summaryrefslogtreecommitdiffstats
path: root/lib/puppet/application
diff options
context:
space:
mode:
authorJesse Wolfe <jes5199@gmail.com>2011-02-03 15:50:06 -0800
committerJesse Wolfe <jes5199@gmail.com>2011-02-03 16:42:10 -0800
commit95fc38c1a06cddbc8de9e308b6abc4ada65671c6 (patch)
treebacd9b86d0d1578e1a9ec4e4c8d9565cb6ca4655 /lib/puppet/application
parenta041e194c41febe752ee39ba5d26291a775ecb5f (diff)
downloadpuppet-95fc38c1a06cddbc8de9e308b6abc4ada65671c6.tar.gz
puppet-95fc38c1a06cddbc8de9e308b6abc4ada65671c6.tar.xz
puppet-95fc38c1a06cddbc8de9e308b6abc4ada65671c6.zip
Maint: move puppet queue --help
Diffstat (limited to 'lib/puppet/application')
-rw-r--r--lib/puppet/application/queue.rb59
1 files changed, 59 insertions, 0 deletions
diff --git a/lib/puppet/application/queue.rb b/lib/puppet/application/queue.rb
index 239f6b2ad..651177109 100644
--- a/lib/puppet/application/queue.rb
+++ b/lib/puppet/application/queue.rb
@@ -37,6 +37,65 @@ class Puppet::Application::Queue < Puppet::Application
option("--debug","-d")
option("--verbose","-v")
+ def help
+ <<-HELP
+
+SYNOPSIS
+========
+Retrieve serialized records from a queue and process them in order.
+
+
+USAGE
+=====
+ puppet queue [-d|--debug] [-v|--verbose]
+
+
+DESCRIPTION
+===========
+This is a simple application that just processes entities in a queue as
+they are recieved.
+
+
+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
+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
+'--genconfig'.
+
+debug: Enable full debugging.
+
+help: Print this help message
+
+verbose: Turn on verbose reporting.
+
+version: Print the puppet version number and exit.
+
+
+EXAMPLE
+=======
+ puppet queue
+
+
+AUTHOR
+======
+Luke Kanies
+
+
+COPYRIGHT
+=========
+Copyright (c) 2009 Puppet Labs, LLC Licensed under the GNU Public
+License
+
+ HELP
+ end
+
def main
require 'puppet/indirector/catalog/queue' # provides Puppet::Indirector::Queue.subscribe
Puppet.notice "Starting puppetqd #{Puppet.version}"