'\"macro stdmacro
.if n .pH g1f.indicator @(#)indicator	40.9 of 12/15/89
.\" Copyright 1989 AT&T
.nr X
.if \nX=0 .ds x} indicator 1F "Form and Menu Language Interpreter Utilities" "\&"
.if \nX=1 .ds x} indicator 1F "Form and Menu Language Interpreter Utilities"
.if \nX=2 .ds x} indicator 1F "" "\&"
.if \nX=3 .ds x} indicator "" "" "\&"
.TH \*(x}
.SH NAME
\f4indicator\f1 \- display application specific alarms and/or the "working" indicator
.SH SYNOPSIS
\f4indicator\f1
[\f4\-b\f1 [\f2n\f1]\|] [\f4\-c\f1 \f2column\f1] [\f4\-l\f1 \f2length\f1] [\f4\-o\f1] [\f4\-w\f1] [\f2string\f1 .\|.\|.]
.SH DESCRIPTION
The \f4indicator\f1 function displays application specific alarms or the
"working" indicator, or both, on the FMLI banner line.
By default, \f4indicator\f1 ????
The argument \f2string\f1 is a string to be displayed on the banner line,
and should always be the last argument given.
Note that \f2string\f1 is not automatically cleared from the banner line.
.PP
The following options are available:
.TP 1i
\f4\-b\f1 \f2n\f1
The \f4\-b\f1 option rings the terminal bell \f2n\f1 times,
where \f2n\f1 is an integer from 1 to 10.
The default value is 1.
If the terminal has no bell, the screen is flashed instead,
if possible.
.TP
\f4\-c\f2 column\f1
The \f4\-c\f1 option defines the column of the banner line
at which to start the indicator string.
The argument \f2column\f1 must be an integer from \f40\f1 to \f4DISPLAYW-1\f1.
If the \f4\-c\f1 option is not used, \f2column\f1 defaults to \f40\f1.
.TP
\f4\-l\f2 length\f1
The \f4\-l\f1 option defines the maximum length of the string displayed.
If \f2string\f1 is longer than \f2length\f1 characters, it will be truncated.
The argument \f2length\f1 must be an integer from \f41\f1 to \f4DISPLAYW\f1.
If the \f4\-l\f1 option is not used,
\f2length\f1 defaults to \f4DISPLAYW\f1.
NOTE: if \f2string\f1 doesn't fit it will be truncated.
.TP
\f4\-o\f1
The \f4\-o\f1 option causes \f4indicator\f1 to duplicate its output to \f2stdout\f1.
.TP
\f4\-w\f1
The \f4\-w\f1 option turns on the "working" indicator.
'\" If the \f4indicator\f1 function is used solely for bell
'\" or "working" indicator control,
'\" remember to give it a null \f2string\f1 argument
'\" unless input is being piped to it.
.SH EXAMPLES
When the value entered in a form field is invalid,
the following use of \f4indicator\f1 will
ring the bell three times and display the word
WRONG starting at column\ 1 of the banner line.
.PP
.RS
\f(CWinvalidmsg=\(gaindicator \f4\-b\fP 3 \f4\-c\fP 1 "WRONG"\(ga\f1
.RE
.PP
To clear the indicator after telling the user the entry is wrong:
.PP
.RS
.nf
\f(CWinvalidmsg=\(gaindicator \f4\-b\fP 9 \f4\-c\fP 1 "WRONG"; sleep(3);
	indicator \f4\-c\fP 1 "     "\(ga\f1
.fi
.RE
.PP
In this example the value of \f4invalidmsg\f1 (in this case the
default value \f4Input is not valid\f1),
still appears on the FMLI message line.
.ig
BUILT-IN FMLI
..
.Ee
