Kako ustvariti stran osebja za Linux

Ukaz človek na Linuxu je vgrajen v mišični pomnilnik vsakega razvijalca in uporabnika Linuxa. Uporabljajo ga dobesedno vsi; od amaterskih in začetnikov razvijalcev do strokovnjakov in strokovnjakov za Linux.

Uporablja se za branje strani priročnika ukazne vrstice za ukaz Linux, konfiguracijsko datoteko ali katero koli drugo funkcijo. Ročne strani so običajno nameščene skupaj z namestitvijo programske opreme v Linuxu. Za strani z navodili je definirana sintaksa, ki jo razčleni ukaz.

Ustvarimo stran man za naslednji skript bash, ki sem ga napisal: 

#!/bin/bash if [ "$1" == "h" ]; nato echo "Hello" fi if [ "$1" = "b" ]; nato odmeva "Adijo" fi

Ta skript naredi samo dve stvari: natisne »Pozdravljeni«, če je možnost »h« podana kot argument, in natisne »Adijo«, če je možnost »b« podana kot argument.

Ustvarimo stran man za ta program. Uporaba vim ali kateri koli urejevalnik po vaši izbiri, da ustvarite besedilno datoteko.

vim test.1

Razširitev '.1' pomeni, da je ta stran priročnika za izvedljiv ukaz. Ne gre za prisilo, ampak za splošno sprejeto konvencijo pri pisanju strani man. Stran priročnika za moškega (človek človek !) navaja kategorije:

 1 Izvedljivi programi ali ukazi lupine 2 Sistemski klici (funkcije, ki jih zagotavlja jedro) 3 Knjižnični klici (funkcije v programskih knjižnicah) 4 Posebne datoteke (običajno jih najdete v /dev) 5 Formati datotek in konvencije, npr. /etc/passwd 6 Igre 7 Razno ( vključno z makro paketi in konvencijami), npr man(7), groff(7) 8 ukazov sistemske administracije (običajno samo za root) 9 rutine jedra [nestandardne]

Stran man je ustvarjena z zelo starim označevalnim jezikom roff. Ima ukaze (oznake za branje) za različne naslove in razdelke.

  • .TH – To bi moral biti prvi ukaz v datoteki man. Uporablja se za določitev naslova naslova strani priročnika.
  • .SH – Naslov razdelka.
  • .B – Uporablja se za prikaz besedila poleg nje v krepkem tisku.
  • .TP – Uporablja se za prikaz informacij o argumentu (zastavici) ukaza.
  • .BR – Uporablja se za prikaz besedila v krepkem tisku in v običajni rimski pisavi.

Sledi priročnik za moj program, ustvarjen z uporabo samo zgornjih (preprostih) ukazov roff.

.TH test.sh 1 .SH IME test.sh \- Natisni Hello or Bye .SH SINOPSIS .B test.sh [ h ] [ b ] .SH OPIS .B test.sh To je vzorčni skript, ki naredi samo 2 stvari . Natisne "Hello", če je argument "h", ali pa natisne "Adijo", če je argument "b" .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

Shranite datoteko s prvim pritiskom na ESC tipko in nato vnesite :wq da shranite datoteko in zaprete konzolo vim.

Preizkusite stran man, ki smo jo pravkar ustvarili s spodnjim ukazom:

človek ./test.1

Za več informacij o človek uporaba, zagon man-strani ukaz v vašem terminalu.

? Nasvet

To je osnovna sintaksa za pisanje strani man. Da bi stvari olajšali, lahko uporabite orodja, kot je txt2man, da pretvorite datoteko v obliki nekega označevalnega jezika v obliko roff.