help2man(1)

1HELP2MAN(1)                      User Commands                     HELP2MAN(1)
2
3
4

NAME

6       help2man - generate a simple manual page
7

SYNOPSIS

9       help2man [OPTION]... EXECUTABLE
10

DESCRIPTION

12       `help2man' generates a man page out of `--help' and `--version' output.
13
14       -n, --name=STRING
15              description for the NAME paragraph
16
17       -s, --section=SECTION
18              section number for manual page (1, 6, 8)
19
20       -m, --manual=TEXT
21              name of manual (User Commands, ...)
22
23       -S, --source=TEXT
24              source of program (FSF, Debian, ...)
25
26       -L, --locale=STRING
27              select locale (default "C")
28
29       -i, --include=FILE
30              include material from `FILE'
31
32       -I, --opt-include=FILE
33              include material from `FILE' if it exists
34
35       -o, --output=FILE
36              send output to `FILE'
37
38       -p, --info-page=TEXT
39              name of Texinfo manual
40
41       -N, --no-info
42              suppress pointer to Texinfo manual
43
44       --help print this help, then exit
45
46       --version
47              print version number, then exit
48
49       EXECUTABLE  should  accept  `--help'  and  `--version' options although
50       alternatives may be specified using:
51
52       -h, --help-option=STRING
53              help option string
54
55       -v, --version-option=STRING
56              version option string
57

INCLUDE FILES

59       Additional material may be included in the generated  output  with  the
60       --include and --opt-include options.  The format is simple:
61
62           [section]
63           text
64
65           /pattern/
66           text
67
68       Blocks  of  verbatim  *roff text are inserted into the output either at
69       the start of the given [section] (case insensitive), or after  a  para‐
70       graph matching /pattern/.
71
72       Patterns  use the Perl regular expression syntax and may be followed by
73       the i, s or m modifiers (see perlre(1)).
74
75       Lines before the first section or pattern which begin with `-' are pro‐
76       cessed  as  options.  Anything else is silently ignored and may be used
77       for comments, RCS keywords and the like.
78
79       The section output order is:
80
81           NAME
82           SYNOPSIS
83           DESCRIPTION
84           OPTIONS
85           EXAMPLES
86           other
87           AUTHOR
88           REPORTING BUGS
89           COPYRIGHT
90           SEE ALSO
91
92       Any [name] or [synopsis] sections appearing in the  include  file  will
93       replace  what  would have automatically been produced (although you can
94       still override the former with --name if required).
95
96       Other sections are prepended to the automatically produced  output  for
97       the  standard sections given above, or included at other (above) in the
98       order they were encountered in the include file.
99

AVAILABILITY

101       The latest version of this distribution is available on-line from:
102
103           ftp://ftp.gnu.org/gnu/help2man/
104

AUTHOR

106       Written by Brendan O'Dea <bod@debian.org>
107

REPORTING BUGS

109       Report bugs to <bug-help2man@gnu.org>.
110

COPYRIGHT

112       Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,  2005  Free
113       Software Foundation, Inc.
114       This is free software; see the source for copying conditions.  There is
115       NO warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR
116       PURPOSE.
117