generated with Ronn/v0.7.3
(The comments found at the beginning of the groff file "man8/puppet-man.8".)
- Display Puppet manual pages.
puppet man action
This subcommand displays manual pages for all Puppet subcommands. If the 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.
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
are valid settings, so you can specify --server <servername>
, or --run_mode <runmode>
as an argument.
See the configuration file documentation at docs.puppetlabs.com/references/stable/configuration.html
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.
Whether to log verbosely.
Whether to log debug information.
- man - Display the manual page for a Puppet subcommand.
puppet man subcommand
Display the manual page for a Puppet subcommand.
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'.
View the manual page for a subcommand:
$ puppet man facts
The pager used for display will be the first found of $MANPAGER
, or more
COPYRIGHT AND LICENSE
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING