pod::man.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

don't have to use code escapes for them; complex expressions like
\&\f(CW$fred{\*(Aqstuff\*(Aq}\fR 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 \*(L"paired quotes,\*(R" makes \*(C+ look right,
puts a little space between double underbars, makes \s-1ALLCAPS\s0 a teeny bit
smaller in \fBtroff\fR, and escapes stuff that *roff treats as special so that
you don't have to.
.PP
The recognized options to \fInew()\fR are as follows.  All options take a single
argument.
.IP "center" 4
.IX Item "center"
Sets the centered page header to use instead of \*(L"User Contributed Perl
Documentation\*(R".
.IP "date" 4
.IX Item "date"
Sets the left-hand footer.  By default, the modification date of the input
file will be used, or the current date if \fIstat()\fR can't find that file (the
case if the input is from \s-1STDIN\s0), and the date will be formatted as
YYYY-MM-DD.
.IP "fixed" 4
.IX Item "fixed"
The fixed-width font to use for vertabim text and code.  Defaults to \s-1CW\s0.
Some systems may want \s-1CR\s0 instead.  Only matters for \fBtroff\fR output.
.IP "fixedbold" 4
.IX Item "fixedbold"
Bold version of the fixed-width font.  Defaults to \s-1CB\s0.  Only matters for
\&\fBtroff\fR output.
.IP "fixeditalic" 4
.IX Item "fixeditalic"
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 \s-1CI\s0.  Only matters for \fBtroff\fR output.
.IP "fixedbolditalic" 4
.IX Item "fixedbolditalic"
Bold italic (probably actually oblique) version of the fixed-width font.
Pod::Man doesn't assume you have this, and defaults to \s-1CB\s0.  Some systems
(such as Solaris) have this font available as \s-1CX\s0.  Only matters for \fBtroff\fR
output.
.IP "name" 4
.IX Item "name"
Set the name of the manual page.  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 \f(CW\*(C`.../lib/Pod/Man.pm\*(C'\fR is converted into
a name like \f(CW\*(C`Pod::Man\*(C'\fR.  This option, if given, overrides any automatic
determination of the name.
.IP "quotes" 4
.IX Item "quotes"
Sets the quote marks used to surround C<> text.  If the value is a
single character, it is used as both the left and right quote; if it is two
characters, the first character is used as the left quote and the second as
the right quoted; and if it is four characters, the first two are used as
the left quote and the second two as the right quote.
.Sp
This may also be set to the special value \f(CW\*(C`none\*(C'\fR, in which case no quote
marks are added around C<> text (but the font is still changed for troff
output).
.IP "release" 4
.IX Item "release"
Set the centered footer.  By default, this is the version of Perl you run
Pod::Man under.  Note that some system an macro sets assume that the
centered footer will be a modification date and will prepend something like
\&\*(L"Last modified: \*(R"; if this is the case, you may want to set \f(CW\*(C`release\*(C'\fR to
the last modified date and \f(CW\*(C`date\*(C'\fR to the version number.
.IP "section" 4
.IX Item "section"
Set the section for the \f(CW\*(C`.TH\*(C'\fR macro.  The standard section numbering
convention is to use 1 for user commands, 2 for system calls, 3 for
functions, 4 for devices, 5 for file formats, 6 for games, 7 for
miscellaneous information, and 8 for administrator commands.  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 consistent are 1, 2, and 3.
.Sp
By default, section 1 will be used unless the file ends in .pm in which case
section 3 will be selected.
.PP
The standard Pod::Simple method \fIparse_file()\fR takes one argument naming the
\&\s-1POD\s0 file to read from.  By default, the output is sent to \s-1STDOUT\s0, but this
can be changed with the \fIoutput_fd()\fR method.
.PP
The standard Pod::Simple method \fIparse_from_file()\fR takes up to two
arguments, the first being the input file to read \s-1POD\s0 from and the second
being the file to write the formatted output to.
.PP
You can also call \fIparse_lines()\fR to parse an array of lines or
\&\fIparse_string_document()\fR to parse a document already in memory.  To put the
output into a string instead of a file handle, call the \fIoutput_string()\fR
method.  See Pod::Simple for the specific details.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP "roff font should be 1 or 2 chars, not ""%s""" 4
.el .IP "roff font should be 1 or 2 chars, not ``%s''" 4
.IX Item "roff font should be 1 or 2 chars, not %s"
(F) You specified a *roff font (using \f(CW\*(C`fixed\*(C'\fR, \f(CW\*(C`fixedbold\*(C'\fR, etc.) that
wasn't either one or two characters.  Pod::Man doesn't support *roff fonts
longer than two characters, although some *roff extensions do (the canonical
versions of \fBnroff\fR and \fBtroff\fR don't either).
.ie n .IP "Invalid quote specification ""%s""" 4
.el .IP "Invalid quote specification ``%s''" 4
.IX Item "Invalid quote specification %s"
(F) The quote specification given (the quotes option to the constructor) was
invalid.  A quote specification must be one, two, or four characters long.
.SH "BUGS"
.IX Header "BUGS"
Eight-bit input data isn't handled at all well at present.  The correct
approach would be to map E<> escapes to the appropriate \s-1UTF\-8\s0
characters and then do a translation pass on the output according to the
user-specified output character set.  Unfortunately, we can't send eight-bit
data directly to the output unless the user says this is okay, since some
vendor *roff implementations can't handle eight-bit data.  If the *roff
implementation can, however, that's far superior to the current hacked
characters that only work under troff.
.PP
There is currently no way to turn off the guesswork that tries to format
unmarked text appropriately, and sometimes it isn't wanted (particularly
when using \s-1POD\s0 to document something other than Perl).  Most of the work
towards fixing this has now been done, however, and all that's still needed
is a user interface.
.PP
The \s-1NAME\s0 section should be recognized specially and index entries emitted
for everything in that section.  This would have to be deferred until the
next section, since extraneous things in \s-1NAME\s0 tends to confuse various man
page processors.  Currently, no index entries are emitted for anything in
\&\s-1NAME\s0.
.PP
Pod::Man doesn't handle font names longer than two characters.  Neither do
most \fBtroff\fR implementations, but \s-1GNU\s0 troff does as an extension.  It would
be nice to support as an option for those who want to use it.
.PP
The preamble added to each output file is rather verbose, and most of it
is only necessary in the presence of non-ASCII characters.  It would
ideally be nice if all of those definitions were only output if needed,
perhaps on the fly as the characters are used.
.PP
Pod::Man is excessively slow.
.SH "CAVEATS"
.IX Header "CAVEATS"
The handling of hyphens and em dashes is somewhat fragile, and one may get
the wrong one under some circumstances.  This should only matter for
\&\fBtroff\fR output.
.PP
When and whether to use small caps is somewhat tricky, and Pod::Man doesn't
necessarily get it right.
.PP
Converting neutral double quotes to properly matched double quotes doesn't
work unless there are no formatting codes between the quote marks.  This
only matters for troff output.
.SH "AUTHOR"
.IX Header "AUTHOR"
Russ Allbery <[e-mail]>, based \fIvery\fR heavily on the original
\&\fBpod2man\fR by Tom Christiansen <[e-mail]>.  The modifications to
work with Pod::Simple instead of Pod::Parser were originally contributed by
Sean Burke (but I've since hacked them beyond recognition and all bugs are
mine).
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
by Russ Allbery <[e-mail]>.
.PP
This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple, \fIperlpod\fR\|(1), \fIpod2man\fR\|(1), \fInroff\fR\|(1), \fItroff\fR\|(1),
\&\fIman\fR\|(1), \fIman\fR\|(7)
.PP
Ossanna, Joseph F., and Brian W. Kernighan.  \*(L"Troff User's Manual,\*(R"
Computing Science Technical Report No. 54, \s-1AT&T\s0 Bell Laboratories.  This is
the best documentation of standard \fBnroff\fR and \fBtroff\fR.  At the time of
this writing, it's available at
<http://www.cs.bell\-labs.com/cm/cs/cstr.html>.
.PP
The man page documenting the man macro set may be \fIman\fR\|(5) instead of
\&\fIman\fR\|(7) on your system.  Also, please see \fIpod2man\fR\|(1) for extensive
documentation on writing manual pages if you've not done it before and
aren't familiar with the conventions.
.PP
The current version of this module is always available from its web site at
<http://www.eyrie.org/~eagle/software/podlators/>.  It is also part of the
Perl core distribution as of 5.6.0.