puppet 2.6.0 → 2.6.1

data/man/man8/puppetdoc.8

@@ -1,108 +1,108 @@
-.TH   "" "" ""
-.SH NAME
- \- 
-.\" Man page generated from reStructeredText.
-.
-.SH SYNOPSIS
-.sp
-Generate a reference for all Puppet types. Largely meant for internal
-Reductive Labs use.
-.SH USAGE
-.INDENT 0.0
-.INDENT 3.5
-.INDENT 0.0
-.TP
-.B puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>]
-.
-[\-r|\-\-reference <[type]|configuration|..>] [\-\-charset CHARSET] [manifest\-file]
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.SH DESCRIPTION
-.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.
-.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 \(aqoutputdir\(aq option.
-.sp
-If the command is started with \(aqmanifest\-file\(aq command\-line arguments,
-puppet doc 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 \(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 \(aqrdoc\(aq mode.
-.TP
-.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 \(aqtrac\(aq mode only works on Reductive 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 +puppet doc \-\-list+.
-.TP
-.B charset:   Used only in \(aqrdoc\(aq mode. It sets the charset used in the
-.
-html files produced.
-.UNINDENT
-.SH EXAMPLE
-.INDENT 0.0
-.INDENT 3.5
-.sp
-$ puppet doc \-r type > /tmp/type_reference.rst
-.UNINDENT
-.UNINDENT
-.sp
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPETDOC" "8" "August 2010" "" ""
+Generate a reference for all Puppet types\. Largely meant for internal Reductive Labs use\.puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir \fIrdoc outputdir\fR] [\-m|\-\-mode \fItext|pdf|rdoc\fR]
+.
+.IP "" 4
+.
+.nf
+
+         [\-r|\-\-reference <[type]|configuration|\.\.>] [\-\-charset CHARSET] [manifest\-file]
+.
+.fi
+.
+.IP "" 0
+If mode is not \'rdoc\', then this command generates a Markdown 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 Puppet Labs web site\.
+.
+.P
+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\.
+.
+.P
+If the command is started with \'manifest\-file\' command\-line arguments, puppet doc generate a single manifest documentation that is output on stdout\.all: Output the docs for all of the reference types\. In \'rdoc\'
+.
+.IP "" 4
+.
+.nf
+
+       modes, this also outputs documentation for all resources
+.
+.fi
+.
+.IP "" 0
+.
+.P
+help: Print this help message
+.
+.P
+outputdir: Specifies the directory where to output the rdoc
+.
+.IP "" 4
+.
+.nf
+
+       documentation in \'rdoc\' mode\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+mode: Determine the output mode\. Valid modes are \'text\', \'trac\',
+.
+.IP "" 4
+.
+.nf
+
+       \'pdf\' and \'rdoc\'\. The \'pdf\' mode creates PDF formatted files
+       in the /tmp directory\. The default mode is \'text\'\. In \'rdoc\'
+       mode you must provide \'manifests\-path\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+reference: Build a particular reference\. Get a list of references by
+.
+.IP "" 4
+.
+.nf
+
+       running +puppet doc \-\-list+\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+charset: Used only in \'rdoc\' mode\. It sets the charset used in the
+.
+.IP "" 4
+.
+.nf
+
+       html files produced\.
+.
+.fi
+.
+.IP "" 0
+$ puppet doc \-r type > /tmp/type_reference\.rst
+.
+.P
 or
-.INDENT 0.0
-.INDENT 3.5
-.sp
+.
+.P
 $ puppet doc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
-.UNINDENT
-.UNINDENT
-.sp
+.
+.P
 or
-.INDENT 0.0
-.INDENT 3.5
-.sp
-$ puppet doc /etc/puppet/manifests/site.pp
-.UNINDENT
-.UNINDENT
-.sp
+.
+.P
+$ puppet doc /etc/puppet/manifests/site\.pp
+.
+.P
 or
-.INDENT 0.0
-.INDENT 3.5
-.sp
-$ puppet doc \-m markdown \-r configuration
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-.sp
-Luke Kanies
-.SH COPYRIGHT
-.sp
-Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
-Public License
-.\" Generated by docutils manpage writer.
-.\" 
 .
+.P
+$ puppet doc \-m pdf \-r configurationLuke KaniesCopyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU Public License

data/man/man8/puppetmasterd.8

@@ -1,72 +1,52 @@
-.TH   "" "" ""
-.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 puppet master [\-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
-.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://docs.puppetlabs.com/references/stable/configuration.html\fP for the
-full list of acceptable parameters. A commented list of all
-configuration options can also be generated by running puppetmasterdd
-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
-puppet master
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-.sp
-Luke Kanies
-.SH COPYRIGHT
-.sp
-Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
-License
-.\" Generated by docutils manpage writer.
-.\" 
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
+.TH "PUPPETMASTERD" "8" "August 2010" "" ""
+The central puppet server\. Functions as a certificate authority by default\.puppet master [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help]
+.
+.IP "" 4
+.
+.nf
+
+  [\-l|\-\-logdest <file>|console|syslog] [\-v|\-\-verbose] [\-V|\-\-version]
+.
+.fi
+.
+.IP "" 0
+This is the puppet central daemon\.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 \fIdirectory\fR\' as an argument\.
+.
+.P
+See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppetmasterdd with \'\-\-genconfig\'\.
+.
+.P
+daemonize: Send the process into the background\. This is the default\.
+.
+.P
+no\-daemonize: Do not send the process into the background\.
+.
+.P
+debug: Enable full debugging\.
+.
+.P
+help: Print this help message\.
+.
+.P
+logdest: Where to send messages\. Choose between syslog, the
+.
+.IP "" 4
+.
+.nf
+
+          console, and a log file\. Defaults to sending messages to
+          syslog, or the console if debugging or verbosity is
+          enabled\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+verbose: Enable verbosity\.
+.
+.P
+version: Print the puppet version number and exit\.puppet masterLuke KaniesCopyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License

data/man/man8/puppetqd.8

@@ -1,55 +1,20 @@
-.TH SYNOPSIS  "" "" ""
-.SH NAME
-Synopsis \- 
-.\" Man page generated from reStructeredText.
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.sp
-Retrieve serialized records from a queue and process them in order.
-.SH USAGE
-.INDENT 0.0
-.INDENT 3.5
-.sp
-puppet queue [\-d|\-\-debug] [\-v|\-\-verbose]
-.UNINDENT
-.UNINDENT
-.SH DESCRIPTION
-.sp
-This is a simple application that just processes entities in a queue as
-they are recieved.
-.SH OPTIONS
-.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://docs.puppetlabs.com/references/stable/configuration.html\fP for the
-full list of acceptable parameters. A commented list of all
-configuration options can also be generated by running puppetd with
-\(aq\-\-genconfig\(aq.
-.sp
-debug:   Enable full debugging.
-.sp
-help:    Print this help message
-.sp
-verbose: Turn on verbose reporting.
-.sp
-version: Print the puppet version number and exit.
-.SH EXAMPLE
-.INDENT 0.0
-.INDENT 3.5
-.sp
-puppet queue
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-.sp
-Luke Kanies
-.SH COPYRIGHT
-.sp
-Copyright (c) 2009 Reductive Labs, LLC Licensed under the GNU Public
-License
-.\" Generated by docutils manpage writer.
-.\" 
+.TH "PUPPETQD" "8" "August 2010" "" ""
+puppet queue [\-d|\-\-debug] [\-v|\-\-verbose]This is a simple application that just processes entities in a queue as they are recieved\.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 \fIservername\fR\' as an argument\.
 .
+.P
+See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppetd with \'\-\-genconfig\'\.
+.
+.P
+debug: Enable full debugging\.
+.
+.P
+help: Print this help message
+.
+.P
+verbose: Turn on verbose reporting\.
+.
+.P
+version: Print the puppet version number and exit\.puppet queueLuke KaniesCopyright (c) 2009 Reductive Labs, LLC Licensed under the GNU Public License

data/man/man8/puppetrun.8

@@ -1,153 +1,173 @@
-.TH   "" "" ""
-.SH NAME
- \- 
-.\" Man page generated from reStructeredText.
-.
-.SH SYNOPSIS
-.sp
-Trigger a puppet agent run on a set of hosts.
-.SH USAGE
-.INDENT 0.0
-.INDENT 3.5
-.INDENT 0.0
-.TP
-.B puppet kick [\-a|\-\-all] [\-c|\-\-class <class>] [\-d|\-\-debug] [\-f|\-\-foreground]
-.
-[\-h|\-\-help] [\-\-host <host>] [\-\-no\-fqdn] [\-\-ignoreschedules]
-[\-t|\-\-tag <tag>] [\-\-test] [\-p|\-\-ping] <host> [<host> [...]]
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.SH DESCRIPTION
-.sp
-This script can be used to connect to a set of machines running +puppet
-agent+ and trigger them to run their configurations. The most common
-usage would be to specify a class of hosts and a set of tags, and
-+puppet kick+ would look up in LDAP all of the hosts matching that
-class, then connect to each host and trigger a run of all of the objects
-with the specified tags.
-.sp
-If you are not storing your host configurations in LDAP, you can specify
-hosts manually.
-.sp
-You will most likely have to run +puppet kick+ as root to get access to
-the SSL certificates.
-.sp
-+puppet kick+ reads +puppet master+\(aqs configuration file, so that it can
-copy things like LDAP settings.
-.SH USAGE NOTES
-.sp
-+puppet kick+ is useless unless +puppet agent+ is listening. See its
-documentation for more information, but the gist is that you must enable
-+listen+ on the +puppet agent+ daemon, either using +\-\-listen+ on the
-command line or adding \(aqlisten: true\(aq in its config file. In addition,
-you need to set the daemons up to specifically allow connections by
-creating the +namespaceauth+ file, normally at
-\(aq/etc/puppet/namespaceauth.conf\(aq. This file specifies who has access to
-each namespace; if you create the file you must add every namespace you
-want any Puppet daemon to allow \-\- it is currently global to all Puppet
-daemons.
-.sp
-An example file looks like this:
-.sp
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPETRUN" "8" "August 2010" "" ""
+Trigger a puppet agent run on a set of hosts\.puppet kick [\-a|\-\-all] [\-c|\-\-class \fIclass\fR] [\-d|\-\-debug] [\-f|\-\-foreground]
+.
+.IP "" 4
+.
 .nf
-.ft C
+
+  [\-h|\-\-help] [\-\-host <host>] [\-\-no\-fqdn] [\-\-ignoreschedules]
+  [\-t|\-\-tag <tag>] [\-\-test] [\-p|\-\-ping] <host> [<host> [\.\.\.]]
+.
+.fi
+.
+.IP "" 0
+This script can be used to connect to a set of machines running +puppet agent+ and trigger them to run their configurations\. The most common usage would be to specify a class of hosts and a set of tags, and +puppet kick+ would look up in LDAP all of the hosts matching that class, then connect to each host and trigger a run of all of the objects with the specified tags\.
+.
+.P
+If you are not storing your host configurations in LDAP, you can specify hosts manually\.
+.
+.P
+You will most likely have to run +puppet kick+ as root to get access to the SSL certificates\.
+.
+.P
++puppet kick+ reads +puppet master+\'s configuration file, so that it can copy things like LDAP settings\.+puppet kick+ is useless unless +puppet agent+ is listening\. See its documentation for more information, but the gist is that you must enable +listen+ on the +puppet agent+ daemon, either using +\-\-listen+ on the command line or adding \'listen: true\' in its config file\. In addition, you need to set the daemons up to specifically allow connections by creating the +namespaceauth+ file, normally at \'/etc/puppet/namespaceauth\.conf\'\. This file specifies who has access to each namespace; if you create the file you must add every namespace you want any Puppet daemon to allow \-\- it is currently global to all Puppet daemons\.
+.
+.P
+An example file looks like this::
+.
+.IP "" 4
+.
+.nf
+
 [fileserver]
-    allow *.madstop.com
+    allow *\.madstop\.com
 
 [puppetmaster]
-    allow *.madstop.com
+    allow *\.madstop\.com
 
 [puppetrunner]
-    allow culain.madstop.com
-.ft P
+    allow culain\.madstop\.com
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This is what you would install on your Puppet master; non\-master hosts could leave off the \'fileserver\' and \'puppetmaster\' namespaces\.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 \fIdirectory\fR\' as an argument\.
+.
+.P
+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 configuration options can also be generated by running puppet master with \'\-\-genconfig\'\.
+.
+.P
+all: Connect to all available hosts\. Requires LDAP support
+.
+.IP "" 4
+.
+.nf
+
+             at this point\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+class: Specify a class of machines to which to connect\. This
+.
+.IP "" 4
+.
+.nf
+
+             only works if you have LDAP configured, at the moment\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+debug: Enable full debugging\.
+.
+.P
+foreground: Run each configuration in the foreground; that is, when
+.
+.IP "" 4
+.
+.nf
+
+             connecting to a host, do not return until the host has
+             finished its run\. The default is false\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+help: Print this help message
+.
+.P
+host: A specific host to which to connect\. This flag can be
+.
+.IP "" 4
+.
+.nf
+
+             specified more than once\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+ignoreschedules: Whether the client should ignore schedules when running
+.
+.IP "" 4
+.
+.nf
+
+             its configuration\. This can be used to force the client
+             to perform work it would not normally perform so soon\.
+             The default is false\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+parallel: How parallel to make the connections\. Parallelization
+.
+.IP "" 4
+.
+.nf
+
+             is provided by forking for each client to which to
+             connect\. The default is 1, meaning serial execution\.
+.
 .fi
-.sp
-This is what you would install on your Puppet master; non\-master hosts
-could leave off the \(aqfileserver\(aq and \(aqpuppetmaster\(aq namespaces.
-.sp
-Expect more documentation on this eventually.
-.SH OPTIONS
-.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/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 puppet master
-with \(aq\-\-genconfig\(aq.
-.INDENT 0.0
-.TP
-.B all:             Connect to all available hosts. Requires LDAP support
-.
-at this point.
-.TP
-.B class:           Specify a class of machines to which to connect. This
-.
-only works if you have LDAP configured, at the moment.
-.UNINDENT
-.sp
-debug:           Enable full debugging.
-.INDENT 0.0
-.TP
-.B foreground:      Run each configuration in the foreground; that is, when
-.
-connecting to a host, do not return until the host has
-finished its run. The default is false.
-.UNINDENT
-.sp
-help:            Print this help message
-.INDENT 0.0
-.TP
-.B host:            A specific host to which to connect. This flag can be
-.
-specified more than once.
-.TP
-.B ignoreschedules: Whether the client should ignore schedules when running
-.
-its configuration. This can be used to force the client
-to perform work it would not normally perform so soon.
-The default is false.
-.TP
-.B parallel:        How parallel to make the connections. Parallelization
-.
-is provided by forking for each client to which to
-connect. The default is 1, meaning serial execution.
-.TP
-.B tag:             Specify a tag for selecting the objects to apply. Does
-.
-not work with the \-\-test option.
-.TP
-.B test:            Print the hosts you would connect to but do not
-.
-actually connect. This option requires LDAP support at
-this point.
-.UNINDENT
-.sp
-ping:
-.sp
+.
+.IP "" 0
+.
+.P
+tag: Specify a tag for selecting the objects to apply\. Does
+.
+.IP "" 4
+.
 .nf
-.ft C
-Do a ICMP echo against the target host. Skip hosts that don\(aqt respond to ping.
-.ft P
+
+             not work with the \-\-test option\.
+.
 .fi
-.SH EXAMPLE
-.INDENT 0.0
-.INDENT 3.5
-.sp
-sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-.sp
-Luke Kanies
-.SH COPYRIGHT
-.sp
-Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
-License
-.\" Generated by docutils manpage writer.
-.\" 
 .
+.IP "" 0
+.
+.P
+test: Print the hosts you would connect to but do not
+.
+.IP "" 4
+.
+.nf
+
+             actually connect\. This option requires LDAP support at
+             this point\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+ping::
+.
+.P
+Do a ICMP echo against the target host\. Skip hosts that don\'t respond to ping\.sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2Luke KaniesCopyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License