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