Fossil SCM

update ref page

kejoki 2008-12-19 23:09 trunk
Commit 10db583adc08da54f9119de70160f2f2f656e8fb
1 file changed +38 -23
+38 -23
--- www/reference.wiki
+++ www/reference.wiki
@@ -13,10 +13,16 @@
1313
This is traditional with VCS/SCM. Some <i>options</i> to fossil commands
1414
<i>do</i> use special delimiters, particularly the '-' (hyphen, or dash)
1515
character. This is very similar to Tcl. Think of fossil as a shell you
1616
invoke and feed a command to, including any options, and it will make
1717
more sense.
18
+
19
+ * A <u>version</u> in <b>fossil</b> is 40 character hexadecimal string.
20
+ <b>fossil</b> will be able to figure out which version you want with any
21
+ prefix of that string that is distinct from all others. <em>Commands
22
+ which require a version are looking for that string, the unique prefix,
23
+ or a <code>tag</code>.</em>
1824
1925
* Any fossil command is acceptable once enough of it has been
2026
entered to make the intent unambiguous. 'clo' is a proper prefix of
2127
both the 'clone' and 'close' commands, for instance, but 'clon' is
2228
enough to make the intent&#8212;the 'clone' command&#8212;unambiguous.
@@ -26,84 +32,85 @@
2632
2733
<code>$ fossil help</code><nowiki><pre>
2834
Usage: fossil help COMMAND.
2935
Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; ">
3036
<tr>
31
- <td><a href="#add">add</a></td>
37
+ <td><a href="#add">add</a>*</td>
3238
<td><a href="#configure">configuration</a></td>
3339
<td><a href="#leaves">leaves</a></td>
3440
<td><a href="#redo">redo</a></td>
35
- <td><a href="#server">ui</a></td>
41
+ <td><a href="#timeline">timeline</a></td>
3642
</tr>
3743
<tr>
38
- <td><a href="#all">all</a></td>
44
+ <td><a href="#all">all</a>*</td>
3945
<td><a href="#deconstruct">deconstruct</a></td>
40
- <td><a href="#ls">ls</a></td>
46
+ <td><a href="#ls">ls</a>*</td>
4147
<td><a href="#mv">rename</a></td>
42
- <td><a href="#undo">undo</a></td>
48
+ <td><a href="#server">ui</a></td>
4349
</tr>
4450
<tr>
4551
<td><a href="#cgi">cgi</a></td>
4652
<td><a href="#rm">del</a></td>
4753
<td><a href="#merge">merge</a></td>
4854
<td><a href="#revert">revert</a></td>
49
- <td><a href="#setting">unset</a></td>
55
+ <td><a href="#undo">undo</a></td>
5056
</tr>
5157
<tr>
52
- <td><a href="#changes">changes</a></td>
58
+ <td><a href="#changes">changes</a>*</td>
5359
<td><a href="#descendants">descendants</a></td>
5460
<td><a href="#mv">mv</a></td>
5561
<td><a href="#rm">rm</a></td>
56
- <td><a href="#update">update</a></td>
62
+ <td><a href="#setting">unset</a></td>
5763
</tr>
5864
<tr>
59
- <td><a href="#checkout">checkout</a></td>
65
+ <td><a href="#checkout">checkout</a>*</td>
6066
<td><a href="#diff">diff</a></td>
61
- <td><a href="#new">new</a></td>
62
- <td><a href="#server">server</a></td>
63
- <td><a href="#user">user</a></td>
67
+ <td><a href="#new">new</a>*</td>
68
+ <td><a href="#rstats">rstats</a></td>
69
+ <td><a href="#update">update</a>*</td>
6470
</tr>
6571
<tr>
6672
<td><a href="#commit">ci</a></td>
67
- <td><a href="#extra">extra</a></td>
73
+ <td><a href="#extra">extra</a>*</td>
6874
<td><a href="#open">open</a></td>
69
- <td><a href="#setting">settings</a></td>
70
- <td><a href="#version">version</a></td>
75
+ <td><a href="#server">server</a></td>
76
+ <td><a href="#user">user</a></td>
7177
</tr>
7278
<tr>
7379
<td><a href="#clean">clean</a></td>
7480
<td><a href="#diff">gdiff</a></td>
7581
<td><a href="#pull">pull</a></td>
76
- <td><a href="#status">status</a></td>
77
- <td><a href="#wiki">wiki</a></td>
82
+ <td><a href="#setting">settings</a></td>
83
+ <td><a href="#version">version</a>*</td>
7884
</tr>
7985
<tr>
8086
<td><a href="#clone">clone</a></td>
8187
<td><a href="#help">help</a></td>
8288
<td><a href="#push">push</a></td>
83
- <td><a href="#sync">sync</a></td>
89
+ <td><a href="#status">status</a>*</td>
90
+ <td><a href="#wiki">wiki</a></td>
8491
</tr>
8592
<tr>
8693
<td><a href="#close">close</a></td>
8794
<td><a href="#http">http</a></td>
8895
<td><a href="#rebuild">rebuild</a></td>
89
- <td><a href="#tag">tag</a></td>
96
+ <td><a href="#sync">sync</a>*</td>
9097
</tr>
9198
<tr>
9299
<td><a href="#commit">commit</a></td>
93100
<td><a href="#info">info</a></td>
94101
<td><a href="#reconstruct">reconstruct</a></td>
95
- <td><a href="#timeline">timeline</a></td>
102
+ <td><a href="#tag">tag</a></td>
96103
</tr>
97104
</table><nowiki><pre>
98
-This is fossil version [2be82dcc2a] 2008-12-07 18:48:09 UTC
105
+This is fossil version [ba837fd294] 2008-12-16 18:39:29 UTC
99106
</pre>
100107
<b>What follows</b> is a survey of what you get if you type<code>
101108
fossil&nbsp;help&nbsp;<i>command</i> </code>for all of the
102109
commands listed above. There are links to individual pages for each
103
-of them; pages with content (not all of them are done) go into the command
104
-in a bit more depth than the program help.
110
+of them; pages with content (commands marked with a '*' are done) go
111
+into the reason for a command in a bit more depth than the program help.
105112
<pre>
106113
<hr><a href="#tof">&#710;</a>
107114
<a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE...
108115
Make arrangements to add one or more files to the current checkout
109116
at the next commit.
@@ -315,10 +322,11 @@
315322
Move or rename one or more files within the tree
316323
317324
This command does not rename the files on disk. All this command does is
318325
record the fact that filenames have changed so that appropriate notations
319326
can be made at the next commit/checkin.
327
+
320328
<hr><a href="#tof">&#710;</a>
321329
<a name="new">Usage: </a><a href="cmd_new.wiki">fossil new</a> FILENAME
322330
323331
Create a repository for a new project in the file named FILENAME.
324332
This command is distinct from "clone". The "clone" command makes
@@ -327,10 +335,16 @@
327335
<hr><a href="#tof">&#710;</a>
328336
<a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME
329337
Open a connection to the local repository in FILENAME. A checkout
330338
for the repository is created with its root at the working directory.
331339
See also the "close" command.
340
+
341
+<hr><a href="#tof">&#710;</a>
342
+ <a name="rstats">Usage: </a><a href="cmd_rstats.wiki">fossil rstats</a>
343
+
344
+ Deliver a report of the repository statistics for the
345
+ current checkout.
332346
333347
<hr><a href="#tof">&#710;</a>
334348
<a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY?
335349
Pull changes in a remote repository into the local repository.
336350
The repository is identified by the -R or --repository option.
@@ -351,10 +365,11 @@
351365
352366
<hr><a href="#tof">&#710;</a>
353367
<a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY?
354368
Push changes in the local repository over into a remote repository.
355369
See the "pull" command for additional information.
370
+
356371
<hr><a href="#tof">&#710;</a>
357372
<a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY
358373
Reconstruct the named repository database from the core
359374
records. Run this command after updating the fossil
360375
executable in a way that changes the database schema.
361376
--- www/reference.wiki
+++ www/reference.wiki
@@ -13,10 +13,16 @@
13 This is traditional with VCS/SCM. Some <i>options</i> to fossil commands
14 <i>do</i> use special delimiters, particularly the '-' (hyphen, or dash)
15 character. This is very similar to Tcl. Think of fossil as a shell you
16 invoke and feed a command to, including any options, and it will make
17 more sense.
 
 
 
 
 
 
18
19 * Any fossil command is acceptable once enough of it has been
20 entered to make the intent unambiguous. 'clo' is a proper prefix of
21 both the 'clone' and 'close' commands, for instance, but 'clon' is
22 enough to make the intent&#8212;the 'clone' command&#8212;unambiguous.
@@ -26,84 +32,85 @@
26
27 <code>$ fossil help</code><nowiki><pre>
28 Usage: fossil help COMMAND.
29 Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; ">
30 <tr>
31 <td><a href="#add">add</a></td>
32 <td><a href="#configure">configuration</a></td>
33 <td><a href="#leaves">leaves</a></td>
34 <td><a href="#redo">redo</a></td>
35 <td><a href="#server">ui</a></td>
36 </tr>
37 <tr>
38 <td><a href="#all">all</a></td>
39 <td><a href="#deconstruct">deconstruct</a></td>
40 <td><a href="#ls">ls</a></td>
41 <td><a href="#mv">rename</a></td>
42 <td><a href="#undo">undo</a></td>
43 </tr>
44 <tr>
45 <td><a href="#cgi">cgi</a></td>
46 <td><a href="#rm">del</a></td>
47 <td><a href="#merge">merge</a></td>
48 <td><a href="#revert">revert</a></td>
49 <td><a href="#setting">unset</a></td>
50 </tr>
51 <tr>
52 <td><a href="#changes">changes</a></td>
53 <td><a href="#descendants">descendants</a></td>
54 <td><a href="#mv">mv</a></td>
55 <td><a href="#rm">rm</a></td>
56 <td><a href="#update">update</a></td>
57 </tr>
58 <tr>
59 <td><a href="#checkout">checkout</a></td>
60 <td><a href="#diff">diff</a></td>
61 <td><a href="#new">new</a></td>
62 <td><a href="#server">server</a></td>
63 <td><a href="#user">user</a></td>
64 </tr>
65 <tr>
66 <td><a href="#commit">ci</a></td>
67 <td><a href="#extra">extra</a></td>
68 <td><a href="#open">open</a></td>
69 <td><a href="#setting">settings</a></td>
70 <td><a href="#version">version</a></td>
71 </tr>
72 <tr>
73 <td><a href="#clean">clean</a></td>
74 <td><a href="#diff">gdiff</a></td>
75 <td><a href="#pull">pull</a></td>
76 <td><a href="#status">status</a></td>
77 <td><a href="#wiki">wiki</a></td>
78 </tr>
79 <tr>
80 <td><a href="#clone">clone</a></td>
81 <td><a href="#help">help</a></td>
82 <td><a href="#push">push</a></td>
83 <td><a href="#sync">sync</a></td>
 
84 </tr>
85 <tr>
86 <td><a href="#close">close</a></td>
87 <td><a href="#http">http</a></td>
88 <td><a href="#rebuild">rebuild</a></td>
89 <td><a href="#tag">tag</a></td>
90 </tr>
91 <tr>
92 <td><a href="#commit">commit</a></td>
93 <td><a href="#info">info</a></td>
94 <td><a href="#reconstruct">reconstruct</a></td>
95 <td><a href="#timeline">timeline</a></td>
96 </tr>
97 </table><nowiki><pre>
98 This is fossil version [2be82dcc2a] 2008-12-07 18:48:09 UTC
99 </pre>
100 <b>What follows</b> is a survey of what you get if you type<code>
101 fossil&nbsp;help&nbsp;<i>command</i> </code>for all of the
102 commands listed above. There are links to individual pages for each
103 of them; pages with content (not all of them are done) go into the command
104 in a bit more depth than the program help.
105 <pre>
106 <hr><a href="#tof">&#710;</a>
107 <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE...
108 Make arrangements to add one or more files to the current checkout
109 at the next commit.
@@ -315,10 +322,11 @@
315 Move or rename one or more files within the tree
316
317 This command does not rename the files on disk. All this command does is
318 record the fact that filenames have changed so that appropriate notations
319 can be made at the next commit/checkin.
 
320 <hr><a href="#tof">&#710;</a>
321 <a name="new">Usage: </a><a href="cmd_new.wiki">fossil new</a> FILENAME
322
323 Create a repository for a new project in the file named FILENAME.
324 This command is distinct from "clone". The "clone" command makes
@@ -327,10 +335,16 @@
327 <hr><a href="#tof">&#710;</a>
328 <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME
329 Open a connection to the local repository in FILENAME. A checkout
330 for the repository is created with its root at the working directory.
331 See also the "close" command.
 
 
 
 
 
 
332
333 <hr><a href="#tof">&#710;</a>
334 <a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY?
335 Pull changes in a remote repository into the local repository.
336 The repository is identified by the -R or --repository option.
@@ -351,10 +365,11 @@
351
352 <hr><a href="#tof">&#710;</a>
353 <a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY?
354 Push changes in the local repository over into a remote repository.
355 See the "pull" command for additional information.
 
356 <hr><a href="#tof">&#710;</a>
357 <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY
358 Reconstruct the named repository database from the core
359 records. Run this command after updating the fossil
360 executable in a way that changes the database schema.
361
--- www/reference.wiki
+++ www/reference.wiki
@@ -13,10 +13,16 @@
13 This is traditional with VCS/SCM. Some <i>options</i> to fossil commands
14 <i>do</i> use special delimiters, particularly the '-' (hyphen, or dash)
15 character. This is very similar to Tcl. Think of fossil as a shell you
16 invoke and feed a command to, including any options, and it will make
17 more sense.
18
19 * A <u>version</u> in <b>fossil</b> is 40 character hexadecimal string.
20 <b>fossil</b> will be able to figure out which version you want with any
21 prefix of that string that is distinct from all others. <em>Commands
22 which require a version are looking for that string, the unique prefix,
23 or a <code>tag</code>.</em>
24
25 * Any fossil command is acceptable once enough of it has been
26 entered to make the intent unambiguous. 'clo' is a proper prefix of
27 both the 'clone' and 'close' commands, for instance, but 'clon' is
28 enough to make the intent&#8212;the 'clone' command&#8212;unambiguous.
@@ -26,84 +32,85 @@
32
33 <code>$ fossil help</code><nowiki><pre>
34 Usage: fossil help COMMAND.
35 Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; ">
36 <tr>
37 <td><a href="#add">add</a>*</td>
38 <td><a href="#configure">configuration</a></td>
39 <td><a href="#leaves">leaves</a></td>
40 <td><a href="#redo">redo</a></td>
41 <td><a href="#timeline">timeline</a></td>
42 </tr>
43 <tr>
44 <td><a href="#all">all</a>*</td>
45 <td><a href="#deconstruct">deconstruct</a></td>
46 <td><a href="#ls">ls</a>*</td>
47 <td><a href="#mv">rename</a></td>
48 <td><a href="#server">ui</a></td>
49 </tr>
50 <tr>
51 <td><a href="#cgi">cgi</a></td>
52 <td><a href="#rm">del</a></td>
53 <td><a href="#merge">merge</a></td>
54 <td><a href="#revert">revert</a></td>
55 <td><a href="#undo">undo</a></td>
56 </tr>
57 <tr>
58 <td><a href="#changes">changes</a>*</td>
59 <td><a href="#descendants">descendants</a></td>
60 <td><a href="#mv">mv</a></td>
61 <td><a href="#rm">rm</a></td>
62 <td><a href="#setting">unset</a></td>
63 </tr>
64 <tr>
65 <td><a href="#checkout">checkout</a>*</td>
66 <td><a href="#diff">diff</a></td>
67 <td><a href="#new">new</a>*</td>
68 <td><a href="#rstats">rstats</a></td>
69 <td><a href="#update">update</a>*</td>
70 </tr>
71 <tr>
72 <td><a href="#commit">ci</a></td>
73 <td><a href="#extra">extra</a>*</td>
74 <td><a href="#open">open</a></td>
75 <td><a href="#server">server</a></td>
76 <td><a href="#user">user</a></td>
77 </tr>
78 <tr>
79 <td><a href="#clean">clean</a></td>
80 <td><a href="#diff">gdiff</a></td>
81 <td><a href="#pull">pull</a></td>
82 <td><a href="#setting">settings</a></td>
83 <td><a href="#version">version</a>*</td>
84 </tr>
85 <tr>
86 <td><a href="#clone">clone</a></td>
87 <td><a href="#help">help</a></td>
88 <td><a href="#push">push</a></td>
89 <td><a href="#status">status</a>*</td>
90 <td><a href="#wiki">wiki</a></td>
91 </tr>
92 <tr>
93 <td><a href="#close">close</a></td>
94 <td><a href="#http">http</a></td>
95 <td><a href="#rebuild">rebuild</a></td>
96 <td><a href="#sync">sync</a>*</td>
97 </tr>
98 <tr>
99 <td><a href="#commit">commit</a></td>
100 <td><a href="#info">info</a></td>
101 <td><a href="#reconstruct">reconstruct</a></td>
102 <td><a href="#tag">tag</a></td>
103 </tr>
104 </table><nowiki><pre>
105 This is fossil version [ba837fd294] 2008-12-16 18:39:29 UTC
106 </pre>
107 <b>What follows</b> is a survey of what you get if you type<code>
108 fossil&nbsp;help&nbsp;<i>command</i> </code>for all of the
109 commands listed above. There are links to individual pages for each
110 of them; pages with content (commands marked with a '*' are done) go
111 into the reason for a command in a bit more depth than the program help.
112 <pre>
113 <hr><a href="#tof">&#710;</a>
114 <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE...
115 Make arrangements to add one or more files to the current checkout
116 at the next commit.
@@ -315,10 +322,11 @@
322 Move or rename one or more files within the tree
323
324 This command does not rename the files on disk. All this command does is
325 record the fact that filenames have changed so that appropriate notations
326 can be made at the next commit/checkin.
327
328 <hr><a href="#tof">&#710;</a>
329 <a name="new">Usage: </a><a href="cmd_new.wiki">fossil new</a> FILENAME
330
331 Create a repository for a new project in the file named FILENAME.
332 This command is distinct from "clone". The "clone" command makes
@@ -327,10 +335,16 @@
335 <hr><a href="#tof">&#710;</a>
336 <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME
337 Open a connection to the local repository in FILENAME. A checkout
338 for the repository is created with its root at the working directory.
339 See also the "close" command.
340
341 <hr><a href="#tof">&#710;</a>
342 <a name="rstats">Usage: </a><a href="cmd_rstats.wiki">fossil rstats</a>
343
344 Deliver a report of the repository statistics for the
345 current checkout.
346
347 <hr><a href="#tof">&#710;</a>
348 <a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY?
349 Pull changes in a remote repository into the local repository.
350 The repository is identified by the -R or --repository option.
@@ -351,10 +365,11 @@
365
366 <hr><a href="#tof">&#710;</a>
367 <a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY?
368 Push changes in the local repository over into a remote repository.
369 See the "pull" command for additional information.
370
371 <hr><a href="#tof">&#710;</a>
372 <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY
373 Reconstruct the named repository database from the core
374 records. Run this command after updating the fossil
375 executable in a way that changes the database schema.
376

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button