Changeset 481 for branches/confman-1.9/confman.8.in

Timestamp:

11/11/2009 14:09:39 (3 years ago)

Author:

ccowart

Message:

Merging improved recipe creation and editing from trunk.

Resolves #83, #84

Location:

branches/confman-1.9

Files:

• . (modified) (1 prop)
• confman.8.in (modified) (5 diffs)

branches/confman-1.9/confman.8.in

@@ -36 +36 @@
 .Op Fl v | Cm version
 .Nm
-.Ar command Oo Ar command_opts Oc Op Ar command_args
+.Oo Ar flags Oc Ar command Oo Ar command_opts Oc Op Ar command_args
 .Sh DESCRIPTION
 The
@@ -96 +96 @@
 operations can bring the system up-to-date.
 .El
-.\" TODO
+.Ss FLAGS
+.Bl -tag -width "FLAGS "
+.It Global flags
+The following flags can be specified before the commands:
+.Bl -tag -width indent
+.It Fl h Op Ar command 
+Synonymous to the
+.Ar help
+command below.
+.It Fl v
+Causes
+.Nm
+to print the version string and exit.
+.El
+.It Log flags
+The following flags can be used where
+.Ar log_flags
+appears in the usage statements (See
+.Sx COMMANDS ) :
+.Bl -tag -width indent
+.It Fl m Ar message
+The string in the
+.Ar message
+argument will be used instead of prompting the user for a log message for
+.Cm commit
+and
+.Cm install
+operations.
+.It Fl F Ar filename
+Like
+.Fl m ,
+except the log's contents are read from
+.Ar filename
+instead of the command line.
+.El
+.El
 .Ss COMMANDS
 The following commands are supported by 
@@ -125 +160 @@
 that will cause the latest repository revision to be reflected in your working
 copy.  command does not alter the repository or the system.
-.It Cm commit
+.It Cm commit Oo log_flags Oc
 The commit command causes your changes to take effect. 
 .Bl -bullet
@@ -171 +206 @@
 working copy of
 .Ar module .
-.It Cm install Ar
+.It Cm install Oo Ar log_flags Oc Ar
 Roll out the specified working files and directories to the live filesystem.
 Note that recipe ordering will be respected, so using install in a low-priority
 module will still cause the highest priority module's copy of the file to
 ultimately be installed.
-.It Cm status [ Ar working_copy ]
+.It Cm status Oo Ar working_copy Oc
 Look at the status entries for the file or directory specified by 
 .Ar working_copy .
@@ -183 +218 @@
 .It Cm recipe 
 .Brq Cm get | list
-.It Cm recipe 
-.Brq Cm create | edit | print | remove | set 
-.Ar recipe 
+.It Cm recipe create Oo Fl R Ar filename Oc Oo Ar log_flags Oc Ar recipe
+.It Cm recipe print Ar recipe
+.It Cm recipe Bro Cm edit | remove Brc Oo Ar log_flags Oc Ar recipe 
+.It Cm recipe set Ar recipe
 .Bl -tag -width indent
 .It Cm create
 Create a recipe named 
-.Ar recipe
+.Ar recipe. 
+Use -R to specify a file with the recipe's contents to bypass interactive 
+mode.
 .It Cm edit
 Open