''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's usually written by a technician, product developer, or a company's customer service staff.
Most user guid ...
for the
Perl 5
Perl is a family of two High-level programming language, high-level, General-purpose programming language, general-purpose, Interpreter (computing), interpreted, dynamic programming languages. "Perl" refers to Perl 5, but from 2000 to 2019 it ...
programming language
A programming language is a system of notation for writing computer programs. Most programming languages are text-based formal languages, but they may also be graphical. They are a kind of computer language.
The description of a programming ...
. It is available in several different formats, including online in
HTML
The HyperText Markup Language or HTML is the standard markup language for documents designed to be displayed in a web browser. It can be assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScri ...
and
PDF
Portable Document Format (PDF), standardized as ISO 32000, is a file format developed by Adobe in 1992 to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems. ...
. 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 manageme ...
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 pur ...
(pod). Some
distributions, such as
Strawberry Perl
Strawberry Perl is a distribution of the Perl programming language for the Microsoft Windows platform. Additionally, strawberry contains a fully featured Mingw-w64 C/C++ compiler with many libraries included. While most other distributions rely o ...
, 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 interpreter or command-line processor uses a command-line interface (CLI) to receive commands from a user in the form of lines of text. This provides a means of setting parameters for the environment, invoking executables and pro ...
.
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 usually found on a Unix or Unix-like operating system. Topics covered include computer programs (including library and system calls), formal standards and conventions, and ev ...
– 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
''PerlMonks'' is a community website covering all aspects of Perl programming and other related topics such as web applications and system administration. It is often referred to by users as 'The Monastery'.
The name PerlMonks, and the general sty ...
– 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, i ...
– 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