Начало работы с «man»: несколько вопросов [дубликат]

[1.]

Я ожидал увидеть список, но все, что я получаю, это: Какую страницу руководства вы хотите?

-S не используется для отображения списка разделов, вместо этого он просит вас передать список разделов в желаемый порядок поиска разделов . Например.

xb@dnxb:/tmp$ man -S=7,6,5,4,3,2 ls
No manual entry for ls
See 'man 7 undocumented' for help when manual pages are not available.
xb@dnxb:/tmp$ 

Вышеупомянутый -S = 7,6,5,4,3,2 показывает, что порядок поиска разделов начинается слева направо в этом списке. Если руководство ls содержит раздел 7, оно будет показано. В противном случае он попытается выполнить поиск в разделе 6 и так далее. Если в конце этого списка нет раздела, будет сказано «Нет ручного ввода для ls» , даже если раздел 1 существует . Но этот работает, потому что раздел 1 в списке:

xb@dnxb:/tmp$ man -S=7,6,5,4,3,2,1 ls
xb@dnxb:/tmp$ 

Поиграйте с этими двумя, чтобы доказать, что порядок поиска -S слева направо:

xb@dnxb:/tmp$ man -S 1,1posix ls
xb@dnxb:/tmp$ man -S 1posix,1 ls
xb@dnxb:/tmp$ 

Вы также можете просто передать точный раздел, без -S :

xb@dnxb:/tmp$ man 5 ls
No manual entry for ls in section 5
See 'man 7 undocumented' for help when manual pages are not available.
xb@dnxb:/tmp$ man 1posix ls
xb@dnxb:/tmp$

Порядок по умолчанию можно найти здесь (этот путь к файлу описан в man man ), порядок поиска слева направо:

xb@dnxb:/tmp$ \grep SECTION /etc/manpath.config
# the default is 1, n, l, 8, 3, 0, 2, 5, 4, 9, 6, 7. Multiple SECTION
SECTION         1 n l 8 3 2 3posix 3pm 3perl 5 4 9 6 7
xb@dnxb:/tmp$ 

Как я могу отобразить разделы man-страницы? Как узнать, какие разделы предлагает страница руководства?

Используйте apropos [-e] , whatis или man -k :

xb@dnxb:/tmp$ apropos statvfs #OR man -k statvfs
fstatvfs (2)         - get filesystem statistics
fstatvfs (3)         - get filesystem statistics
fstatvfs (3posix)    - get file system information
statvfs (2)          - get filesystem statistics
statvfs (3)          - get filesystem statistics
statvfs (3posix)     - get file system information
statvfs.h (7posix)   - VFS File System information structure
sys_statvfs.h (7posix) - VFS File System information structure
xb@dnxb:/tmp$ apropos -e statvfs #OR whatis statvfs
statvfs (2)          - get filesystem statistics
statvfs (3)          - get filesystem statistics
statvfs (3posix)     - get file system information
xb@dnxb:/tmp$ 

[2.]

Как показать короткую версию / превью человека страница?

Я всегда использую - help , чтобы увидеть сокращенную версию руководства (Заявление об ограничении ответственности: не совсем эквивалентно), например:

xb@dnxb:/tmp$ mplayer --help
Usage:   mplayer [options] [url|path/]filename

Basic options: (complete list in the man page)
 -vo <drv>        select video output driver ('-vo help' for a list)
 -ao <drv>        select audio output driver ('-ao help' for a list)
 vcd://<trackno>  play (S)VCD (Super Video CD) track (raw device, no mount)
 dvd://<titleno>  play DVD title from device instead of plain file
 -alang/-slang    select DVD audio/subtitle language (by 2-char country code)
 -ss <position>   seek to given (seconds or hh:mm:ss) position
 -nosound         do not play sound
 -fs              fullscreen playback (or -vm, -zoom, details in the man page)
 -x <x> -y <y>    set display resolution (for use with -vm or -zoom)
 -sub <file>      specify subtitle file to use (also see -subfps, -subdelay)
 -playlist <file> specify playlist file
 -vid x -aid y    select video (x) and audio (y) stream to play
 -fps x -srate y  change video (x fps) and audio (y Hz) rate
 -pp <quality>    enable postprocessing filter (details in the man page)
 -framedrop       enable frame dropping (for slow machines)

Basic keys: (complete list in the man page, also check input.conf)
 <-  or  ->       seek backward/forward 10 seconds
 down or up       seek backward/forward  1 minute
 pgdown or pgup   seek backward/forward 10 minutes
 < or >           step backward/forward in playlist
 p or SPACE       pause movie (press any key to continue)
 q or ESC         stop playing and quit program
 + or -           adjust audio delay by +/- 0.1 second
 o                cycle OSD mode:  none / seekbar / seekbar + timer
 * or /           increase or decrease PCM volume
 x or z           adjust subtitle delay by +/- 0.1 second
 r or t           adjust subtitle position up/down, also see -vf expand

 * * * SEE THE MAN PAGE FOR DETAILS, FURTHER (ADVANCED) OPTIONS AND KEYS * * *

MPlayer 1.3.0 (Debian), built with gcc-5.4.0 (C) 2000-2016 MPlayer Team
xb@dnxb:/tmp$ 

Раньше онлайн-руководство («онлайн» в отличие от «печатного») состояло из восьми разделов, но позже было добавлено еще несколько. Это разделы 1, 2, ..., 8, поэтому вы должны ввести что-то вроде

man -S 4 xyz

, чтобы получить справочную страницу для xyz в Разделе 4.

На самом деле, указание раздела важно только при наличии справочных страниц. для одного и того же ключевого слова в более чем одном разделе.

Например:

man printf

дает

PRINTF(1)                                                         User Commands

NAME
       printf - format and print data

SYNOPSIS
       printf FORMAT [ARGUMENT]...
       printf OPTION

DESCRIPTION
       Print ARGUMENT(s) according to FORMAT, or execute according to OPTION
...

, а

man -S 3 printf

дает

PRINTF(3)                                                   Linux Programmer's Manual

NAME
       printf, fprintf, dprintf, sprintf, snprintf, vprintf, vfprintf, vdprintf, vsprintf, vsnprintf - formatted output conversion

SYNOPSIS
       #include <stdio.h>

       int printf(const char *format, ...);
       int fprintf(FILE *stream, const char *format, ...);
       int dprintf(int fd, const char *format, ...);
       int sprintf(char *str, const char *format, ...);
       int snprintf(char *str, size_t size, const char *format, ...);
...

Попробуйте man -S x intro с x = 1,2,3, .. ..чтобы познакомиться с различными разделами.

Иногда встречаются такие утверждения: ... fork (2) используется для создания нового процесса; за ним часто следует execl (3) ... Это означает, что справочная страница для fork находится в разделе 2, а справочная страница для execl находится в Разделе 3.

Как я могу отобразить краткую версию / предварительный просмотр страницы руководства?

Я не уверен, что вы имеете в виду. man не предоставляет что-то вроде Get-Help в PowerShell. whatis дает очень короткое описание, например

whatis man
man                  (1)  - format and display the on-line manual pages
man                  (1p)  - display system documentation
man                  (7)  - macros to format man pages
man []               (1)  - format and display the on-line manual pages
man []               (1p)  - display system documentation
man []               (7)  - macros to format man pages
man []               (7)  - pages - conventions for writing Linux man pages
man-pages            (7)  - conventions for writing Linux man pages
man.conf []          (5)  - configuration data for man
man.conf [man]       (5)  - configuration data for man

Простой ответ:

Страницы с помощью содержат разделов; разделы содержат ман-страницы.

Это относится к пронумерованным разделам, о которых вы говорите. Может быть две страницы с одинаковым названием, но в двух разных (пронумерованных) разделах, например, printf. На странице printf(1) описано средство командной строки. Страница printf(3) охватывает вызов функции C.

Вы можете просматривать обе страницы в последовательности, выполнив:

man -a printf

Когда вы выйдете из первой, вы увидите вторую.

Вы можете увидеть, в каких разделах он появляется, не открывая ни того, ни другого, выполнив:

man -aw printf

Помимо пронумерованных разделов , в которых существуют man-страницы,отдельные страницы также разделены визуально с отдельными заголовками и подзаголовками, такими как «Имя», «Синопсис», «Описание» и т. Д.

Это также называются «разделы», но это совершенно иное использование слова «раздел» от пронумерованных разделов, описанных выше.

Аргумент -S не делает то, что ты хочешь. Он предназначен для указания категорий страниц руководства, в которых вы хотите искать.

Если существует автоматизированный метод отображения разделов страницы руководства, я не знаю об этом. Я бы обратился к таким инструментам, как grep / sed / awk, чтобы проанализировать справочную страницу и извлечь интересующий меня текст, например:

man ls | grep -v -e '^ $' -e '^ [[: space:]] '

Приведенный выше код не является полным решением. Во-первых, он также печатает верхний и нижний колонтитулы справочной страницы. Надеюсь, вы можете изменить его, чтобы полностью удовлетворить ваши требования, или придумать лучшую реализацию;)

Точно так же запрос на получение «предварительного просмотра» страницы руководства может быть легко выполнен путем конвейерной передачи вывода человека в другой инструмент. Я бы порекомендовал голову для этой задачи.