pod::simple.3

视频监控网络部分的协议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 "Pod::Simple 3"
.TH Pod::Simple 3 "2007-12-18" "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"
Pod::Simple \- framework for parsing Pod
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& TODO
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Pod::Simple is a Perl library for parsing text in the Pod (\*(L"plain old
documentation\*(R") markup language that is typically used for writing
documentation for Perl and for Perl modules. The Pod format is explained
in the perlpod man page; the most common formatter is called
\&\*(L"perldoc\*(R".
.PP
Pod formatters can use Pod::Simple to parse Pod documents into produce
renderings of them in plain \s-1ASCII\s0, in \s-1HTML\s0, or in any number of other
formats. Typically, such formatters will be subclasses of Pod::Simple,
and so they will inherit its methods, like \f(CW\*(C`parse_file\*(C'\fR.
.PP
If you're reading this document just because you have a Pod-processing
subclass that you want to use, this document (plus the documentation for
the subclass) is probably all you'll need to read.
.PP
If you're reading this document because you want to write a formatter
subclass, continue reading this document, and then read
Pod::Simple::Subclassing, and then possibly even read perlpodspec
(some of which is for parser-writers, but much of which is notes to
formatter-writers).
.SH "MAIN METHODS"
.IX Header "MAIN METHODS"
.ie n .IP """$parser = \f(CISomeClass\f(CW\->new();""" 4
.el .IP "\f(CW$parser = \f(CISomeClass\f(CW\->new();\fR" 4
.IX Item "$parser = SomeClass->new();"
This returns a new parser object, where \fI\f(CI\*(C`SomeClass\*(C'\fI\fR is a subclass
of Pod::Simple.
.ie n .IP """$parser\->output_fh( *OUT );""" 4
.el .IP "\f(CW$parser\->output_fh( *OUT );\fR" 4
.IX Item "$parser->output_fh( *OUT );"
This sets the filehandle that \f(CW$parser\fR's output will be written to.
You can pass \f(CW*STDOUT\fR, otherwise you should probably do something
like this:
.Sp
.Vb 3
\&    my $outfile = "output.txt";
\&    open TXTOUT, ">$outfile" or die "Can\*(Aqt write to $outfile: $!";
\&    $parser\->output_fh(*TXTOUT);
.Ve
.Sp
\&...before you call one of the \f(CW\*(C`$parser\->parse_\f(CIwhatever\f(CW\*(C'\fR methods.
.ie n .IP """$parser\->output_string( \e$somestring );""" 4
.el .IP "\f(CW$parser\->output_string( \e$somestring );\fR" 4
.IX Item "$parser->output_string( $somestring );"
This sets the string that \f(CW$parser\fR's output will be sent to,
instead of any filehandle.
.ie n .IP """$parser\->parse_file( \f(CI$some_filename\f(CW );""" 4
.el .IP "\f(CW$parser\->parse_file( \f(CI$some_filename\f(CW );\fR" 4
.IX Item "$parser->parse_file( $some_filename );"
.PD 0
.ie n .IP """$parser\->parse_file( *INPUT_FH );""" 4
.el .IP "\f(CW$parser\->parse_file( *INPUT_FH );\fR" 4
.IX Item "$parser->parse_file( *INPUT_FH );"
.PD
This reads the Pod content of the file (or filehandle) that you specify,
and processes it with that \f(CW$parser\fR object, according to however
\&\f(CW$parser\fR's class works, and according to whatever parser options you
have set up for this \f(CW$parser\fR object.
.ie n .IP """$parser\->parse_string_document( \f(CI$all_content\f(CW );""" 4
.el .IP "\f(CW$parser\->parse_string_document( \f(CI$all_content\f(CW );\fR" 4
.IX Item "$parser->parse_string_document( $all_content );"
This works just like \f(CW\*(C`parse_file\*(C'\fR except that it reads the Pod
content not from a file, but from a string that you have already
in memory.
.ie n .IP """$parser\->parse_lines( \f(CI...@lines...\f(CW, undef );""" 4
.el .IP "\f(CW$parser\->parse_lines( \f(CI...@lines...\f(CW, undef );\fR" 4
.IX Item "$parser->parse_lines( ...@lines..., undef );"
This processes the lines in \f(CW@lines\fR (where each list item must be a
defined value, and must contain exactly one line of content \*(-- so no
items like \f(CW"foo\enbar"\fR are allowed).  The final \f(CW\*(C`undef\*(C'\fR is used to
indicate the end of document being parsed.
.Sp
The other \f(CW\*(C`parser_\f(CIwhatever\f(CW\*(C'\fR methods are meant to be called only once
per \f(CW$parser\fR object; but \f(CW\*(C`parse_lines\*(C'\fR can be called as many times per
\&\f(CW$parser\fR object as you want, as long as the last call (and only
the last call) ends with an \f(CW\*(C`undef\*(C'\fR value.
.ie n .IP """$parser\->content_seen""" 4
.el .IP "\f(CW$parser\->content_seen\fR" 4
.IX Item "$parser->content_seen"
This returns true only if there has been any real content seen
for this document.
.ie n .IP """\f(CISomeClass\f(CW\->filter( \f(CI$filename\f(CW );""" 4
.el .IP "\f(CW\f(CISomeClass\f(CW\->filter( \f(CI$filename\f(CW );\fR" 4
.IX Item "SomeClass->filter( $filename );"
.PD 0
.ie n .IP """\f(CISomeClass\f(CW\->filter( \f(CI*INPUT_FH\f(CW );""" 4
.el .IP "\f(CW\f(CISomeClass\f(CW\->filter( \f(CI*INPUT_FH\f(CW );\fR" 4
.IX Item "SomeClass->filter( *INPUT_FH );"
.ie n .IP """\f(CISomeClass\f(CW\->filter( \f(CI\e$document_content\f(CW );""" 4
.el .IP "\f(CW\f(CISomeClass\f(CW\->filter( \f(CI\e$document_content\f(CW );\fR" 4
.IX Item "SomeClass->filter( $document_content );"
.PD
This is a shortcut method for creating a new parser object, setting the
output handle to \s-1STDOUT\s0, and then processing the specified file (or
filehandle, or in-memory document). This is handy for one-liners like
this:
.Sp
.Vb 1
\&  perl \-MPod::Simple::Text \-e "Pod::Simple::Text\->filter(\*(Aqthingy.pod\*(Aq)"
.Ve
.SH "SECONDARY METHODS"
.IX Header "SECONDARY METHODS"
Some of these methods might be of interest to general users, as
well as of interest to formatter-writers.
.PP
Note that the general pattern here is that the accessor-methods
read the attribute's value with \f(CW\*(C`$value = $parser\->\f(CIattribute\f(CW\*(C'\fR
and set the attribute's value with
\&\f(CW\*(C`$parser\->\f(CIattribute\f(CW(\f(CInewvalue\f(CW)\*(C'\fR.  For each accessor, I typically
only mention one syntax or another, based on which I think you are actually
most likely to use.
.ie n .IP """$parser\->no_whining( \f(CISOMEVALUE\f(CW )""" 4
.el .IP "\f(CW$parser\->no_whining( \f(CISOMEVALUE\f(CW )\fR" 4
.IX Item "$parser->no_whining( SOMEVALUE )"
If you set this attribute to a true value, you will suppress the
parser's complaints about irregularities in the Pod coding. By default,
this attribute's value is false, meaning that irregularities will
be reported.
.Sp
Note that turning this attribute to true won't suppress one or two kinds
of complaints about rarely occurring unrecoverable errors.
.ie n .IP """$parser\->no_errata_section( \f(CISOMEVALUE\f(CW )""" 4
.el .IP "\f(CW$parser\->no_errata_section( \f(CISOMEVALUE\f(CW )\fR" 4
.IX Item "$parser->no_errata_section( SOMEVALUE )"
If you set this attribute to a true value, you will stop the parser from
generating a \*(L"\s-1POD\s0 \s-1ERRORS\s0\*(R" section at the end of the document. By
default, this attribute's value is false, meaning that an errata section
will be generated, as necessary.
.ie n .IP """$parser\->complain_stderr( \f(CISOMEVALUE\f(CW )""" 4
.el .IP "\f(CW$parser\->complain_stderr( \f(CISOMEVALUE\f(CW )\fR" 4
.IX Item "$parser->complain_stderr( SOMEVALUE )"
If you set this attribute to a true value, it will send reports of
parsing errors to \s-1STDERR\s0. By default, this attribute's value is false,
meaning that no output is sent to \s-1STDERR\s0.
.Sp
Note that errors can be noted in an errata section, or sent to \s-1STDERR\s0,
or both, or neither. So don't think that turning on \f(CW\*(C`complain_stderr\*(C'\fR
will turn off \f(CW\*(C`no_errata_section\*(C'\fR or vice versa \*(-- these are
independent attributes.
.ie n .IP """$parser\->source_filename""" 4
.el .IP "\f(CW$parser\->source_filename\fR" 4
.IX Item "$parser->source_filename"
This returns the filename that this parser object was set to read from.
.ie n .IP """$parser\->doc_has_started""" 4
.el .IP "\f(CW$parser\->doc_has_started\fR" 4
.IX Item "$parser->doc_has_started"
This returns true if \f(CW$parser\fR has read from a source, and has seen
Pod content in it.
.ie n .IP """$parser\->source_dead""" 4
.el .IP "\f(CW$parser\->source_dead\fR" 4
.IX Item "$parser->source_dead"
This returns true if \f(CW$parser\fR has read from a source, and come to the
end of that source.
.SH "CAVEATS"
.IX Header "CAVEATS"
This is just a beta release \*(-- there are a good number of things still
left to do.  Notably, support for \s-1EBCDIC\s0 platforms is still half-done,
an untested.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple::Subclassing
.PP
perlpod
.PP
perlpodspec
.PP
Pod::Escapes
.PP
perldoc
.SH "COPYRIGHT AND DISCLAIMERS"
.IX Header "COPYRIGHT AND DISCLAIMERS"
Copyright (c) 2002 Sean M. Burke.  All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
.SH "AUTHOR"
.IX Header "AUTHOR"
Original author: Sean M. Burke \f(CW\*(C`[e-mail]\*(C'\fR
.PP
Maintained by: Allison Randal \f(CW\*(C`[e-mail]\*(C'\fR