Overview
| SHA1 Hash: | 44b3fc6b5b35597a9461359a1a369386d9ce2320 |
|---|---|
| Date: | 2008-11-17 02:07:14 |
| User: | kejoki |
| Comment: | reference docs -- added 'all', minor edits to others. |
| Timelines: | ancestors | descendants | both | trunk |
| Other Links: | files | ZIP archive | manifest |
Tags And Properties
- branch=trunk inherited from [a28c83647d]
- sym-trunk inherited from [a28c83647d]
Changes
[hide diffs]Added www/cmd_all.wiki version [7f2e021118]
@@ -1,1 +1,59 @@ +<h2>all</h2> + +The <code>all</code> command will let you perform (some) commands on +<em>all</em> of your repositories, and provides a way of finding all +of your repositories as well. + +There are some commands you might especially want to perform on every +repository you've got, once in a while. <code> fossil all +</code> includes four of the most likely as sub-commands: +<code><a href="cmd_pull.wiki">pull</a></code>, +<code><a href="cmd_push.wiki">push</a></code>, +<code><a href="cmd_rebuild.wiki">rebuild</a></code> and +<code><a href="cmd_sync.wiki">sync</a></code>. + +Follow the links to find out what each of those do, and then a moment +of thought will tell you why you might want to have them available for +all repositories. + +Certainly you'll want your repositories all rebuilt when you upgrade +<b>fossil</b> after there has been a change in the repository +structure. For the others, it depends. Usually you would want +across-the-board versions if you've been "off Net" for a while, and +have commits to multiple repositories than you need to share, or want +to get the repository changes that have been made by others, or both. + +The last sub-command provided by <code>all</code> is "<code>list</code>." + +While the other sub-commands give you a way to conveniently take care +of all of your repositories for some common tasks, the +<code>list</code> provides a way to take care of any subset of your +repositories in any way you want. It provides a list of all of your +repositories' locations. <code>fossil all list</code> +outputs a one-per-line listing of the path for each of your +repositories. With that in hand, you can easily script just about any +repository manipulations you want. + +Or, you could just jog your memory. + +The <code>all</code> command uses the <i>.fossil</i> file in the home +directory to find all of your repositories, so you can mess it up by +moving your repositories around. This is easy to do inadvertently if +you have a cavalier attitude about repos, but you'll know pretty +quickly that you've done it—many commands you try to use from +inside of a checkout won't work correctly. The <i>.fossil</i> file is +an <b>sqlite</b> db file which fossil uses to keeping track of +repository locations. Advice: if you move your repositories around, +let fossil know you did; +<code><a href="cmd_close.wiki">close</a></code> them before you move +them, and then <code><a href="cmd_open.wiki">open</a></code> them from +their new locations. +See also: <a href="cmd_pull.wiki">fossil pull</a>, +<a href="cmd_push.wiki">fossil push</a>, +<a href="cmd_rebuild.wiki">fossil rebuild</a>, +<a href="cmd_sync.wiki">fossil sync</a>, +<a href="cmd_open.wiki">fossil open</a>, +<a href="cmd_close.wiki">fossil close</a>, +<a href="reference.wiki">Reference</a>, +<b><a href="http://www.sqlite.org">sqlite</a></b>
Modified www/cmd_extra.wiki from [064fbbac2e] to [2878d79760].
@@ -6,25 +6,33 @@ Extra files are files that exist in a checked-out project, but don't belong to the repository. The <code>fossil extra</code> command will get you a list of these files. -This is convenient for figuring out if you've <code>add</code>ed every file -that needs to be in the repository before you do a commit. It will also -tell you what will be removed if you <code>clean</code> the project. +This is convenient for figuring out if you've <code> +<a href="cmd_add.wiki">add</a></code>ed every file that needs to be + +in the repository before you do a commit. It will also tell you what +will be removed if you <code><a href="cmd_clean.wiki">clean</a></code> +the project. -Suppose, for example, you have a "noodle.src" file as a scratch pad for source -code, and you don't want to include your latest hare-brained ideas in the -repository? You don't <code>add</code> it to the repository, of course—though -there are ways you might add it unintentionally. If your project is big, and you want to -find noodle.src, and anything else that isn't under source control within the project -directories, then<code> fossil extra </code> will give you a list. +Suppose, for example, you have a "noodle.src" file as a scratch pad +for source code, and you don't want to include your latest +hare-brained ideas in the repository? You don't <code>add</code> it +to the repository, of course—though there are ways you might add +it unintentionally. If your project is big, and you want to find +noodle.src, and anything else that isn't under source control within +the project directories, then<code> fossil extra </code> will +give you a list. If you don't think this is all that useful, then you've never had to write a shell script that only affects project files and leaves everything else alone. ;) The <code>extra</code> command is almost, but not quite entirely, the exact -opposite of the <a href="cmd_ls.wiki><code>ls</code></a> command. +opposite of the <code><a href="cmd_ls.wiki">ls</a></code> command. -See also: <a href="cmd_clean.wiki">fossil clean</a>, <a href="cmd_ls.wiki">fossil ls</a>, <a href="reference.wiki"> -Reference</a> +See also: <a href="cmd_status.wiki">fossil status</a>, +<a href="cmd_ls.wiki">fossil ls</a>, +<a href="cmd_changes.wiki">fossil changes</a>, +<a href="cmd_clean.wiki">fossil clean</a>, +<a href="reference.wiki">Reference</a>
Modified www/reference.wiki from [de3ee24bea] to [28024751b1].
@@ -20,11 +20,11 @@
entered to make the intent unambiguous. 'clo' is a proper prefix of
both the 'clone' and 'close' commands, for instance, but 'clon' is
enough to make the intent—the 'clone' command—unambiguous.
You should probably start interacting with fossil at the command line
- by asking it what it can do:
+ by asking it what it can do: <a name="tof">ᵻ</a>
<code>$ fossil help</code><nowiki><pre>
Usage: fossil help COMMAND.
Available COMMANDs:</pre><table width="80%" style="font-family: fixed, courier, monospace; ">
<tr>
@@ -102,17 +102,17 @@
commands listed above. There are links to individual pages for each
of them; pages with content (not all of them are done) go into the command
in a bit more depth than the program help.
<pre>
- <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE...
+ <a name="add">Usage: </a><code><a href="cmd_add.wiki">fossil add</a></code> FILE... <a href="#tof">ᵻ</a>
Make arrangements to add one or more files to the current checkout
at the next commit.
- <a name="all">Usage: </a><code><a href="cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync)
+ <a name="all">Usage: </a><code><a href="cmd_all.wiki">fossil all</a></code> (list|pull|push|rebuild|sync) <a href="#tof">ᵻ</a>
The ~/.fossil file records the location of all repositories for a
user. This command performs certain operations on all repositories
that can be useful before or after a period of disconnection operation.
Available operations are:
@@ -130,11 +130,11 @@
Respositories are automatically added to the set of known repositories
when one of the following commands against the repository: clone, info,
pull, push, or sync
- <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT
+ <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT <a href="#tof">ᵻ</a>
The SCRIPT argument is the name of a file that is the CGI script
that is being run. The command name, "cgi", may be omitted if
the GATEWAY_INTERFACE environment variable is set to "CGI" (which
should always be the case for CGI scripts run by a webserver.) The
@@ -146,26 +146,26 @@
The second line defines the name of the repository. After locating
the repository, fossil will generate a webpage on stdout based on
the values of standard CGI environment variables.
- <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a>
+ <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a> <a href="#tof">ᵻ</a>
Report on the edit status of all files in the current checkout.
See also the "status" and "extra" commands.
- <a name="checkout">Usage: </a><a href="checkout">fossil checkout</a> VERSION ?-f|--force?
+ <a name="checkout">Usage: </a><a href="checkout">fossil checkout</a> VERSION ?-f|--force? <a href="#tof">ᵻ</a>
Check out a version specified on the command-line. This command
will not overwrite edited files in the current checkout unless
the --force option appears on the command-line.
See also the "update" command.
- <a name="commit">Usage: </a><a href="cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...?
+ <a name="commit">Usage: </a><a href="cmd_commit.wiki">fossil commit</a> ?-m COMMENT? ?--nosign? ?FILE...? <a href="#tof">ᵻ</a>
fossil ci ... (as above)
Create a new version containing all of the changes in the current
checkout. You will be prompted to enter a check-in comment unless
the "-m" option is used to specify a comment line. You will be
@@ -173,11 +173,11 @@
unless the "--nosign" options is used. All files that have
changed will be committed unless some subset of files is specified
on the command line.
- <a name="clean">Usage: </a><a href="cmd_clean.wiki">fossil clean</a> ?-all?
+ <a name="clean">Usage: </a><a href="cmd_clean.wiki">fossil clean</a> ?-all? <a href="#tof">ᵻ</a>
Delete all "extra" files in the source tree. "Extra" files are
files that are not officially part of the checkout. See also
the "extra" command. This operation cannot be undone.
@@ -184,24 +184,24 @@
You will be prompted before removing each file. If you are
sure you wish to remove all "extra" files you can specify the
optional -all flag.
- <a name="clone">Usage: </a><a href="cmd_clone.wiki">fossil clone</a> URL FILENAME
+ <a name="clone">Usage: </a><a href="cmd_clone.wiki">fossil clone</a> URL FILENAME <a href="#tof">ᵻ</a>
Make a clone of a repository specified by URL in the local
file named FILENAME.
- <a name="close">Usage: </a><a href="cmd_close.wiki">fossil close</a> ?-f|--force?
+ <a name="close">Usage: </a><a href="cmd_close.wiki">fossil close</a> ?-f|--force? <a href="#tof">ᵻ</a>
The opposite of "open". Close the current database connection.
Require a -f or --force flag if there are unsaved changed in the
current check-out.
- <a name="configure">Usage: </a><a href="cmd_configure.wiki">fossil configure</a> METHOD ...
+ <a name="configure">Usage: </a><a href="cmd_configure.wiki">fossil configure</a> METHOD ... <a href="#tof">ᵻ</a>
Where METHOD is one of: export import merge pull push reset. All methods
accept the -R or --repository option to specific a repository.
fossil configuration export AREA FILENAME
@@ -240,30 +240,30 @@
source. The inbound configuration is not checked for safety and can
introduce security vulnerabilities.
COMMAND: deconstruct
- <a name="deconstruct">Usage: </a><a href="cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION
+ <a name="deconstruct">Usage: </a><a href="cmd_deconstruct.wiki">fossil deconstruct</a> ?-R|--repository REPOSITORY? DESTINATION <a href="#tof">ᵻ</a>
Populates the indicated DESTINATION directory with copies of all
artifcats contained within the repository. Artifacts are named AA/bbbbb
where AA is the first 2 characters of the artifact ID and bbbbb is the
remaining 38 characters.
- <a name="rm">Usage: </a><a href="cmd_rm.wiki">fossil rm</a> FILE...
+ <a name="rm">Usage: </a><a href="cmd_rm.wiki">fossil rm</a> FILE... <a href="#tof">ᵻ</a>
or: fossil del FILE...
Remove one or more files from the tree.
- <a name="descendants">Usage: </a><a href="cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID?
+ <a name="descendants">Usage: </a><a href="cmd_descendants.wiki">fossil descendants</a> ?BASELINE-ID? <a href="#tof">ᵻ</a>
Find all leaf descendants of the baseline specified or if the argument
is omitted, of the baseline currently checked out.
- <a name="diff">Usage: </a><a href="cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE...
+ <a name="diff">Usage: </a><a href="cmd_diff.wiki">fossil diff</a>|gdiff ?-i? ?-r REVISION? FILE... <a href="#tof">ᵻ</a>
Show the difference between the current version of a file (as it
exists on disk) and that same file as it was checked out.
diff will show a textual diff while gdiff will attempt to run a
@@ -284,59 +284,59 @@
fossil setting gdiff-command meld
fossil setting gdiff-command xxdiff
fossil setting gdiff-command kdiff3
- <a name="extra">Usage: </a><a href="cmd_extra.wiki">fossil extra</a>
+ <a name="extra">Usage: </a><a href="cmd_extra.wiki">fossil extra</a> <a href="#tof">ᵻ</a>
Print a list of all files in the source tree that are not part of
the current checkout. See also the "clean" command.
- <a name="help">Usage: </a><a href="cmd_help.wiki">fossil help</a> COMMAND
+ <a name="help">Usage: </a><a href="cmd_help.wiki">fossil help</a> COMMAND <a href="#tof">ᵻ</a>
Display information on how to use COMMAND
- <a name="http">Usage: </a><a href="cmd_http.wiki">fossil http</a> REPOSITORY
+ <a name="http">Usage: </a><a href="cmd_http.wiki">fossil http</a> REPOSITORY <a href="#tof">ᵻ</a>
Handle a single HTTP request appearing on stdin. The resulting webpage
is delivered on stdout. This method is used to launch an HTTP request
handler from inetd, for example. The argument is the name of the
repository.
- <a name="info">Usage: </a><a href="cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME?
+ <a name="info">Usage: </a><a href="cmd_info.wiki">fossil info</a> ?ARTIFACT-ID|FILENAME? <a href="#tof">ᵻ</a>
With no arguments, provide information about the current tree.
If an argument is specified, provide information about the object
in the respository of the current tree that the argument refers
to. Or if the argument is the name of a repository, show
information about that repository.
- <a name="leaves">Usage: </a><a href="cmd_leaves.wiki">fossil leaves</a>
+ <a name="leaves">Usage: </a><a href="cmd_leaves.wiki">fossil leaves</a> <a href="#tof">ᵻ</a>
Find leaves of all branches.
- <a name="ls">Usage: </a><a href="cmd_ls.wiki">fossil ls</a>
+ <a name="ls">Usage: </a><a href="cmd_ls.wiki">fossil ls</a> <a href="#tof">ᵻ</a>
Show the names of all files in the current checkout
- <a name="merge">Usage: </a><a href="cmd_merge.wiki">fossil merge</a> VERSION
+ <a name="merge">Usage: </a><a href="cmd_merge.wiki">fossil merge</a> VERSION <a href="#tof">ᵻ</a>
The argument is a version that should be merged into the current
checkout.
Only file content is merged. The result continues to use the
file and directory names from the current check-out even if those
names might have been changed in the branch being merged in.
- <a name="mv">Usage: </a><a href="cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME
+ <a name="mv">Usage: </a><a href="cmd_mv.wiki">fossil mv|rename</a> OLDNAME NEWNAME <a href="#tof">ᵻ</a>
or: fossil mv|rename OLDNAME... DIR
Move or rename one or more files within the tree
This command does not rename the files on disk. All this command does is
@@ -348,18 +348,18 @@
Create a repository for a new project in the file named FILENAME.
This command is distinct from "clone". The "clone" command makes
a copy of an existing project. This command starts a new project.
- <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME
+ <a name="open">Usage: </a><a href="cmd_open.wiki">fossil open</a> FILENAME <a href="#tof">ᵻ</a>
Open a connection to the local repository in FILENAME. A checkout
for the repository is created with its root at the working directory.
See also the "close" command.
- <a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY?
+ <a name="pull">Usage: </a><a href="cmd_pull.wiki">fossil pull</a> ?URL? ?-R|--respository REPOSITORY? <a href="#tof">ᵻ</a>
Pull changes in a remote repository into the local repository.
The repository is identified by the -R or --repository option.
If there is no such option then the open repository is used.
The URL of the remote server is specified on the command line
@@ -375,30 +375,30 @@
prompted for the password on the command-line. The PORT
specifies the TCP port of the server. The default port is
80.
- <a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY?
+ <a name="push">Usage: </a><a href="cmd_push.wiki">fossil push</a> ?URL? ?-R|--repository REPOSITORY? <a href="#tof">ᵻ</a>
Push changes in the local repository over into a remote repository.
See the "pull" command for additional information.
- <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY
+ <a name="rebuild">Usage: </a><a href="cmd_rebuild.wiki">fossil rebuild</a> REPOSITORY <a href="#tof">ᵻ</a>
Reconstruct the named repository database from the core
records. Run this command after updating the fossil
executable in a way that changes the database schema.
COMMAND: reconstruct
- <a name="reconstruct">Usage: </a><a href="cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN
+ <a name="reconstruct">Usage: </a><a href="cmd_reconstruct.wiki">fossil reconstruct</a> REPOSITORY ORIGIN <a href="#tof">ᵻ</a>
Creates the REPOSITORY and populates it with the artifacts in the
indicated ORIGIN directory.
- <a name="redo">Usage: </a><a href="cmd_redo.wiki">fossil redo</a> ?FILENAME...?
+ <a name="redo">Usage: </a><a href="cmd_redo.wiki">fossil redo</a> ?FILENAME...? <a href="#tof">ᵻ</a>
Redo the an update or merge operation that has been undone by the
undo command. If FILENAME is specified then restore the changes
associated with the named file(s) but otherwise leave the update
or merge undone.
@@ -405,19 +405,19 @@
A single level of undo/redo is supported. The undo/redo stack
is cleared by the commit and checkout commands.
- <a name="revert">Usage: </a><a href="cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE
+ <a name="revert">Usage: </a><a href="cmd_revert.wiki">fossil revert</a> ?--yes? ?-r REVISION? FILE <a href="#tof">ᵻ</a>
Revert to the current repository version of FILE, or to
the version associated with baseline REVISION if the -r flag
appears. This command will confirm your operation unless the
file is missing or the --yes option is used.
- <a name="server">Usage: </a><a href="cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY?
+ <a name="server">Usage: </a><a href="cmd_server.wiki">fossil server</a> ?-P|--port TCPPORT? ?REPOSITORY? <a href="#tof">ᵻ</a>
Or: fossil ui ?-P|--port TCPPORT? ?REPOSITORY?
Open a socket and begin listening and responding to HTTP requests on
TCP port 8080, or on any other TCP port defined by the -P or
--port option. The optional argument is the name of the repository.
@@ -428,11 +428,11 @@
the web server.
COMMAND: settings
COMMAND: unset
- <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global?
+ <a name="setting">Usage: </a><a href="cmd_setting.wiki">fossil setting</a> ?PROPERTY? ?VALUE? ?-global? <a href="#tof">ᵻ</a>
fossil unset PROPERTY ?-global?
The "setting" command with no arguments lists all properties and their
values. With just a property name it shows the value of that property.
With a value argument it changes the property for the current repository.
@@ -472,23 +472,23 @@
web browser when given a URL as an argument.
Defaults to "start" on windows, "open" on Mac,
and "firefox" on Unix.
- <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a>
+ <a name="status">Usage: </a><a href="cmd_status.wiki">fossil status</a> <a href="#tof">ᵻ</a>
Report on the status of the current checkout.
- <a name="sync">Usage: </a><a href="cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY?
+ <a name="sync">Usage: </a><a href="cmd_sync.wiki">fossil sync</a> ?URL? ?-R|--repository REPOSITORY? <a href="#tof">ᵻ</a>
Synchronize the local repository with a remote repository. This is
the equivalent of running both "push" and "pull" at the same time.
See the "pull" command for additional information.
- <a name="tag">Usage: </a><a href="cmd_tag.wiki">fossil tag</a> SUBCOMMAND ...
+ <a name="tag">Usage: </a><a href="cmd_tag.wiki">fossil tag</a> SUBCOMMAND ... <a href="#tof">ᵻ</a>
Run various subcommands to control tags and properties
fossil tag add ?--raw? TAGNAME BASELINE ?VALUE?
@@ -541,11 +541,11 @@
fossil update tag:decaf
will assume that "decaf" is a tag/branch name.
- <a name="timeline">Usage: </a><a href="cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N?
+ <a name="timeline">Usage: </a><a href="cmd_timeline.wiki">fossil timeline</a> ?WHEN? ?BASELINE|DATETIME? ?-n|--count N? <a href="#tof">ᵻ</a>
Print a summary of activity going backwards in date and time
specified or from the current date and time if no arguments
are given. Show as many as N (default 20) check-ins. The
WHEN argument can be any unique abbreviation of one of these
@@ -560,21 +560,21 @@
The DATETIME should be in the ISO8601 format. For
examples: "2007-08-18 07:21:21". You can also say "current"
for the current version or "now" for the current time.
- <a name="undo">Usage: </a><a href="cmd_undo.wiki">fossil undo</a> ?FILENAME...?
+ <a name="undo">Usage: </a><a href="cmd_undo.wiki">fossil undo</a> ?FILENAME...? <a href="#tof">ᵻ</a>
Undo the most recent update or merge operation. If FILENAME is
specified then restore the content of the named file(s) but otherwise
leave the update or merge in effect.
A single level of undo/redo is supported. The undo/redo stack
is cleared by the commit and checkout commands.
- <a name="update">Usage: </a><a href="cmd_update.wiki">fossil update</a> ?VERSION? ?--latest?
+ <a name="update">Usage: </a><a href="cmd_update.wiki">fossil update</a> ?VERSION? ?--latest? <a href="#tof">ᵻ</a>
The optional argument is a version that should become the current
version. If the argument is omitted, then use the leaf of the
tree that begins with the current version, if there is only a
single leaf. If there are a multiple leaves, the latest is used
@@ -582,11 +582,11 @@
This command is different from the "checkout" in that edits are
not overwritten. Edits are merged into the new version.
- <a name="user">Usage: </a><a href="cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE?
+ <a name="user">Usage: </a><a href="cmd_user.wiki">fossil user</a> SUBCOMMAND ... ?-R|--repository FILE? <a href="#tof">ᵻ</a>
Run various subcommands on users of the open repository or of
the repository identified by the -R or --repository option.
fossil user capabilities USERNAME ?STRING?
@@ -611,16 +611,16 @@
fossil user password USERNAME
Change the web access password for a user.
- <a name="version">Usage: </a><a href="cmd_version.wiki">fossil version</a>
+ <a name="version">Usage: </a><a href="cmd_version.wiki">fossil version</a> <a href="#tof">ᵻ</a>
Print the source code version number for the fossil executable.
- <a name="wiki">Usage: </a><a href="cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName
+ <a name="wiki">Usage: </a><a href="cmd_wiki.wiki">fossil wiki</a> (export|create|commit|list) WikiName <a href="#tof">ᵻ</a>
Run various subcommands to fetch wiki entries.
fossil wiki export PAGENAME ?FILE?
@@ -676,5 +676,6 @@
so they are (currently) not addressed here. Clarity and brevity may be
sacrificed for expediency at the authors indiscretion. All spelling and
grammatical mistakes are somebody elses fault.<code> void * </code>
prohibited where<code> __C_PLUS_PLUS__ </code>. Title and taxes extra.
Not valid in Hooptigonia.
+<a href="#tof">ᵻ</a>