.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Forest 3pm"
.TH Forest 3pm "2022-06-14" "perl v5.34.0" "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"
Forest \- A collection of n\-ary tree related modules
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Forest is intended to be a replacement for the Tree::Simple family of modules,
and fixes many of the issues that have always bothered me about them. It is by
no means a complete replacement yet, but should eventually grow to become that.
.PP
For more information please refer to the individual module documentation,
starting with Forest::Tree.
.SH "TODO"
.IX Header "TODO"
.IP "More documentation" 4
.IX Item "More documentation"
This is 0.10 so it is (still) lacking quite a bit of docs (I am being really lazy sorry).
Although I invite people to read the source, it is quite simple really.
.IP "More tests" 4
.IX Item "More tests"
The coverage is in the low 90s, but there is still a lot of behavioral stuff that could
use some testing too.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Tree::Simple" 4
.IX Item "Tree::Simple"
I wrote this module a few years ago and I had served me well, but recently I find
myself getting frustrated with some of the uglier bits of this module. So Forest is
a re-write of this module.
.IP "Tree" 4
.IX Item "Tree"
This is an ambitious project to replace all the Tree related modules with a single
core implementation. There is some good code in here, but the project seems to be
very much on the back-burner at this time.
.IP "OCaml port of Forest" 4
.IX Item "OCaml port of Forest"
Ask me about the OCaml port of this module, it is also sitting on my hard drive
waiting for release. It actually helped quite a bit in terms of helping me settle
on the APIs for this module. Static typing can be very helpful sometimes.
.SH "BUGS"
.IX Header "BUGS"
All complex software has bugs lurking in it, and this module is no
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan.little@iinteractive.com>
.PP
With contributions from:
.PP
Yuval (nothingmuch) Kogman
.PP
Guillermo (groditi) Roditi
.PP
Florian (rafl) Ragwitz
.PP
Jesse (doy) Luehrs
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2008\-2014 Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.