{
    "content": [
        {
            "type": "text",
            "text": "# Pod::Text (info)\n\n## NAME\n\nPod::Text - Convert POD data to formatted text\n\n## SYNOPSIS\n\nuse Pod::Text;\nmy $parser = Pod::Text->new (sentence => 1, width => 78);\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');\n\n## DESCRIPTION\n\nPod::Text is a module that can convert documentation in the POD format\n(the preferred language for documenting Perl) into formatted text.  It\nuses no special formatting controls or codes whatsoever, and its output\nis therefore suitable for nearly any device.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **DIAGNOSTICS**\n- **BUGS**\n- **CAVEATS**\n- **NOTES**\n- **AUTHOR**\n- **COPYRIGHT AND LICENSE**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Pod::Text",
        "section": "",
        "mode": "info",
        "summary": "Pod::Text - Convert POD data to formatted text",
        "synopsis": "use Pod::Text;\nmy $parser = Pod::Text->new (sentence => 1, width => 78);\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [
            {
                "name": "perlpod",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/perlpod/1/json"
            },
            {
                "name": "pod2text",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/pod2text/1/json"
            },
            {
                "name": "Text",
                "section": "3perl",
                "url": "https://www.chedong.com/phpMan.php/man/Text/3perl/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 125,
                "subsections": []
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 23,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "CAVEATS",
                "lines": 15,
                "subsections": []
            },
            {
                "name": "NOTES",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND LICENSE",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 7,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Pod::Text - Convert POD data to formatted text\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Pod::Text;\nmy $parser = Pod::Text->new (sentence => 1, width => 78);\n\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Pod::Text is a module that can convert documentation in the POD format\n(the preferred language for documenting Perl) into formatted text.  It\nuses no special formatting controls or codes whatsoever, and its output\nis therefore suitable for nearly any device.\n\nAs a derived class from Pod::Simple, Pod::Text supports the same\nmethods and interfaces.  See Pod::Simple for all the details; briefly,\none creates a new parser with \"Pod::Text->new()\" and then normally\ncalls parsefile().\n\nnew() can take options, in the form of key/value pairs, that control\nthe behavior of the parser.  The currently recognized options are:\n\nalt If set to a true value, selects an alternate output format that,\namong other things, uses a different heading style and marks\n\"=item\" entries with a colon in the left margin.  Defaults to\nfalse.\n\ncode\nIf set to a true value, the non-POD parts of the input file will be\nincluded in the output.  Useful for viewing code documented with\nPOD blocks with the POD rendered and the code left intact.\n\nerrors\nHow to report errors.  \"die\" says to throw an exception on any POD\nformatting error.  \"stderr\" says to report errors on standard\nerror, but not to throw an exception.  \"pod\" says to include a POD\nERRORS section in the resulting documentation summarizing the\nerrors.  \"none\" ignores POD errors entirely, as much as possible.\n\nThe default is \"pod\".\n\nindent\nThe number of spaces to indent regular text, and the default\nindentation for \"=over\" blocks.  Defaults to 4.\n\nloose\nIf set to a true value, a blank line is printed after a \"=head1\"\nheading.  If set to false (the default), no blank line is printed\nafter \"=head1\", although one is still printed after \"=head2\".  This\nis the default because it's the expected formatting for manual\npages; if you're formatting arbitrary text documents, setting this\nto true may result in more pleasing output.\n\nmargin\nThe width of the left margin in spaces.  Defaults to 0.  This is\nthe margin for all text, including headings, not the amount by\nwhich regular text is indented; for the latter, see the indent\noption.  To set the right margin, see the width option.\n\nnourls\nNormally, L<> formatting codes with a URL but anchor text are\nformatted to show both the anchor text and the URL.  In other\nwords:\n\nL<foo|http://example.com/>\n\nis formatted as:\n\nfoo <http://example.com/>\n\nThis option, if set to a true value, suppresses the URL when anchor\ntext is given, so this example would be formatted as just \"foo\".\nThis can produce less cluttered output in cases where the URLs are\nnot particularly important.\n\nquotes\nSets the quote marks used to surround C<> text.  If the value is a\nsingle character, it is used as both the left and right quote.\nOtherwise, it is split in half, and the first half of the string is\nused as the left quote and the second is used as the right quote.\n\nThis may also be set to the special value \"none\", in which case no\nquote marks are added around C<> text.\n\nsentence\nIf set to a true value, Pod::Text will assume that each sentence\nends in two spaces, and will try to preserve that spacing.  If set\nto false, all consecutive whitespace in non-verbatim paragraphs is\ncompressed into a single space.  Defaults to false.\n\nstderr\nSend error messages about invalid POD to standard error instead of\nappending a POD ERRORS section to the generated output.  This is\nequivalent to setting \"errors\" to \"stderr\" if \"errors\" is not\nalready set.  It is supported for backward compatibility.\n\nutf8\nBy default, Pod::Text uses the same output encoding as the input\nencoding of the POD source (provided that Perl was built with\nPerlIO; otherwise, it doesn't encode its output).  If this option\nis given, the output encoding is forced to UTF-8.\n\nBe aware that, when using this option, the input encoding of your\nPOD source should be properly declared unless it's US-ASCII.\nPod::Simple will attempt to guess the encoding and may be\nsuccessful if it's Latin-1 or UTF-8, but it will produce warnings.\nUse the \"=encoding\" command to declare the encoding.  See\nperlpod(1) for more information.\n\nwidth\nThe column at which to wrap text on the right-hand side.  Defaults\nto 76.\n\nThe standard Pod::Simple method parsefile() takes one argument naming\nthe POD file to read from.  By default, the output is sent to \"STDOUT\",\nbut this can be changed with the outputfh() method.\n\nThe standard Pod::Simple method parsefromfile() takes up to two\narguments, the first being the input file to read POD from and the\nsecond being the file to write the formatted output to.\n\nYou can also call parselines() to parse an array of lines or\nparsestringdocument() to parse a document already in memory.  As with\nparsefile(), parselines() and parsestringdocument() default to\nsending their output to \"STDOUT\" unless changed with the outputfh()\nmethod.  Be aware that parselines() and parsestringdocument() both\nexpect raw bytes, not decoded characters.\n\nTo put the output from any parse method into a string instead of a file\nhandle, call the outputstring() method instead of outputfh().\n\nSee Pod::Simple for more specific details on the methods available to\nall derived parsers.\n",
                "subsections": []
            },
            "DIAGNOSTICS": {
                "content": "Bizarre space in item\nItem called without tag\n(W) Something has gone wrong in internal \"=item\" processing.  These\nmessages indicate a bug in Pod::Text; you should never see them.\n\nCan't open %s for reading: %s\n(F) Pod::Text was invoked via the compatibility mode pod2text()\ninterface and the input file it was given could not be opened.\n\nInvalid errors setting \"%s\"\n(F) The \"errors\" parameter to the constructor was set to an unknown\nvalue.\n\nInvalid quote specification \"%s\"\n(F) The quote specification given (the \"quotes\" option to the\nconstructor) was invalid.  A quote specification must be either one\ncharacter long or an even number (greater than one) characters\nlong.\n\nPOD document had syntax errors\n(F) The POD document being formatted had syntax errors and the\n\"errors\" option was set to \"die\".\n",
                "subsections": []
            },
            "BUGS": {
                "content": "Encoding handling assumes that PerlIO is available and does not work\nproperly if it isn't.  The \"utf8\" option is therefore not supported\nunless Perl is built with PerlIO support.\n",
                "subsections": []
            },
            "CAVEATS": {
                "content": "If Pod::Text is given the \"utf8\" option, the encoding of its output\nfile handle will be forced to UTF-8 if possible, overriding any\nexisting encoding.  This will be done even if the file handle is not\ncreated by Pod::Text and was passed in from outside.  This maintains\nconsistency regardless of PERLUNICODE and other settings.\n\nIf the \"utf8\" option is not given, the encoding of its output file\nhandle will be forced to the detected encoding of the input POD, which\npreserves whatever the input text is.  This ensures backward\ncompatibility with earlier, pre-Unicode versions of this module,\nwithout large numbers of Perl warnings.\n\nThis is not ideal, but it seems to be the best compromise.  If it\ndoesn't work for you, please let me know the details of how it broke.\n",
                "subsections": []
            },
            "NOTES": {
                "content": "This is a replacement for an earlier Pod::Text module written by Tom\nChristiansen.  It has a revamped interface, since it now uses\nPod::Simple, but an interface roughly compatible with the old\nPod::Text::pod2text() function is still available.  Please change to\nthe new calling convention, though.\n\nThe original Pod::Text contained code to do formatting via termcap\nsequences, although it wasn't turned on by default and it was\nproblematic to get it to work at all.  This rewrite doesn't even try to\ndo that, but a subclass of it does.  Look for Pod::Text::Termcap.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Russ Allbery <rra@cpan.org>, based very heavily on the original\nPod::Text by Tom Christiansen <tchrist@mox.perl.com> and its conversion\nto Pod::Parser by Brad Appleton <bradapp@enteract.com>.  Sean Burke's\ninitial conversion of Pod::Man to use Pod::Simple provided much-needed\nguidance on how to use Pod::Simple.\n",
                "subsections": []
            },
            "COPYRIGHT AND LICENSE": {
                "content": "Copyright 1999-2002, 2004, 2006, 2008-2009, 2012-2016, 2018-2019 Russ\nAllbery <rra@cpan.org>\n\nThis program is free software; you may redistribute it and/or modify it\nunder the same terms as Perl itself.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "Pod::Simple, Pod::Text::Termcap, perlpod(1), pod2text(1)\n\nThe current version of this module is always available from its web\nsite at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also\npart of the Perl core distribution as of 5.6.0.\n\nperl v5.34.0                      2026-06-23                  Pod::Text(3perl)",
                "subsections": []
            }
        }
    }
}