Template:Short description Template:Distinguish Template:Lowercase title
.jpg){kind=link}
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 administrators can create and install manual pages associated with the specific host. A manual end user may invoke a documentation page by issuing the man command followed by the name of the item for which they want the documentation. These manual pages are typically requested by end users, programmers and administrators doing real time work but can also be formatted for printing.
By default, man typically uses a formatting program such as nroff with a macro package or mandoc, and also a terminal pager program such as more or less to display its output on the user's screen.
Man pages are often referred to as an online form of software documentation,<ref name="online-man">{{#invoke:citation/CS1|citation
|CitationClass=web
}}</ref> even though the man command does not require internet access. The environment variable MANPATH often specifies a list of directory paths to search for the various documentation pages. Manual pages date back to the times when printed documentation was the norm.
HistoryEdit
Before Unix (e.g., GCOS), documentation was printed pages, available on the premises to users (staff, students...), organized into steel binders, locked together in one monolithic steel reading rack, bolted to a table or counter, with pages organized for modular information updates, replacement, errata, and addenda. Template:Cn
In the first two years of the history of Unix, no documentation existed.<ref name="reader">Template:Cite tech report</ref> The Unix Programmer's Manual was first published on November 3, 1971. The first actual man pages were written by Dennis Ritchie and Ken Thompson at the insistenceTemplate:Fact of their manager Doug McIlroy in 1971. Aside from the man pages, the Programmer's Manual also accumulated a set of short papers, some of them tutorials (e.g. for general Unix usage, the C programming language, and tools such as Yacc), and others more detailed descriptions of operating system features. The printed version of the manual initially fit into a single binder, but as of PWB/UNIX and the 7th Edition of Research Unix, it was split into two volumes with the printed man pages forming Volume 1.<ref name="evolution">{{#invoke:citation/CS1|citation |CitationClass=web }} Originally published in Microsystems 5(11), November 1984.</ref>
Later versions of the documentation imitated the first man pages' terseness. Ritchie added a "How to get started" section to the Third Edition introduction, and Lorinda Cherry provided the "Purple Card" pocket reference for the Sixth and Seventh Editions.Template:R Versions of the software were named after the revision of the manual; the seventh edition of the Unix Programmer's Manual, for example, came with the 7th Edition or Version 7 of Unix.<ref name="fiedler198310">Template:Cite news</ref>
For the Fourth Edition the man pages were formatted using the troff typesetting packageTemplate:R and its set of -man macros (which were completely revised between the Sixth and Seventh Editions of the Manual,<ref name="evolution"/> but have since not drastically changed). At the time, the availability of online documentation through the manual page system was regarded as a great advance. To this day, virtually every Unix command line application comes with a man page, and many Unix users perceive a program's lack of man pages as a sign of low quality or incompleteness. Indeed, some projects, such as Debian, go out of their way to write man pages for programs lacking one. The modern descendants of 4.4BSD also distribute man pages as one of the primary forms of system documentation (having replaced the old -man macros with the newer -mdoc).
There was a hidden Easter egg in the man-db version of the man command that would cause the command to return "gimme gimme gimme" when run at 00:30 (a reference to the ABBA song Gimme! Gimme! Gimme! (A Man After Midnight). It was introduced in 2011<ref name="git1">{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> but first restricted<ref name="git2">{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> and then removed in 2017<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> after finally being found.<ref name="stackexchange1">{{#invoke:citation/CS1|citation |CitationClass=web }}</ref>
FormattingEdit
The default format of man pages is troff, with either the macro package man (appearance oriented) or mdoc (semantic oriented). This makes it possible to typeset a man page into PostScript, PDF, and various other formats for viewing or printing.
Some Unix systems have a package for the Template:Tt command, which enables users to browse their man pages using an HTML browser. Systems with groff and man-db should use the higher-quality native HTML output (Template:Tt) instead. The GNU Emacs program WoMan (from "WithOut man") allows to browse man pages from the editor.<ref name="WoMan">{{#invoke:citation/CS1|citation |CitationClass=web }}</ref>
In 2010, OpenBSD deprecated troff for formatting man pages in favour of mandoc, a specialised compiler/formatter for man pages with native support for output in PostScript, HTML, XHTML, and the terminal. It is meant to only support a subset of troff used in manual pages, specifically those using mdoc macros.
Online servicesEdit
Quite a few websites offer online access to manual pages from various Unix-like systems.
In February 2013, the BSD community saw a new open source mdoc.su service launched, which unified and shortened access to the man.cgi scripts of the major modern BSD projects through a unique nginx-based deterministic URL shortening service for the *BSD man pages.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref><ref>Template:Cite mailing list</ref><ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref>
For Linux, a man7.org service has been set up to serve manuals specific to the system.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> A ManKier service provides a wider selection, and integrates the TLDR pages too.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref>
Command usageEdit
To read a manual page for a Unix command, a user can type: <syntaxhighlight lang="bash"> man <command_name> </syntaxhighlight>
Pages are traditionally referred to using the notation "name(section)": for example, Template:Man. The section refers to different ways the topic might be referenced - for example, as a system call, or a shell (command line) command or package, or a package's configuration file, or as a coding construct / header.
The same page name may appear in more than one section of the manual, such as when the names of system calls, user commands, or macro packages coincide. Examples are Template:Man and Template:Man, or Template:Man and Template:Man. The syntax for accessing the non-default manual section varies between different man implementations.
On Solaris and illumos, for example, the syntax for reading Template:Man is: <syntaxhighlight lang="bash"> man -s 3c printf </syntaxhighlight> On Linux and BSD derivatives the same invocation would be: <syntaxhighlight lang="bash"> man 3 printf </syntaxhighlight>
which searches for printf in section 3 of the man pages. The actual file name likely includes the section. Continuing this example, printf.3.gz would be a compressed manual page file in section 3 for printf.
Manual sectionsEdit
The manual is generally split into eight numbered sections. Most systems today (e.g. BSD,<ref name=FBSD>Template:Man</ref> macOS, Linux,<ref name=mk/> and Solaris 11.4) inherit the numbering scheme used by Research Unix.<ref name=v8>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref><ref name=svr4>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> While System V uses a different order:<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref>
| Common | System V | Description |
|---|---|---|
| 1 | 1 | General commands |
| 2 | 2 | System calls |
| 3 | 3 | Library functions, covering in particular the C standard library |
| 4 | 7 | Special files (usually devices, those found in /dev) and drivers |
| 5 | 4 | File formats and conventions |
| 6 | 6 | Games and screensavers |
| 7 | 5 | Miscellaneous |
| 8 | 1M | System administration commands and daemons |
POSIX APIs are present in both sections 2 and 3, where section 2 contains APIs that are implemented as system calls and section 3 contains APIs that are implemented as library routines.
On some systems, additional sections may be included such as:
| Section | Description | |
|---|---|---|
| 0 | C library header files (Unix v6) | |
| 9 | Kernel routines (FreeBSD, SVR4, Linux)<ref name=svr4/><ref name=FBSD/> | |
| l | LAPACK library functions<ref>{{#invoke:citation/CS1|citation | CitationClass=web
}}</ref> |
| n | Tcl/Tk commands | |
| x | The X Window System |
Some sections are further subdivided by means of a suffix; for example, in some systems, section 3C is for C library calls, 3M is for the math library, and so on. A consequence of this is that section 8 (system administration commands) is sometimes relegated to the 1M subsection of the main commands section. Some subsection suffixes have a general meaning across sections:
| Subsection | Description |
|---|---|
| p | POSIX specifications |
| x | X Window System documentation |
(Section 3 tends to be the exception with the many suffixes for different languages.)
Some versions of man cache the formatted versions of the last several pages viewed. One form is the cat page, simply piped to the pager for display.
LayoutEdit
All man pages follow a common layout that is optimized for presentation on a simple ASCII text display, possibly without any form of highlighting or font control. Sections present may include:<ref name=mdoc-7/>Template:Rp
- NAME
- The name of the command or function, followed by a one-line description of what it does.
- SYNOPSIS
- In the case of a command, a formal description of how to run it and what command line options it takes. For program functions, a list of the parameters the function takes and which header file contains its declaration.
- DESCRIPTION
- A textual description of the functioning of the command or function. For programs, this section often includes explanations of available command line options.
- EXAMPLES
- Some examples of common usage.
- SEE ALSO
- A list of related commands or functions.
Other sections may be present, but these are not well standardized across man pages. Common examples include: OPTIONS, EXIT STATUS, RETURN VALUE, ENVIRONMENT, BUGS, FILES, AUTHOR, REPORTING BUGS, HISTORY and COPYRIGHT.
AuthoringEdit
Manual pages can be written either in the old <syntaxhighlight lang="text" class="" style="" inline="1">man</syntaxhighlight> macros or the new <syntaxhighlight lang="text" class="" style="" inline="1">doc</syntaxhighlight> macros.<ref>Template:Man</ref> The <syntaxhighlight lang="text" class="" style="" inline="1">man</syntaxhighlight> macro set provides minimal rich text functions, with directives for the title line, section headers, (bold, small or italic) fonts, paragraphs and adding/reducing indentation.<ref>Template:Man</ref> The newer <syntaxhighlight lang="text" class="" style="" inline="1">mdoc</syntaxhighlight> language is more semantic in nature, and contains specialized macros for most standard sections such as program name, synopsis, function names, and the name of the authors. This information can be used to implement a semantic search for manuals by programs such as mandoc. Although it also includes directives to directly control the styling, it is expected that the specialized macros will cover most of the use-cases.<ref name=mdoc-7>Template:Man</ref> Both the mandoc and the groff projects consider <syntaxhighlight lang="text" class="" style="" inline="1">mdoc</syntaxhighlight> the preferred format for new documents.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref>
Although man pages are, to troff, text laid out using 10-point Roman type, this distinction is usually moot because man pages are viewed in the terminal (TTY) instead of laid out on paper. As a result, the "small font" macro is seldom used.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> On the other hand, bold and italic text is supported by the terminal via ECMA-48, and groff's <syntaxhighlight lang="text" class="" style="" inline="1">grotty</syntaxhighlight> does emit them as requested when it detects a supporting terminal. The BSD mandoc however only supports bold and underlined (as a replacement for italics) text via the typewriter backspace-then-overstrike sequence, which needs to be translated into ECMA-48 by <syntaxhighlight lang="text" class="" style="" inline="1">less</syntaxhighlight>.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref><ref>Template:Man. "Font styles are applied by using back-spaced encoding..."</ref>
Some tools have been used to convert documents in a less contrived format to manual pages. Examples include GNU's <syntaxhighlight lang="text" class="" style="" inline="1">help2man</syntaxhighlight>, which takes a <syntaxhighlight lang="text" class="" style="" inline="1">--help</syntaxhighlight> output and some additional content to generate a manual page.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> The manual would be barely more useful than the said output, but for GNU programs this is not an issue as texinfo is the main documentation system.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref> A number of tools, including pandoc, ronn, and md2man support conversion from Markdown to manual pages. All these tools emit the <syntaxhighlight lang="text" class="" style="" inline="1">man</syntaxhighlight> format, as Markdown is not expressive enough to match the semantic content of <syntaxhighlight lang="text" class="" style="" inline="1">mdoc</syntaxhighlight>. DocBook has an inbuilt man(7) converter – of appalling quality, according to mandoc's author<ref>{{#invoke:citation/CS1|citation |CitationClass=web }} – for specific complaints by the author, see Template:Cite mailing list</ref> who wrote a separate mdoc(7) converter.
Man pages are usually written in English, but translations into other languages may be available on the system. The GNU <syntaxhighlight lang="text" class="" style="" inline="1">man-db</syntaxhighlight> and the mandoc <syntaxhighlight lang="text" class="" style="" inline="1">man</syntaxhighlight> is known to search for localized manual pages under subdirectories.<ref>{{#invoke:citation/CS1|citation |CitationClass=web }}</ref><ref name=mk>Template:Man</ref>Template:Rp<ref name=FBSD/>
AlternativesEdit
Few alternatives to man have enjoyed much popularity, with the possible exception of GNU Project's "info" system, an early and simple hypertext system. There is also a third-party effort known as TLDR pages (tldr) that provides simple examples for common use cases, similar to a cheatsheet.<ref>{{#invoke:citation/CS1|citation
|CitationClass=web
}}</ref>
In addition, some Unix GUI applications (particularly those built using the GNOME and KDE development environments) now provide end-user documentation in HTML and include embedded HTML viewers such as yelp for reading the help within the application. An HTML system in Emacs is also slated to replace texinfo.<ref>Template:Cite mailing list</ref>
See alsoEdit
- List of Unix commands
- List of Plan 9 applications
infoapropos- README
- RTFM
- ManOpen – NeXT/macOS graphical man utility
ReferencesEdit
External linksEdit
- History of UNIX Manpages for a primary-source history of UNIX man pages.
- UNIX and Linux Man Page Repository with nearly 300,000 well formatted man pages.
- What do the numbers in a man page mean?
- FreeBSD Manual Pages, freebsd.org – has also man pages for Darwin, Debian, HP-UX, IRIS, NetBSD, OpenBSD, NextSTEP, SunOS and more