1PUPPETDOC(8)                                                      PUPPETDOC(8)
2
3
4
5Generate  a  reference for all Puppet types. Largely meant for internal Puppet
6Labs use.puppet doc [-a|--all]  [-h|--help]  [-o|--outputdir  rdoc  outputdir]
7[-m|--mode text|pdf|rdoc]
8
9
10
11                    [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [manifest-file]
12
13
14       If  mode is not ´rdoc´, then this command generates a Markdown document
15       describing all installed Puppet types or  all  allowable  arguments  to
16       puppet executables. It is largely meant for internal use and is used to
17       generate the reference document available on the Puppet Labs web site.
18
19       In ´rdoc´ mode, this command generates an html RDoc hierarchy  describ‐
20       ing the manifests that are in ´manifestdir´ and ´modulepath´ configura‐
21       tion directives.  The  generated  documentation  directory  is  doc  by
22       default but can be changed with the ´outputdir´ option.
23
24       If  the command is started with ´manifest-file´ command-line arguments,
25       puppet doc generate a single manifest documentation that is  output  on
26       stdout.all: Output the docs for all of the reference types. In ´rdoc´
27
28
29
30                  modes, this also outputs documentation for all resources
31
32
33
34       help: Print this help message
35
36       outputdir: Specifies the directory where to output the rdoc
37
38
39
40                  documentation in ´rdoc´ mode.
41
42
43
44       mode: Determine the output mode. Valid modes are ´text´, ´trac´,
45
46
47
48                  ´pdf´ and ´rdoc´. The ´pdf´ mode creates PDF formatted files
49                  in the /tmp directory. The default mode is ´text´. In ´rdoc´
50                  mode you must provide ´manifests-path´
51
52
53
54       reference: Build a particular reference. Get a list of references by
55
56
57
58                  running +puppet doc --list+.
59
60
61
62       charset: Used only in ´rdoc´ mode. It sets the charset used in the
63
64
65
66                  html files produced.
67
68
69       $ puppet doc -r type > /tmp/type_reference.rst
70
71       or
72
73       $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
74
75       or
76
77       $ puppet doc /etc/puppet/manifests/site.pp
78
79       or
80
81       $  puppet doc -m pdf -r configurationLuke KaniesCopyright (c) 2005-2007
82       Puppet Labs, LLC Licensed under the GNU Public License
83
84
85
86                                  August 2010                     PUPPETDOC(8)
Impressum