Permalink
Browse files

Maint: Update man pages

Updated the man pages via the `rake gen_manpages` task.
  • Loading branch information...
1 parent 758d3a5 commit fdf1d9e3b5e2231daf5ddf26f1460e1dbb3c972a @joshcooper joshcooper committed Jan 15, 2013
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -0,0 +1,23 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "EXTLOOKUP2HIERA" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBextlookup2hiera\fR
+.
+.P
+Converter for extlookup CSV files into Hiera JSON and YAML files
+.
+.IP "" 4
+.
+.nf
+
+\-i, \-\-in FILE Input CSV file
+\-o, \-\-out FILE Output Hiera file
+\-j, \-\-json Create JSON format file
+.
+.fi
+.
+.IP "" 0
+
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-AGENT" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-AGENT" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-agent\fR \- The puppet agent daemon
@@ -61,7 +61,7 @@ Provide transaction information via exit codes\. If this is enabled, an exit cod
.
.TP
\-\-digest
-Change the certificate fingerprinting digest algorithm\. The default is MD5\. Valid values depends on the version of OpenSSL installed, but should always at least contain MD5, MD2, SHA1 and SHA256\.
+Change the certificate fingerprinting digest algorithm\. The default is SHA256\. Valid values depends on the version of OpenSSL installed, but will likely contain MD5, MD2, SHA1 and SHA256\.
.
.TP
\-\-disable
@@ -97,7 +97,7 @@ Where to send messages\. Choose between syslog, the console, and a log file\. De
.
.TP
\-\-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 puppet agent is being run with listen = true in puppet\.conf or was started with the \fB\-\-listen\fR option\.
+Do not create a config client\. This will cause the daemon to start but not check configuration unless it is triggered with \fBpuppet kick\fR\. This only makes sense when puppet agent is being run with listen = true in puppet\.conf or was started with the \fB\-\-listen\fR option\.
.
.TP
\-\-noop
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-APPLY" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-APPLY" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-apply\fR \- Apply Puppet manifests locally
@@ -10,7 +10,7 @@
Applies a standalone Puppet manifest to the local system\.
.
.SH "USAGE"
-puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-l|\-\-logdest \fIfile\fR] [\-\-noop] [\-\-apply \fIcatalog\fR] [\-\-catalog \fIcatalog\fR] \fIfile\fR
+puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-l|\-\-logdest \fIfile\fR] [\-\-noop] [\-\-catalog \fIcatalog\fR] \fIfile\fR
.
.SH "DESCRIPTION"
This is the standalone puppet execution tool; use it to apply individual manifests\.
@@ -60,10 +60,6 @@ Execute a specific piece of Puppet code
Print extra information\.
.
.TP
-\-\-apply
-Apply a JSON catalog (such as one generated with \'puppet master \-\-compile\')\. You can either specify a JSON file or pipe in JSON from standard input\. Deprecated, please use \-\-catalog instead\.
-.
-.TP
\-\-catalog
Apply a JSON catalog (such as one generated with \'puppet master \-\-compile\')\. You can either specify a JSON file or pipe in JSON from standard input\.
.
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-CA" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CA" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-ca\fR \- Local Puppet Certificate Authority management\.
@@ -16,16 +16,12 @@ This provides local management of the Puppet Certificate Authority\.
You can use this subcommand to sign outstanding certificate requests, list and manage local certificates, and inspect the state of the CA\.
.
.SH "OPTIONS"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
-\-\-mode MODE
-The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
-.
-.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
@@ -89,7 +85,7 @@ Undocumented action\.
\fBSYNOPSIS\fR
.
.IP
-puppet ca list [\-\-[no\-]all] [\-\-[no\-]pending] [\-\-[no\-]signed] [\-\-subject PATTERN]
+puppet ca list [\-\-[no\-]all] [\-\-[no\-]pending] [\-\-[no\-]signed] [\-\-digest ALGORITHM] [\-\-subject PATTERN]
.
.IP
\fBDESCRIPTION\fR
@@ -101,6 +97,9 @@ This will list the current certificates and certificate signing requests in the
\fBOPTIONS\fR \fI\-\-[no\-]all\fR \- Include all certificates and requests\.
.
.IP
+\fI\-\-digest ALGORITHM\fR \- The hash algorithm to use when displaying the fingerprint
+.
+.IP
\fI\-\-[no\-]pending\fR \- Include pending certificate signing requests\.
.
.IP
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-CATALOG" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CATALOG" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
@@ -13,16 +13,12 @@ puppet catalog \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
This subcommand deals with catalogs, which are compiled per\-node artifacts generated from a set of Puppet manifests\. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and \fBcertname\fR, but you can change the source of the catalog with the \fB\-\-terminus\fR option\. You can also choose to print any catalog in \'dot\' format (for easy graph viewing with OmniGraffle or Graphviz) with \'\-\-render\-as dot\'\.
.
.SH "OPTIONS"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
-\-\-mode MODE
-The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
-.
-.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
@@ -140,7 +136,7 @@ puppet catalog info [\-\-terminus TERMINUS] [\-\-extra HASH]
\fBDESCRIPTION\fR
.
.IP
-Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
+Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\.
.
.TP
\fBsave\fR \- API only: create or overwrite an object\.
@@ -273,6 +269,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
\fBcompiler\fR
.
.IP "\(bu" 4
+\fBjson\fR
+.
+.IP "\(bu" 4
\fBqueue\fR
.
.IP "\(bu" 4
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-CERT" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERT" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-cert\fR \- Manage certificates and requests
@@ -24,7 +24,7 @@ Revoke a host\'s certificate (if applicable) and remove all files related to tha
.
.TP
fingerprint
-Print the DIGEST (defaults to md5) fingerprint of a host\'s certificate\.
+Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s certificate\.
.
.TP
generate
@@ -40,7 +40,7 @@ Print the full\-text version of a host\'s certificate\.
.
.TP
revoke
-Revoke the certificate of a client\. The certificate can be specified either by its serial number (given as a decimal number or a hexadecimal number prefixed by \'0x\') or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' configuration option\. Note that the puppet master needs to be restarted after revoking certificates\.
+Revoke the certificate of a client\. The certificate can be specified either by its serial number (given as a hexadecimal number prefixed by \'0x\') or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' configuration option\. Note that the puppet master needs to be restarted after revoking certificates\.
.
.TP
sign
@@ -62,7 +62,7 @@ Operate on all items\. Currently only makes sense with the \'sign\', \'clean\',
.
.TP
\-\-digest
-Set the digest for fingerprinting (defaults to md5)\. Valid values depends on your openssl and openssl ruby extension version, but should contain at least md5, sha1, md2, sha256\.
+Set the digest for fingerprinting (defaults to the the digest used when signing the cert)\. Valid values depends on your openssl and openssl ruby extension version\.
.
.TP
\-\-debug
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-CERTIFICATE" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-certificate\fR \- Provide access to the CA for certificate management\.
@@ -13,16 +13,12 @@ puppet certificate \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-
This subcommand interacts with a local or remote Puppet certificate authority\. Currently, its behavior is not a full superset of \fBpuppet cert\fR; specifically, it is unable to mimic puppet cert\'s "clean" option, and its "generate" action submits a CSR rather than creating a signed certificate\.
.
.SH "OPTIONS"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
-\-\-mode MODE
-The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
-.
-.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
@@ -134,7 +130,7 @@ puppet certificate info [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-loca
\fBDESCRIPTION\fR
.
.IP
-Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
+Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\.
.
.TP
\fBlist\fR \- List all certificate signing requests\.
@@ -228,6 +224,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
\fBca\fR
.
.IP "\(bu" 4
+\fBdisabled_ca\fR
+.
+.IP "\(bu" 4
\fBfile\fR
.
.IP "\(bu" 4
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-certificate_request\fR \- Manage certificate requests\.
@@ -13,16 +13,12 @@ puppet certificate_request \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
This subcommand retrieves and submits certificate signing requests (CSRs)\.
.
.SH "OPTIONS"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
-\-\-mode MODE
-The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
-.
-.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
@@ -93,7 +89,7 @@ puppet certificate_request info [\-\-terminus TERMINUS] [\-\-extra HASH]
\fBDESCRIPTION\fR
.
.IP
-Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
+Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\.
.
.TP
\fBsave\fR \- API only: submit a certificate signing request\.
@@ -158,6 +154,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
\fBca\fR
.
.IP "\(bu" 4
+\fBdisabled_ca\fR
+.
+.IP "\(bu" 4
\fBfile\fR
.
.IP "\(bu" 4
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "May 2012" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-certificate_revocation_list\fR \- Manage the list of revoked certificates\.
@@ -13,16 +13,12 @@ puppet certificate_revocation_list \fIaction\fR [\-\-terminus TERMINUS] [\-\-ext
This subcommand is primarily for retrieving the certificate revocation list from the CA\.
.
.SH "OPTIONS"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
-\-\-mode MODE
-The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
-.
-.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
@@ -111,7 +107,7 @@ puppet certificate_revocation_list info [\-\-terminus TERMINUS] [\-\-extra HASH]
\fBDESCRIPTION\fR
.
.IP
-Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
+Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\.
.
.TP
\fBsave\fR \- Invalid for this subcommand\.
@@ -155,6 +151,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
\fBca\fR
.
.IP "\(bu" 4
+\fBdisabled_ca\fR
+.
+.IP "\(bu" 4
\fBfile\fR
.
.IP "\(bu" 4
Oops, something went wrong.

0 comments on commit fdf1d9e

Please sign in to comment.