Public Types | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::CommandLine::ShowHelp Class Reference


Functor to print the Unix man page.

This functor, when applied, creates a Unix manual page from available documentation in the parser, and then invokes standard Unix commands to format the text and page it to standard output. Strange things might happen if standard input is not the terminal, since the pager will probably be expecting to read commands from standard input.

Definition at line 1674 of file util/Sawyer/CommandLine.h.

#include <util/Sawyer/CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::ShowHelp:
Inheritance graph
Collaboration diagram for Sawyer::CommandLine::ShowHelp:
Collaboration graph

Public Types

typedef SharedPointer< ShowHelpPtr
 Reference counting pointer for this class. More...
- Public Types inherited from Sawyer::CommandLine::SwitchAction
typedef SharedPointer< SwitchActionPtr
 Reference counting pointer for this class. More...

Static Public Member Functions

static Ptr instance ()
 Allocating constructor. More...

Protected Member Functions

 ShowHelp ()
 Constructor for derived classes. More...
virtual void operator() (const ParserResult &)

Additional Inherited Members

- Public Member Functions inherited from Sawyer::CommandLine::SwitchAction
void run (const ParserResult &parserResult)
 Runs the action. More...
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 SharedObject (const SharedObject &)
 Copy constructor. More...
virtual ~SharedObject ()
 Virtual destructor. More...
SharedObjectoperator= (const SharedObject &)
 Assignment. More...

Member Typedef Documentation

Reference counting pointer for this class.

Definition at line 1680 of file util/Sawyer/CommandLine.h.

Constructor & Destructor Documentation

Sawyer::CommandLine::ShowHelp::ShowHelp ( )

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1677 of file util/Sawyer/CommandLine.h.

Member Function Documentation

static Ptr Sawyer::CommandLine::ShowHelp::instance ( )

Allocating constructor.

Returns a pointer to a new ShowHelp object. Uses will most likely want to use the showHelp factory instead, which requires less typing.

See also
Command line action factories, and the SwitchAction class.

Definition at line 1686 of file util/Sawyer/CommandLine.h.

The documentation for this class was generated from the following file: