Ako vytvoriť Linux Man Page

Príkaz muž na Linuxe je vložený do svalovej pamäte každého vývojára a používateľa Linuxu. Používa ho doslova každý; od amatérskych a začínajúcich vývojárov až po linuxových profesionálov a expertov.

Používa sa na čítanie manuálovej stránky príkazového riadka pre príkaz Linux, konfiguračný súbor alebo akúkoľvek inú funkciu. Manuálne stránky sa zvyčajne inštalujú spolu s inštaláciou softvéru v systéme Linux. Pre manuálne stránky je definovaná syntax, ktorú príkaz analyzuje.

Poďme vytvoriť manuálovú stránku pre nasledujúci bash skript, ktorý som napísal: 

#!/bin/bash if [ "$1" == "h" ]; potom echo "Ahoj" fi if [ "$1" = "b" ]; potom echo "Ahoj" fi

Tento skript robí iba dve veci: Ak je ako argument zadaná možnosť „h“, vypíše „Ahoj“ a ak je ako argument zadaná možnosť „b“, vypíše „Ahoj“.

Vytvorme manuálovú stránku pre tento program. Použite vim alebo ľubovoľný editor podľa vášho výberu na vytvorenie textového súboru.

vim test.1

Prípona „.1“ znamená, že táto manuálová stránka je pre spustiteľný príkaz. Nie je to nutkanie, ale skôr široko dodržiavaná konvencia pri písaní manuálových stránok. Manuálna stránka pre človeka (muž muž !) uvádza kategórie:

 1 Spustiteľné programy alebo príkazy shellu 2 Systémové volania (funkcie poskytované jadrom) 3 Volania knižnice (funkcie v rámci programových knižníc) 4 Špeciálne súbory (zvyčajne sa nachádzajú v /dev) 5 Formáty súborov a konvencie, napr. /etc/passwd 6 Hry 7 Rôzne ( vrátane makro balíkov a konvencií), napr man(7), groff(7) 8 Príkazy na správu systému (zvyčajne iba pre root) 9 Rutiny jadra [Neštandardné]

Man stránka je vytvorená pomocou veľmi starého značkovacieho jazyka roff. Má príkazy (čítacie značky) pre rôzne tituly a sekcie.

  • .TH – Toto by mal byť prvý príkaz v súbore man. Používa sa na zadanie nadpisu nadpisu manuálovej stránky.
  • .SH – Nadpis sekcie.
  • .B – Používa sa na zobrazenie textu vedľa neho tučným písmom.
  • .TP – Používa sa na zobrazenie informácií o argumente (príznaku) príkazu.
  • .BR – Používa sa na zobrazenie textu tučným písmom a normálnym písmom Roman.

Nasleduje manuálová stránka môjho programu vytvorená iba pomocou vyššie uvedených (jednoduchých) príkazov roff.

.TH test.sh 1 .SH MENO test.sh \- Tlač Hello or Bye .SH SYNOPSA .B test.sh [ h ] [ b ] .SH POPIS .B test.sh Toto je vzorový skript, ktorý robí len 2 veci . Buď vypíše "Ahoj", ak je argument 'h', alebo vypíše "Ahoj", ak je argument 'b' .SH OPTIONS .TP .BR h Tlač Ahoj .TP .BR b Tlač Zbohom

Uložte súbor prvým stlačením tlačidla ESC a potom zadajte :wq uložte súbor a ukončite konzolu vim.

Otestujte manuálovú stránku, ktorú sme práve vytvorili, pomocou príkazu nižšie:

muž ./test.1

Pre viac info na muž použitie, spustiť manové stránky príkaz vo vašom termináli.

? Tip

Toto je základná syntax pre písanie manuálových stránok. Na uľahčenie môžete použiť nástroje ako txt2man na konverziu súboru v nejakom formáte značkovacieho jazyka na formát roff.