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

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

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

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

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

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

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().

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

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

Referenced by poptPrintHelp().

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

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

Referenced by displayArgs().

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

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

Referenced by displayArgs().

void poptSetOtherOptionHelp	(	poptContext	con,
		const char *	text
	)

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

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().

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().

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().

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().

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().

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

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 }
}