Questions tagged [man]

man - format and display the on-line manual pages ("on-line" meaning “on the computer”, as opposed to “on paper”, not “on the Internet”)

A traditional Unix documentation system, man is the main documentation scheme on most Unix-like OS's.

According to man itself, it is:

an interface to the on-line reference manuals.

The pages are usually written in English, with translations sometimes provided.

Man topics fall into these numbered sections, though section numbers may differ from system to system:

  • 1 - Executable programs and shell commands, eg. man aspell or man 1 aspell

  • 2 - System calls (kernel functions), eg. man delete_module or man 2 delete_module

  • 3 - Library calls, eg. man 3 assert

  • 4 - Special files (usually devices found in /dev) and drivers, eg. man console

  • 5 - File formats and conventions, eg. man bounce

  • 6 - Games and screensavers, eg: man gnome-mahjongg

  • 7 - Miscellaneous (including macro packages and conventions), e.g. man 7 man, man x

  • 8 - System administration commands (usually only for root), e.g. man wpa_passphrase

  • 9 - Kernel routines [Non standard]

  • 0 - C library header files [Non standard]

Section numbers are used in man calls for disambiguation, when there are documents for the same names, but different topics, in different sections, eg.

  • man 2 exit for exit kernel function terminating the calling process immediately, and

  • man 3 exit for a standard library function call that causes normal termination of the process.

Similar documentation standards

Shell built-ins usually do not have their separate man pages. Their short description can be viewed with the help command.

In recent years, software providers often choose info pages as their documentation scheme.

Useful commands

  • Man pages of man

    man man

Further reading

Internal links

External links

See also

633 questions
745
votes
9 answers

What do the numbers in a man page mean?

So, for example, when I type man ls I see LS(1). But if I type man apachectl I see APACHECTL(8) and if I type man cd I end up with cd(n). I'm wondering what the significance of the numbers in the parentheses are, if they have any.
Wilduck
  • 7,577
95
votes
11 answers

How do I use man pages to learn how to use commands?

While researching another problem, I came across a command, locate something | xargs -I {} bash -c "if [ -d "{}" ]; then echo {}; fi" that I wanted to learn more about. So I ran man xargs and get the following output: XARGS(1) …
user1717828
  • 3,542
77
votes
7 answers

How to dump a man page?

How can I 'cat' a man page like I would 'cat' a file to get just a dump of the contents?
LanceBaynes
  • 40,135
  • 97
  • 255
  • 351
53
votes
1 answer

How does `man git init` get the right man page?

So it seems that typing man git init into a bash prompt on an Ubuntu 14.04 system does the same as man git-init, only I'm not quite sure how. The man page for man (i.e. man man) doesn't seem to allow for this construct, unless git was a section of…
mc0e
  • 1,086
48
votes
3 answers

Understand synopsis in manpage

I have not been able to understand the SYNOPSIS section in the manpage of a command. For example, let's see the manpage of man itself. By man man: SYNOPSIS man [-C file] [-d] [-D] [--warnings[=warnings]] [-R encoding] [-L locale]…
Tim
  • 101,790
36
votes
2 answers

What is the deal with mandb and stray cats?

The man page for mandb refers to stray cats: -s, --no-straycats Do not spend time looking for or adding information to the databases regarding stray cats. There is no explanation of what a stray cat is. What's up?
tbodt
  • 495
25
votes
4 answers

How do I directly display a man page?

I'm writing a man page for a program that I am packaging. How can I display the manpage file that I created, to check if it's all right? Is there a way to pass my file directly to the man command instead of having it search the installed manpages by…
hugomg
  • 5,747
  • 4
  • 39
  • 54
23
votes
3 answers

Where should I install manual pages in user directory?

I'm trying to create a Makefile for a small Perl utility I wrote, And I'm struggling to find out a way to find where to install my man page when make is run as a non-root user. I'm currently parsing the output of manpath to find out the first path…
23
votes
1 answer

man does not work (too many arguments)

I get this an error when trying to run man on a Linux system: $ LC_ALL=C man man man: Too many arguments Try 'man --help' or 'man --usage' for more information. My man command doesn't seem to be an alias: command -v man: /usr/bin/man What's…
NeedHelp
  • 343
  • 2
  • 5
20
votes
7 answers

How do I check man pages for what single parameter of the command does?

Example: I am using tar -zxvf command but I don't know what 'x' stands for. How can I check this single parameter without having to scroll all the way through man tar?
syntagma
  • 12,311
19
votes
3 answers

How to append to MANPATH?

If the MANPATH environment variable is set, man very "helpfully" ignores the default search path, as defined in /etc/manpath.config. Is there any way add a path or paths to that searched by man?
mjs
  • 309
  • 1
  • 2
  • 7
17
votes
2 answers

What does the "3am" section means in manpages?

I found this accidentally. I just typed man fork, and instead of showing the system call documentation, it showed to me an awk extension, however, the section page number was 3am, instead of just 3. What does 3am means?
ABu
  • 556
16
votes
1 answer

View a man page in a specific section

I wanted to access man pages for command chmod. Command whatis chmod gave this output: chmod (2) - change permissions of a file chmod (1) - change file mode bits But I was actually looking for chmod(2). When I type man chmod,…
13
votes
2 answers

Guided tour at the console?

I think it would really enjoy a guided tour of either just the typical Linux filesystem (which I realize varies from system to system), or a guided tour of the filesystem and common console productivity patterns and everything else! Imagine you're a…
themirror
  • 6,988
12
votes
2 answers

How to find the name of the man page of something?

Let's say I want the man page related to luks. man luks doesn't work, is there a quick way for me to find the man pages using the keyword luks from bash ?
ChiseledAbs
  • 2,243
1
2 3 4 5 6