summaryrefslogtreecommitdiffstats
path: root/bin
diff options
context:
space:
mode:
authorJesse Wolfe <jes5199@gmail.com>2010-04-21 00:20:19 -0700
committertest branch <puppet-dev@googlegroups.com>2010-02-17 06:50:53 -0800
commitb6e2ce6a85c953fcd57a3b837ccaa794a634dc22 (patch)
tree66ef5c62bed72f4784a6505c22aa2d3db9ecb1dd /bin
parentb0737228b8b56019e417d68d7215270ce282f535 (diff)
downloadpuppet-b6e2ce6a85c953fcd57a3b837ccaa794a634dc22.tar.gz
puppet-b6e2ce6a85c953fcd57a3b837ccaa794a634dc22.tar.xz
puppet-b6e2ce6a85c953fcd57a3b837ccaa794a634dc22.zip
feature #2276 Single Executable: help info
Change the --help text to match the new single executable invocations Signed-off-by: Jesse Wolfe <jes5199@gmail.com>
Diffstat (limited to 'bin')
-rwxr-xr-xbin/filebucket8
-rwxr-xr-xbin/pi8
-rwxr-xr-xbin/puppetdoc16
-rwxr-xr-xbin/ralsh17
4 files changed, 25 insertions, 24 deletions
diff --git a/bin/filebucket b/bin/filebucket
index 1c5daa4e3..aa0a1d9d0 100755
--- a/bin/filebucket
+++ b/bin/filebucket
@@ -7,7 +7,7 @@
#
# = Usage
#
-# filebucket [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
+# puppet filebucket [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
# [-l|--local] [-r|--remote]
# [-s|--server <server>] [-b|--bucket <directory>] <file> <file> ...
#
@@ -41,9 +41,9 @@
#
# = Example
#
-# $ filebucket backup /etc/passwd
+# $ puppet filebucket backup /etc/passwd
# /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
-# $ filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+# $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
# $
#
# = Options
@@ -83,7 +83,7 @@
#
# = Example
#
-# filebucket -b /tmp/filebucket /my/file
+# puppet filebucket -b /tmp/filebucket /my/file
#
# = Author
#
diff --git a/bin/pi b/bin/pi
index 68e756a35..fe847d1c1 100755
--- a/bin/pi
+++ b/bin/pi
@@ -7,7 +7,7 @@
# help.
# = Usage
#
-# pi [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
+# puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
#
# = Description
#
@@ -32,9 +32,9 @@
#
# = Example
#
-# pi --list
-# pi file --providers
-# pi user -s -m
+# puppet describe --list
+# puppet describe file --providers
+# puppet describe user -s -m
#
# = Author
#
diff --git a/bin/puppetdoc b/bin/puppetdoc
index e17b014b3..849b5338b 100755
--- a/bin/puppetdoc
+++ b/bin/puppetdoc
@@ -8,8 +8,8 @@
#
# = Usage
#
-# puppetdoc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>]
-# [-r|--reference <[type]|configuration|..>] [manifest-file]
+# puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>]
+# [-r|--reference <[type]|configuration|..>] [manifest-file]
#
# = Description
#
@@ -22,7 +22,7 @@
# are in 'manifestdir' and 'modulepath' configuration directives.
# The generated documentation directory is doc by default but can be changed with the 'outputdir' option.
#
-# If the command is started with 'manifest-file' command-line arguments, puppetdoc generate a single
+# If the command is started with 'manifest-file' command-line arguments, puppet doc generate a single
# manifest documentation that is output on stdout.
#
# = Options
@@ -40,17 +40,17 @@
# Determine the output mode. Valid modes are 'text', 'trac', 'pdf', 'markdown' and 'rdoc'. The 'pdf' and 'markdown' modes create PDF or Markdown formatted files in the /tmp directory. Note that 'trac' mode only works on Reductive Labs servers. The default mode is 'text'. In 'rdoc' mode you must provide 'manifests-path'
#
# reference::
-# Build a particular reference. Get a list of references by running +puppetdoc --list+.
+# Build a particular reference. Get a list of references by running +puppet doc --list+.
#
# = Example
#
-# $ puppetdoc -r type > /tmp/type_reference.rst
+# $ puppet doc -r type > /tmp/type_reference.rst
# or
-# $ puppetdoc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
+# $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
# or
-# $ puppetdoc /etc/puppet/manifests/site.pp
+# $ puppet doc /etc/puppet/manifests/site.pp
# or
-# $ puppetdoc -m markdown -r configuration
+# $ puppet doc -m markdown -r configuration
#
# = Author
#
diff --git a/bin/ralsh b/bin/ralsh
index c99672ae4..00a6925a1 100755
--- a/bin/ralsh
+++ b/bin/ralsh
@@ -7,8 +7,9 @@
#
# = Usage
#
-# ralsh [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit] [-H|--host <host>]
-# [-p|--param <param>] [-t|--types] type <name>
+# puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
+# [-H|--host <host>] [-p|--param <param>] [-t|--types]
+# type <name>
#
# = Description
#
@@ -16,12 +17,12 @@
# into Puppet code, along with some ability to use Puppet to affect the current
# state.
#
-# By default, you must at least provide a type to list, which case ralsh
+# By default, you must at least provide a type to list, which case puppet resource
# will tell you everything it knows about all instances of that type. You can
-# optionally specify an instance name, and ralsh will only describe that single
+# optionally specify an instance name, and puppet resource will only describe that single
# instance.
#
-# You can also add +--edit+ as an argument, and ralsh will write its output
+# You can also add +--edit+ as an argument, and puppet resource will write its output
# to a file, open that file in an editor, and then apply the file as a Puppet
# transaction. You can easily use this to use Puppet to make simple changes to
# a system.
@@ -63,9 +64,9 @@
#
# = Example
#
-# This example uses ``ralsh`` to return Puppet configuration for the user ``luke``::
+# This example uses ``puppet resource`` to return Puppet configuration for the user ``luke``::
#
-# $ ralsh user luke
+# $ puppet resource user luke
# user { 'luke':
# home => '/home/luke',
# uid => '100',
@@ -85,5 +86,5 @@
# Copyright (c) 2005-2007 Reductive Labs, LLC
# Licensed under the GNU Public License
-require 'puppet/application/ralsh'
+require 'puppet/application/resource'
Puppet::Application[:resource].run