puppetdoc (8) - Linux Man Pages

NAME


 

SYNOPSIS

Generate a reference for all Puppet types. Largely meant for internal Puppet Labs use.

USAGE

puppetdoc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>]
[-r|--reference <[type]|configuration|..>] [manifest-file]

DESCRIPTION

If mode is not aqrdocaq, 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 Puppet Labs web site.

In aqrdocaq mode, this command generates an html RDoc hierarchy describing the manifests that are in aqmanifestdiraq and aqmodulepathaq configuration directives. The generated documentation directory is doc by default but can be changed with the aqoutputdiraq option.

If the command is started with aqmanifest-fileaq command-line arguments, puppetdoc generate a single manifest documentation that is output on stdout.

OPTIONS

all: Output the docs for all of the reference types. In aqrdocaq
modes, this also outputs documentation for all resources

help: Print this help message

outputdir: Specifies the directory where to output the rdoc
documentation in aqrdocaq mode.
mode: Determine the output mode. Valid modes are aqtextaq, aqtracaq,
aqpdfaq, aqmarkdownaq and aqrdocaq. The aqpdfaq and aqmarkdownaq modes create PDF or Markdown formatted files in the /tmp directory. Note that aqtracaq mode only works on Puppet Labs servers. The default mode is aqtextaq. In aqrdocaq mode you must provide aqmanifests-pathaq
reference: Build a particular reference. Get a list of references by
running +puppetdoc --list+.

EXAMPLE

$ puppetdoc -r type > /tmp/type_reference.rst

or

$ puppetdoc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests

or

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

or

$ puppetdoc -m markdown -r configuration

AUTHOR

Luke Kanies

COPYRIGHT

Copyright (c) 2005-2007 Puppet Labs, LLC Licensed under the GNU Public License