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
|
---
layout: default
built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad
title: 'Man Page: puppet doc'
canonical: "/puppet/latest/man/doc.html"
---
# Man Page: puppet doc
> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700
## NAME
**puppet-doc** - Generate Puppet references
## SYNOPSIS
Generates a reference for all Puppet types. Largely meant for internal
Puppet Inc. use. (Deprecated)
## USAGE
puppet doc \[-h\|\--help\] \[-l\|\--list\] \[-r\|\--reference
*reference-name*\]
## 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.
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.
This command (puppet-doc) will be removed once the puppetlabs internal
documentation processing pipeline is completely based on puppet-strings.
## OPTIONS
\--help
: Print this help message
\--reference
: Build a particular reference. Get a list of references by running
\'puppet doc \--list\'.
## EXAMPLE
$ puppet doc -r type > /tmp/type_reference.markdown
## AUTHOR
Luke Kanies
## COPYRIGHT
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0
License
|
