Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
Mercy Corps

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 50 guest(s) and 0 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

pod2man



SYNOPSIS

       pod2man [--section=manext] [--release=version] [--cen­
       ter=string] [--date=string] [--fixed=font] [--fixed­
       bold=font] [--fixeditalic=font] [--fixedbolditalic=font]
       [--name=name] [--official] [--lax] [--quotes=quotes]
       [--verbose] [input [output] ...]

       pod2man --help


DESCRIPTION

       pod2man is a front-end for Pod::Man, using it to generate
       *roff input from POD source.  The resulting *roff code is
       suitable for display on a terminal using nroff(1), nor­
       mally via man(1), or printing using troff(1).

       input is the file to read for POD source (the POD can be
       embedded in code).  If input isn't given, it defaults to
       STDIN.  output, if given, is the file to which to write
       the formatted output.  If output isn't given, the format­
       ted output is written to STDOUT.  Several POD files can be
       processed in the same pod2man invocation (saving module
       load and compile times) by providing multiple pairs of
       input and output files on the command line.

       --section, --release, --center, --date, and --official can
       be used to set the headers and footers to use; if not
       given, Pod::Man will assume various defaults.  See below
       or Pod::Man for details.

       pod2man assumes that your *roff formatters have a fixed-
       width font named CW.  If yours is called something else
       (like CR), use --fixed to specify it.  This generally only
       matters for troff output for printing.  Similarly, you can
       set the fonts used for bold, italic, and bold italic
       fixed-width output.

       Besides the obvious pod conversions, Pod::Man, and there­
       fore pod2man also takes care of formatting func(),
       func(n), and simple variable references like $foo or @bar
       so you don't have to use code escapes for them; complex
       expressions like $fred{'stuff'} will still need to be
       escaped, though.  It also translates dashes that aren't
       used as hyphens into en dashes, makes long dashes--like
       this--into proper em dashes, fixes "paired quotes," and
       takes care of several other troff-specific tweaks.  See
       Pod::Man for complete information.


OPTIONS

       -c string, --center=string
           Sets the centered page header to string.  The default
           is "User Contributed Perl Documentation", but also see
           --official below.
           Only matters for troff(1) output.

       --fixeditalic=font
           Italic version of the fixed-width font (actually,
           something of a misnomer, since most fixed-width fonts
           only have an oblique version, not an italic version).
           Defaults to CI.  Only matters for troff(1) output.

       --fixedbolditalic=font
           Bold italic (probably actually oblique) version of the
           fixed-width font.  Pod::Man doesn't assume you have
           this, and defaults to CB.  Some systems (such as
           Solaris) have this font available as CX.  Only matters
           for troff(1) output.

       -h, --help
           Print out usage information.

       -l, --lax
           No longer used.  pod2man used to check its input for
           validity as a manual page, but this should now be done
           by podchecker(1) instead.  Accepted for backwards com­
           patibility; this option no longer does anything.

       -n name, --name=name
           Set the name of the manual page to name.  Without this
           option, the manual name is set to the uppercased base
           name of the file being converted unless the manual
           section is 3, in which case the path is parsed to see
           if it is a Perl module path.  If it is, a path like
           ".../lib/Pod/Man.pm" is converted into a name like
           "Pod::Man".  This option, if given, overrides any
           automatic determination of the name.

           Note that this option is probably not useful when con­
           verting multiple POD files at once.  The convention
           for Unix man pages for commands is for the man page
           title to be in all-uppercase even if the command
           isn't.

       -o, --official
           Set the default header to indicate that this page is
           part of the standard Perl release, if --center is not
           also given.

       -q quotes, --quotes=quotes
           Sets the quote marks used to surround C<> text to
           quotes.  If quotes is a single character, it is used
           as both the left and right quote; if quotes is two
           characters, the first character is used as the left
           quote and the second as the right quoted; and if
           quotes is four characters, the first two are used as

       -s, --section
           Set the section for the ".TH" macro.  The standard
           section numbering convention is to use 1 for user com­
           mands, 2 for system calls, 3 for functions, 4 for
           devices, 5 for file formats, 6 for games, 7 for mis­
           cellaneous information, and 8 for administrator com­
           mands.  There is a lot of variation here, however;
           some systems (like Solaris) use 4 for file formats, 5
           for miscellaneous information, and 7 for devices.
           Still others use 1m instead of 8, or some mix of both.
           About the only section numbers that are reliably con­
           sistent are 1, 2, and 3.

           By default, section 1 will be used unless the file
           ends in .pm in which case section 3 will be selected.

       -v, --verbose
           Print out the name of each output file as it is being
           generated.


DIAGNOSTICS

       If pod2man fails with errors, see Pod::Man and Pod::Parser
       for information about what those errors might mean.


EXAMPLES

           pod2man program > program.1
           pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
           pod2man --section=7 note.pod > note.7

       If you would like to print out a lot of man page continu­
       ously, you probably want to set the C and D registers to
       set contiguous page numbering and even/odd paging, at
       least on some versions of man(7).

           troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...

       To get index entries on stderr, turn on the F register, as
       in:

           troff -man -rF1 perl.1

       The indexing merely outputs messages via ".tm" for each
       major page, section, subsection, item, and any "X<>"
       directives.  See Pod::Man for more details.


BUGS

       Lots of this documentation is duplicated from Pod::Man.


NOTES

       For those not sure of the proper layout of a man page,
       here are some notes on writing a proper man page.
       the form of man page references so that cross-referencing
       tools can provide the user with links and the like.  It's
       possible to overdo this, though, so be careful not to
       clutter your documentation with too much markup.

       The major headers should be set out using a "=head1"
       directive, and are historically written in the rather
       startling ALL UPPER CASE format, although this is not
       mandatory.  Minor headers may be included using "=head2",
       and are typically in mixed case.

       The standard sections of a manual page are:

       NAME
           Mandatory section; should be a comma-separated list of
           programs or functions documented by this podpage, such
           as:

               foo, bar - programs to do something

           Manual page indexers are often extremely picky about
           the format of this section, so don't put anything in
           it except this line.  A single dash, and only a single
           dash, should separate the list of programs or func­
           tions from the description.  Functions should not be
           qualified with "()" or the like.  The description
           should ideally fit on a single line, even if a man
           program replaces the dash with a few tabs.

       SYNOPSIS
           A short usage summary for programs and functions.
           This section is mandatory for section 3 pages.

       DESCRIPTION
           Extended description and discussion of the program or
           functions, or the body of the documentation for man
           pages that document something else.  If particularly
           long, it's a good idea to break this up into subsec­
           tions "=head2" directives like:

               =head2 Normal Usage

               =head2 Advanced Features

               =head2 Writing Configuration Files

           or whatever is appropriate for your documentation.

       OPTIONS
           Detailed description of each of the command-line
           options taken by the program.  This should be separate
           from the description for the use of things like
           the above would be:

               =item B<-s> I<manext>, B<--section>=I<manext>

           (Writing the short option first is arguably easier to
           read, since the long option is long enough to draw the
           eye to it anyway and the short option can otherwise
           get lost in visual noise.)

       RETURN VALUE
           What the program or function returns, if successful.
           This section can be omitted for programs whose precise
           exit codes aren't important, provided they return 0 on
           success as is standard.  It should always be present
           for functions.

       ERRORS
           Exceptions, error return codes, exit statuses, and
           errno settings.  Typically used for function documen­
           tation; program documentation uses DIAGNOSTICS
           instead.  The general rule of thumb is that errors
           printed to STDOUT or STDERR and intended for the end
           user are documented in DIAGNOSTICS while errors passed
           internal to the calling program and intended for other
           programmers are documented in ERRORS.  When document­
           ing a function that sets errno, a full list of the
           possible errno values should be given here.

       DIAGNOSTICS
           All possible messages the program can print out--and
           what they mean.  You may wish to follow the same docu­
           mentation style as the Perl documentation; see perl­
           diag(1) for more details (and look at the POD source
           as well).

           If applicable, please include details on what the user
           should do to correct the error; documenting an error
           as indicating "the input buffer is too small" without
           telling the user how to increase the size of the input
           buffer (or at least telling them that it isn't possi­
           ble) aren't very useful.

       EXAMPLES
           Give some example uses of the program or function.
           Don't skimp; users often find this the most useful
           part of the documentation.  The examples are generally
           given as verbatim paragraphs.

           Don't just present an example without explaining what
           it does.  Adding a short paragraph saying what the
           example will do can increase the value of the example
           immensely.

           Since environment variables are normally in all upper­
           case, no additional special formatting is generally
           needed; they're glaring enough as it is.

       FILES
           All files used by the program or function, normally
           presented as a list, and what it uses them for.  File
           names should be enclosed in F<>.  It's particularly
           important to document files that will be potentially
           modified.

       CAVEATS
           Things to take special care with, sometimes called
           WARNINGS.

       BUGS
           Things that are broken or just don't work quite right.

       RESTRICTIONS
           Bugs you don't plan to fix.  :-)

       NOTES
           Miscellaneous commentary.

       SEE ALSO
           Other man pages to check out, like man(1), man(7),
           makewhatis(8), or catman(8).  Normally a simple list
           of man pages separated by commas, or a paragraph giv­
           ing the name of a reference work.  Man page refer­
           ences, if they use the standard "name(section)" form,
           don't have to be enclosed in L<> (although it's recom­
           mended), but other things in this section probably
           should be when appropriate.

           If the package has a mailing list, include a URL or
           subscription instructions here.

           If the package has a web site, include a URL here.

       AUTHOR
           Who wrote it (use AUTHORS for multiple people).
           Including your current e-mail address (or some e-mail
           address to which bug reports should be sent) so that
           users have a way of contacting you is a good idea.
           Remember that program documentation tends to roam the
           wild for far longer than you expect and pick an e-mail
           address that's likely to last if possible.

       COPYRIGHT AND LICENSE
           For copyright

           choose any licensing.

       HISTORY
           Programs derived from other sources sometimes have
           this, or you might keep a modification log here.  If
           the log gets overly long or detailed, consider main­
           taining it in a separate file, though.

       In addition, some systems use CONFORMING TO to note con­
       formance to relevant standards and MT-LEVEL to note safe­
       ness for use in threaded programs or signal handlers.
       These headings are primarily useful when documenting parts
       of a C library.  Documentation of object-oriented
       libraries or modules may use CONSTRUCTORS and METHODS sec­
       tions for detailed documentation of the parts of the
       library and save the DESCRIPTION section for an overview;
       other large modules may use FUNCTIONS for similar reasons.
       Some people use OVERVIEW to summarize the description if
       it's quite long.

       Section ordering varies, although NAME should always be
       the first section (you'll break some man page systems oth­
       erwise), and NAME, SYNOPSIS, DESCRIPTION, and OPTIONS gen­
       erally always occur first and in that order if present.
       In general, SEE ALSO, AUTHOR, and similar material should
       be left for last.  Some systems also move WARNINGS and
       NOTES to last.  The order given above should be reasonable
       for most purposes.

       Finally, as a general note, try not to use an excessive
       amount of markup.  As documented here and in Pod::Man, you
       can safely leave Perl variables, function names, man page
       references, and the like unadorned by markup and the POD
       translators will figure it out for you.  This makes it
       much easier to later edit the documentation.  Note that
       many existing translators (including this one currently)
       will do the wrong thing with e-mail addresses or URLs when
       wrapped in L<>, so don't do that.

       For additional information that may be more accurate for
       your specific system, see either man(5) or man(7) depend­
       ing on your system manual section numbering conventions.


SEE ALSO

       Pod::Man, Pod::Parser, man(1), nroff(1), podchecker(1),
       troff(1), man(7)

       The man page documenting the an macro set may be man(5)
       instead of man(7) on your system.

       The current version of this script is always available
       from its web site at <http://www.eyrie.org/~eagle/soft­
       This program is free software; you may redistribute it
       and/or modify it under the same terms as Perl itself.

perl v5.8.1                 2003-09-23                 POD2MAN(1)
  




Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
The Linux Tutorial can use your help.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.09 Seconds