| | @@ -1,615 +1,680 @@ |
| 1 | | -<h2>Command Line Interface Reference</h2> |
| 2 | | - |
| 3 | | -The <code>fossil</code> program supplies most of the actual |
| 4 | | -documentation about its options, so a good way to start documenting |
| 5 | | -the program is to nab the output of <code>fossil help <i>command</i></code> |
| 6 | | -for all of its (exposed) cli. |
| 7 | | - |
| 8 | | -<i>This was suggested under the <b>Reference</b> heading in |
| 9 | | -[Documentation outline]. |
| 10 | | - |
| 11 | | -If you are trying to find information about fossil's web capabilities, |
| 12 | | -see the <a href="doc/tip/www/index.wiki">Fossil Home</a> and |
| 13 | | -<a href="doc/tip/www/wikitheory.wiki">Fossil Wiki</a> pages for pointers. |
| 14 | | - |
| 15 | | -<h3>Things to note</h3> |
| 16 | | -Fossil cli commands do not use special delimeters, they use spaces. |
| 17 | | -This is traditional with VCS/SCM. Some <i>options</i> to fossil commands |
| 18 | | -<i>do</i> use special delimiters, particularly the '-' (hyphen, or dash) |
| 19 | | -character. This is very similar to Tcl. |
| 20 | | - |
| 21 | | -Any fossil command is acceptable once enough of it has been |
| 22 | | -entered to make the intent unambiguous. 'clo' is a proper prefix of |
| 23 | | -both the 'clone' and 'close' commands, for instance, but 'clon' is |
| 24 | | -enough to make the intent—the 'clone' command—unambiguous. |
| 25 | | - |
| 26 | | -You should probably start interacting with fossil at the command line |
| 27 | | -by asking it what it can do: |
| 28 | | - |
| 29 | | -<code>$ fossil help</code><nowiki><pre> |
| 30 | | -Usage: fossil help COMMAND. |
| 31 | | -Available COMMANDs: |
| 32 | | -add configuration leaves redo ui |
| 33 | | -all deconstruct ls rename undo |
| 34 | | -cgi del merge revert unset |
| 35 | | -changes descendants mv rm update |
| 36 | | -checkout diff new server user |
| 37 | | -ci extra open settings version |
| 38 | | -clean gdiff pull status wiki |
| 39 | | -clone help push sync |
| 40 | | -close http rebuild tag |
| 41 | | -commit info reconstruct timeline |
| 42 | | -This is fossil version [c66ffba6da] 2008-11-10 19:54:53 UTC |
| 43 | | -</pre></nowiki> |
| 44 | | -<b>What follows</b> is a survey of what you get if you type<code> |
| 45 | | -fossil help <i>command</i> </code>for all of the |
| 46 | | -commands listed above. There are links to individual pages for each |
| 47 | | -of them; pages with content (not all of them are done) go into the command |
| 48 | | -in a bit more depth than the program help. |
| 49 | | -<nowiki><pre> |
| 50 | | - |
| 51 | | -Usage: </nowiki><code>[fossil add]</code><nowiki> FILE... |
| 52 | | - |
| 53 | | -Make arrangements to add one or more files to the current checkout |
| 54 | | -at the next commit. |
| 55 | | - |
| 56 | | - |
| 57 | | -Usage: </nowiki><code>[fossil all]</code><nowiki> (list|pull|push|rebuild|sync) |
| 58 | | - |
| 59 | | -The ~/.fossil file records the location of all repositories for a |
| 60 | | -user. This command performs certain operations on all repositories |
| 61 | | -that can be useful before or after a period of disconnection operation. |
| 62 | | -Available operations are: |
| 63 | | - |
| 64 | | - list Display the location of all repositories |
| 65 | | - |
| 66 | | - pull Run a "pull" operation on all repositories |
| 67 | | - |
| 68 | | - push Run a "push" on all repositories |
| 69 | | - |
| 70 | | - rebuild Rebuild on all repositories |
| 71 | | - |
| 72 | | - sync Run a "sync" on all repositories |
| 73 | | - |
| 74 | | -Respositories are automatically added to the set of known repositories |
| 75 | | -when one of the following commands against the repository: clone, info, |
| 76 | | -pull, push, or sync |
| 77 | | - |
| 78 | | - |
| 79 | | -Usage: </nowiki>[fossil cgi]<nowiki> SCRIPT |
| 80 | | - |
| 81 | | -The SCRIPT argument is the name of a file that is the CGI script |
| 82 | | -that is being run. The command name, "cgi", may be omitted if |
| 83 | | -the GATEWAY_INTERFACE environment variable is set to "CGI" (which |
| 84 | | -should always be the case for CGI scripts run by a webserver.) The |
| 85 | | -SCRIPT file should look something like this: |
| 86 | | - |
| 87 | | - #!/usr/bin/fossil |
| 88 | | - repository: /home/somebody/project.db |
| 89 | | - |
| 90 | | -The second line defines the name of the repository. After locating |
| 91 | | -the repository, fossil will generate a webpage on stdout based on |
| 92 | | -the values of standard CGI environment variables. |
| 93 | | - |
| 94 | | - |
| 95 | | -Usage: </nowiki>[fossil changes]<nowiki> |
| 96 | | - |
| 97 | | -Report on the edit status of all files in the current checkout. |
| 98 | | -See also the "status" and "extra" commands. |
| 99 | | - |
| 100 | | - |
| 101 | | -Usage: </nowiki>[fossil checkout]<nowiki> VERSION ?-f|--force? |
| 102 | | - |
| 103 | | -Check out a version specified on the command-line. This command |
| 104 | | -will not overwrite edited files in the current checkout unless |
| 105 | | -the --force option appears on the command-line. |
| 106 | | - |
| 107 | | -See also the "update" command. |
| 108 | | - |
| 109 | | - |
| 110 | | -Usage: </nowiki>[fossil commit]<nowiki> ?-m COMMENT? ?--nosign? ?FILE...? |
| 111 | | - fossil ci ... (as above) |
| 112 | | - |
| 113 | | -Create a new version containing all of the changes in the current |
| 114 | | -checkout. You will be prompted to enter a check-in comment unless |
| 115 | | -the "-m" option is used to specify a comment line. You will be |
| 116 | | -prompted for your GPG passphrase in order to sign the new manifest |
| 117 | | -unless the "--nosign" options is used. All files that have |
| 118 | | -changed will be committed unless some subset of files is specified |
| 119 | | -on the command line. |
| 120 | | - |
| 121 | | - |
| 122 | | -Usage: </nowiki>[fossil clean]<nowiki> ?-all? |
| 123 | | - |
| 124 | | -Delete all "extra" files in the source tree. "Extra" files are |
| 125 | | -files that are not officially part of the checkout. See also |
| 126 | | -the "extra" command. This operation cannot be undone. |
| 127 | | - |
| 128 | | -You will be prompted before removing each file. If you are |
| 129 | | -sure you wish to remove all "extra" files you can specify the |
| 130 | | -optional -all flag. |
| 131 | | - |
| 132 | | - |
| 133 | | -Usage: </nowiki>[fossil clone]<nowiki> URL FILENAME |
| 134 | | - |
| 135 | | -Make a clone of a repository specified by URL in the local |
| 136 | | -file named FILENAME. |
| 137 | | - |
| 138 | | - |
| 139 | | -Usage: </nowiki>[fossil close]<nowiki> ?-f|--force? |
| 140 | | - |
| 141 | | -The opposite of "open". Close the current database connection. |
| 142 | | -Require a -f or --force flag if there are unsaved changed in the |
| 143 | | -current check-out. |
| 144 | | - |
| 145 | | - |
| 146 | | -Usage: </nowiki>[fossil configure]<nowiki> METHOD ... |
| 147 | | - |
| 148 | | -Where METHOD is one of: export import merge pull push reset. All methods |
| 149 | | -accept the -R or --repository option to specific a repository. |
| 150 | | - |
| 151 | | - fossil configuration export AREA FILENAME |
| 152 | | - |
| 153 | | - Write to FILENAME exported configuraton information for AREA. |
| 154 | | - AREA can be one of: all ticket skin project |
| 155 | | - |
| 156 | | - fossil configuration import FILENAME |
| 157 | | - |
| 158 | | - Read a configuration from FILENAME, overwriting the current |
| 159 | | - configuration. |
| 160 | | - |
| 161 | | - fossil configuration merge FILENAME |
| 162 | | - |
| 163 | | - Read a configuration from FILENAME and merge its values into |
| 164 | | - the current configuration. Existing values take priority over |
| 165 | | - values read from FILENAME. |
| 166 | | - |
| 167 | | - fossil configuration pull AREA ?URL? |
| 168 | | - |
| 169 | | - Pull and install the configuration from a different server |
| 170 | | - identified by URL. If no URL is specified, then the default |
| 171 | | - server is used. |
| 172 | | - |
| 173 | | - fossil configuration push AREA ?URL? |
| 174 | | - |
| 175 | | - Push the local configuration into the remote server identified |
| 176 | | - by URL. Admin privilege is required on the remote server for |
| 177 | | - this to work. |
| 178 | | - |
| 179 | | - fossil configuration reset AREA |
| 180 | | - |
| 181 | | - Restore the configuration to the default. AREA as above. |
| 182 | | - |
| 183 | | -WARNING: Do not import, merge, or pull configurations from an untrusted |
| 184 | | -source. The inbound configuration is not checked for safety and can |
| 185 | | -introduce security vulnerabilities. |
| 186 | | - |
| 187 | | - |
| 188 | | -COMMAND: deconstruct |
| 189 | | -Usage: </nowiki>[fossil deconstruct]<nowiki> ?-R|--repository REPOSITORY? DESTINATION |
| 190 | | - |
| 191 | | -Populates the indicated DESTINATION directory with copies of all |
| 192 | | -artifcats contained within the repository. Artifacts are named AA/bbbbb |
| 193 | | -where AA is the first 2 characters of the artifact ID and bbbbb is the |
| 194 | | -remaining 38 characters. |
| 195 | | - |
| 196 | | - |
| 197 | | -Usage: </nowiki>[fossil rm]<nowiki> FILE... |
| 198 | | - or: fossil del FILE... |
| 199 | | -Remove one or more files from the tree. |
| 200 | | - |
| 201 | | - |
| 202 | | -Usage: </nowiki>[fossil descendants]<nowiki> ?BASELINE-ID? |
| 203 | | - |
| 204 | | -Find all leaf descendants of the baseline specified or if the argument |
| 205 | | -is omitted, of the baseline currently checked out. |
| 206 | | - |
| 207 | | - |
| 208 | | -Usage: </nowiki>[fossil diff]<nowiki>|gdiff ?-i? ?-r REVISION? FILE... |
| 209 | | - |
| 210 | | -Show the difference between the current version of a file (as it |
| 211 | | -exists on disk) and that same file as it was checked out. |
| 212 | | - |
| 213 | | -diff will show a textual diff while gdiff will attempt to run a |
| 214 | | -graphical diff command that you have setup. If the choosen command |
| 215 | | -is not yet configured, the internal textual diff command will be |
| 216 | | -used. |
| 217 | | - |
| 218 | | -If -i is supplied for either diff or gdiff, the internal textual |
| 219 | | -diff command will be executed. |
| 220 | | - |
| 221 | | -Here are a few external diff command settings, for example: |
| 222 | | - |
| 223 | | - fossil setting diff-command diff |
| 224 | | - |
| 225 | | - fossil setting gdiff-command tkdiff |
| 226 | | - fossil setting gdiff-command eskill22 |
| 227 | | - fossil setting gdiff-command tortoisemerge |
| 228 | | - fossil setting gdiff-command meld |
| 229 | | - fossil setting gdiff-command xxdiff |
| 230 | | - fossil setting gdiff-command kdiff3 |
| 231 | | - |
| 232 | | - |
| 233 | | -Usage: </nowiki>[fossil extra]<nowiki> |
| 234 | | - |
| 235 | | -Print a list of all files in the source tree that are not part of |
| 236 | | -the current checkout. See also the "clean" command. |
| 237 | | - |
| 238 | | - |
| 239 | | -Usage: </nowiki>[fossil help]<nowiki> COMMAND |
| 240 | | - |
| 241 | | -Display information on how to use COMMAND |
| 242 | | - |
| 243 | | - |
| 244 | | -Usage: </nowiki>[fossil http]<nowiki> REPOSITORY |
| 245 | | - |
| 246 | | -Handle a single HTTP request appearing on stdin. The resulting webpage |
| 247 | | -is delivered on stdout. This method is used to launch an HTTP request |
| 248 | | -handler from inetd, for example. The argument is the name of the |
| 249 | | -repository. |
| 250 | | - |
| 251 | | - |
| 252 | | -Usage: </nowiki>[fossil info]<nowiki> ?ARTIFACT-ID|FILENAME? |
| 253 | | - |
| 254 | | -With no arguments, provide information about the current tree. |
| 255 | | -If an argument is specified, provide information about the object |
| 256 | | -in the respository of the current tree that the argument refers |
| 257 | | -to. Or if the argument is the name of a repository, show |
| 258 | | -information about that repository. |
| 259 | | - |
| 260 | | - |
| 261 | | -Usage: </nowiki>[fossil leaves]<nowiki> |
| 262 | | - |
| 263 | | -Find leaves of all branches. |
| 264 | | - |
| 265 | | - |
| 266 | | -Usage: </nowiki>[fossil ls]<nowiki> |
| 267 | | - |
| 268 | | -Show the names of all files in the current checkout |
| 269 | | - |
| 270 | | - |
| 271 | | -Usage: </nowiki>[fossil merge]<nowiki> VERSION |
| 272 | | - |
| 273 | | -The argument is a version that should be merged into the current |
| 274 | | -checkout. |
| 275 | | - |
| 276 | | -Only file content is merged. The result continues to use the |
| 277 | | -file and directory names from the current check-out even if those |
| 278 | | -names might have been changed in the branch being merged in. |
| 279 | | - |
| 280 | | - |
| 281 | | -Usage: </nowiki>[fossil new]<nowiki> FILENAME |
| 282 | | - |
| 283 | | -Create a repository for a new project in the file named FILENAME. |
| 284 | | -This command is distinct from "clone". The "clone" command makes |
| 285 | | -a copy of an existing project. This command starts a new project. |
| 286 | | - |
| 287 | | - |
| 288 | | -Usage: </nowiki>[fossil open]<nowiki> FILENAME |
| 289 | | - |
| 290 | | -Open a connection to the local repository in FILENAME. A checkout |
| 291 | | -for the repository is created with its root at the working directory. |
| 292 | | -See also the "close" command. |
| 293 | | - |
| 294 | | - |
| 295 | | -Usage: </nowiki>[fossil pull]<nowiki> ?URL? ?-R|--respository REPOSITORY? |
| 296 | | - |
| 297 | | -Pull changes in a remote repository into the local repository. |
| 298 | | -The repository is identified by the -R or --repository option. |
| 299 | | -If there is no such option then the open repository is used. |
| 300 | | -The URL of the remote server is specified on the command line |
| 301 | | -If no URL is specified then the URL used by the most recent |
| 302 | | -"pull", "push", or "sync" command is used. |
| 303 | | - |
| 304 | | -The URL is of the following form: |
| 305 | | - |
| 306 | | - http://USER@HOST:PORT/PATH |
| 307 | | - |
| 308 | | -The "USER@" and ":PORT" substrings are optional. |
| 309 | | -The "USER" substring specifies the login user. You will be |
| 310 | | -prompted for the password on the command-line. The PORT |
| 311 | | -specifies the TCP port of the server. The default port is |
| 312 | | -80. |
| 313 | | - |
| 314 | | - |
| 315 | | -Usage: </nowiki>[fossil push]<nowiki> ?URL? ?-R|--repository REPOSITORY? |
| 316 | | - |
| 317 | | -Push changes in the local repository over into a remote repository. |
| 318 | | -See the "pull" command for additional information. |
| 319 | | - |
| 320 | | -Usage: </nowiki>[fossil rebuild]<nowiki> REPOSITORY |
| 321 | | - |
| 322 | | -Reconstruct the named repository database from the core |
| 323 | | -records. Run this command after updating the fossil |
| 324 | | -executable in a way that changes the database schema. |
| 325 | | - |
| 326 | | - |
| 327 | | -COMMAND: reconstruct |
| 328 | | -Usage: </nowiki>[fossil reconstruct]<nowiki> REPOSITORY ORIGIN |
| 329 | | - |
| 330 | | -Creates the REPOSITORY and populates it with the artifacts in the |
| 331 | | -indicated ORIGIN directory. |
| 332 | | - |
| 333 | | - |
| 334 | | -Usage: </nowiki>[fossil redo]<nowiki> ?FILENAME...? |
| 335 | | - |
| 336 | | -Redo the an update or merge operation that has been undone by the |
| 337 | | -undo command. If FILENAME is specified then restore the changes |
| 338 | | -associated with the named file(s) but otherwise leave the update |
| 339 | | -or merge undone. |
| 340 | | - |
| 341 | | -A single level of undo/redo is supported. The undo/redo stack |
| 342 | | -is cleared by the commit and checkout commands. |
| 343 | | - |
| 344 | | - |
| 345 | | -Usage: </nowiki>[fossil revert]<nowiki> ?--yes? ?-r REVISION? FILE |
| 346 | | - |
| 347 | | -Revert to the current repository version of FILE, or to |
| 348 | | -the version associated with baseline REVISION if the -r flag |
| 349 | | -appears. This command will confirm your operation unless the |
| 350 | | -file is missing or the --yes option is used. |
| 351 | | - |
| 352 | | - |
| 353 | | -Usage: </nowiki>[fossil server]<nowiki> ?-P|--port TCPPORT? ?REPOSITORY? |
| 354 | | - Or: fossil ui ?-P|--port TCPPORT? ?REPOSITORY? |
| 355 | | - |
| 356 | | -Open a socket and begin listening and responding to HTTP requests on |
| 357 | | -TCP port 8080, or on any other TCP port defined by the -P or |
| 358 | | -The repository argument may be omitted if the working directory is |
| 359 | | -within an open checkout. |
| 360 | | - |
| 361 | | -The "ui" command automatically starts a web browser after initializing |
| 362 | | -the web server. |
| 363 | | - |
| 364 | | - |
| 365 | | -COMMAND: settings |
| 366 | | -COMMAND: unset |
| 367 | | -Usage: </nowiki>[fossil setting]<nowiki> ?PROPERTY? ?VALUE? ?-global? |
| 368 | | - fossil unset PROPERTY ?-global? |
| 369 | | - |
| 370 | | -The "setting" command with no arguments lists all properties and their |
| 371 | | -values. With just a property name it shows the value of that property. |
| 372 | | -With a value argument it changes the property for the current repository. |
| 373 | | - |
| 374 | | -The "unset" command clears a property setting. |
| 375 | | - |
| 376 | | - autosync If enabled, automatically pull prior to |
| 377 | | - commit or update and automatically push |
| 378 | | - after commit or tag or branch creation. |
| 379 | | - |
| 380 | | - diff-command External command to run when performing a diff. |
| 381 | | - If undefined, the internal text diff will be used. |
| 382 | | - |
| 383 | | - editor Text editor command used for check-in comments. |
| 384 | | - |
| 385 | | - gdiff-command External command to run when performing a graphical |
| 386 | | - diff. If undefined, text diff will be used. |
| 387 | | - |
| 388 | | - localauth If enabled, require that HTTP connections from |
| 389 | | - 127.0.0.1 be authenticated by password. If |
| 390 | | - false, all HTTP requests from localhost have |
| 391 | | - unrestricted access to the repository. |
| 392 | | - |
| 393 | | - clearsign When enabled (the default), fossil will attempt to |
| 394 | | - sign all commits with gpg. When disabled, commits will |
| 395 | | - be unsigned. |
| 396 | | - |
| 397 | | - pgp-command Command used to clear-sign manifests at check-in. |
| 398 | | - The default is "gpg --clearsign -o ". |
| 399 | | - |
| 400 | | - proxy URL of the HTTP proxy. If undefined or "off" then |
| 401 | | - the "http_proxy" environment variable is consulted. |
| 402 | | - If the http_proxy environment variable is undefined |
| 403 | | - then a direct HTTP connection is used. |
| 404 | | - |
| 405 | | - web-browser A shell command used to launch your preferred |
| 406 | | - web browser when given a URL as an argument. |
| 407 | | - Defaults to "start" on windows, "open" on Mac, |
| 408 | | - and "firefox" on Unix. |
| 409 | | - |
| 410 | | - |
| 411 | | -Usage: </nowiki>[fossil status]<nowiki> |
| 412 | | - |
| 413 | | -Report on the status of the current checkout. |
| 414 | | - |
| 415 | | - |
| 416 | | -Usage: </nowiki>[fossil sync]<nowiki> ?URL? ?-R|--repository REPOSITORY? |
| 417 | | - |
| 418 | | -Synchronize the local repository with a remote repository. This is |
| 419 | | -the equivalent of running both "push" and "pull" at the same time. |
| 420 | | -See the "pull" command for additional information. |
| 421 | | - |
| 422 | | - |
| 423 | | -Usage: </nowiki>[fossil tag]<nowiki> SUBCOMMAND ... |
| 424 | | - |
| 425 | | -Run various subcommands to control tags and properties |
| 426 | | - |
| 427 | | - fossil tag add ?--raw? TAGNAME BASELINE ?VALUE? |
| 428 | | - |
| 429 | | - Add a new tag or property to BASELINE. The tag will |
| 430 | | - be usable instead of a BASELINE in commands such as |
| 431 | | - update and merge. |
| 432 | | - |
| 433 | | - fossil tag branch ?--raw? ?--nofork? TAGNAME BASELINE ?VALUE? |
| 434 | | - |
| 435 | | - A fork will be created so that the new checkin |
| 436 | | - is a sibling of BASELINE and identical to it except |
| 437 | | - for a generated comment. Then the new tag will |
| 438 | | - be added to the new checkin and propagated to |
| 439 | | - all direct children. Additionally all symbolic |
| 440 | | - tags of that checkin inherited from BASELINE will |
| 441 | | - be cancelled. |
| 442 | | - |
| 443 | | - However, if the option --nofork is given, no |
| 444 | | - fork will be created and the tag/property will be |
| 445 | | - added to BASELINE directly. No tags will be canceled. |
| 446 | | - |
| 447 | | - fossil tag cancel ?--raw? TAGNAME BASELINE |
| 448 | | - |
| 449 | | - Remove the tag TAGNAME from BASELINE, and also remove |
| 450 | | - the propagation of the tag to any descendants. |
| 451 | | - |
| 452 | | - fossil tag find ?--raw? TAGNAME |
| 453 | | - |
| 454 | | - List all baselines that use TAGNAME |
| 455 | | - |
| 456 | | - fossil tag list ?--raw? ?BASELINE? |
| 457 | | - |
| 458 | | - List all tags, or if BASELINE is supplied, list |
| 459 | | - all tags and their values for BASELINE. |
| 460 | | - |
| 461 | | -The option --raw allows the manipulation of all types of |
| 462 | | -tags used for various internal purposes in fossil. You |
| 463 | | -should not use this option to make changes unless you are |
| 464 | | -sure what you are doing. |
| 465 | | - |
| 466 | | -If you need to use a tagname that might be confused with |
| 467 | | -a hexadecimal baseline or artifact ID, you can explicitly |
| 468 | | -disambiguate it by prefixing it with "tag:". For instance: |
| 469 | | - |
| 470 | | - fossil update decaf |
| 471 | | - |
| 472 | | -will be taken as an artifact or baseline ID and fossil will |
| 473 | | -probably complain that no such revision was found. However |
| 474 | | - |
| 475 | | - fossil update tag:decaf |
| 476 | | - |
| 477 | | -will assume that "decaf" is a tag/branch name. |
| 478 | | - |
| 479 | | - |
| 480 | | -Usage: </nowiki>[fossil timeline]<nowiki> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N? |
| 481 | | - |
| 482 | | -Print a summary of activity going backwards in date and time |
| 483 | | -specified or from the current date and time if no arguments |
| 484 | | -are given. Show as many as N (default 20) check-ins. The |
| 485 | | -WHEN argument can be any unique abbreviation of one of these |
| 486 | | -keywords: |
| 487 | | - |
| 488 | | - before |
| 489 | | - after |
| 490 | | - descendants | children |
| 491 | | - ancestors | parents |
| 492 | | - |
| 493 | | -The BASELINE can be any unique prefix of 4 characters or more. |
| 494 | | -The DATETIME should be in the ISO8601 format. For |
| 495 | | -examples: "2007-08-18 07:21:21". You can also say "current" |
| 496 | | -for the current version or "now" for the current time. |
| 497 | | - |
| 498 | | - |
| 499 | | -Usage: </nowiki>[fossil undo]<nowiki> ?FILENAME...? |
| 500 | | - |
| 501 | | -Undo the most recent update or merge operation. If FILENAME is |
| 502 | | -specified then restore the content of the named file(s) but otherwise |
| 503 | | -leave the update or merge in effect. |
| 504 | | - |
| 505 | | -A single level of undo/redo is supported. The undo/redo stack |
| 506 | | -is cleared by the commit and checkout commands. |
| 507 | | - |
| 508 | | - |
| 509 | | -Usage: </nowiki>[fossil update]<nowiki> ?VERSION? ?--latest? |
| 510 | | - |
| 511 | | -The optional argument is a version that should become the current |
| 512 | | -version. If the argument is omitted, then use the leaf of the |
| 513 | | -tree that begins with the current version, if there is only a |
| 514 | | -single leaf. If there are a multiple leaves, the latest is used |
| 515 | | -if the --latest flag is present. |
| 516 | | - |
| 517 | | -This command is different from the "checkout" in that edits are |
| 518 | | -not overwritten. Edits are merged into the new version. |
| 519 | | - |
| 520 | | - |
| 521 | | -Usage: </nowiki>[fossil user]<nowiki> SUBCOMMAND ... ?-R|--repository FILE? |
| 522 | | - |
| 523 | | -Run various subcommands on users of the open repository or of |
| 524 | | -the repository identified by the -R or --repository option. |
| 525 | | - |
| 526 | | - fossil user capabilities USERNAME ?STRING? |
| 527 | | - |
| 528 | | - Query or set the capabilities for user USERNAME |
| 529 | | - |
| 530 | | - fossil user default ?USERNAME? |
| 531 | | - |
| 532 | | - Query or set the default user. The default user is the |
| 533 | | - user for command-line interaction. |
| 534 | | - |
| 535 | | - fossil user list |
| 536 | | - |
| 537 | | - List all users known to the repository |
| 538 | | - |
| 539 | | - fossil user new ?USERNAME? |
| 540 | | - |
| 541 | | - Create a new user in the repository. Users can never be |
| 542 | | - deleted. They can be denied all access but they must continue |
| 543 | | - to exist in the database. |
| 544 | | - |
| 545 | | - fossil user password USERNAME |
| 546 | | - |
| 547 | | - Change the web access password for a user. |
| 548 | | - |
| 549 | | - |
| 550 | | -Usage: </nowiki>[fossil version]<nowiki> |
| 551 | | - |
| 552 | | -Print the source code version number for the fossil executable. |
| 553 | | - |
| 554 | | - |
| 555 | | -Usage: </nowiki>[fossil wiki]<nowiki> (export|create|commit|list) WikiName |
| 556 | | - |
| 557 | | -Run various subcommands to fetch wiki entries. |
| 558 | | - |
| 559 | | - fossil wiki export PAGENAME ?FILE? |
| 560 | | - |
| 561 | | - Sends the latest version of the PAGENAME wiki |
| 562 | | - entry to the given file or standard output. |
| 563 | | - |
| 564 | | - fossil wiki commit PAGENAME ?FILE? |
| 565 | | - |
| 566 | | - Commit changes to a wiki page from FILE or from standard. |
| 567 | | - |
| 568 | | - fossil wiki create PAGENAME ?FILE? |
| 569 | | - |
| 570 | | - Create a new wiki page with initial content taken from |
| 571 | | - FILE or from standard input. |
| 572 | | - |
| 573 | | - fossil wiki list |
| 574 | | - |
| 575 | | - Lists all wiki entries, one per line, ordered |
| 576 | | - case-insentively by name. |
| 577 | | - |
| 578 | | -TODOs: |
| 579 | | - |
| 580 | | - fossil wiki export ?-u ARTIFACT? WikiName ?FILE? |
| 581 | | - |
| 582 | | - Outputs the selected version of WikiName. |
| 583 | | - |
| 584 | | - fossil wiki delete ?-m MESSAGE? WikiName |
| 585 | | - |
| 586 | | - The same as deleting a file entry, but i don't know if fossil |
| 587 | | - supports a commit message for Wiki entries. |
| 588 | | - |
| 589 | | - fossil wiki ?-u? ?-d? ?-s=[|]? list |
| 590 | | - |
| 591 | | - Lists the artifact ID and/or Date of last change along with |
| 592 | | - each entry name, delimited by the -s char. |
| 593 | | - |
| 594 | | - fossil wiki diff ?ARTIFACT? ?-f infile[=stdin]? EntryName |
| 595 | | - |
| 596 | | - Diffs the local copy of a page with a given version (defaulting |
| 597 | | - to the head version). |
| 598 | | - |
| 599 | | -</pre></nowiki> |
| 600 | | - |
| 601 | | -<hr> |
| 602 | | - |
| 603 | | -<h3>Caveats</h3> |
| 604 | | -This is not actually a reference, it's the start of a reference. |
| 605 | | -There are wikilinks to uncreated pages for the commands. This was |
| 606 | | -created by running the fossil help for each command listed by running |
| 607 | | -fossil help... Duplicate commands are only listed once (I |
| 608 | | -<i>think</i>). There are several bits of <b>fossil</b> that are not addressed |
| 609 | | -in the help for commands (special wiki directories, special users, etc.) |
| 610 | | -so they are (currently) not addressed here. Clarity and brevity may be |
| 611 | | -sacrificed for expediency at the authors indiscretion. All spelling and |
| 612 | | -grammatical mistakes are somebody elses fault.<code> void * </code> |
| 613 | | -prohibited where<code> __C_PLUS_PLUS__ </code>. Title and taxes extra. |
| 614 | | -Not valid in Hooptigonia. |
| 1 | + <h2>Command Line Interface Reference</h2> |
| 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. |
| 6 | + |
| 7 | + If you are trying to find information about fossil's web capabilities, |
| 8 | + see the <a href="doc/tip/www/index.wiki">Fossil Home</a> and |
| 9 | + <a href="doc/tip/www/wikitheory.wiki">Fossil Wiki</a> pages for pointers. |
| 10 | + |
| 11 | + <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 |
| 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—the 'clone' command—unambiguous. |
| 23 | + |
| 24 | + You should probably start interacting with fossil at the command line |
| 25 | + by asking it what it can do: |
| 26 | + |
| 27 | + <code>$ fossil help</code><nowiki><pre> |
| 28 | +Usage: fossil help COMMAND. |
| 29 | +Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; "> |
| 30 | + <tr> |
| 31 | + <td><a href="#add">add</a></td> |
| 32 | + <td><a href="#configure">configuration</a></td> |
| 33 | + <td><a href="#leaves">leaves</a></td> |
| 34 | + <td><a href="#redo">redo</a></td> |
| 35 | + <td><a href="#server">ui</a></td> |
| 36 | + </tr> |
| 37 | + <tr> |
| 38 | + <td><a href="#all">all</a></td> |
| 39 | + <td><a href="#deconstruct">deconstruct</a></td> |
| 40 | + <td><a href="#ls">ls</a></td> |
| 41 | + <td><a href="#mv">rename</a></td> |
| 42 | + <td><a href="#undo">undo</a></td> |
| 43 | + </tr> |
| 44 | + <tr> |
| 45 | + <td><a href="#cgi">cgi</a></td> |
| 46 | + <td><a href="#rm">del</a></td> |
| 47 | + <td><a href="#merge">merge</a></td> |
| 48 | + <td><a href="#revert">revert</a></td> |
| 49 | + <td><a href="#setting">unset</a></td> |
| 50 | + </tr> |
| 51 | + <tr> |
| 52 | + <td><a href="#changes">changes</a></td> |
| 53 | + <td><a href="#descendants">descendants</a></td> |
| 54 | + <td><a href="#mv">mv</a></td> |
| 55 | + <td><a href="#rm">rm</a></td> |
| 56 | + <td><a href="#update">update</a></td> |
| 57 | + </tr> |
| 58 | + <tr> |
| 59 | + <td><a href="#checkout">checkout</a></td> |
| 60 | + <td><a href="#diff">diff</a></td> |
| 61 | + <td><a href="#new">new</a></td> |
| 62 | + <td><a href="#server">server</a></td> |
| 63 | + <td><a href="#user">user</a></td> |
| 64 | + </tr> |
| 65 | + <tr> |
| 66 | + <td><a href="#commit">ci</a></td> |
| 67 | + <td><a href="#extra">extra</a></td> |
| 68 | + <td><a href="#open">open</a></td> |
| 69 | + <td><a href="#setting">settings</a></td> |
| 70 | + <td><a href="#version">version</a></td> |
| 71 | + </tr> |
| 72 | + <tr> |
| 73 | + <td><a href="#clean">clean</a></td> |
| 74 | + <td><a href="#diff">gdiff</a></td> |
| 75 | + <td><a href="#pull">pull</a></td> |
| 76 | + <td><a href="#status">status</a></td> |
| 77 | + <td><a href="#wiki">wiki</a></td> |
| 78 | + </tr> |
| 79 | + <tr> |
| 80 | + <td><a href="#clone">clone</a></td> |
| 81 | + <td><a href="#help">help</a></td> |
| 82 | + <td><a href="#push">push</a></td> |
| 83 | + <td><a href="#sync">sync</a></td> |
| 84 | + </tr> |
| 85 | + <tr> |
| 86 | + <td><a href="#close">close</a></td> |
| 87 | + <td><a href="#http">http</a></td> |
| 88 | + <td><a href="#rebuild">rebuild</a></td> |
| 89 | + <td><a href="#tag">tag</a></td> |
| 90 | + </tr> |
| 91 | + <tr> |
| 92 | + <td><a href="#commit">commit</a></td> |
| 93 | + <td><a href="#info">info</a></td> |
| 94 | + <td><a href="#reconstruct">reconstruct</a></td> |
| 95 | + <td><a href="#timeline">timeline</a></td> |
| 96 | + </tr> |
| 97 | + </table><nowiki><pre> |
| 98 | +This is fossil version [c66ffba6da] 2008-11-10 19:54:53 UTC |
| 99 | + </pre></nowiki> |
| 100 | + <b>What follows</b> is a survey of what you get if you type<code> |
| 101 | + fossil help <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 | + <nowiki><pre> |
| 106 | + |
| 107 | + <a name="add">Usage:</a><code><a href="doc/tip/www/cmd_add.wiki">fossil add</a></code> FILE... |
| 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="doc/tip/www/cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync) |
| 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 | + |
| 120 | + list Display the location of all repositories |
| 121 | + |
| 122 | + pull Run a "pull" operation on all repositories |
| 123 | + |
| 124 | + push Run a "push" on all repositories |
| 125 | + |
| 126 | + rebuild Rebuild on all repositories |
| 127 | + |
| 128 | + sync Run a "sync" on all repositories |
| 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="doc/tip/www/cmd_cgi">fossil cgi</a> SCRIPT |
| 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: |
| 142 | + |
| 143 | + #!/usr/bin/fossil |
| 144 | + repository: /home/somebody/project.db |
| 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="doc/tip/www/cmd_changes">fossil changes</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? |
| 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="doc/tip/www/cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...? |
| 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="doc/tip/www/cmd_clean.wiki">fossil clean</a> ?-all? |
| 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="doc/tip/www/cmd_clone.wiki">fossil clone</a> URL FILENAME |
| 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="doc/tip/www/cmd_close.wiki">fossil close</a> ?-f|--force? |
| 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="doc/tip/www/cmd_configure.wiki">fossil configure</a> METHOD ... |
| 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 | + |
| 209 | + Write to FILENAME exported configuraton information for AREA. |
| 210 | + AREA can be one of: all ticket skin project |
| 211 | + |
| 212 | + fossil configuration import FILENAME |
| 213 | + |
| 214 | + Read a configuration from FILENAME, overwriting the current |
| 215 | + configuration. |
| 216 | + |
| 217 | + fossil configuration merge FILENAME |
| 218 | + |
| 219 | + Read a configuration from FILENAME and merge its values into |
| 220 | + the current configuration. Existing values take priority over |
| 221 | + values read from FILENAME. |
| 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. |
| 234 | + |
| 235 | + fossil configuration reset AREA |
| 236 | + |
| 237 | + Restore the configuration to the default. AREA as above. |
| 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="doc/tip/www/cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION |
| 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="doc/tip/www/cmd_rm.wiki">fossil rm</a> FILE... |
| 254 | + or: fossil del FILE... |
| 255 | + Remove one or more files from the tree. |
| 256 | + |
| 257 | + |
| 258 | + <a name="descendants">Usage:</a><a href="doc/tip/www/cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID? |
| 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="doc/tip/www/cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE... |
| 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 |
| 271 | + is not yet configured, the internal textual diff command will be |
| 272 | + used. |
| 273 | + |
| 274 | + If -i is supplied for either diff or gdiff, the internal textual |
| 275 | + diff command will be executed. |
| 276 | + |
| 277 | + Here are a few external diff command settings, for example: |
| 278 | + |
| 279 | + fossil setting diff-command diff |
| 280 | + |
| 281 | + fossil setting gdiff-command tkdiff |
| 282 | + fossil setting gdiff-command eskill22 |
| 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="doc/tip/www/cmd_extra.wiki">fossil extra</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="doc/tip/www/cmd_help.wiki">fossil help</a> COMMAND |
| 296 | + |
| 297 | + Display information on how to use COMMAND |
| 298 | + |
| 299 | + |
| 300 | + <a name="http">Usage:</a><a href="doc/tip/www/cmd_http.wiki">fossil http</a> REPOSITORY |
| 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="doc/tip/www/cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME? |
| 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="doc/tip/www/cmd_leaves.wiki">fossil leaves</a> |
| 318 | + |
| 319 | + Find leaves of all branches. |
| 320 | + |
| 321 | + |
| 322 | + <a name="ls">Usage:</a><a href="doc/tip/www/cmd_ls.wiki">fossil ls</a> |
| 323 | + |
| 324 | + Show the names of all files in the current checkout |
| 325 | + |
| 326 | + |
| 327 | + <a name="merge">Usage:</a><a href="doc/tip/www/cmd_merge.wiki">fossil merge</a> VERSION |
| 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="doc/tip/www/cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME |
| 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="doc/tip/www/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="doc/tip/www/cmd_open.wiki">fossil open</a> FILENAME |
| 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="doc/tip/www/cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY? |
| 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 |
| 367 | + "pull", "push", or "sync" command is used. |
| 368 | + |
| 369 | + The URL is of the following form: |
| 370 | + |
| 371 | + http://USER@HOST:PORT/PATH |
| 372 | + |
| 373 | + The "USER@" and ":PORT" substrings are optional. |
| 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="doc/tip/www/cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY? |
| 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="doc/tip/www/cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY |
| 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="doc/tip/www/cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN |
| 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="doc/tip/www/cmd_redo.wiki">fossil redo</a> ?FILENAME...? |
| 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="doc/tip/www/cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE |
| 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="doc/tip/www/cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY? |
| 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 | + 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="doc/tip/www/cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? |
| 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 | + |
| 440 | + The "unset" command clears a property setting. |
| 441 | + |
| 442 | + autosync If enabled, automatically pull prior to |
| 443 | + commit or update and automatically push |
| 444 | + after commit or tag or branch creation. |
| 445 | + |
| 446 | + diff-command External command to run when performing a diff. |
| 447 | + If undefined, the internal text diff will be used. |
| 448 | + |
| 449 | + editor Text editor command used for check-in comments. |
| 450 | + |
| 451 | + gdiff-command External command to run when performing a graphical |
| 452 | + diff. If undefined, text diff will be used. |
| 453 | + |
| 454 | + localauth If enabled, require that HTTP connections from |
| 455 | + 127.0.0.1 be authenticated by password. If |
| 456 | + false, all HTTP requests from localhost have |
| 457 | + unrestricted access to the repository. |
| 458 | + |
| 459 | + clearsign When enabled (the default), fossil will attempt to |
| 460 | + sign all commits with gpg. When disabled, commits will |
| 461 | + be unsigned. |
| 462 | + |
| 463 | + pgp-command Command used to clear-sign manifests at check-in. |
| 464 | + The default is "gpg --clearsign -o ". |
| 465 | + |
| 466 | + proxy URL of the HTTP proxy. If undefined or "off" then |
| 467 | + the "http_proxy" environment variable is consulted. |
| 468 | + If the http_proxy environment variable is undefined |
| 469 | + then a direct HTTP connection is used. |
| 470 | + |
| 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="doc/tip/www/cmd_status.wiki">fossil status</a> |
| 478 | + |
| 479 | + Report on the status of the current checkout. |
| 480 | + |
| 481 | + |
| 482 | + <a name="sync">Usage:</a><a href="doc/tip/www/cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY? |
| 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="doc/tip/www/cmd_tag.wiki">fossil tag</a> SUBCOMMAND ... |
| 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 |
| 496 | + be usable instead of a BASELINE in commands such as |
| 497 | + update and merge. |
| 498 | + |
| 499 | + fossil tag branch ?--raw? ?--nofork? TAGNAME BASELINE ?VALUE? |
| 500 | + |
| 501 | + A fork will be created so that the new checkin |
| 502 | + is a sibling of BASELINE and identical to it except |
| 503 | + for a generated comment. Then the new tag will |
| 504 | + be added to the new checkin and propagated to |
| 505 | + all direct children. Additionally all symbolic |
| 506 | + tags of that checkin inherited from BASELINE will |
| 507 | + be cancelled. |
| 508 | + |
| 509 | + However, if the option --nofork is given, no |
| 510 | + fork will be created and the tag/property will be |
| 511 | + added to BASELINE directly. No tags will be canceled. |
| 512 | + |
| 513 | + fossil tag cancel ?--raw? TAGNAME BASELINE |
| 514 | + |
| 515 | + Remove the tag TAGNAME from BASELINE, and also remove |
| 516 | + the propagation of the tag to any descendants. |
| 517 | + |
| 518 | + fossil tag find ?--raw? TAGNAME |
| 519 | + |
| 520 | + List all baselines that use TAGNAME |
| 521 | + |
| 522 | + fossil tag list ?--raw? ?BASELINE? |
| 523 | + |
| 524 | + List all tags, or if BASELINE is supplied, list |
| 525 | + all tags and their values for BASELINE. |
| 526 | + |
| 527 | + The option --raw allows the manipulation of all types of |
| 528 | + tags used for various internal purposes in fossil. You |
| 529 | + should not use this option to make changes unless you are |
| 530 | + sure what you are doing. |
| 531 | + |
| 532 | + If you need to use a tagname that might be confused with |
| 533 | + a hexadecimal baseline or artifact ID, you can explicitly |
| 534 | + disambiguate it by prefixing it with "tag:". For instance: |
| 535 | + |
| 536 | + fossil update decaf |
| 537 | + |
| 538 | + will be taken as an artifact or baseline ID and fossil will |
| 539 | + probably complain that no such revision was found. However |
| 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="doc/tip/www/cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N? |
| 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: |
| 553 | + |
| 554 | + before |
| 555 | + after |
| 556 | + descendants | children |
| 557 | + ancestors | parents |
| 558 | + |
| 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="doc/tip/www/cmd_undo.wiki">fossil undo</a> ?FILENAME...? |
| 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="doc/tip/www/cmd_update.wiki">fossil update</a> ?VERSION? ?--latest? |
| 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="doc/tip/www/cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE? |
| 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 | + |
| 594 | + Query or set the capabilities for user USERNAME |
| 595 | + |
| 596 | + fossil user default ?USERNAME? |
| 597 | + |
| 598 | + Query or set the default user. The default user is the |
| 599 | + user for command-line interaction. |
| 600 | + |
| 601 | + fossil user list |
| 602 | + |
| 603 | + List all users known to the repository |
| 604 | + |
| 605 | + fossil user new ?USERNAME? |
| 606 | + |
| 607 | + Create a new user in the repository. Users can never be |
| 608 | + deleted. They can be denied all access but they must continue |
| 609 | + to exist in the database. |
| 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="doc/tip/www/cmd_version.wiki">fossil version</a> |
| 617 | + |
| 618 | + Print the source code version number for the fossil executable. |
| 619 | + |
| 620 | + |
| 621 | + <a name="wiki">Usage:</a><a href="doc/tip/www/cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName |
| 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 |
| 628 | + entry to the given file or standard output. |
| 629 | + |
| 630 | + fossil wiki commit PAGENAME ?FILE? |
| 631 | + |
| 632 | + Commit changes to a wiki page from FILE or from standard. |
| 633 | + |
| 634 | + fossil wiki create PAGENAME ?FILE? |
| 635 | + |
| 636 | + Create a new wiki page with initial content taken from |
| 637 | + FILE or from standard input. |
| 638 | + |
| 639 | + fossil wiki list |
| 640 | + |
| 641 | + Lists all wiki entries, one per line, ordered |
| 642 | + case-insentively by name. |
| 643 | + |
| 644 | + TODOs: |
| 645 | + |
| 646 | + fossil wiki export ?-u ARTIFACT? WikiName ?FILE? |
| 647 | + |
| 648 | + Outputs the selected version of WikiName. |
| 649 | + |
| 650 | + fossil wiki delete ?-m MESSAGE? WikiName |
| 651 | + |
| 652 | + The same as deleting a file entry, but i don't know if fossil |
| 653 | + supports a commit message for Wiki entries. |
| 654 | + |
| 655 | + fossil wiki ?-u? ?-d? ?-s=[|]? list |
| 656 | + |
| 657 | + Lists the artifact ID and/or Date of last change along with |
| 658 | + each entry name, delimited by the -s char. |
| 659 | + |
| 660 | + fossil wiki diff ?ARTIFACT? ?-f infile[=stdin]? EntryName |
| 661 | + |
| 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 |
| 673 | + fossil help... Duplicate commands are only listed once (I |
| 674 | + <i>think</i>). There are several bits of <b>fossil</b> that are not addressed |
| 675 | + in the help for commands (special wiki directories, special users, etc.) |
| 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. |
| 615 | 681 | |