source: LMDZ5/trunk/tools/fcm/doc/user_guide/annex_quick_ref.html @ 1867

Last change on this file since 1867 was 1578, checked in by jghattas, 13 years ago
  • Add fcm in LMDZ5/tools directory

It is no longer needed to have fcm in your environement PATH variable.
Now makelmdz_fcm takes by default this fcm. It is still possible to use
another fcm, using -fcm_path argument in makelmdz_fcm.
File size: 6.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5  <title>FCM System User Guide Annex: Quick reference</title>
6  <meta name="author" content="FCM development team">
7  <meta name="descriptions" content="User Guide Annex">
8  <meta name="keywords" content="FCM, user guide, annex">
9  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
10  <link rel="stylesheet" type="text/css" href="style.css">
11</head>
12
13<body>
14  <script type="text/javascript">
15  <!--
16    document.write ('<address>')
17    document.write ('<a href="index.html">FCM System User Guide</a>')
18    document.write (' &gt; ')
19    document.write ('Annex: Quick reference')
20    document.write ('<\/address>')
21  //-->
22  </script>
23
24  <h1>Annex:<br>
25  Quick reference</h1>
26
27  <p>Note: some sub-commands can be invoked with alternate names. For example,
28  "fcm help" is the same as "fcm ?". In this annex, some favourite alternate
29  names are listed, separated by a pipe, i.e. the above example will be given as
30  "fcm help|?".</p>
31
32  <a name="help"></a><h2>Getting help</h2>
33
34  <table summary="help" width="100%" border="0">
35    <tr>
36      <td>fcm help|?</td>
37
38      <td width="70%">get list of subcommands</td>
39    </tr>
40
41    <tr>
42      <td>fcm help|? SUBCOMMAND</td>
43
44      <td width="70%">get help on SUBCOMMAND</td>
45    </tr>
46  </table>
47
48  <a name="maintaining-wc"></a><h2>Maintaining the working copy</h2>
49
50  <table summary="maintaining-wc" width="100%" border="0">
51    <tr>
52      <td colspan="2">fcm&nbsp;checkout|co&nbsp;[OPTIONS]&nbsp;URL&nbsp;[DEST]</td>
53
54      <td width="70%">Checkout URL (and create a working copy at DEST)</td>
55    </tr>
56
57    <tr>
58      <td>&nbsp;</td>
59
60      <td width="18%">-r N</td>
61
62      <td width="70%">Checkout revision N of URL</td>
63    </tr>
64
65    <tr>
66      <td colspan="2">fcm info</td>
67
68      <td width="70%">Print working copy information</td>
69    </tr>
70
71    <tr>
72      <td colspan="2">fcm status|st [OPTIONS]</td>
73
74      <td width="70%">Print status of working copy</td>
75    </tr>
76
77    <tr>
78      <td>&nbsp;</td>
79
80      <td width="18%">-u</td>
81
82      <td width="70%">Show update information</td>
83    </tr>
84
85    <tr>
86      <td>&nbsp;</td>
87
88      <td width="18%">-v</td>
89
90      <td width="70%">Show verbose information</td>
91    </tr>
92
93    <tr>
94      <td colspan="2">fcm update|up</td>
95
96      <td width="70%">Update working copy with repository changes</td>
97    </tr>
98
99    <tr>
100      <td colspan="2">fcm switch|sw URL</td>
101
102      <td width="70%">Switch your working copy to point to a branch specified by
103      URL</td>
104    </tr>
105
106    <tr>
107      <td colspan="2">fcm commit|ci</td>
108
109      <td width="70%">Commit local changes back into the repository</td>
110    </tr>
111  </table>
112
113  <a name="preparing-changes"></a><h2>Preparing changes</h2>
114
115  <table summary="preparing-changes" width="100%" border="0">
116    <tr>
117      <td colspan="2">fcm diff|di [OPTIONS]</td>
118
119      <td width="70%">Display working copy changes in unified diff format</td>
120    </tr>
121
122    <tr>
123      <td>&nbsp;</td>
124
125      <td width="18%">-b</td>
126
127      <td width="70%">Show differences relative to the base of the branch</td>
128    </tr>
129
130    <tr>
131      <td>&nbsp;</td>
132
133      <td width="18%">-g</td>
134
135      <td width="70%">Display working copy changes with a graphical diff
136      tool</td>
137    </tr>
138
139    <tr>
140      <td>&nbsp;</td>
141
142      <td width="18%">-r N</td>
143
144      <td width="70%">Display working copy changes against revision N</td>
145    </tr>
146
147    <tr>
148      <td>&nbsp;</td>
149
150      <td width="18%">-t</td>
151
152      <td width="70%">Display differences in Trac, (with -b only)</td>
153    </tr>
154
155    <tr>
156      <td colspan="2">fcm revert [OPTIONS] PATH</td>
157
158      <td width="70%">Restore the file PATH to the pristine copy</td>
159    </tr>
160
161    <tr>
162      <td>&nbsp;</td>
163
164      <td>-R</td>
165
166      <td width="70%">Descend PATH recursively, restoring any modified files to
167      the pristine copy</td>
168    </tr>
169
170    <tr>
171      <td colspan="2">fcm mkdir [PATH]</td>
172
173      <td width="70%">Add a directory PATH under revision control</td>
174    </tr>
175
176    <tr>
177      <td colspan="2">fcm add [OPTIONS] [PATH]</td>
178
179      <td width="70%">Add PATH under revision control</td>
180    </tr>
181
182    <tr>
183      <td>&nbsp;</td>
184
185      <td width="18%">-c</td>
186
187      <td width="70%">Check for items not under revision control and add
188      them</td>
189    </tr>
190
191    <tr>
192      <td colspan="2">fcm&nbsp;delete|del|rm&nbsp;[OPTIONS]&nbsp;[PATH]</td>
193
194      <td width="70%">Remove PATH from revision control</td>
195    </tr>
196
197    <tr>
198      <td>&nbsp;</td>
199
200      <td width="18%">-c</td>
201
202      <td width="70%">Check for missing items and remove them</td>
203    </tr>
204
205    <tr>
206      <td colspan="2">fcm copy|cp SRC DST</td>
207
208      <td width="70%">Duplicate SRC to DST, remembering history</td>
209    </tr>
210
211    <tr>
212      <td colspan="2">fcm&nbsp;move|mv&nbsp;SRC&nbsp;DST</td>
213
214      <td width="70%">Move or rename SRC to DST, remembering history</td>
215    </tr>
216  </table>
217
218  <a name="browse"></a><h2>Browsing</h2>
219
220  <table summary="browse" width="100%" border="0">
221    <tr>
222      <td colspan="2">fcm&nbsp;log&nbsp;[OPTIONS]&nbsp;[TARGET]</td>
223
224      <td width="70%">Show the log message of a TARGET that can either be
225      working copy or URL</td>
226    </tr>
227
228    <tr>
229      <td>&nbsp;</td>
230
231      <td width="18%">-r N[:M]</td>
232
233      <td width="70%">Show the log message of a range of reivsions</td>
234    </tr>
235
236    <tr>
237      <td colspan="2">fcm list|ls [OPTIONS] [TARGET]</td>
238
239      <td width="70%">List directory entries in TARGET</td>
240    </tr>
241
242    <tr>
243      <td>&nbsp;</td>
244
245      <td width="18%">-r N</td>
246
247      <td width="70%">List directory entries of revision N</td>
248    </tr>
249
250    <tr>
251      <td>&nbsp;</td>
252
253      <td width="18%">-v</td>
254
255      <td width="70%">List directory entries in verbose mode</td>
256    </tr>
257
258    <tr>
259      <td>&nbsp;</td>
260
261      <td width="18%">-R</td>
262
263      <td width="70%">List directory entries recursively down the
264      directories</td>
265    </tr>
266
267    <tr>
268      <td colspan="2">fcm trac [TARGET]</td>
269
270      <td width="70%">Open a WWW browser to browse TARGET with Trac</td>
271    </tr>
272  </table>
273
274  <a name="branch"></a><h2>Branching</h2>
275
276  <table summary="browse" width="100%" border="0">
277    <tr>
278      <td colspan="2">fcm branch|br [OPTIONS] [URL]</td>
279
280      <td width="70%">Show branch information of URL or local working
281      copy</td>
282    </tr>
283
284    <tr>
285      <td>&nbsp;</td>
286
287      <td width="18%">-d</td>
288
289      <td width="70%">Show branch information and delete the branch</td>
290    </tr>
291
292    <tr>
293      <td>&nbsp;</td>
294
295      <td width="18%">-c -n NAME</td>
296
297      <td width="70%">Create a branch</td>
298    </tr>
299
300    <tr>
301      <td colspan="2">fcm merge [SOURCE]</td>
302
303      <td width="70%">Merge changes from SOURCE to your working copy</td>
304    </tr>
305
306    <tr>
307      <td colspan="2">fcm conflicts|cf</td>
308
309      <td width="70%">Use xxdiff to resolve conflicts in your working copy</td>
310    </tr>
311  </table>
312
313  <script type="text/javascript" src="maintain.js">
314  </script>
315</body>
316</html>
Note: See TracBrowser for help on using the repository browser.