Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

optionprocess(3) [centos man page]

optionProcess(3)						Programmer's Manual						  optionProcess(3)

NAME
optionProcess - this is the main option processing routine SYNOPSIS
#include <your-opts.h> cc [...] -o outfile infile.c -lopts [...] int optionProcess(tOptions* opts, int a_ct, char** a_v); DESCRIPTION
This is the main entry point for processing options. It is intended that this procedure be called once at the beginning of the execution of a program. Depending on options selected earlier, it is sometimes necessary to stop and restart option processing, or to select com- pletely different sets of options. This can be done easily, but you generally do not want to do this. The number of arguments processed always includes the program name. If one of the arguments is "--", then it is counted and the processing stops. If an error was encountered and errors are to be tolerated, then the returned value is the index of the argument causing the error. A hyphen by itself ("-") will also cause processing to stop and will not be counted among the processed arguments. A hyphen by itself is treated as an operand. Encountering an operand stops option processing. opts program options descriptor a_ct program arg count a_v program arg vector RETURN VALUE
the count of the arguments processed ERRORS
Errors will cause diagnostics to be printed. exit(3) may or may not be called. It depends upon whether or not the options were generated with the "allow-errors" attribute, or if the ERRSKIP_OPTERR or ERRSTOP_OPTERR macros were invoked. SEE ALSO
The info documentation for the -lopts library. ao_string_tokenize(3), configFileLoad(3), optionFileLoad(3), optionFindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3), optionLoadLine(3), optionMemberList(3), optionNextValue(3), optionOnlyUsage(3), optionRestore(3), optionSaveFile(3), optionSaveState(3), optionUnloadNested(3), optionVersion(3), strequate(3), streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3), 2014-06-10 optionProcess(3)

Check Out this Related Man Page

optionFileLoad(3)						Programmer's Manual						 optionFileLoad(3)

NAME
optionFileLoad - Load the locatable config files, in order SYNOPSIS
#include <your-opts.h> cc [...] -o outfile infile.c -lopts [...] int optionFileLoad(tOptions* opts, char const* prog); DESCRIPTION
This function looks in all the specified directories for a configuration file ("rc" file or "ini" file) and processes any found twice. The first time through, they are processed in reverse order (last file first). At that time, only "immediate action" configurables are pro- cessed. For example, if the last named file specifies not processing any more configuration files, then no more configuration files will be processed. Such an option in the first named directory will have no effect. Once the immediate action configurables have been handled, then the directories are handled in normal, forward order. In that way, later config files can override the settings of earlier config files. See the AutoOpts documentation for a thorough discussion of the config file format. Configuration files not found or not decipherable are simply ignored. opts program options descriptor prog program name RETURN VALUE
0 -> SUCCESS, -1 -> FAILURE ERRORS
Returns the value, "-1" if the program options descriptor is out of date or indecipherable. Otherwise, the value "0" will always be returned. SEE ALSO
The info documentation for the -lopts library. ao_string_tokenize(3), configFileLoad(3), optionFindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3), optionLoadLine(3), optionMemberList(3), optionNextValue(3), optionOnlyUsage(3), optionProcess(3), optionRestore(3), optionSaveFile(3), optionSaveState(3), optionUnloadNested(3), optionVersion(3), strequate(3), streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3), 2014-06-10 optionFileLoad(3)
Man Page

Featured Tech Videos