popthelp.cpp File Reference

Functions
static void	displayArgs (poptContext con, enum poptCallbackReason, struct poptOption *key, const char *, void *)
static const char *const	getTableTranslationDomain (const struct poptOption *table)
static const char *const	getArgDescrip (const struct poptOption *opt, const char *translation_domain)
static void	singleOptionHelp (FILE *f, int maxLeftCol, const struct poptOption *opt, const char *translation_domain)
static int	maxArgWidth (const struct poptOption *opt, const char *translation_domain)
static void	singleTableHelp (FILE *f, const struct poptOption *table, int left, const char *translation_domain)
static int	showHelpIntro (poptContext con, FILE *f)
void	poptPrintHelp (poptContext con, FILE *f, int)
static int	singleOptionUsage (FILE *f, int cursor, const struct poptOption *opt, const char *translation_domain)
static int	singleTableUsage (FILE *f, int cursor, const struct poptOption *table, const char *translation_domain)
static int	showShortOptions (const struct poptOption *opt, FILE *f, char *str)
void	poptPrintUsage (poptContext con, FILE *f, int)
void	poptSetOtherOptionHelp (poptContext con, const char *text)

Variables
struct poptOption	poptHelpOptions []

Function Documentation

displayArgs()

static void displayArgs ( poptContext  con, enum  poptCallbackReason, struct poptOption *  key, const char *  , void *    )

static

References poptPrintHelp(), poptPrintUsage(), and poptOption::shortName.

getArgDescrip()

static const char* const getArgDescrip ( const struct poptOption *  opt, const char *  translation_domain  )

static

References poptOption::argDescrip, poptOption::argInfo, D_, POPT_, POPT_ARG_MASK, and poptHelpOptions.

Referenced by maxArgWidth(), singleOptionHelp(), and singleOptionUsage().

getTableTranslationDomain()

static const char* const getTableTranslationDomain ( const struct poptOption *  table )

static

References poptOption::arg, poptOption::argInfo, poptOption::longName, POPT_ARG_INTL_DOMAIN, and poptOption::shortName.

Referenced by singleTableHelp().

maxArgWidth()

static int maxArgWidth ( const struct poptOption *  opt, const char *  translation_domain  )

static

References poptOption::arg, poptOption::argInfo, getArgDescrip(), poptOption::longName, max, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_ARGFLAG_DOC_HIDDEN, and poptOption::shortName.

Referenced by poptPrintHelp().

poptPrintHelp()

void poptPrintHelp	(	poptContext	con,
		FILE *	f,
		int	flags
	)

References maxArgWidth(), poptContext_s::options, poptContext_s::otherHelp, POPT_, showHelpIntro(), and singleTableHelp().

Referenced by displayArgs().

poptPrintUsage()

void poptPrintUsage	(	poptContext	con,
		FILE *	f,
		int	flags
	)

References poptContext_s::options, poptContext_s::otherHelp, showHelpIntro(), showShortOptions(), and singleTableUsage().

Referenced by displayArgs().

poptSetOtherOptionHelp()

void poptSetOtherOptionHelp	(	poptContext	con,
		const char *	text
	)

References poptContext_s::otherHelp, xfree, and xstrdup().

showHelpIntro()

static int showHelpIntro ( poptContext  con, FILE *  f  )

static

References optionStackEntry::argv, poptContext_s::flags, len, poptContext_s::optionStack, POPT_, and POPT_CONTEXT_KEEP_FIRST.

Referenced by poptPrintHelp(), and poptPrintUsage().

showShortOptions()

static int showShortOptions ( const struct poptOption *  opt, FILE *  f, char *  str  )

static

References poptOption::arg, poptOption::argInfo, poptOption::longName, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, and poptOption::shortName.

Referenced by poptPrintUsage().

singleOptionHelp()

static void singleOptionHelp ( FILE *  f, int  maxLeftCol, const struct poptOption *  opt, const char *  translation_domain  )

static

References poptOption::argDescrip, D_, poptOption::descrip, getArgDescrip(), poptOption::longName, and poptOption::shortName.

Referenced by singleTableHelp().

singleOptionUsage()

static int singleOptionUsage ( FILE *  f, int  cursor, const struct poptOption *  opt, const char *  translation_domain  )

static

References poptOption::argDescrip, poptOption::argInfo, getArgDescrip(), len, poptOption::longName, POPT_ARG_MASK, and poptOption::shortName.

Referenced by singleTableUsage().

singleTableHelp()

static void singleTableHelp ( FILE *  f, const struct poptOption *  table, int  left, const char *  translation_domain  )

static

References poptOption::arg, poptOption::argInfo, D_, poptOption::descrip, getTableTranslationDomain(), poptOption::longName, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_ARGFLAG_DOC_HIDDEN, poptOption::shortName, and singleOptionHelp().

Referenced by poptPrintHelp().

singleTableUsage()

static int singleTableUsage ( FILE *  f, int  cursor, const struct poptOption *  table, const char *  translation_domain  )

static

References poptOption::arg, poptOption::argInfo, poptOption::longName, POPT_ARG_INCLUDE_TABLE, POPT_ARG_INTL_DOMAIN, POPT_ARG_MASK, POPT_ARGFLAG_DOC_HIDDEN, poptOption::shortName, and singleOptionUsage().

Referenced by poptPrintUsage().

Variable Documentation

poptHelpOptions

struct poptOption poptHelpOptions[]

Initial value:

= {
    { NULL, '\0', POPT_ARG_CALLBACK, (void *)&displayArgs, '\0', NULL, NULL },
    { "help", '?', 0, NULL, '?', N_("Show this help message"), NULL },
    { "usage", 'u', 0, NULL, 'u', N_("Display brief usage message"), NULL },
    { NULL, '\0', 0, NULL, 0, NULL, NULL }
}

Referenced by getArgDescrip().