diff options
Diffstat (limited to 'bin')
| -rwxr-xr-x | bin/puppetdoc | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc index 09d0966cd..a69d169c9 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -8,7 +8,7 @@ # # = Usage # -# puppetdoc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|trac|rdoc>] +# puppetdoc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>] # [-r|--reference <[type]|configuration|..>] [manifest-file] # # = Description @@ -37,7 +37,7 @@ # Specifies the directory where to output the rdoc documentation in 'rdoc' mode. # # mode:: -# Determine the output mode. Valid modes are 'text', 'trac', 'pdf' and 'rdoc'. Note that 'trac' mode only works on Reductive Labs servers. The default mode is 'text'. In 'rdoc' mode you must provide 'manifests-path' +# Determine the output mode. Valid modes are 'text', 'trac', 'pdf', 'markdown' and 'rdoc'. The 'pdf' and 'markdown' modes create PDF or Markdown formatted files in the /tmp directory. Note that 'trac' mode only works on Reductive Labs servers. 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 +puppetdoc --list+. @@ -49,6 +49,8 @@ # $ puppetdoc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests # or # $ puppetdoc /etc/puppet/manifests/site.pp +# or +# $ puppetdoc -m markdown -r configuration # # = Author # |