''Perl Programming Documentation'', also called ''perldoc'', is the name of the
user manual
A user guide, also commonly known as a user manual, is intended to assist users in using a particular product, service or application. It is usually written by a technician, product developer, or a company's customer service staff.
Most user gu ...
for the
Perl 5
Perl is a high-level, general-purpose, interpreted, dynamic programming language. Though Perl is not officially an acronym, there are various backronyms in use, including "Practical Extraction and Reporting Language".
Perl was developed by ...
programming language
A programming language is a system of notation for writing computer programs.
Programming languages are described in terms of their Syntax (programming languages), syntax (form) and semantics (computer science), semantics (meaning), usually def ...
. It is available in several different formats, including online in
HTML
Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. It defines the content and structure of web content. It is often assisted by technologies such as Cascading Style Sheets ( ...
and
PDF
Portable document format (PDF), standardized as ISO 32000, is a file format developed by Adobe Inc., Adobe in 1992 to present documents, including text formatting and images, in a manner independent of application software, computer hardware, ...
. The
documentation
Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge managem ...
is bundled with Perl in its own format, known as
Plain Old Documentation
Plain Old Documentation (pod) is a lightweight markup language used to document the Perl programming language as well as Perl modules and programs.
Design
Pod is designed to be a simple, clean language with just enough syntax to be useful. It p ...
(pod). Some
distributions, such as
Strawberry Perl, include the documentation in HTML, PDF, and pod formats.
perldoc is also the name of the Perl command that provides "access to all the documentation that comes with Perl", from the
command line
A command-line interface (CLI) is a means of interacting with software via command (computing), commands each formatted as a line of text. Command-line interfaces emerged in the mid-1960s, on computer terminals, as an interactive and more user ...
.
See also
*
Outline of Perl – overview of and topical guide to the Perl programming language
*
Raku – Perl 5's sister language
*
man page
A man page (short for manual page) is a form of software documentation found on Unix and Unix-like operating systems. Topics covered include programs, system libraries, system calls, and sometimes local system details. The local host administr ...
– form of software documentation usually found on a Unix or Unix-like operating system, invoked by issuing the man command. Perl documentation is sometimes available as man pages.
*
PerlMonks – community website covering all aspects of Perl programming and other related topics such as web applications and system administration. Includes forums where perl users may seek answers to their questions, and answer the questions of others.
*
RTFM
RTFM is an initialism and internet slang for the expression "read the fucking manual", typically used to reply to a basic question where the answer is easily found in the documentation, user guide, owner's manual, man page, online help, internet ...
– Internet slang for "Read the Frickin' Manual"
External links
Official documentation for Perl 5– displays the documentation, and also includes links to download the HTML and PDF files for off-line use.
*
– covers use of the perldoc command
Perl documentation documentation– documentation about perl's documentation
Official documentation for Perl 6
Software documentation
{{prog-lang-stub