pod2man.1

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

.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POD2MAN 1"
.TH POD2MAN 1 "2008-01-23" "perl v5.10.0" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pod2man \- Convert POD data to formatted *roff input
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
pod2man [\fB\-\-section\fR=\fImanext\fR] [\fB\-\-release\fR[=\fIversion\fR]]
[\fB\-\-center\fR=\fIstring\fR] [\fB\-\-date\fR=\fIstring\fR] [\fB\-\-fixed\fR=\fIfont\fR]
[\fB\-\-fixedbold\fR=\fIfont\fR] [\fB\-\-fixeditalic\fR=\fIfont\fR]
[\fB\-\-fixedbolditalic\fR=\fIfont\fR] [\fB\-\-name\fR=\fIname\fR] [\fB\-\-official\fR]
[\fB\-\-lax\fR] [\fB\-\-quotes\fR=\fIquotes\fR] [\fB\-\-verbose\fR]
[\fIinput\fR [\fIoutput\fR] ...]
.PP
pod2man \fB\-\-help\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpod2man\fR is a front-end for Pod::Man, using it to generate *roff input
from \s-1POD\s0 source.  The resulting *roff code is suitable for display on a
terminal using \fInroff\fR\|(1), normally via \fIman\fR\|(1), or printing using \fItroff\fR\|(1).
.PP
\&\fIinput\fR is the file to read for \s-1POD\s0 source (the \s-1POD\s0 can be embedded in
code).  If \fIinput\fR isn't given, it defaults to \s-1STDIN\s0.  \fIoutput\fR, if given,
is the file to which to write the formatted output.  If \fIoutput\fR isn't
given, the formatted output is written to \s-1STDOUT\s0.  Several \s-1POD\s0 files can be
processed in the same \fBpod2man\fR invocation (saving module load and compile
times) by providing multiple pairs of \fIinput\fR and \fIoutput\fR files on the
command line.
.PP
\&\fB\-\-section\fR, \fB\-\-release\fR, \fB\-\-center\fR, \fB\-\-date\fR, and \fB\-\-official\fR 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.
.PP
\&\fBpod2man\fR assumes that your *roff formatters have a fixed-width font named
\&\s-1CW\s0.  If yours is called something else (like \s-1CR\s0), use \fB\-\-fixed\fR 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.
.PP
Besides the obvious pod conversions, Pod::Man, and therefore pod2man also
takes care of formatting \fIfunc()\fR, func(n), and simple variable references
like \f(CW$foo\fR or \f(CW@bar\fR so you 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" and
takes care of several other troff-specific tweaks.  See Pod::Man for
complete information.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR \fIstring\fR, \fB\-\-center\fR=\fIstring\fR" 4
.IX Item "-c string, --center=string"
Sets the centered page header to \fIstring\fR.  The default is \*(L"User
Contributed Perl Documentation\*(R", but also see \fB\-\-official\fR below.
.IP "\fB\-d\fR \fIstring\fR, \fB\-\-date\fR=\fIstring\fR" 4
.IX Item "-d string, --date=string"
Set the left-hand footer string to this value.  By default, the modification
date of the input file will be used, or the current date if input comes from
\&\s-1STDIN\s0.
.IP "\fB\-\-fixed\fR=\fIfont\fR" 4
.IX Item "--fixed=font"
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 \fItroff\fR\|(1) output.
.IP "\fB\-\-fixedbold\fR=\fIfont\fR" 4
.IX Item "--fixedbold=font"
Bold version of the fixed-width font.  Defaults to \s-1CB\s0.  Only matters for
\&\fItroff\fR\|(1) output.
.IP "\fB\-\-fixeditalic\fR=\fIfont\fR" 4
.IX Item "--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 \s-1CI\s0.  Only matters for \fItroff\fR\|(1) output.
.IP "\fB\-\-fixedbolditalic\fR=\fIfont\fR" 4
.IX Item "--fixedbolditalic=font"
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 \fItroff\fR\|(1)
output.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Print out usage information.
.IP "\fB\-l\fR, \fB\-\-lax\fR" 4
.IX Item "-l, --lax"
No longer used.  \fBpod2man\fR used to check its input for validity as a manual
page, but this should now be done by \fIpodchecker\fR\|(1) instead.  Accepted for
backwards compatibility; this option no longer does anything.
.IP "\fB\-n\fR \fIname\fR, \fB\-\-name\fR=\fIname\fR" 4
.IX Item "-n name, --name=name"
Set the name of the manual page to \fIname\fR.  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.
.Sp
Note that this option is probably not useful when converting multiple \s-1POD\s0
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.
.IP "\fB\-o\fR, \fB\-\-official\fR" 4
.IX Item "-o, --official"
Set the default header to indicate that this page is part of the standard
Perl release, if \fB\-\-center\fR is not also given.
.IP "\fB\-q\fR \fIquotes\fR, \fB\-\-quotes\fR=\fIquotes\fR" 4
.IX Item "-q quotes, --quotes=quotes"
Sets the quote marks used to surround C<> text to \fIquotes\fR.  If
\&\fIquotes\fR is a single character, it is used as both the left and right
quote; if \fIquotes\fR is two characters, the first character is used as the
left quote and the second as the right quoted; and if \fIquotes\fR is four
characters, the first two are used as the left quote and the second two as
the right quote.
.Sp
\&\fIquotes\fR 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 "\fB\-r\fR, \fB\-\-release\fR" 4
.IX Item "-r, --release"
Set the centered footer.  By default, this is the version of Perl you run
\&\fBpod2man\fR 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 \fB\-\-release\fR to
the last modified date and \fB\-\-date\fR to the version number.
.IP "\fB\-s\fR, \fB\-\-section\fR" 4
.IX Item "-s, --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.
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
.IX Item "-v, --verbose"
Print out the name of each output file as it is being generated.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
If \fBpod2man\fR fails with errors, see Pod::Man and Pod::Simple for
information about what those errors might mean.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 3