Methods

Archive::Tar::Minitar::Command::CommandHelp

Public Instance Methods

call(args, opts = {}, ioe = {}) click to toggle source
     # File lib/archive/tar/minitar/command.rb, line 312
312:     def call(args, opts = {}, ioe = {})
313:       ioe = CommandPattern.default_ioe(ioe)
314: 
315:       help_on = args.shift
316: 
317:       if CommandPattern.command?(help_on)
318:         ioe[:output] << CommandPattern[help_on].help
319:       elsif help_on == "commands"
320:         ioe[:output] << The commands known to minitar are:    minitar create          Creates a new tarfile.    minitar extract         Extracts files from a tarfile.    minitar list            Lists files in the tarfile.All commands accept the options --verbose and --progress, which aremutually exclusive. In "minitar list", --progress means the same as--verbose.  --verbose, -V     Performs the requested command verbosely.  --progress, -P    Shows a progress bar, if appropriate, for the action                    being performed.
321:       else
322:         ioe[:output] << "Unknown command: #{help_on}\n" unless help_on.nil? or help_on.empty?
323:         ioe[:output] << self.help
324:       end
325: 
326:       0
327:     end
help() click to toggle source
     # File lib/archive/tar/minitar/command.rb, line 344
344:     def help
345:       help = This is a basic help message containing pointers to more information onhow to use this command-line tool. Try:    minitar help commands       list all 'minitar' commands    minitar help <COMMAND>      show help on <COMMAND>                                  (e.g., 'minitar help create')
346:     end
name() click to toggle source
     # File lib/archive/tar/minitar/command.rb, line 308
308:     def name
309:       "help"
310:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.