|
Data Structures |
struct | poptOption |
struct | poptAlias |
| A popt alias argument for poptAddAlias(). More...
|
struct | poptItem_s |
| A popt alias or exec argument for poptAddItem(). More...
|
Auto-generated help/usage |
#define | POPT_AUTOALIAS |
#define | POPT_AUTOHELP |
#define | POPT_TABLEEND { NULL, '\0', 0, 0, 0, NULL, NULL } |
struct poptOption | poptAliasOptions [] |
| Empty table marker to enable displaying popt alias/exec options.
|
struct poptOption | poptHelpOptions [] |
| Auto help table options.
|
Defines |
#define | POPT_OPTION_DEPTH 10 |
|
#define | POPT_ARG_NONE 0 |
#define | POPT_ARG_STRING 1 |
#define | POPT_ARG_INT 2 |
#define | POPT_ARG_LONG 3 |
#define | POPT_ARG_INCLUDE_TABLE 4 |
#define | POPT_ARG_CALLBACK 5 |
#define | POPT_ARG_INTL_DOMAIN 6 |
#define | POPT_ARG_VAL 7 |
#define | POPT_ARG_FLOAT 8 |
#define | POPT_ARG_DOUBLE 9 |
#define | POPT_ARG_MASK 0x0000FFFF |
|
#define | POPT_ARGFLAG_ONEDASH 0x80000000 |
#define | POPT_ARGFLAG_DOC_HIDDEN 0x40000000 |
#define | POPT_ARGFLAG_STRIP 0x20000000 |
#define | POPT_ARGFLAG_OPTIONAL 0x10000000 |
#define | POPT_ARGFLAG_OR 0x08000000 |
#define | POPT_ARGFLAG_NOR 0x09000000 |
#define | POPT_ARGFLAG_AND 0x04000000 |
#define | POPT_ARGFLAG_NAND 0x05000000 |
#define | POPT_ARGFLAG_XOR 0x02000000 |
#define | POPT_ARGFLAG_NOT 0x01000000 |
#define | POPT_ARGFLAG_LOGICALOPS (POPT_ARGFLAG_OR|POPT_ARGFLAG_AND|POPT_ARGFLAG_XOR) |
#define | POPT_BIT_SET (POPT_ARG_VAL|POPT_ARGFLAG_OR) |
#define | POPT_BIT_CLR (POPT_ARG_VAL|POPT_ARGFLAG_NAND) |
#define | POPT_ARGFLAG_SHOW_DEFAULT 0x00800000 |
|
#define | POPT_CBFLAG_PRE 0x80000000 |
#define | POPT_CBFLAG_POST 0x40000000 |
#define | POPT_CBFLAG_INC_DATA 0x20000000 |
#define | POPT_CBFLAG_SKIPOPTION 0x10000000 |
#define | POPT_CBFLAG_CONTINUE 0x08000000 |
|
#define | POPT_ERROR_NOARG -10 |
#define | POPT_ERROR_BADOPT -11 |
#define | POPT_ERROR_OPTSTOODEEP -13 |
#define | POPT_ERROR_BADQUOTE -15 |
#define | POPT_ERROR_ERRNO -16 |
#define | POPT_ERROR_BADNUMBER -17 |
#define | POPT_ERROR_OVERFLOW -18 |
#define | POPT_ERROR_BADOPERATION -19 |
#define | POPT_ERROR_NULLARG -20 |
#define | POPT_ERROR_MALLOC -21 |
|
#define | POPT_BADOPTION_NOALIAS (1 << 0) |
|
#define | POPT_CONTEXT_NO_EXEC (1 << 0) |
#define | POPT_CONTEXT_KEEP_FIRST (1 << 1) |
#define | POPT_CONTEXT_POSIXMEHARDER (1 << 2) |
#define | POPT_CONTEXT_ARG_OPTS (1 << 4) |
Typedefs |
typedef struct poptItem_s * | poptItem |
| A popt alias or exec argument for poptAddItem().
|
typedef struct poptContext_s * | poptContext |
typedef struct poptOption * | poptOption |
typedef void(* | poptCallbackType )(poptContext con, enum poptCallbackReason reason, const struct poptOption *opt, const char *arg, const void *data) |
| Table callback prototype.
|
Enumerations |
enum | poptCallbackReason { POPT_CALLBACK_REASON_PRE,
POPT_CALLBACK_REASON_POST,
POPT_CALLBACK_REASON_OPTION
} |
Functions |
poptContext | poptGetContext (const char *name, int argc, const char **argv, const struct poptOption *options, int flags) |
| Initialize popt context.
|
void | poptResetContext (poptContext con) |
| Reinitialize popt context.
|
int | poptGetNextOpt (poptContext con) |
| Return value of next option found.
|
const char * | poptGetOptArg (poptContext con) |
| Return next option argument (if any).
|
const char * | poptGetArg (poptContext con) |
| Return current option's argument.
|
const char * | poptPeekArg (poptContext con) |
| Peek at current option's argument.
|
const char ** | poptGetArgs (poptContext con) |
| Return remaining arguments.
|
const char * | poptBadOption (poptContext con, int flags) |
| Return the option which caused the most recent error.
|
poptContext | poptFreeContext (poptContext con) |
| Destroy context.
|
int | poptStuffArgs (poptContext con, const char **argv) |
| Add arguments to context.
|
int | poptAddAlias (poptContext con, struct poptAlias alias, int flags) |
| Add alias to context.
|
int | poptAddItem (poptContext con, poptItem newItem, int flags) |
| Add alias/exec item to context.
|
int | poptReadConfigFile (poptContext con, const char *fn) |
| Read configuration file.
|
int | poptReadDefaultConfig (poptContext con, int useEnv) |
| Read default configuration from /etc/popt and $HOME/.popt.
|
int | poptDupArgv (int argc, const char **argv, int *argcPtr, const char ***argvPtr) |
| Duplicate an argument array.
|
int | poptParseArgvString (const char *s, int *argcPtr, const char ***argvPtr) |
| Parse a string into an argument array.
|
const char *const | poptStrerror (const int error) |
| Return formatted error string for popt failure.
|
void | poptSetExecPath (poptContext con, const char *path, int allowAbsolute) |
| Limit search for executables.
|
void | poptPrintHelp (poptContext con, FILE *fp, int flags) |
| Print detailed description of options.
|
void | poptPrintUsage (poptContext con, FILE *fp, int flags) |
| Print terse description of options.
|
void | poptSetOtherOptionHelp (poptContext con, const char *text) |
| Provide text to replace default "[OPTION...]" in help/usage output.
|
const char * | poptGetInvocationName (poptContext con) |
| Return argv[0] from context.
|
int | poptStrippedArgv (poptContext con, int argc, char **argv) |
| Shuffle argv pointers to remove stripped args, returns new argc.
|