A parancs Férfi
a Linuxon minden Linux-fejlesztő és -felhasználó izommemóriájába ágyazva. Szó szerint mindenki használja; az amatőr és kezdő fejlesztőktől a Linux szakemberekig és szakértőkig.
Linux-parancsok, konfigurációs fájlok vagy bármely más szolgáltatás parancssori kézikönyvének olvasására szolgál. A kézikönyv oldalait általában a szoftver telepítésével együtt telepítik Linux alatt. A kézi oldalaknak van egy meghatározott szintaxisa, amelyet a parancs értelmez.
Hozzunk létre egy man oldalt az általam írt következő bash szkripthez:
#!/bin/bash if [ "$1" == "h" ]; then echo "Hello" fi if [ "$1" = "b" ]; majd echo "Bye" fi
Ez a szkript csak két dolgot végez: „Hello”-t ír ki, ha a „h” opció argumentumként van megadva, és a „Bye”-t írja ki, ha a „b” opció argumentumként van megadva.
Hozzunk létre egy man oldalt ehhez a programhoz. Használat vim
vagy bármely választott szerkesztővel szöveges fájl létrehozásához.
vim teszt.1
A „.1” kiterjesztés azt jelzi, hogy ez a kézikönyv egy végrehajtható parancsra vonatkozik. Ez nem kényszer, hanem egy széles körben követett konvenció a man oldalak írása során. A kézikönyv oldala a férfi számára (férfi ember
!) felsorolja a kategóriákat:
1 Futtatható programok vagy shell parancsok 2 Rendszerhívások (a kernel által biztosított funkciók) 3 Könyvtárhívások (a programkönyvtárak funkciói) 4 Speciális fájlok (általában a /dev fájlban találhatók) 5 Fájlformátumok és konvenciók pl. /etc/passwd 6 Játékok 7 Egyéb ( beleértve a makrócsomagokat és egyezményeket), pl man(7), groff(7) 8 Rendszeradminisztrációs parancsok (általában csak root számára) 9 Kernel rutinok [Nem szabványos]
Egy man oldal a nagyon régi roff jelölőnyelv használatával jön létre. Különféle címekhez és szakaszokhoz vannak parancsok (jelzők olvasása).
.TH
– Ez legyen az első parancs a man fájlban. A man oldal címsorának megadására szolgál..SH
– Szakaszcím..B
– A mellette lévő szöveg félkövérrel való megjelenítésére szolgál..TP
– A parancs argumentumával (jelzőjével) kapcsolatos információk megjelenítésére szolgál..BR
– A szöveg félkövérrel és normál római betűtípussal történő megjelenítésére szolgál.
Az alábbiakban a programom kézikönyve látható, amelyet csak a fenti (egyszerű) roff parancsokkal készítettem el.
.TH test.sh 1 .SH NÉV test.sh \- Nyomtatás Hello or Bye .SH SZINOPSZIS .B test.sh [ h ] [ b ] .SH LEÍRÁS .B test.sh Ez egy minta szkript, amely csak 2 dolgot tesz . Vagy a „Hello” szöveget írja ki, ha az argumentum „h”, vagy a „Bye” szöveget írja ki, ha az argumentum „b” .SH OPTIONS .TP .BR h Nyomtatás Hello .TP .BR b Nyomtatás Viszlát
Mentse el a fájlt a gomb első megnyomásával KILÉPÉS
gombot, majd írja be :wq
a fájl mentéséhez és a vim konzolból való kilépéshez.
Tesztelje az imént létrehozott man oldalt az alábbi paranccsal:
ember ./teszt.1
További információért Férfi
használat, futás férfi man-oldalak
parancsot a termináljában.
? Tipp
Ez a man oldalak írásának alapvető szintaxisa. A dolgok megkönnyítése érdekében használhat olyan eszközöket, mint például a txt2man, amely valamilyen jelölőnyelvi formátumú fájlt roff formátumba konvertál.