summaryrefslogtreecommitdiffstats
path: root/man/man8/puppetdoc.8
diff options
context:
space:
mode:
Diffstat (limited to 'man/man8/puppetdoc.8')
-rw-r--r--man/man8/puppetdoc.862
1 files changed, 62 insertions, 0 deletions
diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8
new file mode 100644
index 000000000..d7aacee75
--- /dev/null
+++ b/man/man8/puppetdoc.8
@@ -0,0 +1,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-03-22 17:46.
+.\"