Sha256: 6e835dd6efa0faeec30c8c034d2374447ae36da8a7b989118dee05bf8e36d966

Contents?: true

Size: 1.42 KB

Versions: 24

Compression:

Stored size: 1.42 KB

Contents

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-DOC" "8" "April 2019" "Puppet, Inc." "Puppet manual"
.
.SH "NAME"
\fBpuppet\-doc\fR \- Generate Puppet references
.
.SH "SYNOPSIS"
Generates a reference for all Puppet types\. Largely meant for internal Puppet Inc\. use\. (Deprecated)
.
.SH "USAGE"
puppet doc [\-h|\-\-help] [\-l|\-\-list] [\-r|\-\-reference \fIreference\-name\fR]
.
.SH "DESCRIPTION"
This deprecated command generates a Markdown document to stdout 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 Puppet Inc\. web site\.
.
.P
For Puppet module documentation (and all other use cases) this command has been superseded by the "puppet\-strings" module \- see https://github\.com/puppetlabs/puppetlabs\-strings for more information\.
.
.P
This command (puppet\-doc) will be removed once the puppetlabs internal documentation processing pipeline is completely based on puppet\-strings\.
.
.SH "OPTIONS"
.
.TP
\-\-help
Print this help message
.
.TP
\-\-reference
Build a particular reference\. Get a list of references by running \'puppet doc \-\-list\'\.
.
.SH "EXAMPLE"
.
.nf

$ puppet doc \-r type > /tmp/type_reference\.markdown
.
.fi
.
.SH "AUTHOR"
Luke Kanies
.
.SH "COPYRIGHT"
Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

Version data entries

24 entries across 24 versions & 1 rubygems

Version Path
puppet-6.4.2 man/man8/puppet-doc.8
puppet-6.4.2-x86-mingw32 man/man8/puppet-doc.8
puppet-6.4.2-x64-mingw32 man/man8/puppet-doc.8
puppet-6.4.2-universal-darwin man/man8/puppet-doc.8
puppet-6.0.9 man/man8/puppet-doc.8
puppet-6.0.9-x86-mingw32 man/man8/puppet-doc.8
puppet-6.0.9-x64-mingw32 man/man8/puppet-doc.8
puppet-6.0.9-universal-darwin man/man8/puppet-doc.8
puppet-5.5.14 man/man8/puppet-doc.8
puppet-5.5.14-x86-mingw32 man/man8/puppet-doc.8
puppet-5.5.14-x64-mingw32 man/man8/puppet-doc.8
puppet-5.5.14-universal-darwin man/man8/puppet-doc.8
puppet-6.4.1 man/man8/puppet-doc.8
puppet-6.4.1-x86-mingw32 man/man8/puppet-doc.8
puppet-6.4.1-x64-mingw32 man/man8/puppet-doc.8
puppet-6.4.1-universal-darwin man/man8/puppet-doc.8
puppet-6.0.8 man/man8/puppet-doc.8
puppet-6.0.8-x86-mingw32 man/man8/puppet-doc.8
puppet-6.0.8-x64-mingw32 man/man8/puppet-doc.8
puppet-6.0.8-universal-darwin man/man8/puppet-doc.8