| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
|---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
|---|
| 3 | |
|---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> |
|---|
| 5 | <head> |
|---|
| 6 | <meta name="generator" content= |
|---|
| 7 | "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" /> |
|---|
| 8 | |
|---|
| 9 | <title>Annex: Quick reference</title> |
|---|
| 10 | <meta name="author" content="FCM development team" /> |
|---|
| 11 | <meta name="descriptions" content="User Guide Annex" /> |
|---|
| 12 | <meta name="keywords" content="FCM, user guide, annex" /> |
|---|
| 13 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|---|
| 14 | <link rel="stylesheet" type="text/css" href="style.css" /> |
|---|
| 15 | <script type="text/javascript" src="fcm.js"> |
|---|
| 16 | </script> |
|---|
| 17 | </head> |
|---|
| 18 | |
|---|
| 19 | <body onload= |
|---|
| 20 | "javascript: FCM.load('doc/user_guide/', null, [['.', 'FCM User Guide']]);"> |
|---|
| 21 | <div id="document-info"> |
|---|
| 22 | <address id="fcm-js-trail"></address> |
|---|
| 23 | |
|---|
| 24 | <address id="fcm-js-maintenance"></address> |
|---|
| 25 | </div> |
|---|
| 26 | |
|---|
| 27 | <h1>Annex: Quick reference</h1> |
|---|
| 28 | |
|---|
| 29 | <p>Note: some sub-commands can be invoked with alternate names. For example, |
|---|
| 30 | <code>fcm help</code> is the same as <code>fcm ?</code>. In this annex, some |
|---|
| 31 | favourite alternate names are listed, separated by a pipe, i.e. the above |
|---|
| 32 | example will be given as <samp>fcm help|?</samp>.</p> |
|---|
| 33 | |
|---|
| 34 | <h2 id="help">Getting help</h2> |
|---|
| 35 | |
|---|
| 36 | <dl> |
|---|
| 37 | <dt><code>fcm help|?</code></dt> |
|---|
| 38 | |
|---|
| 39 | <dd>get list of subcommands</dd> |
|---|
| 40 | |
|---|
| 41 | <dt><code>fcm help|? SUBCOMMAND</code></dt> |
|---|
| 42 | |
|---|
| 43 | <dd>get help on SUBCOMMAND</dd> |
|---|
| 44 | </dl> |
|---|
| 45 | |
|---|
| 46 | <h2 id="maintaining-wc">Maintaining the working copy</h2> |
|---|
| 47 | |
|---|
| 48 | <dl> |
|---|
| 49 | <dt><code>fcm checkout|co [OPTIONS] URL [DEST]</code></dt> |
|---|
| 50 | |
|---|
| 51 | <dd>Checkout URL (and create a working copy at DEST)</dd> |
|---|
| 52 | |
|---|
| 53 | <dt><code>fcm checkout|co -r N URL [DEST]</code></dt> |
|---|
| 54 | |
|---|
| 55 | <dd>Checkout revision N of URL (and create a working copy at DEST)</dd> |
|---|
| 56 | |
|---|
| 57 | <dt><code>fcm info</code></dt> |
|---|
| 58 | |
|---|
| 59 | <dd>Print working copy information</dd> |
|---|
| 60 | |
|---|
| 61 | <dt><code>fcm status|st [OPTIONS]</code></dt> |
|---|
| 62 | |
|---|
| 63 | <dd>Print status of working copy</dd> |
|---|
| 64 | |
|---|
| 65 | <dt><code>fcm status|st -u</code></dt> |
|---|
| 66 | |
|---|
| 67 | <dd>Show update information</dd> |
|---|
| 68 | |
|---|
| 69 | <dt><code>fcm status|st -v</code></dt> |
|---|
| 70 | |
|---|
| 71 | <dd>Show verbose information</dd> |
|---|
| 72 | |
|---|
| 73 | <dt><code>fcm update|up</code></dt> |
|---|
| 74 | |
|---|
| 75 | <dd>Update working copy with repository changes</dd> |
|---|
| 76 | |
|---|
| 77 | <dt><code>fcm switch|sw URL</code></dt> |
|---|
| 78 | |
|---|
| 79 | <dd>Switch your working copy to point to a branch specified by URL</dd> |
|---|
| 80 | |
|---|
| 81 | <dt><code>fcm commit|ci</code></dt> |
|---|
| 82 | |
|---|
| 83 | <dd>Commit local changes back into the repository</dd> |
|---|
| 84 | </dl> |
|---|
| 85 | |
|---|
| 86 | <h2 id="preparing-changes">Preparing changes</h2> |
|---|
| 87 | |
|---|
| 88 | <dl> |
|---|
| 89 | <dt><code>fcm diff|di [OPTIONS]</code></dt> |
|---|
| 90 | |
|---|
| 91 | <dd>Display working copy changes in unified diff format</dd> |
|---|
| 92 | |
|---|
| 93 | <dt><code>fcm diff|di -b</code></dt> |
|---|
| 94 | |
|---|
| 95 | <dd>Show differences relative to the base of the branch</dd> |
|---|
| 96 | |
|---|
| 97 | <dt><code>fcm diff|di -g</code></dt> |
|---|
| 98 | |
|---|
| 99 | <dd>Display working copy changes with a graphical diff tool</dd> |
|---|
| 100 | |
|---|
| 101 | <dt><code>fcm diff|di -r N</code></dt> |
|---|
| 102 | |
|---|
| 103 | <dd>Display working copy changes against revision N</dd> |
|---|
| 104 | |
|---|
| 105 | <dt><code>fcm diff|di -t</code></dt> |
|---|
| 106 | |
|---|
| 107 | <dd>Display differences in Trac, (with -b only)</dd> |
|---|
| 108 | |
|---|
| 109 | <dt><code>fcm revert [OPTIONS] PATH</code></dt> |
|---|
| 110 | |
|---|
| 111 | <dd>Restore the file PATH to the pristine copy</dd> |
|---|
| 112 | |
|---|
| 113 | <dt><code>fcm revert -R PATH</code></dt> |
|---|
| 114 | |
|---|
| 115 | <dd>Descend PATH recursively, restoring any modified files to the pristine |
|---|
| 116 | copy</dd> |
|---|
| 117 | |
|---|
| 118 | <dt><code>fcm mkdir [PATH]</code></dt> |
|---|
| 119 | |
|---|
| 120 | <dd>Add a directory PATH under revision control</dd> |
|---|
| 121 | |
|---|
| 122 | <dt><code>fcm add [OPTIONS] [PATH]</code></dt> |
|---|
| 123 | |
|---|
| 124 | <dd>Add PATH under revision control</dd> |
|---|
| 125 | |
|---|
| 126 | <dt><code>fcm add -c [PATH]</code></dt> |
|---|
| 127 | |
|---|
| 128 | <dd>Check for items not under revision control and add them</dd> |
|---|
| 129 | |
|---|
| 130 | <dt><code>fcm delete|del|rm [OPTIONS] [PATH]</code></dt> |
|---|
| 131 | |
|---|
| 132 | <dd>Remove PATH from revision control</dd> |
|---|
| 133 | |
|---|
| 134 | <dt><code>fcm delete|del|rm -c [PATH]</code></dt> |
|---|
| 135 | |
|---|
| 136 | <dd>Check for missing items and remove them</dd> |
|---|
| 137 | |
|---|
| 138 | <dt><code>fcm copy|cp SRC DST</code></dt> |
|---|
| 139 | |
|---|
| 140 | <dd>Duplicate SRC to DST, remembering history</dd> |
|---|
| 141 | |
|---|
| 142 | <dt><code>fcm move|mv SRC DST</code></dt> |
|---|
| 143 | |
|---|
| 144 | <dd>Move or rename SRC to DST, remembering history</dd> |
|---|
| 145 | </dl> |
|---|
| 146 | |
|---|
| 147 | <h2 id="browse">Browsing</h2> |
|---|
| 148 | |
|---|
| 149 | <dl> |
|---|
| 150 | <dt><code>fcm log [OPTIONS] [TARGET]</code></dt> |
|---|
| 151 | |
|---|
| 152 | <dd>Show the log message of a TARGET that can either be working copy or |
|---|
| 153 | URL</dd> |
|---|
| 154 | |
|---|
| 155 | <dt><code>fcm log -r N[:M] [TARGET]</code></dt> |
|---|
| 156 | |
|---|
| 157 | <dd>Show the log message of a range of reivsions</dd> |
|---|
| 158 | |
|---|
| 159 | <dt><code>fcm list|ls [OPTIONS] [TARGET]</code></dt> |
|---|
| 160 | |
|---|
| 161 | <dd>List directory entries in TARGET</dd> |
|---|
| 162 | |
|---|
| 163 | <dt><code>fcm list|ls -r N [TARGET]</code></dt> |
|---|
| 164 | |
|---|
| 165 | <dd>List directory entries of revision N</dd> |
|---|
| 166 | |
|---|
| 167 | <dt><code>fcm list|ls -v [TARGET]</code></dt> |
|---|
| 168 | |
|---|
| 169 | <dd>List directory entries in verbose mode</dd> |
|---|
| 170 | |
|---|
| 171 | <dt><code>fcm list|ls -R [TARGET]</code></dt> |
|---|
| 172 | |
|---|
| 173 | <dd>List directory entries recursively down the directories</dd> |
|---|
| 174 | |
|---|
| 175 | <dt><code>fcm trac [TARGET]</code></dt> |
|---|
| 176 | |
|---|
| 177 | <dd>Open a WWW browser to browse TARGET with Trac</dd> |
|---|
| 178 | </dl> |
|---|
| 179 | |
|---|
| 180 | <h2 id="branch">Branching</h2> |
|---|
| 181 | |
|---|
| 182 | <dl> |
|---|
| 183 | <dt><code>fcm branch|br [OPTIONS] [URL]</code></dt> |
|---|
| 184 | |
|---|
| 185 | <dd>Show branch information of URL or local working copy</dd> |
|---|
| 186 | |
|---|
| 187 | <dt><code>fcm branch|br -d [URL]</code></dt> |
|---|
| 188 | |
|---|
| 189 | <dd>Show branch information and delete the branch</dd> |
|---|
| 190 | |
|---|
| 191 | <dt><code>fcm branch|br -c -n NAME [URL]</code></dt> |
|---|
| 192 | |
|---|
| 193 | <dd>Create a branch</dd> |
|---|
| 194 | |
|---|
| 195 | <dt><code>fcm merge [SOURCE]</code></dt> |
|---|
| 196 | |
|---|
| 197 | <dd>Merge changes from SOURCE to your working copy</dd> |
|---|
| 198 | |
|---|
| 199 | <dt><code>fcm conflicts|cf</code></dt> |
|---|
| 200 | |
|---|
| 201 | <dd>Use xxdiff to resolve conflicts in your working copy</dd> |
|---|
| 202 | </dl> |
|---|
| 203 | </body> |
|---|
| 204 | </html> |
|---|
