summaryrefslogtreecommitdiff
path: root/autoopts/optionOnlyUsage.3
blob: a48ddb5020fc2291c7fef4766d40b0bf69dd12e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
.TH optionOnlyUsage 3 2012-08-11 "" "Programmer's Manual"
.\"  DO NOT EDIT THIS FILE   (optionOnlyUsage.3)
.\"  
.\"  It has been AutoGen-ed  August 11, 2012 at 09:44:56 AM by AutoGen 5.16.2
.\"  From the definitions    ./funcs.def
.\"  and the template file   agman3.tpl
.SH NAME
optionOnlyUsage - Print usage text for just the options
.sp 1
.SH SYNOPSIS

#include <\fIyour-opts.h\fP>
.br
cc [...] -o outfile infile.c -l\fBopts\fP [...]
.sp 1
void \fBoptionOnlyUsage\fP(tOptions* \fIpOpts\fP, int \fIex_code\fP);
.sp 1
.SH DESCRIPTION
This routine will print only the usage for each option.
This function may be used when the emitted usage must incorporate
information not available to AutoOpts.
.TP
.IR pOpts
program options descriptor
.TP
.IR ex_code
exit code for calling exit(3)
.SH SEE ALSO
The \fIinfo\fP documentation for the -l\fIopts\fP library.
.br
ao_string_tokenize(3), configFileLoad(3), optionFileLoad(3), optionFindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3), optionLoadLine(3), optionNextValue(3), optionProcess(3), optionRestore(3), optionSaveFile(3), optionSaveState(3), optionUnloadNested(3), optionVersion(3), pathfind(3), strequate(3), streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3),