Fossil SCM

Adjust some wikilinks, clean up main ref page, add "new" command.

kejoki 2008-12-12 21:55 trunk
Commit 1eb067d45626121fb666d111b654eaf47943c351
+13 -3
--- kktodo.wiki
+++ kktodo.wiki
@@ -2,11 +2,11 @@
22
33
.plan -- <i>Fossil, the DG</i> Bwahahahaha! The cover art could be an <i>homo erectus</i> skull lying on some COBOL code...
44
55
1. Command line interface reference docs
66
<ul>
7
- <li> Finish initial pages.</li>
7
+ <li> <font color="#bb4466">Finish initial pages.</font></li>
88
<li> Start on tech-spec (serious, not "chatty") reference pages.</li>
99
<li> Edit, edit, edit.</li>
1010
</ul>
1111
1212
2. Support docs
@@ -25,23 +25,33 @@
2525
</ul>
2626
</li>
2727
<li>Hmmm. Experimenting.</li>
2828
<ul>
2929
<li>The road less travelled, or where'd that
30
- fork come from?</l>
30
+ fork come from?</li>
3131
</ul>
3232
<li>Oops! Going back in time.</li>
33
+ <ul>
34
+ <li>Versions</li>
35
+ <ul>
36
+ <li>What <i>is</i> a version?</li>
37
+ <li>Is it a "version" or a "tag"?</li>
38
+ <li>DSCM redux: Revisionist versioning.</li>
39
+ </ul>
40
+ </ul>
3341
</ul>
3442
</li>
3543
<li>Basic explanation of <i>merge</i>.
3644
<ol>
37
- <li>Leaves, branches and baselines.</li>
45
+ <li>Leaves, branches and baselines: We want a shrubbery!</li>
3846
<li><i>update</i> merges vs. <i>merge</i> merges.
3947
All merges are equal, but some are more equal than others.</li>
4048
</ol>
4149
</li>
4250
</ul>
51
+
52
+ 3. Configuration
4353
4454
42. General
4555
<ul>
4656
<li>Co-ordinate style and tone with drh, other devs. (documentation
4757
standard? yuck.)</li>
4858
--- kktodo.wiki
+++ kktodo.wiki
@@ -2,11 +2,11 @@
2
3 .plan -- <i>Fossil, the DG</i> Bwahahahaha! The cover art could be an <i>homo erectus</i> skull lying on some COBOL code...
4
5 1. Command line interface reference docs
6 <ul>
7 <li> Finish initial pages.</li>
8 <li> Start on tech-spec (serious, not "chatty") reference pages.</li>
9 <li> Edit, edit, edit.</li>
10 </ul>
11
12 2. Support docs
@@ -25,23 +25,33 @@
25 </ul>
26 </li>
27 <li>Hmmm. Experimenting.</li>
28 <ul>
29 <li>The road less travelled, or where'd that
30 fork come from?</l>
31 </ul>
32 <li>Oops! Going back in time.</li>
 
 
 
 
 
 
 
 
33 </ul>
34 </li>
35 <li>Basic explanation of <i>merge</i>.
36 <ol>
37 <li>Leaves, branches and baselines.</li>
38 <li><i>update</i> merges vs. <i>merge</i> merges.
39 All merges are equal, but some are more equal than others.</li>
40 </ol>
41 </li>
42 </ul>
 
 
43
44 42. General
45 <ul>
46 <li>Co-ordinate style and tone with drh, other devs. (documentation
47 standard? yuck.)</li>
48
--- kktodo.wiki
+++ kktodo.wiki
@@ -2,11 +2,11 @@
2
3 .plan -- <i>Fossil, the DG</i> Bwahahahaha! The cover art could be an <i>homo erectus</i> skull lying on some COBOL code...
4
5 1. Command line interface reference docs
6 <ul>
7 <li> <font color="#bb4466">Finish initial pages.</font></li>
8 <li> Start on tech-spec (serious, not "chatty") reference pages.</li>
9 <li> Edit, edit, edit.</li>
10 </ul>
11
12 2. Support docs
@@ -25,23 +25,33 @@
25 </ul>
26 </li>
27 <li>Hmmm. Experimenting.</li>
28 <ul>
29 <li>The road less travelled, or where'd that
30 fork come from?</li>
31 </ul>
32 <li>Oops! Going back in time.</li>
33 <ul>
34 <li>Versions</li>
35 <ul>
36 <li>What <i>is</i> a version?</li>
37 <li>Is it a "version" or a "tag"?</li>
38 <li>DSCM redux: Revisionist versioning.</li>
39 </ul>
40 </ul>
41 </ul>
42 </li>
43 <li>Basic explanation of <i>merge</i>.
44 <ol>
45 <li>Leaves, branches and baselines: We want a shrubbery!</li>
46 <li><i>update</i> merges vs. <i>merge</i> merges.
47 All merges are equal, but some are more equal than others.</li>
48 </ol>
49 </li>
50 </ul>
51
52 3. Configuration
53
54 42. General
55 <ul>
56 <li>Co-ordinate style and tone with drh, other devs. (documentation
57 standard? yuck.)</li>
58
+15 -15
--- www/cmd_all.wiki
+++ www/cmd_all.wiki
@@ -4,15 +4,15 @@
44
<em>all</em> of your repositories, and provides a way of finding all
55
of your repositories as well.
66
77
There are some commands you might especially want to perform on every
88
repository you've got, once in a while. <code> fossil&nbsp;all
9
-</code> includes four of the most likely as sub-commands:
10
-<code><a href="cmd_pull.wiki">pull</a></code>,
11
-<code><a href="cmd_push.wiki">push</a></code>,
12
-<code><a href="cmd_rebuild.wiki">rebuild</a></code> and
13
-<code><a href="cmd_sync.wiki">sync</a></code>.
9
+</code> includes four of the most likely as sub-commands:
10
+[./cmd_pull.wiki | <code>pull</code>],
11
+[./cmd_push.wiki | <code>push</code>],
12
+[./cmd_rebuild.wiki | <code>rebuild</code>] and
13
+[./cmd_sync.wiki | <code>sync</code>].
1414
1515
Follow the links to find out what each of those do, and then a moment
1616
of thought will tell you why you might want to have them available for
1717
all repositories.
1818
@@ -43,17 +43,17 @@
4343
quickly that you've done it&#8212;many commands you try to use from
4444
inside of a checkout won't work correctly. The <i>.fossil</i> file is
4545
an <b>sqlite</b> db file which fossil uses to keeping track of
4646
repository locations. Advice: if you move your repositories around,
4747
let fossil know you did;
48
-<code><a href="cmd_close.wiki">close</a></code> them before you move
49
-them, and then <code><a href="cmd_open.wiki">open</a></code> them from
48
+[./cmd_close.wiki | <code>close</code>] them before you move
49
+them, and then [./cmd_open.wiki | <code>open</code>] them from
5050
their new locations.
5151
52
-See also: <a href="cmd_pull.wiki">fossil pull</a>,
53
-<a href="cmd_push.wiki">fossil push</a>,
54
-<a href="cmd_rebuild.wiki">fossil rebuild</a>,
55
-<a href="cmd_sync.wiki">fossil sync</a>,
56
-<a href="cmd_open.wiki">fossil open</a>,
57
-<a href="cmd_close.wiki">fossil close</a>,
58
-<a href="reference.wiki">Reference</a>,
59
-<b><a href="http://www.sqlite.org">sqlite</a></b>
52
+See also: [./cmd_pull.wiki | fossil pull],
53
+[./cmd_push.wiki | fossil push],
54
+[./cmd_rebuild.wiki | fossil rebuild],
55
+[./cmd_sync.wiki | fossil sync],
56
+[./cmd_open.wiki | fossil open],
57
+[./cmd_close.wiki | fossil close],
58
+[./reference.wiki | Reference],
59
+[http://www.sqlite.org | <b>SQLite</b>]
6060
--- www/cmd_all.wiki
+++ www/cmd_all.wiki
@@ -4,15 +4,15 @@
4 <em>all</em> of your repositories, and provides a way of finding all
5 of your repositories as well.
6
7 There are some commands you might especially want to perform on every
8 repository you've got, once in a while. <code> fossil&nbsp;all
9 </code> includes four of the most likely as sub-commands:
10 <code><a href="cmd_pull.wiki">pull</a></code>,
11 <code><a href="cmd_push.wiki">push</a></code>,
12 <code><a href="cmd_rebuild.wiki">rebuild</a></code> and
13 <code><a href="cmd_sync.wiki">sync</a></code>.
14
15 Follow the links to find out what each of those do, and then a moment
16 of thought will tell you why you might want to have them available for
17 all repositories.
18
@@ -43,17 +43,17 @@
43 quickly that you've done it&#8212;many commands you try to use from
44 inside of a checkout won't work correctly. The <i>.fossil</i> file is
45 an <b>sqlite</b> db file which fossil uses to keeping track of
46 repository locations. Advice: if you move your repositories around,
47 let fossil know you did;
48 <code><a href="cmd_close.wiki">close</a></code> them before you move
49 them, and then <code><a href="cmd_open.wiki">open</a></code> them from
50 their new locations.
51
52 See also: <a href="cmd_pull.wiki">fossil pull</a>,
53 <a href="cmd_push.wiki">fossil push</a>,
54 <a href="cmd_rebuild.wiki">fossil rebuild</a>,
55 <a href="cmd_sync.wiki">fossil sync</a>,
56 <a href="cmd_open.wiki">fossil open</a>,
57 <a href="cmd_close.wiki">fossil close</a>,
58 <a href="reference.wiki">Reference</a>,
59 <b><a href="http://www.sqlite.org">sqlite</a></b>
60
--- www/cmd_all.wiki
+++ www/cmd_all.wiki
@@ -4,15 +4,15 @@
4 <em>all</em> of your repositories, and provides a way of finding all
5 of your repositories as well.
6
7 There are some commands you might especially want to perform on every
8 repository you've got, once in a while. <code> fossil&nbsp;all
9 </code> includes four of the most likely as sub-commands:
10 [./cmd_pull.wiki | <code>pull</code>],
11 [./cmd_push.wiki | <code>push</code>],
12 [./cmd_rebuild.wiki | <code>rebuild</code>] and
13 [./cmd_sync.wiki | <code>sync</code>].
14
15 Follow the links to find out what each of those do, and then a moment
16 of thought will tell you why you might want to have them available for
17 all repositories.
18
@@ -43,17 +43,17 @@
43 quickly that you've done it&#8212;many commands you try to use from
44 inside of a checkout won't work correctly. The <i>.fossil</i> file is
45 an <b>sqlite</b> db file which fossil uses to keeping track of
46 repository locations. Advice: if you move your repositories around,
47 let fossil know you did;
48 [./cmd_close.wiki | <code>close</code>] them before you move
49 them, and then [./cmd_open.wiki | <code>open</code>] them from
50 their new locations.
51
52 See also: [./cmd_pull.wiki | fossil pull],
53 [./cmd_push.wiki | fossil push],
54 [./cmd_rebuild.wiki | fossil rebuild],
55 [./cmd_sync.wiki | fossil sync],
56 [./cmd_open.wiki | fossil open],
57 [./cmd_close.wiki | fossil close],
58 [./reference.wiki | Reference],
59 [http://www.sqlite.org | <b>SQLite</b>]
60
--- www/cmd_extra.wiki
+++ www/cmd_extra.wiki
@@ -7,14 +7,14 @@
77
the repository.
88
99
The <code>fossil extra</code> command will get you a list of these files.
1010
1111
This is convenient for figuring out if you've <code>
12
-<a href="cmd_add.wiki">add</a></code>ed every file that needs to be
12
+[./cmd_add.wiki | add]</code>ed every file that needs to be
1313
1414
in the repository before you do a commit. It will also tell you what
15
-will be removed if you <code><a href="cmd_clean.wiki">clean</a></code>
15
+will be removed if you [./cmd_clean.wiki | <code>clean</code>]
1616
the project.
1717
1818
Suppose, for example, you have a "noodle.src" file as a scratch pad
1919
for source code, and you don't want to include your latest
2020
hare-brained ideas in the repository? You don't <code>add</code> it
@@ -27,12 +27,12 @@
2727
If you don't think this is all that useful, then you've never had to write
2828
a shell script that only affects project files and leaves everything
2929
else alone. ;)
3030
3131
The <code>extra</code> command is almost, but not quite entirely, the exact
32
-opposite of the <code><a href="cmd_ls.wiki">ls</a></code> command.
32
+opposite of the [./cmd_ls.wiki | <code>ls</code>] command.
3333
34
-See also: <a href="cmd_status.wiki">fossil status</a>,
35
-<a href="cmd_ls.wiki">fossil ls</a>,
36
-<a href="cmd_changes.wiki">fossil changes</a>,
37
-<a href="cmd_clean.wiki">fossil clean</a>,
38
-<a href="reference.wiki">Reference</a>
34
+See also: [./cmd_status.wiki | fossil status],
35
+[./cmd_ls.wiki | fossil ls],
36
+[./cmd_changes.wiki | fossil changes],
37
+[./cmd_clean.wiki | fossil clean],
38
+[./reference.wiki | Reference]
3939
--- www/cmd_extra.wiki
+++ www/cmd_extra.wiki
@@ -7,14 +7,14 @@
7 the repository.
8
9 The <code>fossil extra</code> command will get you a list of these files.
10
11 This is convenient for figuring out if you've <code>
12 <a href="cmd_add.wiki">add</a></code>ed every file that needs to be
13
14 in the repository before you do a commit. It will also tell you what
15 will be removed if you <code><a href="cmd_clean.wiki">clean</a></code>
16 the project.
17
18 Suppose, for example, you have a "noodle.src" file as a scratch pad
19 for source code, and you don't want to include your latest
20 hare-brained ideas in the repository? You don't <code>add</code> it
@@ -27,12 +27,12 @@
27 If you don't think this is all that useful, then you've never had to write
28 a shell script that only affects project files and leaves everything
29 else alone. ;)
30
31 The <code>extra</code> command is almost, but not quite entirely, the exact
32 opposite of the <code><a href="cmd_ls.wiki">ls</a></code> command.
33
34 See also: <a href="cmd_status.wiki">fossil status</a>,
35 <a href="cmd_ls.wiki">fossil ls</a>,
36 <a href="cmd_changes.wiki">fossil changes</a>,
37 <a href="cmd_clean.wiki">fossil clean</a>,
38 <a href="reference.wiki">Reference</a>
39
--- www/cmd_extra.wiki
+++ www/cmd_extra.wiki
@@ -7,14 +7,14 @@
7 the repository.
8
9 The <code>fossil extra</code> command will get you a list of these files.
10
11 This is convenient for figuring out if you've <code>
12 [./cmd_add.wiki | add]</code>ed every file that needs to be
13
14 in the repository before you do a commit. It will also tell you what
15 will be removed if you [./cmd_clean.wiki | <code>clean</code>]
16 the project.
17
18 Suppose, for example, you have a "noodle.src" file as a scratch pad
19 for source code, and you don't want to include your latest
20 hare-brained ideas in the repository? You don't <code>add</code> it
@@ -27,12 +27,12 @@
27 If you don't think this is all that useful, then you've never had to write
28 a shell script that only affects project files and leaves everything
29 else alone. ;)
30
31 The <code>extra</code> command is almost, but not quite entirely, the exact
32 opposite of the [./cmd_ls.wiki | <code>ls</code>] command.
33
34 See also: [./cmd_status.wiki | fossil status],
35 [./cmd_ls.wiki | fossil ls],
36 [./cmd_changes.wiki | fossil changes],
37 [./cmd_clean.wiki | fossil clean],
38 [./reference.wiki | Reference]
39
+9 -8
--- www/cmd_ls.wiki
+++ www/cmd_ls.wiki
@@ -1,11 +1,11 @@
11
<h2>ls</h2>
22
33
The <code>ls</code><a href="#notes">*</a> command is informational, it doesn't do anything to
44
a checked-out project, but it tells you something about it.
55
6
-A project consists of a "source tree" of "artifacts" (see <a href="concepts.wiki">Fossil concepts</a>.)
6
+A project consists of a "source tree" of "artifacts" (see [./concepts.wiki | Fossil concepts].)
77
From a practical standpoint this is a set of files and directories rooted
88
at a main project directory. The files that are under source control aren't
99
particularly distinguishable from those that aren't. The <code>ls</code> and
1010
<code>extra</code> commands provide this information.
1111
@@ -18,11 +18,11 @@
1818
it's the status as <b>fossil</b> sees it and has nothing to do with
1919
filesystem status. If you're new to source-management/version-control
2020
systems, you'll probably get bit by this concept-bug at least once.
2121
2222
To really see the difference, issue an <code>ls</code> before and after doing
23
-a <a href="cmd_commit.wiki"><code>commit</code></a>. Before, the status of files may be any of the three,
23
+a [./cmd_commit.wiki | <code>commit</code>]. Before, the status of files may be any of the three,
2424
but after <code>commit</code>ting changes the status will be UNCHANGED "across
2525
the board."
2626
2727
By way of example, here's what I see if I <code>fossil ls</code> in the
2828
directory where I have checked out my testing repository:
@@ -39,16 +39,17 @@
3939
_FOSSIL_ manifest nibcrod
4040
</pre></nowiki>
4141
4242
The <code>ls</code> command is almost, but not quite entirely, the exact
4343
opposite of the
44
-<a href="cmd_extra.wiki"><code>extra</code> command</a>.
44
+[./cmd_extra.wiki | <code>extra</code> command].
4545
4646
<a name="notes">Notes:</a>
4747
* If you come from the <b>Windows</b> world, it will help to know that 'ls' is the usual <b>unix</b> command for listing a directory.
4848
* There are more states for a file to be in than those listed, including MISSING, EDITED, RENAMED and a couple of others.
4949
50
-See also: <a href="cmd_add.wiki">fossil add</a>, <a href="rm.wiki">
51
-fossil rm</a>, <a href="cmd_extra.wiki">fossil extra</a>,
52
-<a href="cmd_commit.wiki">fossil commit</a>,
53
-<a href="concepts.wiki">Fossil concepts</a>,
54
-<a href="reference.wiki">Reference</a>
50
+See also: [./cmd_add.wiki | fossil add],
51
+[./rm.wiki | fossil rm],
52
+[./cmd_extra.wiki | fossil extra],
53
+[./cmd_commit.wiki | fossil commit],
54
+[./concepts.wiki | Fossil concepts],
55
+[./reference.wiki | Reference]
5556
5657
ADDED www/cmd_new.wiki
--- www/cmd_ls.wiki
+++ www/cmd_ls.wiki
@@ -1,11 +1,11 @@
1 <h2>ls</h2>
2
3 The <code>ls</code><a href="#notes">*</a> command is informational, it doesn't do anything to
4 a checked-out project, but it tells you something about it.
5
6 A project consists of a "source tree" of "artifacts" (see <a href="concepts.wiki">Fossil concepts</a>.)
7 From a practical standpoint this is a set of files and directories rooted
8 at a main project directory. The files that are under source control aren't
9 particularly distinguishable from those that aren't. The <code>ls</code> and
10 <code>extra</code> commands provide this information.
11
@@ -18,11 +18,11 @@
18 it's the status as <b>fossil</b> sees it and has nothing to do with
19 filesystem status. If you're new to source-management/version-control
20 systems, you'll probably get bit by this concept-bug at least once.
21
22 To really see the difference, issue an <code>ls</code> before and after doing
23 a <a href="cmd_commit.wiki"><code>commit</code></a>. Before, the status of files may be any of the three,
24 but after <code>commit</code>ting changes the status will be UNCHANGED "across
25 the board."
26
27 By way of example, here's what I see if I <code>fossil ls</code> in the
28 directory where I have checked out my testing repository:
@@ -39,16 +39,17 @@
39 _FOSSIL_ manifest nibcrod
40 </pre></nowiki>
41
42 The <code>ls</code> command is almost, but not quite entirely, the exact
43 opposite of the
44 <a href="cmd_extra.wiki"><code>extra</code> command</a>.
45
46 <a name="notes">Notes:</a>
47 * If you come from the <b>Windows</b> world, it will help to know that 'ls' is the usual <b>unix</b> command for listing a directory.
48 * There are more states for a file to be in than those listed, including MISSING, EDITED, RENAMED and a couple of others.
49
50 See also: <a href="cmd_add.wiki">fossil add</a>, <a href="rm.wiki">
51 fossil rm</a>, <a href="cmd_extra.wiki">fossil extra</a>,
52 <a href="cmd_commit.wiki">fossil commit</a>,
53 <a href="concepts.wiki">Fossil concepts</a>,
54 <a href="reference.wiki">Reference</a>
 
55
56 DDED www/cmd_new.wiki
--- www/cmd_ls.wiki
+++ www/cmd_ls.wiki
@@ -1,11 +1,11 @@
1 <h2>ls</h2>
2
3 The <code>ls</code><a href="#notes">*</a> command is informational, it doesn't do anything to
4 a checked-out project, but it tells you something about it.
5
6 A project consists of a "source tree" of "artifacts" (see [./concepts.wiki | Fossil concepts].)
7 From a practical standpoint this is a set of files and directories rooted
8 at a main project directory. The files that are under source control aren't
9 particularly distinguishable from those that aren't. The <code>ls</code> and
10 <code>extra</code> commands provide this information.
11
@@ -18,11 +18,11 @@
18 it's the status as <b>fossil</b> sees it and has nothing to do with
19 filesystem status. If you're new to source-management/version-control
20 systems, you'll probably get bit by this concept-bug at least once.
21
22 To really see the difference, issue an <code>ls</code> before and after doing
23 a [./cmd_commit.wiki | <code>commit</code>]. Before, the status of files may be any of the three,
24 but after <code>commit</code>ting changes the status will be UNCHANGED "across
25 the board."
26
27 By way of example, here's what I see if I <code>fossil ls</code> in the
28 directory where I have checked out my testing repository:
@@ -39,16 +39,17 @@
39 _FOSSIL_ manifest nibcrod
40 </pre></nowiki>
41
42 The <code>ls</code> command is almost, but not quite entirely, the exact
43 opposite of the
44 [./cmd_extra.wiki | <code>extra</code> command].
45
46 <a name="notes">Notes:</a>
47 * If you come from the <b>Windows</b> world, it will help to know that 'ls' is the usual <b>unix</b> command for listing a directory.
48 * There are more states for a file to be in than those listed, including MISSING, EDITED, RENAMED and a couple of others.
49
50 See also: [./cmd_add.wiki | fossil add],
51 [./rm.wiki | fossil rm],
52 [./cmd_extra.wiki | fossil extra],
53 [./cmd_commit.wiki | fossil commit],
54 [./concepts.wiki | Fossil concepts],
55 [./reference.wiki | Reference]
56
57 DDED www/cmd_new.wiki
--- a/www/cmd_new.wiki
+++ b/www/cmd_new.wiki
@@ -0,0 +1,3 @@
1
+<h2>new</h2>
2
+
3
+The
--- a/www/cmd_new.wiki
+++ b/www/cmd_new.wiki
@@ -0,0 +1,3 @@
 
 
 
--- a/www/cmd_new.wiki
+++ b/www/cmd_new.wiki
@@ -0,0 +1,3 @@
1 <h2>new</h2>
2
3 The
--- www/cmd_update.wiki
+++ www/cmd_update.wiki
@@ -1,33 +1,33 @@
11
<h2>update</h2>
22
33
What do you do if you have changes out on a repository and
44
you want them merged with your checkout?
55
6
-You use the <code>update</code> command, that's what.
6
+You use the <code>update</code> command.
77
8
-<b>fossil</b> can <a href="about_checkout.wiki">overwrite</a> any
8
+<b>fossil</b> can [./about_checkout.wiki | overwrite] any
99
changes you've made to your checkout, or it can
10
-<a href="about_merge.wiki">merge</a> whatever changes have occurred
10
+[./about_merge.wiki | merge] whatever changes have occurred
1111
in the repo into your checkout.
1212
1313
Update <em>merges</em> changes from the repository into your checkout.
1414
1515
<b>fossil</b> uses a simple conflict resolution strategy for merges:
1616
the latest change wins.
1717
18
-Local intranet <code><a href="cmd_commit.wiki">commit</a></code>s
18
+Local intranet <code>[./cmd_commit.wiki | commit]</code>s
1919
(by someone else)
20
-or Net <code><a href="cmd_pull.wiki">pull</a></code>s from a server
20
+or Net <code>[./cmd_pull.wiki | pull]</code>s from a server
2121
will usually require a <code>fossil&nbsp;update</code> afterward.
2222
2323
Local commits are likely to be made with
24
-<a href="cmd_settings.wiki#autosync">automatic syncing</a>
24
+[./cmd_settings.wiki#autosync | automatic syncing]
2525
set to "on", however, so if you don't use <b>fossil</b> for Net-wide
2626
projects you may never have to use <code>update</code>.
2727
28
-See also: <a href="cmd_pull.wiki">fossil pull</a>,
29
-<a href="cmd_commit.wiki">fossil commit</a>,
30
-<a href="cmd_settings.wiki#autosync">fossil setting</a> (autosync),
31
-<i><a href="about_checkout.wiki">checkouts</a></i>,
32
-<i><a href="about_merge.wiki">merging</a></i>,
33
-<a href="reference.wiki">Reference</a>
28
+See also: [./cmd_pull.wiki | fossil pull],
29
+[./cmd_commit.wiki | fossil commit],
30
+[./cmd_settings.wiki#autosync | fossil setting] (autosync),
31
+[./about_checkout.wiki | <i>checkouts</i>],
32
+[./about_merge.wiki | <i>merging</i>],
33
+[./reference.wiki | Reference]
3434
--- www/cmd_update.wiki
+++ www/cmd_update.wiki
@@ -1,33 +1,33 @@
1 <h2>update</h2>
2
3 What do you do if you have changes out on a repository and
4 you want them merged with your checkout?
5
6 You use the <code>update</code> command, that's what.
7
8 <b>fossil</b> can <a href="about_checkout.wiki">overwrite</a> any
9 changes you've made to your checkout, or it can
10 <a href="about_merge.wiki">merge</a> whatever changes have occurred
11 in the repo into your checkout.
12
13 Update <em>merges</em> changes from the repository into your checkout.
14
15 <b>fossil</b> uses a simple conflict resolution strategy for merges:
16 the latest change wins.
17
18 Local intranet <code><a href="cmd_commit.wiki">commit</a></code>s
19 (by someone else)
20 or Net <code><a href="cmd_pull.wiki">pull</a></code>s from a server
21 will usually require a <code>fossil&nbsp;update</code> afterward.
22
23 Local commits are likely to be made with
24 <a href="cmd_settings.wiki#autosync">automatic syncing</a>
25 set to "on", however, so if you don't use <b>fossil</b> for Net-wide
26 projects you may never have to use <code>update</code>.
27
28 See also: <a href="cmd_pull.wiki">fossil pull</a>,
29 <a href="cmd_commit.wiki">fossil commit</a>,
30 <a href="cmd_settings.wiki#autosync">fossil setting</a> (autosync),
31 <i><a href="about_checkout.wiki">checkouts</a></i>,
32 <i><a href="about_merge.wiki">merging</a></i>,
33 <a href="reference.wiki">Reference</a>
34
--- www/cmd_update.wiki
+++ www/cmd_update.wiki
@@ -1,33 +1,33 @@
1 <h2>update</h2>
2
3 What do you do if you have changes out on a repository and
4 you want them merged with your checkout?
5
6 You use the <code>update</code> command.
7
8 <b>fossil</b> can [./about_checkout.wiki | overwrite] any
9 changes you've made to your checkout, or it can
10 [./about_merge.wiki | merge] whatever changes have occurred
11 in the repo into your checkout.
12
13 Update <em>merges</em> changes from the repository into your checkout.
14
15 <b>fossil</b> uses a simple conflict resolution strategy for merges:
16 the latest change wins.
17
18 Local intranet <code>[./cmd_commit.wiki | commit]</code>s
19 (by someone else)
20 or Net <code>[./cmd_pull.wiki | pull]</code>s from a server
21 will usually require a <code>fossil&nbsp;update</code> afterward.
22
23 Local commits are likely to be made with
24 [./cmd_settings.wiki#autosync | automatic syncing]
25 set to "on", however, so if you don't use <b>fossil</b> for Net-wide
26 projects you may never have to use <code>update</code>.
27
28 See also: [./cmd_pull.wiki | fossil pull],
29 [./cmd_commit.wiki | fossil commit],
30 [./cmd_settings.wiki#autosync | fossil setting] (autosync),
31 [./about_checkout.wiki | <i>checkouts</i>],
32 [./about_merge.wiki | <i>merging</i>],
33 [./reference.wiki | Reference]
34
+90 -135
--- www/reference.wiki
+++ www/reference.wiki
@@ -20,11 +20,11 @@
2020
entered to make the intent unambiguous. 'clo' is a proper prefix of
2121
both the 'clone' and 'close' commands, for instance, but 'clon' is
2222
enough to make the intent&#8212;the 'clone' command&#8212;unambiguous.
2323
2424
You should probably start interacting with fossil at the command line
25
- by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#7547;</a>
25
+ by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#710;</a>
2626
2727
<code>$ fossil help</code><nowiki><pre>
2828
Usage: fossil help COMMAND.
2929
Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; ">
3030
<tr>
@@ -93,27 +93,25 @@
9393
<td><a href="#info">info</a></td>
9494
<td><a href="#reconstruct">reconstruct</a></td>
9595
<td><a href="#timeline">timeline</a></td>
9696
</tr>
9797
</table><nowiki><pre>
98
-This is fossil version [c66ffba6da] 2008-11-10 19:54:53 UTC
98
+This is fossil version [2be82dcc2a] 2008-12-07 18:48:09 UTC
9999
</pre>
100100
<b>What follows</b> is a survey of what you get if you type<code>
101101
fossil&nbsp;help&nbsp;<i>command</i> </code>for all of the
102102
commands listed above. There are links to individual pages for each
103103
of them; pages with content (not all of them are done) go into the command
104104
in a bit more depth than the program help.
105105
<pre>
106
-
107
- <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE... <a href="#tof">&#7547;</a>
108
-
106
+<hr><a href="#tof">&#710;</a>
107
+ <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE...
109108
Make arrangements to add one or more files to the current checkout
110109
at the next commit.
111110
112
-
113
- <a name="all">Usage: </a><code><a href="cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync) <a href="#tof">&#7547;</a>
114
-
111
+<hr><a href="#tof">&#710;</a>
112
+ <a name="all">Usage: </a><code><a href="cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync)
115113
The ~/.fossil file records the location of all repositories for a
116114
user. This command performs certain operations on all repositories
117115
that can be useful before or after a period of disconnection operation.
118116
Available operations are:
119117
@@ -129,13 +127,12 @@
129127
130128
Respositories are automatically added to the set of known repositories
131129
when one of the following commands against the repository: clone, info,
132130
pull, push, or sync
133131
134
-
135
- <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT <a href="#tof">&#7547;</a>
136
-
132
+<hr><a href="#tof">&#710;</a>
133
+ <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT
137134
The SCRIPT argument is the name of a file that is the CGI script
138135
that is being run. The command name, "cgi", may be omitted if
139136
the GATEWAY_INTERFACE environment variable is set to "CGI" (which
140137
should always be the case for CGI scripts run by a webserver.) The
141138
SCRIPT file should look something like this:
@@ -145,64 +142,57 @@
145142
146143
The second line defines the name of the repository. After locating
147144
the repository, fossil will generate a webpage on stdout based on
148145
the values of standard CGI environment variables.
149146
150
-
151
- <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a> <a href="#tof">&#7547;</a>
152
-
147
+<hr><a href="#tof">&#710;</a>
148
+ <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a>
153149
Report on the edit status of all files in the current checkout.
154150
See also the "status" and "extra" commands.
155151
156
-
157
- <a name="checkout">Usage: </a><a href="checkout">fossil checkout</a> VERSION ?-f|--force? <a href="#tof">&#7547;</a>
158
-
152
+<hr><a href="#tof">&#710;</a>
153
+ <a name="checkout">Usage: </a><a href="checkout">fossil checkout</a> VERSION ?-f|--force?
159154
Check out a version specified on the command-line. This command
160155
will not overwrite edited files in the current checkout unless
161156
the --force option appears on the command-line.
162157
163158
See also the "update" command.
164159
165
-
166
- <a name="commit">Usage: </a><a href="cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...? <a href="#tof">&#7547;</a>
167
- fossil ci ... (as above)
160
+<hr><a href="#tof">&#710;</a>
161
+ <a name="commit">Usage: </a><a href="cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...? fossil ci ... (as above)
168162
169163
Create a new version containing all of the changes in the current
170164
checkout. You will be prompted to enter a check-in comment unless
171165
the "-m" option is used to specify a comment line. You will be
172166
prompted for your GPG passphrase in order to sign the new manifest
173167
unless the "--nosign" options is used. All files that have
174168
changed will be committed unless some subset of files is specified
175169
on the command line.
176170
177
-
178
- <a name="clean">Usage: </a><a href="cmd_clean.wiki">fossil clean</a> ?-all? <a href="#tof">&#7547;</a>
179
-
171
+<hr><a href="#tof">&#710;</a>
172
+ <a name="clean">Usage: </a><a href="cmd_clean.wiki">fossil clean</a> ?-all?
180173
Delete all "extra" files in the source tree. "Extra" files are
181174
files that are not officially part of the checkout. See also
182175
the "extra" command. This operation cannot be undone.
183176
184177
You will be prompted before removing each file. If you are
185178
sure you wish to remove all "extra" files you can specify the
186179
optional -all flag.
187180
188
-
189
- <a name="clone">Usage: </a><a href="cmd_clone.wiki">fossil clone</a> URL FILENAME <a href="#tof">&#7547;</a>
190
-
181
+<hr><a href="#tof">&#710;</a>
182
+ <a name="clone">Usage: </a><a href="cmd_clone.wiki">fossil clone</a> URL FILENAME
191183
Make a clone of a repository specified by URL in the local
192184
file named FILENAME.
193185
194
-
195
- <a name="close">Usage: </a><a href="cmd_close.wiki">fossil close</a> ?-f|--force? <a href="#tof">&#7547;</a>
196
-
186
+<hr><a href="#tof">&#710;</a>
187
+ <a name="close">Usage: </a><a href="cmd_close.wiki">fossil close</a> ?-f|--force?
197188
The opposite of "open". Close the current database connection.
198189
Require a -f or --force flag if there are unsaved changed in the
199190
current check-out.
200191
201
-
202
- <a name="configure">Usage: </a><a href="cmd_configure.wiki">fossil configure</a> METHOD ... <a href="#tof">&#7547;</a>
203
-
192
+<hr><a href="#tof">&#710;</a>
193
+ <a name="configure">Usage: </a><a href="cmd_configure.wiki">fossil configure</a> METHOD ...
204194
Where METHOD is one of: export import merge pull push reset. All methods
205195
accept the -R or --repository option to specific a repository.
206196
207197
fossil configuration export AREA FILENAME
208198
@@ -222,12 +212,11 @@
222212
223213
fossil configuration pull AREA ?URL?
224214
225215
Pull and install the configuration from a different server
226216
identified by URL. If no URL is specified, then the default
227
- server is used.
228
-
217
+ server is used.
229218
fossil configuration push AREA ?URL?
230219
231220
Push the local configuration into the remote server identified
232221
by URL. Admin privilege is required on the remote server for
233222
this to work.
@@ -238,33 +227,29 @@
238227
239228
WARNING: Do not import, merge, or pull configurations from an untrusted
240229
source. The inbound configuration is not checked for safety and can
241230
introduce security vulnerabilities.
242231
243
-
244
- COMMAND: deconstruct
245
- <a name="deconstruct">Usage: </a><a href="cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION <a href="#tof">&#7547;</a>
246
-
232
+<hr><a href="#tof">&#710;</a>
233
+ COMMAND: deconstruct
234
+ <a name="deconstruct">Usage: </a><a href="cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION
247235
Populates the indicated DESTINATION directory with copies of all
248236
artifcats contained within the repository. Artifacts are named AA/bbbbb
249237
where AA is the first 2 characters of the artifact ID and bbbbb is the
250238
remaining 38 characters.
251239
252
-
253
- <a name="rm">Usage: </a><a href="cmd_rm.wiki">fossil rm</a> FILE... <a href="#tof">&#7547;</a>
254
- or: fossil del FILE...
240
+<hr><a href="#tof">&#710;</a>
241
+ <a name="rm">Usage: </a><a href="cmd_rm.wiki">fossil rm</a> FILE... or: fossil del FILE...
255242
Remove one or more files from the tree.
256243
257
-
258
- <a name="descendants">Usage: </a><a href="cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID? <a href="#tof">&#7547;</a>
259
-
244
+<hr><a href="#tof">&#710;</a>
245
+ <a name="descendants">Usage: </a><a href="cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID?
260246
Find all leaf descendants of the baseline specified or if the argument
261247
is omitted, of the baseline currently checked out.
262248
263
-
264
- <a name="diff">Usage: </a><a href="cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE... <a href="#tof">&#7547;</a>
265
-
249
+<hr><a href="#tof">&#710;</a>
250
+ <a name="diff">Usage: </a><a href="cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE...
266251
Show the difference between the current version of a file (as it
267252
exists on disk) and that same file as it was checked out.
268253
269254
diff will show a textual diff while gdiff will attempt to run a
270255
graphical diff command that you have setup. If the choosen command
@@ -283,84 +268,72 @@
283268
fossil setting gdiff-command tortoisemerge
284269
fossil setting gdiff-command meld
285270
fossil setting gdiff-command xxdiff
286271
fossil setting gdiff-command kdiff3
287272
288
-
289
- <a name="extra">Usage: </a><a href="cmd_extra.wiki">fossil extra</a> <a href="#tof">&#7547;</a>
290
-
273
+<hr><a href="#tof">&#710;</a>
274
+ <a name="extra">Usage: </a><a href="cmd_extra.wiki">fossil extra</a>
291275
Print a list of all files in the source tree that are not part of
292276
the current checkout. See also the "clean" command.
293277
294
-
295
- <a name="help">Usage: </a><a href="cmd_help.wiki">fossil help</a> COMMAND <a href="#tof">&#7547;</a>
296
-
278
+<hr><a href="#tof">&#710;</a>
279
+ <a name="help">Usage: </a><a href="cmd_help.wiki">fossil help</a> COMMAND
297280
Display information on how to use COMMAND
298281
299
-
300
- <a name="http">Usage: </a><a href="cmd_http.wiki">fossil http</a> REPOSITORY <a href="#tof">&#7547;</a>
301
-
282
+<hr><a href="#tof">&#710;</a>
283
+ <a name="http">Usage: </a><a href="cmd_http.wiki">fossil http</a> REPOSITORY
302284
Handle a single HTTP request appearing on stdin. The resulting webpage
303285
is delivered on stdout. This method is used to launch an HTTP request
304
- handler from inetd, for example. The argument is the name of the
305
- repository.
286
+ handler from inetd, for example. The argument is the name of the repository.
306287
307
-
308
- <a name="info">Usage: </a><a href="cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME? <a href="#tof">&#7547;</a>
309
-
288
+<hr><a href="#tof">&#710;</a>
289
+ <a name="info">Usage: </a><a href="cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME?
310290
With no arguments, provide information about the current tree.
311291
If an argument is specified, provide information about the object
312292
in the respository of the current tree that the argument refers
313293
to. Or if the argument is the name of a repository, show
314294
information about that repository.
315295
316
-
317
- <a name="leaves">Usage: </a><a href="cmd_leaves.wiki">fossil leaves</a> <a href="#tof">&#7547;</a>
318
-
296
+<hr><a href="#tof">&#710;</a>
297
+ <a name="leaves">Usage: </a><a href="cmd_leaves.wiki">fossil leaves</a>
319298
Find leaves of all branches.
320299
321
-
322
- <a name="ls">Usage: </a><a href="cmd_ls.wiki">fossil ls</a> <a href="#tof">&#7547;</a>
323
-
300
+<hr><a href="#tof">&#710;</a>
301
+ <a name="ls">Usage: </a><a href="cmd_ls.wiki">fossil ls</a>
324302
Show the names of all files in the current checkout
325303
326
-
327
- <a name="merge">Usage: </a><a href="cmd_merge.wiki">fossil merge</a> VERSION <a href="#tof">&#7547;</a>
328
-
304
+<hr><a href="#tof">&#710;</a>
305
+ <a name="merge">Usage: </a><a href="cmd_merge.wiki">fossil merge</a> VERSION
329306
The argument is a version that should be merged into the current
330
- checkout.
331
-
307
+ checkout.
332308
Only file content is merged. The result continues to use the
333309
file and directory names from the current check-out even if those
334310
names might have been changed in the branch being merged in.
335311
336
-
337
- <a name="mv">Usage: </a><a href="cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME <a href="#tof">&#7547;</a>
338
- or: fossil mv|rename OLDNAME... DIR
312
+<hr><a href="#tof">&#710;</a>
313
+ <a name="mv">Usage: </a><a href="cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME or: fossil mv|rename OLDNAME... DIR
339314
340315
Move or rename one or more files within the tree
341316
342317
This command does not rename the files on disk. All this command does is
343318
record the fact that filenames have changed so that appropriate notations
344319
can be made at the next commit/checkin.
345
-
320
+<hr><a href="#tof">&#710;</a>
346321
<a name="new">Usage: </a><a href="cmd_new.wiki">fossil new</a> FILENAME
347322
348323
Create a repository for a new project in the file named FILENAME.
349324
This command is distinct from "clone". The "clone" command makes
350325
a copy of an existing project. This command starts a new project.
351326
352
-
353
- <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME <a href="#tof">&#7547;</a>
354
-
327
+<hr><a href="#tof">&#710;</a>
328
+ <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME
355329
Open a connection to the local repository in FILENAME. A checkout
356330
for the repository is created with its root at the working directory.
357331
See also the "close" command.
358332
359
-
360
- <a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY? <a href="#tof">&#7547;</a>
361
-
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?
362335
Pull changes in a remote repository into the local repository.
363336
The repository is identified by the -R or --repository option.
364337
If there is no such option then the open repository is used.
365338
The URL of the remote server is specified on the command line
366339
If no URL is specified then the URL used by the most recent
@@ -374,51 +347,45 @@
374347
The "USER" substring specifies the login user. You will be
375348
prompted for the password on the command-line. The PORT
376349
specifies the TCP port of the server. The default port is
377350
80.
378351
379
-
380
- <a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY? <a href="#tof">&#7547;</a>
381
-
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?
382354
Push changes in the local repository over into a remote repository.
383355
See the "pull" command for additional information.
384
-
385
- <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY <a href="#tof">&#7547;</a>
386
-
356
+<hr><a href="#tof">&#710;</a>
357
+ <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY
387358
Reconstruct the named repository database from the core
388359
records. Run this command after updating the fossil
389360
executable in a way that changes the database schema.
390361
391
-
392
- COMMAND: reconstruct
393
- <a name="reconstruct">Usage: </a><a href="cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN <a href="#tof">&#7547;</a>
394
-
362
+<hr><a href="#tof">&#710;</a>
363
+ COMMAND: reconstruct
364
+ <a name="reconstruct">Usage: </a><a href="cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN
395365
Creates the REPOSITORY and populates it with the artifacts in the
396366
indicated ORIGIN directory.
397367
398
-
399
- <a name="redo">Usage: </a><a href="cmd_redo.wiki">fossil redo</a> ?FILENAME...? <a href="#tof">&#7547;</a>
400
-
368
+<hr><a href="#tof">&#710;</a>
369
+ <a name="redo">Usage: </a><a href="cmd_redo.wiki">fossil redo</a> ?FILENAME...?
401370
Redo the an update or merge operation that has been undone by the
402371
undo command. If FILENAME is specified then restore the changes
403372
associated with the named file(s) but otherwise leave the update
404373
or merge undone.
405374
406375
A single level of undo/redo is supported. The undo/redo stack
407376
is cleared by the commit and checkout commands.
408377
409
-
410
- <a name="revert">Usage: </a><a href="cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE <a href="#tof">&#7547;</a>
411
-
378
+<hr><a href="#tof">&#710;</a>
379
+ <a name="revert">Usage: </a><a href="cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE
412380
Revert to the current repository version of FILE, or to
413381
the version associated with baseline REVISION if the -r flag
414382
appears. This command will confirm your operation unless the
415383
file is missing or the --yes option is used.
416384
417
-
418
- <a name="server">Usage: </a><a href="cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY? <a href="#tof">&#7547;</a>
419
- Or: fossil ui ?-P|--port TCPPORT? ?REPOSITORY?
385
+<hr><a href="#tof">&#710;</a>
386
+ <a name="server">Usage: </a><a href="cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY? Or: fossil ui ?-P|--port TCPPORT? ?REPOSITORY?
420387
421388
Open a socket and begin listening and responding to HTTP requests on
422389
TCP port 8080, or on any other TCP port defined by the -P or
423390
--port option. The optional argument is the name of the repository.
424391
The repository argument may be omitted if the working directory is
@@ -425,15 +392,14 @@
425392
within an open checkout.
426393
427394
The "ui" command automatically starts a web browser after initializing
428395
the web server.
429396
430
-
397
+<hr><a href="#tof">&#710;</a>
431398
COMMAND: settings
432399
COMMAND: unset
433
- <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? <a href="#tof">&#7547;</a>
434
- fossil unset PROPERTY ?-global?
400
+ <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? fossil unset PROPERTY ?-global?
435401
436402
The "setting" command with no arguments lists all properties and their
437403
values. With just a property name it shows the value of that property.
438404
With a value argument it changes the property for the current repository.
439405
@@ -471,25 +437,22 @@
471437
web-browser A shell command used to launch your preferred
472438
web browser when given a URL as an argument.
473439
Defaults to "start" on windows, "open" on Mac,
474440
and "firefox" on Unix.
475441
476
-
477
- <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a> <a href="#tof">&#7547;</a>
478
-
442
+<hr><a href="#tof">&#710;</a>
443
+ <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a>
479444
Report on the status of the current checkout.
480445
481
-
482
- <a name="sync">Usage: </a><a href="cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY? <a href="#tof">&#7547;</a>
483
-
446
+<hr><a href="#tof">&#710;</a>
447
+ <a name="sync">Usage: </a><a href="cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY?
484448
Synchronize the local repository with a remote repository. This is
485449
the equivalent of running both "push" and "pull" at the same time.
486450
See the "pull" command for additional information.
487451
488
-
489
- <a name="tag">Usage: </a><a href="cmd_tag.wiki">fossil tag</a> SUBCOMMAND ... <a href="#tof">&#7547;</a>
490
-
452
+<hr><a href="#tof">&#710;</a>
453
+ <a name="tag">Usage: </a><a href="cmd_tag.wiki">fossil tag</a> SUBCOMMAND ...
491454
Run various subcommands to control tags and properties
492455
493456
fossil tag add ?--raw? TAGNAME BASELINE ?VALUE?
494457
495458
Add a new tag or property to BASELINE. The tag will
@@ -540,13 +503,12 @@
540503
541504
fossil update tag:decaf
542505
543506
will assume that "decaf" is a tag/branch name.
544507
545
-
546
- <a name="timeline">Usage: </a><a href="cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N? <a href="#tof">&#7547;</a>
547
-
508
+<hr><a href="#tof">&#710;</a>
509
+ <a name="timeline">Usage: </a><a href="cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N?
548510
Print a summary of activity going backwards in date and time
549511
specified or from the current date and time if no arguments
550512
are given. Show as many as N (default 20) check-ins. The
551513
WHEN argument can be any unique abbreviation of one of these
552514
keywords:
@@ -559,35 +521,31 @@
559521
The BASELINE can be any unique prefix of 4 characters or more.
560522
The DATETIME should be in the ISO8601 format. For
561523
examples: "2007-08-18 07:21:21". You can also say "current"
562524
for the current version or "now" for the current time.
563525
564
-
565
- <a name="undo">Usage: </a><a href="cmd_undo.wiki">fossil undo</a> ?FILENAME...? <a href="#tof">&#7547;</a>
566
-
526
+<hr><a href="#tof">&#710;</a>
527
+ <a name="undo">Usage: </a><a href="cmd_undo.wiki">fossil undo</a> ?FILENAME...?
567528
Undo the most recent update or merge operation. If FILENAME is
568529
specified then restore the content of the named file(s) but otherwise
569530
leave the update or merge in effect.
570531
571532
A single level of undo/redo is supported. The undo/redo stack
572533
is cleared by the commit and checkout commands.
573534
574
-
575
- <a name="update">Usage: </a><a href="cmd_update.wiki">fossil update</a> ?VERSION? ?--latest? <a href="#tof">&#7547;</a>
576
-
535
+<hr><a href="#tof">&#710;</a>
536
+ <a name="update">Usage: </a><a href="cmd_update.wiki">fossil update</a> ?VERSION? ?--latest?
577537
The optional argument is a version that should become the current
578538
version. If the argument is omitted, then use the leaf of the
579
- tree that begins with the current version, if there is only a
580
- single leaf. If there are a multiple leaves, the latest is used
539
+ tree that begins with the current version, if there is only a single leaf. If there are a multiple leaves, the latest is used
581540
if the --latest flag is present.
582541
583542
This command is different from the "checkout" in that edits are
584543
not overwritten. Edits are merged into the new version.
585544
586
-
587
- <a name="user">Usage: </a><a href="cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE? <a href="#tof">&#7547;</a>
588
-
545
+<hr><a href="#tof">&#710;</a>
546
+ <a name="user">Usage: </a><a href="cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE?
589547
Run various subcommands on users of the open repository or of
590548
the repository identified by the -R or --repository option.
591549
592550
fossil user capabilities USERNAME ?STRING?
593551
@@ -610,18 +568,16 @@
610568
611569
fossil user password USERNAME
612570
613571
Change the web access password for a user.
614572
615
-
616
- <a name="version">Usage: </a><a href="cmd_version.wiki">fossil version</a> <a href="#tof">&#7547;</a>
617
-
573
+<hr><a href="#tof">&#710;</a>
574
+ <a name="version">Usage: </a><a href="cmd_version.wiki">fossil version</a>
618575
Print the source code version number for the fossil executable.
619576
620
-
621
- <a name="wiki">Usage: </a><a href="cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName <a href="#tof">&#7547;</a>
622
-
577
+<hr><a href="#tof">&#710;</a>
578
+ <a name="wiki">Usage: </a><a href="cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName
623579
Run various subcommands to fetch wiki entries.
624580
625581
fossil wiki export PAGENAME ?FILE?
626582
627583
Sends the latest version of the PAGENAME wiki
@@ -662,11 +618,11 @@
662618
Diffs the local copy of a page with a given version (defaulting
663619
to the head version).
664620
665621
</pre></nowiki>
666622
667
- <hr>
623
+ <hr><a href="#tof">&#710;</a>
668624
669625
<h3>Caveats</h3>
670626
This is not actually a reference, it's the start of a reference.
671627
There are wikilinks to uncreated pages for the commands. This was
672628
created by running the fossil help for each command listed by running
@@ -676,6 +632,5 @@
676632
so they are (currently) not addressed here. Clarity and brevity may be
677633
sacrificed for expediency at the authors indiscretion. All spelling and
678634
grammatical mistakes are somebody elses fault.<code> void * </code>
679635
prohibited where<code> __C_PLUS_PLUS__ </code>. Title and taxes extra.
680636
Not valid in Hooptigonia.
681
-<a href="#tof">&#7547;</a>
682637
--- www/reference.wiki
+++ www/reference.wiki
@@ -20,11 +20,11 @@
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.
23
24 You should probably start interacting with fossil at the command line
25 by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#7547;</a>
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>
@@ -93,27 +93,25 @@
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 [c66ffba6da] 2008-11-10 19:54:53 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
107 <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE... <a href="#tof">&#7547;</a>
108
109 Make arrangements to add one or more files to the current checkout
110 at the next commit.
111
112
113 <a name="all">Usage: </a><code><a href="cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync) <a href="#tof">&#7547;</a>
114
115 The ~/.fossil file records the location of all repositories for a
116 user. This command performs certain operations on all repositories
117 that can be useful before or after a period of disconnection operation.
118 Available operations are:
119
@@ -129,13 +127,12 @@
129
130 Respositories are automatically added to the set of known repositories
131 when one of the following commands against the repository: clone, info,
132 pull, push, or sync
133
134
135 <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT <a href="#tof">&#7547;</a>
136
137 The SCRIPT argument is the name of a file that is the CGI script
138 that is being run. The command name, "cgi", may be omitted if
139 the GATEWAY_INTERFACE environment variable is set to "CGI" (which
140 should always be the case for CGI scripts run by a webserver.) The
141 SCRIPT file should look something like this:
@@ -145,64 +142,57 @@
145
146 The second line defines the name of the repository. After locating
147 the repository, fossil will generate a webpage on stdout based on
148 the values of standard CGI environment variables.
149
150
151 <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a> <a href="#tof">&#7547;</a>
152
153 Report on the edit status of all files in the current checkout.
154 See also the "status" and "extra" commands.
155
156
157 <a name="checkout">Usage: </a><a href="checkout">fossil checkout</a> VERSION ?-f|--force? <a href="#tof">&#7547;</a>
158
159 Check out a version specified on the command-line. This command
160 will not overwrite edited files in the current checkout unless
161 the --force option appears on the command-line.
162
163 See also the "update" command.
164
165
166 <a name="commit">Usage: </a><a href="cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...? <a href="#tof">&#7547;</a>
167 fossil ci ... (as above)
168
169 Create a new version containing all of the changes in the current
170 checkout. You will be prompted to enter a check-in comment unless
171 the "-m" option is used to specify a comment line. You will be
172 prompted for your GPG passphrase in order to sign the new manifest
173 unless the "--nosign" options is used. All files that have
174 changed will be committed unless some subset of files is specified
175 on the command line.
176
177
178 <a name="clean">Usage: </a><a href="cmd_clean.wiki">fossil clean</a> ?-all? <a href="#tof">&#7547;</a>
179
180 Delete all "extra" files in the source tree. "Extra" files are
181 files that are not officially part of the checkout. See also
182 the "extra" command. This operation cannot be undone.
183
184 You will be prompted before removing each file. If you are
185 sure you wish to remove all "extra" files you can specify the
186 optional -all flag.
187
188
189 <a name="clone">Usage: </a><a href="cmd_clone.wiki">fossil clone</a> URL FILENAME <a href="#tof">&#7547;</a>
190
191 Make a clone of a repository specified by URL in the local
192 file named FILENAME.
193
194
195 <a name="close">Usage: </a><a href="cmd_close.wiki">fossil close</a> ?-f|--force? <a href="#tof">&#7547;</a>
196
197 The opposite of "open". Close the current database connection.
198 Require a -f or --force flag if there are unsaved changed in the
199 current check-out.
200
201
202 <a name="configure">Usage: </a><a href="cmd_configure.wiki">fossil configure</a> METHOD ... <a href="#tof">&#7547;</a>
203
204 Where METHOD is one of: export import merge pull push reset. All methods
205 accept the -R or --repository option to specific a repository.
206
207 fossil configuration export AREA FILENAME
208
@@ -222,12 +212,11 @@
222
223 fossil configuration pull AREA ?URL?
224
225 Pull and install the configuration from a different server
226 identified by URL. If no URL is specified, then the default
227 server is used.
228
229 fossil configuration push AREA ?URL?
230
231 Push the local configuration into the remote server identified
232 by URL. Admin privilege is required on the remote server for
233 this to work.
@@ -238,33 +227,29 @@
238
239 WARNING: Do not import, merge, or pull configurations from an untrusted
240 source. The inbound configuration is not checked for safety and can
241 introduce security vulnerabilities.
242
243
244 COMMAND: deconstruct
245 <a name="deconstruct">Usage: </a><a href="cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION <a href="#tof">&#7547;</a>
246
247 Populates the indicated DESTINATION directory with copies of all
248 artifcats contained within the repository. Artifacts are named AA/bbbbb
249 where AA is the first 2 characters of the artifact ID and bbbbb is the
250 remaining 38 characters.
251
252
253 <a name="rm">Usage: </a><a href="cmd_rm.wiki">fossil rm</a> FILE... <a href="#tof">&#7547;</a>
254 or: fossil del FILE...
255 Remove one or more files from the tree.
256
257
258 <a name="descendants">Usage: </a><a href="cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID? <a href="#tof">&#7547;</a>
259
260 Find all leaf descendants of the baseline specified or if the argument
261 is omitted, of the baseline currently checked out.
262
263
264 <a name="diff">Usage: </a><a href="cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE... <a href="#tof">&#7547;</a>
265
266 Show the difference between the current version of a file (as it
267 exists on disk) and that same file as it was checked out.
268
269 diff will show a textual diff while gdiff will attempt to run a
270 graphical diff command that you have setup. If the choosen command
@@ -283,84 +268,72 @@
283 fossil setting gdiff-command tortoisemerge
284 fossil setting gdiff-command meld
285 fossil setting gdiff-command xxdiff
286 fossil setting gdiff-command kdiff3
287
288
289 <a name="extra">Usage: </a><a href="cmd_extra.wiki">fossil extra</a> <a href="#tof">&#7547;</a>
290
291 Print a list of all files in the source tree that are not part of
292 the current checkout. See also the "clean" command.
293
294
295 <a name="help">Usage: </a><a href="cmd_help.wiki">fossil help</a> COMMAND <a href="#tof">&#7547;</a>
296
297 Display information on how to use COMMAND
298
299
300 <a name="http">Usage: </a><a href="cmd_http.wiki">fossil http</a> REPOSITORY <a href="#tof">&#7547;</a>
301
302 Handle a single HTTP request appearing on stdin. The resulting webpage
303 is delivered on stdout. This method is used to launch an HTTP request
304 handler from inetd, for example. The argument is the name of the
305 repository.
306
307
308 <a name="info">Usage: </a><a href="cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME? <a href="#tof">&#7547;</a>
309
310 With no arguments, provide information about the current tree.
311 If an argument is specified, provide information about the object
312 in the respository of the current tree that the argument refers
313 to. Or if the argument is the name of a repository, show
314 information about that repository.
315
316
317 <a name="leaves">Usage: </a><a href="cmd_leaves.wiki">fossil leaves</a> <a href="#tof">&#7547;</a>
318
319 Find leaves of all branches.
320
321
322 <a name="ls">Usage: </a><a href="cmd_ls.wiki">fossil ls</a> <a href="#tof">&#7547;</a>
323
324 Show the names of all files in the current checkout
325
326
327 <a name="merge">Usage: </a><a href="cmd_merge.wiki">fossil merge</a> VERSION <a href="#tof">&#7547;</a>
328
329 The argument is a version that should be merged into the current
330 checkout.
331
332 Only file content is merged. The result continues to use the
333 file and directory names from the current check-out even if those
334 names might have been changed in the branch being merged in.
335
336
337 <a name="mv">Usage: </a><a href="cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME <a href="#tof">&#7547;</a>
338 or: fossil mv|rename OLDNAME... DIR
339
340 Move or rename one or more files within the tree
341
342 This command does not rename the files on disk. All this command does is
343 record the fact that filenames have changed so that appropriate notations
344 can be made at the next commit/checkin.
345
346 <a name="new">Usage: </a><a href="cmd_new.wiki">fossil new</a> FILENAME
347
348 Create a repository for a new project in the file named FILENAME.
349 This command is distinct from "clone". The "clone" command makes
350 a copy of an existing project. This command starts a new project.
351
352
353 <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME <a href="#tof">&#7547;</a>
354
355 Open a connection to the local repository in FILENAME. A checkout
356 for the repository is created with its root at the working directory.
357 See also the "close" command.
358
359
360 <a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY? <a href="#tof">&#7547;</a>
361
362 Pull changes in a remote repository into the local repository.
363 The repository is identified by the -R or --repository option.
364 If there is no such option then the open repository is used.
365 The URL of the remote server is specified on the command line
366 If no URL is specified then the URL used by the most recent
@@ -374,51 +347,45 @@
374 The "USER" substring specifies the login user. You will be
375 prompted for the password on the command-line. The PORT
376 specifies the TCP port of the server. The default port is
377 80.
378
379
380 <a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY? <a href="#tof">&#7547;</a>
381
382 Push changes in the local repository over into a remote repository.
383 See the "pull" command for additional information.
384
385 <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY <a href="#tof">&#7547;</a>
386
387 Reconstruct the named repository database from the core
388 records. Run this command after updating the fossil
389 executable in a way that changes the database schema.
390
391
392 COMMAND: reconstruct
393 <a name="reconstruct">Usage: </a><a href="cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN <a href="#tof">&#7547;</a>
394
395 Creates the REPOSITORY and populates it with the artifacts in the
396 indicated ORIGIN directory.
397
398
399 <a name="redo">Usage: </a><a href="cmd_redo.wiki">fossil redo</a> ?FILENAME...? <a href="#tof">&#7547;</a>
400
401 Redo the an update or merge operation that has been undone by the
402 undo command. If FILENAME is specified then restore the changes
403 associated with the named file(s) but otherwise leave the update
404 or merge undone.
405
406 A single level of undo/redo is supported. The undo/redo stack
407 is cleared by the commit and checkout commands.
408
409
410 <a name="revert">Usage: </a><a href="cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE <a href="#tof">&#7547;</a>
411
412 Revert to the current repository version of FILE, or to
413 the version associated with baseline REVISION if the -r flag
414 appears. This command will confirm your operation unless the
415 file is missing or the --yes option is used.
416
417
418 <a name="server">Usage: </a><a href="cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY? <a href="#tof">&#7547;</a>
419 Or: fossil ui ?-P|--port TCPPORT? ?REPOSITORY?
420
421 Open a socket and begin listening and responding to HTTP requests on
422 TCP port 8080, or on any other TCP port defined by the -P or
423 --port option. The optional argument is the name of the repository.
424 The repository argument may be omitted if the working directory is
@@ -425,15 +392,14 @@
425 within an open checkout.
426
427 The "ui" command automatically starts a web browser after initializing
428 the web server.
429
430
431 COMMAND: settings
432 COMMAND: unset
433 <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? <a href="#tof">&#7547;</a>
434 fossil unset PROPERTY ?-global?
435
436 The "setting" command with no arguments lists all properties and their
437 values. With just a property name it shows the value of that property.
438 With a value argument it changes the property for the current repository.
439
@@ -471,25 +437,22 @@
471 web-browser A shell command used to launch your preferred
472 web browser when given a URL as an argument.
473 Defaults to "start" on windows, "open" on Mac,
474 and "firefox" on Unix.
475
476
477 <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a> <a href="#tof">&#7547;</a>
478
479 Report on the status of the current checkout.
480
481
482 <a name="sync">Usage: </a><a href="cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY? <a href="#tof">&#7547;</a>
483
484 Synchronize the local repository with a remote repository. This is
485 the equivalent of running both "push" and "pull" at the same time.
486 See the "pull" command for additional information.
487
488
489 <a name="tag">Usage: </a><a href="cmd_tag.wiki">fossil tag</a> SUBCOMMAND ... <a href="#tof">&#7547;</a>
490
491 Run various subcommands to control tags and properties
492
493 fossil tag add ?--raw? TAGNAME BASELINE ?VALUE?
494
495 Add a new tag or property to BASELINE. The tag will
@@ -540,13 +503,12 @@
540
541 fossil update tag:decaf
542
543 will assume that "decaf" is a tag/branch name.
544
545
546 <a name="timeline">Usage: </a><a href="cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N? <a href="#tof">&#7547;</a>
547
548 Print a summary of activity going backwards in date and time
549 specified or from the current date and time if no arguments
550 are given. Show as many as N (default 20) check-ins. The
551 WHEN argument can be any unique abbreviation of one of these
552 keywords:
@@ -559,35 +521,31 @@
559 The BASELINE can be any unique prefix of 4 characters or more.
560 The DATETIME should be in the ISO8601 format. For
561 examples: "2007-08-18 07:21:21". You can also say "current"
562 for the current version or "now" for the current time.
563
564
565 <a name="undo">Usage: </a><a href="cmd_undo.wiki">fossil undo</a> ?FILENAME...? <a href="#tof">&#7547;</a>
566
567 Undo the most recent update or merge operation. If FILENAME is
568 specified then restore the content of the named file(s) but otherwise
569 leave the update or merge in effect.
570
571 A single level of undo/redo is supported. The undo/redo stack
572 is cleared by the commit and checkout commands.
573
574
575 <a name="update">Usage: </a><a href="cmd_update.wiki">fossil update</a> ?VERSION? ?--latest? <a href="#tof">&#7547;</a>
576
577 The optional argument is a version that should become the current
578 version. If the argument is omitted, then use the leaf of the
579 tree that begins with the current version, if there is only a
580 single leaf. If there are a multiple leaves, the latest is used
581 if the --latest flag is present.
582
583 This command is different from the "checkout" in that edits are
584 not overwritten. Edits are merged into the new version.
585
586
587 <a name="user">Usage: </a><a href="cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE? <a href="#tof">&#7547;</a>
588
589 Run various subcommands on users of the open repository or of
590 the repository identified by the -R or --repository option.
591
592 fossil user capabilities USERNAME ?STRING?
593
@@ -610,18 +568,16 @@
610
611 fossil user password USERNAME
612
613 Change the web access password for a user.
614
615
616 <a name="version">Usage: </a><a href="cmd_version.wiki">fossil version</a> <a href="#tof">&#7547;</a>
617
618 Print the source code version number for the fossil executable.
619
620
621 <a name="wiki">Usage: </a><a href="cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName <a href="#tof">&#7547;</a>
622
623 Run various subcommands to fetch wiki entries.
624
625 fossil wiki export PAGENAME ?FILE?
626
627 Sends the latest version of the PAGENAME wiki
@@ -662,11 +618,11 @@
662 Diffs the local copy of a page with a given version (defaulting
663 to the head version).
664
665 </pre></nowiki>
666
667 <hr>
668
669 <h3>Caveats</h3>
670 This is not actually a reference, it's the start of a reference.
671 There are wikilinks to uncreated pages for the commands. This was
672 created by running the fossil help for each command listed by running
@@ -676,6 +632,5 @@
676 so they are (currently) not addressed here. Clarity and brevity may be
677 sacrificed for expediency at the authors indiscretion. All spelling and
678 grammatical mistakes are somebody elses fault.<code> void * </code>
679 prohibited where<code> __C_PLUS_PLUS__ </code>. Title and taxes extra.
680 Not valid in Hooptigonia.
681 <a href="#tof">&#7547;</a>
682
--- www/reference.wiki
+++ www/reference.wiki
@@ -20,11 +20,11 @@
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.
23
24 You should probably start interacting with fossil at the command line
25 by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#710;</a>
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>
@@ -93,27 +93,25 @@
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.
110
111 <hr><a href="#tof">&#710;</a>
112 <a name="all">Usage: </a><code><a href="cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync)
 
113 The ~/.fossil file records the location of all repositories for a
114 user. This command performs certain operations on all repositories
115 that can be useful before or after a period of disconnection operation.
116 Available operations are:
117
@@ -129,13 +127,12 @@
127
128 Respositories are automatically added to the set of known repositories
129 when one of the following commands against the repository: clone, info,
130 pull, push, or sync
131
132 <hr><a href="#tof">&#710;</a>
133 <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT
 
134 The SCRIPT argument is the name of a file that is the CGI script
135 that is being run. The command name, "cgi", may be omitted if
136 the GATEWAY_INTERFACE environment variable is set to "CGI" (which
137 should always be the case for CGI scripts run by a webserver.) The
138 SCRIPT file should look something like this:
@@ -145,64 +142,57 @@
142
143 The second line defines the name of the repository. After locating
144 the repository, fossil will generate a webpage on stdout based on
145 the values of standard CGI environment variables.
146
147 <hr><a href="#tof">&#710;</a>
148 <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a>
 
149 Report on the edit status of all files in the current checkout.
150 See also the "status" and "extra" commands.
151
152 <hr><a href="#tof">&#710;</a>
153 <a name="checkout">Usage: </a><a href="checkout">fossil checkout</a> VERSION ?-f|--force?
 
154 Check out a version specified on the command-line. This command
155 will not overwrite edited files in the current checkout unless
156 the --force option appears on the command-line.
157
158 See also the "update" command.
159
160 <hr><a href="#tof">&#710;</a>
161 <a name="commit">Usage: </a><a href="cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...? fossil ci ... (as above)
 
162
163 Create a new version containing all of the changes in the current
164 checkout. You will be prompted to enter a check-in comment unless
165 the "-m" option is used to specify a comment line. You will be
166 prompted for your GPG passphrase in order to sign the new manifest
167 unless the "--nosign" options is used. All files that have
168 changed will be committed unless some subset of files is specified
169 on the command line.
170
171 <hr><a href="#tof">&#710;</a>
172 <a name="clean">Usage: </a><a href="cmd_clean.wiki">fossil clean</a> ?-all?
 
173 Delete all "extra" files in the source tree. "Extra" files are
174 files that are not officially part of the checkout. See also
175 the "extra" command. This operation cannot be undone.
176
177 You will be prompted before removing each file. If you are
178 sure you wish to remove all "extra" files you can specify the
179 optional -all flag.
180
181 <hr><a href="#tof">&#710;</a>
182 <a name="clone">Usage: </a><a href="cmd_clone.wiki">fossil clone</a> URL FILENAME
 
183 Make a clone of a repository specified by URL in the local
184 file named FILENAME.
185
186 <hr><a href="#tof">&#710;</a>
187 <a name="close">Usage: </a><a href="cmd_close.wiki">fossil close</a> ?-f|--force?
 
188 The opposite of "open". Close the current database connection.
189 Require a -f or --force flag if there are unsaved changed in the
190 current check-out.
191
192 <hr><a href="#tof">&#710;</a>
193 <a name="configure">Usage: </a><a href="cmd_configure.wiki">fossil configure</a> METHOD ...
 
194 Where METHOD is one of: export import merge pull push reset. All methods
195 accept the -R or --repository option to specific a repository.
196
197 fossil configuration export AREA FILENAME
198
@@ -222,12 +212,11 @@
212
213 fossil configuration pull AREA ?URL?
214
215 Pull and install the configuration from a different server
216 identified by URL. If no URL is specified, then the default
217 server is used.
 
218 fossil configuration push AREA ?URL?
219
220 Push the local configuration into the remote server identified
221 by URL. Admin privilege is required on the remote server for
222 this to work.
@@ -238,33 +227,29 @@
227
228 WARNING: Do not import, merge, or pull configurations from an untrusted
229 source. The inbound configuration is not checked for safety and can
230 introduce security vulnerabilities.
231
232 <hr><a href="#tof">&#710;</a>
233 COMMAND: deconstruct
234 <a name="deconstruct">Usage: </a><a href="cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION
 
235 Populates the indicated DESTINATION directory with copies of all
236 artifcats contained within the repository. Artifacts are named AA/bbbbb
237 where AA is the first 2 characters of the artifact ID and bbbbb is the
238 remaining 38 characters.
239
240 <hr><a href="#tof">&#710;</a>
241 <a name="rm">Usage: </a><a href="cmd_rm.wiki">fossil rm</a> FILE... or: fossil del FILE...
 
242 Remove one or more files from the tree.
243
244 <hr><a href="#tof">&#710;</a>
245 <a name="descendants">Usage: </a><a href="cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID?
 
246 Find all leaf descendants of the baseline specified or if the argument
247 is omitted, of the baseline currently checked out.
248
249 <hr><a href="#tof">&#710;</a>
250 <a name="diff">Usage: </a><a href="cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE...
 
251 Show the difference between the current version of a file (as it
252 exists on disk) and that same file as it was checked out.
253
254 diff will show a textual diff while gdiff will attempt to run a
255 graphical diff command that you have setup. If the choosen command
@@ -283,84 +268,72 @@
268 fossil setting gdiff-command tortoisemerge
269 fossil setting gdiff-command meld
270 fossil setting gdiff-command xxdiff
271 fossil setting gdiff-command kdiff3
272
273 <hr><a href="#tof">&#710;</a>
274 <a name="extra">Usage: </a><a href="cmd_extra.wiki">fossil extra</a>
 
275 Print a list of all files in the source tree that are not part of
276 the current checkout. See also the "clean" command.
277
278 <hr><a href="#tof">&#710;</a>
279 <a name="help">Usage: </a><a href="cmd_help.wiki">fossil help</a> COMMAND
 
280 Display information on how to use COMMAND
281
282 <hr><a href="#tof">&#710;</a>
283 <a name="http">Usage: </a><a href="cmd_http.wiki">fossil http</a> REPOSITORY
 
284 Handle a single HTTP request appearing on stdin. The resulting webpage
285 is delivered on stdout. This method is used to launch an HTTP request
286 handler from inetd, for example. The argument is the name of the repository.
 
287
288 <hr><a href="#tof">&#710;</a>
289 <a name="info">Usage: </a><a href="cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME?
 
290 With no arguments, provide information about the current tree.
291 If an argument is specified, provide information about the object
292 in the respository of the current tree that the argument refers
293 to. Or if the argument is the name of a repository, show
294 information about that repository.
295
296 <hr><a href="#tof">&#710;</a>
297 <a name="leaves">Usage: </a><a href="cmd_leaves.wiki">fossil leaves</a>
 
298 Find leaves of all branches.
299
300 <hr><a href="#tof">&#710;</a>
301 <a name="ls">Usage: </a><a href="cmd_ls.wiki">fossil ls</a>
 
302 Show the names of all files in the current checkout
303
304 <hr><a href="#tof">&#710;</a>
305 <a name="merge">Usage: </a><a href="cmd_merge.wiki">fossil merge</a> VERSION
 
306 The argument is a version that should be merged into the current
307 checkout.
 
308 Only file content is merged. The result continues to use the
309 file and directory names from the current check-out even if those
310 names might have been changed in the branch being merged in.
311
312 <hr><a href="#tof">&#710;</a>
313 <a name="mv">Usage: </a><a href="cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME or: fossil mv|rename OLDNAME... DIR
 
314
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
325 a copy of an existing project. This command starts a new project.
326
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.
337 If there is no such option then the open repository is used.
338 The URL of the remote server is specified on the command line
339 If no URL is specified then the URL used by the most recent
@@ -374,51 +347,45 @@
347 The "USER" substring specifies the login user. You will be
348 prompted for the password on the command-line. The PORT
349 specifies the TCP port of the server. The default port is
350 80.
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
362 <hr><a href="#tof">&#710;</a>
363 COMMAND: reconstruct
364 <a name="reconstruct">Usage: </a><a href="cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN
 
365 Creates the REPOSITORY and populates it with the artifacts in the
366 indicated ORIGIN directory.
367
368 <hr><a href="#tof">&#710;</a>
369 <a name="redo">Usage: </a><a href="cmd_redo.wiki">fossil redo</a> ?FILENAME...?
 
370 Redo the an update or merge operation that has been undone by the
371 undo command. If FILENAME is specified then restore the changes
372 associated with the named file(s) but otherwise leave the update
373 or merge undone.
374
375 A single level of undo/redo is supported. The undo/redo stack
376 is cleared by the commit and checkout commands.
377
378 <hr><a href="#tof">&#710;</a>
379 <a name="revert">Usage: </a><a href="cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE
 
380 Revert to the current repository version of FILE, or to
381 the version associated with baseline REVISION if the -r flag
382 appears. This command will confirm your operation unless the
383 file is missing or the --yes option is used.
384
385 <hr><a href="#tof">&#710;</a>
386 <a name="server">Usage: </a><a href="cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY? Or: fossil ui ?-P|--port TCPPORT? ?REPOSITORY?
 
387
388 Open a socket and begin listening and responding to HTTP requests on
389 TCP port 8080, or on any other TCP port defined by the -P or
390 --port option. The optional argument is the name of the repository.
391 The repository argument may be omitted if the working directory is
@@ -425,15 +392,14 @@
392 within an open checkout.
393
394 The "ui" command automatically starts a web browser after initializing
395 the web server.
396
397 <hr><a href="#tof">&#710;</a>
398 COMMAND: settings
399 COMMAND: unset
400 <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? fossil unset PROPERTY ?-global?
 
401
402 The "setting" command with no arguments lists all properties and their
403 values. With just a property name it shows the value of that property.
404 With a value argument it changes the property for the current repository.
405
@@ -471,25 +437,22 @@
437 web-browser A shell command used to launch your preferred
438 web browser when given a URL as an argument.
439 Defaults to "start" on windows, "open" on Mac,
440 and "firefox" on Unix.
441
442 <hr><a href="#tof">&#710;</a>
443 <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a>
 
444 Report on the status of the current checkout.
445
446 <hr><a href="#tof">&#710;</a>
447 <a name="sync">Usage: </a><a href="cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY?
 
448 Synchronize the local repository with a remote repository. This is
449 the equivalent of running both "push" and "pull" at the same time.
450 See the "pull" command for additional information.
451
452 <hr><a href="#tof">&#710;</a>
453 <a name="tag">Usage: </a><a href="cmd_tag.wiki">fossil tag</a> SUBCOMMAND ...
 
454 Run various subcommands to control tags and properties
455
456 fossil tag add ?--raw? TAGNAME BASELINE ?VALUE?
457
458 Add a new tag or property to BASELINE. The tag will
@@ -540,13 +503,12 @@
503
504 fossil update tag:decaf
505
506 will assume that "decaf" is a tag/branch name.
507
508 <hr><a href="#tof">&#710;</a>
509 <a name="timeline">Usage: </a><a href="cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N?
 
510 Print a summary of activity going backwards in date and time
511 specified or from the current date and time if no arguments
512 are given. Show as many as N (default 20) check-ins. The
513 WHEN argument can be any unique abbreviation of one of these
514 keywords:
@@ -559,35 +521,31 @@
521 The BASELINE can be any unique prefix of 4 characters or more.
522 The DATETIME should be in the ISO8601 format. For
523 examples: "2007-08-18 07:21:21". You can also say "current"
524 for the current version or "now" for the current time.
525
526 <hr><a href="#tof">&#710;</a>
527 <a name="undo">Usage: </a><a href="cmd_undo.wiki">fossil undo</a> ?FILENAME...?
 
528 Undo the most recent update or merge operation. If FILENAME is
529 specified then restore the content of the named file(s) but otherwise
530 leave the update or merge in effect.
531
532 A single level of undo/redo is supported. The undo/redo stack
533 is cleared by the commit and checkout commands.
534
535 <hr><a href="#tof">&#710;</a>
536 <a name="update">Usage: </a><a href="cmd_update.wiki">fossil update</a> ?VERSION? ?--latest?
 
537 The optional argument is a version that should become the current
538 version. If the argument is omitted, then use the leaf of the
539 tree that begins with the current version, if there is only a single leaf. If there are a multiple leaves, the latest is used
 
540 if the --latest flag is present.
541
542 This command is different from the "checkout" in that edits are
543 not overwritten. Edits are merged into the new version.
544
545 <hr><a href="#tof">&#710;</a>
546 <a name="user">Usage: </a><a href="cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE?
 
547 Run various subcommands on users of the open repository or of
548 the repository identified by the -R or --repository option.
549
550 fossil user capabilities USERNAME ?STRING?
551
@@ -610,18 +568,16 @@
568
569 fossil user password USERNAME
570
571 Change the web access password for a user.
572
573 <hr><a href="#tof">&#710;</a>
574 <a name="version">Usage: </a><a href="cmd_version.wiki">fossil version</a>
 
575 Print the source code version number for the fossil executable.
576
577 <hr><a href="#tof">&#710;</a>
578 <a name="wiki">Usage: </a><a href="cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName
 
579 Run various subcommands to fetch wiki entries.
580
581 fossil wiki export PAGENAME ?FILE?
582
583 Sends the latest version of the PAGENAME wiki
@@ -662,11 +618,11 @@
618 Diffs the local copy of a page with a given version (defaulting
619 to the head version).
620
621 </pre></nowiki>
622
623 <hr><a href="#tof">&#710;</a>
624
625 <h3>Caveats</h3>
626 This is not actually a reference, it's the start of a reference.
627 There are wikilinks to uncreated pages for the commands. This was
628 created by running the fossil help for each command listed by running
@@ -676,6 +632,5 @@
632 so they are (currently) not addressed here. Clarity and brevity may be
633 sacrificed for expediency at the authors indiscretion. All spelling and
634 grammatical mistakes are somebody elses fault.<code> void * </code>
635 prohibited where<code> __C_PLUS_PLUS__ </code>. Title and taxes extra.
636 Not valid in Hooptigonia.
 
637

Keyboard Shortcuts

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