.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.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" ''
.    ds C`
.    ds C'
'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 >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Tree::Pod 3pm"
.TH Pod::Tree::Pod 3pm "2019-02-25" "perl v5.28.1" "User Contributed Perl Documentation"
.\" 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::Tree::Pod \- Convert a Pod::Tree back to a POD
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Pod::Tree::Pod;
\&
\&  $tree =  Pod::Tree\->new;
\&    
\&  $dest =  IO::File\->new;
\&  $dest = "file.pod";
\&
\&  $pod  =  Pod::Tree::Pod\->new($tree, $dest);
\&
\&  $pod\->translate;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Pod::Tree::Pod\*(C'\fR converts a Pod::Tree back to a \s-1POD.\s0
The destination is fixed when the object is created.
The \f(CW\*(C`translate\*(C'\fR method does the actual translation.
.PP
For convenience, 
Pod::Tree::Pod can write the \s-1POD\s0 to a variety of destinations.
The \f(CW\*(C`new\*(C'\fR method resolves the \fI\f(CI$dest\fI\fR argument.
.SS "Destination resolution"
.IX Subsection "Destination resolution"
\&\f(CW\*(C`Pod::Tree::Pod\*(C'\fR can write \s-1HTML\s0 to either of 2 destinations.
\&\f(CW\*(C`new\*(C'\fR resolves \fI\f(CI$dest\fI\fR by checking these things,
in order:
.IP "1." 4
If \fI\f(CI$dest\fI\fR is a reference,
then it is taken to be an \f(CW\*(C`IO::File\*(C'\fR object
that is already open on the file where the \s-1POD\s0 will be written.
.IP "2." 4
If \fI\f(CI$dest\fI\fR is not a reference,
then it is taken to be the name of the file where the \s-1POD\s0 will be written.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "\fI\f(CI$pod\fI\fR = ""new"" ""Pod::Tree::Pod"" \fI\f(CI$tree\fI\fR, \fI\f(CI$dest\fI\fR" 4
.el .IP "\fI\f(CI$pod\fI\fR = \f(CWnew\fR \f(CWPod::Tree::Pod\fR \fI\f(CI$tree\fI\fR, \fI\f(CI$dest\fI\fR" 4
.IX Item "$pod = new Pod::Tree::Pod $tree, $dest"
Creates a new \f(CW\*(C`Pod::Tree::Pod\*(C'\fR object.
.Sp
\&\fI\f(CI$tree\fI\fR is a \f(CW\*(C`Pod::Tree\*(C'\fR object that represents a \s-1POD.\s0
\&\fI\f(CI$pod\fI\fR writes the \s-1POD\s0 to \fI\f(CI$dest\fI\fR.
See \*(L"Destination resolution\*(R" for details.
.ie n .IP "\fI\f(CI$pod\fI\fR\->""translate""" 4
.el .IP "\fI\f(CI$pod\fI\fR\->\f(CWtranslate\fR" 4
.IX Item "$pod->translate"
Writes the text of the \s-1POD.\s0
This method should only be called once.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP """Pod::Tree::Pod::new: not enough arguments""" 4
.el .IP "\f(CWPod::Tree::Pod::new: not enough arguments\fR" 4
.IX Item "Pod::Tree::Pod::new: not enough arguments"
(F) \f(CW\*(C`new\*(C'\fR called with fewer than 2 arguments.
.ie n .IP """Pod::Tree::HTML::new: Can\*(Aqt open $dest: $!""" 4
.el .IP "\f(CWPod::Tree::HTML::new: Can\*(Aqt open $dest: $!\fR" 4
.IX Item "Pod::Tree::HTML::new: Cant open $dest: $!"
(F) The destination file couldn't be opened.
.SH "NOTES"
.IX Header "NOTES"
.IP "\(bu" 4
The destination doesn't actually have to be an \f(CW\*(C`IO::File\*(C'\fR object.
It may be any object that has a \f(CW\*(C`print\*(C'\fR method.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), \f(CW\*(C`Pod::Tree\*(C'\fR, \f(CW\*(C`Pod::Tree::Node\*(C'\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven McDougall, swmcd@world.std.com
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2000\-2003 by Steven McDougall. This module is free
software; you can redistribute it and/or modify it under the same
terms as Perl itself.