Unknown option: help
at /usr/share/perl5/core_perl/Pod/Perldoc/GetOptsOO.pm line 73.
perldoc [options] PageName|ModuleName|ProgramName|URL...
perldoc [options] -f BuiltinFunction
perldoc [options] -q FAQRegex
perldoc [options] -v PerlVariable
Options:
-h Display this help message
-V Report version
-r Recursive search (slow)
-i Ignore case
-t Display pod using pod2text instead of Pod::Man and groff
(-t is the default on win32 unless -n is specified)
-u Display unformatted pod text
-m Display module's file in its entirety
-n Specify replacement for groff
-l Display the module's file name
-U Don't attempt to drop privs for security
-F Arguments are file names, not modules (implies -U)
-D Verbosely describe what's going on
-T Send output to STDOUT without any pager
-d output_filename_to_send_to
-o output_format_name
-M FormatterModuleNameToUse
-w formatter_option:option_value
-L translation_code Choose doc translation (if any)
-X Use index if present (looks for pod.idx at /usr/lib/perl5/core_perl)
-q Search the text of questions (not answers) in perlfaq[1-9]
-f Search Perl built-in functions
-a Search Perl API
-v Search predefined Perl variables
PageName|ModuleName|ProgramName|URL...
is the name of a piece of documentation that you want to look at. You
may either give a descriptive name of the page (as in the case of
`perlfunc') the name of a module, either like `Term::Info' or like
`Term/Info', or the name of a program, like `perldoc', or a URL
starting with http(s).
BuiltinFunction
is the name of a perl function. Will extract documentation from
`perlfunc' or `perlop'.
FAQRegex
is a regex. Will search perlfaq[1-9] for and extract any
questions that match.
Any switches in the PERLDOC environment variable will be used before the
command line arguments. The optional pod index file contains a list of
filenames, one per line.
[Perldoc v3.2801]
Options (23)
| Option | Description | Source |
|---|
-h | Prints out a brief help message. | help + man |
-V | Displays the version of perldoc you're running. | help + man |
-r | Recursive search (slow) | help + man |
-i | Ignore case. | help + man |
-t | Display pod using pod2text instead of Pod::Man and groff (-t is the default on win32 unless -n is specified) | help + man |
-u | Skip the real Pod formatting, and just show the raw Pod source (Unformatted) | help + man |
-m module | Display the entire module: both code and unformatted pod documentation. | help + man |
-n some-formatter | Specify replacement for groff | help + man |
-l | Display only the file name of the module found. | help + man |
-U | When running as the superuser, don't attempt drop privileges for security. | help + man |
-F | Arguments are file names, not modules (implies -U) | help + man |
-D | Describes search for the item in detail. | help + man |
-T | This specifies that the output is not to be sent to a pager, but is to be sent directly to STDOUT. | help + man |
-d output_filename_to_send_to | This specifies that the output is to be sent neither to a pager nor to STDOUT, but is to be saved to the specified filename. | help + man |
-o output_format_name | This specifies that you want Perldoc to try using a Pod-formatting class for the output format that you specify. | help + man |
-M FormatterModuleNameToUse | This specifies the module that you want to try using for formatting the pod. | help + man |
-w formatter_option:option_value | This specifies an option to call the formatter with. | help + man |
-L translation_code | This allows one to specify the language code for the desired language translation. | help + man |
-X | Use index if present (looks for pod.idx at /usr/lib/perl5/core_perl) | help + man |
-q perlfaq-search-regexp | Search the text of questions (not answers) in perlfaq[1-9] | help + man |
-f perlfunc | The -f option followed by the name of a perl built-in function will extract the documentation of this function from perlfunc. | help + man |
-a perlapifunc | The -a option followed by the name of a perl api function will extract the documentation of this function from perlapi. | help + man |
-v perlvar | The -v option followed by the name of a Perl predefined variable will extract the documentation of this variable from perlvar. | help + man |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.