LinuxCommandLibrary

perldoc

displays Perl documentation

TLDR

View module documentation

$ perldoc [Module::Name]
copy
View function documentation
$ perldoc -f [function]
copy
View FAQ
$ perldoc -q "[keyword]"
copy
View built-in variable
$ perldoc perlvar
copy
Search documentation
$ perldoc -f [pattern]
copy

SYNOPSIS

perldoc [options] [topic]

DESCRIPTION

perldoc displays Perl documentation. Accesses POD format docs.
The tool browses Perl documentation. Core and module docs.

PARAMETERS

TOPIC

Module, function, or document.
-f FUNCTION
Look up function.
-q QUERY
Search FAQ.
-v VARIABLE
Look up variable.
-m MODULE
Show module source.
-t
Plain text output.

CAVEATS

POD format. Module must be installed. Pager used for display.

HISTORY

perldoc is part of core Perl for accessing documentation.

SEE ALSO

perl(1), pod2man(1), pod2html(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community