options.h File Reference
Header for command line options parsing utilities.
More...
#include <yaz/yconfig.h>
Go to the source code of this file.
Detailed Description
Header for command line options parsing utilities.
Definition in file options.h.
Define Documentation
| #define YAZ_OPTIONS_EOF (-2) |
| #define YAZ_OPTIONS_ERROR (-1) |
Function Documentation
| int options |
( |
const char * |
desc, |
|
|
char ** |
argv, |
|
|
int |
argc, |
|
|
char ** |
arg | |
|
) |
| | |
command-line options parsing for main
- desc command argument description (allowed options)
- argv main argv
- argc main argc
- arg returned argument (for options that take an argument).
- Return values:
-
| 0 | non-option arg (e.g. filename). |
| -1 | unknown option (error). arg is name of unknown option |
| -2 | no more options (end of options) |
| c | option char |
This function is called repeatedly for each option. Both single char options (-x) as well as GNU long options are supported (--long). The description is a sequence specs where each spec is if the form: [a-zA-Z0-9]({[a-zA-Z0-9]*})+:? . For example: h{help}f{filename}{fname}:
The first char is what is returned when met (single char option char). The second is zero ore more long option values (synonum for single char) If colon is appended, it means the option takes an argument.
Definition at line 20 of file options.c.
Referenced by check_options().
