puppet 2.6.18 → 2.7.1

data/man/man8/filebucket.8

@@ -1,105 +1,81 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "FILEBUCKET" "8" "August 2010" "" ""
-A stand\-alone Puppet filebucket client\.puppet filebucket [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose]
+.TH "PUPPET\-FILEBUCKET" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
 .
-.IP "" 4
+.SH "NAME"
+\fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
 .
-.nf
-
- [\-l|\-\-local] [\-r|\-\-remote]
- [\-s|\-\-server <server>] [\-b|\-\-bucket <directory>] <file> <file> \.\.\.
+.SH "SYNOPSIS"
+A stand\-alone Puppet filebucket client\.
 .
-.fi
-.
-.IP "" 0
-This is a stand\-alone filebucket client for sending files to a local or central filebucket\.This client can operate in three modes, with only one mode per call:
+.SH "USAGE"
+puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\.
 .
 .P
-backup: Send one or more files to the specified file bucket\. Each sent
-.
-.IP "" 4
-.
-.nf
-
-     file is printed with its resulting md5 sum\.
-.
-.fi
-.
-.IP "" 0
+Puppet filebucket can operate in three modes, with only one mode per call:
 .
 .P
-get: Return the text associated with an md5 sum\. The text is printed
-.
-.IP "" 4
-.
-.nf
-
-     to stdout, and only one file can be retrieved at a time\.
-.
-.fi
-.
-.IP "" 0
+backup: Send one or more files to the specified file bucket\. Each sent file is printed with its resulting md5 sum\.
 .
 .P
-restore: Given a file path and an md5 sum, store the content associated
-.
-.IP "" 4
+get: Return the text associated with an md5 sum\. The text is printed to stdout, and only one file can be retrieved at a time\.
 .
-.nf
-
-     with the sum into the specified file path\. You can specify an
-     entirely new path to this argument; you are not restricted to
-     restoring the content to its original location\.
-.
-.fi
+.P
+restore: Given a file path and an md5 sum, store the content associated with the sum into the specified file path\. You can specify an entirely new path to this argument; you are not restricted to restoring the content to its original location\.
 .
-.IP "" 0
+.SH "DESCRIPTION"
+This is a stand\-alone filebucket client for sending files to a local or central filebucket\.
 .
 .P
-Note that +filebucket+ defaults to using a network\-based filebucket available on the server named +puppet+\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying +\-\-local+\.$ puppet filebucket backup /etc/passwd /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 $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\.
+Note that \'filebucket\' defaults to using a network\-based filebucket available on the server named \'puppet\'\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying \'\-\-local\'\.
+.
+.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 \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 puppet with \'\-\-genconfig\'\.
 .
-.P
-debug: Enable full debugging\.
+.TP
+\-\-debug
+Enable full debugging\.
 .
-.P
-help: Print this help message
+.TP
+\-\-help
+Print this help message
 .
-.P
-local: Use the local filebucket\. This will use the default
+.TP
+\-\-local
+Use the local filebucket\. This will use the default configuration information\.
 .
-.IP "" 4
+.TP
+\-\-remote
+Use a remote filebucket\. This will use the default configuration information\.
 .
-.nf
-
-     configuration information\.
+.TP
+\-\-server
+The server to send the file to, instead of locally\.
 .
-.fi
+.TP
+\-\-verbose
+Print extra information\.
 .
-.IP "" 0
+.TP
+\-\-version
+Print version information\.
 .
-.P
-remote: Use a remote filebucket\. This will use the default
-.
-.IP "" 4
+.SH "EXAMPLE"
 .
 .nf
 
-     configuration information\.
+$ puppet filebucket backup /etc/passwd
+/etc/passwd: 429b225650b912a2ee067b0a4cf1e949
+$ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
 .
 .fi
 .
-.IP "" 0
+.SH "AUTHOR"
+Luke Kanies
 .
-.P
-server: The server to send the file to, instead of locally\.
-.
-.P
-verbose: Print extra information\.
-.
-.P
-version: Print version information\.puppet filebucket \-b /tmp/filebucket /my/fileLuke KaniesCopyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/pi.8

@@ -1,17 +1,51 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PI" "8" "August 2010" "" ""
-Print help about puppet types on the console\. Run with \'\-h\' to get detailed help\.puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]Prints details of Puppet types, providers and metaparameters on the console\.help: Print this help text
+.TH "PUPPET\-DESCRIBE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
 .
-.P
-providers: Describe providers in detail for each type
+.SH "NAME"
+\fBpuppet\-describe\fR \- Display help about resource types
 .
-.P
-list: List all types
+.SH "SYNOPSIS"
+Prints help about Puppet resource types, providers, and metaparameters\.
 .
-.P
-meta: List all metaparameters
+.SH "USAGE"
+puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]
 .
-.P
-short: List only parameters without detailpuppet describe \-\-list puppet describe file \-\-providers puppet describe user \-s \-mDavid LutterkortCopyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License
+.SH "OPTIONS"
+.
+.TP
+\-\-help
+Print this help text
+.
+.TP
+\-\-providers
+Describe providers in detail for each type
+.
+.TP
+\-\-list
+List all types
+.
+.TP
+\-\-meta
+List all metaparameters
+.
+.TP
+\-\-short
+List only parameters without detail
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet describe \-\-list
+$ puppet describe file \-\-providers
+$ puppet describe user \-s \-m
+.
+.fi
+.
+.SH "AUTHOR"
+David Lutterkort
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-agent.8

@@ -0,0 +1,154 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-AGENT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-agent\fR \- The puppet agent daemon
+.
+.SH "SYNOPSIS"
+Retrieves the client configuration from the puppet master and applies it to the local host\.
+.
+.P
+This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\.
+.
+.SH "USAGE"
+puppet agent [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-disable] [\-\-enable] [\-h|\-\-help] [\-\-certname \fIhost name\fR] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-o|\-\-onetime] [\-\-serve \fIhandler\fR] [\-t|\-\-test] [\-\-noop] [\-\-digest \fIdigest\fR] [\-\-fingerprint] [\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR]
+.
+.SH "DESCRIPTION"
+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 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\.
+.
+.P
+Once the client has a signed certificate, it will retrieve its configuration and apply it\.
+.
+.SH "USAGE NOTES"
+\'puppet agent\' 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 background, attempt to get a signed certificate, and retrieve and apply its configuration every 30 minutes\.
+.
+.P
+Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' or \'fingerprint\' 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 the server), and exits after running the configuration once (rather than hanging around as a long\-running process)\.
+.
+.P
+\'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 of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to 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\.
+.
+.P
+\'fingerprint\' is a one\-time flag\. In this mode \'puppet agent\' will run once and display on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the \'\-\-digest\' option allows to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
+.
+.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 \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 puppet agent with \'\-\-genconfig\'\.
+.
+.TP
+\-\-daemonize
+Send the process into the background\. This is the default\.
+.
+.TP
+\-\-no\-daemonize
+Do not send the process into the background\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.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\.
+.
+.TP
+\-\-detailed\-exitcodes
+Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, and an exit code of \'4\' means that there were failures during the transaction\. This option only makes sense in conjunction with \-\-onetime\.
+.
+.TP
+\-\-disable
+Disable working on the local system\. This puts a lock file in place, causing \'puppet agent\' 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\.
+.
+.IP
+\'puppet agent\' uses the same lock file while it is running, so no more than one \'puppet agent\' process is working at a time\.
+.
+.IP
+\'puppet agent\' exits after executing this\.
+.
+.TP
+\-\-enable
+Enable working on the local system\. This removes any lock file, causing \'puppet agent\' 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)\.
+.
+.IP
+\'puppet agent\' exits after executing this\.
+.
+.TP
+\-\-certname
+Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\.
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-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
+\-\-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
+.
+.TP
+\-\-onetime
+Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\.
+.
+.TP
+\-\-fingerprint
+Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\.
+.
+.TP
+\-\-serve
+Start another type of server\. By default, \'puppet agent\' 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 that does not require configuration, e\.g\., filebucket, ca, 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
+\-\-test
+Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exit\-codes\', \'no\-splay\', and \'show_diff\'\.
+.
+.TP
+\-\-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\.
+.
+.TP
+\-\-verbose
+Turn on verbose reporting\.
+.
+.TP
+\-\-version
+Print the puppet version number and exit\.
+.
+.TP
+\-\-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 \'puppet agent\' 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\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet agent \-\-server puppet\.domain\.com
+.
+.fi
+.
+.SH "DIAGNOSTICS"
+Puppet agent accepts the following signals:
+.
+.TP
+SIGHUP
+Restart the puppet agent daemon\.
+.
+.TP
+SIGINT and SIGTERM
+Shut down the puppet agent daemon\.
+.
+.TP
+SIGUSR1
+Immediately retrieve and apply configurations from the puppet master\.
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-apply.8

@@ -0,0 +1,75 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-APPLY" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-apply\fR \- Apply Puppet manifests locally
+.
+.SH "SYNOPSIS"
+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] [\-\-apply \fIcatalog\fR] \fIfile\fR
+.
+.SH "DESCRIPTION"
+This is the standalone puppet execution tool; use it to apply individual manifests\.
+.
+.P
+When provided with a modulepath, via command line or config file, puppet apply can effectively mimic the catalog that would be served by puppet master with access to the same modules, although there are some subtle differences\. When combined with scheduling and an automated system for pushing manifests, this can be used to implement a serverless Puppet site\.
+.
+.P
+Most users should use \'puppet agent\' and \'puppet master\' for site\-wide manifests\.
+.
+.SH "OPTIONS"
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'modulepath\' is a valid configuration parameter, so you can specify \'\-\-tags \fIclass\fR,\fItag\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 puppet with \'\-\-genconfig\'\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.TP
+\-\-detailed\-exitcodes
+Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, and an exit code of \'4\' means that there were failures during the transaction\.
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-loadclasses
+Load any stored classes\. \'puppet agent\' caches configured classes (usually at /etc/puppet/classes\.txt), and setting this option causes all of those classes to be set in your puppet manifest\.
+.
+.TP
+\-\-logdest
+Where to send messages\. Choose between syslog, the console, and a log file\. Defaults to sending messages to the console\.
+.
+.TP
+\-\-execute
+Execute a specific piece of Puppet code
+.
+.TP
+\-\-verbose
+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\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet apply \-l /tmp/manifest\.log manifest\.pp
+$ puppet apply \-\-modulepath=/root/dev/modules \-e "include ntpd::server"
+.
+.fi
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-catalog.8

@@ -0,0 +1,286 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-CATALOG" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
+.
+.SH "SYNOPSIS"
+puppet catalog \fIaction\fR [\-\-terminus TERMINUS]
+.
+.SH "DESCRIPTION"
+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\.
+.
+.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\.
+.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.
+.TP
+\-\-debug
+Whether to log debug information\.
+.
+.TP
+\-\-terminus TERMINUS
+Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
+.
+.IP
+Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
+.
+.IP
+The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBapply\fR \- Find and apply a catalog\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog apply [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Finds and applies a catalog\. This action takes no arguments, but the source of the catalog can be managed with the \fB\-\-terminus\fR option\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report object\.
+.
+.TP
+\fBdestroy\fR \- Invalid for this subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog destroy [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBdownload\fR \- Download this node\'s catalog from the puppet master server\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog download [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieves a catalog from the puppet master and saves it to the local yaml cache\. This action always contacts the puppet master and will ignore alternate termini\.
+.
+.IP
+The saved catalog can be used in any subsequent catalog action by specifying \'\-\-terminus yaml\' for that action\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog\.indirection\.terminus_class set to yaml\. The terminus must be explicitly re\-set for subsequent catalog actions\.
+.
+.TP
+\fBfind\fR \- Retrieve the catalog for a node\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog find [\-\-terminus TERMINUS] \fIcertname\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieve the catalog for a node\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource::Catalog object\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog info [\-\-terminus TERMINUS]
+.
+.IP
+\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\.
+.
+.TP
+\fBsave\fR \- API only: create or overwrite an object\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog save [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
+.
+.TP
+\fBsearch\fR \- Invalid for this subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBselect\fR \- Retrieve a catalog and filter it for resources of a given type\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet catalog select [\-\-terminus TERMINUS] \fIhost\fR \fIresource_type\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieves a catalog for the specified host, then searches it for all resources of the requested type\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+A list of resource references ("Type[title]")\. When used from the API, returns an array of Puppet::Resource objects excised from a catalog\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+By default, this action will retrieve a catalog from Puppet\'s compiler subsystem; you must call the action with \fB\-\-terminus rest\fR if you wish to retrieve a catalog from the puppet master\.
+.
+.IP
+FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog\. Use json instead\.
+.
+.SH "EXAMPLES"
+\fBapply\fR
+.
+.P
+Apply the locally cached catalog:
+.
+.P
+$ puppet catalog apply \-\-terminus yaml
+.
+.P
+Retrieve a catalog from the master and apply it, in one step:
+.
+.P
+$ puppet catalog apply \-\-terminus rest
+.
+.P
+From \fBsecret_agent\.rb\fR (API example):
+.
+.IP "" 4
+.
+.nf
+
+# \.\.\.
+Puppet::Face[:catalog, \'0\.0\.1\']\.download
+# (Termini are singletons; catalog\.download has a side effect of
+# setting the catalog terminus to yaml)
+report  = Puppet::Face[:catalog, \'0\.0\.1\']\.apply
+# \.\.\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fBdownload\fR
+.
+.P
+Retrieve and store a catalog:
+.
+.P
+$ puppet catalog download
+.
+.P
+From \fBsecret_agent\.rb\fR (API example):
+.
+.IP "" 4
+.
+.nf
+
+Puppet::Face[:plugin, \'0\.0\.1\']\.download
+Puppet::Face[:facts, \'0\.0\.1\']\.upload
+Puppet::Face[:catalog, \'0\.0\.1\']\.download
+# \.\.\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fBselect\fR
+.
+.P
+Ask the puppet master for a list of managed file resources for a node:
+.
+.P
+$ puppet catalog select \-\-terminus rest somenode\.magpie\.lan file
+.
+.SH "NOTES"
+This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
+.
+.IP "\(bu" 4
+\fBactive_record\fR
+.
+.IP "\(bu" 4
+\fBcompiler\fR
+.
+.IP "\(bu" 4
+\fBqueue\fR
+.
+.IP "\(bu" 4
+\fBrest\fR
+.
+.IP "\(bu" 4
+\fBstatic_compiler\fR
+.
+.IP "\(bu" 4
+\fByaml\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING