source: release-kits/lirk3/resources/gs3-release-maker/apache-ant-1.6.5/docs/manual/OptionalTasks/sos.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 13.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4
5 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
6 <title>SOS Tasks</title>
7
8<link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
9</head>
10<body>
11
12<div align="center">
13<h1>SourceOffSite Tasks User Manual</h1>
14
15<div align="left">by
16<ul>
17<li><a href="mailto:[email protected]">Jesse Stockall</a></li>
18</ul>
19Version 1.1 2002/01/23
20<br>
21<br>
22
23<hr width="100%" size="2">
24<h2>Contents</h2>
25
26<ul>
27 <li><a href="#intro">Introduction</a></li>
28 <li><a href="#tasks">The Tasks</a></li>
29
30</ul>
31<br>
32
33<h2><a name="intro">Introduction</a> </h2>
34
35<p>These tasks provide an interface to the <a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top">
36Microsoft Visual SourceSafe</a> SCM via <a href="http://www.sourcegear.com">
37SourceGear's</a> <a href="http://sourcegear.com/sos/index.htm">SourceOffSite</a>
38product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote
39development teams and tele-commuters that need fast and secure read/write
40access to a centralized SourceSafe database via any TCP/IP connection. SOS
41provides Linux ,Solaris &amp; Windows clients. The
42<code> org.apache.tools.ant.taskdefs.optional.sos</code>
43package consists of a simple framework to support SOS functionality as well
44as some Ant tasks encapsulating frequently used SOS commands. Although it
45is possible to use these commands on the desktop, they were primarily intended
46to be used by automated build systems. These tasks have been tested with
47SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks
48have been tested with Linux, Solaris &amp; Windows2000.</p>
49
50<h2><a name="tasks">The Tasks</a> </h2>
51
52<table border="0" cellspacing="0" cellpadding="3">
53 <tbody>
54 <tr>
55 <td><a href="#SOSGet">sosget</a></td>
56 <td>Retrieves a read-only copy of the specified project or file.</td>
57 </tr>
58 <tr>
59 <td><a href="#SOSLabel">soslabel</a></td>
60 <td>Assigns a label to the specified project.</td>
61 </tr>
62 <tr>
63 <td><a href="#SOSCheckIn">soscheckin</a></td>
64 <td>Updates VSS with changes made to a checked out file or project,
65 and unlocks the VSS master copy.</td>
66 </tr>
67 <tr>
68 <td><a href="#SOSCheckOut">soscheckout</a></td>
69 <td>Retrieves a read-write copy of the specified project
70 or file, locking the&nbsp;VSS master copy</td>
71 </tr>
72
73 </tbody>
74</table>
75 <br>
76
77<hr width="100%" size="2">
78<h2>Task Descriptions</h2>
79
80<h2><a name="SOSGet"></a>SOSGet<br>
81 </h2>
82<h3>Description</h3>
83 Task to perform GET commands with SOS<br>
84<h3>Parameters</h3>
85 </div>
86 </div>
87
88<table border="1">
89 <tbody>
90 <tr>
91 <th>Attribute</th>
92 <th>Values</th>
93 <th>Required</th>
94 </tr>
95 <tr>
96 <td>soscmd</td>
97 <td>Directory which contains soscmd(.exe) <br>
98 soscmd(.exe) must be in the path if this is not specified</td>
99 <td>No</td>
100 </tr>
101 <tr>
102 <td>vssserverpath</td>
103 <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
104 <td>Yes</td>
105 </tr>
106 <tr>
107 <td>sosserverpath</td>
108 <td>address &amp; port of the SOS server - eg. 192.168.0.1:8888</td>
109 <td>Yes</td>
110 </tr>
111 <tr>
112 <td>projectpath</td>
113 <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
114 <td>Yes</td>
115 </tr>
116 <tr>
117 <td>file</td>
118 <td>Filename to act upon<br>
119 If no file is specified then act upon the project</td>
120 <td>No</td>
121 </tr>
122 <tr>
123 <td>username</td>
124 <td>SourceSafe username</td>
125 <td>Yes</td>
126 </tr>
127 <tr>
128 <td>password</td>
129 <td>SourceSafe password</td>
130 <td>No</td>
131 </tr>
132 <tr>
133 <td>localpath</td>
134 <td>Override the working directory and get to the specified path</td>
135 <td>No</td>
136 </tr>
137 <tr>
138 <td>soshome</td>
139 <td>The path to the SourceOffSite home directory</td>
140 <td>No</td>
141 </tr>
142 <tr>
143 <td>nocompress</td>
144 <td>true or false - disable compression</td>
145 <td>No</td>
146 </tr>
147 <tr>
148 <td>recursive</td>
149 <td>true or false - Only works with the GetProject command</td>
150 <td>No</td>
151 </tr>
152 <tr>
153 <td>version</td>
154 <td>a version number to get - Only works with the GetFile command</td>
155 <td>No</td>
156 </tr>
157 <tr>
158 <td>label</td>
159 <td>a label version to get - Only works with the GetProject command</td>
160 <td>No</td>
161 </tr>
162 <tr>
163 <td>nocache</td>
164 <td>true or false - Only needed if SOSHOME is set as an environment variable</td>
165 <td>No</td>
166 </tr>
167 <tr>
168 <td>verbose</td>
169 <td>true or false - Status messages are displayed</td>
170 <td>No</td>
171 </tr>
172 </tbody>
173</table>
174
175<h3>Example</h3>
176
177<pre>
178&lt;sosget verbose=&quot;true&quot;
179 recursive=&quot;true&quot;
180 username=&quot;build&quot;
181 password=&quot;build&quot;
182 localpath=&quot;tmp&quot;
183 projectpath=&quot;$/SourceRoot/project1&quot;
184 sosserverpath=&quot;192.168.10.6:8888&quot;
185 vssserverpath=&quot;d:\vss\srcsafe.ini&quot;/&gt;
186</pre>
187<small>Connects to a SourceOffsite server on 192.168.10.6:8888 with
188build,build as the username &amp; password. The SourceSafe database resides
189on the same box as the SOS server &amp; the VSS database is at
190&quot;d:\vss\srcsafe.ini&quot; Does a recursive GetProject on
191$/SourceRoot/project1, using tmp as the working
192directory. </small><br>
193<br>
194
195<hr width="100%" size="2">
196<h2><a name="SOSLabel"></a>SOSLabel</h2>
197
198<h3>Description</h3>
199 Task to perform Label commands with SOS<br>
200<h3>Parameters</h3>
201
202<table border="1">
203 <tbody><tr>
204 <th>Attribute</th>
205 <th>Values</th>
206 <th>Required</th>
207 </tr>
208 <tr>
209 <td>soscmd</td>
210 <td>Directory which contains soscmd(.exe) <br>
211 soscmd(.exe) must be in the path if this is not specified</td>
212 <td>No</td>
213 </tr>
214 <tr>
215 <td>vssserverpath</td>
216 <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
217 <td>Yes</td>
218 </tr>
219 <tr>
220 <td>sosserverpath</td>
221 <td>address and port of the SOS server - eg. 192.168.0.1:8888</td>
222 <td>Yes</td>
223 </tr>
224 <tr>
225 <td>projectpath</td>
226 <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
227 <td>Yes</td>
228 </tr>
229 <tr>
230 <td>username</td>
231 <td>SourceSafe username</td>
232 <td>Yes</td>
233 </tr>
234 <tr>
235 <td>password</td>
236 <td>SourceSafe password</td>
237 <td>No</td>
238 </tr>
239 <tr>
240 <td>label</td>
241 <td>The label to apply to a project</td>
242 <td>Yes</td>
243 </tr>
244 <tr>
245 <td>comment</td>
246 <td>A comment to be applied to all files being labeled</td>
247 <td>No</td>
248 </tr>
249 <tr>
250 <td>verbose</td>
251 <td>true or false - Status messages are displayed</td>
252 <td>No</td>
253 </tr>
254 </tbody>
255</table>
256
257<h3>Example</h3>
258<pre>
259&lt;soslabel username=&quot;build&quot;
260 password=&quot;build&quot;
261 label=&quot;test label&quot;
262 projectpath=&quot;$/SourceRoot/project1&quot;
263 sosserverpath=&quot;192.168.10.6:8888&quot;
264 vssserverpath=&quot;d:\vss\srcsafe.ini&quot;/&gt;
265</pre>
266
267<small>Connects to a SourceOffsite server on 192.168.10.6:8888 with
268build,build as the username &amp; password. The SourceSafe database resides
269on the same box as the SOS server &amp; the VSS database is at
270&quot;d:\vss\srcsafe.ini&quot;. Labels the $/SourceRoot/project1
271project with &quot;test label&quot;.</small><br>
272<br>
273
274<hr width="100%" size="2"><br>
275
276<h2><a name="SOSCheckIn"></a>SOSCheckIn</h2>
277
278<h3>Description</h3>
279 Task to perform CheckIn commands with SOS<br>
280<h3>Parameters</h3>
281<table border="1">
282 <tbody>
283 <tr>
284 <th>Attribute</th>
285 <th>Values</th>
286 <th>Required</th>
287 </tr>
288 <tr>
289 <td>soscmd</td>
290 <td>Directory which contains soscmd(.exe) <br>
291 soscmd(.exe) must be in the path if this is not specified</td>
292 <td>No</td>
293 </tr>
294 <tr>
295 <td>vssserverpath</td>
296 <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
297 <td>Yes</td>
298 </tr>
299 <tr>
300 <td>sosserverpath</td>
301 <td>address and port of the SOS server - eg. 192.168.0.1:8888</td>
302 <td>Yes</td>
303 </tr>
304 <tr>
305 <td>projectpath</td>
306 <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
307 <td>Yes</td>
308 </tr>
309 <tr>
310 <td>file</td>
311 <td>Filename to act upon<br> If no file is specified then act upon the project</td>
312 <td>No</td>
313 </tr>
314 <tr>
315 <td>username</td>
316 <td>SourceSafe username</td>
317 <td>Yes</td>
318 </tr>
319 <tr>
320 <td>password</td>
321 <td>SourceSafe password</td>
322 <td>No</td>
323 </tr>
324 <tr>
325 <td>localpath</td>
326 <td>Override the working directory and get to the specified path</td>
327 <td>No</td>
328 </tr>
329 <tr>
330 <td>soshome</td>
331 <td>The path to the SourceOffSite home directory</td>
332 <td>No</td>
333 </tr>
334 <tr>
335 <td>nocompress</td>
336 <td>true or false - disable compression</td>
337 <td>No</td>
338 </tr>
339 <tr>
340 <td>recursive</td>
341 <td>true or false - Only works with the CheckOutProject command</td>
342 <td>No</td>
343 </tr>
344 <tr>
345 <td>nocache</td>
346 <td>true or false - Only needed if SOSHOME is set as an environment variable</td>
347 <td>No</td>
348 </tr>
349 <tr>
350 <td>verbose</td>
351 <td>true or false - Status messages are displayed</td>
352 <td>No</td>
353 </tr>
354 <tr><td>comment</td>
355 <td>A comment to be applied to all files being checked in</td>
356 <td>No</td>
357 </tr>
358 </tbody>
359</table>
360
361<h3>Example</h3>
362<pre>
363&lt;soscheckin username=&quot;build&quot;
364 password=&quot;build&quot;
365 file=&quot;foobar.txt&quot;
366 verbose=&quot;true&quot;
367 comment=&quot;comment abc&quot;
368 projectpath=&quot;$/SourceRoot/project1&quot;
369 sosserverpath=&quot;server1:8888&quot;
370 vssserverpath=&quot;\\server2\vss\srcsafe.ini&quot;/&gt;
371</pre>
372
373<small>Connects to a SourceOffsite server on server1:8888 with build,build as
374the username &amp; password. The SourceSafe database resides on a different
375box (server2) &amp; the VSS database is on a share called
376&quot;vss&quot;. Checks-in only the &quot;foobar.txt&quot; file adding
377a comment of &quot;comment abc&quot;. Extra status messages will be
378displayed on screen.</small><br>
379<br>
380
381<hr width="100%" size="2">
382<h2><a name="SOSCheckOut"></a>SOSCheckOut</h2>
383
384<h3>Description</h3>
385 Task to perform CheckOut commands with SOS<br>
386
387<h3>Parameters</h3>
388
389<table border="1">
390 <tbody>
391 <tr>
392 <th>Attribute</th>
393 <th>Values</th>
394 <th>Required</th>
395 </tr>
396 <tr>
397 <td>soscmd</td>
398 <td>Directory which contains soscmd(.exe) <br>
399 soscmd(.exe) must be in the path if this is not specified</td>
400 <td>No</td>
401 </tr>
402 <tr>
403 <td>vssserverpath</td>
404 <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
405 <td>Yes</td>
406 </tr>
407 <tr>
408 <td>sosserverpath</td>
409 <td>address and port of the SOS server - eg. 192.168.0.1:8888</td>
410 <td>Yes</td>
411 </tr>
412 <tr>
413 <td>projectpath</td>
414 <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
415 <td>Yes</td>
416 </tr>
417 <tr>
418 <td>file</td>
419 <td>Filename to act upon<br> If no file is specified then act upon the project</td>
420 <td>No</td>
421 </tr>
422 <tr>
423 <td>username</td>
424 <td>SourceSafe username</td>
425 <td>Yes</td>
426 </tr>
427 <tr>
428 <td>password</td>
429 <td>SourceSafe password</td>
430 <td>No</td>
431 </tr>
432 <tr>
433 <td>localpath</td>
434 <td>Override the working directory and get to the specified path</td>
435 <td>No</td>
436 </tr>
437 <tr>
438 <td>soshome</td>
439 <td>The path to the SourceOffSite home directory</td>
440 <td>No</td>
441 </tr>
442 <tr>
443 <td>nocompress</td>
444 <td>true or false - disable compression</td>
445 <td>No</td>
446 </tr>
447 <tr>
448 <td>recursive</td>
449 <td>true or false - Only works with the CheckOutProject command</td>
450 <td>No</td>
451 </tr>
452 <tr>
453 <td>nocache</td>
454 <td>true or false - Only needed if SOSHOME is set as an environment variable</td>
455 <td>No</td>
456 </tr>
457 <tr>
458 <td>verbose</td>
459 <td>true or false - Status messages are displayed</td>
460 <td>No</td>
461 </tr>
462 </tbody>
463</table>
464 <br>
465
466<h3>Example</h3>
467<pre>
468&lt;soscheckout soscmd=&quot;/usr/local/bin&quot;
469 verbose=&quot;true&quot;
470 username=&quot;build&quot;
471 password=&quot;build&quot;
472 projectpath=&quot;$/SourceRoot/project1&quot;
473 sosserverpath=&quot;192.168.10.6:8888&quot;
474 vssserverpath=&quot;\\server2\vss\srcsafe.ini&quot;/&gt;
475</pre>
476
477<small>Connects to a SourceOffsite server on server1:8888 with build,build as
478the username &amp; password. The SourceSafe database resides on a different
479box (server2) &amp; the VSS database is on a share called
480&quot;vss&quot;. Checks-out &quot;project1&quot;, Only the
481&quot;project1&quot; directory will be locked as the recursive option
482was not set. Extra status messages will be displayed on screen. The
483soscmd(.exe) file to be used resides in /usr/local/bin.</small><br>
484<br>
485<hr>
486<p align="center">Copyright &copy; 2002,2004 The Apache Software Foundation. All rights
487Reserved.</p>
488</body>
489</html>
Note: See TracBrowser for help on using the repository browser.