airopt.h File Reference
Airframe options interface. More...
#include <airframe/autoinc.h>
Go to the source code of this file.
Typedefs | |
typedef _AirOptionCtx | AirOptionCtx |
Opaque options context structure. | |
Functions | |
void | air_opterr (const char *fmt,...) |
Print a formatted option error message on standard error and exit the process. | |
AirOptionCtx * | air_option_context_new (const char *helpstr, int *argc, char ***argv, AirOptionEntry *entries) |
Create a new option context. | |
gboolean | air_option_context_add_group (AirOptionCtx *aoctx, const char *shortname, const char *longname, const char *description, AirOptionEntry *entries) |
Add a group of options to an option context. | |
void | air_option_context_parse (AirOptionCtx *aoctx) |
Parse command line arguments based on option entries that have been added to the option context. | |
void | air_option_context_set_help_enabled (AirOptionCtx *aoctx) |
Enable the display of option help by invoking your program with the --help or --usage parameters. | |
void | air_option_context_usage (AirOptionCtx *aoctx) |
Print a command line option usage message for your program, if supported by the underlying options library. | |
void | air_option_context_free (AirOptionCtx *aoctx) |
Destroy an options context. |
Detailed Description
Airframe options interface.
Function Documentation
|
Print a formatted option error message on standard error and exit the process. Use this only during command-line option processing. This call will not return.
|
|
Add a group of options to an option context.
|
|
Destroy an options context.
|
|
Create a new option context.
|
|
Parse command line arguments based on option entries that have been added to the option context. The argc and argv associated with the context will be updated by this function, with recognized options removed. Prints an error to standard error and terminates the process if the command-line cannot be parsed.
|
|
Enable the display of option help by invoking your program with the --help or --usage parameters.
|
|
Print a command line option usage message for your program, if supported by the underlying options library.
|