Команда чоловік на Linux вбудована в м’язову пам’ять кожного розробника та користувача Linux. Ним користуються буквально всі; від аматорів і початківців розробників до професіоналів і експертів Linux.
Він використовується для читання сторінки керівництва командного рядка для команди Linux, файлу конфігурації або будь-якої іншої функції. Ручні сторінки зазвичай встановлюються разом із встановленням програмного забезпечення в Linux. Існує визначений синтаксис для сторінок посібника, який аналізується командою.
Давайте створимо сторінку man для наступного сценарію bash, який я написав:
#!/bin/bash if [ "$1" == "h" ]; потім echo "Hello" fi if [ "$1" = "b" ]; потім луна "До побачення" fiЦей сценарій виконує лише дві речі: він друкує «Hello», якщо параметр «h» вказано як аргумент, і друкує «Bye», якщо параметр «b» вказано як аргумент.
Давайте створимо сторінку керівництва для цієї програми. Використовуйте vim або будь-який редактор на ваш вибір, щоб створити текстовий файл.
vim тест.1Розширення «.1» означає, що ця сторінка керівництва призначена для виконуваної команди. Це не примус, а скоріше загальноприйнята конвенція під час написання сторінок керівництва. Сторінка посібника для людини (людина людина !) перелічує категорії:
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 NAME test.sh \- Друк Hello or 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Збережіть файл спочатку натиснувши кнопку ВИХІД ключ, а потім введіть :wq щоб зберегти файл і вийти з консолі vim.
Перевірте сторінку керівництва, яку ми щойно створили, використовуючи команду нижче:
людина ./тест.1
Для отримання додаткової інформації про чоловік використання, запуск man-сторінки команду у вашому терміналі.
? Порада
Це основний синтаксис для написання man-сторінок. Щоб полегшити роботу, ви можете використовувати такі інструменти, як txt2man, щоб конвертувати файл у форматі мови розмітки у формат roff.