Kako stvoriti stranicu za Linux Man

Zapovijed čovjek na Linuxu je ugrađen u mišićnu memoriju svakog Linux programera i korisnika. Koriste ga doslovno svi; od programera amatera i početnika do profesionalaca i stručnjaka za Linux.

Koristi se za čitanje stranice priručnika naredbenog retka za Linux naredbu, konfiguracijsku datoteku ili bilo koju drugu značajku. Ručne stranice obično se instaliraju zajedno s instalacijom softvera u Linuxu. Postoji definirana sintaksa za ručne stranice, koja se analizira naredbom.

Napravimo man stranicu za sljedeću bash skriptu koju sam napisao: 

#!/bin/bash if [ "$1" == "h" ]; zatim echo "Halo" fi if [ "$1" = "b" ]; zatim eho "Zbogom" fi

Ova skripta radi samo dvije stvari: ispisuje "Hello" ako je opcija "h" navedena kao argument, i ispisuje "Bye" ako je opcija "b" navedena kao argument.

Napravimo man stranicu za ovaj program. Koristiti vim ili bilo koji uređivač po vašem izboru za stvaranje tekstualne datoteke.

vim test.1

Proširenje '.1' označava da je ova stranica priručnika za izvršnu naredbu. To nije prisila, već široko prihvaćena konvencija tijekom pisanja man stranica. Stranica priručnika za čovjeka (čovjek čovjek !) navodi kategorije:

 1 Izvršni programi ili naredbe ljuske 2 Sistemski pozivi (funkcije koje pruža kernel) 3 Pozivi knjižnice (funkcije unutar programskih knjižnica) 4 Posebne datoteke (obično se nalaze u /dev) 5 Formati datoteka i konvencije npr. /etc/passwd 6 Igre 7 Razno ( uključujući makro pakete i konvencije), npr man(7), groff(7) 8 naredbi administracije sustava (obično samo za root) 9 rutine kernela [nestandardne]

Man stranica je stvorena korištenjem vrlo starog jezika za označavanje roff. Ima naredbe (oznake za čitanje) za različite naslove i odjeljke.

  • .TH – Ovo bi trebala biti prva naredba u man datoteci. Koristi se za određivanje naslova naslova man stranice.
  • .SH – Naslov odjeljka.
  • .B – Koristi se za prikaz teksta pored njega podebljanim.
  • .TP – Koristi se za prikaz informacija o argumentu (zastavici) naredbe.
  • .BR – Koristi se za prikaz teksta podebljanim i normalnim rimskim fontom.

Slijedi man stranica za moj program kreirana korištenjem samo gornjih (jednostavnih) roff naredbi.

.TH test.sh 1 .SH NAZIV test.sh \- Ispis Hello or Bye .SH SINOPSIS .B test.sh [ h ] [ b ] .SH OPIS .B test.sh Ovo je primjer skripte koja radi samo 2 stvari . Ili ispisuje "Hello" ako je argument 'h' ili ispisuje "Bye" ako je argument 'b' .SH OPTIONS .TP .BR h Ispis Hello .TP .BR b Ispis bok

Spremite datoteku prvim pritiskom na ESC tipku, a zatim upišite :wq za spremanje datoteke i izlaz iz vim konzole.

Testirajte man stranicu koju smo upravo kreirali pomoću naredbe u nastavku:

čovjek ./test.1

Za više informacija o čovjek korištenje, trčanje man-stranice naredbu u vašem terminalu.

? Savjet

Ovo je osnovna sintaksa za pisanje man stranica. Da biste olakšali stvari, možete koristiti alate kao što je txt2man za pretvaranje datoteke u nekom formatu jezika za označavanje u format roff.