Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

man - display system documentation

&pagelevel(4)&pagelevel

The man command allows you to use the POSIX online documentation, in other words to have the syntax and description of a POSIX commands written to standard output.


Syntax


Format 1:man[ -x] command...
Format 2:man -k expression

-x

Only the command syntax is written to standard output. If this option is not set the full description of the command is output.

-k

Scans the POSIX-internal database. This database contains a brief description of every command. Every line which contains the specified expression is output.

command

The name of one or more POSIX commands. If there is no description available for one of the commands the following error message is output:

Manual entry not found: /usr/share/man/En/text.txt.Z

If more than one command is specified and -x is not set, the output command defined by the PAGER variable is called separately for each command.

expression

An expression according to the syntax of the grep command. The search is performed case-insensitive (grep -i).

File

/usr/share/man/En/*.txt.Z
/usr/share/man/De/*.txt.Z

These files contain the manual entries; one file per command and language.

/usr/share/man/En/man.index
/usr/share/man/De/man.index

Brief descriptions of the commands.

Variable

PAGER

Determines the command which will display or process the information. The information will be sent to standard input of the command. The default value is more -d.

Locale

The following environment variables affect the execution of man:

LANG

Determines the language for the output of documentation and of messages. If the contents of the variable start with "De" oder "de" the output language will be German. Otherwise it will be English.

LC_ALL

If set to a non-empty string value, that value overwrites the value of the LANG variable.

Example 1

Displaying Information about the mkdir command:

$ man mkdir

mkdir - make directories

========================

mkdir is used to create new directories.

...

(END) [RETURN]

$

Example 2

Displaying all the commands which contain the string "attrib" in their brief description:

$ man attrib
Manual entry not found: /usr/share/man/En/attrib.txt.Z

$ man -k attrib

bs2file - set BS2000 file attributes

export - set export attribute for variables

readonly - set read-only attributes for variables

typeset - set attributes for variables

unset - unset values and attributes of variables and functions

(END) [RETURN]

$

Beispiel 3

Send the brief description of all commands to the default printer:

$ PAGER=lp man -k .
lp: request id is TSN-0V02 (TSN0V01.2011-04-27.144908-1.standard_input)

$

Example 4

Displaying the syntax of the head command:

$ man -x head

+-- Syntax -----------------------------------------------------------------+

|                                                                           |
| Format 1: head[ -n number][ file]                                         |

|                                                                           |

| Format 2: head[ -number][ file]                                           |
|                                                                           |

+---------------------------------------------------------------------------+

$

See also

cat, more, lp