.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH HELP2MAN "1" "February 2006" "help2man 1.36" "User Commands"
.SH NAME
help2man \- generate a simple manual page
.SH SYNOPSIS
.B help2man
[\fIOPTION\fR]... \fIEXECUTABLE\fR
.SH DESCRIPTION
`help2man' generates a man page out of `\-\-help' and `\-\-version' output.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR
description for the NAME paragraph
.TP
\fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR
section number for manual page (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR
name of manual (User Commands, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR
source of program (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR
select locale (default "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR
include material from `FILE'
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR
include material from `FILE' if it exists
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
send output to `FILE'
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR
name of Texinfo manual
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
suppress pointer to Texinfo manual
.TP
\fB\-\-help\fR
print this help, then exit
.TP
\fB\-\-version\fR
print version number, then exit
.PP
EXECUTABLE should accept `\-\-help' and `\-\-version' options although
alternatives may be specified using:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR
help option string
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR
version option string
.SH "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)).

Lines before the first section or pattern which begin with `\-' are
processed as options.  Anything else 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.
.SH AVAILABILITY
The latest version of this distribution is available on-line from:

    ftp://ftp.gnu.org/gnu/help2man/
.SH AUTHOR
Written by Brendan O'Dea <bod@debian.org>
.SH "REPORTING BUGS"
Report bugs to <bug\-help2man@gnu.org>.
.SH COPYRIGHT
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free
Software Foundation, Inc.
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
The full documentation for
.B help2man
is maintained as a Texinfo manual.  If the
.B info
and
.B help2man
programs are properly installed at your site, the command
.IP
.B info help2man
.PP
should give you access to the complete manual.