GNU/Linux >> Znalost Linux >  >> Linux

Jak přidat položky manuálové stránky pro vlastní elektrické nástroje?

Nemám ponětí o tom, jak mohu zpřístupnit své domácí specializované skripty (napsané většinou v Bash a Perlu) prostřednictvím man stránky.

Jaký postup bych musel dodržet a existuje nějaký konkrétní formát, ve kterém musí být dokumentace napsána, abych to mohl udělat?

Přijatá odpověď:

Zjistil jsem, že používání Perl's POD je mnohem jednodušší než přímé psaní manuálových stránek a ze souboru POD můžete vytvořit manuálovou stránku pomocí pod2man utilita (součást základního balíčku Perl). Vzhledem k tomu, že některé z vašich spustitelných souborů jsou již napsány v Perlu, můžete přidat formátování POD přímo do svých skriptů a lze je přímo převést na soubory POD. Také jsem viděl několik projektů používat formát POD, i když je jejich kód napsán v jiných jazycích, kvůli jednoduchosti POD.

Chcete-li přidat další adresář manuálových stránek, můžete nastavit $MANPATH proměnná prostředí. Předpona $MANPATH s : aby byl přidán do seznamu již nakonfigurovaných mužských cest. Použijte manpath příkaz k zobrazení aktuálně definovaných cest pro muže.


Linux
  1. Co znamenají čísla na mužské stránce?

  2. Proč stránka Apt-key Man nedoporučuje používat její příkaz Add?

  3. Jak nainstalovat R 3.3.1 do vlastního adresáře?

  1. 4 skenovací nástroje pro desktop Linux

  2. Jak přidat vlastní příponu souboru do PhotoRec pro obnovu dat?

  3. Jak přidat položku do databáze manuálových stránek Linuxu

  1. Jak přidat nový řádek na konec souboru?

  2. Jak zjistit, zda mužská stránka, na kterou se dívám, je ta správná?

  3. Jak mohu přidat zápatí na konec každé stránky postscriptového nebo pdf souboru v linuxu?