File: annex_quick_ref.html

package info (click to toggle)
fcm 2021.05.01-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 7,788 kB
  • sloc: perl: 26,014; sh: 10,510; javascript: 4,043; f90: 774; python: 294; ansic: 29; makefile: 14; cpp: 5
file content (260 lines) | stat: -rw-r--r-- 7,435 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!DOCTYPE html>
<html>
<head>
  <title>FCM: User Guide: Annex: Quick Reference</title>
  <meta name="author" content="FCM team" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <link rel="icon" href="../etc/fcm-icon.png" type="image/png" />
  <link rel="shortcut icon" href="../etc/fcm-icon.png" type="image/png" />
  <link href="../etc/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen" />
  <link href="../etc/fcm.css" rel="stylesheet" media="screen" />
</head>
<body>
  <div class="navbar navbar-inverse">
    <div class="container-fluid">
      <div class="navbar-header">
        <a class="navbar-brand" href=".."><span class="fcm-version">FCM</span></a>
      </div>
      <div class="collapse navbar-collapse">
        <ul class="nav navbar-nav">
          <li><a href="../installation/">Installation</a></li>

          <li><a class="active" href="#">User Guide</a></li>
        </ul>
      </div>
    </div>
  </div>

  <div class="page-header">
    <div class="fcm-page-content pull-right well well-sm"></div>
    <h1>FCM: User Guide: Annex: Quick Reference</h1>
  </div>

  <div class="container">
  <div class="row">
  <div class="col-md-12">

  <p>Note: some sub-commands can be invoked with alternate names. For example,
  <code>fcm help</code> is the same as <code>fcm ?</code>. In this annex, some
  favourite alternate names are listed, separated by a pipe, i.e. the above
  example will be given as <samp>fcm help|?</samp>.</p>

  <h2 id="help">Getting help</h2>

  <dl>
    <dt><code>fcm help|?</code></dt>

    <dd>get list of subcommands</dd>

    <dt><code>fcm help|? SUBCOMMAND</code></dt>

    <dd>get help on SUBCOMMAND</dd>
  </dl>

  <h2 id="maintaining-wc">Maintaining the working copy</h2>

  <dl>
    <dt><code>fcm checkout|co [OPTIONS] URL [DEST]</code></dt>

    <dd>Checkout URL (and create a working copy at DEST)</dd>

    <dt><code>fcm checkout|co -r N URL [DEST]</code></dt>

    <dd>Checkout revision N of URL (and create a working copy at DEST)</dd>

    <dt><code>fcm info</code></dt>

    <dd>Print working copy information</dd>

    <dt><code>fcm status|st [OPTIONS]</code></dt>

    <dd>Print status of working copy</dd>

    <dt><code>fcm status|st -u</code></dt>

    <dd>Show update information</dd>

    <dt><code>fcm status|st -v</code></dt>

    <dd>Show verbose information</dd>

    <dt><code>fcm update|up</code></dt>

    <dd>Update working copy with repository changes</dd>

    <dt><code>fcm switch|sw URL</code></dt>

    <dd>Switch your working copy to point to a branch specified by URL</dd>

    <dt><code>fcm commit|ci</code></dt>

    <dd>Commit local changes back into the repository</dd>
  </dl>

  <h2 id="preparing-changes">Preparing changes</h2>

  <dl>
    <dt><code>fcm diff|di [OPTIONS]</code></dt>

    <dd>Display working copy changes in unified diff format</dd>

    <dt><code>fcm branch-diff|bdiff|bdi [OPTIONS]</code></dt>

    <dd>Show differences relative to the base of the branch</dd>

    <dt><code>fcm diff|di -g</code></dt>

    <dd>Display working copy changes with a graphical diff tool</dd>

    <dt><code>fcm diff|di -r N</code></dt>

    <dd>Display working copy changes against revision N</dd>

    <dt><code>fcm diff|di -t</code></dt>

    <dd>Display differences in Trac, (with -b only)</dd>

    <dt><code>fcm revert [OPTIONS] PATH</code></dt>

    <dd>Restore the file PATH to the pristine copy</dd>

    <dt><code>fcm revert -R PATH</code></dt>

    <dd>Descend PATH recursively, restoring any modified files to the pristine
    copy</dd>

    <dt><code>fcm mkdir [PATH]</code></dt>

    <dd>Add a directory PATH under revision control</dd>

    <dt><code>fcm add [OPTIONS] PATH ...</code></dt>

    <dd>Add PATH under revision control</dd>

    <dt><code>fcm add -c [PATH]</code></dt>

    <dd>Check for items not under revision control and add them</dd>

    <dt><code>fcm delete|del|rm [OPTIONS] PATH ...</code></dt>

    <dd>Remove PATH from revision control</dd>

    <dt><code>fcm delete|del|rm -c [PATH]</code></dt>

    <dd>Check for missing items and remove them</dd>

    <dt><code>fcm copy|cp SRC DST</code></dt>

    <dd>Duplicate SRC to DST, remembering history</dd>

    <dt><code>fcm move|mv SRC DST</code></dt>

    <dd>Move or rename SRC to DST, remembering history</dd>

    <dt><code>fcm propset|ps svn:executable ON FILE</code></dt>

    <dd>Indicate that FILE will have executable permission when checked out to a
    Unix file system.</dd>

    <dt><code>fcm propdel|pd svn:executable FILE</code></dt>

    <dd>Reverse of the above.</dd>

    <dt><code>fcm propset|ps svn:special ON FILE</code></dt>

    <dd>Indicate that FILE is a symbolic link rather than a regular file.</dd>

    <dt><code>fcm propdel|pd svn:special FILE</code></dt>

    <dd>Reverse of the above.</dd>
  </dl>

  <h2 id="browse">Browsing</h2>

  <dl>
    <dt><code>fcm log [OPTIONS] [TARGET]</code></dt>

    <dd>Show the log message of a TARGET that can either be working copy or
    URL</dd>

    <dt><code>fcm log -r N[:M] [TARGET]</code></dt>

    <dd>Show the log message of a range of reivsions</dd>

    <dt><code>fcm propedit|pe --revprop svn:log -r N [TARGET]</code></dt>

    <dd>Edit the commit log message of revision N.</dd>

    <dt><code>fcm list|ls [OPTIONS] [TARGET]</code></dt>

    <dd>List directory entries in TARGET</dd>

    <dt><code>fcm list|ls -r N [TARGET]</code></dt>

    <dd>List directory entries of revision N</dd>

    <dt><code>fcm list|ls -v [TARGET]</code></dt>

    <dd>List directory entries in verbose mode</dd>

    <dt><code>fcm list|ls -R [TARGET]</code></dt>

    <dd>List directory entries recursively down the directories</dd>

    <dt><code>fcm browse [TARGET]</code></dt>

    <dd>Open a WWW browser to browse TARGET with Trac</dd>
  </dl>

  <h2 id="branch">Branching</h2>

  <dl>
    <dt><code>fcm branch-info|binfo [OPTIONS] [URL]</code></dt>

    <dd>Show branch information of URL or local working copy</dd>

    <dt><code>fcm branch-delete|bdel [URL]</code></dt>

    <dd>Show branch information and delete the branch</dd>

    <dt><code>fcm branch-create|bcreate NAME [URL]</code></dt>

    <dd>Create a branch</dd>

    <dt><code>fcm branch-list|blist|bls [--show-all|-a] [URL]</code></dt>

    <dd>Lists branches</dd>

    <dt><code>fcm merge [SOURCE]</code></dt>

    <dd>Merge changes from SOURCE to your working copy</dd>

    <dt><code>fcm conflicts|cf</code></dt>

    <dd>Use xxdiff to resolve conflicts in your working copy</dd>
  </dl>

  </div>
  </div>
  </div>

  <hr/>
  <div class="container-fluid text-center">
    <div class="row"><div class="col-md-12">
    <address><small>
      Copyright &copy; 2006-2021 British Crown (Met Office) &amp; Contributors.
      <a href="http://www.metoffice.gov.uk">Met Office</a>.
      See <a href="../etc/fcm-terms-of-use.html">Terms of Use</a>.<br />
      This document is released under the British <a href=
      "http://www.nationalarchives.gov.uk/doc/open-government-licence/" rel=
      "license">Open Government Licence</a>.<br />
    </small></address>
    </div></div>
  </div>

  <script type="text/javascript" src="../etc/jquery.min.js"></script>
  <script type="text/javascript" src="../etc/bootstrap/js/bootstrap.min.js"></script>
  <script type="text/javascript" src="../etc/fcm.js"></script>
  <script type="text/javascript" src="../etc/fcm-version.js"></script>
</body>
</html>