Команда человек в Linux встроена в мышечную память каждого разработчика и пользователя Linux. Его используют буквально все; от любителей и начинающих разработчиков до профессионалов и экспертов по Linux.
Он используется для чтения страницы руководства командной строки для команды Linux, файла конфигурации или любой другой функции. Страницы руководства обычно устанавливаются вместе с установкой программного обеспечения в Linux. Для справочных страниц существует определенный синтаксис, который анализируется командой.
Давайте создадим страницу руководства для следующего сценария bash, который я написал:
#! / bin / bash если ["$ 1" == "h"]; затем echo "Hello" fi if ["$ 1" = "b"]; затем повторить эхо "Пока" фиЭтот сценарий делает только две вещи: он печатает «Hello», если в качестве аргумента указан параметр «h», и печатает «Bye», если в качестве аргумента указан параметр «b».
Давайте создадим справочную страницу для этой программы. Использовать vim или любой редактор по вашему выбору для создания текстового файла.
vim test.1Расширение «.1» означает, что эта страница руководства предназначена для исполняемой команды. Это не принуждение, а, скорее, общепринятое соглашение при написании страниц руководства. Справочная страница для man (мужчина мужчина !) перечислены категории:
1 Исполняемые программы или команды оболочки 2 Системные вызовы (функции, предоставляемые ядром) 3 Вызовы библиотек (функции в библиотеках программ) 4 Специальные файлы (обычно находятся в / dev) 5 Форматы файлов и соглашения, например / etc / passwd 6 Игры 7 Разное ( включая пакеты макросов и соглашения), например man (7), groff (7) 8 Команды системного администрирования (обычно только для root) 9 Подпрограммы ядра [нестандартные]Страница руководства создается с использованием очень старого языка разметки roff. В нем есть команды (маркеры чтения) для различных заголовков и разделов.
.TH- Это должна быть первая команда в файле man. Он используется для указания заголовка заголовка страницы руководства..SH- Заголовок раздела..B- Используется для отображения текста рядом с ним жирным шрифтом..TP- Используется для отображения информации об аргументе (флаге) команды..BR- Используется для отображения текста полужирным шрифтом и обычным римским шрифтом.
Ниже приведена страница руководства для моей программы, созданная с использованием только указанных выше (простых) команд roff.
.TH test.sh 1 .SH ИМЯ test.sh \ - Распечатать Hello или Bye .SH СИНОПСИС .B test.sh [h] [b] .SH ОПИСАНИЕ .B test.sh Это пример сценария, который выполняет только 2 функции . Он либо печатает «Hello», если аргумент «h», либо «Bye», если аргумент равен «b» .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print ByeСохраните файл сначала нажав кнопку ESC ключ, а затем введите : wq чтобы сохранить файл и выйти из консоли vim.
Протестируйте только что созданную страницу руководства, используя следующую команду:
человек ./test.1
Для получения дополнительной информации о человек использование, запуск man-страницы в вашем терминале.
? Подсказка
Это основной синтаксис для написания страниц руководства. Чтобы упростить задачу, вы можете использовать такие инструменты, как txt2man, для преобразования файла в формате некоторого языка разметки в формат roff.