[Zope3-checkins] CVS: Zope3/src/zope/fssync - zsync.txt:1.10

[Fred L. Drake, Jr.]

Update of /cvs-repository/Zope3/src/zope/fssync
In directory cvs.zope.org:/tmp/cvs-serv32643

Modified Files:
	zsync.txt 
Log Message:
- add documentation on the help command
- relabel the remove command to match the preference for delete in
  Subversion
- update the supported command aliases


=== Zope3/src/zope/fssync/zsync.txt 1.9 => 1.10 ===
--- Zope3/src/zope/fssync/zsync.txt:1.9	Mon Aug 11 18:02:09 2003
+++ Zope3/src/zope/fssync/zsync.txt	Fri Aug 15 18:34:55 2003
@@ -25,6 +25,9 @@
 performed.  The following commands are supported; names given in
 parentheses are aliases supported for convenience:
 
+**help** (h, ?)
+  Display help text on **zsync** and individual commands.
+
 **checkin** (ci)
   Add the target material to the object database.
 
@@ -41,7 +44,7 @@
 **update** (up)
   Retrieve updates from the object database.
 
-**diff**
+**diff** (di)
   Report differences between the local representation and the data
   from which the modified copy was generated.  This command can be run
   *offline* (without any network access), so is useful when working
@@ -57,7 +60,7 @@
   additions are not made to the object database itself until the next
   **zsync commit**.
 
-**remove** (rm)
+**delete** (del remove rm)
   Mark an object for removal from the object database.  The change is
   not made to the object database itself until the next **zsync
   commit**.
@@ -204,6 +207,21 @@
   reporting a list of paths for which conflicts are detected.
 
 
+The **zsync delete** Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Synopsis
+++++++++
+
+**delete** *path* ...
+
+Description
++++++++++++
+
+The **delete** command has no specific options.  It requires at least
+one *path* argument.
+
+
 The **zsync diff** Command
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -255,36 +273,37 @@
   **patch** typically needs at least two lines of context.
 
 
-The **zsync mkdir** Command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The **zsync help** Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Synopsis
 ++++++++
 
-**mkdir** *path* ...
+**help** [*command* ...]
 
 Description
 +++++++++++
 
-Create one or more directories and schedule them for addition.  The
-additions are not made to the object database itself until the next
-**zsync commit**.  Reverting these additions with **zsync revert**
-will not cause the directories themselves to be removed.
+When used with specifying *command*, this displays general help on
+using **zsync**.  When *command* is given, information about each
+command list is presented.
 
 
-The **zsync remove** Command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The **zsync mkdir** Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Synopsis
 ++++++++
 
-**remove** *path* ...
+**mkdir** *path* ...
 
 Description
 +++++++++++
 
-The **remove** command has no specific options.  It requires at least
-one *path* argument.
+Create one or more directories and schedule them for addition.  The
+additions are not made to the object database itself until the next
+**zsync commit**.  Reverting these additions with **zsync revert**
+will not cause the directories themselves to be removed.
 
 
 The **zsync resolve** Command