summaryrefslogtreecommitdiffstats
path: root/man/man8/puppet-man.8
diff options
context:
space:
mode:
Diffstat (limited to 'man/man8/puppet-man.8')
-rw-r--r--man/man8/puppet-man.874
1 files changed, 74 insertions, 0 deletions
diff --git a/man/man8/puppet-man.8 b/man/man8/puppet-man.8
new file mode 100644
index 000000000..fe5f375eb
--- /dev/null
+++ b/man/man8/puppet-man.8
@@ -0,0 +1,74 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-MAN" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-man\fR \- Display Puppet manual pages\.
+.
+.SH "SYNOPSIS"
+puppet man \fIaction\fR
+.
+.SH "DESCRIPTION"
+This subcommand displays manual pages for all Puppet subcommands\. If the \fBronn\fR gem (\fIhttps://github\.com/rtomayko/ronn/\fR) is installed on your system, puppet man will display fully\-formated man pages\. If \fBronn\fR is not available, puppet man will display the raw (but human\-readable) source text in a pager\.
+.
+.SH "OPTIONS"
+Note that any configuration parameter 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, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+.
+.P
+See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.
+.TP
+\-\-mode MODE
+The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
+.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.
+.TP
+\-\-debug
+Whether to log debug information\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBman\fR \- Display the manual page for a Puppet subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet man \fIsubcommand\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Display the manual page for a Puppet subcommand\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+The man data, in Markdown format, suitable for consumption by Ronn\.
+.
+.IP
+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\'\.
+.
+.SH "EXAMPLES"
+\fBman\fR
+.
+.P
+View the manual page for a subcommand:
+.
+.P
+$ puppet man facts
+.
+.SH "NOTES"
+The pager used for display will be the first found of \fB$MANPAGER\fR, \fB$PAGER\fR, \fBless\fR, \fBmost\fR, or \fBmore\fR\.
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING