20 сент. 2000 г.

Азы linux (для детей) урок 15

Страницы man

Многие начинающие пользователи бояться справочных (man) страниц, потому что они ошеломляют количеством информации. Однако они хорошо структурированы, вы можете убедиться в этом на примере ниже: man man.
Чтение man-страниц обычно происходит в окне терминала в графическом режиме, или, если вы предпочитаете, прямо в текстовом режиме. Введите эту команду после приглашения и нажмите Enter:
yourname@yourcomp ~> man man
Документация для man отобразится на экране после нажатия Enter:
man(1)                                                         man(1)


NAME
 man - format and display the on-line manual pages
 manpath - determine user's search path for man pages

SYNOPSIS
 man [-acdfFhkKtwW] [--path] [-m system] [-p string] [-C config_file]
 [-M pathlist] [-P pager] [-S section_list] [section] name ...


DESCRIPTION
 man formats and displays the on-line manual pages.  If you specify
 section, man only looks in that section of the manual.  
 name is normally the name of the manual page, which is typically the 
 name of a  command, function, or file.  However, if name contains a 
 slash (/) then man interprets it as a file specification, so that you
 can do man ./foo.5 or even man /cd/foo/bar.1.gz.

 See  below  for  a  description  of where man looks for the manual
 page files.

OPTIONS
 -C  config_file
lines 1-27
Для просмотра следующей страницы нужно нажать пробел. Вы можете вернуться на предыдущую страницу, используя клавишу b. Когда вы дойдете до конца, man обычно закрывается, и вы возвращаетесь назад к приглашению. Нажмите q, если вы хотите покинуть man-страницу, не дойдя до конца, или если просмотр автоматически не завершается в конце страницы.
Каждая man-страница обычно содержит несколько стандартных разделов (что можно наблюдать на примере man man):
  • Первая строка содержит имя команды, о которой вы читаете, и id раздела, в котором эта man-страница находится. Man-страницы упорядочены по разделам. Команды могут иметь несколько man-страниц, например, man-страницу из пользовательского раздела, man-страницу из раздела администратора системы, и man-страницу из раздела для программиста.
  • Имя (name) команды и краткое описание приводятся в том виде, который используется при индексировании man-страниц. Вы можете просматривать эту базу при поиске любой строки с помощью команды apropos.
  • Обзор (synopsis) команды представляет специальные обозначения всех опций и/или аргументы, которые эта команда может принимать. Вы можете считать опции способом выполнения команды. Аргументы это то, по отношению к чему вы ее выполняете. У некоторых команд нет опций и аргументов. Необязательные опции и аргументы располагаются между "[" и "]", что указывает на то, что они могут быть опущены.
  • Дается более длинное описание (description) команды.
  • Список опций (options) с их описанием. Обычно опции могут быть скомбинированы. Если это не так, раздел уведомит вас об этом.
  • Окружение (environment) описывает переменные оболочки, которые влияют на поведение этой команды (это есть не у всех команд).
  • Иногда предусмотрены разделы специфичные для данной команды.
  • Ссылки на другие man-страницы приводится в разделе “SEE ALSO” ("смотри также"). Между круглыми скобками есть номер раздела, в котором находится справочная страница для данной команды. Опытные пользователи часто переходят к разделу "SEE ALSO" используя команду /, за которой следует строка поиска see и нажимают Enter.
  • Также обычно имеется информация об известных ошибках (аномалиях), а также куда можно сообщить о новых ошибках, если вы их найдете.
  • Также может содержаться информация об авторе и авторских правах.
У некоторых команд есть несколько man-страниц. Например, у команды passwd есть man-страница в разделе 1, а другая — в разделе 5. По умолчанию отображается man-страница с наименьшим номером. Если вы хотите увидеть другой раздел, а не тот, что по умолчанию, укажите его после команды man:
man 5 passwd
Если вы хотите увидеть все справочные страницы о команде, одну за другой, используйте с man опцию -a:
man -a passwd
Таким образом, когда вы дойдете до конца первой man-страницы и нажмите пробел, будет отображаться man-страница из следующего раздела.

Больше информации

Страницы Info

В дополнение к man-страницам, вы можете почитать о команде info-страницы, используя команду info. Они обычно содержат более свежую информацию и несколько проще в использовании. Man-страницы некоторых команд ссылаются на info-страницы.
Начните с ввода info info в окне терминала:
File: info.info,  Node: Top,  Next: Getting Started,  Up: (dir)

Info: An Introduction
*********************

   Info is a program, which you are using now, for reading
documentation of computer programs.  The GNU Project distributes most
of its on-line manuals in the Info format, so you need a program called
"Info reader" to read the manuals.  One of such programs you are using
now.

   If you are new to Info and want to learn how to use it, type the
command `h' now.  It brings you to a programmed instruction sequence.

   To learn advanced Info commands, type `n' twice.  This brings you to
`Info for Experts', skipping over the `Getting Started' chapter.

* Menu:

* Getting Started::             Getting started using an Info reader.
* Advanced Info::               Advanced commands within Info.
* Creating an Info File::       How to make your own Info file.
--zz-Info: (info.info.gz)Top, 24 lines --Top-------------------------------
Welcome to Info version 4.2. Type C-h for help, m for menu item.
Используйте клавиши со стрелками для просмотра текста и перемещения курсора на строку, начинающуюся со звездочки и содержащую ключевое слово, о котором вы хотите получить информацию, и затем нажмите Enter. Используйте клавиши P и N для перехода к предыдущей или следующей теме. Пробел переместит вас на одну страницу дальше, независимо от того, начинается ли новая тема или страница info для другой команды. Используйте Q для выхода. Программа info содержит больше информации.

Команды whatis и apropos

Краткие пояснения к командам доступны путем использования команды whatis, как в примере ниже:
[your_prompt] whatis ls
ls                   (1)  - list directory contents
Она отображает краткую информацию о команде, и первый раздел в структуре man-страниц, который содержит соответствующую страницу.
Если вы не знаете, где начать и какую man-страницу читать, команда apropos даст дополнительную информацию. Скажем, вы не знаете, как запустить браузер, тогда вы можете ввести следующую команду:
another prompt> apropos browser
Galeon [galeon](1)  - gecko-based GNOME web browser
lynx           (1)  - a general purpose distributed information browser 
	            for the World Wide Web
ncftp          (1)  - Browser program for the File Transfer Protocol
opera          (1)  - a graphical web browser
pilot          (1)  - simple file system browser in the style of the 
		    Pine Composer
pinfo          (1)  - curses based lynx-style info browser
pinfo [pman]   (1)  - curses based lynx-style info browser
viewres        (1x)  - graphical class browser for Xt
После нажатия Enter вы увидите, что большая часть браузеров входят в состав вашей ОС: и не только веб-браузеры, но также файловые и FTP браузеры, браузеры для документации. Если у вас установлены пакеты разработчика, то могут быть также сопровождающие man-страницы, касающиеся написания программ, связанных с браузерами. Как правило, команды с man-страницы находится в первом разделе, поэтому помечены "(1)", что соответствует их использованию под пользователем. Пользователь, который написал выше команду apropos, может в результате попытаться выполнить команды galeon, lynx или opera, т.к. они очевидно связаны с просмотром World Wide Web.

Опция --help

Большинство команд GNU поддерживают --help, которая выдает краткое пояснение того, как использовать команду, и список доступных опций. Ниже результат выдачи с этой опцией для команды cat:
userprompt@host: cat --help
Usage: cat [OPTION] [FILE]...
Concatenate FILE(s), or standard input, to standard output.

  -A, --show-all           equivalent to -vET
  -b, --number-nonblank    number nonblank output lines
  -e                       equivalent to -vE
  -E, --show-ends          display $ at end of each line
  -n, --number             number all output lines
  -s, --squeeze-blank      never more than one single blank line
  -t                       equivalent to -vT
  -T, --show-tabs          display TAB characters as ^I
  -u                       (ignored)
  -v, --show-nonprinting   use ^ and M- notation, 
			   except for LFD and TAB
      --help     display this help and exit
      --version  output version information and exit

With no FILE, or when FILE is -, read standard input.

Report bugs to .

Помощь в графическом режиме

Если вы предпочитаете графический интерфейс пользователя, то не отчаивайтесь. Konqueror, файловый менеджер KDE по умолчанию, обеспечивает безболезненный и красочный доступ к man и info-страницам. Вы можете попробовать "info:info" в адресной строке, и сможете посмотреть info-страницу о команде info. Также "man:ls" представит вам man-страницу команды ls. У вас даже есть завершение имени команды: вы увидите man-страницы для всех команд, начинающихся с "ls" прокрутив меню. Ввод "info:/dir" в адресной строке отображает все info-страницы, расположенные во вспомогательных категориях. Превосходен включенный в справочник Konqueror Help-контент. Запускается из меню или набрав команду konqueror в окне терминала c последующим нажатием Enter; см. скриншот ниже.
Рисунок 2.2. Konqueror как help-браузер
Просмотр справочной информации в Konqueror
Help-браузер в Gnome также очень удобный. Вы можете запустить его выбрав Приложения → Справка в меню Gnome, нажав спасателей значок на вашем рабочем столе, либо введя команду gnome-help в окне терминала. Системную документацию и man-страницы легче просматривать в простом интерфейсе.
Файловый менеджер nautilus обеспечивает поиск по индексу man- и info-страниц, они легко просматриваются и взаимосвязаны. Nautilus запускается из командной строки, или нажатием на значке вашего домашнего каталога, или из меню Gnome.
Большим преимуществом GUI для системной документации является то, что вся информация полностью взаимосвязана, так что вы можете переходить по ссылкам в разделе "SEE ALSO" ("См. также") и там, где появляются ссылки на другие man-страницы, и таким образом просматривать и приобретать знания без перерыва в течение нескольких часов.

Исключения

Некоторые команды не имеют отдельной документации, т.к. являются частью другой команды. cd, exit, logout и pwd как раз такие исключения. Они часть вашей программы shell и называются встроенными командами shell. Для получения информации о них обратитесь к man- или info-страницам вашей оболочки. Большинство начинающих пользователей Linux имеют Bash оболочку. См. Раздел "Shell" для дополнительной информации об оболочках.
Если вы изменяете первоначальную системную конфигурацию, то все равно еще может быть возможным, что man-страницы существуют, но не видны, т.к. окружение вашей оболочки изменилось. В этом случае вам нужно проверить переменную MANPATH. Как это сделать описано см. Раздел "Экспорт переменных".
Некоторые программы или пакеты содержат только набор инструкций или ссылки в каталог /usr/share/doc. Для их отображения см. Раздел "Другие способы просмотра содержимого".
В худшем случае, вы можете случайно удалить документы из системы (надеемся случайно, потому что это очень плохая идея делать это целенаправленно). В этом случае, попробуйте сначала убедиться, что там действительно нет ничего подходящего, используя инструмент поиска (прочитайте Раздел "Поиск файлов"). Если окажется именно так, то возможно, вам придется переустановить пакет, который содержит команду, к которой относится документация, см. Раздел "Установка нового ПО".