(8)

NAME

SYNOPSIS

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

USAGE

puppetdoc [-a|--all] [-h|--help] [-m|--mode <text|pdf|trac> [-r|--reference <[type]|configuration|..>]

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.

OPTIONS

all: Output the docs for all of the reference types.

help: Print this help message

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´.

reference: Build a particular reference. Get a list of references by

running +puppetdoc --list+.

EXAMPLE

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

AUTHOR

Luke Kanies

COPYRIGHT

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

()