Hash :
32a1dfbe
Author :
Thomas de Grivel
Date :
2023-01-21T15:08:35
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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
Include file for help2man man page
$Id: help2man.aux,v 1.5 2000/07/07 06:13:21 bod Exp $
[name]
help2man \- generate a simple manual page
[include files]
Additional material may be included in the generated output with the
.B \-\-include
and
.B \-\-opt\-include
options. The format is simple:
[section]
text
/pattern/
text
Blocks of verbatim *roff text are inserted into the output either at
the start of the given
.BI [ section ]
(case insensitive), or after a paragraph matching
.BI / pattern /\fR.
Patterns use the Perl regular expression syntax and may be followed by
the
.IR i ,
.I s
or
.I m
modifiers (see
.BR perlre (1)).
Anything before the first section or pattern is silently ignored and
may be used for comments, RCS keywords and the like.
The section output order is:
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLES
\fIother\fR
AUTHOR
REPORTING BUGS
COPYRIGHT
SEE ALSO
Any
.B [name]
or
.B [synopsis]
sections appearing in the include file will replace what would have
automatically been produced (although you can still override the
former with
.B --name
if required).
Other sections are prepended to the automatically produced output for
the standard sections given above, or included at
.I other
(above) in the order they were encountered in the include file.
[availability]
The latest version of this distribution is available on-line from:
ftp://ftp.gnu.org/gnu/help2man/