GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PUPPET-DOC (8)

NAME

puppet-doc - Generate Puppet references

CONTENTS

SYNOPSIS

Generates a reference for all Puppet types. Largely meant for internal Puppet Labs 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 Labs 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 Labs, LLC Licensed under the Apache 2.0 License
Search for    or go to Top of page |  Section 8 |  Main Index


Puppet Labs, LLC PUPPET-DOC (8) May 2015

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.