1PUPPET-DOC(8)                    Puppet manual                   PUPPET-DOC(8)
2
3
4

NAME

6       puppet-doc - Generate Puppet references
7

SYNOPSIS

9       Generates  a reference for all Puppet types. Largely meant for internal
10       Puppet Inc. use. (Deprecated)
11

USAGE

13       puppet doc [-h|--help] [-l|--list] [-r|--reference reference-name]
14

DESCRIPTION

16       This deprecated command generates a Markdown  document  to  stdout  de‐
17       scribing  all installed Puppet types or all allowable arguments to pup‐
18       pet executables. It is largely meant for internal use and  is  used  to
19       generate the reference document available on the Puppet Inc. web site.
20
21       For  Puppet module documentation (and all other use cases) this command
22       has  been   superseded   by   the   "puppet-strings"   module   -   see
23       https://github.com/puppetlabs/puppetlabs-strings for more information.
24
25       This  command (puppet-doc) will be removed once the puppetlabs internal
26       documentation  processing  pipeline  is  completely   based   on   pup‐
27       pet-strings.
28

OPTIONS

30       --help Print this help message
31
32       --reference
33              Build  a  particular reference. Get a list of references by run‐
34              ning ´puppet doc --list´.
35

EXAMPLE

37       $ puppet doc -r type > /tmp/type_reference.markdown
38

AUTHOR

40       Luke Kanies
41

43       Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache  2.0  Li‐
44       cense
45
46
47
48Puppet, Inc.                     October 2023                    PUPPET-DOC(8)
Impressum