.TH "extract_usage_from_stx" "" "" "Panu A. Kalliokoski"
.SH NAME
extract_usage_from_stx \- extract \(lqUsage:\(rq messages from manpages written in Stx
.SH SYNOPSIS
.PP
\fCextract_usage_from_stx\fP [ \fIfile\fP  \fIfile\fP .\|.\|. ]
.SH DESCRIPTION
.PP
Process the given \fIfiles\fP, which should be manpages written in Stx,
stripping away everything that is typically \fInot\fP included in a \(lqUsage:\(rq
message.  If no \fIfiles\fP are given, read standard input instead.
.PP
A \(lqUsage:\(rq message is a message typically printed when a program is
called with incorrect arguments or when help is specifically requested,
for example with a \fC--help\fP command line option.  A \(lqUsage:\(rq message
is typically a subset of the information provided on a command's manual
page.
.PP
The information left in the \(lqUsage:\(rq message by
\fCextract_usage_from_stx\fP includes:
.RS 4
.IP \(bu 4
\&the command synopsis, as given in the \(lqSYNOPSIS\(rq section
.IP \(bu 4
\&the command line options, as given in the \(lqOPTIONS\(rq section, together
with the first sentence of their description.  A sentence is taken to
end at a period (\fC.\fP).
.RE
.PP
The output of \fCextract_usage_from_stx\fP is still in Stx format, which
you might want to further process to produce the actual \(lqUsage:\(rq
message.
.SH OPTIONS
.RS 3
.TP
\&\fC--version\fP, \fC-V\fP
Just show version information and exit.
.TP
\&\fC--help\fP, \fC-?\fP
Just show a short help message and exit.
.RE
.SH SEE ALSO
.PP
\fCstx2any\fP (1).
.SH BUGS
.PP
The end-condition of a sentence is too strong.
.SH AUTHOR
.PP
This manual page was written by Panu A. Kalliokoski.