diff options
Diffstat (limited to 'man/man8/puppet-help.8')
-rw-r--r-- | man/man8/puppet-help.8 | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/man/man8/puppet-help.8 b/man/man8/puppet-help.8 new file mode 100644 index 000000000..0f22ca887 --- /dev/null +++ b/man/man8/puppet-help.8 @@ -0,0 +1,71 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-HELP" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-help\fR \- Display Puppet help\. +. +.SH "SYNOPSIS" +puppet help \fIaction\fR +. +.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 +\fBhelp\fR \- Display help about Puppet subcommands and their actions\. +\fBSYNOPSIS\fR +. +.IP +puppet help [\-\-version VERSION] [\fIsubcommand\fR] [\fIaction\fR] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Display help about Puppet subcommands and their actions\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-version VERSION\fR \- The version of the subcommand for which to show help\. +. +.IP +\fBRETURNS\fR +. +.IP +Short help text for the specified subcommand or action\. +. +.SH "EXAMPLES" +\fBhelp\fR +. +.P +Get help for an action: +. +.P +$ puppet help +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING |