The puppet apply help was somewhat lacking, so I edited the content while making its formatting ronn-compatible.
Signed-off-by: nfagerlund <[email protected]> --- Local-branch: ticket/next/1204 lib/puppet/application/apply.rb | 82 +++++++++++++++++++++++---------------- 1 files changed, 49 insertions(+), 33 deletions(-) diff --git a/lib/puppet/application/apply.rb b/lib/puppet/application/apply.rb index 1a5ab2c..37029cf 100644 --- a/lib/puppet/application/apply.rb +++ b/lib/puppet/application/apply.rb @@ -29,30 +29,42 @@ class Puppet::Application::Apply < Puppet::Application def help <<-HELP -SYNOPSIS +puppet-apply(8) -- Apply Puppet manifests locally ======== -Run a stand-alone 'puppet' manifest. + +SYNOPSIS +-------- +Applies a standalone Puppet manifest to the local system. USAGE -===== - puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] [-e|--execute] - [--detailed-exitcodes] [-l|--logdest <file>] <file> +----- +puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] + [-e|--execute] [--detailed-exitcodes] [-l|--logdest <file>] <file> DESCRIPTION -=========== -This is the standalone puppet execution tool; use it to execute -individual manifests that you write. If you need to execute site-wide -manifests, use 'puppet agent' and 'puppet master'. +----------- +This is the standalone puppet execution tool; use it to apply +individual manifests. + +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. + +Most users should use 'puppet agent' and 'puppet master' for site-wide +manifests. 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 -argument. +file is also a valid long argument. For example, 'modulepath' is a +valid configuration parameter, so you can specify '--tags <class>,<tag>' +as an argument. See the configuration file documentation at http://docs.puppetlabs.com/references/stable/configuration.html for the @@ -60,42 +72,46 @@ full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with '--genconfig'. -debug: Enable full debugging. +* --debug: + Enable full debugging. -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. +* --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. -help: Print this help message +* --help: + Print this help message -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. +* --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. -logdest: Where to send messages. Choose between syslog, the - console, and a log file. Defaults to sending - messages to the console. +* --logdest: + Where to send messages. Choose between syslog, the console, and a log + file. Defaults to sending messages to the console. -execute: Execute a specific piece of Puppet code +* --execute: + Execute a specific piece of Puppet code -verbose: Print extra information. +* --verbose: + Print extra information. EXAMPLE -======= - puppet -l /tmp/manifest.log manifest.pp +------- + $ puppet apply -l /tmp/manifest.log manifest.pp + $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server" AUTHOR -====== +------ Luke Kanies COPYRIGHT -========= +--------- Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License -- 1.7.3.3 -- You received this message because you are subscribed to the Google Groups "Puppet Developers" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/puppet-dev?hl=en.
