PUPPET-DOC(8) OpenVox manual PUPPET-DOC(8) NAME puppet-doc - Generate Puppet references for OpenVox SYNOPSIS Generates a reference for all Puppet types. Largely meant for internal 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 executa- bles. It is largely meant for internal use and is used to generate the ref- erence documents which can be posted to a website. 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 doc- umentation 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. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2.0 License Vox Pupuli January 2025 PUPPET-DOC(8)
Want to link to this manual page? Use this URL:
<https://man.FreeBSD.org/cgi/man.cgi?query=puppet-doc&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>