.ds Vv 1.2.14
.TH VistaIOReportUsage 3 "24 April 1993" "VistaIO Version \*(Vv"
.SH NAME
VistaIOReportUsage, VistaIOReportValidOptions \- report valid command line arguments
.SH SYNOPSIS
.nf
.B "#include <vistaio.h>"
.PP
.ft B
void VistaIOReportUsage (\fIprogram\fP, \fInoptions\fP, \fIoptions\fP, \
\fIother_args\fP)
.RS
VistaIOStringConst \fIprogram\fP, \fIother_args\fP;
int \fInoptions\fP;
VistaIOOptionDescRec \fIoptions\fP[\fInoptions\fP];
.RE
.PP
.ft B
void VistaIOReportValidOptions (\fInoptions\fP, \fIoptions\fP)
.RS
int \fInoptions\fP;
VistaIOOptionDescRec \fIoptions\fP[\fInoptions\fP];
.RE
.fi
.SH ARGUMENTS
.IP \fIprogram\fP 10n
Specifies the program's name. Usually \fBargv[0]\fP is passed.
.IP \fInoptions\fP 10n
Specifies the number of entries in the table of option descriptors.
.IP \fIoptions\fP
Specifies the location of the table of option descriptors.
.IP \fIother_args\fP
May specify a string describing any options the program accepts other than
those described in the options table, or it may be
.SB NULL\c
.
.SH DESCRIPTION
\fBVistaIOReportUsage\fP prints, to the standard error stream, information about how
to use a program. It first prints a line of the form:
.PP
.RS
\fBUsage: \fIprogram\fB <options> \fIother_args\fB, where <options> includes:
.RE
.PP
The \fIprogram\fP argument supplies the \fIprogram\fP component of this 
line, and the \fIother_args\fP argument supplies the \fIother_args\fP 
component. If the program accepts no options other than those described in 
the options table, \fIother_args\fP should be 
.SB NULL\c
\&.
.PP
\fBVistaIOReportUsage\fP then calls \fBVistaIOReportValidOptions\fP to print a
summary of the options described by \fInoptions\fP and \fIoptions\fP.
.PP
\fBVistaIOReportValidOptions\fP prints a description of each option in a table of
option descriptors. The description is intended to advise a program user.
It indicates what keyword signals the option's presence in the command
line, whether it is optional, how many values must follow it, what type
those values should have, what keywords may be used as values for the
option, and what default value(s) the option has.  The description will
also include any ``blurb'' string of help information that is found in the
option's table entry. The information is printed to the standard error
stream.
.SH "SEE ALSO"
.na
.nh
.BR VistaIOParseCommand (3),
.BR VistaIOReportBadArgs (3),
.BR VistaIOoption (3),

.ad
.hy
.SH AUTHOR
Art Pope <pope@cs.ubc.ca>

Adaption to vistaio: Gert Wollny <gw.fossdev@gmail.com>