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