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.

Functions

void displayArgs (poptContext con, enum poptCallbackReason foo, struct poptOption *key, const char *arg, void *data)
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)
void singleOptionHelp (FILE *fp, int maxLeftCol, const struct poptOption *opt, const char *translation_domain)
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. More...

void singleTableHelp (poptContext con, FILE *fp, const struct poptOption *table, int left, const char *translation_domain)
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. More...

int singleTableUsage (poptContext con, FILE *fp, int cursor, const struct poptOption *opt, const char *translation_domain)
int showShortOptions (const struct poptOption *opt, FILE *fp, char *str)
 Return concatenated short options for display. More...

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

Variables

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

struct poptOption poptHelpOptions []
 Auto help table options. More...


Detailed Description

Definition in file popthelp.c.


Function Documentation

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

Parameters:
con   context
key   option(s)

Definition at line 19 of file popthelp.c.

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

Parameters:
opt   option(s)
translation_domain   translation domain

Definition at line 85 of file popthelp.c.

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

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

Parameters:
table   option(s)

Definition at line 67 of file popthelp.c.

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
translation_domain   translation domain

Definition at line 387 of file popthelp.c.

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
item   alias/exec array
nitems   no. of ara/exec entries
translation_domain   translation domain

Definition at line 540 of file popthelp.c.

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 343 of file popthelp.c.

Referenced by poptPrintHelp().

int showHelpIntro ( poptContext con,
FILE * fp ) [static]
 

Parameters:
con   context
fp   output file handle

Definition at line 452 of file popthelp.c.

Referenced by poptPrintHelp(), and poptPrintUsage().

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

Return concatenated short options for display.

Parameters:
opt   option(s)
fp   output file handle
Return values:
str   concatenation of short options
Returns:
length of display string

Definition at line 601 of file popthelp.c.

Referenced by poptPrintUsage().

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

Parameters:
opt   option(s)
translation_domain   translation domain

Definition at line 115 of file popthelp.c.

Referenced by singleOptionHelp().

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

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

Definition at line 182 of file popthelp.c.

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
opt   option(s)
translation_domain   translation domain

Definition at line 492 of file popthelp.c.

Referenced by itemUsage(), and singleTableUsage().

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

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

Definition at line 411 of file popthelp.c.

Referenced by poptPrintHelp().

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

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

Definition at line 569 of file popthelp.c.

Referenced by poptPrintUsage().


Variable Documentation

struct poptOption poptAliasOptions[]
 

Initial value:

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

Definition at line 42 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 51 of file popthelp.c.


Generated at Tue Dec 23 04:54:13 2003 for rpm by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001