nl::ArgParser::HelpOptions

#include <src/lib/support/nlargparser.hpp>

Common OptionSet for handling informational options (help, version).

Summary

Inherits from: nl::ArgParser::OptionSetBase

Constructors and Destructors
`HelpOptions(const char appName, const char appUsage, const char *appVersion)`
`HelpOptions(const char appName, const char appUsage, const char appVersion, const char appDesc)`

Public attributes
`AppDesc`	`const char *` A description of the application's purpose/behavior.
`AppName`	`const char *` The name of the command-line application.
`AppUsage`	`const char *` A short string depicting the application's command-line syntax.
`AppVersion`	`const char *`

Public functions
`HandleOption(const char progName, OptionSet optSet, int id, const char name, const char arg)`	`virtual bool`
`PrintBriefUsage(FILE *s)`	`void` Print a short description of the command's usage followed by instructions on how to get more help.
`PrintLongUsage(OptionSet optSets[], FILE s)`	`void` Print the full usage information, including information on all available options.
`PrintVersion(FILE *s)`	`void`

const char * AppDesc

A description of the application's purpose/behavior.

const char * AppName

The name of the command-line application.

const char * AppUsage

A short string depicting the application's command-line syntax.

const char * AppVersion

virtual bool HandleOption(
  const char *progName,
  OptionSet *optSet,
  int id,
  const char *name,
  const char *arg
)

 HelpOptions(
  const char *appName,
  const char *appUsage,
  const char *appVersion
)

 HelpOptions(
  const char *appName,
  const char *appUsage,
  const char *appVersion,
  const char *appDesc
)

void PrintBriefUsage(
  FILE *s
)

Print a short description of the command's usage followed by instructions on how to get more help.

void PrintLongUsage(
  OptionSet *optSets[],
  FILE *s
)

Print the full usage information, including information on all available options.

void PrintVersion(
  FILE *s
)