Poster of Linux kernelThe best gift for a Linux geek


Section: (8) Updated: August 2010
Local index Up
Generate a reference for all Puppet types. Largely meant for internal Puppet Labs use.puppet doc [-a|--all] [-h|--help] [-o|--outputdir rdoc outputdir] [-m|--mode text|pdf|rdoc]

         [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [manifest-file]
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.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' 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.
$ puppet doc -r type > /tmp/type_reference.rst


$ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests


$ puppet doc /etc/puppet/manifests/site.pp


$ puppet doc -m pdf -r configurationLuke KaniesCopyright (c) 2005-2007 Puppet Labs, LLC Licensed under the GNU Public License

This document was created by man2html, using the manual pages.
Time: 22:02:12 GMT, April 16, 2011