| | @@ -1,40 +1,46 @@ |
| 1 | 1 | <h2>Command Line Interface Reference</h2> |
| 2 | 2 | |
| 3 | | - This is an easy introduction to the fossil command line interface (cli). |
| 4 | | - It assumes some familiarity with using the command line, and with Source |
| 5 | | - Code Maintenence (SCM) systems—but not <i>too</i> much. |
| 3 | + This is an easy introduction to the fossil command line interface |
| 4 | + (cli). It assumes some familiarity with using the command line, and |
| 5 | + with Source Code Maintenence (SCM) systems—but not <i>too</i> |
| 6 | + much. |
| 6 | 7 | |
| 7 | | - If you are trying to find information about fossil's web capabilities, |
| 8 | | - see the <a href="index.wiki">Fossil Home</a> and |
| 8 | + If you are trying to find information about fossil's web |
| 9 | + capabilities, see the <a href="index.wiki">Fossil Home</a> and |
| 9 | 10 | <a href="wikitheory.wiki">Fossil Wiki</a> pages for pointers. |
| 10 | 11 | |
| 11 | 12 | <h3>Things to note</h3> |
| 12 | | - * Fossil cli commands do not use special delimeters, they use spaces. |
| 13 | | - This is traditional with VCS/SCM. Some <i>options</i> to fossil commands |
| 14 | | - <i>do</i> use special delimiters, particularly the '-' (hyphen, or dash) |
| 15 | | - character. This is very similar to Tcl. Think of fossil as a shell you |
| 16 | | - invoke and feed a command to, including any options, and it will make |
| 17 | | - more sense. |
| 18 | | - |
| 19 | | - * Any fossil command is acceptable once enough of it has been |
| 13 | + * Fossil cli commands do not use special delimeters, they use |
| 14 | + spaces. This is traditional with VCS/SCM. Some <i>options</i> to |
| 15 | + fossil commands <i>do</i> use special delimiters, particularly the |
| 16 | + '-' (hyphen, or dash) character. This is very similar to Tcl. |
| 17 | + Think of fossil as a shell you invoke and feed a command to, |
| 18 | + including any options, and it will make more sense. |
| 19 | + |
| 20 | + * Any fossil command is acceptable once enough of it has been |
| 20 | 21 | entered to make the intent unambiguous. 'clo' is a proper prefix of |
| 21 | 22 | both the 'clone' and 'close' commands, for instance, but 'clon' is |
| 22 | | - enough to make the intent—the 'clone' command—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: <a name="tof">ˆ</a> |
| 23 | + enough to make the intent—the 'clone' |
| 24 | + command—unambiguous. |
| 25 | + |
| 26 | + * Pragmatically, a <u>version</u> in <b>fossil</b> is a |
| 27 | + 40-character long string of hexadecimal. <b>fossil</b> will be |
| 28 | + able to figure out which version you want with any |
| 29 | + <i>distinct</i> prefix of that string which is at least four |
| 30 | + characters long. <em>Commands which require a version are |
| 31 | + looking for the string, a distinct prefix of the string, or a |
| 32 | + <code>tag</code>.</em> |
| 33 | + |
| 34 | + You should probably start interacting with fossil at the command |
| 35 | + line by asking it what it can |
| 36 | + do: <a name="tof">ˆ</a> |
| 32 | 37 | |
| 33 | 38 | <code>$ fossil help</code><nowiki><pre> |
| 34 | 39 | Usage: fossil help COMMAND. |
| 35 | | -Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; "> |
| 40 | +Available COMMANDs:</pre><table width="80%" |
| 41 | + style="font-family: fixed, courier, monospace;"> |
| 36 | 42 | <tr> |
| 37 | 43 | <td><a href="#add">add</a>*</td> |
| 38 | 44 | <td><a href="#configure">configuration</a></td> |
| 39 | 45 | <td><a href="#leaves">leaves</a></td> |
| 40 | 46 | <td><a href="#redo">redo</a></td> |
| | @@ -100,11 +106,11 @@ |
| 100 | 106 | <td><a href="#info">info</a></td> |
| 101 | 107 | <td><a href="#reconstruct">reconstruct</a></td> |
| 102 | 108 | <td><a href="#tag">tag</a></td> |
| 103 | 109 | </tr> |
| 104 | 110 | </table><nowiki><pre> |
| 105 | | -This is fossil version [ba837fd294] 2008-12-16 18:39:29 UTC |
| 111 | +This is fossil version [b12a031557] 2008-12-26 17:41:09 UTC |
| 106 | 112 | </pre> |
| 107 | 113 | <b>What follows</b> is a survey of what you get if you type<code> |
| 108 | 114 | fossil help <i>command</i> </code>for all of the |
| 109 | 115 | commands listed above. There are links to individual pages for each |
| 110 | 116 | of them; pages with content (commands marked with a '*' are done) go |
| | @@ -410,51 +416,58 @@ |
| 410 | 416 | the web server. |
| 411 | 417 | |
| 412 | 418 | <hr><a href="#tof">ˆ</a> |
| 413 | 419 | COMMAND: settings |
| 414 | 420 | COMMAND: unset |
| 415 | | - <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? fossil unset PROPERTY ?-global? |
| 421 | + <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? |
| 422 | + fossil unset PROPERTY ?-global? |
| 416 | 423 | |
| 417 | 424 | The "setting" command with no arguments lists all properties and their |
| 418 | 425 | values. With just a property name it shows the value of that property. |
| 419 | 426 | With a value argument it changes the property for the current repository. |
| 420 | 427 | |
| 421 | 428 | The "unset" command clears a property setting. |
| 422 | 429 | |
| 423 | | - autosync If enabled, automatically pull prior to |
| 424 | | - commit or update and automatically push |
| 425 | | - after commit or tag or branch creation. |
| 426 | | - |
| 427 | | - diff-command External command to run when performing a diff. |
| 428 | | - If undefined, the internal text diff will be used. |
| 429 | | - |
| 430 | | - editor Text editor command used for check-in comments. |
| 431 | | - |
| 432 | | - gdiff-command External command to run when performing a graphical |
| 433 | | - diff. If undefined, text diff will be used. |
| 434 | | - |
| 435 | | - localauth If enabled, require that HTTP connections from |
| 436 | | - 127.0.0.1 be authenticated by password. If |
| 437 | | - false, all HTTP requests from localhost have |
| 438 | | - unrestricted access to the repository. |
| 439 | | - |
| 440 | | - clearsign When enabled (the default), fossil will attempt to |
| 441 | | - sign all commits with gpg. When disabled, commits will |
| 442 | | - be unsigned. |
| 443 | | - |
| 444 | | - pgp-command Command used to clear-sign manifests at check-in. |
| 445 | | - The default is "gpg --clearsign -o ". |
| 446 | | - |
| 447 | | - proxy URL of the HTTP proxy. If undefined or "off" then |
| 448 | | - the "http_proxy" environment variable is consulted. |
| 449 | | - If the http_proxy environment variable is undefined |
| 450 | | - then a direct HTTP connection is used. |
| 451 | | - |
| 452 | | - web-browser A shell command used to launch your preferred |
| 453 | | - web browser when given a URL as an argument. |
| 454 | | - Defaults to "start" on windows, "open" on Mac, |
| 455 | | - and "firefox" on Unix. |
| 430 | + autosync If enabled, automatically pull prior to |
| 431 | + commit or update and automatically push |
| 432 | + after commit or tag or branch creation. |
| 433 | + |
| 434 | + diff-command External command to run when performing a diff. |
| 435 | + If undefined, the internal text diff will be used. |
| 436 | + |
| 437 | + editor Text editor command used for check-in comments. |
| 438 | + |
| 439 | + http-port The TCP/IP port number to use by the "server" |
| 440 | + and "ui" commands. Default: 8080 |
| 441 | + |
| 442 | + gdiff-command External command to run when performing a graphical |
| 443 | + diff. If undefined, text diff will be used. |
| 444 | + |
| 445 | + localauth If enabled, require that HTTP connections from |
| 446 | + 127.0.0.1 be authenticated by password. If |
| 447 | + false, all HTTP requests from localhost have |
| 448 | + unrestricted access to the repository. |
| 449 | + |
| 450 | + clearsign When enabled (the default), fossil will attempt to |
| 451 | + sign all commits with gpg. When disabled, commits will |
| 452 | + be unsigned. |
| 453 | + |
| 454 | + pgp-command Command used to clear-sign manifests at check-in. |
| 455 | + The default is "gpg --clearsign -o ". |
| 456 | + |
| 457 | + mtime-changes Use file modification times (mtimes) to detect when |
| 458 | + files have been modified. |
| 459 | + |
| 460 | + proxy URL of the HTTP proxy. If undefined or "off" then |
| 461 | + the "http_proxy" environment variable is consulted. |
| 462 | + If the http_proxy environment variable is undefined |
| 463 | + then a direct HTTP connection is used. |
| 464 | + |
| 465 | + web-browser A shell command used to launch your preferred |
| 466 | + web browser when given a URL as an argument. |
| 467 | + Defaults to "start" on windows, "open" on Mac, |
| 468 | + and "firefox" on Unix. |
| 456 | 469 | |
| 457 | 470 | <hr><a href="#tof">ˆ</a> |
| 458 | 471 | <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a> |
| 459 | 472 | Report on the status of the current checkout. |
| 460 | 473 | |
| 461 | 474 | |