{
    "content": [
        {
            "type": "text",
            "text": "# pod2man (perldoc)\n\n**Summary:** pod2man - Convert POD data to formatted *roff input\n\n**Synopsis:** pod2man [--center=*string*] [--date=*string*] [--errors=*style*] [--fixed=*font*]\n[--fixedbold=*font*] [--fixeditalic=*font*] [--fixedbolditalic=*font*] [--name=*name*]\n[--nourls] [--official] [--release=*version*] [--section=*manext*] [--quotes=*quotes*]\n[--lquote=*quote*] [--rquote=*quote*] [--stderr] [--utf8] [--verbose] [*input* [*output*] ...]\npod2man --help\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -h | --help | — | Print out usage information. |\n| -l | --lax | — | No longer used. pod2man used to check its input for validity as a manual page, but this should now be done by podchecker |\n| — | --nourls | — | Normally, L<> formatting codes with a URL but anchor text are formatted to show both the anchor text and the URL. In oth |\n| -o | --official | — | Set the default header to indicate that this page is part of the standard Perl release, if --center is not also given. - |\n| — | --stderr | — | By default, pod2man dies if any errors are detected in the POD input. If --stderr is given and no --errors flag is prese |\n| -u | --utf8 | — | By default, pod2man produces the most conservative possible *roff output to try to ensure that it will work with as many |\n| -v | --verbose | — | Print out the name of each output file as it is being generated. |\n\n## Examples\n\n- `pod2man program > program.1`\n- `pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3`\n- `pod2man --section=7 note.pod > note.7`\n- `If you would like to print out a lot of man page continuously, you probably want to set the C`\n- `and D registers to set contiguous page numbering and even/odd paging, at least on some versions`\n- `of man(7).`\n- `troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...`\n- `To get index entries on \"STDERR\", turn on the F register, as in:`\n- `troff -man -rF1 perl.1`\n- `The indexing merely outputs messages via \".tm\" for each major page, section, subsection, item,`\n- `and any \"X<>\" directives. See Pod::Man for more details.`\n\n## See Also\n\n- man(1)\n- nroff(1)\n- perlpod(1)\n- podchecker(1)\n- perlpodstyle(1)\n- troff(1)\n- man(5)\n- man(7)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (7 lines)\n- **DESCRIPTION** (26 lines)\n- **OPTIONS** (35 lines) — 7 subsections\n  - -h, --help (2 lines)\n  - -l, --lax (31 lines)\n  - --nourls (13 lines)\n  - -o, --official (37 lines)\n  - --stderr (4 lines)\n  - -u, --utf8 (18 lines)\n  - -v, --verbose (2 lines)\n- **EXIT STATUS** (6 lines)\n- **DIAGNOSTICS** (3 lines)\n- **EXAMPLES** (17 lines)\n- **BUGS** (2 lines)\n- **AUTHOR** (3 lines)\n- **COPYRIGHT AND LICENSE** (5 lines)\n- **SEE ALSO** (1 lines) — 1 subsections\n  - man (6 lines)\n\n## Full Content\n\n### NAME\n\npod2man - Convert POD data to formatted *roff input\n\n### SYNOPSIS\n\npod2man [--center=*string*] [--date=*string*] [--errors=*style*] [--fixed=*font*]\n[--fixedbold=*font*] [--fixeditalic=*font*] [--fixedbolditalic=*font*] [--name=*name*]\n[--nourls] [--official] [--release=*version*] [--section=*manext*] [--quotes=*quotes*]\n[--lquote=*quote*] [--rquote=*quote*] [--stderr] [--utf8] [--verbose] [*input* [*output*] ...]\n\npod2man --help\n\n### DESCRIPTION\n\npod2man is a front-end for Pod::Man, using it to generate *roff input from POD source. The\nresulting *roff code is suitable for display on a terminal using nroff(1), normally via man(1),\nor printing using troff(1).\n\n*input* is the file to read for POD source (the POD can be embedded in code). If *input* isn't\ngiven, it defaults to \"STDIN\". *output*, if given, is the file to which to write the formatted\noutput. If *output* isn't given, the formatted output is written to \"STDOUT\". Several POD files\ncan be processed in the same pod2man invocation (saving module load and compile times) by\nproviding multiple pairs of *input* and *output* files on the command line.\n\n--section, --release, --center, --date, and --official can be used to set the headers and\nfooters to use; if not given, Pod::Man will assume various defaults. See below or Pod::Man for\ndetails.\n\npod2man assumes that your *roff formatters have a fixed-width font named \"CW\". If yours is\ncalled something else (like \"CR\"), use --fixed to specify it. This generally only matters for\ntroff output for printing. Similarly, you can set the fonts used for bold, italic, and bold\nitalic fixed-width output.\n\nBesides the obvious pod conversions, Pod::Man, and therefore pod2man also takes care of\nformatting func(), func(n), and simple variable references like $foo or @bar so you don't have\nto use code escapes for them; complex expressions like $fred{'stuff'} will still need to be\nescaped, though. It also translates dashes that aren't used as hyphens into en dashes, makes\nlong dashes--like this--into proper em dashes, fixes \"paired quotes,\" and takes care of several\nother troff-specific tweaks. See Pod::Man for complete information.\n\n### OPTIONS\n\n-c *string*, --center=*string*\nSets the centered page header for the \".TH\" macro to *string*. The default is \"User\nContributed Perl Documentation\", but also see --official below.\n\n-d *string*, --date=*string*\nSet the left-hand footer string for the \".TH\" macro to *string*. By default, the\nmodification date of the input file will be used, or the current date if input comes from\n\"STDIN\", and will be based on UTC (so that the output will be reproducible regardless of\nlocal time zone).\n\n--errors=*style*\nSet the error handling style. \"die\" says to throw an exception on any POD formatting error.\n\"stderr\" says to report errors on standard error, but not to throw an exception. \"pod\" says\nto include a POD ERRORS section in the resulting documentation summarizing the errors.\n\"none\" ignores POD errors entirely, as much as possible.\n\nThe default is \"die\".\n\n--fixed=*font*\nThe fixed-width font to use for verbatim text and code. Defaults to \"CW\". Some systems may\nwant \"CR\" instead. Only matters for troff(1) output.\n\n--fixedbold=*font*\nBold version of the fixed-width font. Defaults to \"CB\". Only matters for troff(1) output.\n\n--fixeditalic=*font*\nItalic version of the fixed-width font (actually, something of a misnomer, since most\nfixed-width fonts only have an oblique version, not an italic version). Defaults to \"CI\".\nOnly matters for troff(1) output.\n\n--fixedbolditalic=*font*\nBold italic (probably actually oblique) version of the fixed-width font. Pod::Man doesn't\nassume you have this, and defaults to \"CB\". Some systems (such as Solaris) have this font\navailable as \"CX\". Only matters for troff(1) output.\n\n#### -h, --help\n\nPrint out usage information.\n\n#### -l, --lax\n\nNo longer used. pod2man used to check its input for validity as a manual page, but this\nshould now be done by podchecker(1) instead. Accepted for backward compatibility; this\noption no longer does anything.\n\n--lquote=*quote*\n--rquote=*quote*\nSets the quote marks used to surround C<> text. --lquote sets the left quote mark and\n--rquote sets the right quote mark. Either may also be set to the special value \"none\", in\nwhich case no quote mark is added on that side of C<> text (but the font is still changed\nfor troff output).\n\nAlso see the --quotes option, which can be used to set both quotes at once. If both --quotes\nand one of the other options is set, --lquote or --rquote overrides --quotes.\n\n-n *name*, --name=*name*\nSet the name of the manual page for the \".TH\" macro to *name*. Without this option, the\nmanual name is set to the uppercased base name of the file being converted unless the manual\nsection is 3, in which case the path is parsed to see if it is a Perl module path. If it is,\na path like \".../lib/Pod/Man.pm\" is converted into a name like \"Pod::Man\". This option, if\ngiven, overrides any automatic determination of the name.\n\nAlthough one does not have to follow this convention, be aware that the convention for UNIX\nman pages for commands is for the man page title to be in all-uppercase, even if the command\nisn't.\n\nThis option is probably not useful when converting multiple POD files at once.\n\nWhen converting POD source from standard input, the name will be set to \"STDIN\" if this\noption is not provided. Providing this option is strongly recommended to set a meaningful\nmanual page name.\n\n#### --nourls\n\nNormally, L<> formatting codes with a URL but anchor text are formatted to show both the\nanchor text and the URL. In other words:\n\nL<foo|http://example.com/>\n\nis formatted as:\n\nfoo <http://example.com/>\n\nThis flag, if given, suppresses the URL when anchor text is given, so this example would be\nformatted as just \"foo\". This can produce less cluttered output in cases where the URLs are\nnot particularly important.\n\n#### -o, --official\n\nSet the default header to indicate that this page is part of the standard Perl release, if\n--center is not also given.\n\n-q *quotes*, --quotes=*quotes*\nSets the quote marks used to surround C<> text to *quotes*. If *quotes* is a single\ncharacter, it is used as both the left and right quote. Otherwise, it is split in half, and\nthe first half of the string is used as the left quote and the second is used as the right\nquote.\n\n*quotes* may also be set to the special value \"none\", in which case no quote marks are added\naround C<> text (but the font is still changed for troff output).\n\nAlso see the --lquote and --rquote options, which can be used to set the left and right\nquotes independently. If both --quotes and one of the other options is set, --lquote or\n--rquote overrides --quotes.\n\n-r *version*, --release=*version*\nSet the centered footer for the \".TH\" macro to *version*. By default, this is set to the\nversion of Perl you run pod2man under. Setting this to the empty string will cause some\n*roff implementations to use the system default value.\n\nNote that some system \"an\" macro sets assume that the centered footer will be a modification\ndate and will prepend something like \"Last modified: \". If this is the case for your target\nsystem, you may want to set --release to the last modified date and --date to the version\nnumber.\n\n-s *string*, --section=*string*\nSet the section for the \".TH\" macro. The standard section numbering convention is to use 1\nfor user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6\nfor games, 7 for miscellaneous information, and 8 for administrator commands. There is a lot\nof variation here, however; some systems (like Solaris) use 4 for file formats, 5 for\nmiscellaneous information, and 7 for devices. Still others use 1m instead of 8, or some mix\nof both. About the only section numbers that are reliably consistent are 1, 2, and 3.\n\nBy default, section 1 will be used unless the file ends in \".pm\", in which case section 3\nwill be selected.\n\n#### --stderr\n\nBy default, pod2man dies if any errors are detected in the POD input. If --stderr is given\nand no --errors flag is present, errors are sent to standard error, but pod2man does not\nabort. This is equivalent to \"--errors=stderr\" and is supported for backward compatibility.\n\n#### -u, --utf8\n\nBy default, pod2man produces the most conservative possible *roff output to try to ensure\nthat it will work with as many different *roff implementations as possible. Many *roff\nimplementations cannot handle non-ASCII characters, so this means all non-ASCII characters\nare converted either to a *roff escape sequence that tries to create a properly accented\ncharacter (at least for troff output) or to \"X\".\n\nThis option says to instead output literal UTF-8 characters. If your *roff implementation\ncan handle it, this is the best output format to use and avoids corruption of documents\ncontaining non-ASCII characters. However, be warned that *roff source with literal UTF-8\ncharacters is not supported by many implementations and may even result in segfaults and\nother bad behavior.\n\nBe aware that, when using this option, the input encoding of your POD source should be\nproperly declared unless it's US-ASCII. Pod::Simple will attempt to guess the encoding and\nmay be successful if it's Latin-1 or UTF-8, but it will warn, which by default results in a\npod2man failure. Use the \"=encoding\" command to declare the encoding. See perlpod(1) for\nmore information.\n\n#### -v, --verbose\n\nPrint out the name of each output file as it is being generated.\n\n### EXIT STATUS\n\nAs long as all documents processed result in some output, even if that output includes errata (a\n\"POD ERRORS\" section generated with \"--errors=pod\"), pod2man will exit with status 0. If any of\nthe documents being processed do not result in an output document, pod2man will exit with status\n1. If there are syntax errors in a POD document being processed and the error handling style is\nset to the default of \"die\", pod2man will abort immediately with exit status 255.\n\n### DIAGNOSTICS\n\nIf pod2man fails with errors, see Pod::Man and Pod::Simple for information about what those\nerrors might mean.\n\n### EXAMPLES\n\npod2man program > program.1\npod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3\npod2man --section=7 note.pod > note.7\n\nIf you would like to print out a lot of man page continuously, you probably want to set the C\nand D registers to set contiguous page numbering and even/odd paging, at least on some versions\nof man(7).\n\ntroff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...\n\nTo get index entries on \"STDERR\", turn on the F register, as in:\n\ntroff -man -rF1 perl.1\n\nThe indexing merely outputs messages via \".tm\" for each major page, section, subsection, item,\nand any \"X<>\" directives. See Pod::Man for more details.\n\n### BUGS\n\nLots of this documentation is duplicated from Pod::Man.\n\n### AUTHOR\n\nRuss Allbery <rra@cpan.org>, based *very* heavily on the original pod2man by Larry Wall and Tom\nChristiansen.\n\n### COPYRIGHT AND LICENSE\n\nCopyright 1999-2001, 2004, 2006, 2008, 2010, 2012-2019 Russ Allbery <rra@cpan.org>\n\nThis program is free software; you may redistribute it and/or modify it under the same terms as\nPerl itself.\n\n### SEE ALSO\n\nPod::Man, Pod::Simple, man(1), nroff(1), perlpod(1), podchecker(1), perlpodstyle(1), troff(1),\n\n#### man\n\nThe man page documenting the an macro set may be man(5) instead of man(7) on your system.\n\nThe current version of this script is always available from its web site at\n<https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core\ndistribution as of 5.6.0.\n\n"
        }
    ],
    "structuredContent": {
        "command": "pod2man",
        "section": "",
        "mode": "perldoc",
        "summary": "pod2man - Convert POD data to formatted *roff input",
        "synopsis": "pod2man [--center=*string*] [--date=*string*] [--errors=*style*] [--fixed=*font*]\n[--fixedbold=*font*] [--fixeditalic=*font*] [--fixedbolditalic=*font*] [--name=*name*]\n[--nourls] [--official] [--release=*version*] [--section=*manext*] [--quotes=*quotes*]\n[--lquote=*quote*] [--rquote=*quote*] [--stderr] [--utf8] [--verbose] [*input* [*output*] ...]\npod2man --help",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "-h",
                "long": "--help",
                "arg": null,
                "description": "Print out usage information."
            },
            {
                "flag": "-l",
                "long": "--lax",
                "arg": null,
                "description": "No longer used. pod2man used to check its input for validity as a manual page, but this should now be done by podchecker(1) instead. Accepted for backward compatibility; this option no longer does anything. --lquote=*quote* --rquote=*quote* Sets the quote marks used to surround C<> text. --lquote sets the left quote mark and --rquote sets the right quote mark. Either may also be set to the special value \"none\", in which case no quote mark is added on that side of C<> text (but the font is still changed for troff output). Also see the --quotes option, which can be used to set both quotes at once. If both --quotes and one of the other options is set, --lquote or --rquote overrides --quotes. -n *name*, --name=*name* Set the name of the manual page for the \".TH\" macro to *name*. Without this option, the manual name is set to the uppercased base name of the file being converted unless the manual section is 3, in which case the path is parsed to see if it is a Perl module path. If it is, a path like \".../lib/Pod/Man.pm\" is converted into a name like \"Pod::Man\". This option, if given, overrides any automatic determination of the name. Although one does not have to follow this convention, be aware that the convention for UNIX man pages for commands is for the man page title to be in all-uppercase, even if the command isn't. This option is probably not useful when converting multiple POD files at once. When converting POD source from standard input, the name will be set to \"STDIN\" if this option is not provided. Providing this option is strongly recommended to set a meaningful manual page name."
            },
            {
                "flag": "",
                "long": "--nourls",
                "arg": null,
                "description": "Normally, L<> formatting codes with a URL but anchor text are formatted to show both the anchor text and the URL. In other words: L<foo|http://example.com/> is formatted as: foo <http://example.com/> This flag, if given, suppresses the URL when anchor text is given, so this example would be formatted as just \"foo\". This can produce less cluttered output in cases where the URLs are not particularly important."
            },
            {
                "flag": "-o",
                "long": "--official",
                "arg": null,
                "description": "Set the default header to indicate that this page is part of the standard Perl release, if --center is not also given. -q *quotes*, --quotes=*quotes* Sets the quote marks used to surround C<> text to *quotes*. If *quotes* is a single character, it is used as both the left and right quote. Otherwise, it is split in half, and the first half of the string is used as the left quote and the second is used as the right quote. *quotes* may also be set to the special value \"none\", in which case no quote marks are added around C<> text (but the font is still changed for troff output). Also see the --lquote and --rquote options, which can be used to set the left and right quotes independently. If both --quotes and one of the other options is set, --lquote or --rquote overrides --quotes. -r *version*, --release=*version* Set the centered footer for the \".TH\" macro to *version*. By default, this is set to the version of Perl you run pod2man under. Setting this to the empty string will cause some *roff implementations to use the system default value. Note that some system \"an\" macro sets assume that the centered footer will be a modification date and will prepend something like \"Last modified: \". If this is the case for your target system, you may want to set --release to the last modified date and --date to the version number. -s *string*, --section=*string* Set the section for the \".TH\" macro. The standard section numbering convention is to use 1 for user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6 for games, 7 for miscellaneous information, and 8 for administrator commands. There is a lot of variation here, however; some systems (like Solaris) use 4 for file formats, 5 for miscellaneous information, and 7 for devices. Still others use 1m instead of 8, or some mix of both. About the only section numbers that are reliably consistent are 1, 2, and 3. By default, section 1 will be used unless the file ends in \".pm\", in which case section 3 will be selected."
            },
            {
                "flag": "",
                "long": "--stderr",
                "arg": null,
                "description": "By default, pod2man dies if any errors are detected in the POD input. If --stderr is given and no --errors flag is present, errors are sent to standard error, but pod2man does not abort. This is equivalent to \"--errors=stderr\" and is supported for backward compatibility."
            },
            {
                "flag": "-u",
                "long": "--utf8",
                "arg": null,
                "description": "By default, pod2man produces the most conservative possible *roff output to try to ensure that it will work with as many different *roff implementations as possible. Many *roff implementations cannot handle non-ASCII characters, so this means all non-ASCII characters are converted either to a *roff escape sequence that tries to create a properly accented character (at least for troff output) or to \"X\". This option says to instead output literal UTF-8 characters. If your *roff implementation can handle it, this is the best output format to use and avoids corruption of documents containing non-ASCII characters. However, be warned that *roff source with literal UTF-8 characters is not supported by many implementations and may even result in segfaults and other bad behavior. Be aware that, when using this option, the input encoding of your POD source should be properly declared unless it's US-ASCII. Pod::Simple will attempt to guess the encoding and may be successful if it's Latin-1 or UTF-8, but it will warn, which by default results in a pod2man failure. Use the \"=encoding\" command to declare the encoding. See perlpod(1) for more information."
            },
            {
                "flag": "-v",
                "long": "--verbose",
                "arg": null,
                "description": "Print out the name of each output file as it is being generated."
            }
        ],
        "examples": [
            "pod2man program > program.1",
            "pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3",
            "pod2man --section=7 note.pod > note.7",
            "If you would like to print out a lot of man page continuously, you probably want to set the C",
            "and D registers to set contiguous page numbering and even/odd paging, at least on some versions",
            "of man(7).",
            "troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...",
            "To get index entries on \"STDERR\", turn on the F register, as in:",
            "troff -man -rF1 perl.1",
            "The indexing merely outputs messages via \".tm\" for each major page, section, subsection, item,",
            "and any \"X<>\" directives. See Pod::Man for more details."
        ],
        "see_also": [
            {
                "name": "man",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/man/1/json"
            },
            {
                "name": "nroff",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/nroff/1/json"
            },
            {
                "name": "perlpod",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/perlpod/1/json"
            },
            {
                "name": "podchecker",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/podchecker/1/json"
            },
            {
                "name": "perlpodstyle",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/perlpodstyle/1/json"
            },
            {
                "name": "troff",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/troff/1/json"
            },
            {
                "name": "man",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/man/5/json"
            },
            {
                "name": "man",
                "section": "7",
                "url": "https://www.chedong.com/phpMan.php/man/man/7/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 26,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 35,
                "subsections": [
                    {
                        "name": "-h, --help",
                        "lines": 2,
                        "flag": "-h",
                        "long": "--help"
                    },
                    {
                        "name": "-l, --lax",
                        "lines": 31,
                        "flag": "-l",
                        "long": "--lax"
                    },
                    {
                        "name": "--nourls",
                        "lines": 13,
                        "long": "--nourls"
                    },
                    {
                        "name": "-o, --official",
                        "lines": 37,
                        "flag": "-o",
                        "long": "--official"
                    },
                    {
                        "name": "--stderr",
                        "lines": 4,
                        "long": "--stderr"
                    },
                    {
                        "name": "-u, --utf8",
                        "lines": 18,
                        "flag": "-u",
                        "long": "--utf8"
                    },
                    {
                        "name": "-v, --verbose",
                        "lines": 2,
                        "flag": "-v",
                        "long": "--verbose"
                    }
                ]
            },
            {
                "name": "EXIT STATUS",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "EXAMPLES",
                "lines": 17,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND LICENSE",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 1,
                "subsections": [
                    {
                        "name": "man",
                        "lines": 6
                    }
                ]
            }
        ],
        "sections": {
            "NAME": {
                "content": "pod2man - Convert POD data to formatted *roff input\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "pod2man [--center=*string*] [--date=*string*] [--errors=*style*] [--fixed=*font*]\n[--fixedbold=*font*] [--fixeditalic=*font*] [--fixedbolditalic=*font*] [--name=*name*]\n[--nourls] [--official] [--release=*version*] [--section=*manext*] [--quotes=*quotes*]\n[--lquote=*quote*] [--rquote=*quote*] [--stderr] [--utf8] [--verbose] [*input* [*output*] ...]\n\npod2man --help\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "pod2man is a front-end for Pod::Man, using it to generate *roff input from POD source. The\nresulting *roff code is suitable for display on a terminal using nroff(1), normally via man(1),\nor printing using troff(1).\n\n*input* is the file to read for POD source (the POD can be embedded in code). If *input* isn't\ngiven, it defaults to \"STDIN\". *output*, if given, is the file to which to write the formatted\noutput. If *output* isn't given, the formatted output is written to \"STDOUT\". Several POD files\ncan be processed in the same pod2man invocation (saving module load and compile times) by\nproviding multiple pairs of *input* and *output* files on the command line.\n\n--section, --release, --center, --date, and --official can be used to set the headers and\nfooters to use; if not given, Pod::Man will assume various defaults. See below or Pod::Man for\ndetails.\n\npod2man assumes that your *roff formatters have a fixed-width font named \"CW\". If yours is\ncalled something else (like \"CR\"), use --fixed to specify it. This generally only matters for\ntroff output for printing. Similarly, you can set the fonts used for bold, italic, and bold\nitalic fixed-width output.\n\nBesides the obvious pod conversions, Pod::Man, and therefore pod2man also takes care of\nformatting func(), func(n), and simple variable references like $foo or @bar so you don't have\nto use code escapes for them; complex expressions like $fred{'stuff'} will still need to be\nescaped, though. It also translates dashes that aren't used as hyphens into en dashes, makes\nlong dashes--like this--into proper em dashes, fixes \"paired quotes,\" and takes care of several\nother troff-specific tweaks. See Pod::Man for complete information.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "-c *string*, --center=*string*\nSets the centered page header for the \".TH\" macro to *string*. The default is \"User\nContributed Perl Documentation\", but also see --official below.\n\n-d *string*, --date=*string*\nSet the left-hand footer string for the \".TH\" macro to *string*. By default, the\nmodification date of the input file will be used, or the current date if input comes from\n\"STDIN\", and will be based on UTC (so that the output will be reproducible regardless of\nlocal time zone).\n\n--errors=*style*\nSet the error handling style. \"die\" says to throw an exception on any POD formatting error.\n\"stderr\" says to report errors on standard error, but not to throw an exception. \"pod\" says\nto include a POD ERRORS section in the resulting documentation summarizing the errors.\n\"none\" ignores POD errors entirely, as much as possible.\n\nThe default is \"die\".\n\n--fixed=*font*\nThe fixed-width font to use for verbatim text and code. Defaults to \"CW\". Some systems may\nwant \"CR\" instead. Only matters for troff(1) output.\n\n--fixedbold=*font*\nBold version of the fixed-width font. Defaults to \"CB\". Only matters for troff(1) output.\n\n--fixeditalic=*font*\nItalic version of the fixed-width font (actually, something of a misnomer, since most\nfixed-width fonts only have an oblique version, not an italic version). Defaults to \"CI\".\nOnly matters for troff(1) output.\n\n--fixedbolditalic=*font*\nBold italic (probably actually oblique) version of the fixed-width font. Pod::Man doesn't\nassume you have this, and defaults to \"CB\". Some systems (such as Solaris) have this font\navailable as \"CX\". Only matters for troff(1) output.\n",
                "subsections": [
                    {
                        "name": "-h, --help",
                        "content": "Print out usage information.\n",
                        "flag": "-h",
                        "long": "--help"
                    },
                    {
                        "name": "-l, --lax",
                        "content": "No longer used. pod2man used to check its input for validity as a manual page, but this\nshould now be done by podchecker(1) instead. Accepted for backward compatibility; this\noption no longer does anything.\n\n--lquote=*quote*\n--rquote=*quote*\nSets the quote marks used to surround C<> text. --lquote sets the left quote mark and\n--rquote sets the right quote mark. Either may also be set to the special value \"none\", in\nwhich case no quote mark is added on that side of C<> text (but the font is still changed\nfor troff output).\n\nAlso see the --quotes option, which can be used to set both quotes at once. If both --quotes\nand one of the other options is set, --lquote or --rquote overrides --quotes.\n\n-n *name*, --name=*name*\nSet the name of the manual page for the \".TH\" macro to *name*. Without this option, the\nmanual name is set to the uppercased base name of the file being converted unless the manual\nsection is 3, in which case the path is parsed to see if it is a Perl module path. If it is,\na path like \".../lib/Pod/Man.pm\" is converted into a name like \"Pod::Man\". This option, if\ngiven, overrides any automatic determination of the name.\n\nAlthough one does not have to follow this convention, be aware that the convention for UNIX\nman pages for commands is for the man page title to be in all-uppercase, even if the command\nisn't.\n\nThis option is probably not useful when converting multiple POD files at once.\n\nWhen converting POD source from standard input, the name will be set to \"STDIN\" if this\noption is not provided. Providing this option is strongly recommended to set a meaningful\nmanual page name.\n",
                        "flag": "-l",
                        "long": "--lax"
                    },
                    {
                        "name": "--nourls",
                        "content": "Normally, L<> formatting codes with a URL but anchor text are formatted to show both the\nanchor text and the URL. In other words:\n\nL<foo|http://example.com/>\n\nis formatted as:\n\nfoo <http://example.com/>\n\nThis flag, if given, suppresses the URL when anchor text is given, so this example would be\nformatted as just \"foo\". This can produce less cluttered output in cases where the URLs are\nnot particularly important.\n",
                        "long": "--nourls"
                    },
                    {
                        "name": "-o, --official",
                        "content": "Set the default header to indicate that this page is part of the standard Perl release, if\n--center is not also given.\n\n-q *quotes*, --quotes=*quotes*\nSets the quote marks used to surround C<> text to *quotes*. If *quotes* is a single\ncharacter, it is used as both the left and right quote. Otherwise, it is split in half, and\nthe first half of the string is used as the left quote and the second is used as the right\nquote.\n\n*quotes* may also be set to the special value \"none\", in which case no quote marks are added\naround C<> text (but the font is still changed for troff output).\n\nAlso see the --lquote and --rquote options, which can be used to set the left and right\nquotes independently. If both --quotes and one of the other options is set, --lquote or\n--rquote overrides --quotes.\n\n-r *version*, --release=*version*\nSet the centered footer for the \".TH\" macro to *version*. By default, this is set to the\nversion of Perl you run pod2man under. Setting this to the empty string will cause some\n*roff implementations to use the system default value.\n\nNote that some system \"an\" macro sets assume that the centered footer will be a modification\ndate and will prepend something like \"Last modified: \". If this is the case for your target\nsystem, you may want to set --release to the last modified date and --date to the version\nnumber.\n\n-s *string*, --section=*string*\nSet the section for the \".TH\" macro. The standard section numbering convention is to use 1\nfor user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6\nfor games, 7 for miscellaneous information, and 8 for administrator commands. There is a lot\nof variation here, however; some systems (like Solaris) use 4 for file formats, 5 for\nmiscellaneous information, and 7 for devices. Still others use 1m instead of 8, or some mix\nof both. About the only section numbers that are reliably consistent are 1, 2, and 3.\n\nBy default, section 1 will be used unless the file ends in \".pm\", in which case section 3\nwill be selected.\n",
                        "flag": "-o",
                        "long": "--official"
                    },
                    {
                        "name": "--stderr",
                        "content": "By default, pod2man dies if any errors are detected in the POD input. If --stderr is given\nand no --errors flag is present, errors are sent to standard error, but pod2man does not\nabort. This is equivalent to \"--errors=stderr\" and is supported for backward compatibility.\n",
                        "long": "--stderr"
                    },
                    {
                        "name": "-u, --utf8",
                        "content": "By default, pod2man produces the most conservative possible *roff output to try to ensure\nthat it will work with as many different *roff implementations as possible. Many *roff\nimplementations cannot handle non-ASCII characters, so this means all non-ASCII characters\nare converted either to a *roff escape sequence that tries to create a properly accented\ncharacter (at least for troff output) or to \"X\".\n\nThis option says to instead output literal UTF-8 characters. If your *roff implementation\ncan handle it, this is the best output format to use and avoids corruption of documents\ncontaining non-ASCII characters. However, be warned that *roff source with literal UTF-8\ncharacters is not supported by many implementations and may even result in segfaults and\nother bad behavior.\n\nBe aware that, when using this option, the input encoding of your POD source should be\nproperly declared unless it's US-ASCII. Pod::Simple will attempt to guess the encoding and\nmay be successful if it's Latin-1 or UTF-8, but it will warn, which by default results in a\npod2man failure. Use the \"=encoding\" command to declare the encoding. See perlpod(1) for\nmore information.\n",
                        "flag": "-u",
                        "long": "--utf8"
                    },
                    {
                        "name": "-v, --verbose",
                        "content": "Print out the name of each output file as it is being generated.\n",
                        "flag": "-v",
                        "long": "--verbose"
                    }
                ]
            },
            "EXIT STATUS": {
                "content": "As long as all documents processed result in some output, even if that output includes errata (a\n\"POD ERRORS\" section generated with \"--errors=pod\"), pod2man will exit with status 0. If any of\nthe documents being processed do not result in an output document, pod2man will exit with status\n1. If there are syntax errors in a POD document being processed and the error handling style is\nset to the default of \"die\", pod2man will abort immediately with exit status 255.\n",
                "subsections": []
            },
            "DIAGNOSTICS": {
                "content": "If pod2man fails with errors, see Pod::Man and Pod::Simple for information about what those\nerrors might mean.\n",
                "subsections": []
            },
            "EXAMPLES": {
                "content": "pod2man program > program.1\npod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3\npod2man --section=7 note.pod > note.7\n\nIf you would like to print out a lot of man page continuously, you probably want to set the C\nand D registers to set contiguous page numbering and even/odd paging, at least on some versions\nof man(7).\n\ntroff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...\n\nTo get index entries on \"STDERR\", turn on the F register, as in:\n\ntroff -man -rF1 perl.1\n\nThe indexing merely outputs messages via \".tm\" for each major page, section, subsection, item,\nand any \"X<>\" directives. See Pod::Man for more details.\n",
                "subsections": []
            },
            "BUGS": {
                "content": "Lots of this documentation is duplicated from Pod::Man.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Russ Allbery <rra@cpan.org>, based *very* heavily on the original pod2man by Larry Wall and Tom\nChristiansen.\n",
                "subsections": []
            },
            "COPYRIGHT AND LICENSE": {
                "content": "Copyright 1999-2001, 2004, 2006, 2008, 2010, 2012-2019 Russ Allbery <rra@cpan.org>\n\nThis program is free software; you may redistribute it and/or modify it under the same terms as\nPerl itself.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "Pod::Man, Pod::Simple, man(1), nroff(1), perlpod(1), podchecker(1), perlpodstyle(1), troff(1),",
                "subsections": [
                    {
                        "name": "man",
                        "content": "The man page documenting the an macro set may be man(5) instead of man(7) on your system.\n\nThe current version of this script is always available from its web site at\n<https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core\ndistribution as of 5.6.0.\n"
                    }
                ]
            }
        }
    }
}