Автор - Лукас Вестерман (Lucas Westermann)
Читатели часто просят меня, чтобы я рассказал об основной структуре страниц помощи или, как их ещё называют, man-страниц (англ. manual). В этой статье я попробую рассказать о man-страницах такой команды, как 'ping'. Команда:
ping -h
выведет помощь по команде ping (аргумент -h, наравне с –help, де факто используются для получения помощи по любой команде). Выданная информация будет выглядеть примерно так, как показано на рисунке справа.
Значения в первых квадратных скобках «-LRUbdfnqrvVaA» — это список возможных ключей, которым не требуются аргументы (в основном они предназначены для изменения вида вывода информации) и для их объяснения потребуется пролистать страницу помощи. Следующие значения в квадратных скобках, которые выглядят как ключ и некоторая комбинация (например, -c количество), требуют чтобы вы подставили некоторое верное значение после ключа. Выделенные слова помогут вам определить, что же выполняет та или иная команда.
В идеале страница помощи должна представлять из себя краткий справочник, на случай если вы не уверены, за что отвечает тот или иной ключ команды. Но если вы впервые столкнулись с командой и не знаете, что выполняет даже и половина ключей, лучшим вариантом будет прочитать всю страницу помощи от и до, так как в ней вы найдёте все необходимые сведения и о назначении ключей, и о примерах применения, и о полезных сайтах и т.д. Многие страницы содержат подобную информацию, но, к сожалению, не все.
Чтобы просмотреть страницу помощи, введите команду:
man ping
Раздел Краткой Информации напоминает вывод команды –help, но здесь за ним следует раздел описания, в котором указано, каким образом следует использовать команду и для чего она вообще предназначена. В разделе Опций перечислен полный список аргументов команды и их краткое описание. Для навигации по документу используйте стрелки вверх/вниз или клавиши PgUp/PgDown. Самая нижняя строчка на каждой странице выглядит так: «Страница помощи ping(8) строка 21/356 15%». В ней указано, что вы просматриваете страницу помощи по команде ping, находитесь на 21 строке из 356, что равно 15% от всего документа. Дальше по документу вы должны будете увидеть раздел «Подробности ICMP пакета», название раздела говорит само за себя. Кроме этого вы встретите ещё несколько разделов, пока не достигнете раздела об ошибках, описывать их нет нужды, так как вся информация подробно изложена в них самих. Перечисленные в соответствующем разделе ошибки являются открытыми (то есть являются известными ошибками в приложении, которые пока ещё не исправлены), а в разделе «Смотрите также» вам будут предложены несколько команд, которые могут быть полезны в использовании с данной командой. В разделе История, как ни странно, описывается история появления команды, а в заключительных разделах Безопасность и Доступность вы найдёте ещё немного полезной информации.
Не все страницы помощи выглядят подобным образом, но все они должны отвечать следующим условиям:
- Название
- Краткая информация
- Описание
- Опции
- Полезная информация относящаяся к команде (определения, объяснения и т.д.)
- Ошибки
- Смотрите также
- История
- Безопасность (если применяется)
- Доступность
Это может быть полезным, если вы хотели бы найти информацию по определённому значению, и теперь вы точно знаете, где его искать. А если вы пишете собственную утилиту или же хотите добавить страницу помощи в ваш скрипт, то это поможет вам правильно составить её. Надеюсь, что эта статья помогла вам лучше понять, как работают страницы помощи и научила вас разбираться в часто запутанных файлах справки.
