PUPPET-DOC(8) Puppet manual PUPPET-DOC(8)NAME
puppet-doc - Generate Puppet documentation and references
SYNOPSIS
Generates a reference for all Puppet types. Largely meant for internal Puppet Labs use.
USAGE
puppet doc [-a|--all] [-h|--help] [-o|--outputdir rdoc-outputdir] [-m|--mode text|pdf|rdoc] [-r|--reference reference-name] [--charset
charset] [manifest-file]
DESCRIPTION
If mode is not 'rdoc', then this command generates a Markdown 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 Puppet Labs web
site.
In 'rdoc' mode, this command generates an html RDoc hierarchy describing the manifests that are in 'manifestdir' and 'modulepath' configu-
ration directives. The generated documentation directory is doc by default but can be changed with the 'outputdir' option.
If the command is run with the name of a manifest file as an argument, puppet doc will output a single manifest's documentation on stdout.
OPTIONS --all Output the docs for all of the reference types. In 'rdoc' mode, this also outputs documentation for all resources.
--help Print this help message
--outputdir
Used only in 'rdoc' mode. The directory to which the rdoc output should be written.
--mode Determine the output mode. Valid modes are 'text', 'pdf' and 'rdoc'. The 'pdf' mode creates PDF formatted files in the /tmp direc-
tory. The default mode is 'text'. In 'rdoc' mode you must provide 'manifests-path'
--reference
Build a particular reference. Get a list of references by running 'puppet doc --list'.
--charset
Used only in 'rdoc' mode. It sets the charset used in the html files produced.
--manifestdir
Used only in 'rdoc' mode. The directory to scan for stand-alone manifests. If not supplied, puppet doc will use the manifestdir from
puppet.conf.
--modulepath
Used only in 'rdoc' mode. The directory or directories to scan for modules. If not supplied, puppet doc will use the modulepath from
puppet.conf.
--environment
Used only in 'rdoc' mode. The configuration environment from which to read the modulepath and manifestdir settings, when reading
said settings from puppet.conf. Due to a known bug, this option is not currently effective.
EXAMPLE
$ puppet doc -r type > /tmp/type_reference.markdown
or
$ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
or
$ puppet doc /etc/puppet/manifests/site.pp
or
$ puppet doc -m pdf -r configuration
AUTHOR
Luke Kanies
COPYRIGHT
Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
Puppet Labs, LLC June 2012 PUPPET-DOC(8)
Check Out this Related Man Page
PUPPET-RESOURCE(8) Puppet manual PUPPET-RESOURCE(8)NAME
puppet-resource - The resource abstraction layer shell
SYNOPSIS
Uses the Puppet RAL to directly interact with the system.
USAGE
puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit] [-H|--host host] [-p|--param parameter] [-t|--types] type [name]
[attribute=value ...]
DESCRIPTION
This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current
state using Puppet's RAL.
By default, you must at least provide a type to list, in which case puppet resource will tell you everything it knows about all resources
of that type. You can optionally specify an instance name, and puppet resource will only describe that single instance.
If given a type, a name, and a series of attribute=value pairs, puppet resource will modify the state of the specified resource. Alter-
nately, if given a type, a name, and the '--edit' flag, puppet resource will write its output to a file, open that file in an editor, and
then apply the saved file as a Puppet transaction.
OPTIONS
Note that any configuration parameter that's valid in the configuration file is also a valid long argument. For example, 'ssldir' is a
valid configuration parameter, so you can specify '--ssldir directory' as an argument.
See the configuration file documentation at http://docs.puppetlabs.com/references/stable/configuration.html for the full list of acceptable
parameters. A commented list of all configuration options can also be generated by running puppet with '--genconfig'.
--debug
Enable full debugging.
--edit Write the results of the query to a file, open the file in an editor, and read the file back in as an executable Puppet manifest.
--host When specified, connect to the resource server on the named host and retrieve the list of resouces of the type specified.
--help Print this help message.
--param
Add more parameters to be outputted from queries.
--types
List all available types.
--verbose
Print extra information.
EXAMPLE
This example uses puppet resource to return a Puppet configuration for the user luke:
$ puppet resource user luke
user { 'luke':
home => '/home/luke',
uid => '100',
ensure => 'present',
comment => 'Luke Kanies,,,',
gid => '1000',
shell => '/bin/bash',
groups => ['sysadmin','audio','video','puppet']
}
AUTHOR
Luke Kanies
COPYRIGHT
Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
Puppet Labs, LLC June 2012 PUPPET-RESOURCE(8)