diff options
Diffstat (limited to 'man/man8/puppetdoc.8')
| -rw-r--r-- | man/man8/puppetdoc.8 | 89 |
1 files changed, 71 insertions, 18 deletions
diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8 index db6d1d78e..e6b6a339e 100644 --- a/man/man8/puppetdoc.8 +++ b/man/man8/puppetdoc.8 @@ -1,7 +1,6 @@ .TH "" "" "" .SH NAME - \- - + \- .\" Man page generated from reStructeredText. .SH SYNOPSIS @@ -10,44 +9,98 @@ Reductive Labs use. .SH USAGE +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 -.\" visit_block_quote -puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-m|\-\-mode <text|pdf|trac> [\-r|\-\-reference <[type]|configuration|..>] - +.TP +.B puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>] +[\-r|\-\-reference <[type]|configuration|..>] [manifest\-file] -.\" depart_block_quote +.UNINDENT +.UNINDENT +.UNINDENT .SH DESCRIPTION -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. +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, +puppetdoc generate a single manifest documentation that is output on +stdout. .SH OPTIONS -all: Output the docs for all of the reference types. +.INDENT 0.0 + +.TP +.B all: Output the docs for all of the reference types. In \'rdoc\' +modes, this also outputs documentation for all resources +.UNINDENT help: Print this help message +.INDENT 0.0 + +.TP +.B outputdir: Specifies the directory where to output the rdoc +documentation in \'rdoc\' mode. + .TP .B mode: Determine the output mode. Valid modes are \'text\', \'trac\', -and \'pdf\'. Note that \'trac\' mode only works on Reductive Labs -servers. The default mode is \'text\'. +\'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\' .TP .B reference: Build a particular reference. Get a list of references by running +puppetdoc \-\-list+. +.UNINDENT .SH EXAMPLE - -.\" visit_block_quote +.INDENT 0.0 +.INDENT 3.5 $ puppetdoc \-r type > /tmp/type_reference.rst +.UNINDENT +.UNINDENT +or + +.INDENT 0.0 +.INDENT 3.5 +$ puppetdoc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests + +.UNINDENT +.UNINDENT +or + +.INDENT 0.0 +.INDENT 3.5 +$ puppetdoc /etc/puppet/manifests/site.pp + +.UNINDENT +.UNINDENT +or + +.INDENT 0.0 +.INDENT 3.5 +$ puppetdoc \-m markdown \-r configuration -.\" depart_block_quote +.UNINDENT +.UNINDENT .SH AUTHOR Luke Kanies @@ -58,5 +111,5 @@ Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU Public License -.\" Generated by docutils manpage writer on 2008-05-05 09:33. -.\" +.\" Generated by docutils manpage writer on 2009-12-30 19:24. +.\" |