Method: Puppet::Application::Describe#help

Defined in:
lib/puppet/application/describe.rb

#helpObject

API:

  • public



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/puppet/application/describe.rb', line 180

def help
  <<~HELP

    puppet-describe(8) -- #{summary}
    ========

    SYNOPSIS
    --------
    Prints help about Puppet resource types, providers, and metaparameters.


    USAGE
    -----
    puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]


    OPTIONS
    -------
    * --help:
      Print this help text

    * --providers:
      Describe providers in detail for each type

    * --list:
      List all types

    * --meta:
      List all metaparameters

    * --short:
      List only parameters without detail


    EXAMPLE
    -------
        $ puppet describe --list
        $ puppet describe file --providers
        $ puppet describe user -s -m


    AUTHOR
    ------
    David Lutterkort


    COPYRIGHT
    ---------
    Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License

  HELP
end