help2man.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.12.
   2 .TH HELP2MAN "1" "August 2012" "help2man 1.40.12" "User Commands"
   3 .SH NAME
   4 help2man \- generate a simple manual page
   5 .SH SYNOPSIS
   6 .B help2man
   7 [\fIOPTION\fR]... \fIEXECUTABLE\fR
   8 .SH DESCRIPTION
   9 `help2man' generates a man page out of `\-\-help' and `\-\-version' output.
  10 .TP
  11 \fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR
  12 description for the NAME paragraph
  13 .TP
  14 \fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR
  15 section number for manual page (1, 6, 8)
  16 .TP
  17 \fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR
  18 name of manual (User Commands, ...)
  19 .TP
  20 \fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR
  21 source of program (FSF, Debian, ...)
  22 .TP
  23 \fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR
  24 select locale (default "C")
  25 .TP
  26 \fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR
  27 include material from `FILE'
  28 .TP
  29 \fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR
  30 include material from `FILE' if it exists
  31 .TP
  32 \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
  33 send output to `FILE'
  34 .TP
  35 \fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR
  36 name of Texinfo manual
  37 .TP
  38 \fB\-N\fR, \fB\-\-no\-info\fR
  39 suppress pointer to Texinfo manual
  40 .TP
  41 \fB\-l\fR, \fB\-\-libtool\fR
  42 exclude the `lt\-' from the program name
  43 .TP
  44 \fB\-\-help\fR
  45 print this help, then exit
  46 .TP
  47 \fB\-\-version\fR
  48 print version number, then exit
  49 .PP
  50 EXECUTABLE should accept `\-\-help' and `\-\-version' options and produce output on
  51 stdout although alternatives may be specified using:
  52 .TP
  53 \fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR
  54 help option string
  55 .TP
  56 \fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR
  57 version option string
  58 .TP
  59 \fB\-\-version\-string\fR=\fISTRING\fR
  60 version string
  61 .TP
  62 \fB\-\-no\-discard\-stderr\fR
  63 include stderr when parsing option output
  64 .SH "INCLUDE FILES"
  65 Additional material may be included in the generated output with the
  66 .B \-\-include
  67 and
  68 .B \-\-opt\-include
  69 options.  The format is simple:
  70
  71     [section]
  72     text
  73
  74     /pattern/
  75     text
  76
  77 Blocks of verbatim *roff text are inserted into the output either at
  78 the start of the given
  79 .BI [ section ]
  80 (case insensitive), or after a paragraph matching
  81 .BI / pattern /\fR.
  82
  83 Patterns use the Perl regular expression syntax and may be followed by
  84 the
  85 .IR i ,
  86 .I s
  87 or
  88 .I m
  89 modifiers (see
  90 .BR perlre (1)).
  91
  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.
  95
  96 The section output order (for those included) is:
  97
  98     NAME
  99     SYNOPSIS
 100     DESCRIPTION
 101     OPTIONS
 102     ENVIRONMENT
 103     FILES
 104     EXAMPLES
 105     \fIother\fR
 106     AUTHOR
 107     REPORTING BUGS
 108     COPYRIGHT
 109     SEE ALSO
 110
 111 Any
 112 .B [NAME]
 113 or
 114 .B [SYNOPSIS]
 115 sections appearing in the include file will replace what would have
 116 automatically been produced (although you can still override the
 117 former with
 118 .B --name
 119 if required).
 120
 121 Other sections are prepended to the automatically produced output for
 122 the standard sections given above, or included at
 123 .I other
 124 (above) in the order they were encountered in the include file.
 125 .SH AVAILABILITY
 126 The latest version of this distribution is available on-line from:
 127
 128     ftp://ftp.gnu.org/gnu/help2man/
 129 .SH AUTHOR
 130 Written by Brendan O'Dea <bod@debian.org>
 131 .SH "REPORTING BUGS"
 132 Report bugs to <bug\-help2man@gnu.org>.
 133 .SH COPYRIGHT
 134 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
 135 2011, 2012 Free Software Foundation, Inc.
 136 .br
 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.
 139 .SH "SEE ALSO"
 140 The full documentation for
 141 .B help2man
 142 is maintained as a Texinfo manual.  If the
 143 .B info
 144 and
 145 .B help2man
 146 programs are properly installed at your site, the command
 147 .IP
 148 .B info help2man
 149 .PP
 150 should give you access to the complete manual.