1HELP2MAN(1) User Commands HELP2MAN(1)
2
3
4
6 help2man - generate a simple manual page
7
9 help2man [OPTION]... EXECUTABLE
10
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 -l, --libtool
45 exclude the `lt-' from the program name
46
47 --help print this help, then exit
48
49 --version
50 print version number, then exit
51
52 EXECUTABLE should accept `--help' and `--version' options and produce
53 output on stdout although alternatives may be specified using:
54
55 -h, --help-option=STRING
56 help option string
57
58 -v, --version-option=STRING
59 version option string
60
61 --version-string=STRING
62 version string
63
64 --no-discard-stderr
65 include stderr when parsing option output
66
68 Additional material may be included in the generated output with the
69 --include and --opt-include 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 [section] (case insensitive), or after a para‐
79 graph matching /pattern/.
80
81 Patterns use the Perl regular expression syntax and may be followed by
82 the i, s or m modifiers (see perlre(1)).
83
84 Lines before the first section or pattern which begin with `-' are pro‐
85 cessed as options. Anything else is silently ignored and may be used
86 for comments, RCS keywords and the like.
87
88 The section output order (for those included) is:
89
90 NAME
91 SYNOPSIS
92 DESCRIPTION
93 OPTIONS
94 other
95 ENVIRONMENT
96 FILES
97 EXAMPLES
98 AUTHOR
99 REPORTING BUGS
100 COPYRIGHT
101 SEE ALSO
102
103 Any [NAME] or [SYNOPSIS] sections appearing in the include file will
104 replace what would have automatically been produced (although you can
105 still override the former with --name if required).
106
107 Other sections are prepended to the automatically produced output for
108 the standard sections given above, or included at other (above) in the
109 order they were encountered in the include file.
110
111 Placement of the text within the section may be explicitly requested by
112 using the syntax [<section], [=section] or [>section] to place the
113 additional text before, in place of, or after the default output
114 respectively.
115
117 The latest version of this distribution is available on-line from:
118
119 ftp://ftp.gnu.org/gnu/help2man/
120
122 Written by Brendan O'Dea <bod@debian.org>
123
125 Report bugs to <bug-help2man@gnu.org>.
126
128 Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
129 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021 Free Soft‐
130 ware Foundation, Inc.
131 This is free software; see the source for copying conditions. There is
132 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
133 PURPOSE.
134
136 The full documentation for help2man is maintained as a Texinfo manual.
137 If the info and help2man programs are properly installed at your site,
138 the command
139
140 info help2man
141
142 should give you access to the complete manual.
143
144
145
146GNU help2man 1.48.2 March 2021 HELP2MAN(1)