1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10.
2 .TH HELP2MAN "1" "June 2012" "help2man 1.40.10" "User Commands"
4 help2man \- generate a simple manual page
7 [\fIOPTION\fR]... \fIEXECUTABLE\fR
9 `help2man' generates a man page out of `\-\-help' and `\-\-version' output.
11 \fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR
12 description for the NAME paragraph
14 \fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR
15 section number for manual page (1, 6, 8)
17 \fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR
18 name of manual (User Commands, ...)
20 \fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR
21 source of program (FSF, Debian, ...)
23 \fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR
24 select locale (default "C")
26 \fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR
27 include material from `FILE'
29 \fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR
30 include material from `FILE' if it exists
32 \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
35 \fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR
36 name of Texinfo manual
38 \fB\-N\fR, \fB\-\-no\-info\fR
39 suppress pointer to Texinfo manual
41 \fB\-l\fR, \fB\-\-libtool\fR
42 exclude the `lt\-' from the program name
45 print this help, then exit
48 print version number, then exit
50 EXECUTABLE should accept `\-\-help' and `\-\-version' options and produce output on
51 stdout although alternatives may be specified using:
53 \fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR
56 \fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR
59 \fB\-\-version\-string\fR=\fISTRING\fR
62 \fB\-\-no\-discard\-stderr\fR
63 include stderr when parsing option output
65 Additional material may be included in the generated output with the
69 options. The format is simple:
77 Blocks of verbatim *roff text are inserted into the output either at
78 the start of the given
80 (case insensitive), or after a paragraph matching
83 Patterns use the Perl regular expression syntax and may be followed by
92 Lines before the first section or pattern which begin with `\-' are
93 processed as options. Anything else is silently ignored and may be
94 used for comments, RCS keywords and the like.
96 The section output order (for those included) is:
115 sections appearing in the include file will replace what would have
116 automatically been produced (although you can still override the
121 Other sections are prepended to the automatically produced output for
122 the standard sections given above, or included at
124 (above) in the order they were encountered in the include file.
126 The latest version of this distribution is available on-line from:
128 ftp://ftp.gnu.org/gnu/help2man/
130 Written by Brendan O'Dea <bod@debian.org>
132 Report bugs to <bug\-help2man@gnu.org>.
134 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
135 2011, 2012 Free Software Foundation, Inc.
137 This is free software; see the source for copying conditions. There is NO
138 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
140 The full documentation for
142 is maintained as a Texinfo manual. If the
146 programs are properly installed at your site, the command
150 should give you access to the complete manual.