()

NAME
 -

SYNOPSIS
Generate a reference for all Puppet types. Largely meant for internal Reductive 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 '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.

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', 'trac',
    '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'

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 Reductive Labs, LLC Licensed under the GNU Public License