4 use File::Basename qw(&basename &dirname);
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
12 # to ensure Configure will look for $Config{startperl}.
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.
18 $file = basename($0, '.PL');
19 $file .= '.com' if $^O eq 'VMS';
21 open OUT,">$file" or die "Can't create $file: $!";
23 print "Extracting $file (with variable substitutions)\n";
25 # In this section, perl variables will be expanded during extraction.
26 # You can use $Config{...} to use Configure variables.
28 print OUT <<"!GROK!THIS!";
30 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
31 if \$running_under_some_shell;
34 # In the following, perl variables are not expanded during extraction.
36 print OUT <<'!NO!SUBS!';
38 # pod2man -- Convert POD data to formatted *roff input.
39 # $Id: pod2man.PL,v 1.6 2001/07/10 11:23:46 eagle Exp $
41 # Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>
43 # This program is free software; you may redistribute it and/or modify it
44 # under the same terms as Perl itself.
48 use Getopt::Long qw(GetOptions);
50 use Pod::Usage qw(pod2usage);
54 # Insert -- into @ARGV before any single dash argument to hide it from
55 # Getopt::Long; we want to interpret it as meaning stdin (which Pod::Parser
58 @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
60 # Parse our options, trying to retain backwards compatibility with pod2man but
61 # allowing short forms as well. --lax is currently ignored.
63 Getopt::Long::config ('bundling_override');
64 GetOptions (\%options, 'section|s=s', 'release|r=s', 'center|c=s',
65 'date|d=s', 'fixed=s', 'fixedbold=s', 'fixeditalic=s',
66 'fixedbolditalic=s', 'official|o', 'quotes|q=s', 'lax|l',
68 pod2usage (0) if $options{help};
70 # Official sets --center, but don't override things explicitly set.
71 if ($options{official} && !defined $options{center}) {
72 $options{center} = 'Perl Programmers Reference Guide';
75 # Initialize and run the formatter, pulling a pair of input and output off at
77 my $parser = Pod::Man->new (%options);
80 @files = splice (@ARGV, 0, 2);
81 $parser->parse_from_file (@files);
88 pod2man - Convert POD data to formatted *roff input
92 pod2man [B<--section>=I<manext>] [B<--release>=I<version>]
93 [B<--center>=I<string>] [B<--date>=I<string>] [B<--fixed>=I<font>]
94 [B<--fixedbold>=I<font>] [B<--fixeditalic>=I<font>]
95 [B<--fixedbolditalic>=I<font>] [B<--official>] [B<--lax>]
96 [B<--quotes>=I<quotes>] [I<input> [I<output>] ...]
102 B<pod2man> is a front-end for Pod::Man, using it to generate *roff input
103 from POD source. The resulting *roff code is suitable for display on a
104 terminal using nroff(1), normally via man(1), or printing using troff(1).
106 I<input> is the file to read for POD source (the POD can be embedded in
107 code). If I<input> isn't given, it defaults to STDIN. I<output>, if given,
108 is the file to which to write the formatted output. If I<output> isn't
109 given, the formatted output is written to STDOUT. Several POD files can be
110 processed in the same B<pod2man> invocation (saving module load and compile
111 times) by providing multiple pairs of I<input> and I<output> files on the
114 B<--section>, B<--release>, B<--center>, B<--date>, and B<--official> can be
115 used to set the headers and footers to use; if not given, Pod::Man will
116 assume various defaults. See below or L<Pod::Man> for details.
118 B<pod2man> assumes that your *roff formatters have a fixed-width font named
119 CW. If yours is called something else (like CR), use B<--fixed> to specify
120 it. This generally only matters for troff output for printing. Similarly,
121 you can set the fonts used for bold, italic, and bold italic fixed-width
124 Besides the obvious pod conversions, Pod::Man, and therefore pod2man also
125 takes care of formatting func(), func(n), and simple variable references
126 like $foo or @bar so you don't have to use code escapes for them; complex
127 expressions like C<$fred{'stuff'}> will still need to be escaped, though.
128 It also translates dashes that aren't used as hyphens into en dashes, makes
129 long dashes--like this--into proper em dashes, fixes "paired quotes," and
130 takes care of several other troff-specific tweaks. See L<Pod::Man> for
131 complete information.
137 =item B<-c> I<string>, B<--center>=I<string>
139 Sets the centered page header to I<string>. The default is "User
140 Contributed Perl Documentation", but also see B<--official> below.
142 =item B<-d> I<string>, B<--date>=I<string>
144 Set the left-hand footer string to this value. By default, the modification
145 date of the input file will be used, or the current date if input comes from
148 =item B<--fixed>=I<font>
150 The fixed-width font to use for vertabim text and code. Defaults to CW.
151 Some systems may want CR instead. Only matters for troff(1) output.
153 =item B<--fixedbold>=I<font>
155 Bold version of the fixed-width font. Defaults to CB. Only matters for
158 =item B<--fixeditalic>=I<font>
160 Italic version of the fixed-width font (actually, something of a misnomer,
161 since most fixed-width fonts only have an oblique version, not an italic
162 version). Defaults to CI. Only matters for troff(1) output.
164 =item B<--fixedbolditalic>=I<font>
166 Bold italic (probably actually oblique) version of the fixed-width font.
167 Pod::Man doesn't assume you have this, and defaults to CB. Some systems
168 (such as Solaris) have this font available as CX. Only matters for troff(1)
171 =item B<-h>, B<--help>
173 Print out usage information.
175 =item B<-l>, B<--lax>
177 Don't complain when required sections are missing. Not currently used, as
178 POD checking functionality is not yet implemented in Pod::Man.
180 =item B<-o>, B<--official>
182 Set the default header to indicate that this page is part of the standard
183 Perl release, if B<--center> is not also given.
185 =item B<-q> I<quotes>, B<--quotes>=I<quotes>
187 Sets the quote marks used to surround CE<lt>> text to I<quotes>. If
188 I<quotes> is a single character, it is used as both the left and right
189 quote; if I<quotes> is two characters, the first character is used as the
190 left quote and the second as the right quoted; and if I<quotes> is four
191 characters, the first two are used as the left quote and the second two as
194 I<quotes> may also be set to the special value C<none>, in which case no
195 quote marks are added around CE<lt>> text (but the font is still changed for
198 =item B<-r>, B<--release>
200 Set the centered footer. By default, this is the version of Perl you run
201 B<pod2man> under. Note that some system an macro sets assume that the
202 centered footer will be a modification date and will prepend something like
203 "Last modified: "; if this is the case, you may want to set B<--release> to
204 the last modified date and B<--date> to the version number.
206 =item B<-s>, B<--section>
208 Set the section for the C<.TH> macro. The standard section numbering
209 convention is to use 1 for user commands, 2 for system calls, 3 for
210 functions, 4 for devices, 5 for file formats, 6 for games, 7 for
211 miscellaneous information, and 8 for administrator commands. There is a lot
212 of variation here, however; some systems (like Solaris) use 4 for file
213 formats, 5 for miscellaneous information, and 7 for devices. Still others
214 use 1m instead of 8, or some mix of both. About the only section numbers
215 that are reliably consistent are 1, 2, and 3.
217 By default, section 1 will be used unless the file ends in .pm in which case
218 section 3 will be selected.
224 If B<pod2man> fails with errors, see L<Pod::Man> and L<Pod::Parser> for
225 information about what those errors might mean.
229 pod2man program > program.1
230 pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
231 pod2man --section=7 note.pod > note.7
233 If you would like to print out a lot of man page continuously, you probably
234 want to set the C and D registers to set contiguous page numbering and
235 even/odd paging, at least on some versions of man(7).
237 troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...
239 To get index entries on stderr, turn on the F register, as in:
241 troff -man -rF1 perl.1
243 The indexing merely outputs messages via C<.tm> for each major page,
244 section, subsection, item, and any C<XE<lt>E<gt>> directives. See
245 L<Pod::Man> for more details.
249 Lots of this documentation is duplicated from L<Pod::Man>.
251 POD checking and the corresponding B<--lax> option don't work yet.
255 For those not sure of the proper layout of a man page, here are some notes
256 on writing a proper man page.
258 The name of the program being documented is conventionally written in bold
259 (using BE<lt>E<gt>) wherever it occurs, as are all program options.
260 Arguments should be written in italics (IE<lt>E<gt>). Functions are
261 traditionally written in italics; if you write a function as function(),
262 Pod::Man will take care of this for you. Literal code or commands should
263 be in CE<lt>E<gt>. References to other man pages should be in the form
264 C<manpage(section)>, and Pod::Man will automatically format those
265 appropriately. As an exception, it's traditional not to use this form when
266 referring to module documentation; use C<LE<lt>Module::NameE<gt>> instead.
268 References to other programs or functions are normally in the form of man
269 page references so that cross-referencing tools can provide the user with
270 links and the like. It's possible to overdo this, though, so be careful not
271 to clutter your documentation with too much markup.
273 The major headers should be set out using a C<=head1> directive, and are
274 historically written in the rather startling ALL UPPER CASE format, although
275 this is not mandatory. Minor headers may be included using C<=head2>, and
276 are typically in mixed case.
278 The standard sections of a manual page are:
284 Mandatory section; should be a comma-separated list of programs or functions
285 documented by this podpage, such as:
287 foo, bar - programs to do something
289 Manual page indexers are often extremely picky about the format of this
290 section, so don't put anything in it except this line. A single dash, and
291 only a single dash, should separate the list of programs or functions from
292 the description. Functions should not be qualified with C<()> or the like.
293 The description should ideally fit on a single line, even if a man program
294 replaces the dash with a few tabs.
298 A short usage summary for programs and functions. This section is mandatory
303 Extended description and discussion of the program or functions, or the body
304 of the documentation for man pages that document something else. If
305 particularly long, it's a good idea to break this up into subsections
306 C<=head2> directives like:
310 =head2 Advanced Features
312 =head2 Writing Configuration Files
314 or whatever is appropriate for your documentation.
318 Detailed description of each of the command-line options taken by the
319 program. This should be separate from the description for the use of things
320 like L<Pod::Usage|Pod::Usage>. This is normally presented as a list, with
321 each option as a separate C<=item>. The specific option string should be
322 enclosed in BE<lt>E<gt>. Any values that the option takes should be
323 enclosed in IE<lt>E<gt>. For example, the section for the option
324 B<--section>=I<manext> would be introduced with:
326 =item B<--section>=I<manext>
328 Synonymous options (like both the short and long forms) are separated by a
329 comma and a space on the same C<=item> line, or optionally listed as their
330 own item with a reference to the canonical name. For example, since
331 B<--section> can also be written as B<-s>, the above would be:
333 =item B<-s> I<manext>, B<--section>=I<manext>
335 (Writing the short option first is arguably easier to read, since the long
336 option is long enough to draw the eye to it anyway and the short option can
337 otherwise get lost in visual noise.)
341 What the program or function returns, if successful. This section can be
342 omitted for programs whose precise exit codes aren't important, provided
343 they return 0 on success as is standard. It should always be present for
348 Exceptions, error return codes, exit statuses, and errno settings.
349 Typically used for function documentation; program documentation uses
350 DIAGNOSTICS instead. The general rule of thumb is that errors printed to
351 STDOUT or STDERR and intended for the end user are documented in DIAGNOSTICS
352 while errors passed internal to the calling program and intended for other
353 programmers are documented in ERRORS. When documenting a function that sets
354 errno, a full list of the possible errno values should be given here.
358 All possible messages the program can print out--and what they mean. You
359 may wish to follow the same documentation style as the Perl documentation;
360 see perldiag(1) for more details (and look at the POD source as well).
362 If applicable, please include details on what the user should do to correct
363 the error; documenting an error as indicating "the input buffer is too
364 small" without telling the user how to increase the size of the input buffer
365 (or at least telling them that it isn't possible) aren't very useful.
369 Give some example uses of the program or function. Don't skimp; users often
370 find this the most useful part of the documentation. The examples are
371 generally given as verbatim paragraphs.
373 Don't just present an example without explaining what it does. Adding a
374 short paragraph saying what the example will do can increase the value of
375 the example immensely.
379 Environment variables that the program cares about, normally presented as a
380 list using C<=over>, C<=item>, and C<=back>. For example:
386 Used to determine the user's home directory. F<.foorc> in this
387 directory is read for configuration details, if it exists.
391 Since environment variables are normally in all uppercase, no additional
392 special formatting is generally needed; they're glaring enough as it is.
396 All files used by the program or function, normally presented as a list, and
397 what it uses them for. File names should be enclosed in FE<lt>E<gt>. It's
398 particularly important to document files that will be potentially modified.
402 Things to take special care with, sometimes called WARNINGS.
406 Things that are broken or just don't work quite right.
410 Bugs you don't plan to fix. :-)
414 Miscellaneous commentary.
418 Other man pages to check out, like man(1), man(7), makewhatis(8), or
419 catman(8). Normally a simple list of man pages separated by commas, or a
420 paragraph giving the name of a reference work. Man page references, if they
421 use the standard C<name(section)> form, don't have to be enclosed in
422 LE<lt>E<gt>, but other things in this section probably should be when
423 appropriate. You may need to use the C<LE<lt>...|...E<gt>> syntax to keep
424 B<pod2man> and B<pod2text> from being too verbose; see perlpod(1).
426 If the package has a mailing list, include a URL or subscription
429 If the package has a web site, include a URL here.
433 Who wrote it (use AUTHORS for multiple people). Including your current
434 e-mail address (or some e-mail address to which bug reports should be sent)
435 so that users have a way of contacting you is a good idea. Remember that
436 program documentation tends to roam the wild for far longer than you expect
437 and pick an e-mail address that's likely to last if possible.
439 =item COPYRIGHT AND LICENSE
443 Copyright YEAR(s) by YOUR NAME(s)
445 (No, (C) is not needed. No, "all rights reserved" is not needed.)
447 For licensing the easiest way is to use the same licensing as Perl itself:
449 This library is free software; you may redistribute it and/or modify
450 it under the same terms as Perl itself.
452 This makes it easy for people to use your module with Perl. Note that
453 this licensing is neither an endorsement or a requirement, you are of
454 course free to choose any licensing.
458 Programs derived from other sources sometimes have this, or you might keep
459 a modification log here. If the log gets overly long or detailed,
460 consider maintaining it in a separate file, though.
464 In addition, some systems use CONFORMING TO to note conformance to relevant
465 standards and MT-LEVEL to note safeness for use in threaded programs or
466 signal handlers. These headings are primarily useful when documenting parts
467 of a C library. Documentation of object-oriented libraries or modules may
468 use CONSTRUCTORS and METHODS sections for detailed documentation of the
469 parts of the library and save the DESCRIPTION section for an overview; other
470 large modules may use FUNCTIONS for similar reasons. Some people use
471 OVERVIEW to summarize the description if it's quite long.
473 Section ordering varies, although NAME should I<always> be the first section
474 (you'll break some man page systems otherwise), and NAME, SYNOPSIS,
475 DESCRIPTION, and OPTIONS generally always occur first and in that order if
476 present. In general, SEE ALSO, AUTHOR, and similar material should be left
477 for last. Some systems also move WARNINGS and NOTES to last. The order
478 given above should be reasonable for most purposes.
480 Finally, as a general note, try not to use an excessive amount of markup.
481 As documented here and in L<Pod::Man>, you can safely leave Perl variables,
482 function names, man page references, and the like unadorned by markup and
483 the POD translators will figure it out for you. This makes it much easier
484 to later edit the documentation. Note that many existing translators
485 (including this one currently) will do the wrong thing with e-mail addresses
486 or URLs when wrapped in LE<lt>E<gt>, so don't do that.
488 For additional information that may be more accurate for your specific
489 system, see either man(5) or man(7) depending on your system manual section
490 numbering conventions.
494 L<Pod::Man|Pod::Man>, L<Pod::Parser|Pod::Parser>, man(1), nroff(1),
497 The man page documenting the an macro set may be man(5) instead of man(7) on
502 Russ Allbery <rra@stanford.edu>, based I<very> heavily on the original
503 B<pod2man> by Larry Wall and Tom Christiansen. Large portions of this
504 documentation, particularly the sections on the anatomy of a proper man
505 page, are taken from the B<pod2man> documentation by Tom.
507 =head1 COPYRIGHT AND LICENSE
509 Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>.
511 This program is free software; you may redistribute it and/or modify it
512 under the same terms as Perl itself.
518 close OUT or die "Can't close $file: $!";
519 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
520 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';