puppet-doc man page

puppet-doc — Generate Puppet references

Synopsis

Generates a reference for all Puppet types. Largely meant for internal Puppet Labs use. (Deprecated)

Usage

puppet doc [-h|--help] [-l|--list] [-r|--reference reference-name]

Description

This deprecated command generates a Markdown document to stdout 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.

For Puppet module documentation (and all other use cases) this command has been superseded by the "puppet-strings" module - see https://github.com/puppetlabs/puppetlab… for more information.

This command (puppet-doc) will be removed once the puppetlabs internal documentation processing pipeline is completely based on puppet-strings.

Options

--help
Print this help message
--reference
Build a particular reference. Get a list of references by running ´puppet doc --list´.

Example

$ puppet doc -r type > /tmp/type_reference.markdown

Author

Luke Kanies

Info

May 2015 Puppet Labs, LLC Puppet manual