[#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.

5 files changed, 0 insertions, 358 deletions

diff --git a/bin/filebucket b/bin/filebucket
index aa0a1d9d0..95ef7c6cf 100755
--- a/bin/filebucket
+++ b/bin/filebucket
@@ -1,99 +1,5 @@
 #!/usr/bin/env ruby
 
-#
-# = Synopsis
-#
-# A stand-alone Puppet filebucket client.
-#
-# = Usage
-#
-#   puppet filebucket [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
-#      [-l|--local] [-r|--remote]
-#      [-s|--server <server>] [-b|--bucket <directory>] <file> <file> ...
-#
-# = Description
-#
-# This is a stand-alone filebucket client for sending files to a local
-# or central filebucket.
-#
-# = Usage
-#
-# This client can operate in three modes, with only one mode per call:
-#
-# backup::
-#   Send one or more files to the specified file bucket.  Each sent file
-#   is printed with its resulting md5 sum.
-#
-# get::
-#   Return the text associated with an md5 sum.  The text is printed to
-#   stdout, and only one file can be retrieved at a time.
-#
-# restore::
-#   Given a file path and an md5 sum, store the content associated with the
-#   sum into the specified file path.  You can specify an entirely new path
-#   to this argument; you are not restricted to restoring the content to its
-#   original location.
-#
-# Note that +filebucket+ defaults to using a network-based filebucket available on
-# the server named +puppet+.  To use this, you'll have to be running as a user
-# with valid Puppet certificates.  Alternatively, you can use your local file bucket
-# by specifying +--local+.
-#
-# = Example
-#
-#   $ puppet filebucket backup /etc/passwd
-#   /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
-#   $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
-#   $
-#
-# = Options
-#
-# Note that any configuration parameter that's valid in the configuration file
-# is also a valid long argument.  For example, 'ssldir' is a valid configuration
-# parameter, so you can specify '--ssldir <directory>' 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 puppet with
-# '--genconfig'.
-#
-# debug::
-#   Enable full debugging.
-#
-# help::
-#   Print this help message
-#
-# local::
-#   Use the local filebucket.  This will use the default configuration
-#   information.
-#
-# remote::
-#   Use a remote filebucket.  This will use the default configuration
-#   information.
-#
-# server::
-#   The server to send the file to, instead of locally.
-#
-# verbose::
-#   Print extra information.
-#
-# version::
-#   Print version information.
-#
-# = Example
-#
-#   puppet filebucket -b /tmp/filebucket /my/file
-#
-# = Author
-#
-# Luke Kanies
-#
-# = Copyright
-#
-# Copyright (c) 2005 Reductive Labs, LLC
-# Licensed under the GNU Public License
-
 require 'puppet/application'
 require 'puppet/application/filebucket'
 
diff --git a/bin/pi b/bin/pi
index fe847d1c1..f2e7312bd 100755
--- a/bin/pi
+++ b/bin/pi
@@ -1,50 +1,5 @@
 #!/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
-
 require 'puppet/application/describe'
 
 Puppet::Application[:describe].run
diff --git a/bin/puppet b/bin/puppet
index 9b7c7d64d..c03070291 100755
--- a/bin/puppet
+++ b/bin/puppet
@@ -1,73 +1,4 @@
 #!/usr/bin/env ruby
 
-#
-# = Synopsis
-#
-# Run a stand-alone +puppet+ manifest.
-#
-# = Usage
-#
-#   puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] [-e|--execute]
-#               [--detailed-exitcodes] [-l|--logdest <file>] <file>
-#
-# = Description
-#
-# This is the standalone puppet execution tool; use it to execute
-# individual manifests that you write.  If you need to execute site-wide
-# manifests, use 'puppet agent' and 'puppet master'.
-#
-# = Options
-#
-# Note that any configuration parameter that's valid in the configuration file
-# is also a valid long argument.  For example, 'ssldir' is a valid configuration
-# parameter, so you can specify '--ssldir <directory>' 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 puppet with
-# '--genconfig'.
-#
-# debug::
-#   Enable full debugging.
-#
-# detailed-exitcodes::
-#   Provide transaction information via exit codes.  If this is enabled, an exit
-#   code of '2' means there were changes, and an exit code of '4' means that there
-#   were failures during the transaction.
-#
-# help::
-#   Print this help message
-#
-# loadclasses::
-#   Load any stored classes. 'puppet agent' caches configured classes (usually at
-#   /etc/puppet/classes.txt), and setting this option causes all of those classes
-#   to be set in your puppet manifest.
-#
-# logdest::
-#   Where to send messages.  Choose between syslog, the console, and a log file.
-#   Defaults to sending messages to the console.
-#
-# execute::
-#   Execute a specific piece of Puppet code
-#
-# verbose::
-#   Print extra information.
-#
-# = Example
-#
-#   puppet -l /tmp/manifest.log manifest.pp
-#
-# = Author
-#
-# Luke Kanies
-#
-# = Copyright
-#
-# Copyright (c) 2005 Reductive Labs, LLC
-# Licensed under the GNU Public License
-
-#Puppet::Application[:apply].run # this is so the RDoc::usage hack can find this file
-
 require 'puppet/util/command_line'
 Puppet::Util::CommandLine.new.execute
diff --git a/bin/puppetdoc b/bin/puppetdoc
index 400a58251..ea08aa2f1 100755
--- a/bin/puppetdoc
+++ b/bin/puppetdoc
@@ -1,68 +1,4 @@
 #!/usr/bin/env ruby
 
-#
-# = Synopsis
-#
-# Generate a reference for all Puppet types.  Largely meant for internal Reductive
-# Labs use.
-#
-# = Usage
-#
-#   puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>]
-#              [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [manifest-file]
-#
-# = Description
-#
-# If mode is not 'rdoc', then this command generates a restructured-text document describing all installed
-# Puppet types or all allowable arguments to puppet executables.  It is largely
-# meant for internal use and is used to generate the reference document
-# available on the Reductive Labs web site.
-#
-# In 'rdoc' mode, this command generates an html RDoc hierarchy describing the manifests that
-# 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, puppet doc generate a single
-# manifest documentation that is output on stdout.
-#
-# = Options
-#
-# all::
-#   Output the docs for all of the reference types. In 'rdoc' modes, this also outputs documentation for all resources
-#
-# help::
-#   Print this help message
-#
-# outputdir::
-#   Specifies the directory where to output the rdoc documentation in 'rdoc' mode.
-#
-# mode::
-#   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 +puppet doc --list+.
-#
-# charset::
-#   Used only in 'rdoc' mode. It sets the charset used in the html files produced.
-#
-# = Example
-#
-#   $ puppet doc -r type > /tmp/type_reference.rst
-# or
-#   $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
-# or
-#   $ puppet doc /etc/puppet/manifests/site.pp
-# or
-#   $ puppet doc -m markdown -r configuration
-#
-# = Author
-#
-# Luke Kanies
-#
-# = Copyright
-#
-# Copyright (c) 2005-2007 Reductive Labs, LLC
-# Licensed under the GNU Public License
-
 require 'puppet/application/doc'
 Puppet::Application[:doc].run
diff --git a/bin/ralsh b/bin/ralsh
index 00a6925a1..a788e354c 100755
--- a/bin/ralsh
+++ b/bin/ralsh
@@ -1,90 +1,4 @@
 #!/usr/bin/env ruby
-# vim: softtabstop=4 shiftwidth=4 expandtab
-#
-# = Synopsis
-#
-# Use the Puppet RAL to directly interact with the system.
-#
-# = Usage
-#
-#   puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
-#                   [-H|--host <host>] [-p|--param <param>] [-t|--types]
-#                   type <name>
-#
-# = Description
-#
-# This command provides simple facilities for converting current system state
-# 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 puppet resource
-# will tell you everything it knows about all instances of that type.  You can
-# optionally specify an instance name, and puppet resource will only describe that single
-# instance.
-#
-# 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.
-#
-# = Options
-#
-# Note that any configuration parameter that's valid in the configuration file
-# is also a valid long argument.  For example, 'ssldir' is a valid configuration
-# parameter, so you can specify '--ssldir <directory>' 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 puppet with
-# '--genconfig'.
-#
-# debug::
-#   Enable full debugging.
-#
-# edit:
-#   Write the results of the query to a file, open the file in an editor,
-#   and read the file back in as an executable Puppet manifest.
-#
-# host:
-#   When specified, connect to the resource server on the named host
-#   and retrieve the list of resouces of the type specified.
-#
-# help:
-#   Print this help message.
-#
-# param:
-#   Add more parameters to be outputted from queries.
-#
-# types:
-#   List all available types.
-#
-# verbose::
-#   Print extra information.
-#
-# = Example
-#
-# This example uses ``puppet resource`` to return Puppet configuration for the user ``luke``::
-#
-#    $ puppet resource user luke
-#    user { 'luke':
-#      home => '/home/luke',
-#      uid => '100',
-#      ensure => 'present',
-#      comment => 'Luke Kanies,,,',
-#      gid => '1000',
-#      shell => '/bin/bash',
-#      groups => ['sysadmin','audio','video','puppet']
-#    }
-#
-# = Author
-#
-# Luke Kanies
-#
-# = Copyright
-#
-# Copyright (c) 2005-2007 Reductive Labs, LLC
-# Licensed under the GNU Public License
 
 require 'puppet/application/resource'
 Puppet::Application[:resource].run