Overview
| SHA1 Hash: | 9436bb75c3c61d2a36fe82d188278aa8c630ecb0 |
|---|---|
| Date: | 2008-11-15 04:08:26 |
| User: | kejoki |
| Comment: | Updated the main page, added add... |
| 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_.wiki-template version [575b5c55cd]
@@ -1,1 +1,22 @@ +<h2>foo</h2> + +The <code>foo</code> command is informational, it doesn't do anything to +a checked-out project, but it tells you something about it. + +The <code>foo</code> command <<allows you | helps> to> | <ensures that> bar. + +The flibenglookners that the foo command <operates on> | <displays> bar. + +Typing <code>fossil foo</cod> will gonkulate any flibenglookners, but baz. + +What we going to exemplify. + +Example. + +Raison d'etre. + +Compare <code>foo</code> to this here other <code>thingy</code>. +See also: <a href="cmd_bar.wiki">fossil bar</a>, +<a href="cmd_baz.wiki">fossil baz</a>, +<a href="reference.wiki">Reference</a>
Added www/cmd_add.wiki version [90059388b2]
@@ -1,1 +1,42 @@ +<h2>add</h2> + +The often used <code>add</code> command is how you tell <b>fossil</b> to +include a (usually new) file in the repository. + +<b>fossil</b> is designed to manage artifacts whose role is being +"source" for something, most probably software program code or other +text. One can imagine all kinds of ways to let fossil know just what +constitutes a source; the simplest and most direct way it +<i>actually</i> finds out is when you give it the +<code> fossil add <i>file</i> </code> command. + +It's reasonable to think of +the <a href="cmd_import.wiki"><code>import</code></a> +and <a href="cmd_clone.wiki"><code>clone</code></a> +commands as very high-powered versions of the <code>add</code> +command that are combined with system level file movement and +networking functions. Not particularly accurate, but reasonable. + +Typing <code>fossil add myfile</code> causes fossil to put +<i>myfile</i> into the repository at the next +<code>commit</code>—provided you issue it from within the source +tree, of course. + +Note that the repository is <u>not</u> changed by the <code>add</code> +command, but by the <code>commit</code> command. <code>add</code> +<i>myfile</i> tells <b>fossil</b> to "mark" <i>myfile</i> as part of +the repository. Only commands which actually manipulate the content +of the "source" artifacts can physically put the file into (or remove +it from) the repository. + +Just to keep things confused, there are also commands that can +manipulate the repository without affecting the checked-out sources +(see <a href="cmd_pull.wiki">fossil pull</a>, for instance.) +See also: <a href="cmd_rm.wiki">fossil rm</a>, +<a href="cmd_import.wiki">fossil import</a>, +<a href="cmd_clone.wiki">fossil clone</a>, +<a href="cmd_commit.wiki">fossil commit</a>, +<a href="cmd_pull.wiki">fossil pull</a>, +<a href="cmd_settings.wiki">fossil setting</a> (async), +<a href="reference.wiki">Reference</a>
Modified www/index.wiki from [ce68f6c37b] to [7528157689].
@@ -70,10 +70,12 @@
<li>Fossil contains a <a href="wikitheory.wiki">built-in wiki</a>.</li>
<li>There is a
<a href="http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users">
mailing list</a> available for discussing fossil issues.</li>
<li><a href="qandc.wiki">Questions & Criticisms</a> directed at fossil.</li>
+<li>Some (unfinished but expanding) extended
+ <a href="reference.wiki">reference documentation</a> for the fossil command line.
</ul>
<p>Developer Links: </p>
<ul>
Modified www/reference.wiki from [d732d8e38a] to [de3ee24bea].
@@ -94,25 +94,25 @@
<td><a href="#reconstruct">reconstruct</a></td>
<td><a href="#timeline">timeline</a></td>
</tr>
</table><nowiki><pre>
This is fossil version [c66ffba6da] 2008-11-10 19:54:53 UTC
- </pre></nowiki>
- <b>What follows</b> is a survey of what you get if you type<code>
- fossil help <i>command</i> </code>for all of the
- 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.
- <nowiki><pre>
-
- <a name="add">Usage:</a><code><a href="cmd_add.wiki">fossil add</a></code> FILE...
-
- 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)
+</pre>
+<b>What follows</b> is a survey of what you get if you type<code>
+fossil help <i>command</i> </code>for all of the
+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...
+
+ 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)
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
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>
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?
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...?
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?
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
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?
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 ...
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
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...
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?
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...
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,82 +284,82 @@
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>
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
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
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?
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>
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>
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
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
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
record the fact that filenames have changed so that appropriate notations
can be made at the next commit/checkin.
- <a name="new">Usage:</a><a href="cmd_new.wiki">fossil new</a> FILENAME
+ <a name="new">Usage: </a><a href="cmd_new.wiki">fossil new</a> FILENAME
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
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?
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?
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
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
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...?
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
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?
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?
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>
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?
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 ...
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?
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...?
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?
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?
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>
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
Run various subcommands to fetch wiki entries.
fossil wiki export PAGENAME ?FILE?