class Puppet::Application::Describe

    # File lib/puppet/application/describe.rb
181   def help
182     <<-HELP
183 
184 puppet-describe(8) -- #{summary}
185 ========
186 
187 SYNOPSIS
188 --------
189 Prints help about Puppet resource types, providers, and metaparameters.
190 
191 
192 USAGE
193 -----
194 puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
195 
196 
197 OPTIONS
198 -------
199 * --help:
200   Print this help text
201 
202 * --providers:
203   Describe providers in detail for each type
204 
205 * --list:
206   List all types
207 
208 * --meta:
209   List all metaparameters
210 
211 * --short:
212   List only parameters without detail
213 
214 
215 EXAMPLE
216 -------
217     $ puppet describe --list
218     $ puppet describe file --providers
219     $ puppet describe user -s -m
220 
221 
222 AUTHOR
223 ------
224 David Lutterkort
225 
226 
227 COPYRIGHT
228 ---------
229 Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
230 
231     HELP
232   end

    # File lib/puppet/application/describe.rb
238 def main
239   doc = TypeDoc.new
240 
241   if options[:list]
242     doc.list_types
243   else
244     options[:types].each { |name| doc.format_type(name, options) }
245   end
246 end

    # File lib/puppet/application/describe.rb
234 def preinit
235   options[:parameters] = true
236 end

    # File lib/puppet/application/describe.rb
248 def setup
249   options[:types] = command_line.args.dup
250   handle_help(nil) unless options[:list] || options[:types].size > 0
251   $stderr.puts "Warning: ignoring types when listing all types" if options[:list] && options[:types].size > 0
252 end

    # File lib/puppet/application/describe.rb
177 def summary
178   _("Display help about resource types")
179 end