1PUPPET-MAN(8)                    Puppet manual                   PUPPET-MAN(8)
2
3
4

NAME

6       puppet-man - Display Puppet manual pages.
7

SYNOPSIS

9       puppet man action
10

DESCRIPTION

12       Please  use  the command ´puppet help subcommand´ or the system manpage
13       system ´man puppet-subcommand´ to display information about Puppet sub‐
14       commands.  The  deprecated man subcommand displays manual pages for all
15       Puppet subcommands. If the ronn gem (https://github.com/rtomayko/ronn/)
16       is  installed  on  your system, puppet man will display fully-formatted
17       man pages. If ronn is not available, puppet man will  display  the  raw
18       (but human-readable) source text in a pager.
19

OPTIONS

21       Note  that any setting that´s valid in the configuration file is also a
22       valid long argument, although it may or may  not  be  relevant  to  the
23       present action. For example, server and run_mode are valid settings, so
24       you can specify --server <servername>, or --run_mode  <runmode>  as  an
25       argument.
26
27       See    the    configuration    file   documentation   at   https://pup‐
28       pet.com/docs/puppet/latest/configuration.html  for  the  full  list  of
29       acceptable  parameters.  A  commented list of all configuration options
30       can also be generated by running puppet with --genconfig.
31
32       --render-as FORMAT
33              The format in which to render output. The  most  common  formats
34              are  json, s (string), yaml, and console, but other options such
35              as dot are sometimes available.
36
37       --verbose
38              Whether to log verbosely.
39
40       --debug
41              Whether to log debug information.
42

ACTIONS

44       man - Display the manual page for a Puppet subcommand.
45              SYNOPSIS
46
47              puppet man subcommand
48
49              DESCRIPTION
50
51              Display the manual page for a Puppet subcommand.
52
53              RETURNS
54
55              The man data, in Markdown format, suitable  for  consumption  by
56              Ronn.
57
58              RENDERING  ISSUES:  To  skip fancy formatting and output the raw
59              Markdown text (e.g. for use in a  pipeline),  call  this  action
60              with ´--render-as s´.
61

EXAMPLES

63       man
64
65       View the installed manual page for the subcommand ´config´:
66
67       $ man puppet-config
68
69       (Deprecated) View the manual page for the subcommand ´config´:
70
71       $ puppet man config
72

NOTES

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

78       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
79
80
81
82Puppet, Inc.                     January 2019                    PUPPET-MAN(8)
Impressum