Commit | Line | Data |
---|---|---|
4633a7c4 LW |
1 | #!/usr/local/bin/perl |
2 | ||
3 | use Config; | |
4 | use File::Basename qw(&basename &dirname); | |
3b5ca523 | 5 | use Cwd; |
4633a7c4 LW |
6 | |
7 | # List explicitly here the variables you want Configure to | |
8 | # generate. Metaconfig only looks for shell variables, so you | |
9 | # have to mention them as if they were shell variables, not | |
10 | # %Config entries. Thus you write | |
11 | # $startperl | |
12 | # to ensure Configure will look for $Config{startperl}. | |
13 | ||
3b5ca523 GS |
14 | # This forces PL files to create target in same directory as PL file. |
15 | # This is so that make depend always knows where to find PL derivatives. | |
16 | $origdir = cwd; | |
17 | chdir dirname($0); | |
18 | $file = basename($0, '.PL'); | |
774d564b | 19 | $file .= '.com' if $^O eq 'VMS'; |
4633a7c4 LW |
20 | |
21 | open OUT,">$file" or die "Can't create $file: $!"; | |
22 | ||
23 | print "Extracting $file (with variable substitutions)\n"; | |
24 | ||
25 | # In this section, perl variables will be expanded during extraction. | |
26 | # You can use $Config{...} to use Configure variables. | |
27 | ||
28 | print OUT <<"!GROK!THIS!"; | |
5f05dabc | 29 | $Config{startperl} |
30 | eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}' | |
9741dab0 | 31 | if \$running_under_some_shell; |
5d94fbed AD |
32 | !GROK!THIS! |
33 | ||
4633a7c4 LW |
34 | # In the following, perl variables are not expanded during extraction. |
35 | ||
36 | print OUT <<'!NO!SUBS!'; | |
cb1a09d0 | 37 | |
9741dab0 GS |
38 | # pod2man -- Convert POD data to formatted *roff input. |
39 | # | |
0e4e3f6e | 40 | # Copyright 1999, 2000, 2001, 2004, 2006, 2008 Russ Allbery <rra@stanford.edu> |
9741dab0 | 41 | # |
3c014959 | 42 | # This program is free software; you may redistribute it and/or modify it |
9741dab0 | 43 | # under the same terms as Perl itself. |
9741dab0 GS |
44 | |
45 | require 5.004; | |
46 | ||
47 | use Getopt::Long qw(GetOptions); | |
48 | use Pod::Man (); | |
49 | use Pod::Usage qw(pod2usage); | |
50 | ||
51 | use strict; | |
46bce7d0 | 52 | |
59548eca JH |
53 | # Silence -w warnings. |
54 | use vars qw($running_under_some_shell); | |
55 | ||
46bce7d0 | 56 | # Insert -- into @ARGV before any single dash argument to hide it from |
b7ae008f | 57 | # Getopt::Long; we want to interpret it as meaning stdin. |
46bce7d0 GS |
58 | my $stdin; |
59 | @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV; | |
9741dab0 | 60 | |
9f2f055a | 61 | # Parse our options, trying to retain backward compatibility with pod2man but |
3c014959 | 62 | # allowing short forms as well. --lax is currently ignored. |
9741dab0 | 63 | my %options; |
bc9c7511 | 64 | $options{errors} = 'pod'; |
46bce7d0 | 65 | Getopt::Long::config ('bundling_override'); |
bc9c7511 NC |
66 | GetOptions (\%options, 'center|c=s', 'date|d=s', 'fixed=s', 'fixedbold=s', |
67 | 'fixeditalic=s', 'fixedbolditalic=s', 'help|h', 'lax|l', | |
68 | 'name|n=s', 'official|o', 'quotes|q=s', 'release|r:s', | |
69 | 'section|s=s', 'stderr', 'verbose|v', 'utf8|u') or exit 1; | |
9741dab0 GS |
70 | pod2usage (0) if $options{help}; |
71 | ||
72 | # Official sets --center, but don't override things explicitly set. | |
73 | if ($options{official} && !defined $options{center}) { | |
74 | $options{center} = 'Perl Programmers Reference Guide'; | |
75 | } | |
cb1a09d0 | 76 | |
59548eca JH |
77 | # Verbose is only our flag, not a Pod::Man flag. |
78 | my $verbose = $options{verbose}; | |
79 | delete $options{verbose}; | |
80 | ||
9f2f055a | 81 | # This isn't a valid Pod::Man option and is only accepted for backward |
b4558dc4 JH |
82 | # compatibility. |
83 | delete $options{lax}; | |
84 | ||
3c014959 JH |
85 | # Initialize and run the formatter, pulling a pair of input and output off at |
86 | # a time. | |
8f202758 | 87 | my $parser = Pod::Man->new (%options); |
f1745d4f JH |
88 | my @files; |
89 | do { | |
90 | @files = splice (@ARGV, 0, 2); | |
59548eca | 91 | print " $files[1]\n" if $verbose; |
f1745d4f JH |
92 | $parser->parse_from_file (@files); |
93 | } while (@ARGV); | |
3c014959 | 94 | |
9741dab0 | 95 | __END__ |
cb1a09d0 | 96 | |
9741dab0 | 97 | =head1 NAME |
cb1a09d0 | 98 | |
9741dab0 | 99 | pod2man - Convert POD data to formatted *roff input |
cb1a09d0 | 100 | |
0e4e3f6e | 101 | =for stopwords |
bc9c7511 | 102 | en em --stderr stderr --utf8 UTF-8 overdo markup MT-LEVEL Allbery Solaris |
2504ae52 | 103 | URL troff troff-specific formatters uppercased Christiansen |
0e4e3f6e | 104 | |
9741dab0 | 105 | =head1 SYNOPSIS |
cb1a09d0 | 106 | |
bc9c7511 NC |
107 | pod2man [B<--center>=I<string>] [B<--date>=I<string>] |
108 | [B<--fixed>=I<font>] [B<--fixedbold>=I<font>] [B<--fixeditalic>=I<font>] | |
0e4e3f6e | 109 | [B<--fixedbolditalic>=I<font>] [B<--name>=I<name>] [B<--official>] |
bc9c7511 NC |
110 | [B<--quotes>=I<quotes>] [B<--release>[=I<version>]] |
111 | [B<--section>=I<manext>] [B<--stderr>] [B<--utf8>] [B<--verbose>] | |
0e4e3f6e | 112 | [I<input> [I<output>] ...] |
cb1a09d0 | 113 | |
46bce7d0 | 114 | pod2man B<--help> |
cb1a09d0 | 115 | |
9741dab0 | 116 | =head1 DESCRIPTION |
cb1a09d0 | 117 | |
9741dab0 GS |
118 | B<pod2man> is a front-end for Pod::Man, using it to generate *roff input |
119 | from POD source. The resulting *roff code is suitable for display on a | |
120 | terminal using nroff(1), normally via man(1), or printing using troff(1). | |
121 | ||
122 | I<input> is the file to read for POD source (the POD can be embedded in | |
0e4e3f6e SH |
123 | code). If I<input> isn't given, it defaults to C<STDIN>. I<output>, if |
124 | given, is the file to which to write the formatted output. If I<output> | |
125 | isn't given, the formatted output is written to C<STDOUT>. Several POD | |
126 | files can be processed in the same B<pod2man> invocation (saving module | |
127 | load and compile times) by providing multiple pairs of I<input> and | |
128 | I<output> files on the command line. | |
9741dab0 | 129 | |
bc9c7511 NC |
130 | B<--section>, B<--release>, B<--center>, B<--date>, and B<--official> can |
131 | be used to set the headers and footers to use; if not given, Pod::Man will | |
9741dab0 GS |
132 | assume various defaults. See below or L<Pod::Man> for details. |
133 | ||
0e4e3f6e SH |
134 | B<pod2man> assumes that your *roff formatters have a fixed-width font |
135 | named C<CW>. If yours is called something else (like C<CR>), use | |
136 | B<--fixed> to specify it. This generally only matters for troff output | |
137 | for printing. Similarly, you can set the fonts used for bold, italic, and | |
138 | bold italic fixed-width output. | |
9741dab0 GS |
139 | |
140 | Besides the obvious pod conversions, Pod::Man, and therefore pod2man also | |
141 | takes care of formatting func(), func(n), and simple variable references | |
142 | like $foo or @bar so you don't have to use code escapes for them; complex | |
143 | expressions like C<$fred{'stuff'}> will still need to be escaped, though. | |
144 | It also translates dashes that aren't used as hyphens into en dashes, makes | |
145 | long dashes--like this--into proper em dashes, fixes "paired quotes," and | |
146 | takes care of several other troff-specific tweaks. See L<Pod::Man> for | |
147 | complete information. | |
cb1a09d0 | 148 | |
9741dab0 | 149 | =head1 OPTIONS |
cb1a09d0 | 150 | |
9741dab0 | 151 | =over 4 |
cb1a09d0 | 152 | |
9741dab0 | 153 | =item B<-c> I<string>, B<--center>=I<string> |
cb1a09d0 | 154 | |
9741dab0 GS |
155 | Sets the centered page header to I<string>. The default is "User |
156 | Contributed Perl Documentation", but also see B<--official> below. | |
cb1a09d0 | 157 | |
9741dab0 | 158 | =item B<-d> I<string>, B<--date>=I<string> |
cb1a09d0 | 159 | |
9741dab0 GS |
160 | Set the left-hand footer string to this value. By default, the modification |
161 | date of the input file will be used, or the current date if input comes from | |
0e4e3f6e | 162 | C<STDIN>. |
cb1a09d0 | 163 | |
9741dab0 | 164 | =item B<--fixed>=I<font> |
cb1a09d0 | 165 | |
0e4e3f6e SH |
166 | The fixed-width font to use for verbatim text and code. Defaults to |
167 | C<CW>. Some systems may want C<CR> instead. Only matters for troff(1) | |
168 | output. | |
cb1a09d0 | 169 | |
9741dab0 | 170 | =item B<--fixedbold>=I<font> |
cb1a09d0 | 171 | |
0e4e3f6e SH |
172 | Bold version of the fixed-width font. Defaults to C<CB>. Only matters |
173 | for troff(1) output. | |
cb1a09d0 | 174 | |
9741dab0 | 175 | =item B<--fixeditalic>=I<font> |
cb1a09d0 | 176 | |
9741dab0 GS |
177 | Italic version of the fixed-width font (actually, something of a misnomer, |
178 | since most fixed-width fonts only have an oblique version, not an italic | |
0e4e3f6e | 179 | version). Defaults to C<CI>. Only matters for troff(1) output. |
cb1a09d0 | 180 | |
9741dab0 | 181 | =item B<--fixedbolditalic>=I<font> |
cb1a09d0 | 182 | |
9741dab0 | 183 | Bold italic (probably actually oblique) version of the fixed-width font. |
0e4e3f6e SH |
184 | Pod::Man doesn't assume you have this, and defaults to C<CB>. Some |
185 | systems (such as Solaris) have this font available as C<CX>. Only matters | |
186 | for troff(1) output. | |
cb1a09d0 | 187 | |
9741dab0 | 188 | =item B<-h>, B<--help> |
cb1a09d0 | 189 | |
9741dab0 | 190 | Print out usage information. |
cb1a09d0 | 191 | |
9741dab0 | 192 | =item B<-l>, B<--lax> |
cb1a09d0 | 193 | |
9f2f055a SH |
194 | No longer used. B<pod2man> used to check its input for validity as a |
195 | manual page, but this should now be done by L<podchecker(1)> instead. | |
196 | Accepted for backward compatibility; this option no longer does anything. | |
cb1a09d0 | 197 | |
bf202ccd JH |
198 | =item B<-n> I<name>, B<--name>=I<name> |
199 | ||
200 | Set the name of the manual page to I<name>. Without this option, the manual | |
201 | name is set to the uppercased base name of the file being converted unless | |
202 | the manual section is 3, in which case the path is parsed to see if it is a | |
203 | Perl module path. If it is, a path like C<.../lib/Pod/Man.pm> is converted | |
204 | into a name like C<Pod::Man>. This option, if given, overrides any | |
205 | automatic determination of the name. | |
206 | ||
207 | Note that this option is probably not useful when converting multiple POD | |
208 | files at once. The convention for Unix man pages for commands is for the | |
209 | man page title to be in all-uppercase even if the command isn't. | |
210 | ||
9741dab0 | 211 | =item B<-o>, B<--official> |
cb1a09d0 | 212 | |
9741dab0 GS |
213 | Set the default header to indicate that this page is part of the standard |
214 | Perl release, if B<--center> is not also given. | |
cb1a09d0 | 215 | |
ab1f1d91 JH |
216 | =item B<-q> I<quotes>, B<--quotes>=I<quotes> |
217 | ||
218 | Sets the quote marks used to surround CE<lt>> text to I<quotes>. If | |
219 | I<quotes> is a single character, it is used as both the left and right | |
220 | quote; if I<quotes> is two characters, the first character is used as the | |
221 | left quote and the second as the right quoted; and if I<quotes> is four | |
222 | characters, the first two are used as the left quote and the second two as | |
223 | the right quote. | |
224 | ||
225 | I<quotes> may also be set to the special value C<none>, in which case no | |
226 | quote marks are added around CE<lt>> text (but the font is still changed for | |
227 | troff output). | |
228 | ||
9741dab0 | 229 | =item B<-r>, B<--release> |
cb1a09d0 | 230 | |
9741dab0 GS |
231 | Set the centered footer. By default, this is the version of Perl you run |
232 | B<pod2man> under. Note that some system an macro sets assume that the | |
233 | centered footer will be a modification date and will prepend something like | |
234 | "Last modified: "; if this is the case, you may want to set B<--release> to | |
235 | the last modified date and B<--date> to the version number. | |
cb1a09d0 | 236 | |
9741dab0 | 237 | =item B<-s>, B<--section> |
cb1a09d0 | 238 | |
9741dab0 GS |
239 | Set the section for the C<.TH> macro. The standard section numbering |
240 | convention is to use 1 for user commands, 2 for system calls, 3 for | |
241 | functions, 4 for devices, 5 for file formats, 6 for games, 7 for | |
242 | miscellaneous information, and 8 for administrator commands. There is a lot | |
243 | of variation here, however; some systems (like Solaris) use 4 for file | |
244 | formats, 5 for miscellaneous information, and 7 for devices. Still others | |
245 | use 1m instead of 8, or some mix of both. About the only section numbers | |
246 | that are reliably consistent are 1, 2, and 3. | |
cb1a09d0 | 247 | |
0e4e3f6e SH |
248 | By default, section 1 will be used unless the file ends in C<.pm>, in |
249 | which case section 3 will be selected. | |
cb1a09d0 | 250 | |
bc9c7511 NC |
251 | =item B<--stderr> |
252 | ||
253 | By default, B<pod2man> puts any errors detected in the POD input in a POD | |
254 | ERRORS section in the output manual page. If B<--stderr> is given, errors | |
255 | are sent to standard error instead and the POD ERRORS section is | |
256 | suppressed. | |
257 | ||
55595e83 SP |
258 | =item B<-u>, B<--utf8> |
259 | ||
260 | By default, B<pod2man> produces the most conservative possible *roff | |
261 | output to try to ensure that it will work with as many different *roff | |
262 | implementations as possible. Many *roff implementations cannot handle | |
263 | non-ASCII characters, so this means all non-ASCII characters are converted | |
264 | either to a *roff escape sequence that tries to create a properly accented | |
265 | character (at least for troff output) or to C<X>. | |
266 | ||
267 | This option says to instead output literal UTF-8 characters. If your | |
268 | *roff implementation can handle it, this is the best output format to use | |
269 | and avoids corruption of documents containing non-ASCII characters. | |
270 | However, be warned that *roff source with literal UTF-8 characters is not | |
271 | supported by many implementations and may even result in segfaults and | |
272 | other bad behavior. | |
273 | ||
9f2f055a SH |
274 | Be aware that, when using this option, the input encoding of your POD |
275 | source must be properly declared unless it is US-ASCII or Latin-1. POD | |
276 | input without an C<=encoding> command will be assumed to be in Latin-1, | |
277 | and if it's actually in UTF-8, the output will be double-encoded. See | |
278 | L<perlpod(1)> for more information on the C<=encoding> command. | |
279 | ||
59548eca JH |
280 | =item B<-v>, B<--verbose> |
281 | ||
282 | Print out the name of each output file as it is being generated. | |
283 | ||
9741dab0 | 284 | =back |
cb1a09d0 | 285 | |
9741dab0 | 286 | =head1 DIAGNOSTICS |
cb1a09d0 | 287 | |
b7ae008f | 288 | If B<pod2man> fails with errors, see L<Pod::Man> and L<Pod::Simple> for |
9741dab0 | 289 | information about what those errors might mean. |
cb1a09d0 AD |
290 | |
291 | =head1 EXAMPLES | |
292 | ||
293 | pod2man program > program.1 | |
9741dab0 | 294 | pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3 |
cb1a09d0 AD |
295 | pod2man --section=7 note.pod > note.7 |
296 | ||
9741dab0 GS |
297 | If you would like to print out a lot of man page continuously, you probably |
298 | want to set the C and D registers to set contiguous page numbering and | |
299 | even/odd paging, at least on some versions of man(7). | |
cb1a09d0 | 300 | |
9741dab0 | 301 | troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ... |
cb1a09d0 | 302 | |
0e4e3f6e | 303 | To get index entries on C<STDERR>, turn on the F register, as in: |
cb1a09d0 | 304 | |
9741dab0 | 305 | troff -man -rF1 perl.1 |
cb1a09d0 | 306 | |
9741dab0 GS |
307 | The indexing merely outputs messages via C<.tm> for each major page, |
308 | section, subsection, item, and any C<XE<lt>E<gt>> directives. See | |
309 | L<Pod::Man> for more details. | |
cb1a09d0 | 310 | |
9741dab0 | 311 | =head1 BUGS |
cb1a09d0 | 312 | |
9741dab0 | 313 | Lots of this documentation is duplicated from L<Pod::Man>. |
cb1a09d0 | 314 | |
9741dab0 | 315 | =head1 NOTES |
cb1a09d0 | 316 | |
9741dab0 GS |
317 | For those not sure of the proper layout of a man page, here are some notes |
318 | on writing a proper man page. | |
cb1a09d0 | 319 | |
9741dab0 GS |
320 | The name of the program being documented is conventionally written in bold |
321 | (using BE<lt>E<gt>) wherever it occurs, as are all program options. | |
322 | Arguments should be written in italics (IE<lt>E<gt>). Functions are | |
323 | traditionally written in italics; if you write a function as function(), | |
324 | Pod::Man will take care of this for you. Literal code or commands should | |
325 | be in CE<lt>E<gt>. References to other man pages should be in the form | |
326 | C<manpage(section)>, and Pod::Man will automatically format those | |
327 | appropriately. As an exception, it's traditional not to use this form when | |
328 | referring to module documentation; use C<LE<lt>Module::NameE<gt>> instead. | |
cb1a09d0 | 329 | |
9741dab0 GS |
330 | References to other programs or functions are normally in the form of man |
331 | page references so that cross-referencing tools can provide the user with | |
332 | links and the like. It's possible to overdo this, though, so be careful not | |
333 | to clutter your documentation with too much markup. | |
cb1a09d0 | 334 | |
9741dab0 GS |
335 | The major headers should be set out using a C<=head1> directive, and are |
336 | historically written in the rather startling ALL UPPER CASE format, although | |
337 | this is not mandatory. Minor headers may be included using C<=head2>, and | |
338 | are typically in mixed case. | |
cb1a09d0 | 339 | |
9741dab0 | 340 | The standard sections of a manual page are: |
cb1a09d0 | 341 | |
9741dab0 | 342 | =over 4 |
cb1a09d0 | 343 | |
9741dab0 | 344 | =item NAME |
cb1a09d0 | 345 | |
9741dab0 | 346 | Mandatory section; should be a comma-separated list of programs or functions |
0e4e3f6e | 347 | documented by this POD page, such as: |
cb1a09d0 | 348 | |
9741dab0 | 349 | foo, bar - programs to do something |
cb1a09d0 | 350 | |
9741dab0 GS |
351 | Manual page indexers are often extremely picky about the format of this |
352 | section, so don't put anything in it except this line. A single dash, and | |
353 | only a single dash, should separate the list of programs or functions from | |
354 | the description. Functions should not be qualified with C<()> or the like. | |
355 | The description should ideally fit on a single line, even if a man program | |
356 | replaces the dash with a few tabs. | |
cb1a09d0 | 357 | |
9741dab0 | 358 | =item SYNOPSIS |
cb1a09d0 | 359 | |
9741dab0 GS |
360 | A short usage summary for programs and functions. This section is mandatory |
361 | for section 3 pages. | |
cb1a09d0 | 362 | |
9741dab0 | 363 | =item DESCRIPTION |
cb1a09d0 | 364 | |
9741dab0 GS |
365 | Extended description and discussion of the program or functions, or the body |
366 | of the documentation for man pages that document something else. If | |
367 | particularly long, it's a good idea to break this up into subsections | |
368 | C<=head2> directives like: | |
cb1a09d0 | 369 | |
9741dab0 | 370 | =head2 Normal Usage |
cb1a09d0 | 371 | |
9741dab0 | 372 | =head2 Advanced Features |
cb1a09d0 | 373 | |
9741dab0 | 374 | =head2 Writing Configuration Files |
cb1a09d0 | 375 | |
9741dab0 | 376 | or whatever is appropriate for your documentation. |
cb1a09d0 | 377 | |
9741dab0 | 378 | =item OPTIONS |
cb1a09d0 | 379 | |
9741dab0 GS |
380 | Detailed description of each of the command-line options taken by the |
381 | program. This should be separate from the description for the use of things | |
382 | like L<Pod::Usage|Pod::Usage>. This is normally presented as a list, with | |
383 | each option as a separate C<=item>. The specific option string should be | |
384 | enclosed in BE<lt>E<gt>. Any values that the option takes should be | |
385 | enclosed in IE<lt>E<gt>. For example, the section for the option | |
386 | B<--section>=I<manext> would be introduced with: | |
cb1a09d0 | 387 | |
9741dab0 | 388 | =item B<--section>=I<manext> |
cb1a09d0 | 389 | |
9741dab0 GS |
390 | Synonymous options (like both the short and long forms) are separated by a |
391 | comma and a space on the same C<=item> line, or optionally listed as their | |
392 | own item with a reference to the canonical name. For example, since | |
393 | B<--section> can also be written as B<-s>, the above would be: | |
cb1a09d0 | 394 | |
9741dab0 | 395 | =item B<-s> I<manext>, B<--section>=I<manext> |
cb1a09d0 | 396 | |
9741dab0 GS |
397 | (Writing the short option first is arguably easier to read, since the long |
398 | option is long enough to draw the eye to it anyway and the short option can | |
399 | otherwise get lost in visual noise.) | |
cb1a09d0 | 400 | |
9741dab0 | 401 | =item RETURN VALUE |
cb1a09d0 | 402 | |
9741dab0 GS |
403 | What the program or function returns, if successful. This section can be |
404 | omitted for programs whose precise exit codes aren't important, provided | |
405 | they return 0 on success as is standard. It should always be present for | |
406 | functions. | |
a0d0e21e | 407 | |
9741dab0 | 408 | =item ERRORS |
a0d0e21e | 409 | |
46bce7d0 GS |
410 | Exceptions, error return codes, exit statuses, and errno settings. |
411 | Typically used for function documentation; program documentation uses | |
412 | DIAGNOSTICS instead. The general rule of thumb is that errors printed to | |
0e4e3f6e SH |
413 | C<STDOUT> or C<STDERR> and intended for the end user are documented in |
414 | DIAGNOSTICS while errors passed internal to the calling program and | |
415 | intended for other programmers are documented in ERRORS. When documenting | |
416 | a function that sets errno, a full list of the possible errno values | |
417 | should be given here. | |
cb1a09d0 | 418 | |
9741dab0 | 419 | =item DIAGNOSTICS |
cb1a09d0 | 420 | |
9741dab0 GS |
421 | All possible messages the program can print out--and what they mean. You |
422 | may wish to follow the same documentation style as the Perl documentation; | |
423 | see perldiag(1) for more details (and look at the POD source as well). | |
cb1a09d0 | 424 | |
9741dab0 GS |
425 | If applicable, please include details on what the user should do to correct |
426 | the error; documenting an error as indicating "the input buffer is too | |
427 | small" without telling the user how to increase the size of the input buffer | |
428 | (or at least telling them that it isn't possible) aren't very useful. | |
cb1a09d0 | 429 | |
9741dab0 | 430 | =item EXAMPLES |
cb1a09d0 | 431 | |
9741dab0 GS |
432 | Give some example uses of the program or function. Don't skimp; users often |
433 | find this the most useful part of the documentation. The examples are | |
434 | generally given as verbatim paragraphs. | |
cb1a09d0 | 435 | |
9741dab0 GS |
436 | Don't just present an example without explaining what it does. Adding a |
437 | short paragraph saying what the example will do can increase the value of | |
438 | the example immensely. | |
cb1a09d0 | 439 | |
9741dab0 | 440 | =item ENVIRONMENT |
cb1a09d0 | 441 | |
9741dab0 GS |
442 | Environment variables that the program cares about, normally presented as a |
443 | list using C<=over>, C<=item>, and C<=back>. For example: | |
cb1a09d0 | 444 | |
9741dab0 | 445 | =over 6 |
a0d0e21e | 446 | |
9741dab0 | 447 | =item HOME |
bbc6b0c7 | 448 | |
9741dab0 GS |
449 | Used to determine the user's home directory. F<.foorc> in this |
450 | directory is read for configuration details, if it exists. | |
cb1a09d0 | 451 | |
9741dab0 | 452 | =back |
cb1a09d0 | 453 | |
9741dab0 GS |
454 | Since environment variables are normally in all uppercase, no additional |
455 | special formatting is generally needed; they're glaring enough as it is. | |
a0d0e21e | 456 | |
9741dab0 | 457 | =item FILES |
a0d0e21e | 458 | |
9741dab0 GS |
459 | All files used by the program or function, normally presented as a list, and |
460 | what it uses them for. File names should be enclosed in FE<lt>E<gt>. It's | |
461 | particularly important to document files that will be potentially modified. | |
a0d0e21e | 462 | |
9741dab0 | 463 | =item CAVEATS |
cb1a09d0 | 464 | |
9741dab0 | 465 | Things to take special care with, sometimes called WARNINGS. |
1c98b8f6 | 466 | |
9741dab0 | 467 | =item BUGS |
cb1a09d0 | 468 | |
9741dab0 | 469 | Things that are broken or just don't work quite right. |
a0d0e21e | 470 | |
9741dab0 | 471 | =item RESTRICTIONS |
a0d0e21e | 472 | |
9741dab0 | 473 | Bugs you don't plan to fix. :-) |
a0d0e21e | 474 | |
9741dab0 | 475 | =item NOTES |
a0d0e21e | 476 | |
9741dab0 | 477 | Miscellaneous commentary. |
a0d0e21e | 478 | |
9741dab0 | 479 | =item AUTHOR |
a0d0e21e | 480 | |
9741dab0 GS |
481 | Who wrote it (use AUTHORS for multiple people). Including your current |
482 | e-mail address (or some e-mail address to which bug reports should be sent) | |
483 | so that users have a way of contacting you is a good idea. Remember that | |
484 | program documentation tends to roam the wild for far longer than you expect | |
485 | and pick an e-mail address that's likely to last if possible. | |
a0d0e21e | 486 | |
b7ae008f SP |
487 | =item HISTORY |
488 | ||
489 | Programs derived from other sources sometimes have this, or you might keep | |
490 | a modification log here. If the log gets overly long or detailed, | |
491 | consider maintaining it in a separate file, though. | |
492 | ||
09c48e64 JH |
493 | =item COPYRIGHT AND LICENSE |
494 | ||
495 | For copyright | |
496 | ||
3c014959 | 497 | Copyright YEAR(s) by YOUR NAME(s) |
09c48e64 JH |
498 | |
499 | (No, (C) is not needed. No, "all rights reserved" is not needed.) | |
500 | ||
501 | For licensing the easiest way is to use the same licensing as Perl itself: | |
502 | ||
3c014959 JH |
503 | This library is free software; you may redistribute it and/or modify |
504 | it under the same terms as Perl itself. | |
09c48e64 JH |
505 | |
506 | This makes it easy for people to use your module with Perl. Note that | |
507 | this licensing is neither an endorsement or a requirement, you are of | |
508 | course free to choose any licensing. | |
509 | ||
b7ae008f | 510 | =item SEE ALSO |
a0d0e21e | 511 | |
b7ae008f SP |
512 | Other man pages to check out, like man(1), man(7), makewhatis(8), or |
513 | catman(8). Normally a simple list of man pages separated by commas, or a | |
514 | paragraph giving the name of a reference work. Man page references, if they | |
515 | use the standard C<name(section)> form, don't have to be enclosed in | |
516 | LE<lt>E<gt> (although it's recommended), but other things in this section | |
517 | probably should be when appropriate. | |
518 | ||
519 | If the package has a mailing list, include a URL or subscription | |
520 | instructions here. | |
521 | ||
522 | If the package has a web site, include a URL here. | |
a0d0e21e | 523 | |
9741dab0 GS |
524 | =back |
525 | ||
526 | In addition, some systems use CONFORMING TO to note conformance to relevant | |
527 | standards and MT-LEVEL to note safeness for use in threaded programs or | |
528 | signal handlers. These headings are primarily useful when documenting parts | |
529 | of a C library. Documentation of object-oriented libraries or modules may | |
530 | use CONSTRUCTORS and METHODS sections for detailed documentation of the | |
531 | parts of the library and save the DESCRIPTION section for an overview; other | |
532 | large modules may use FUNCTIONS for similar reasons. Some people use | |
3c014959 | 533 | OVERVIEW to summarize the description if it's quite long. |
9741dab0 GS |
534 | |
535 | Section ordering varies, although NAME should I<always> be the first section | |
536 | (you'll break some man page systems otherwise), and NAME, SYNOPSIS, | |
537 | DESCRIPTION, and OPTIONS generally always occur first and in that order if | |
538 | present. In general, SEE ALSO, AUTHOR, and similar material should be left | |
539 | for last. Some systems also move WARNINGS and NOTES to last. The order | |
540 | given above should be reasonable for most purposes. | |
541 | ||
542 | Finally, as a general note, try not to use an excessive amount of markup. | |
543 | As documented here and in L<Pod::Man>, you can safely leave Perl variables, | |
544 | function names, man page references, and the like unadorned by markup and | |
545 | the POD translators will figure it out for you. This makes it much easier | |
546 | to later edit the documentation. Note that many existing translators | |
547 | (including this one currently) will do the wrong thing with e-mail addresses | |
b7ae008f | 548 | when wrapped in LE<lt>E<gt>, so don't do that. |
9741dab0 GS |
549 | |
550 | For additional information that may be more accurate for your specific | |
b4558dc4 JH |
551 | system, see either L<man(5)> or L<man(7)> depending on your system manual |
552 | section numbering conventions. | |
9741dab0 GS |
553 | |
554 | =head1 SEE ALSO | |
555 | ||
9f2f055a SH |
556 | L<Pod::Man>, L<Pod::Simple>, L<man(1)>, L<nroff(1)>, L<perlpod(1)>, |
557 | L<podchecker(1)>, L<troff(1)>, L<man(7)> | |
9741dab0 | 558 | |
b4558dc4 JH |
559 | The man page documenting the an macro set may be L<man(5)> instead of |
560 | L<man(7)> on your system. | |
9741dab0 | 561 | |
fd20da51 JH |
562 | The current version of this script is always available from its web site at |
563 | L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the | |
564 | Perl core distribution as of 5.6.0. | |
565 | ||
9741dab0 GS |
566 | =head1 AUTHOR |
567 | ||
3c014959 JH |
568 | Russ Allbery <rra@stanford.edu>, based I<very> heavily on the original |
569 | B<pod2man> by Larry Wall and Tom Christiansen. Large portions of this | |
570 | documentation, particularly the sections on the anatomy of a proper man | |
9741dab0 | 571 | page, are taken from the B<pod2man> documentation by Tom. |
cb1a09d0 | 572 | |
3c014959 JH |
573 | =head1 COPYRIGHT AND LICENSE |
574 | ||
55595e83 SP |
575 | Copyright 1999, 2000, 2001, 2004, 2006, 2008 Russ Allbery |
576 | <rra@stanford.edu>. | |
3c014959 JH |
577 | |
578 | This program is free software; you may redistribute it and/or modify it | |
579 | under the same terms as Perl itself. | |
580 | ||
9741dab0 | 581 | =cut |
5d94fbed | 582 | !NO!SUBS! |
46bce7d0 | 583 | #'# (cperl-mode) |
4633a7c4 LW |
584 | |
585 | close OUT or die "Can't close $file: $!"; | |
586 | chmod 0755, $file or die "Can't reset permissions for $file: $!\n"; | |
587 | exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':'; | |
3b5ca523 | 588 | chdir $origdir; |