puppet-man man page

puppet-man — Display Puppet manual pages.

Synopsis

puppet man action

Description

This subcommand displays manual pages for all Puppet subcommands. If the ronn gem (https://github.com/rtomayko/ronn/) is installed on your system, puppet man will display fully-formated man pages. If ronn is not available, puppet man will display the raw (but human-readable) source text in a pager.

Options

Note that any setting that´s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action. For example, server and run_mode are valid settings, so you can specify --server <servername>, or --run_mode <runmode> as an argument.

See the configuration file documentation at http://docs.puppetlabs.com/references/s… for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with --genconfig.

--render-as FORMAT
The format in which to render output. The most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available.
--verbose
Whether to log verbosely.
--debug
Whether to log debug information.

Actions

man - Display the manual page for a Puppet subcommand.

Synopsis

puppet man subcommand

Description

Display the manual page for a Puppet subcommand.

RETURNS

The man data, in Markdown format, suitable for consumption by Ronn.

RENDERING ISSUES: To skip fancy formatting and output the raw Markdown text (e.g. for use in a pipeline), call this action with ´--render-as s´.

Examples

man

View the manual page for a subcommand:

$ puppet man facts

Notes

The pager used for display will be the first found of $MANPAGER, $PAGER, less, most, or more.

Info

May 2015 Puppet Labs, LLC Puppet manual