ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/configtools.html
Revision: 1.4
Committed: Wed May 15 14:23:32 2002 UTC (23 years ago) by sashby
Content type: text/html
Branch: MAIN
Changes since 1.3: +38 -26 lines
Log Message:
Updated documentation.

File Contents

# User Rev Content
1 williamc 1.2 <! Style Sheet Header>
2     <html>
3     <head>
4     <title>configtools.html</title>
5     <body bgcolor=beige>
6     <! End Style Sheet Header -----------Insert Text Here --------------------->
7     <center>
8     <h1>Scram Configuration Tools in the Environment</h1>
9     <font color=red>S</font>oftware <font color=red>C</font>onfiguration,
10     <font color=red>R</font>elease <font color=red>A</font>nd
11     <font color=red>M</font>anagement
12     </center>
13     <hr>
14 sashby 1.4 Each Scram-managed project area has a set of configuration tools associated with it. The
15 williamc 1.2 tools available are those requested in the corresponding
16     <a href=requirementdoc.html>requirements document</a> of the project
17     configuration.
18     <p>
19     The environment to which the following commands apply correspond to that of
20 sashby 1.4 the current working directory (from which the command is executed). If
21 williamc 1.2 this does not correspond to a scram area an error will be issued.
22     <p>
23 sashby 1.4 <h2>Viewing the Available Tools</h2>
24 williamc 1.2 The tools available within any given area can be viewed with the command :
25     <p>
26 sashby 1.4 <pre>
27     scram tool list
28     </pre>
29 williamc 1.2 <p>
30     <h2>Viewing Tool Configuration Settings</h2>
31     The settings for a given tool and other tool info can be seen with :
32     <p>
33 sashby 1.4 <pre>
34     scram tool info tool_name [<em>tool_version</em>]
35     </pre>
36 williamc 1.2 <p>
37     If no <em>tool_version</em> is specified the default version is taken.
38 sashby 1.4 <p>
39     The individual values of tool variables (e.g., INCLUDE or LIB paths etc.) can be obtained using
40     the command
41     <pre>
42     scram tool tag tool_name [<em>tag_name</em>]
43     </pre>
44     If no tag name (variable name) is supplied, all known tags for the tool are listed.
45     This command is especially useful within scripts that require local project information, and avoids having
46     to parse scram output using SED or AWK.
47    
48     <h2>Changing the Tool Configuration Settings</h2>
49    
50     There are two modes available: automatic and interactive. Default is automatic and this is used
51     during project bootstrapping.<br>
52     In auto mode, scram will try a number of things to determine the
53     correct values of each tool variable on your system (e.g. checking default
54     locations, environment variables, reading a cmstools file, checking other projects etc.).
55     If SCRAM fails to find the correct value then it will go into interactive mode
56     and ask the user for input.
57     <p>
58     You can override the settings using the command
59     <pre>
60     scram setup [-i] [-f cmstools.conf] tool_name [[<em>tool_version</em>] [<em>tool_doc</em>]]
61     </pre>
62     to rerun the installation of a specific tool.<p>
63     The <b>-f</b> flag causes setup to read the filename given. This filename must end in ".conf".<br>
64     The <b>-i</b> flag overrides the auto mechanism and a tool description document can also be specified.
65     <p>
66    
67 williamc 1.2 <! Style Sheet Footer ---------------Do not change anything after this line-->
68     <hr>
69     <table border=1 width=100%>
70     <td align=left>
71 sashby 1.3 <a href=mailto:Shaun.Ashby@cern.ch
72     >Shaun Ashby</a>
73 williamc 1.2 </td>
74     <td align=center>
75 sashby 1.3 <SCRIPT LANGUAGE="JAVASCRIPT">document.write("Last Updated "+ document.lastModified );</SCRIPT>
76 williamc 1.2 </td>
77     <td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
78     </td>
79     </table>
80     </body> </html>
81     <! End Style Sheet Footer>