diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-02-16 15:26:15 -0800 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-02-17 11:34:22 -0800 |
| commit | f4c7e484dc1781567f55f80619d8a34def22f18d (patch) | |
| tree | 00411dd599636130cdef9e316bcdfcee06bd13d0 /lib/puppet/application/queue.rb | |
| parent | bd14ff5e1ea5bad3e1cba1fd19610f63158c5bc4 (diff) | |
| download | puppet-f4c7e484dc1781567f55f80619d8a34def22f18d.tar.gz puppet-f4c7e484dc1781567f55f80619d8a34def22f18d.tar.xz puppet-f4c7e484dc1781567f55f80619d8a34def22f18d.zip | |
(#1204) Edit content and formatting of puppet queue help
Puppet queue had inadequate help, so I added to it while
reformatting for ronn.
Diffstat (limited to 'lib/puppet/application/queue.rb')
| -rw-r--r-- | lib/puppet/application/queue.rb | 48 |
1 files changed, 31 insertions, 17 deletions
diff --git a/lib/puppet/application/queue.rb b/lib/puppet/application/queue.rb index d32ec9a6f..00ace37fa 100644 --- a/lib/puppet/application/queue.rb +++ b/lib/puppet/application/queue.rb @@ -40,24 +40,34 @@ class Puppet::Application::Queue < Puppet::Application def help <<-HELP -SYNOPSIS +puppet-queue(8) -- Queuing daemon for asynchronous storeconfigs ======== -Retrieve serialized records from a queue and process them in order. + +SYNOPSIS +-------- +Retrieves serialized storeconfigs records from a queue and processes +them in order. USAGE -===== - puppet queue [-d|--debug] [-v|--verbose] +----- +puppet queue [-d|--debug] [-v|--verbose] DESCRIPTION -=========== -This is a simple application that just processes entities in a queue as -they are recieved. +----------- +This application runs as a daemon and processes storeconfigs data, +retrieving the data from a stomp server message queue and writing it to +a database. + +For more information, including instructions for properly setting up +your puppet master and message queue, see the documentation on setting +up asynchronous storeconfigs at: +http://projects.puppetlabs.com/projects/1/wiki/Using_Stored_Configuration 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 <servername>' as @@ -66,30 +76,34 @@ an 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 puppetd with +configuration options can also be generated by running puppet queue with '--genconfig'. -debug: Enable full debugging. +* --debug: + Enable full debugging. -help: Print this help message +* --help: + Print this help message -verbose: Turn on verbose reporting. +* --verbose: + Turn on verbose reporting. -version: Print the puppet version number and exit. +* --version: + Print the puppet version number and exit. EXAMPLE -======= - puppet queue +------- + $ puppet queue AUTHOR -====== +------ Luke Kanies COPYRIGHT -========= +--------- Copyright (c) 2009 Puppet Labs, LLC Licensed under the GNU Public License |