puppet 0.25.1 → 0.25.2

data/man/man8/puppetca.8

@@ -1,7 +1,6 @@
 .TH   "" "" ""
 .SH NAME
- \-
-
+ \- 
 .\" Man page generated from reStructeredText.
 
 .SH SYNOPSIS
@@ -10,16 +9,18 @@ but mostly meant for signing certificate requests from puppet clients.
 
 
 .SH USAGE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
 
 .TP
 .B puppetca [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose]
 [\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke]
 [\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [host]
 
-
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
+.UNINDENT
 
 .SH DESCRIPTION
 Because the puppetmasterd daemon defaults to not signing client
@@ -35,11 +36,12 @@ configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
 argument.
 
 See the configuration file documentation at
-http://reductivelabs.com/projects/puppet/reference/configref.html for
+\fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for
 the full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppetca with
 \'\-\-genconfig\'.
 
+.INDENT 0.0
 
 .TP
 .B all:      Operate on all items. Currently only makes sense with
@@ -55,24 +57,31 @@ certificate of the host remains valid. If \'\-\-all\' is specified
 then all host certificates, both signed and unsigned, will be
 removed.
 
+.UNINDENT
 debug:    Enable full debugging.
 
+.INDENT 0.0
 
 .TP
 .B generate: Generate a certificate for a named client. A
 certificate/keypair will be generated for each client named on
 the command line.
 
+.UNINDENT
 help:     Print this help message
 
+.INDENT 0.0
 
 .TP
 .B list:     List outstanding certificate requests. If \'\-\-all\' is
 specified, signed certificates are also listed, prefixed by
-\'+\'.
+\'+\', and revoked or invalid certificates are prefixed by \'\-\'
+(the verification outcome is printed in parenthesis).
 
+.UNINDENT
 print:    Print the full\-text version of a host\'s certificate.
 
+.INDENT 0.0
 
 .TP
 .B revoke:   Revoke the certificate of a client. The certificate can be
@@ -88,6 +97,7 @@ after revoking certificates.
 .B sign:     Sign an outstanding certificate request. Unless \'\-\-all\' is
 specified, hosts must be listed after all flags.
 
+.UNINDENT
 verbose:  Enable verbosity.
 
 version:  Print the puppet version number and exit.
@@ -96,14 +106,14 @@ verify:   Verify the named certificate against the local CA certificate.
 
 
 .SH EXAMPLE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
 $ puppetca \-l
 culain.madstop.com
 $ puppetca \-s culain.madstop.com
 
-
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
 
 .SH AUTHOR
 Luke Kanies
@@ -114,5 +124,5 @@ Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
 License
 
 
-.\" Generated by docutils manpage writer on 2008-05-05 09:33.
-.\"
+.\" Generated by docutils manpage writer on 2009-12-30 19:31.
+.\" 

data/man/man8/puppetd.8

@@ -1,7 +1,6 @@
 .TH Synopsis  "" "" ""
 .SH NAME
-Synopsis \-
-
+Synopsis \- 
 .\" Man page generated from reStructeredText.
 Retrieve the client configuration from the central puppet server and
 apply it to the local host.
@@ -10,17 +9,19 @@ Currently must be run out periodically, using cron or something similar.
 
 
 .SH USAGE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
 
 .TP
 .B puppetd  [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-disable] [\-\-enable]
 [\-h|\-\-help] [\-\-fqdn <host name>] [\-l|\-\-logdest syslog|<file>|console]
-[\-o|\-\-onetime] [\-\-serve <handler>] [\-t|\-\-test]
+[\-o|\-\-onetime] [\-\-serve <handler>] [\-t|\-\-test] [\-\-noop]
 [\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert <seconds>]
 
-
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
+.UNINDENT
 
 .SH DESCRIPTION
 This is the main puppet client. Its job is to retrieve the local
@@ -68,8 +69,8 @@ configuration parameter, so you can specify \'\-\-server <servername>\' as
 an argument.
 
 See the configuration file documentation at
-http://reductivelabs.com/projects/puppet/reference/configref.html for
-the full list of acceptable parameters. A commented list of all
+\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
+full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppetd with
 \'\-\-genconfig\'.
 
@@ -79,6 +80,7 @@ no\-daemonize: Do not send the process into the background.
 
 debug:        Enable full debugging.
 
+.INDENT 0.0
 
 .TP
 .B disable:      Disable working on the local system. This puts a lock file
@@ -88,11 +90,13 @@ testing a configuration and do not want the central
 configuration to override the local state until everything
 is tested and committed.
 
+.UNINDENT
 +puppetd+ uses the same lock file while it is running, so no more than
 one +puppetd+ process is working at a time.
 
 +puppetd+ exits after executing this.
 
+.INDENT 0.0
 
 .TP
 .B enable:       Enable working on the local system. This removes any lock
@@ -100,8 +104,10 @@ file, causing +puppetd+ to start managing the local system
 again (although it will continue to use its normal
 scheduling, so it might not start for another half hour).
 
+.UNINDENT
 +puppetd+ exits after executing this.
 
+.INDENT 0.0
 
 .TP
 .B fqdn:         Set the fully\-qualified domain name of the client. This is
@@ -109,8 +115,10 @@ only used for certificate purposes, but can be used to
 override the discovered hostname. If you need to use this
 flag, it is generally an indication of a setup problem.
 
+.UNINDENT
 help:         Print this help message
 
+.INDENT 0.0
 
 .TP
 .B logdest:      Where to send messages. Choose between syslog, the
@@ -145,13 +153,21 @@ exactly, both in the call to +serve+ and in
 
 .TP
 .B test:         Enable the most common options used for testing. These are
-+onetime+, +verbose+, +ignorecache, and
++onetime+, +verbose+, +ignorecache, +no\-daemonize+, and
 +no\-usecacheonfailure+.
 
+
+.TP
+.B noop:         Use +noop+ mode where the daemon runs in a no\-op or
+dry\-run mode. This is useful for seeing what changes
+Puppet will make without actually executing the changes.
+
+.UNINDENT
 verbose:      Turn on verbose reporting.
 
 version:      Print the puppet version number and exit.
 
+.INDENT 0.0
 
 .TP
 .B waitforcert:  This option only matters for daemons that do not yet have
@@ -162,14 +178,15 @@ request. This is useful for the initial setup of a puppet
 client. You can turn off waiting for certificates by
 specifying a time of 0.
 
+.UNINDENT
 
 .SH EXAMPLE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
 puppetd \-\-server puppet.domain.com
 
-
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
 
 .SH AUTHOR
 Luke Kanies
@@ -180,5 +197,5 @@ Copyright (c) 2005, 2006 Reductive Labs, LLC Licensed under the GNU
 Public License
 
 
-.\" Generated by docutils manpage writer on 2008-05-05 09:33.
-.\"
+.\" Generated by docutils manpage writer on 2009-12-30 19:31.
+.\" 

data/man/man8/puppetdoc.8

@@ -1,7 +1,6 @@
 .TH   "" "" ""
 .SH NAME
- \-
-
+ \- 
 .\" Man page generated from reStructeredText.
 
 .SH SYNOPSIS
@@ -10,44 +9,98 @@ Reductive Labs use.
 
 
 .SH USAGE
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
 
-.\" visit_block_quote
-puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-m|\-\-mode <text|pdf|trac> [\-r|\-\-reference <[type]|configuration|..>]
-
+.TP
+.B puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>]
+[\-r|\-\-reference <[type]|configuration|..>] [manifest\-file]
 
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
+.UNINDENT
 
 .SH DESCRIPTION
-This command generates a restructured\-text document describing all
-installed Puppet types or all allowable arguments to puppet executables.
-It is largely meant for internal use and is used to generate the
-reference document available on the Reductive Labs web site.
+If mode is not \'rdoc\', then this command generates a restructured\-text
+document describing all installed Puppet types or all allowable
+arguments to puppet executables. It is largely meant for internal use
+and is used to generate the reference document available on the
+Reductive Labs web site.
+
+In \'rdoc\' mode, this command generates an html RDoc hierarchy describing
+the manifests that are in \'manifestdir\' and \'modulepath\' configuration
+directives. The generated documentation directory is doc by default but
+can be changed with the \'outputdir\' option.
+
+If the command is started with \'manifest\-file\' command\-line arguments,
+puppetdoc generate a single manifest documentation that is output on
+stdout.
 
 
 .SH OPTIONS
-all:       Output the docs for all of the reference types.
+.INDENT 0.0
+
+.TP
+.B all:       Output the docs for all of the reference types. In \'rdoc\'
+modes, this also outputs documentation for all resources
 
+.UNINDENT
 help:      Print this help message
 
+.INDENT 0.0
+
+.TP
+.B outputdir: Specifies the directory where to output the rdoc
+documentation in \'rdoc\' mode.
+
 
 .TP
 .B mode:      Determine the output mode. Valid modes are \'text\', \'trac\',
-and \'pdf\'. Note that \'trac\' mode only works on Reductive Labs
-servers. The default mode is \'text\'.
+\'pdf\', \'markdown\' and \'rdoc\'. The \'pdf\' and \'markdown\' modes
+create PDF or Markdown formatted files in the /tmp directory.
+Note that \'trac\' mode only works on Reductive Labs servers.
+The default mode is \'text\'. In \'rdoc\' mode you must provide
+\'manifests\-path\'
 
 
 .TP
 .B reference: Build a particular reference. Get a list of references by
 running +puppetdoc \-\-list+.
 
+.UNINDENT
 
 .SH EXAMPLE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
 $ puppetdoc \-r type > /tmp/type_reference.rst
 
+.UNINDENT
+.UNINDENT
+or
+
+.INDENT 0.0
+.INDENT 3.5
+$ puppetdoc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
+
+.UNINDENT
+.UNINDENT
+or
+
+.INDENT 0.0
+.INDENT 3.5
+$ puppetdoc /etc/puppet/manifests/site.pp
+
+.UNINDENT
+.UNINDENT
+or
+
+.INDENT 0.0
+.INDENT 3.5
+$ puppetdoc \-m markdown \-r configuration
 
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
 
 .SH AUTHOR
 Luke Kanies
@@ -58,5 +111,5 @@ Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
 Public License
 
 
-.\" Generated by docutils manpage writer on 2008-05-05 09:33.
-.\"
+.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" 

data/man/man8/puppetmasterd.8

@@ -1,7 +1,6 @@
 .TH   "" "" ""
 .SH NAME
- \-
-
+ \- 
 .\" Man page generated from reStructeredText.
 
 .SH SYNOPSIS
@@ -10,16 +9,17 @@ default.
 
 
 .SH USAGE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
 
 .TP
 .B puppetmasterd [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help]
-[\-l|\-\-logdest <file>|console|syslog] [\-\-nobucket] [\-\-nonodes]
-[\-v|\-\-verbose] [\-V|\-\-version]
-
+[\-l|\-\-logdest <file>|console|syslog] [\-v|\-\-verbose] [\-V|\-\-version]
 
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
+.UNINDENT
 
 .SH DESCRIPTION
 This is the puppet central daemon.
@@ -32,8 +32,8 @@ configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
 argument.
 
 See the configuration file documentation at
-http://reductivelabs.com/projects/puppet/reference/configref.html for
-the full list of acceptable parameters. A commented list of all
+\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
+full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppetmasterdd
 with \'\-\-genconfig\'.
 
@@ -45,6 +45,7 @@ debug:        Enable full debugging.
 
 help:         Print this help message.
 
+.INDENT 0.0
 
 .TP
 .B logdest:      Where to send messages. Choose between syslog, the
@@ -52,27 +53,19 @@ console, and a log file. Defaults to sending messages to
 syslog, or the console if debugging or verbosity is
 enabled.
 
-nobucket:     Do not function as a file bucket.
-
-
-.TP
-.B nonodes:      Do not use individual node designations; each node will
-receive the result of evaluating the entire configuration.
-
-noreports:    Do not start the reports server.
-
+.UNINDENT
 verbose:      Enable verbosity.
 
 version:      Print the puppet version number and exit.
 
 
 .SH EXAMPLE
-
-.\" visit_block_quote
+.INDENT 0.0
+.INDENT 3.5
 puppetmasterd
 
-
-.\" depart_block_quote
+.UNINDENT
+.UNINDENT
 
 .SH AUTHOR
 Luke Kanies
@@ -83,5 +76,5 @@ Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
 License
 
 
-.\" Generated by docutils manpage writer on 2008-05-05 09:33.
-.\"
+.\" Generated by docutils manpage writer on 2009-12-30 19:31.
+.\"