Expanded documentation of command-line arguments for the puppet executables.

git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1686 980ebf18-57e1-0310-9a29-db15c13687c0

1 files changed, 60 insertions, 1 deletions

diff --git a/bin/puppetdoc b/bin/puppetdoc
index 8185ed773..2c7b1879b 100755
--- a/bin/puppetdoc
+++ b/bin/puppetdoc
@@ -148,7 +148,66 @@ it is most likely an option that is valid for everyone.
 
 This will not always be the case.  I have tried to be as thorough as possible
 in the descriptions of the arguments, so it should be obvious whether an
-argument is approprite or not.
+argument is appropriate or not.
+
+These arguments can be supplied to the executables either as command-line 
+arugments or in the configuration file for the appropriate executable.  For 
+instance, the command-line invocation below would set the configuration directory
+to /private/puppet
+  
+  $ puppetd --confdir=/private/puppet
+  
+Note that boolean options are turned on and off with a slightly different syntax
+on the command line:
+
+  $ puppetd --storeconfigs
+  
+  $ puppetd --no-storeconfigs
+
+The invocations above will enable and disable, respectively, the storage of 
+the client configuration.
+
+As mentioned above, the configuration parameters can also be stored in a 
+configuration file located in the configuration directory (`/etc/puppet` 
+by default).  The file is named for the executable it is intended for, for
+example `/etc/puppetd.conf` is the configuration file for `puppetd`.
+
+The file, which follows INI-style formatting, should contain a bracketed
+heading named for the executable, followed by pairs of parameters with their
+values.  Here is an example of a very simple `puppetd.conf` file:
+
+  [puppetd]
+    confdir = /private/puppet
+    storeconfigs = true
+    
+Note that boolean parameters must be explicitly specified as `true` or
+`false` as seen above.
+
+If you're starting out with a fresh configuration, you may wish to let
+the executable generate a template configuration file for you by invoking
+the executable in question with the `--genconfig` command.  The executable
+will print a template configuration to standard output, which can be
+redirected to a file like so:
+
+  $ puppetd --genconfig > /etc/puppet/puppetd.conf
+  
+Note that this invocation will "clobber" (throw away) the contents of any
+pre-existing `puppetd.conf` file, so make a backup of your present config
+if it contains valuable information.
+  
+Like the `--genconfig` argument, the executables also accept a `--genmanifest`
+argument, which will generate a manifest that can be used to manage all of 
+Puppet's directories and files and prints it to standard output.  This can
+likewise be redirected to a file:
+
+  $ puppetd --genmanifest > /etc/puppet/manifests/site.pp
+
+Puppet can also create user and group accounts for itself (one `puppet` group
+and one `puppet` user) if it is invoked as `root` with the `--mkusers` argument:
+
+  $ puppetd --mkusers
+  
+
 
 Any default values are in ``block type`` at the end of the description.