File Information
Library: OSP/Shell
Package: Shell
Header: Poco/OSP/Shell/HelpCommand.h
Description
HelpCommand implements the "help" command, with the help of the CommandProcessor.
The help command produces a list of commands known by the CommandProcessor, as well as their aliases.
The output of the command can be customized with the following bundle properties:
- help.header: the header text displayed before the list of commands.
- help.footer: the footer text displayed after the list of commands.
Inheritance
Direct Base Classes: Command
All Base Classes: Command
Member Summary
Member Functions: execute
Inherited Functions: execute
Constructors
HelpCommand
HelpCommand(
Poco::OSP::BundleContext::Ptr pContext,
CommandProcessor & commandProcessor
);
Creates the HelpCommand, using the given command processor.
Destructor
~HelpCommand 
~HelpCommand();
Destroys the HelpCommand.
Member Functions
execute
virtual int execute(
Session & session,
const std::vector < std::string > & args,
std::ostream & ostr
);
See also: Poco::OSP::Shell::Command::execute()