Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

popt/popthelp.c File Reference

More...

#include "system.h"
#include "poptint.h"

Go to the source code of this file.

Data Structures

struct  poptDone_s
 Keep track of option tables already processed. More...


Typedefs

typedef poptDone_spoptDone
 Keep track of option tables already processed.


Functions

void displayArgs (poptContext con, enum poptCallbackReason foo, struct poptOption *key, const char *arg, void *data)
 Display arguments.

const char *const getTableTranslationDomain (const struct poptOption *table)
const char *const getArgDescrip (const struct poptOption *opt, const char *translation_domain)
char * singleOptionDefaultValue (int lineLength, const struct poptOption *opt, const char *translation_domain)
 Display default value for an option.

void singleOptionHelp (FILE *fp, int maxLeftCol, const struct poptOption *opt, const char *translation_domain)
 Display help text for an option.

int maxArgWidth (const struct poptOption *opt, const char *translation_domain)
void itemHelp (FILE *fp, poptItem items, int nitems, int left, const char *translation_domain)
 Display popt alias and exec help.

void singleTableHelp (poptContext con, FILE *fp, const struct poptOption *table, int left, const char *translation_domain)
 Display help text for a table of options.

int showHelpIntro (poptContext con, FILE *fp)
void poptPrintHelp (poptContext con, FILE *fp, int flags)
int singleOptionUsage (FILE *fp, int cursor, const struct poptOption *opt, const char *translation_domain)
int itemUsage (FILE *fp, int cursor, poptItem item, int nitems, const char *translation_domain)
 Display popt alias and exec usage.

int singleTableUsage (poptContext con, FILE *fp, int cursor, const struct poptOption *opt, const char *translation_domain, poptDone done)
 Display usage text for a table of options.

int showShortOptions (const struct poptOption *opt, FILE *fp, char *str)
 Return concatenated short options for display.

void poptPrintUsage (poptContext con, FILE *fp, int flags)
void poptSetOtherOptionHelp (poptContext con, const char *text)

Variables

poptOption poptAliasOptions []
 Empty table marker to enable displaying popt alias/exec options.

poptOption poptHelpOptions []
 Auto help table options.


Detailed Description

Definition in file popthelp.c.


Typedef Documentation

typedef struct poptDone_s * poptDone
 

Keep track of option tables already processed.


Function Documentation

void displayArgs poptContext    con,
enum poptCallbackReason    foo,
struct poptOption   key,
const char *    arg,
void *    data
[static]
 

Display arguments.

Parameters:
con  context
foo  (unused)
key  option(s)
arg  (unused)
data  (unused)

Definition at line 23 of file popthelp.c.

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

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

Parameters:
opt  option(s)
translation_domain  translation domain

Definition at line 92 of file popthelp.c.

References poptOption::argDescrip, poptOption::argInfo, D_, POPT_, POPT_ARG_DOUBLE, POPT_ARG_FLOAT, POPT_ARG_INT, POPT_ARG_LONG, POPT_ARG_MASK, POPT_ARG_NONE, POPT_ARG_STRING, and POPT_ARG_VAL.

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

const char* const getTableTranslationDomain const struct poptOption   table [static]
 

Parameters:
table  option(s)

Definition at line 74 of file popthelp.c.

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

Referenced by singleTableHelp().

void itemHelp FILE *    fp,
poptItem    items,
int    nitems,
int    left,
const char *    translation_domain
[static]
 

Display popt alias and exec help.

Parameters:
fp  output file handle
items  alias/exec array
nitems  no. of alias/exec entries
left 
translation_domain  translation domain

Definition at line 414 of file popthelp.c.

References poptOption::argInfo, poptOption::longName, poptItem_s::option, POPT_ARGFLAG_DOC_HIDDEN, poptOption::shortName, and singleOptionHelp().

Referenced by singleTableHelp().

int itemUsage FILE *    fp,
int    cursor,
poptItem    item,
int    nitems,
const char *    translation_domain
[static]
 

Display popt alias and exec usage.

Parameters:
fp  output file handle
cursor 
item  alias/exec array
nitems  no. of ara/exec entries
translation_domain  translation domain

Definition at line 585 of file popthelp.c.

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

Referenced by poptPrintUsage().

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

Parameters:
opt  option(s)
translation_domain  translation domain

Definition at line 369 of file popthelp.c.

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

Referenced by poptPrintHelp().

void poptPrintHelp poptContext    con,
FILE *    fp,
int    flags
 

Print detailed description of options.

Parameters:
con  context
fp  ouput file handle
flags  (unused)

Definition at line 505 of file popthelp.c.

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

Referenced by displayArgs(), and printUsage().

void poptPrintUsage poptContext    con,
FILE *    fp,
int    flags
 

Print terse description of options.

Parameters:
con  context
fp  ouput file handle
flags  (unused)

Definition at line 708 of file popthelp.c.

References poptContext_s::aliases, alloca(), poptContext_s::execs, itemUsage(), poptDone_s::maxopts, poptDone_s::nopts, poptContext_s::numAliases, poptContext_s::numExecs, poptContext_s::options, poptDone_s::opts, poptContext_s::otherHelp, showHelpIntro(), showShortOptions(), and singleTableUsage().

Referenced by displayArgs(), and printUsage().

void poptSetOtherOptionHelp poptContext    con,
const char *    text
 

Provide text to replace default "[OPTION...]" in help/usage output.

Parameters:
con  context
text  replacement text

Definition at line 736 of file popthelp.c.

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

int showHelpIntro poptContext    con,
FILE *    fp
[static]
 

Parameters:
con  context
fp  output file handle

Definition at line 482 of file popthelp.c.

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

Referenced by poptPrintHelp(), and poptPrintUsage().

int showShortOptions const struct poptOption   opt,
FILE *    fp,
char *    str
[static]
 

Return concatenated short options for display.

Todo:
Sub-tables should be recursed.
Parameters:
opt  option(s)
fp  output file handle
Return values:
str  concatenation of short options
Returns:
length of display string

Definition at line 679 of file popthelp.c.

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

Referenced by poptPrintUsage().

char* singleOptionDefaultValue int    lineLength,
const struct poptOption   opt,
const char *    translation_domain
[static]
 

Display default value for an option.

Parameters:
lineLength 
opt  option(s)
translation_domain  translation domain
Returns:

Definition at line 129 of file popthelp.c.

References _free(), poptOption::arg, poptOption::argInfo, D_, POPT_ARG_DOUBLE, POPT_ARG_FLOAT, POPT_ARG_INT, POPT_ARG_LONG, POPT_ARG_MASK, POPT_ARG_NONE, POPT_ARG_STRING, and POPT_ARG_VAL.

Referenced by singleOptionHelp().

void singleOptionHelp FILE *    fp,
int    maxLeftCol,
const struct poptOption   opt,
const char *    translation_domain
[static]
 

Display help text for an option.

Parameters:
fp  output file handle
maxLeftCol 
opt  option(s)
translation_domain  translation domain

Definition at line 200 of file popthelp.c.

References _free(), poptOption::argDescrip, poptOption::argInfo, D_, poptOption::descrip, getArgDescrip(), poptOption::longName, ops, POPT_ARG_DOUBLE, POPT_ARG_FLOAT, POPT_ARG_INT, POPT_ARG_LONG, POPT_ARG_MASK, POPT_ARG_NONE, POPT_ARG_STRING, POPT_ARG_VAL, POPT_ARGFLAG_AND, POPT_ARGFLAG_LOGICALOPS, POPT_ARGFLAG_NOT, POPT_ARGFLAG_ONEDASH, POPT_ARGFLAG_OPTIONAL, POPT_ARGFLAG_OR, POPT_ARGFLAG_SHOW_DEFAULT, POPT_ARGFLAG_XOR, poptOption::shortName, singleOptionDefaultValue(), and poptOption::val.

Referenced by itemHelp(), and singleTableHelp().

int singleOptionUsage FILE *    fp,
int    cursor,
const struct poptOption   opt,
const char *    translation_domain
[static]
 

Parameters:
fp  output file handle
cursor 
opt  option(s)
translation_domain  translation domain

Definition at line 525 of file popthelp.c.

References poptOption::argInfo, getArgDescrip(), poptOption::longName, POPT_ARGFLAG_ONEDASH, and poptOption::shortName.

Referenced by itemUsage(), and singleTableUsage().

void singleTableHelp poptContext    con,
FILE *    fp,
const struct poptOption   table,
int    left,
const char *    translation_domain
[static]
 

Display help text for a table of options.

Parameters:
con  context
fp  output file handle
table  option(s)
left 
translation_domain  translation domain

Definition at line 441 of file popthelp.c.

References poptContext_s::aliases, poptOption::arg, poptOption::argInfo, D_, poptOption::descrip, poptContext_s::execs, getTableTranslationDomain(), itemHelp(), poptOption::longName, poptContext_s::numAliases, poptContext_s::numExecs, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_ARGFLAG_DOC_HIDDEN, poptOption::shortName, and singleOptionHelp().

Referenced by poptPrintHelp().

int singleTableUsage poptContext    con,
FILE *    fp,
int    cursor,
const struct poptOption   opt,
const char *    translation_domain,
poptDone    done
[static]
 

Display usage text for a table of options.

Parameters:
con  context
fp  output file handle
cursor 
opt  option(s)
translation_domain  translation domain
done  tables already processed
Returns:

Definition at line 628 of file popthelp.c.

References poptOption::arg, poptOption::argInfo, poptOption::longName, poptDone_s::maxopts, poptDone_s::nopts, poptDone_s::opts, 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 poptAliasOptions[]
 

Initial value:

Empty table marker to enable displaying popt alias/exec options.

Definition at line 46 of file popthelp.c.

struct poptOption poptHelpOptions[]
 

Initial value:

 {



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




    POPT_TABLEEND
}
Auto help table options.

Definition at line 55 of file popthelp.c.


Generated on Sun Oct 26 13:02:06 2003 for rpm by doxygen1.2.18