summaryrefslogtreecommitdiffstats
path: root/lib/puppet/util/command_line/puppetqd
diff options
context:
space:
mode:
authorJesse Wolfe <jes5199@gmail.com>2010-07-09 11:24:01 -0700
committerMarkus Roberts <Markus@reality.com>2010-07-09 12:43:00 -0700
commita07af2bb40f6894930ed910c66115556e10c0841 (patch)
tree38c70723112b2dc83547b6c9dba3488573ccb6f1 /lib/puppet/util/command_line/puppetqd
parent3c0059195fb2b1255f368d98021f4a99ecd121a6 (diff)
downloadpuppet-a07af2bb40f6894930ed910c66115556e10c0841.tar.gz
puppet-a07af2bb40f6894930ed910c66115556e10c0841.tar.xz
puppet-a07af2bb40f6894930ed910c66115556e10c0841.zip
[#4196] Move the docs into the source directory structure
Since it is no longer possible to find the running executable from the call stack, docs have to be kept somewhere in the source tree. Of course, at this point, we shouldn't be using RDoc::Usage at all.
Diffstat (limited to 'lib/puppet/util/command_line/puppetqd')
-rwxr-xr-xlib/puppet/util/command_line/puppetqd53
1 files changed, 53 insertions, 0 deletions
diff --git a/lib/puppet/util/command_line/puppetqd b/lib/puppet/util/command_line/puppetqd
new file mode 100755
index 000000000..439db5cb0
--- /dev/null
+++ b/lib/puppet/util/command_line/puppetqd
@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+# == 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://reductivelabs.com/trac/puppet/wiki/ConfigurationReference 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 Reductive Labs, LLC
+# Licensed under the GNU Public License
+
+#Puppet::Application[:queue].run