ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/node61.html
Revision: 1.1
Committed: Mon Nov 18 17:50:02 2002 UTC (22 years, 6 months ago) by sashby
Content type: text/html
Branch: MAIN
CVS Tags: V1_pre0, V0_19_7
Branch point for: SCRAM_V1_BRANCH
Log Message:
Generated and added HTML documentation.

File Contents

# Content
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
3 <!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
4 patched version by: Kenshi Muto, Debian Project.
5 LaTeX2HTML 2002 (1.62),
6 original version by: Nikos Drakos, CBLU, University of Leeds
7 * revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
8 * with significant contributions from:
9 Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
10 <HTML>
11 <HEAD>
12 <TITLE>5.4.3 Installing a New Tool into a Project Area</TITLE>
13 <META NAME="description" CONTENT="5.4.3 Installing a New Tool into a Project Area">
14 <META NAME="keywords" CONTENT="SCRAM">
15 <META NAME="resource-type" CONTENT="document">
16 <META NAME="distribution" CONTENT="global">
17
18 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
19 <META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
20 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
21
22 <LINK REL="STYLESHEET" HREF="SCRAM.css">
23
24 <LINK REL="previous" HREF="node60.html">
25 <LINK REL="up" HREF="node58.html">
26 <LINK REL="next" HREF="node62.html">
27 </HEAD>
28
29 <BODY bgcolor="beige" >
30 <!--Navigation Panel-->
31 <A NAME="tex2html1207"
32 HREF="node62.html">
33 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
34 SRC="file:/usr/share/latex2html/icons/next.png"></A>
35 <A NAME="tex2html1201"
36 HREF="node58.html">
37 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
38 SRC="file:/usr/share/latex2html/icons/up.png"></A>
39 <A NAME="tex2html1197"
40 HREF="node60.html">
41 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
42 SRC="file:/usr/share/latex2html/icons/prev.png"></A>
43 <A NAME="tex2html1203"
44 HREF="node2.html">
45 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
46 SRC="file:/usr/share/latex2html/icons/contents.png"></A>
47 <A NAME="tex2html1205"
48 HREF="node85.html">
49 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
50 SRC="file:/usr/share/latex2html/icons/index.png"></A>
51 <BR>
52 <B> Next:</B> <A NAME="tex2html1208"
53 HREF="node62.html">5.4.3.0.1 Example A:</A>
54 <B> Up:</B> <A NAME="tex2html1202"
55 HREF="node58.html">5.4 Configuration Tools in</A>
56 <B> Previous:</B> <A NAME="tex2html1198"
57 HREF="node60.html">5.4.2 Removing a Tool</A>
58 &nbsp <B> <A NAME="tex2html1204"
59 HREF="node2.html">Contents</A></B>
60 &nbsp <B> <A NAME="tex2html1206"
61 HREF="node85.html">Index</A></B>
62 <BR>
63 <BR>
64 <!--End of Navigation Panel-->
65
66 <H2><A NAME="SECTION00643000000000000000"></A><A NAME="sec:cvsrootbreakdown"></A><A NAME="1380"></A>
67 <BR>
68 5.4.3 Installing a New Tool into a Project Area
69 </H2>
70 A new tool is installed using the command
71
72 <P>
73 <TT>scram setup</TT>
74
75 [<B>-i</B>]&nbsp;[<B>-f</B>&nbsp;<I>tools.conf</I>]&nbsp;<TT>tool_name</TT>&nbsp;<TT>tool_version</TT>&nbsp;<TT>url</TT>
76
77 <P>
78 where the <TT>url</TT> is either a tool description file or a
79 valid CVS location (that is, the URL types are <TT>file:</TT> or
80 <TT>url:</TT>). A tool description template can be created using the
81 command <TT>scram tool template</TT>: this will create a template in
82 your current directory. Edit this to suit, ensuring that it has a tool
83 name and version. Define any variables that need to be set, and
84 libraries that are required. Then just run
85
86 <P>
87 <TT>scram setup</TT>
88
89 [<B>-i</B>]&nbsp;[<B>-f</B>&nbsp;<I>tools.conf</I>]&nbsp;<TT>tool_name</TT>
90 &nbsp;<TT>tool_version</TT>&nbsp;<TT>file:./tool_template</TT>
91
92 <P>
93 and supply the settings as required.
94
95 <P>
96 The second URL type refers to download locations on a CVS server. A
97 typical URL can be broken down into six parts that are combined as a
98 single string. These components, for a typical URL, are-
99
100 <P>
101 <DL>
102 <DT><STRONG><TT>cvs://cmscvs.cern.ch/cvs_server/repositories/ToolBox</TT></STRONG></DT>
103 <DD>
104 <BR>
105 The path to to the <TT>ToolBox</TT> repository on a CVS server. This
106 example is for a regular CVS server allowing at least <TT>pserver</TT>
107 anonymous access. If the authentication type is <TT>local</TT> then
108 the path will point directly to a directory:
109 <BR>
110 <DIV ALIGN="CENTER">
111 </DIV><PRE>
112 cvs:/fs/local/cvs_repositories/ToolBox
113 </PRE>
114 <DIV ALIGN="CENTER">
115 <BR>
116
117 </DIV>
118 <A NAME="1415"></A>
119 <A NAME="1416"></A>
120 </DD>
121 <DT><STRONG><TT>?auth=pserver</TT></STRONG></DT>
122 <DD>
123 <BR>
124 The authentication type. This can be <TT>pserver</TT> for anonymous
125 checkouts or <TT>local</TT> for a repository on a local filesystem
126 instead of a dedicated server.
127 </DD>
128 <DT><STRONG><TT>&amp;module=Tools/TOOLNAME</TT></STRONG></DT>
129 <DD>
130 <BR>
131 The location of the module (the tool document for <TT>TOOLNAME</TT>)
132 to be checked out.
133 </DD>
134 <DT><STRONG><TT>passkey=AA_:yZZ3e</TT></STRONG></DT>
135 <DD>
136 <BR>
137 The passkey needed for anonymous checkout. This is the password entry
138 in the file <TT>.cvspass</TT> usually found in a user home directory
139 after a <TT>cvs login</TT> command has been run.
140 </DD>
141 <DT><STRONG><TT>user=anonymous</TT></STRONG></DT>
142 <DD>
143 <BR>
144 The user name for anonymous checkout. This can sometimes be
145 <TT>anon</TT>. Check with local CVS administrators to see how your
146 site repository has been set up.
147 </DD>
148 <DT><STRONG><TT>version=CMS_55</TT></STRONG></DT>
149 <DD>
150 <BR>
151 The configuration version.
152 </DD>
153 </DL>
154
155 <P>
156 Here area several examples illustrating how to use the <TT>scram setup</TT> command.
157
158 <P>
159 <BR><HR>
160 <!--Table of Child-Links-->
161 <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
162
163 <UL>
164 <LI><UL>
165 <LI><A NAME="tex2html1209"
166 HREF="node62.html">5.4.3.0.1 <I>Example A</I>:</A>
167 <LI><A NAME="tex2html1210"
168 HREF="node63.html">5.4.3.0.2 <I>Example B</I>:</A>
169 </UL></UL>
170 <!--End of Table of Child-Links-->
171 <HR>
172 <!--Navigation Panel-->
173 <A NAME="tex2html1207"
174 HREF="node62.html">
175 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
176 SRC="file:/usr/share/latex2html/icons/next.png"></A>
177 <A NAME="tex2html1201"
178 HREF="node58.html">
179 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
180 SRC="file:/usr/share/latex2html/icons/up.png"></A>
181 <A NAME="tex2html1197"
182 HREF="node60.html">
183 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
184 SRC="file:/usr/share/latex2html/icons/prev.png"></A>
185 <A NAME="tex2html1203"
186 HREF="node2.html">
187 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
188 SRC="file:/usr/share/latex2html/icons/contents.png"></A>
189 <A NAME="tex2html1205"
190 HREF="node85.html">
191 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
192 SRC="file:/usr/share/latex2html/icons/index.png"></A>
193 <BR>
194 <B> Next:</B> <A NAME="tex2html1208"
195 HREF="node62.html">5.4.3.0.1 Example A:</A>
196 <B> Up:</B> <A NAME="tex2html1202"
197 HREF="node58.html">5.4 Configuration Tools in</A>
198 <B> Previous:</B> <A NAME="tex2html1198"
199 HREF="node60.html">5.4.2 Removing a Tool</A>
200 &nbsp <B> <A NAME="tex2html1204"
201 HREF="node2.html">Contents</A></B>
202 &nbsp <B> <A NAME="tex2html1206"
203 HREF="node85.html">Index</A></B>
204 <!--End of Navigation Panel-->
205 <ADDRESS>
206 scram-developers@cern.ch
207 </ADDRESS>
208 </BODY>
209 </HTML>