Како направити страницу за Линук Ман

Команда човек на Линук-у је уграђен у мишићну меморију сваког Линук програмера и корисника. Користе га буквално сви; од програмера аматера и почетника до професионалаца и стручњака за Линук.

Користи се за читање странице приручника командне линије за Линук команду, конфигурациону датотеку или било коју другу функцију. Ручне странице се обично инсталирају заједно са инсталацијом софтвера у Линуку. Постоји дефинисана синтакса за ручне странице, која се рашчлањује наредбом.

Хајде да направимо ман страницу за следећу басх скрипту коју сам написао:

#!/бин/басх иф [ "$1" == "х" ]; затим ецхо "Здраво" фи иф [ "$1" = "б" ]; затим ехо "Збогом" фи

Ова скрипта ради само две ствари: штампа „Здраво“ ако је опција „х“ наведена као аргумент, и штампа „Ћао“ ако је опција „б“ наведена као аргумент.

Хајде да направимо ман страницу за овај програм. Користите вим или било који уређивач по вашем избору за креирање текстуалне датотеке.

вим тест.1

Екстензија „.1“ означава да је ова страница приручника за извршну команду. То није присила, већ широко прихваћена конвенција приликом писања ман страница. Страница приручника за човека (човек човек !) наводи категорије:

 1 Извршни програми или команде љуске 2 Системски позиви (функције које обезбеђује кернел) 3 Позиви библиотеке (функције унутар програмских библиотека) 4 Специјални фајлови (обично се налазе у /дев) 5 Формати датотека и конвенције, нпр. /етц/пассвд 6 Игре 7 Разно ( укључујући макро пакете и конвенције), нпр ман(7), грофф(7) 8 команди системске администрације (обично само за роот) 9 рутине кернела [нестандардне]

Ман страница је креирана користећи веома стари језик за означавање рофф. Има команде (ознаке за читање) за различите наслове и одељке.

  • .ТХ – Ово би требало да буде прва команда у ман фајлу. Користи се за одређивање наслова заглавља ман странице.
  • .СХ – Наслов одељка.
  • – Користи се за приказ текста поред њега подебљаним.
  • .ТП – Користи се за приказ информација о аргументу (заставици) команди.
  • .БР – Користи се за приказ текста подебљаним и нормалним римским фонтом.

Следи ман страница за мој програм креирана коришћењем само горњих (једноставних) команди рофф.

.ТХ тест.сх 1 .СХ НАЗИВ тест.сх \- Штампај Хелло ор Бие .СХ СИНОПСИС .Б тест.сх [ х ] [ б ] .СХ ОПИС .Б тест.сх Ово је пример скрипте која ради само 2 ствари . Штампа "Здраво" ако је аргумент "х" или штампа "Здраво" ако је аргумент 'б' .СХ ОПТИОНС .ТП .БР х Штампај Здраво .ТП .БР б Штампај ћао

Сачувајте датотеку првим притиском на ИЗАЋИ тастер, а затим откуцајте :вк да сачувате датотеку и изађете из вим конзоле.

Тестирајте ман страницу коју смо управо креирали користећи наредбу испод:

човек ./тест.1

За више информација о човек употреба, трчање ман-странице команду у вашем терминалу.

? Савет

Ово је основна синтакса за писање ман страница. Да бисте олакшали ствари, можете користити алате као што је ткт2ман да конвертујете датотеку у неком формату језика за означавање у формат рофф.