diff options
Diffstat (limited to 'man/man8/puppetdoc.8')
| -rw-r--r-- | man/man8/puppetdoc.8 | 79 |
1 files changed, 34 insertions, 45 deletions
diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8 index e6b6a339e..5cf7269f0 100644 --- a/man/man8/puppetdoc.8 +++ b/man/man8/puppetdoc.8 @@ -2,114 +2,103 @@ .SH NAME \- .\" Man page generated from reStructeredText. - +. .SH SYNOPSIS +.sp Generate a reference for all Puppet types. Largely meant for internal Reductive Labs use. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 - .TP .B puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>] +. [\-r|\-\-reference <[type]|configuration|..>] [manifest\-file] - .UNINDENT .UNINDENT .UNINDENT - .SH DESCRIPTION -If mode is not \'rdoc\', then this command generates a restructured\-text +.sp +If mode is not \(aqrdoc\(aq, 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 +.sp +In \(aqrdoc\(aq mode, this command generates an html RDoc hierarchy describing +the manifests that are in \(aqmanifestdir\(aq and \(aqmodulepath\(aq 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, +can be changed with the \(aqoutputdir\(aq option. +.sp +If the command is started with \(aqmanifest\-file\(aq command\-line arguments, puppetdoc generate a single manifest documentation that is output on stdout. - - .SH OPTIONS .INDENT 0.0 - .TP -.B all: Output the docs for all of the reference types. In \'rdoc\' +.B all: Output the docs for all of the reference types. In \(aqrdoc\(aq +. modes, this also outputs documentation for all resources - .UNINDENT +.sp help: Print this help message - .INDENT 0.0 - .TP .B outputdir: Specifies the directory where to output the rdoc -documentation in \'rdoc\' mode. - - +. +documentation in \(aqrdoc\(aq mode. .TP -.B mode: Determine the output mode. Valid modes are \'text\', \'trac\', -\'pdf\', \'markdown\' and \'rdoc\'. The \'pdf\' and \'markdown\' modes +.B mode: Determine the output mode. Valid modes are \(aqtext\(aq, \(aqtrac\(aq, +. +\(aqpdf\(aq, \(aqmarkdown\(aq and \(aqrdoc\(aq. The \(aqpdf\(aq and \(aqmarkdown\(aq 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\' - - +Note that \(aqtrac\(aq mode only works on Reductive Labs servers. +The default mode is \(aqtext\(aq. In \(aqrdoc\(aq mode you must provide +\(aqmanifests\-path\(aq .TP .B reference: Build a particular reference. Get a list of references by +. running +puppetdoc \-\-list+. - .UNINDENT - .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 +.sp $ puppetdoc \-r type > /tmp/type_reference.rst - .UNINDENT .UNINDENT +.sp or - .INDENT 0.0 .INDENT 3.5 +.sp $ puppetdoc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests - .UNINDENT .UNINDENT +.sp or - .INDENT 0.0 .INDENT 3.5 +.sp $ puppetdoc /etc/puppet/manifests/site.pp - .UNINDENT .UNINDENT +.sp or - .INDENT 0.0 .INDENT 3.5 +.sp $ puppetdoc \-m markdown \-r configuration - .UNINDENT .UNINDENT - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:24. +.\" Generated by docutils manpage writer. .\" +. |