New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
annex_quick_ref.html in vendors/doc/user_guide – NEMO

source: vendors/doc/user_guide/annex_quick_ref.html @ 10669

Last change on this file since 10669 was 10669, checked in by nicolasmartin, 5 years ago

Import latest FCM release from Github into the repository for testing
File size: 7.2 KB
Line 
1<!DOCTYPE html>
2<html>
3<head>
4  <title>FCM: User Guide: Annex: Quick Reference</title>
5  <meta name="author" content="FCM team" />
6  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7  <link rel="icon" href="../etc/fcm-icon.png" type="image/png" />
8  <link rel="shortcut icon" href="../etc/fcm-icon.png" type="image/png" />
9  <link href="../etc/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen" />
10  <link href="../etc/fcm.css" rel="stylesheet" media="screen" />
11</head>
12<body>
13  <div class="navbar navbar-inverse">
14    <div class="container-fluid">
15      <div class="navbar-header">
16        <a class="navbar-brand" href=".."><span class="fcm-version">FCM</span></a>
17      </div>
18      <div class="collapse navbar-collapse">
19        <ul class="nav navbar-nav">
20          <li><a href="../installation/">Installation</a></li>
21
22          <li><a class="active" href="#">User Guide</a></li>
23        </ul>
24      </div>
25    </div>
26  </div>
27
28  <div class="page-header">
29    <div class="fcm-page-content pull-right well well-sm"></div>
30    <h1>FCM: User Guide: Annex: Quick Reference</h1>
31  </div>
32
33  <div class="container">
34  <div class="row">
35  <div class="col-md-12">
36
37  <p>Note: some sub-commands can be invoked with alternate names. For example,
38  <code>fcm help</code> is the same as <code>fcm ?</code>. In this annex, some
39  favourite alternate names are listed, separated by a pipe, i.e. the above
40  example will be given as <samp>fcm help|?</samp>.</p>
41
42  <h2 id="help">Getting help</h2>
43
44  <dl>
45    <dt><code>fcm help|?</code></dt>
46
47    <dd>get list of subcommands</dd>
48
49    <dt><code>fcm help|? SUBCOMMAND</code></dt>
50
51    <dd>get help on SUBCOMMAND</dd>
52  </dl>
53
54  <h2 id="maintaining-wc">Maintaining the working copy</h2>
55
56  <dl>
57    <dt><code>fcm checkout|co [OPTIONS] URL [DEST]</code></dt>
58
59    <dd>Checkout URL (and create a working copy at DEST)</dd>
60
61    <dt><code>fcm checkout|co -r N URL [DEST]</code></dt>
62
63    <dd>Checkout revision N of URL (and create a working copy at DEST)</dd>
64
65    <dt><code>fcm info</code></dt>
66
67    <dd>Print working copy information</dd>
68
69    <dt><code>fcm status|st [OPTIONS]</code></dt>
70
71    <dd>Print status of working copy</dd>
72
73    <dt><code>fcm status|st -u</code></dt>
74
75    <dd>Show update information</dd>
76
77    <dt><code>fcm status|st -v</code></dt>
78
79    <dd>Show verbose information</dd>
80
81    <dt><code>fcm update|up</code></dt>
82
83    <dd>Update working copy with repository changes</dd>
84
85    <dt><code>fcm switch|sw URL</code></dt>
86
87    <dd>Switch your working copy to point to a branch specified by URL</dd>
88
89    <dt><code>fcm commit|ci</code></dt>
90
91    <dd>Commit local changes back into the repository</dd>
92  </dl>
93
94  <h2 id="preparing-changes">Preparing changes</h2>
95
96  <dl>
97    <dt><code>fcm diff|di [OPTIONS]</code></dt>
98
99    <dd>Display working copy changes in unified diff format</dd>
100
101    <dt><code>fcm branch-diff|bdiff|bdi [OPTIONS]</code></dt>
102
103    <dd>Show differences relative to the base of the branch</dd>
104
105    <dt><code>fcm diff|di -g</code></dt>
106
107    <dd>Display working copy changes with a graphical diff tool</dd>
108
109    <dt><code>fcm diff|di -r N</code></dt>
110
111    <dd>Display working copy changes against revision N</dd>
112
113    <dt><code>fcm diff|di -t</code></dt>
114
115    <dd>Display differences in Trac, (with -b only)</dd>
116
117    <dt><code>fcm revert [OPTIONS] PATH</code></dt>
118
119    <dd>Restore the file PATH to the pristine copy</dd>
120
121    <dt><code>fcm revert -R PATH</code></dt>
122
123    <dd>Descend PATH recursively, restoring any modified files to the pristine
124    copy</dd>
125
126    <dt><code>fcm mkdir [PATH]</code></dt>
127
128    <dd>Add a directory PATH under revision control</dd>
129
130    <dt><code>fcm add [OPTIONS] PATH ...</code></dt>
131
132    <dd>Add PATH under revision control</dd>
133
134    <dt><code>fcm add -c [PATH]</code></dt>
135
136    <dd>Check for items not under revision control and add them</dd>
137
138    <dt><code>fcm delete|del|rm [OPTIONS] PATH ...</code></dt>
139
140    <dd>Remove PATH from revision control</dd>
141
142    <dt><code>fcm delete|del|rm -c [PATH]</code></dt>
143
144    <dd>Check for missing items and remove them</dd>
145
146    <dt><code>fcm copy|cp SRC DST</code></dt>
147
148    <dd>Duplicate SRC to DST, remembering history</dd>
149
150    <dt><code>fcm move|mv SRC DST</code></dt>
151
152    <dd>Move or rename SRC to DST, remembering history</dd>
153
154    <dt><code>fcm propset|ps svn:executable ON FILE</code></dt>
155
156    <dd>Indicate that FILE will have executable permission when checked out to a
157    Unix file system.</dd>
158
159    <dt><code>fcm propdel|pd svn:executable FILE</code></dt>
160
161    <dd>Reverse of the above.</dd>
162
163    <dt><code>fcm propset|ps svn:special ON FILE</code></dt>
164
165    <dd>Indicate that FILE is a symbolic link rather than a regular file.</dd>
166
167    <dt><code>fcm propdel|pd svn:special FILE</code></dt>
168
169    <dd>Reverse of the above.</dd>
170  </dl>
171
172  <h2 id="browse">Browsing</h2>
173
174  <dl>
175    <dt><code>fcm log [OPTIONS] [TARGET]</code></dt>
176
177    <dd>Show the log message of a TARGET that can either be working copy or
178    URL</dd>
179
180    <dt><code>fcm log -r N[:M] [TARGET]</code></dt>
181
182    <dd>Show the log message of a range of reivsions</dd>
183
184    <dt><code>fcm propedit|pe --revprop svn:log -r N [TARGET]</code></dt>
185
186    <dd>Edit the commit log message of revision N.</dd>
187
188    <dt><code>fcm list|ls [OPTIONS] [TARGET]</code></dt>
189
190    <dd>List directory entries in TARGET</dd>
191
192    <dt><code>fcm list|ls -r N [TARGET]</code></dt>
193
194    <dd>List directory entries of revision N</dd>
195
196    <dt><code>fcm list|ls -v [TARGET]</code></dt>
197
198    <dd>List directory entries in verbose mode</dd>
199
200    <dt><code>fcm list|ls -R [TARGET]</code></dt>
201
202    <dd>List directory entries recursively down the directories</dd>
203
204    <dt><code>fcm browse [TARGET]</code></dt>
205
206    <dd>Open a WWW browser to browse TARGET with Trac</dd>
207  </dl>
208
209  <h2 id="branch">Branching</h2>
210
211  <dl>
212    <dt><code>fcm branch-info|binfo [OPTIONS] [URL]</code></dt>
213
214    <dd>Show branch information of URL or local working copy</dd>
215
216    <dt><code>fcm branch-delete|bdel [URL]</code></dt>
217
218    <dd>Show branch information and delete the branch</dd>
219
220    <dt><code>fcm branch-create|bcreate NAME [URL]</code></dt>
221
222    <dd>Create a branch</dd>
223
224    <dt><code>fcm branch-list|blist|bls [--show-all|-a] [URL]</code></dt>
225
226    <dd>Lists branches</dd>
227
228    <dt><code>fcm merge [SOURCE]</code></dt>
229
230    <dd>Merge changes from SOURCE to your working copy</dd>
231
232    <dt><code>fcm conflicts|cf</code></dt>
233
234    <dd>Use xxdiff to resolve conflicts in your working copy</dd>
235  </dl>
236
237  </div>
238  </div>
239  </div>
240
241  <hr/>
242  <div class="container-fluid text-center">
243    <div class="row"><div class="col-md-12">
244    <address><small>
245      &copy; British Crown Copyright 2006-16
246      <a href="http://www.metoffice.gov.uk">Met Office</a>.
247      See <a href="../etc/fcm-terms-of-use.html">Terms of Use</a>.<br />
248      This document is released under the British <a href=
249      "http://www.nationalarchives.gov.uk/doc/open-government-licence/" rel=
250      "license">Open Government Licence</a>.<br />
251    </small></address>
252    </div></div>
253  </div>
254
255  <script type="text/javascript" src="../etc/jquery.min.js"></script>
256  <script type="text/javascript" src="../etc/bootstrap/js/bootstrap.min.js"></script>
257  <script type="text/javascript" src="../etc/fcm.js"></script>
258  <script type="text/javascript" src="../etc/fcm-version.js"></script>
259</body>
260</html>
Note: See TracBrowser for help on using the repository browser.