blob: 8303b7ae099374f3989748049b72191d0cb89eb8 (
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
|
.TH "" "" ""
.SH NAME
\-
.\" Man page generated from reStructeredText.
.SH SYNOPSIS
Generate a reference for all Puppet types. Largely meant for internal
Reductive Labs use.
.SH USAGE
.\" visit_block_quote
puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-m|\-\-mode <text|pdf|trac> [\-r|\-\-reference <[type]|configuration|..>]
.\" depart_block_quote
.SH DESCRIPTION
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.
.SH OPTIONS
all: Output the docs for all of the reference types.
help: Print this help message
.TP
.B mode: Determine the output mode. Valid modes are \'text\', \'trac\',
and \'pdf\'. Note that \'trac\' mode only works on Reductive Labs
servers. The default mode is \'text\'.
.TP
.B reference: Build a particular reference. Get a list of references by
running +puppetdoc \-\-list+.
.SH EXAMPLE
.\" visit_block_quote
$ puppetdoc \-r type > /tmp/type_reference.rst
.\" depart_block_quote
.SH AUTHOR
Luke Kanies
.SH COPYRIGHT
Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
Public License
.\" Generated by docutils manpage writer on 2008-05-05 09:33.
.\"
|
