diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-04-22 13:02:50 -0700 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-05-04 15:57:04 -0700 |
| commit | 855a0ec0deba9fdbaa113260eef8cb8c28e6f5b6 (patch) | |
| tree | 963e335d3dd1190b86bfba8fa9d4bf1c70236f01 | |
| parent | d950921e0dffe3c2f5315e63d86881986d7e4041 (diff) | |
| download | puppet-855a0ec0deba9fdbaa113260eef8cb8c28e6f5b6.tar.gz puppet-855a0ec0deba9fdbaa113260eef8cb8c28e6f5b6.tar.xz puppet-855a0ec0deba9fdbaa113260eef8cb8c28e6f5b6.zip | |
Maint: adjust faces.rb's help to match that of other applications
Faces isn't a face, interestingly, so it doesn't get a summary line in the puppet help.
This will output the appropriately-formatted manpage text using the normal
mechanism.
| -rw-r--r-- | lib/puppet/application/faces.rb | 50 |
1 files changed, 44 insertions, 6 deletions
diff --git a/lib/puppet/application/faces.rb b/lib/puppet/application/faces.rb index 3dd3f0312..e7fce66b1 100644 --- a/lib/puppet/application/faces.rb +++ b/lib/puppet/application/faces.rb @@ -10,16 +10,54 @@ class Puppet::Application::Faces < Puppet::Application Puppet::Util::Log.level = :debug end - option("--help", "-h") do |arg| - puts "Usage: puppet faces [actions|terminuses] -Lists all available faces, and by default includes all available terminuses and actions. -" - end - option("--verbose", "-v") do Puppet::Util::Log.level = :info end + def help + <<-HELP +puppet-faces(8) -- List available Faces and actions +======== + +SYNOPSIS +-------- +Lists the available subcommands (with applicable terminuses and/or actions) +provided by the Puppet Faces API. This information is automatically read +from the Puppet code present on the system. By default, the output includes +all terminuses and actions. + +USAGE +----- +puppet faces [-d|--debug] [-v|--verbose] [actions|terminuses] + +OPTIONS +------- +Note that any configuration option valid in the configuration file is also +a valid long argument. See the configuration file documentation at +http://docs.puppetlabs.com/references/stable/configuration.html for the +full list of acceptable parameters. A commented list of all +configuration options can also be generated by running puppet agent with +'--genconfig'. + +* --verbose: + Sets the log level to "info." This option has no tangible effect at the time + of this writing. + +* --debug: + Sets the log level to "debug." This option has no tangible effect at the time + of this writing. + +AUTHOR +------ +Puppet Labs + +COPYRIGHT +--------- +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License + + HELP + end + def list(*arguments) if arguments.empty? arguments = %w{terminuses actions} |
