caps_arg_parser_list Struct Reference

Data Fields
size_t	cnt
const struct caps_arg_parser *	list
const char *	version
const char *	bugreport
const char *	progname
const char *	feature
const char *	domain
FILE *	errorout
FILE *	out

Detailed Description

Definition of a parser list

Todo:

Mention when to use different values than stderr and/or stdout for the errorout and out members.

Field Documentation

cnt

size_t cnt

Count of entries in list

list

const struct caps_arg_parser* list

Array of parsers used to process the command line parameters

version

const char* version

The program's version information to be shown in the --version option output text. For autotools based build systems, PACKAGE_VERSION is a good choice here.

Note

Can be NULL

bugreport

const char* bugreport

If you have a special email address for bug reports, list it here, for autotools based build systems PACKAGE_BUGREPORT is a good choice here.

Note

Can be NULL

progname

const char* progname

The program's name to be shown in the help and/or usage text

feature

const char* feature

A descriptive feature of the program. To be shown in the help text

Note

Mark for NLS

domain

const char* domain

NLS domain for the program. For autotools based build systems, PACKAGE is a good choice here.

Note

Can be NULL

errorout

FILE* errorout

Used for all kind of error messages. Use stderr for it if you don't have special requirements

out

FILE* out

Used for all kind of non error messages, like the output of the --help option. Use stdout for it if you don't have special requirements

---

The documentation for this struct was generated from the following file:

• libcapsbase/src/libcapscmdparser.h