Name

App::Sqitch::Command::help - Display help information about Sqitch

Synopsis

my $cmd = App::Sqitch::Command::help->new(%params);
$cmd->execute;

Description

If you want to know how to use the help command, you probably want to be reading sqitch-help. But if you really want to know how the help command works, read on.

Interface

Attributes

guide

Boolean indicating whether to list the guides.

Instance Methods

execute

$help->execute($command);

Executes the help command. If a command is passed, the help for that command will be shown. If it cannot be found, Sqitch will throw an error and exit. If no command is specified, the Sqitch core documentation will be shown.

find_and_show

$help->find_and_show($file, %options);

Does the work of finding the pod file $file and passing it on to Pod::Usage, along with any additional options for Pod::Usage's constructor.

See Also

sqitch-help

Documentation for the help command to the Sqitch command-line client.

sqitch

The Sqitch command-line client.

Author

David E. Wheeler <david@justatheory.com>

License

Copyright (c) 2012-2024 iovation Inc., David E. Wheeler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.