← Back to branch summary

~ubuntu-branches/ubuntu/trusty/puppet/trusty

« back to all changes in this revision

Viewing changes to lib/puppet/application/doc.rb

  • Committer: Package Import Robot
  • Author(s): Stig Sandbeck Mathisen
  • Date: 2011-10-22 14:08:22 UTC
  • mfrom: (1.1.25) (3.1.32 sid)
  • Revision ID: package-import@ubuntu.com-20111022140822-odxde5lohc45yhuz
Tags: 2.7.6-1
* New upstream release (CVE-2011-3872)
* Remove cherry-picked "groupadd_aix_warning" patch
* Install all new manpages

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/puppet/application/doc.rb
87
87
OPTIONS
88
88
-------
89
89
* --all:
90
 
  Output the docs for all of the reference types. In 'rdoc'
91
 
  modes, this also outputs documentation for all resources
 
90
  Output the docs for all of the reference types. In 'rdoc' mode, this also
 
91
  outputs documentation for all resources.
92
92
 
93
93
* --help:
94
94
  Print this help message
95
95
 
96
96
* --outputdir:
97
 
  Specifies the directory where to output the rdoc
98
 
  documentation in 'rdoc' mode.
 
97
  Used only in 'rdoc' mode. The directory to which the rdoc output should
 
98
  be written.
99
99
 
100
100
* --mode:
101
 
  Determine the output mode. Valid modes are 'text', 'pdf' and
102
 
  'rdoc'. The 'pdf' mode creates PDF formatted files in the
103
 
  /tmp directory. The default mode is 'text'. In 'rdoc' mode
104
 
  you must provide 'manifests-path'
 
101
  Determine the output mode. Valid modes are 'text', 'pdf' and 'rdoc'. The 'pdf'
 
102
  mode creates PDF formatted files in the /tmp directory. The default mode is
 
103
  'text'. In 'rdoc' mode you must provide 'manifests-path'
105
104
 
106
105
* --reference:
107
 
  Build a particular reference. Get a list of references by
108
 
  running 'puppet doc --list'.
 
106
  Build a particular reference. Get a list of references by running
 
107
  'puppet doc --list'.
109
108
 
110
109
* --charset:
111
 
  Used only in 'rdoc' mode. It sets the charset used in the
112
 
  html files produced.
 
110
  Used only in 'rdoc' mode. It sets the charset used in the html files produced.
 
111
 
 
112
* --manifestdir:
 
113
  Used only in 'rdoc' mode. The directory to scan for stand-alone manifests.
 
114
  If not supplied, puppet doc will use the manifestdir from puppet.conf.
 
115
 
 
116
* --modulepath:
 
117
  Used only in 'rdoc' mode. The directory or directories to scan for modules.
 
118
  If not supplied, puppet doc will use the modulepath from puppet.conf.
 
119
 
 
120
* --environment:
 
121
  Used only in 'rdoc' mode. The configuration environment from which
 
122
  to read the modulepath and manifestdir settings, when reading said settings
 
123
  from puppet.conf. Due to a known bug, this option is not currently effective.
113
124
 
114
125
 
115
126
EXAMPLE
241
252
      @unknown_args.each do |option|
242
253
        # force absolute path for modulepath when passed on commandline
243
254
        if option[:opt]=="--modulepath" or option[:opt] == "--manifestdir"
244
 
          option[:arg] = option[:arg].split(':').collect { |p| File.expand_path(p) }.join(':')
 
255
          option[:arg] = option[:arg].split(File::PATH_SEPARATOR).collect { |p| File.expand_path(p) }.join(File::PATH_SEPARATOR)
245
256
        end
246
257
        Puppet.settings.handlearg(option[:opt], option[:arg])
247
258
      end