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