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