Maint: move puppet doc --help

2 files changed, 84 insertions, 67 deletions

diff --git a/lib/puppet/application/doc.rb b/lib/puppet/application/doc.rb
index aaefd6e75..c7f270c8d 100644
--- a/lib/puppet/application/doc.rb
+++ b/lib/puppet/application/doc.rb
@@ -50,6 +50,90 @@ class Puppet::Application::Doc < Puppet::Application
     options[:references] << arg.intern
   end
 
+  def help
+    <<-HELP
+
+SYNOPSIS
+========
+Generate a reference for all Puppet types. Largely meant for internal
+Puppet Labs use.
+
+
+USAGE
+=====
+  puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|rdoc>]
+             [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [manifest-file]
+
+
+DESCRIPTION
+===========
+If mode is not 'rdoc', then this command generates a Markdown 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 Puppet 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', 'pdf' and
+           'rdoc'. The 'pdf' mode creates PDF formatted files in the
+           /tmp directory. 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.markdown
+
+or
+
+  $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
+
+or
+
+  $ puppet doc /etc/puppet/manifests/site.pp
+
+or
+
+  $ puppet doc -m pdf -r configuration
+
+
+AUTHOR
+======
+Luke Kanies
+
+
+COPYRIGHT
+=========
+Copyright (c) 2005-2007 Puppet Labs, LLC Licensed under the GNU Public
+License
+
+    HELP
+  end
+
   def handle_unknown( opt, arg )
     @unknown_args << {:opt => opt, :arg => arg }
     true
diff --git a/lib/puppet/util/command_line/puppetdoc b/lib/puppet/util/command_line/puppetdoc
deleted file mode 100755
index 45a9c6518..000000000
--- a/lib/puppet/util/command_line/puppetdoc
+++ /dev/null
@@ -1,67 +0,0 @@
-#!/usr/bin/env ruby
-
-#
-# = Synopsis
-#
-# Generate a reference for all Puppet types.  Largely meant for internal Puppet
-# Labs use.
-#
-# = Usage
-#
-#   puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|rdoc>]
-#              [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [manifest-file]
-#
-# = Description
-#
-# If mode is not 'rdoc', then this command generates a Markdown 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 Puppet 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', 'pdf' and 'rdoc'. The 'pdf' mode creates PDF formatted files in the /tmp directory. 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.markdown
-# or
-#   $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
-# or
-#   $ puppet doc /etc/puppet/manifests/site.pp
-# or
-#   $ puppet doc -m pdf -r configuration
-#
-# = Author
-#
-# Luke Kanies
-#
-# = Copyright
-#
-# Copyright (c) 2005-2007 Puppet Labs, LLC
-# Licensed under the GNU Public License
-
-#Puppet::Application[:doc].run