{ "content": [ { "type": "text", "text": "# POD2MAN (man)\n\n## NAME\n\npod2man - Convert POD data to formatted *roff input\n\n## SYNOPSIS\n\npod2man [--center=string] [--date=string]\n[--encoding=encoding] [--errors=style] [--fixed=font]\n[--fixedbold=font] [--fixeditalic=font]\n[--fixedbolditalic=font] [--guesswork=rule[,rule...]]\n[--name=name] [--nourls] [--official]\n[--release=version] [--section=manext]\n[--quotes=quotes] [--lquote=quote] [--rquote=quote]\n[--stderr] [--utf8] [--verbose] [input [output] ...]\npod2man --help\n\n## DESCRIPTION\n\npod2man is a wrapper script around the Pod::Man module, using it to generate *roff input from\nPOD source. The resulting *roff code is suitable for display on a terminal using nroff(1),\nnormally via man(1), or printing using troff(1).\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (14 subsections)\n- **EXIT STATUS**\n- **DIAGNOSTICS**\n- **EXAMPLES**\n- **AUTHOR**\n- **COPYRIGHT AND LICENSE**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "POD2MAN", "section": "", "mode": "man", "summary": "pod2man - Convert POD data to formatted *roff input", "synopsis": "pod2man [--center=string] [--date=string]\n[--encoding=encoding] [--errors=style] [--fixed=font]\n[--fixedbold=font] [--fixeditalic=font]\n[--fixedbolditalic=font] [--guesswork=rule[,rule...]]\n[--name=name] [--nourls] [--official]\n[--release=version] [--section=manext]\n[--quotes=quotes] [--lquote=quote] [--rquote=quote]\n[--stderr] [--utf8] [--verbose] [input [output] ...]\npod2man --help", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-c", "long": "--center", "arg": null, "description": "[1.00] Sets the centered page header for the \".TH\" macro to string. The default is \"User Contributed Perl Documentation\", but also see --official below." }, { "flag": "-d", "long": "--date", "arg": null, "description": "[4.00] Set the left-hand footer string for the \".TH\" macro to string. By default, the first of PODMANDATE, SOURCEDATEEPOCH, the modification date of the input file, or the current date (if input comes from \"STDIN\") will be used, and the date will be in UTC. See \"CLASS METHODS\" in Pod::Man for more details." }, { "flag": "-e", "long": "--encoding", "arg": null, "description": "[5.00] Specifies the encoding of the output. encoding must be an encoding recognized by the Encode module (see Encode::Supported). The default on non-EBCDIC systems is UTF-8. If the output contains characters that cannot be represented in this encoding, that is an error that will be reported as configured by the --errors option. If error handling is other than \"die\", the unrepresentable character will be replaced with the Encode substitution character (normally \"?\"). If the \"encoding\" option is set to the special value \"groff\" (the default on EBCDIC systems), or if the Encode module is not available and the encoding is set to anything other than \"roff\" (see below), Pod::Man will translate all non-ASCII characters to \"\\[uNNNN]\" Unicode escapes. These are not traditionally part of the *roff language, but are supported by groff and mandoc and thus by the majority of manual page processors in use today. If encoding is set to the special value \"roff\", pod2man will do its historic transformation of (some) ISO 8859-1 characters into *roff escapes that may be adequate in troff and may be readable (if ugly) in nroff. This was the default behavior of versions of pod2man before 5.00. With this encoding, all other non-ASCII characters will be replaced with \"X\". It may be required for very old troff and nroff implementations that do not support UTF-8, but its representation of any non-ASCII character is very poor and often specific to European languages. Its use is discouraged. WARNING: The input encoding of the POD source is independent from the output encoding, and setting this option does not affect the interpretation of the POD input. Unless your POD source is US-ASCII, its encoding should be declared with the \"=encoding\" command in the source. If this is not done, Pod::Simple will will attempt to guess the encoding and may be successful if it's Latin-1 or UTF-8, but it will produce warnings. See perlpod(1) for more information. --errors=style [2.5.0] Set the error handling style. \"die\" says to throw an exception on any POD formatting error. \"stderr\" says to report errors on standard error, but not to throw an exception. \"pod\" says to include a POD ERRORS section in the resulting documentation summarizing the errors. \"none\" ignores POD errors entirely, as much as possible. The default is \"die\". --fixed=font [1.0] The fixed-width font to use for verbatim text and code. Defaults to \"CW\". Some systems may want \"CR\" instead. Only matters for troff output. --fixedbold=font [1.0] Bold version of the fixed-width font. Defaults to \"CB\". Only matters for troff output. --fixeditalic=font [1.0] Italic version of the fixed-width font (something of a misnomer, since most fixed- width fonts only have an oblique version, not an italic version). Defaults to \"CI\". Only matters for troff output. --fixedbolditalic=font [1.0] Bold italic (in theory, probably oblique in practice) version of the fixed-width font. Pod::Man doesn't assume you have this, and defaults to \"CB\". Some systems (such as Solaris) have this font available as \"CX\". Only matters for troff output. --guesswork=rule[,rule...] [5.00] By default, pod2man applies some default formatting rules based on guesswork and regular expressions that are intended to make writing Perl documentation easier and require less explicit markup. These rules may not always be appropriate, particularly for documentation that isn't about Perl. This option allows turning all or some of it off. The special rule \"all\" enables all guesswork. This is also the default for backward compatibility reasons. The special rule \"none\" disables all guesswork. Otherwise, the value of this option should be a comma-separated list of one or more of the following keywords: functions Convert function references like foo() to bold even if they have no markup. The function name accepts valid Perl characters for function names (including \":\"), and the trailing parentheses must be present and empty. manref Make the first part (before the parentheses) of man page references like foo(1) bold even if they have no markup. The section must be a single number optionally followed by lowercase letters. quoting If no guesswork is enabled, any text enclosed in C<> is surrounded by double quotes in nroff (terminal) output unless the contents are already quoted. When this guesswork is enabled, quote marks will also be suppressed for Perl variables, function names, function calls, numbers, and hex constants. variables Convert Perl variable names to a fixed-width font even if they have no markup. This transformation will only be apparent in troff output, or some other output format (unlike nroff terminal output) that supports fixed-width fonts. Any unknown guesswork name is silently ignored (for potential future compatibility), so be careful about spelling." }, { "flag": "-h", "long": "--help", "arg": null, "description": "[1.00] Print out usage information." }, { "flag": "-l", "long": "--lax", "arg": null, "description": "[1.00] 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. --language=language [5.00] Add commands telling groff that the input file is in the given language. The value of this setting must be a language abbreviation for which groff provides supplemental configuration, such as \"ja\" (for Japanese) or \"zh\" (for Chinese). This adds: .mso .tmac .hla to the start of the file, which configure correct line breaking for the specified language. Without these commands, groff may not know how to add proper line breaks for Chinese and Japanese text if the man page is installed into the normal man page directory, such as /usr/share/man. On many systems, this will be done automatically if the man page is installed into a language-specific man page directory, such as /usr/share/man/zhCN. In that case, this option is not required. Unfortunately, the commands added with this option are specific to groff and will not work with other troff and nroff implementations. --lquote=quote --rquote=quote [4.08] 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." }, { "flag": "-n", "long": "--name", "arg": null, "description": "[4.08] 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 manual pages is for the title to be in all-uppercase, even if the command isn't. (Perl modules traditionally use mixed case for the manual page title, however.) 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": "[2.5.0] 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 is formatted as: foo 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": "[1.00] Set the default header to indicate that this page is part of the standard Perl release, if --center is not also given." }, { "flag": "-q", "long": "--quotes", "arg": null, "description": "[4.00] 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." }, { "flag": "-r", "long": "--release", "arg": null, "description": "[1.00] 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." }, { "flag": "-s", "long": "--section", "arg": null, "description": "[1.00] 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": "[2.1.3] 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": "[2.1.0] This option used to tell pod2man to produce UTF-8 output. Since this is now the default as of version 5.00, it is ignored and does nothing." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "[1.11] 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_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": "7", "url": "https://www.chedong.com/phpMan.php/man/man/7/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": 11, "subsections": [] }, { "name": "DESCRIPTION", "lines": 20, "subsections": [] }, { "name": "OPTIONS", "lines": 3, "subsections": [ { "name": "-c _ --center", "lines": 3, "flag": "-c", "long": "--center" }, { "name": "-d _ --date", "lines": 5, "flag": "-d", "long": "--date" }, { "name": "-e _ --encoding", "lines": 92, "flag": "-e", "long": "--encoding" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "-l --lax", "lines": 36, "flag": "-l", "long": "--lax" }, { "name": "-n _ --name", "lines": 16, "flag": "-n", "long": "--name" }, { "name": "--nourls", "lines": 13, "long": "--nourls" }, { "name": "-o --official", "lines": 3, "flag": "-o", "long": "--official" }, { "name": "-q _ --quotes", "lines": 12, "flag": "-q", "long": "--quotes" }, { "name": "-r _ --release", "lines": 9, "flag": "-r", "long": "--release" }, { "name": "-s _ --section", "lines": 11, "flag": "-s", "long": "--section" }, { "name": "--stderr", "lines": 5, "long": "--stderr" }, { "name": "-u --utf8", "lines": 3, "flag": "-u", "long": "--utf8" }, { "name": "-v --verbose", "lines": 2, "flag": "-v", "long": "--verbose" } ] }, { "name": "EXIT STATUS", "lines": 7, "subsections": [] }, { "name": "DIAGNOSTICS", "lines": 3, "subsections": [] }, { "name": "EXAMPLES", "lines": 17, "subsections": [] }, { "name": "AUTHOR", "lines": 3, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 5, "subsections": [] }, { "name": "SEE ALSO", "lines": 10, "subsections": [] } ], "sections": { "NAME": { "content": "pod2man - Convert POD data to formatted *roff input\n", "subsections": [] }, "SYNOPSIS": { "content": "pod2man [--center=string] [--date=string]\n[--encoding=encoding] [--errors=style] [--fixed=font]\n[--fixedbold=font] [--fixeditalic=font]\n[--fixedbolditalic=font] [--guesswork=rule[,rule...]]\n[--name=name] [--nourls] [--official]\n[--release=version] [--section=manext]\n[--quotes=quotes] [--lquote=quote] [--rquote=quote]\n[--stderr] [--utf8] [--verbose] [input [output] ...]\n\npod2man --help\n", "subsections": [] }, "DESCRIPTION": { "content": "pod2man is a wrapper script around the Pod::Man module, using it to generate *roff input from\nPOD source. The resulting *roff code is suitable for display on a terminal using nroff(1),\nnormally via man(1), or printing using troff(1).\n\nBy default (on non-EBCDIC systems), pod2man outputs UTF-8 manual pages. Its output should\nwork with the man program on systems that use groff (most Linux distributions) or mandoc\n(most BSD variants), but may result in mangled output on older UNIX systems. To choose a\ndifferent, possibly more backward-compatible output mangling on such systems, use\n\"--encoding=roff\" (the default in earlier Pod::Man versions). See the --encoding option and\n\"ENCODING\" in Pod::Man for more details.\n\ninput 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\nfiles can be processed in the same pod2man invocation (saving module load and compile times)\nby providing 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 for details.\n", "subsections": [] }, "OPTIONS": { "content": "Each option is annotated with the version of podlators in which that option was added with\nits current meaning.\n", "subsections": [ { "name": "-c _ --center", "content": "[1.00] Sets the centered page header for the \".TH\" macro to string. The default is \"User\nContributed Perl Documentation\", but also see --official below.\n", "flag": "-c", "long": "--center" }, { "name": "-d _ --date", "content": "[4.00] Set the left-hand footer string for the \".TH\" macro to string. By default, the\nfirst of PODMANDATE, SOURCEDATEEPOCH, the modification date of the input file, or the\ncurrent date (if input comes from \"STDIN\") will be used, and the date will be in UTC.\nSee \"CLASS METHODS\" in Pod::Man for more details.\n", "flag": "-d", "long": "--date" }, { "name": "-e _ --encoding", "content": "[5.00] Specifies the encoding of the output. encoding must be an encoding recognized by\nthe Encode module (see Encode::Supported). The default on non-EBCDIC systems is UTF-8.\n\nIf the output contains characters that cannot be represented in this encoding, that is an\nerror that will be reported as configured by the --errors option. If error handling is\nother than \"die\", the unrepresentable character will be replaced with the Encode\nsubstitution character (normally \"?\").\n\nIf the \"encoding\" option is set to the special value \"groff\" (the default on EBCDIC\nsystems), or if the Encode module is not available and the encoding is set to anything\nother than \"roff\" (see below), Pod::Man will translate all non-ASCII characters to\n\"\\[uNNNN]\" Unicode escapes. These are not traditionally part of the *roff language, but\nare supported by groff and mandoc and thus by the majority of manual page processors in\nuse today.\n\nIf encoding is set to the special value \"roff\", pod2man will do its historic\ntransformation of (some) ISO 8859-1 characters into *roff escapes that may be adequate in\ntroff and may be readable (if ugly) in nroff. This was the default behavior of versions\nof pod2man before 5.00. With this encoding, all other non-ASCII characters will be\nreplaced with \"X\". It may be required for very old troff and nroff implementations that\ndo not support UTF-8, but its representation of any non-ASCII character is very poor and\noften specific to European languages. Its use is discouraged.\n\nWARNING: The input encoding of the POD source is independent from the output encoding,\nand setting this option does not affect the interpretation of the POD input. Unless your\nPOD source is US-ASCII, its encoding should be declared with the \"=encoding\" command in\nthe source. If this is not done, Pod::Simple will will attempt to guess the encoding and\nmay be successful if it's Latin-1 or UTF-8, but it will produce warnings. See perlpod(1)\nfor more information.\n\n--errors=style\n[2.5.0] Set the error handling style. \"die\" says to throw an exception on any POD\nformatting error. \"stderr\" says to report errors on standard error, but not to throw an\nexception. \"pod\" says to include a POD ERRORS section in the resulting documentation\nsummarizing the errors. \"none\" ignores POD errors entirely, as much as possible.\n\nThe default is \"die\".\n\n--fixed=font\n[1.0] The fixed-width font to use for verbatim text and code. Defaults to \"CW\". Some\nsystems may want \"CR\" instead. Only matters for troff output.\n\n--fixedbold=font\n[1.0] Bold version of the fixed-width font. Defaults to \"CB\". Only matters for troff\noutput.\n\n--fixeditalic=font\n[1.0] Italic version of the fixed-width font (something of a misnomer, since most fixed-\nwidth fonts only have an oblique version, not an italic version). Defaults to \"CI\".\nOnly matters for troff output.\n\n--fixedbolditalic=font\n[1.0] Bold italic (in theory, probably oblique in practice) version of the fixed-width\nfont. Pod::Man doesn't assume you have this, and defaults to \"CB\". Some systems (such\nas Solaris) have this font available as \"CX\". Only matters for troff output.\n\n--guesswork=rule[,rule...]\n[5.00] By default, pod2man applies some default formatting rules based on guesswork and\nregular expressions that are intended to make writing Perl documentation easier and\nrequire less explicit markup. These rules may not always be appropriate, particularly\nfor documentation that isn't about Perl. This option allows turning all or some of it\noff.\n\nThe special rule \"all\" enables all guesswork. This is also the default for backward\ncompatibility reasons. The special rule \"none\" disables all guesswork. Otherwise, the\nvalue of this option should be a comma-separated list of one or more of the following\nkeywords:\n\nfunctions\nConvert function references like foo() to bold even if they have no markup. The\nfunction name accepts valid Perl characters for function names (including \":\"), and\nthe trailing parentheses must be present and empty.\n\nmanref\nMake the first part (before the parentheses) of man page references like foo(1) bold\neven if they have no markup. The section must be a single number optionally followed\nby lowercase letters.\n\nquoting\nIf no guesswork is enabled, any text enclosed in C<> is surrounded by double quotes\nin nroff (terminal) output unless the contents are already quoted. When this\nguesswork is enabled, quote marks will also be suppressed for Perl variables,\nfunction names, function calls, numbers, and hex constants.\n\nvariables\nConvert Perl variable names to a fixed-width font even if they have no markup. This\ntransformation will only be apparent in troff output, or some other output format\n(unlike nroff terminal output) that supports fixed-width fonts.\n\nAny unknown guesswork name is silently ignored (for potential future compatibility), so\nbe careful about spelling.\n", "flag": "-e", "long": "--encoding" }, { "name": "-h --help", "content": "[1.00] Print out usage information.\n", "flag": "-h", "long": "--help" }, { "name": "-l --lax", "content": "[1.00] No longer used. pod2man used to check its input for validity as a manual page,\nbut this should now be done by podchecker(1) instead. Accepted for backward\ncompatibility; this option no longer does anything.\n\n--language=language\n[5.00] Add commands telling groff that the input file is in the given language. The\nvalue of this setting must be a language abbreviation for which groff provides\nsupplemental configuration, such as \"ja\" (for Japanese) or \"zh\" (for Chinese).\n\nThis adds:\n\n.mso .tmac\n.hla \n\nto the start of the file, which configure correct line breaking for the specified\nlanguage. Without these commands, groff may not know how to add proper line breaks for\nChinese and Japanese text if the man page is installed into the normal man page\ndirectory, such as /usr/share/man.\n\nOn many systems, this will be done automatically if the man page is installed into a\nlanguage-specific man page directory, such as /usr/share/man/zhCN. In that case, this\noption is not required.\n\nUnfortunately, the commands added with this option are specific to groff and will not\nwork with other troff and nroff implementations.\n\n--lquote=quote\n--rquote=quote\n[4.08] Sets the quote marks used to surround C<> text. --lquote sets the left quote mark\nand --rquote sets the right quote mark. Either may also be set to the special value\n\"none\", in which case no quote mark is added on that side of C<> text (but the font is\nstill changed for troff output).\n\nAlso see the --quotes option, which can be used to set both quotes at once. If both\n--quotes and one of the other options is set, --lquote or --rquote overrides --quotes.\n", "flag": "-l", "long": "--lax" }, { "name": "-n _ --name", "content": "[4.08] Set the name of the manual page for the \".TH\" macro to name. Without this option,\nthe manual name is set to the uppercased base name of the file being converted unless the\nmanual section is 3, in which case the path is parsed to see if it is a Perl module path.\nIf it is, a path like \".../lib/Pod/Man.pm\" is converted into a name like \"Pod::Man\".\nThis option, if given, overrides any automatic determination of the name.\n\nAlthough one does not have to follow this convention, be aware that the convention for\nUNIX manual pages is for the title to be in all-uppercase, even if the command isn't.\n(Perl modules traditionally use mixed case for the manual page title, however.)\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\nmeaningful manual page name.\n", "flag": "-n", "long": "--name" }, { "name": "--nourls", "content": "[2.5.0] Normally, L<> formatting codes with a URL but anchor text are formatted to show\nboth the anchor text and the URL. In other words:\n\nL\n\nis formatted as:\n\nfoo \n\nThis flag, if given, suppresses the URL when anchor text is given, so this example would\nbe formatted as just \"foo\". This can produce less cluttered output in cases where the\nURLs are not particularly important.\n", "long": "--nourls" }, { "name": "-o --official", "content": "[1.00] Set the default header to indicate that this page is part of the standard Perl\nrelease, if --center is not also given.\n", "flag": "-o", "long": "--official" }, { "name": "-q _ --quotes", "content": "[4.00] Sets 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,\nand the first half of the string is used as the left quote and the second is used as the\nright quote.\n\nquotes may also be set to the special value \"none\", in which case no quote marks are\nadded around 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", "flag": "-q", "long": "--quotes" }, { "name": "-r _ --release", "content": "[1.00] Set the centered footer for the \".TH\" macro to version. By default, this is set\nto the version of Perl you run pod2man under. Setting this to the empty string will\ncause some *roff implementations to use the system default value.\n\nNote that some system \"an\" macro sets assume that the centered footer will be a\nmodification date and will prepend something like \"Last modified: \". If this is the case\nfor your target system, you may want to set --release to the last modified date and\n--date to the version number.\n", "flag": "-r", "long": "--release" }, { "name": "-s _ --section", "content": "[1.00] Set the section for the \".TH\" macro. The standard section numbering convention is\nto use 1 for user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for\nfile formats, 6 for games, 7 for miscellaneous information, and 8 for administrator\ncommands. There is a lot of variation here, however; some systems (like Solaris) use 4\nfor file formats, 5 for miscellaneous information, and 7 for devices. Still others use\n1m instead of 8, or some mix of both. About the only section numbers that are reliably\nconsistent 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": "-s", "long": "--section" }, { "name": "--stderr", "content": "[2.1.3] By default, pod2man dies if any errors are detected in the POD input. If\n--stderr is given and no --errors flag is present, errors are sent to standard error, but\npod2man does not abort. This is equivalent to \"--errors=stderr\" and is supported for\nbackward compatibility.\n", "long": "--stderr" }, { "name": "-u --utf8", "content": "[2.1.0] This option used to tell pod2man to produce UTF-8 output. Since this is now the\ndefault as of version 5.00, it is ignored and does nothing.\n", "flag": "-u", "long": "--utf8" }, { "name": "-v --verbose", "content": "[1.11] 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\n(a \"POD ERRORS\" section generated with \"--errors=pod\"), pod2man will exit with status 0. If\nany of the documents being processed do not result in an output document, pod2man will exit\nwith status 1. If there are syntax errors in a POD document being processed and the error\nhandling style is set to the default of \"die\", pod2man will abort immediately with exit\nstatus 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\nversions of 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,\nitem, and any \"X<>\" directives.\n", "subsections": [] }, "AUTHOR": { "content": "Russ Allbery , based 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, 2022 Russ Allbery \n\nThis program is free software; you may redistribute it and/or modify it under the same terms\nas Perl itself.\n", "subsections": [] }, "SEE ALSO": { "content": "Pod::Man, Pod::Simple, man(1), nroff(1), perlpod(1), podchecker(1), perlpodstyle(1),\ntroff(1), man(7)\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. It is also part of the Perl core\ndistribution as of 5.6.0.\n\nperl v5.38.2 2026-06-12 POD2MAN(1)", "subsections": [] } } } }