Co oznaczają liczby na stronie podręcznika?

Na przykład, kiedy piszę man ls, widzę LS(1). Ale jeśli napiszę man apachectl, zobaczę, APACHECTL(8)a jeśli napiszę, man cdto skończę cd(n).

Zastanawiam się, jakie znaczenie mają liczby w nawiasach, jeśli takie mają.

Liczba odpowiada części sekcji instrukcji, z której pochodzi ta strona; 1 to polecenia użytkownika, a 8 to sysadmin. Strona man dla samego man ( man man) wyjaśnia ją i wymienia te standardowe:

MANUAL SECTIONS
    The standard sections of the manual include:

    1      User Commands
    2      System Calls
    3      C Library Functions
    4      Devices and Special Files
    5      File Formats and Conventions
    6      Games et. al.
    7      Miscellanea
    8      System Administration tools and Daemons

    Distributions customize the manual section to their specifics,
    which often include additional sections.

Istnieją pewne terminy, które mają różne strony w różnych sekcjach (np. printfGdy polecenie pojawia się w sekcji 1, a stdlibfunkcja pojawia się w sekcji 3); w takich przypadkach możesz przekazać numer sekcji manprzed nazwą strony, aby wybrać, który chcesz, lub użyć, man -aaby wyświetlić każdą pasującą stronę z rzędu:

$ man 1 printf
$ man 3 printf
$ man -a printf

Możesz powiedzieć, z którymi sekcjami należy dany termin man -k(odpowiednik apropospolecenia). Będzie także wykonywać dopasowania podłańcuchowe (np. Pokaże, sprintfjeśli uruchomisz man -k printf), więc musisz użyć, ^termaby go ograniczyć:

$ man -k '^printf'
printf               (1)  - format and print data
printf               (1p)  - write formatted output
printf               (3)  - formatted output conversion
printf               (3p)  - print formatted output
printf [builtins]    (1)  - bash built-in commands, see bash(1)

Historia tych numerów sekcji sięga pierwotnego podręcznika programisty Uniksa autorstwa Thompsona i Ritchiego z 1971 roku.

Oryginalne sekcje były

1. Polecenia
2. Połączenia systemowe
3. Podprogramy
4. Pliki specjalne
5. Formaty plików
6. Programy obsługiwane przez użytkownika
7. Różne

konqueror opisuje także niestandardowe sekcje: (dzięki @ greg0ire za pomysł)

0     Header files
0p    Header files (POSIX)
1     Executable programs or shell commands
1p    Executable programs or shell commands (POSIX)
2     System calls (functions provided by the kernel)
3     Library calls (functions within program libraries)
3n    Network Functions
3p    Perl Modules
4     Special files (usually found in /dev)
5     File formats and conventions eg /etc/passwd
6     Games
7     Miscellaneous  (including  macro  packages and conventions), e.g. man(7), groff(7)
8     System administration commands (usually only for root)
9     Kernel routines
l     Local documentation
n     New manpages

Co to oznacza już opisane, ale chce również dodać, że każda sekcja posiada specjalną stronę podręcznika z wprowadzeniem: intro. Na przykład, zobaczyć man 1 introczy man 3 introi tak dalej.

Z strony manpodręcznika:

The table below shows the section numbers of the manual followed by the 
types of pages they contain.

   1   Executable programs or shell commands
   2   System calls (functions provided by the kernel)
   3   Library calls (functions within program libraries)
   4   Special files (usually found in /dev)
   5   File formats and conventions eg /etc/passwd
   6   Games
   7   Miscellaneous  (including  macro  packages and conven‐
       tions), e.g. man(7), groff(7)
   8   System administration commands (usually only for root)
   9   Kernel routines [Non standard]

Co do tego, dlaczego są tak oddzielni - istnieje pewne nakładanie się. Niektóre strony istnieją w więcej niż jednej sekcji, w zależności od tego, co masz na myśli.

Na przykład porównaj man crontabz man 5 crontab- są szanse, że ten drugi to ten, który chciałeś sprawdzić.

To są numery sekcji. Po prostu wpisz man manlub otwórz konqueror i wpisz man: // man, a zobaczysz, co to za sekcje.

Często do strony man można się odwoływać poprzez dodanie jej do sekcji zawartej w nawiasach, np .:

read(2)

Ten styl ma dwie główne zalety:

• natychmiast staje się jasne, że odwołujesz się do strony podręcznika - tzn. możesz napisać coś takiego jak „por. czytaj (3) „zamiast” por. strona podręcznika użytkownika sekcja 3 przeczytana ”
• jeśli wiele sekcji zawiera strony podręcznika o tej samej nazwie, określenie sekcji jest bardziej precyzyjne

Strony podręcznika są podzielone na sekcje, np. Sekcja 1 zawiera wszystkie strony podręcznika użytkownika, sekcja 2 wszystkie strony podręcznika dla wywołań systemowych, sekcja 3 dotyczy funkcji bibliotecznych itp.

W wierszu poleceń, jeśli nie określisz wyraźnie sekcji, otrzymasz pierwszą pasującą stronę man, w domyślnej kolejności przechodzenia między sekcjami, np .:

$ man read

wyświetla się BASH_BUILTINS(1)w Fedorze. Gdzie

$ man 2 read

wyświetla stronę podręcznika dla read()wywołania systemowego.

Zauważ, że specyfikacja pozycji tej sekcji nie jest przenośna - np. W Solarisie możesz podać ją w następujący sposób:

$ man -s 2 read

Zazwyczaj man manzawiera również niektóre z dostępnych sekcji. Ale niekoniecznie wszystkie. Aby wyświetlić wszystkie dostępne sekcje, można wymienić podkatalogi wszystkich katalogów wymienionych w domyślnej ścieżce man lub zmiennej środowiskowej $MANPATH. Na przykład w systemie Fedora 23 z zainstalowanymi niektórymi pakietami programistycznymi /usr/share/manma następujące podkatalogi:

cs  es  id  man0p  man2   man3x  man5x  man7x  man9x  pt_BR  sk  zh_CN
da  fr  it  man1   man2x  man4   man6   man8   mann   pt_PT  sv  zh_TW
de  hr  ja  man1p  man3   man4x  man6x  man8x  pl     ro     tr
en  hu  ko  man1x  man3p  man5   man7   man9   pt     ru     zh

Katalogi z manprefiksem reprezentują każdą sekcję - podczas gdy inne zawierają przetłumaczone sekcje. Tak więc, aby uzyskać listę niepustych sekcji, można wydać takie polecenie:

$ find /usr/share/man -type f  | sed 's@^.*/man\(..*\)/.*$@\1@' \
    | sort -u | column
0p  1p  3   4   6   8
1   2   3p  5   7

(sekcje kończące psię na strony podręcznika POSIX)

Aby wyświetlić stronę podręcznika w innym języku (jeśli jest dostępny), można ustawić zmienną środowiskową związaną z językiem, np .:

$ LC_MESSAGES=de_DE man read

Ponadto każda sekcja powinna mieć nazwaną stronę podręcznika wprowadzającego intro, np. Widoczną poprzez:

$ man 2 intro

Definicje SVr4 to:

1 User Commands
2 System Calls
3 library Functions
4 File Formats
5 Standards, Environment and Macros (e.g. man(5))
6 Games and Demos
7 Device and Network Interfaces, Special Files
8 Maintenance Procedures
9 Kernel and Driver entry points and structures

Jest to faktyczna numeracja „genetycznego” systemu UNIX. POSIX nie definiuje liczb.