| 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 |
sashby |
1.5 |
|
| 66 |
|
|
|
| 67 |
|
|
<h2>Removing a Tool from a Project Area</h2>
|
| 68 |
|
|
|
| 69 |
|
|
Sometimes it might be necessary to remove a tool from a project area. This can be achieved by
|
| 70 |
|
|
using the command
|
| 71 |
|
|
<pre>
|
| 72 |
|
|
scram tool remove tool_name
|
| 73 |
|
|
</pre>
|
| 74 |
|
|
This completely removes all references to the tool. To re-install the default version it will
|
| 75 |
|
|
be necessary to re-run scram setup. Before installing a new version of a tool, it is best to
|
| 76 |
|
|
remove the old one.
|
| 77 |
sashby |
1.4 |
<p>
|
| 78 |
|
|
|
| 79 |
sashby |
1.5 |
|
| 80 |
|
|
|
| 81 |
|
|
<!-- <h2>Installing a New Tool into a Project Area</h2> -->
|
| 82 |
|
|
<!-- New tools can be added easily. The tools can either be downloaded from the CVS repository or -->
|
| 83 |
|
|
<!-- they can be set up using a file. -->
|
| 84 |
|
|
<!-- The command -->
|
| 85 |
|
|
<!-- <pre> -->
|
| 86 |
|
|
<!-- scram setup [-i] [-f cmstools.conf] tool_name tool_version [<em>URL</em>]] -->
|
| 87 |
|
|
<!-- </pre> -->
|
| 88 |
|
|
<!-- where URL is -->
|
| 89 |
|
|
<!-- <pre> -->
|
| 90 |
|
|
<!-- 'cvs://cmscvs.cern.ch/cvs_server/repositories/SCRAMToolBox?auth=pserver&module=SCRAMToolBox/XMLTools/&passkey=AA_:yZZ3e&user=anonymous&version=CMS_40_2' -->
|
| 91 |
|
|
<!-- </pre> -->
|
| 92 |
|
|
<!-- (Note: it MUST be quoted like this). -->
|
| 93 |
|
|
|
| 94 |
|
|
<!-- This completely removes all references to the tool. To re-install the default version -->
|
| 95 |
|
|
<!-- <p> -->
|
| 96 |
|
|
|
| 97 |
|
|
|
| 98 |
|
|
|
| 99 |
williamc |
1.2 |
<! Style Sheet Footer ---------------Do not change anything after this line-->
|
| 100 |
|
|
<hr>
|
| 101 |
|
|
<table border=1 width=100%>
|
| 102 |
|
|
<td align=left>
|
| 103 |
sashby |
1.3 |
<a href=mailto:Shaun.Ashby@cern.ch
|
| 104 |
|
|
>Shaun Ashby</a>
|
| 105 |
williamc |
1.2 |
</td>
|
| 106 |
|
|
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
|
| 107 |
|
|
</td>
|
| 108 |
|
|
</table>
|
| 109 |
|
|
</body> </html>
|
| 110 |
|
|
<! End Style Sheet Footer>
|
