Jak vytvořit stránku Linux Man

Příkaz muž na Linuxu je zasazen do svalové paměti každého vývojáře a uživatele Linuxu. Používá ho doslova každý; od amatérských a začínajících vývojářů až po linuxové profesionály a experty.

Používá se pro čtení manuálové stránky příkazového řádku pro příkaz Linux, konfigurační soubor nebo jakoukoli jinou funkci. Manuálové stránky se obvykle instalují spolu s instalací softwaru v Linuxu. Existuje definovaná syntaxe pro manuální stránky, která je analyzována příkazem.

Vytvořme manuálovou stránku pro následující bash skript, který jsem napsal: 

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

Tento skript dělá pouze dvě věci: Vypíše „Ahoj“, pokud je jako argument uvedena možnost „h“, a vypíše „Sbohem“, pokud je jako argument uvedena možnost „b“.

Vytvořme manuálovou stránku pro tento program. Použití vim nebo libovolný editor podle vašeho výběru pro vytvoření textového souboru.

vim test.1

Přípona „.1“ znamená, že tato manuálová stránka je pro spustitelný příkaz. Není to nutkání, ale spíše široce dodržovaná konvence při psaní manuálových stránek. Manuálová stránka pro muže (muž muž !) uvádí kategorie:

 1 Spustitelné programy nebo příkazy shellu 2 Systémová volání (funkce poskytované jádrem) 3 Volání knihovny (funkce v knihovnách programů) 4 Speciální soubory (obvykle se nacházejí v /dev) 5 Formáty souborů a konvence, např. /etc/passwd 6 Hry 7 Různé ( včetně makro balíčků a konvencí), např man(7), groff(7) 8 Příkazy pro správu systému (obvykle pouze pro uživatele root) 9 Rutiny jádra [Nestandardní]

Manová stránka je vytvořena pomocí velmi starého značkovacího jazyka roff. Obsahuje příkazy (přečtení značek) pro různé tituly a sekce.

  • .TH – Toto by měl být první příkaz v man souboru. Používá se k určení nadpisu nadpisu manuálové stránky.
  • .SH – Nadpis sekce.
  • .B – Používá se k zobrazení textu vedle něj tučně.
  • .TP – Používá se k zobrazení informací o argumentu (příznaku) příkazu.
  • .BR – Používá se k zobrazení textu tučně a normálním písmem Roman.

Následuje manuálová stránka pro můj program vytvořená pouze pomocí výše uvedených (jednoduchých) příkazů roff.

.TH test.sh 1 .SH JMÉNO test.sh \- Tisk Hello or Bye .SH SYNOPSE .B test.sh [ h ] [ b ] .SH POPIS .B test.sh Toto je ukázkový skript, který dělá pouze 2 věci . Buď vypíše "Ahoj", pokud je argument 'h', nebo vypíše "Ahoj", pokud je argument 'b' .SH OPTIONS .TP .BR h Tisk Ahoj .TP .BR b Tisk Nashledanou

Uložte soubor nejprve stisknutím tlačítka ESC a poté zadejte :wq uložte soubor a ukončete konzolu vim.

Otestujte manuálovou stránku, kterou jsme právě vytvořili, pomocí příkazu níže:

muž ./test.1

Pro více informací na muž použití, spustit manové stránky příkaz ve vašem terminálu.

? Spropitné

Toto je základní syntaxe pro psaní manuálových stránek. Chcete-li věci usnadnit, můžete použít nástroje jako txt2man pro převod souboru v nějakém formátu značkovacího jazyka na formát roff.