summaryrefslogtreecommitdiffstats
path: root/lib/puppet/application/queue.rb
diff options
context:
space:
mode:
authorJesse Wolfe <jes5199@gmail.com>2011-02-03 16:47:51 -0800
committerJesse Wolfe <jes5199@gmail.com>2011-02-03 16:47:51 -0800
commitdd68914eb25d8dd9aac5c8ced39fa0d05136ed9f (patch)
treeb0dd0c48901a9fa339b2d8734bd7a6bca088458c /lib/puppet/application/queue.rb
parentea348761df0b5297dbac50c7f1c48d22746524fa (diff)
parent3f2f1c2456cf5f08bd67ab5730ab970be5285711 (diff)
downloadpuppet-dd68914eb25d8dd9aac5c8ced39fa0d05136ed9f.tar.gz
puppet-dd68914eb25d8dd9aac5c8ced39fa0d05136ed9f.tar.xz
puppet-dd68914eb25d8dd9aac5c8ced39fa0d05136ed9f.zip
Merge branch 'maint/2.6.next/help' into next
Diffstat (limited to 'lib/puppet/application/queue.rb')
-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 b9e8ca4ca..d32ec9a6f 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}"