puppet 0.25.4 → 0.25.5

data/man/man8/puppetd.8

@@ -1,55 +1,53 @@
-.TH Synopsis  "" "" ""
+.TH SYNOPSIS  "" "" ""
 .SH NAME
 Synopsis \- 
 .\" Man page generated from reStructeredText.
+.
+.sp
 Retrieve the client configuration from the central puppet server and
 apply it to the local host.
-
+.sp
 Currently must be run out periodically, using cron or something similar.
-
-
 .SH USAGE
 .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] [\-\-noop]
 [\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert <seconds>]
-
 .UNINDENT
 .UNINDENT
 .UNINDENT
-
 .SH DESCRIPTION
+.sp
 This is the main puppet client. Its job is to retrieve the local
-machine\'s configuration from a remote server and apply it. In order to
+machine\(aqs configuration from a remote server and apply it. In order to
 successfully communicate with the remote server, the client must have a
 certificate signed by a certificate authority that the server trusts;
 the recommended method for this, at the moment, is to run a certificate
 authority as part of the puppet server (which is the default). The
 client will connect and request a signed certificate, and will continue
 connecting until it receives one.
-
+.sp
 Once the client has a signed certificate, it will retrieve its
 configuration and apply it.
-
-
 .SH USAGE NOTES
+.sp
 +puppetd+ does its best to find a compromise between interactive use and
 daemon use. Run with no arguments and no configuration, it will go into
 the backgroun, attempt to get a signed certificate, and retrieve and
 apply its configuration every 30 minutes.
-
+.sp
 Some flags are meant specifically for interactive use \-\- in particular,
 +test+ and +tags+ are useful. +test+ enables verbose logging, causes the
-daemon to stay in the foreground, exits if the server\'s configuration is
-invalid (this happens if, for instance, you\'ve left a syntax error on
+daemon to stay in the foreground, exits if the server\(aqs configuration is
+invalid (this happens if, for instance, you\(aqve left a syntax error on
 the server), and exits after running the configuration once (rather than
 hanging around as a long\-running process).
-
+.sp
 +tags+ allows you to specify what portions of a configuration you want
 to apply. Puppet elements are tagged with all of the class or definition
 names that contain them, and you can use the +tags+ flag to specify one
@@ -60,87 +58,80 @@ manage +ntpd+, you would put all of the new elements into an +ntpd+
 class, and call puppet with +\-\-tags ntpd+, which would only apply that
 small portion of the configuration during your testing, rather than
 applying the whole thing.
-
-
 .SH OPTIONS
-Note that any configuration parameter that\'s valid in the configuration
-file is also a valid long argument. For example, \'server\' is a valid
-configuration parameter, so you can specify \'\-\-server <servername>\' as
+.sp
+Note that any configuration parameter that\(aqs valid in the configuration
+file is also a valid long argument. For example, \(aqserver\(aq is a valid
+configuration parameter, so you can specify \(aq\-\-server <servername>\(aq as
 an argument.
-
+.sp
 See the configuration file documentation at
-\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
+\fI\%http://puppetlabs.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\'.
-
+\(aq\-\-genconfig\(aq.
+.sp
 daemonize:    Send the process into the background. This is the default.
-
+.sp
 no\-daemonize: Do not send the process into the background.
-
+.sp
 debug:        Enable full debugging.
-
 .INDENT 0.0
-
 .TP
 .B disable:      Disable working on the local system. This puts a lock file
+.
 in place, causing +puppetd+ not to work on the system
 until the lock file is removed. This is useful if you are
 testing a configuration and do not want the central
 configuration to override the local state until everything
 is tested and committed.
-
 .UNINDENT
+.sp
 +puppetd+ uses the same lock file while it is running, so no more than
 one +puppetd+ process is working at a time.
-
+.sp
 +puppetd+ exits after executing this.
-
 .INDENT 0.0
-
 .TP
 .B enable:       Enable working on the local system. This removes any lock
+.
 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
+.sp
 +puppetd+ exits after executing this.
-
 .INDENT 0.0
-
 .TP
 .B fqdn:         Set the fully\-qualified domain name of the client. This is
+.
 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
+.sp
 help:         Print this help message
-
 .INDENT 0.0
-
 .TP
 .B logdest:      Where to send messages. Choose between syslog, the
+.
 console, and a log file. Defaults to sending messages to
 syslog, or the console if debugging or verbosity is
 enabled.
-
-
 .TP
 .B no\-client:    Do not create a config client. This will cause the daemon
+.
 to run without ever checking for its configuration
 automatically, and only makes sense when used in
 conjunction with \-\-listen.
-
-
 .TP
-.B onetime:      Run the configuration once, rather than as a long\-running
-daemon. This is useful for interactively running puppetd.
-
-
+.B onetime:      Run the configuration once. Runs a single daemonized
+.
+Puppet run. Useful for interactively running puppetd and
+hence used in conjunction with the \-\-no\-daemonize option.
 .TP
 .B serve:        Start another type of server. By default, +puppetd+ will
+.
 start a service handler that allows authenticated and
 authorized remote nodes to trigger the configuration to be
 pulled down and applied. You can specify any handler here
@@ -149,53 +140,46 @@ or resource. The handlers are in
 +lib/puppet/network/handler+, and the names must match
 exactly, both in the call to +serve+ and in
 +namespaceauth.conf+.
-
-
 .TP
 .B test:         Enable the most common options used for testing. These are
+.
 +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
+.sp
 verbose:      Turn on verbose reporting.
-
+.sp
 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
+.
 certificates and it is enabled by default, with a value of
 120 (seconds). This causes +puppetd+ to connect to the
 server every 2 minutes and ask it to sign a certificate
 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
 .INDENT 0.0
 .INDENT 3.5
+.sp
 puppetd \-\-server puppet.domain.com
-
 .UNINDENT
 .UNINDENT
-
 .SH AUTHOR
+.sp
 Luke Kanies
-
-
 .SH COPYRIGHT
-Copyright (c) 2005, 2006 Reductive Labs, LLC Licensed under the GNU
+.sp
+Copyright (c) 2005, 2006 Puppet Labs, LLC Licensed under the GNU
 Public License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:31.
+.\" Generated by docutils manpage writer.
 .\" 
+.

data/man/man8/puppetdoc.8

@@ -2,114 +2,103 @@
 .SH NAME
  \- 
 .\" Man page generated from reStructeredText.
-
+.
 .SH SYNOPSIS
+.sp
 Generate a reference for all Puppet types. Largely meant for internal
-Reductive Labs use.
-
-
+Puppet Labs use.
 .SH USAGE
 .INDENT 0.0
 .INDENT 3.5
 .INDENT 0.0
-
 .TP
 .B puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>]
+.
 [\-r|\-\-reference <[type]|configuration|..>] [manifest\-file]
-
 .UNINDENT
 .UNINDENT
 .UNINDENT
-
 .SH DESCRIPTION
-If mode is not \'rdoc\', then this command generates a restructured\-text
+.sp
+If mode is not \(aqrdoc\(aq, 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
+Puppet Labs web site.
+.sp
+In \(aqrdoc\(aq mode, this command generates an html RDoc hierarchy describing
+the manifests that are in \(aqmanifestdir\(aq and \(aqmodulepath\(aq 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,
+can be changed with the \(aqoutputdir\(aq option.
+.sp
+If the command is started with \(aqmanifest\-file\(aq command\-line arguments,
 puppetdoc generate a single manifest documentation that is output on
 stdout.
-
-
 .SH OPTIONS
 .INDENT 0.0
-
 .TP
-.B all:       Output the docs for all of the reference types. In \'rdoc\'
+.B all:       Output the docs for all of the reference types. In \(aqrdoc\(aq
+.
 modes, this also outputs documentation for all resources
-
 .UNINDENT
+.sp
 help:      Print this help message
-
 .INDENT 0.0
-
 .TP
 .B outputdir: Specifies the directory where to output the rdoc
-documentation in \'rdoc\' mode.
-
-
+.
+documentation in \(aqrdoc\(aq mode.
 .TP
-.B mode:      Determine the output mode. Valid modes are \'text\', \'trac\',
-\'pdf\', \'markdown\' and \'rdoc\'. The \'pdf\' and \'markdown\' modes
+.B mode:      Determine the output mode. Valid modes are \(aqtext\(aq, \(aqtrac\(aq,
+.
+\(aqpdf\(aq, \(aqmarkdown\(aq and \(aqrdoc\(aq. The \(aqpdf\(aq and \(aqmarkdown\(aq 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\'
-
-
+Note that \(aqtrac\(aq mode only works on Puppet Labs servers.
+The default mode is \(aqtext\(aq. In \(aqrdoc\(aq mode you must provide
+\(aqmanifests\-path\(aq
 .TP
 .B reference: Build a particular reference. Get a list of references by
+.
 running +puppetdoc \-\-list+.
-
 .UNINDENT
-
 .SH EXAMPLE
 .INDENT 0.0
 .INDENT 3.5
+.sp
 $ puppetdoc \-r type > /tmp/type_reference.rst
-
 .UNINDENT
 .UNINDENT
+.sp
 or
-
 .INDENT 0.0
 .INDENT 3.5
+.sp
 $ puppetdoc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
-
 .UNINDENT
 .UNINDENT
+.sp
 or
-
 .INDENT 0.0
 .INDENT 3.5
+.sp
 $ puppetdoc /etc/puppet/manifests/site.pp
-
 .UNINDENT
 .UNINDENT
+.sp
 or
-
 .INDENT 0.0
 .INDENT 3.5
+.sp
 $ puppetdoc \-m markdown \-r configuration
-
 .UNINDENT
 .UNINDENT
-
 .SH AUTHOR
+.sp
 Luke Kanies
-
-
 .SH COPYRIGHT
-Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
+.sp
+Copyright (c) 2005\-2007 Puppet Labs, LLC Licensed under the GNU
 Public License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" Generated by docutils manpage writer.
 .\" 
+.

data/man/man8/puppetmasterd.8

@@ -2,79 +2,71 @@
 .SH NAME
  \- 
 .\" Man page generated from reStructeredText.
-
+.
 .SH SYNOPSIS
+.sp
 The central puppet server. Functions as a certificate authority by
 default.
-
-
 .SH USAGE
 .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] [\-v|\-\-verbose] [\-V|\-\-version]
-
 .UNINDENT
 .UNINDENT
 .UNINDENT
-
 .SH DESCRIPTION
+.sp
 This is the puppet central daemon.
-
-
 .SH OPTIONS
-Note that any configuration parameter that\'s valid in the configuration
-file is also a valid long argument. For example, \'ssldir\' is a valid
-configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
+.sp
+Note that any configuration parameter that\(aqs valid in the configuration
+file is also a valid long argument. For example, \(aqssldir\(aq is a valid
+configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an
 argument.
-
+.sp
 See the configuration file documentation at
-\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
+\fI\%http://puppetlabs.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\'.
-
+with \(aq\-\-genconfig\(aq.
+.sp
 daemonize:    Send the process into the background. This is the default.
-
+.sp
 no\-daemonize: Do not send the process into the background.
-
+.sp
 debug:        Enable full debugging.
-
+.sp
 help:         Print this help message.
-
 .INDENT 0.0
-
 .TP
 .B logdest:      Where to send messages. Choose between syslog, the
+.
 console, and a log file. Defaults to sending messages to
 syslog, or the console if debugging or verbosity is
 enabled.
-
 .UNINDENT
+.sp
 verbose:      Enable verbosity.
-
+.sp
 version:      Print the puppet version number and exit.
-
-
 .SH EXAMPLE
 .INDENT 0.0
 .INDENT 3.5
+.sp
 puppetmasterd
-
 .UNINDENT
 .UNINDENT
-
 .SH AUTHOR
+.sp
 Luke Kanies
-
-
 .SH COPYRIGHT
-Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
+.sp
+Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public
 License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:31.
+.\" Generated by docutils manpage writer.
 .\" 
+.