{
    "content": [
        {
            "type": "text",
            "text": "# Pod::Simple (info)\n\n## NAME\n\nPod::Simple - framework for parsing Pod\n\n## SYNOPSIS\n\nTODO\n\n## DESCRIPTION\n\nPod::Simple is a Perl library for parsing text in the Pod (\"plain old\ndocumentation\") markup language that is typically used for writing\ndocumentation for Perl and for Perl modules. The Pod format is\nexplained in perlpod; the most common formatter is called \"perldoc\".\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **MAIN METHODS**\n- **SECONDARY METHODS**\n- **TERTIARY METHODS**\n- **ENCODING**\n- **SEE ALSO**\n- **SUPPORT**\n- **COPYRIGHT AND DISCLAIMERS**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Pod::Simple",
        "section": "",
        "mode": "info",
        "summary": "Pod::Simple - framework for parsing Pod",
        "synopsis": "TODO",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 26,
                "subsections": []
            },
            {
                "name": "MAIN METHODS",
                "lines": 57,
                "subsections": []
            },
            {
                "name": "SECONDARY METHODS",
                "lines": 113,
                "subsections": []
            },
            {
                "name": "TERTIARY METHODS",
                "lines": 105,
                "subsections": []
            },
            {
                "name": "ENCODING",
                "lines": 14,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 10,
                "subsections": []
            },
            {
                "name": "SUPPORT",
                "lines": 12,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND DISCLAIMERS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 20,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Pod::Simple - framework for parsing Pod\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "TODO\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Pod::Simple is a Perl library for parsing text in the Pod (\"plain old\ndocumentation\") markup language that is typically used for writing\ndocumentation for Perl and for Perl modules. The Pod format is\nexplained in perlpod; the most common formatter is called \"perldoc\".\n\nBe sure to read \"ENCODING\" if your Pod contains non-ASCII characters.\n\nPod formatters can use Pod::Simple to parse Pod documents and render\nthem into plain text, HTML, or any number of other formats. Typically,\nsuch formatters will be subclasses of Pod::Simple, and so they will\ninherit its methods, like \"parsefile\".  But note that Pod::Simple\ndoesn't understand and properly parse Perl itself, so if you have a\nfile which contains a Perl program that has a multi-line quoted string\nwhich has lines that look like pod, Pod::Simple will treat them as pod.\nThis can be avoided if the file makes these into indented here\ndocuments instead.\n\nIf you're reading this document just because you have a Pod-processing\nsubclass that you want to use, this document (plus the documentation\nfor the subclass) is probably all you need to read.\n\nIf you're reading this document because you want to write a formatter\nsubclass, continue reading it and then read Pod::Simple::Subclassing,\nand then possibly even read perlpodspec (some of which is for parser-\nwriters, but much of which is notes to formatter-writers).\n",
                "subsections": []
            },
            "MAIN METHODS": {
                "content": "\"$parser = SomeClass->new();\"\nThis returns a new parser object, where \"SomeClass\" is a subclass\nof Pod::Simple.\n\n\"$parser->outputfh( *OUT );\"\nThis sets the filehandle that $parser's output will be written to.\nYou can pass *STDOUT or *STDERR, otherwise you should probably do\nsomething like this:\n\nmy $outfile = \"output.txt\";\nopen TXTOUT, \">$outfile\" or die \"Can't write to $outfile: $!\";\n$parser->outputfh(*TXTOUT);\n\n...before you call one of the \"$parser->parsewhatever\" methods.\n\n\"$parser->outputstring( \\$somestring );\"\nThis sets the string that $parser's output will be sent to, instead\nof any filehandle.\n\n\"$parser->parsefile( $somefilename );\"\n\"$parser->parsefile( *INPUTFH );\"\nThis reads the Pod content of the file (or filehandle) that you\nspecify, and processes it with that $parser object, according to\nhowever $parser's class works, and according to whatever parser\noptions you have set up for this $parser object.\n\n\"$parser->parsestringdocument( $allcontent );\"\nThis works just like \"parsefile\" except that it reads the Pod\ncontent not from a file, but from a string that you have already in\nmemory.\n\n\"$parser->parselines( ...@lines..., undef );\"\nThis processes the lines in @lines (where each list item must be a\ndefined value, and must contain exactly one line of content -- so\nno items like \"foo\\nbar\" are allowed).  The final \"undef\" is used\nto indicate the end of document being parsed.\n\nThe other \"parserwhatever\" methods are meant to be called only\nonce per $parser object; but \"parselines\" can be called as many\ntimes per $parser object as you want, as long as the last call (and\nonly the last call) ends with an \"undef\" value.\n\n\"$parser->contentseen\"\nThis returns true only if there has been any real content seen for\nthis document. Returns false in cases where the document contains\ncontent, but does not make use of any Pod markup.\n\n\"SomeClass->filter( $filename );\"\n\"SomeClass->filter( *INPUTFH );\"\n\"SomeClass->filter( \\$documentcontent );\"\nThis is a shortcut method for creating a new parser object, setting\nthe output handle to STDOUT, and then processing the specified file\n(or filehandle, or in-memory document). This is handy for one-\nliners like this:\n\nperl -MPod::Simple::Text -e \"Pod::Simple::Text->filter('thingy.pod')\"\n",
                "subsections": []
            },
            "SECONDARY METHODS": {
                "content": "Some of these methods might be of interest to general users, as well as\nof interest to formatter-writers.\n\nNote that the general pattern here is that the accessor-methods read\nthe attribute's value with \"$value = $parser->attribute\" and set the\nattribute's value with \"$parser->attribute(newvalue)\".  For each\naccessor, I typically only mention one syntax or another, based on\nwhich I think you are actually most likely to use.\n\n\"$parser->parsecharacters( SOMEVALUE )\"\nThe Pod parser normally expects to read octets and to convert those\noctets to characters based on the \"=encoding\" declaration in the\nPod source.  Set this option to a true value to indicate that the\nPod source is already a Perl character stream.  This tells the\nparser to ignore any \"=encoding\" command and to skip all the code\npaths involving decoding octets.\n\n\"$parser->nowhining( SOMEVALUE )\"\nIf you set this attribute to a true value, you will suppress the\nparser's complaints about irregularities in the Pod coding. By\ndefault, this attribute's value is false, meaning that\nirregularities will be reported.\n\nNote that turning this attribute to true won't suppress one or two\nkinds of complaints about rarely occurring unrecoverable errors.\n\n\"$parser->noerratasection( SOMEVALUE )\"\nIf you set this attribute to a true value, you will stop the parser\nfrom generating a \"POD ERRORS\" section at the end of the document.\nBy default, this attribute's value is false, meaning that an errata\nsection will be generated, as necessary.\n\n\"$parser->complainstderr( SOMEVALUE )\"\nIf you set this attribute to a true value, it will send reports of\nparsing errors to STDERR. By default, this attribute's value is\nfalse, meaning that no output is sent to STDERR.\n\nSetting \"complainstderr\" also sets \"noerratasection\".\n\n\"$parser->sourcefilename\"\nThis returns the filename that this parser object was set to read\nfrom.\n\n\"$parser->dochasstarted\"\nThis returns true if $parser has read from a source, and has seen\nPod content in it.\n\n\"$parser->sourcedead\"\nThis returns true if $parser has read from a source, and come to\nthe end of that source.\n\n\"$parser->stripverbatimindent( SOMEVALUE )\"\nThe perlpod spec for a Verbatim paragraph is \"It should be\nreproduced exactly...\", which means that the whitespace you've used\nto indent your verbatim blocks will be preserved in the output.\nThis can be annoying for outputs such as HTML, where that\nwhitespace will remain in front of every line. It's an unfortunate\ncase where syntax is turned into semantics.\n\nIf the POD you're parsing adheres to a consistent indentation\npolicy, you can have such indentation stripped from the beginning\nof every line of your verbatim blocks. This method tells\nPod::Simple what to strip. For two-space indents, you'd use:\n\n$parser->stripverbatimindent('  ');\n\nFor tab indents, you'd use a tab character:\n\n$parser->stripverbatimindent(\"\\t\");\n\nIf the POD is inconsistent about the indentation of verbatim\nblocks, but you have figured out a heuristic to determine how much\na particular verbatim block is indented, you can pass a code\nreference instead. The code reference will be executed with one\nargument, an array reference of all the lines in the verbatim\nblock, and should return the value to be stripped from each line.\nFor example, if you decide that you're fine to use the first line\nof the verbatim block to set the standard for indentation of the\nrest of the block, you can look at the first line and return the\nappropriate value, like so:\n\n$new->stripverbatimindent(sub {\nmy $lines = shift;\n(my $indent = $lines->[0]) =~ s/\\S.*//;\nreturn $indent;\n});\n\nIf you'd rather treat each line individually, you can do that, too,\nby just transforming them in-place in the code reference and\nreturning \"undef\". Say that you don't want any lines indented. You\ncan do something like this:\n\n$new->stripverbatimindent(sub {\nmy $lines = shift;\nsub { s/^\\s+// for @{ $lines },\nreturn undef;\n});\n\n\"$parser->expandverbatimtabs( n )\"\nDefault: 8\n\nIf after any stripping of indentation in verbatim blocks, there\nremain tabs, this method call indicates what to do with them.  0\nmeans leave them as tabs, any other number indicates that each tab\nis to be translated so as to have tab stops every \"n\" columns.\n\nThis is independent of other methods (except that it operates after\nany verbatim input stripping is done).\n\nLike the other methods, the input parameter is not checked for\nvalidity.  \"undef\" or containing non-digits has the same effect as\n8.\n",
                "subsections": []
            },
            "TERTIARY METHODS": {
                "content": "\"$parser->abandonoutputfh()\"\nCancel output to the file handle. Any POD read by the $parser is\nnot effected.\n\n\"$parser->abandonoutputstring()\"\nCancel output to the output string. Any POD read by the $parser is\nnot effected.\n\n\"$parser->acceptcode( @codes )\"\nAlias for acceptcodes.\n\n\"$parser->acceptcodes( @codes )\"\nAllows $parser to accept a list of \"Formatting Codes\" in perlpod.\nThis can be used to implement user-defined codes.\n\n\"$parser->acceptdirectiveasdata( @directives )\"\nAllows $parser to accept a list of directives for data paragraphs.\nA directive is the label of a \"Command Paragraph\" in perlpod. A\ndata paragraph is one delimited by \"=begin/=for/=end\" directives.\nThis can be used to implement user-defined directives.\n\n\"$parser->acceptdirectiveasprocessed( @directives )\"\nAllows $parser to accept a list of directives for processed\nparagraphs. A directive is the label of a \"Command Paragraph\" in\nperlpod. A processed paragraph is also known as \"Ordinary\nParagraph\" in perlpod. This can be used to implement user-defined\ndirectives.\n\n\"$parser->acceptdirectiveasverbatim( @directives )\"\nAllows $parser to accept a list of directives for \"Verbatim\nParagraph\" in perlpod. A directive is the label of a \"Command\nParagraph\" in perlpod. This can be used to implement user-defined\ndirectives.\n\n\"$parser->accepttarget( @targets )\"\nAlias for accepttargets.\n\n\"$parser->accepttargetastext( @targets )\"\nAlias for accepttargetsastext.\n\n\"$parser->accepttargets( @targets )\"\nAccepts targets for \"=begin/=for/=end\" sections of the POD.\n\n\"$parser->accepttargetsastext( @targets )\"\nAccepts targets for \"=begin/=for/=end\" sections that should be\nparsed as POD. For details, see \"About Data Paragraphs\" in\nperlpodspec.\n\n\"$parser->anyerrataseen()\"\nUsed to check if any errata was seen.\n\nExample:\n\ndie \"too many errors\\n\" if $parser->anyerrataseen();\n\n\"$parser->errataseen()\"\nReturns a hash reference of all errata seen, both whines and\nscreams. The hash reference's keys are the line number and the\nvalue is an array reference of the errors for that line.\n\nExample:\n\nif ( $parser->anyerrataseen() ) {\n$logger->log( $parser->errataseen() );\n}\n\n\"$parser->detectedencoding()\"\nReturn the encoding corresponding to \"=encoding\", but only if the\nencoding was recognized and handled.\n\n\"$parser->encoding()\"\nReturn encoding of the document, even if the encoding is not\ncorrectly handled.\n\n\"$parser->parsefromfile( $source, $to )\"\nParses from $source file to $to file. Similar to \"parsefromfile\"\nin Pod::Parser.\n\n\"$parser->scream( @errormessages )\"\nLog an error that can't be ignored.\n\n\"$parser->unacceptcode( @codes )\"\nAlias for unacceptcodes.\n\n\"$parser->unacceptcodes( @codes )\"\nRemoves @codes as valid codes for the parse.\n\n\"$parser->unacceptdirective( @directives )\"\nAlias for unacceptdirectives.\n\n\"$parser->unacceptdirectives( @directives )\"\nRemoves @directives as valid directives for the parse.\n\n\"$parser->unaccepttarget( @targets )\"\nAlias for unaccepttargets.\n\n\"$parser->unaccepttargets( @targets )\"\nRemoves @targets as valid targets for the parse.\n\n\"$parser->versionreport()\"\nReturns a string describing the version.\n\n\"$parser->whine( @errormessages )\"\nLog an error unless \"$parser->nowhining( TRUE );\".\n",
                "subsections": []
            },
            "ENCODING": {
                "content": "The Pod::Simple parser expects to read octets.  The parser will decode\nthe octets into Perl's internal character string representation using\nthe value of the \"=encoding\" declaration in the POD source.\n\nIf the POD source does not include an \"=encoding\" declaration, the\nparser will attempt to guess the encoding (selecting one of UTF-8 or CP\n1252) by examining the first non-ASCII bytes and applying the heuristic\ndescribed in perlpodspec.  (If the POD source contains only ASCII\nbytes, the encoding is assumed to be ASCII.)\n\nIf you set the \"parsecharacters\" option to a true value the parser\nwill expect characters rather than octets; will ignore any \"=encoding\";\nand will make no attempt to decode the input.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "Pod::Simple::Subclassing\n\nperlpod\n\nperlpodspec\n\nPod::Escapes\n\nperldoc\n",
                "subsections": []
            },
            "SUPPORT": {
                "content": "Questions or discussion about POD and Pod::Simple should be sent to the\npod-people@perl.org mail list. Send an empty email to\npod-people-subscribe@perl.org to subscribe.\n\nThis module is managed in an open GitHub repository,\n<https://github.com/perl-pod/pod-simple/>. Feel free to fork and\ncontribute, or to clone <git://github.com/perl-pod/pod-simple.git> and\nsend patches!\n\nPlease use <https://github.com/perl-pod/pod-simple/issues/new> to file\na bug report.\n",
                "subsections": []
            },
            "COPYRIGHT AND DISCLAIMERS": {
                "content": "Copyright (c) 2002 Sean M. Burke.\n\nThis library is free software; you can redistribute it and/or modify it\nunder the same terms as Perl itself.\n\nThis program is distributed in the hope that it will be useful, but\nwithout any warranty; without even the implied warranty of\nmerchantability or fitness for a particular purpose.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.  But don't\nbother him, he's retired.\n\nPod::Simple is maintained by:\n\no   Allison Randal \"allison@perl.org\"\n\no   Hans Dieter Pearcey \"hdp@cpan.org\"\n\no   David E. Wheeler \"dwheeler@cpan.org\"\n\no   Karl Williamson \"khw@cpan.org\"\n\nDocumentation has been contributed by:\n\no   Gabor Szabo \"szabgab@gmail.com\"\n\no   Shawn H Corey  \"SHCOREY at cpan.org\"\n\nperl v5.34.0                      2026-06-23                Pod::Simple(3perl)",
                "subsections": []
            }
        }
    }
}