man page - ArchWiki

# man page

From ArchWiki
Jump to navigation Jump to search

Related articles

- Color output in console#man

man pages—abbreviation for "manual pages"—are the form of documentation that is available on almost all UNIX-like operating systems, including Arch Linux. The command used to display them is `man`.

In spite of their scope, man pages are designed to be self-contained documents, consequentially limiting themselves to referring to other man pages when discussing related subjects. This is in sharp contrast with the hyperlink-aware Info documents, GNU's attempt at replacing the traditional man page format.

man-db implements man on Arch Linux, and less is the default pager used with man.

## Accessing man pages

To read a man page, simply enter:

    $ man page_name

Manuals are sorted into several sections. For a full listing see the section entitled "Sections of the manual pages" in man-pages(7).

Man pages are usually referred to by their name, followed by their section number in parentheses. Often there are multiple man pages of the same name, such as man(1) and man(7). In this case, give man the section number followed by the name of the man page, for example:

    $ man 5 passwd

to read the man page on `/etc/passwd`, rather than the `passwd` utility.

## Format

Man pages all follow a fairly standard format, which helps in navigating them. See the section entitled "Sections within a manual page" in man-pages(7).

## Searching manuals

This article or section needs language, wiki syntax or style improvements. See Help:Style for reference.

Reason: Unnecessarily verbose. (Discuss in Talk:Man page#)

Even though the `man` utility allows users to display man pages, and search their contents via less, a problem arises when one knows not the exact name of the desired manual page in the first place! Fortunately, the `-k` or `--apropos` options can be used to search the manual page descriptions for instances of a given keyword.

### Building the manual cache with mandb

The search feature is provided by a dedicated cache, otherwise all searches would give the nothing appropriate result. By default, maintenance of that cache is handled by `man-db.service` which gets periodically triggered by `man-db.timer`. You can manually (re)generate the cache or update it by running:

    # mandb

### Searching for expressions in manuals

For example, to search for man pages related to "password":

    $ man -k password

or:

    $ man --apropos password

This is equivalent to calling the `apropos` command:

    $ apropos password

The given keyword is interpreted as a regular expression by default.

If you want to do a more in-depth search by matching the keywords found in the whole articles, you can use the `-K` option:

    $ man -K password

### Getting one-line descriptions with whatis

One-line descriptions of man pages in the man-db cache can be displayed using the `whatis` command. For example, for a brief description of the man page sections about `ls`, type:

    $ whatis ls

    ls (1p)              - list directory contents
    ls (1)               - list directory contents

## Page width

The man page width is controlled by the `MANWIDTH` environment variable.

If the number of columns in the terminal is too small (e.g. the window width is narrow), the line breaks will be wrong. This can be very disturbing for reading. You can fix this by setting the MANWIDTH on `man` invocation. With `Bash`, that would be:

    ~/.bashrc

    man() {
        local width=$(tput cols)
        [ $width -gt $MANWIDTH ] && width=$MANWIDTH
        env MANWIDTH=$width \
        man "$@"
    }

## Reading local man pages

Instead of the standard interface, using browsers such as lynx and Firefox to view man pages allows users to reap info pages' main benefit of hyperlinked text. Alternatives include the following:

### Viewer applications

- GNOME Help — Help viewer for GNOME. It can show man pages via `yelp man:<name>` or the undocumented `CTRL+L` keybinding from an existing window.

  https://wiki.gnome.org/Apps/Yelp || yelp

- KHelpCenter — Application to show KDE Applications' documentation. Man pages are in UNIX manual pages or by running `khelpcenter man:<name>`.

  https://userbase.kde.org/KHelpCenter || khelpcenter

- Konqueror — KDE file manager and web browser. It can show man pages via `man:<name>`.

  https://konqueror.org/ || konqueror

- xman — Provides a categorized look at man pages.

  https://xorg.freedesktop.org/ || xorg-xman

### Conversion to HTML

#### mandoc

Install the mandocAUR package. To convert a page, for example `free(1)`:

    $ mandoc -Thtml -Ostyle=style.css /usr/share/man/man1/free.1.gz > free.html

Now open the file called `free.html` in your favourite browser.

#### man2html

First, install man2html from the official repositories.

Now, convert a man page:

    $ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html

Another use for `man2html` is exporting to raw, printer-friendly text:

    $ man free | man2html -bare > ~/free.txt

#### man -H

The GNU implementation of man in the Arch repositories also has the ability to do this on its own:

    $ man -H free

This will read your `BROWSER` environment variable to determine the browser. You can override this by passing the binary to the `-H` option.

#### roffit

First install roffitAUR from AUR.

To convert a man page:

    $ gunzip -c /usr/share/man/man1/free.1.gz | roffit > free.html

### Conversion to PDF

man pages have always been printable: they are written in troff, which is fundamentally a typesetting language. If you have ghostscript installed, you can convert a man page to PDF using `man -t <manpage> | ps2pdf - <pdf>`.

Caveats: Fonts are generally limited to Times at hardcoded sizes. There are no hyperlinks. Some man pages were specifically designed for terminal viewing, and won't look right in PS or PDF form.

## Online man pages

There are several online databases of man pages, including:

- man7.org. Upstream for Arch Linux's man-pages.
- Arch Linux man pages. Used for links from the wiki.
- manned.org — collection from various Linux distributions, BSD, etc., with multiple package versions
- linux.die.net
- man.cx
- Debian man pages
- Ubuntu man pages
- DragonFlyBSD man pages
- FreeBSD man pages
- NetBSD man pages
- OpenBSD man pages
- Mac OS X man pages[dead link 2019-01-17]
- Plan 9 Manual — Volume 1
- Inferno Manual — Volume 1
- Storage Foundation man pages
- The UNIX and Linux forums man page repository

Tip: You can use the `!archman` DuckDuckGo !Bang to search through the Arch Linux man pages directly.
Warning: Some distributions provide patched or outdated man pages that differ from those provided by Arch. Exercise caution when using online man pages.

## Noteworthy manpages

Here follows a non-exhaustive list of noteworthy pages that might help you understand a lot of things more in-depth. Some of them might serve as a good reference (like the ASCII table).

- ascii(7)
- boot(7)
- charsets(7)
- chmod(1)
- credentials(7)
- fstab(5)
- hier(7)
- systemd(1)
- locale(1p), locale(5), locale(7)
- printf(3)
- proc(5)
- regex(7)
- signal(7)
- term(5), term(7)
- termcap(5)
- terminfo(5)
- utf-8(7)

More generally, have a look at category 7 (miscellaneous) pages:

    $ man -s 7 -k ".*"

Arch Linux specific pages:

- archlinux(7)
- mkinitcpio(8)
- pacman(8)
- pacman-key(8)
- pacman.conf(5)

## See also

- man page - Gentoo wiki article
- Write The Fine Manual with pod2man

Category:

- Command-line

Hidden categories:

- Pages or sections flagged with Template:Style
- Pages with dead links