blob: 281b7385e81b4d3a384726ebdf9426072e7c4638 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
.TH "" "" ""
.SH NAME
\-
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
Generate a reference for all Puppet types. Largely meant for internal
Reductive Labs use.
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>]
.
[\-r|\-\-reference <[type]|configuration|..>] [\-\-charset CHARSET] [manifest\-file]
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
If mode is not \(aqrdoc\(aq, then this command generates a restructured\-text
document describing all installed Puppet types or all allowable
arguments to puppet executables. It is largely meant for internal use
and is used to generate the reference document available on the
Reductive Labs web site.
.sp
In \(aqrdoc\(aq mode, this command generates an html RDoc hierarchy describing
the manifests that are in \(aqmanifestdir\(aq and \(aqmodulepath\(aq configuration
directives. The generated documentation directory is doc by default but
can be changed with the \(aqoutputdir\(aq option.
.sp
If the command is started with \(aqmanifest\-file\(aq command\-line arguments,
puppet doc generate a single manifest documentation that is output on
stdout.
.SH OPTIONS
.INDENT 0.0
.TP
.B all: Output the docs for all of the reference types. In \(aqrdoc\(aq
.
modes, this also outputs documentation for all resources
.UNINDENT
.sp
help: Print this help message
.INDENT 0.0
.TP
.B outputdir: Specifies the directory where to output the rdoc
.
documentation in \(aqrdoc\(aq mode.
.TP
.B mode: Determine the output mode. Valid modes are \(aqtext\(aq, \(aqtrac\(aq,
.
\(aqpdf\(aq, \(aqmarkdown\(aq and \(aqrdoc\(aq. The \(aqpdf\(aq and \(aqmarkdown\(aq modes
create PDF or Markdown formatted files in the /tmp directory.
Note that \(aqtrac\(aq mode only works on Reductive Labs servers.
The default mode is \(aqtext\(aq. In \(aqrdoc\(aq mode you must provide
\(aqmanifests\-path\(aq
.TP
.B reference: Build a particular reference. Get a list of references by
.
running +puppet doc \-\-list+.
.TP
.B charset: Used only in \(aqrdoc\(aq mode. It sets the charset used in the
.
html files produced.
.UNINDENT
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
.sp
$ puppet doc \-r type > /tmp/type_reference.rst
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
$ puppet doc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
$ puppet doc /etc/puppet/manifests/site.pp
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
$ puppet doc \-m markdown \-r configuration
.UNINDENT
.UNINDENT
.SH AUTHOR
.sp
Luke Kanies
.SH COPYRIGHT
.sp
Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
Public License
.\" Generated by docutils manpage writer.
.\"
.
|
