Fossil SCM

cli docs

kejoki 2008-12-21 16:36 trunk
Commit aef81bf344e688a620af8db143e54cff1bbbf017
--- www/cmd_.wiki-template
+++ www/cmd_.wiki-template
@@ -5,18 +5,18 @@
55
66
The <code>foo</code> command <<allows you | helps> to> | <ensures that> bar.
77
88
The flibenglookners that the foo command <operates on> | <displays> bar.
99
10
-Typing <code>fossil foo</cod> will gonkulate any flibenglookners, but baz.
10
+Typing <code>fossil foo</code> will gonkulate any flibenglookners, but baz.
1111
1212
What we going to exemplify.
1313
1414
Example.
1515
1616
Raison d'etre.
1717
1818
Compare <code>foo</code> to this here other <code>thingy</code>.
1919
20
-See also: <a href="cmd_bar.wiki">fossil bar</a>,
21
-<a href="cmd_baz.wiki">fossil baz</a>,
22
-<a href="reference.wiki">Reference</a>
20
+See also: [./cmd_bar.wiki | fossil bar],
21
+[./cmd_baz.wiki | fossil baz],
22
+[./reference.wiki | Reference]
2323
2424
ADDED www/cmd_cgi.wiki
2525
ADDED www/cmd_mv.wiki
2626
ADDED www/cmd_rm.wiki
--- www/cmd_.wiki-template
+++ www/cmd_.wiki-template
@@ -5,18 +5,18 @@
5
6 The <code>foo</code> command <<allows you | helps> to> | <ensures that> bar.
7
8 The flibenglookners that the foo command <operates on> | <displays> bar.
9
10 Typing <code>fossil foo</cod> will gonkulate any flibenglookners, but baz.
11
12 What we going to exemplify.
13
14 Example.
15
16 Raison d'etre.
17
18 Compare <code>foo</code> to this here other <code>thingy</code>.
19
20 See also: <a href="cmd_bar.wiki">fossil bar</a>,
21 <a href="cmd_baz.wiki">fossil baz</a>,
22 <a href="reference.wiki">Reference</a>
23
24 DDED www/cmd_cgi.wiki
25 DDED www/cmd_mv.wiki
26 DDED www/cmd_rm.wiki
--- www/cmd_.wiki-template
+++ www/cmd_.wiki-template
@@ -5,18 +5,18 @@
5
6 The <code>foo</code> command <<allows you | helps> to> | <ensures that> bar.
7
8 The flibenglookners that the foo command <operates on> | <displays> bar.
9
10 Typing <code>fossil foo</code> will gonkulate any flibenglookners, but baz.
11
12 What we going to exemplify.
13
14 Example.
15
16 Raison d'etre.
17
18 Compare <code>foo</code> to this here other <code>thingy</code>.
19
20 See also: [./cmd_bar.wiki | fossil bar],
21 [./cmd_baz.wiki | fossil baz],
22 [./reference.wiki | Reference]
23
24 DDED www/cmd_cgi.wiki
25 DDED www/cmd_mv.wiki
26 DDED www/cmd_rm.wiki
--- a/www/cmd_cgi.wiki
+++ b/www/cmd_cgi.wiki
@@ -0,0 +1,19 @@
1
+<h2>cgi</h2>
2
+
3
+<code>cgi</code> is the command that tells fossil it is running as a
4
+web-page supplier for an external http server. (For you web-miesters,
5
+the "cgi" is actually unnecessary if your web environment is set up in
6
+a normal fashion.)
7
+
8
+This is the command you will probably use if you want to make a
9
+moderate-to-high hit rate public repository (like the <b>fossil</b>
10
+project's self-hosted repository) but you'll be using it in the
11
+shebang line.
12
+
13
+If you need lower level access to the pages <b>fossil</b> generates,
14
+you'll want to look at the [./cmd_http.wiki | <code>http</code>]
15
+command.
16
+
17
+See also: [./cmd_http.wiki | fossil http],
18
+[./concepts.wiki#saserv | <i>Concepts (setting up a server)</i>],
19
+[./reference.wiki | Reference]
--- a/www/cmd_cgi.wiki
+++ b/www/cmd_cgi.wiki
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_cgi.wiki
+++ b/www/cmd_cgi.wiki
@@ -0,0 +1,19 @@
1 <h2>cgi</h2>
2
3 <code>cgi</code> is the command that tells fossil it is running as a
4 web-page supplier for an external http server. (For you web-miesters,
5 the "cgi" is actually unnecessary if your web environment is set up in
6 a normal fashion.)
7
8 This is the command you will probably use if you want to make a
9 moderate-to-high hit rate public repository (like the <b>fossil</b>
10 project's self-hosted repository) but you'll be using it in the
11 shebang line.
12
13 If you need lower level access to the pages <b>fossil</b> generates,
14 you'll want to look at the [./cmd_http.wiki | <code>http</code>]
15 command.
16
17 See also: [./cmd_http.wiki | fossil http],
18 [./concepts.wiki#saserv | <i>Concepts (setting up a server)</i>],
19 [./reference.wiki | Reference]
--- a/www/cmd_mv.wiki
+++ b/www/cmd_mv.wiki
@@ -0,0 +1,24 @@
1
+<h2>mv | rename</h2>
2
+
3
+The <code>mv</code> (alias "<code>rename</code>") command tells
4
+<b>fossil</b> that a file has gone from one external name to another
5
+without changing content.
6
+
7
+You could do this by renaming the file in the file system,
8
+[./cmd_rm.wiki | deleting] the old name from the project, and
9
+[./cmd_add.wiki | adding] the new name. But you would lose the
10
+continuity of the <u>content's</u> history that way. Using
11
+<code>mv</code> makes the name change a part of the history
12
+maintained by <b>fossil</b>. You will, of course, need a good
13
+comment somewhere (say, the commit comment) if you want to
14
+remember <em>why</em> you changed the name... <b>fossil</b>
15
+only maintains history, it doesn't (yet) explain it.
16
+
17
+<code>mv</code> is much like the [./cmd_rm.wiki | <code>rm</code>]
18
+command, in that it manipulates <b>fossil</b>'s "idea" of what is
19
+part of the project. The difference is that <code>mv</code> assumes
20
+you have actually made some change to the file system.
21
+
22
+See also: [./cmd_rm.wiki | fossil rm],
23
+[./cmd_add.wiki | fossil add],
24
+[./reference.wiki | Reference]
--- a/www/cmd_mv.wiki
+++ b/www/cmd_mv.wiki
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_mv.wiki
+++ b/www/cmd_mv.wiki
@@ -0,0 +1,24 @@
1 <h2>mv | rename</h2>
2
3 The <code>mv</code> (alias "<code>rename</code>") command tells
4 <b>fossil</b> that a file has gone from one external name to another
5 without changing content.
6
7 You could do this by renaming the file in the file system,
8 [./cmd_rm.wiki | deleting] the old name from the project, and
9 [./cmd_add.wiki | adding] the new name. But you would lose the
10 continuity of the <u>content's</u> history that way. Using
11 <code>mv</code> makes the name change a part of the history
12 maintained by <b>fossil</b>. You will, of course, need a good
13 comment somewhere (say, the commit comment) if you want to
14 remember <em>why</em> you changed the name... <b>fossil</b>
15 only maintains history, it doesn't (yet) explain it.
16
17 <code>mv</code> is much like the [./cmd_rm.wiki | <code>rm</code>]
18 command, in that it manipulates <b>fossil</b>'s "idea" of what is
19 part of the project. The difference is that <code>mv</code> assumes
20 you have actually made some change to the file system.
21
22 See also: [./cmd_rm.wiki | fossil rm],
23 [./cmd_add.wiki | fossil add],
24 [./reference.wiki | Reference]
--- a/www/cmd_rm.wiki
+++ b/www/cmd_rm.wiki
@@ -0,0 +1,40 @@
1
+<h2>del | rm</h2>
2
+
3
+The <code>del</code> (alias <code>rm</code>) command takes a "file"
4
+<em>out</em> of a project.
5
+
6
+It does <u>not</u> delete the file from the repository, it does
7
+<u>not</u> remove the file from the file system on disk. It tells
8
+<b>fossil</b> that the file is no longer a part of the project for
9
+which <b>fossil</b> is maintaining the sources.
10
+
11
+For example, if you have a nice, clean source tree and use the
12
+[./cmd_extra.wiki | <code>extra</code>] command on it, you won't
13
+get any output. If you then <code>rm</code> some file and commit
14
+the change, that file will be listed by the <code>extra</code>
15
+command.
16
+
17
+The file is still on the disk, and it is still in the repository.
18
+<strong>But</strong> the file <em>is not part of the project</em>
19
+anymore. Further changes to the file will not be checked in unless
20
+you [./cmd_add.wiki | <code>add</code>] the file again.
21
+
22
+It can initially be confusing to see a file that's been "deleted"
23
+still showing up in the files list in the repository, but remember
24
+that the files list currently<a href="#vnote"><sup>*</sup></a> shows
25
+all of the files that have ever been in the repository <em>because
26
+<b>fossil</b> is a source control system and therefore keeps a record
27
+of the history of a project.</em>
28
+
29
+To get a list of the files <em>only in the current version</em> of the
30
+project, use the [./cmd_ls.wiki | <code>ls</code>] command.
31
+
32
+The <code>del</code> command is the logical opposite of the
33
+[./cmd_add.wiki | <code>add</code>] command, in its single-file-add
34
+form.
35
+
36
+<font size="-1"><a name="vnote"><sup>*</sup></a>version 7c281b629a on 20081220</font>
37
+
38
+See also: [./cmd_add.wiki | fossil add],
39
+[./cmd_ls.wiki | fossil ls],
40
+[./reference.wiki | Reference]
--- a/www/cmd_rm.wiki
+++ b/www/cmd_rm.wiki
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_rm.wiki
+++ b/www/cmd_rm.wiki
@@ -0,0 +1,40 @@
1 <h2>del | rm</h2>
2
3 The <code>del</code> (alias <code>rm</code>) command takes a "file"
4 <em>out</em> of a project.
5
6 It does <u>not</u> delete the file from the repository, it does
7 <u>not</u> remove the file from the file system on disk. It tells
8 <b>fossil</b> that the file is no longer a part of the project for
9 which <b>fossil</b> is maintaining the sources.
10
11 For example, if you have a nice, clean source tree and use the
12 [./cmd_extra.wiki | <code>extra</code>] command on it, you won't
13 get any output. If you then <code>rm</code> some file and commit
14 the change, that file will be listed by the <code>extra</code>
15 command.
16
17 The file is still on the disk, and it is still in the repository.
18 <strong>But</strong> the file <em>is not part of the project</em>
19 anymore. Further changes to the file will not be checked in unless
20 you [./cmd_add.wiki | <code>add</code>] the file again.
21
22 It can initially be confusing to see a file that's been "deleted"
23 still showing up in the files list in the repository, but remember
24 that the files list currently<a href="#vnote"><sup>*</sup></a> shows
25 all of the files that have ever been in the repository <em>because
26 <b>fossil</b> is a source control system and therefore keeps a record
27 of the history of a project.</em>
28
29 To get a list of the files <em>only in the current version</em> of the
30 project, use the [./cmd_ls.wiki | <code>ls</code>] command.
31
32 The <code>del</code> command is the logical opposite of the
33 [./cmd_add.wiki | <code>add</code>] command, in its single-file-add
34 form.
35
36 <font size="-1"><a name="vnote"><sup>*</sup></a>version 7c281b629a on 20081220</font>
37
38 See also: [./cmd_add.wiki | fossil add],
39 [./cmd_ls.wiki | fossil ls],
40 [./reference.wiki | Reference]
--- www/concepts.wiki
+++ www/concepts.wiki
@@ -366,11 +366,11 @@
366366
a lot of work and normally takes time, patience, and a lot of system
367367
knowledge. Fossil is designed to avoid this frustration. Setting up
368368
a server with fossil is ridiculously easy. You have three options:</p>
369369
370370
<ol>
371
-<li><p><b>Setting up a stand-alone server</b></p>
371
+<li><p><b><a name="saserv">S</a>etting up a stand-alone server</b></p>
372372
373373
<p>From within your source tree just use the <b>server</b> command and
374374
fossil will start listening for incoming requests on TCP port 8080.
375375
You can point your web browser at <a href="http://localhost:8080/">
376376
http://localhost:8080/</a> and begin exploring. Or your coworkers
377377
--- www/concepts.wiki
+++ www/concepts.wiki
@@ -366,11 +366,11 @@
366 a lot of work and normally takes time, patience, and a lot of system
367 knowledge. Fossil is designed to avoid this frustration. Setting up
368 a server with fossil is ridiculously easy. You have three options:</p>
369
370 <ol>
371 <li><p><b>Setting up a stand-alone server</b></p>
372
373 <p>From within your source tree just use the <b>server</b> command and
374 fossil will start listening for incoming requests on TCP port 8080.
375 You can point your web browser at <a href="http://localhost:8080/">
376 http://localhost:8080/</a> and begin exploring. Or your coworkers
377
--- www/concepts.wiki
+++ www/concepts.wiki
@@ -366,11 +366,11 @@
366 a lot of work and normally takes time, patience, and a lot of system
367 knowledge. Fossil is designed to avoid this frustration. Setting up
368 a server with fossil is ridiculously easy. You have three options:</p>
369
370 <ol>
371 <li><p><b><a name="saserv">S</a>etting up a stand-alone server</b></p>
372
373 <p>From within your source tree just use the <b>server</b> command and
374 fossil will start listening for incoming requests on TCP port 8080.
375 You can point your web browser at <a href="http://localhost:8080/">
376 http://localhost:8080/</a> and begin exploring. Or your coworkers
377
+10 -10
--- www/reference.wiki
+++ www/reference.wiki
@@ -14,21 +14,21 @@
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.
1818
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.
23
+
1924
* A <u>version</u> in <b>fossil</b> is 40 character hexadecimal string.
2025
<b>fossil</b> will be able to figure out which version you want with any
2126
prefix of that string that is distinct from all others. <em>Commands
2227
which require a version are looking for that string, the unique prefix,
2328
or a <code>tag</code>.</em>
2429
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.
29
-
3030
You should probably start interacting with fossil at the command line
3131
by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#710;</a>
3232
3333
<code>$ fossil help</code><nowiki><pre>
3434
Usage: fossil help COMMAND.
@@ -42,25 +42,25 @@
4242
</tr>
4343
<tr>
4444
<td><a href="#all">all</a>*</td>
4545
<td><a href="#deconstruct">deconstruct</a></td>
4646
<td><a href="#ls">ls</a>*</td>
47
- <td><a href="#mv">rename</a></td>
47
+ <td><a href="#mv">rename</a>*</td>
4848
<td><a href="#server">ui</a></td>
4949
</tr>
5050
<tr>
51
- <td><a href="#cgi">cgi</a></td>
52
- <td><a href="#rm">del</a></td>
51
+ <td><a href="#cgi">cgi</a>*</td>
52
+ <td><a href="#rm">del</a>*</td>
5353
<td><a href="#merge">merge</a></td>
5454
<td><a href="#revert">revert</a></td>
5555
<td><a href="#undo">undo</a></td>
5656
</tr>
5757
<tr>
5858
<td><a href="#changes">changes</a>*</td>
5959
<td><a href="#descendants">descendants</a></td>
60
- <td><a href="#mv">mv</a></td>
61
- <td><a href="#rm">rm</a></td>
60
+ <td><a href="#mv">mv</a>*</td>
61
+ <td><a href="#rm">rm</a>*</td>
6262
<td><a href="#setting">unset</a></td>
6363
</tr>
6464
<tr>
6565
<td><a href="#checkout">checkout</a>*</td>
6666
<td><a href="#diff">diff</a></td>
6767
--- www/reference.wiki
+++ www/reference.wiki
@@ -14,21 +14,21 @@
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.
29
30 You should probably start interacting with fossil at the command line
31 by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#710;</a>
32
33 <code>$ fossil help</code><nowiki><pre>
34 Usage: fossil help COMMAND.
@@ -42,25 +42,25 @@
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
--- www/reference.wiki
+++ www/reference.wiki
@@ -14,21 +14,21 @@
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.
23
24 * A <u>version</u> in <b>fossil</b> is 40 character hexadecimal string.
25 <b>fossil</b> will be able to figure out which version you want with any
26 prefix of that string that is distinct from all others. <em>Commands
27 which require a version are looking for that string, the unique prefix,
28 or a <code>tag</code>.</em>
29
 
 
 
 
 
30 You should probably start interacting with fossil at the command line
31 by asking it what it can do:&nbsp;&nbsp;&nbsp;&nbsp;<a name="tof">&#710;</a>
32
33 <code>$ fossil help</code><nowiki><pre>
34 Usage: fossil help COMMAND.
@@ -42,25 +42,25 @@
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

Keyboard Shortcuts

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