diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-02-16 15:06:42 -0800 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-02-17 11:34:22 -0800 |
| commit | 768d9a1a796b631de7ec4da2e75ec52211716c9a (patch) | |
| tree | 503873ad0cc9c2618af553e8aaafac3c9b3a026a | |
| parent | 3f1c26ff5699589e06f9fd48c0bd9ac3379a4c07 (diff) | |
| download | puppet-768d9a1a796b631de7ec4da2e75ec52211716c9a.tar.gz puppet-768d9a1a796b631de7ec4da2e75ec52211716c9a.tar.xz puppet-768d9a1a796b631de7ec4da2e75ec52211716c9a.zip | |
(#1204) Reformat help text for puppet master
Markdown changes for compatibility with ronn.
| -rw-r--r-- | lib/puppet/application/master.rb | 71 |
1 files changed, 43 insertions, 28 deletions
diff --git a/lib/puppet/application/master.rb b/lib/puppet/application/master.rb index b2b77f870..39af33dc8 100644 --- a/lib/puppet/application/master.rb +++ b/lib/puppet/application/master.rb @@ -28,25 +28,32 @@ class Puppet::Application::Master < Puppet::Application def help <<-HELP -SYNOPSIS +puppet-master(8) -- The puppet master daemon ======== + +SYNOPSIS +-------- The central puppet server. Functions as a certificate authority by default. USAGE -===== - puppet master [-D|--daemonize|--no-daemonize] [-d|--debug] [-h|--help] - [-l|--logdest <file>|console|syslog] [-v|--verbose] [-V|--version] - [--compile <nodename>] [--apply <catalog>] +----- +puppet master [-D|--daemonize|--no-daemonize] [-d|--debug] [-h|--help] + [-l|--logdest <file>|console|syslog] [-v|--verbose] [-V|--version] + [--compile <nodename>] [--apply <catalog>] + DESCRIPTION -=========== -This is the puppet central daemon. +----------- +This command starts an instance of puppet master, running as a daemon +and using Ruby's built-in Webrick webserver. Puppet master can also be +managed by other application servers; when this is the case, this +executable is not used. 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 @@ -55,47 +62,55 @@ argument. 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 +configuration options can also be generated by running puppet master with '--genconfig'. -daemonize: Send the process into the background. This is the default. +* --daemonize: + Send the process into the background. This is the default. -no-daemonize: Do not send the process into the background. +* --no-daemonize: + Do not send the process into the background. -debug: Enable full debugging. +* --debug: + Enable full debugging. -help: Print this help message. +* --help: + Print this help message. -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. +* --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. -verbose: Enable verbosity. +* --verbose: + Enable verbosity. -version: Print the puppet version number and exit. +* --version: + Print the puppet version number and exit. -compile: Capability to compile a catalogue and output it in JSON - from the Puppet master. Uses facts contained in the - $vardir/yaml/ directory to compile the catalog. +* --compile: + Capability to compile a catalogue and output it in JSON from the + Puppet master. Uses facts contained in the $vardir/yaml/ directory to + compile the catalog. -apply: Capability to apply JSON catalog (such as one generated - with --compile). You can either specify a JSON file or - pipe in JSON from standard input. +* --apply: + Capability to apply JSON catalog (such as one generated with + --compile). You can either specify a JSON file or pipe in JSON from + standard input. EXAMPLE -======= +------- puppet master AUTHOR -====== +------ Luke Kanies COPYRIGHT -========= +--------- Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License |
