summaryrefslogtreecommitdiffstats
path: root/bin
diff options
context:
space:
mode:
authorBrice Figureau <brice-puppet@daysofwonder.com>2010-06-06 18:03:18 +0200
committertest branch <puppet-dev@googlegroups.com>2010-02-17 06:50:53 -0800
commit3a44f0e4826b8677323d3c1be55263dfa94f3305 (patch)
treec39e30693935c73a46381316031ab5b7615332a9 /bin
parentfb5c1d7bbe629df6214af9b47e522fb282983beb (diff)
downloadpuppet-3a44f0e4826b8677323d3c1be55263dfa94f3305.tar.gz
puppet-3a44f0e4826b8677323d3c1be55263dfa94f3305.tar.xz
puppet-3a44f0e4826b8677323d3c1be55263dfa94f3305.zip
Fix #3932 - Add --charset to puppetdoc for RDoc mode
This adds the --charset option to puppetdoc for RDoc mode. This allows to set the charset for the generated html. Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
Diffstat (limited to 'bin')
-rwxr-xr-xbin/puppetdoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc
index 849b5338b..400a58251 100755
--- a/bin/puppetdoc
+++ b/bin/puppetdoc
@@ -9,7 +9,7 @@
# = Usage
#
# puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>]
-# [-r|--reference <[type]|configuration|..>] [manifest-file]
+# [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [manifest-file]
#
# = Description
#
@@ -42,6 +42,9 @@
# reference::
# Build a particular reference. Get a list of references by running +puppet doc --list+.
#
+# charset::
+# Used only in 'rdoc' mode. It sets the charset used in the html files produced.
+#
# = Example
#
# $ puppet doc -r type > /tmp/type_reference.rst