diff options
| author | Jesse Wolfe <jes5199@gmail.com> | 2010-07-09 11:24:01 -0700 |
|---|---|---|
| committer | Markus Roberts <Markus@reality.com> | 2010-07-09 12:43:00 -0700 |
| commit | a07af2bb40f6894930ed910c66115556e10c0841 (patch) | |
| tree | 38c70723112b2dc83547b6c9dba3488573ccb6f1 /lib/puppet/util/command_line/pi | |
| parent | 3c0059195fb2b1255f368d98021f4a99ecd121a6 (diff) | |
| download | puppet-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/pi')
| -rwxr-xr-x | lib/puppet/util/command_line/pi | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/lib/puppet/util/command_line/pi b/lib/puppet/util/command_line/pi new file mode 100755 index 000000000..ae3c46e9a --- /dev/null +++ b/lib/puppet/util/command_line/pi @@ -0,0 +1,48 @@ +#!/usr/bin/env ruby + +# +# = Synopsis +# +# Print help about puppet types on the console. Run with '-h' to get detailed +# help. +# = Usage +# +# puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta] +# +# = Description +# +# Prints details of Puppet types, providers and metaparameters on the console. +# +# = Options +# +# help:: +# Print this help text +# +# providers:: +# Describe providers in detail for each type +# +# list:: +# List all types +# +# meta:: +# List all metaparameters +# +# short:: +# List only parameters without detail +# +# = Example +# +# puppet describe --list +# puppet describe file --providers +# puppet describe user -s -m +# +# = Author +# +# David Lutterkort +# +# = Copyright +# +# Copyright (c) 2005 Reductive Labs, LLC +# Licensed under the GNU Public License + +#Puppet::Application[:describe].run |