Pomoc w systemie

Linux – podobnie jak wszystkie inne uniksopodobne systemy operacyjne – hołduje tradycji, że każda dostępna w systemie komenda ma stowarzyszony z nią opis, np.

labul@centos7-1 ~]$ help echo
labul@centos7-1 ~]$ ipcalc -h
labul@centos7-1 ~]$ tar --help
labul@centos7-1 ~]$ man|info tar
labul@centos7-1 ~]$ man|info gcc

Jest to tradycyjny, właściwy dla systemu UNIX sposób dostarczania dokumentacji dotyczącej programów.

Każda strona systemu pomocy należy do jakiegoś rozdziału podręcznika (manual):

1

User commands

2

System calls

3

C language library functions

4

Device files and drivers

5

Configuration files and file formats

6

Games

7

Miscellaneous (e. g. groff macros, ASCII tables, …)

8

Administrator commands

9

Kernel functions

n

»New« commands

Z praktycznego punktu widzenia najważniejsze są rozdziały 1, 5 i 8.

Każda strona podręcznika jest podzielona na sekcje:

NAME

Command name and brief description

SYNOPSIS

Description of the command syntax

DESCRIPTION

Verbose description of the command’s effects

OPTIONS

Available options

ARGUMENTS

Available Arguments

FILES

Auxiliary files

EXAMPLES

Sample command lines

SEE ALSO

Cross-references to related topics

DIAGNOSTICS

Error and warning messages

COPYRIGHT

Authors of the command

BUGS

Known limitations of the command

Zob. np. strony podręcznika dla komendy su i usermod.

Na początku lat 1990, w ramach projektu GNU uznanno ten system dokumentowania komend za przestarzały i postanowiono zastąpić go przy pomocy komendy info.

Porównaj w jakich rozdziałach znajdują się strony następujących komend: date, tar, ip, fsck.

Porównaj man [1] crontab oraz man 5 crontab. Jak działa komenda man -a crontab?

Porównaj także

labul@centos7-1 ~]$ man ssh
labul@centos7-1 ~]$ man ssh_config
labul@centos7-1 ~]$ man sshd
labul@centos7-1 ~]$ man sshd_config
labul@centos7-1 ~]$ systemctl status sshd

Jeśli nie znamy dokładnie nazwy komendy, której strony pomocy chcielibyśmy przeczytać, to można użyć komendy man -k klucz lub apropos klucz, które przeszukują sekcje “NAME” w poszukiwaniu podanego słowa kluczowego. whatis klucz wykonuje jedynie przeszukiwanie w nazwach komend.

Porównaj działanie komend:

# man -k cron
# apropos cron

Strony podręcznika systemowego są dostępne także poprzez przeglądarkę konqueror; wystarczy wpisać jako adres zasobu man:ssh lub info:tar.

Strony podręcznika systemowego są umieszczone w /usr/share/man/ i /usr/share/info/ (np. info -w emacs); dodatkowa dokumentacja znajduje się w /usr/share/doc (zob. manpath).

Zob. Przykłady użycia komend man i apropos.

Przydatne strony: