Kuidas luua Linuxi juhilehte

Käsk mees on Linux on põimitud iga Linuxi arendaja ja kasutaja lihasmällu. Seda kasutavad sõna otseses mõttes kõik; amatöör- ja algajatest arendajatest Linuxi professionaalide ja ekspertideni.

Seda kasutatakse Linuxi käsu, konfiguratsioonifaili või mõne muu funktsiooni käsurea käsiraamatu lugemiseks. Manuaalsed lehed installitakse tavaliselt Linuxis koos tarkvara installimisega. Käsitsi lehtede jaoks on määratletud süntaks, mis sõelutakse käsuga.

Loome man-lehe järgmise bash-skripti jaoks, mille olen kirjutanud:

#!/bin/bash if [ "$1" == "h" ]; siis kaja "Tere" fi if [ "$1" = "b" ]; siis kaja "Bye" fi

See skript teeb ainult kahte asja: see prindib "Tere", kui argumendiks on määratud valik "h", ja "Bye", kui argumendiks on määratud valik "b".

Loome selle programmi jaoks man-lehe. Kasuta vim või mõni teie valitud redaktor tekstifaili loomiseks.

vim test.1

Laiend ".1" tähendab, et see man-leht on käivitatava käsu jaoks. See ei ole sund, vaid pigem laialt järgitud konventsioon man-lehtede kirjutamisel. Manuali leht (mees mees !) loetleb kategooriad:

 1 Käivitavad programmid või shellikäsud 2 Süsteemikutsed (kerneli pakutavad funktsioonid) 3 Teegikutsed (funktsioonid programmiteekide sees) 4 Erifailid (tavaliselt /dev) 5 Failivormingud ja kokkulepped, nt /etc/passwd 6 Mängud 7 Mitmesugust ( sealhulgas makropaketid ja kokkulepped), nt man(7), groff(7) 8 Süsteemihalduskäsud (tavaliselt ainult root jaoks) 9 Kerneli rutiinid [mittestandardne]

Man-leht luuakse väga vana roffi märgistuskeele abil. Sellel on käsud (loe markereid) erinevate pealkirjade ja jaotiste jaoks.

  • .TH – See peaks olema esimene käsk man-failis. Seda kasutatakse man-lehe pealkirja pealkirja määramiseks.
  • .SH – jaotise pealkiri.
  • .B – Seda kasutatakse kõrvaloleva teksti paksus kirjas kuvamiseks.
  • .TP – Seda kasutatakse käsu argumendi (lipu) kohta teabe kuvamiseks.
  • .BR – Seda kasutatakse teksti kuvamiseks paksus kirjas ja tavalises ladina kirjas.

Järgmine on minu programmi man-leht, mis on loodud ainult ülaltoodud (lihtsate) roff-käskude abil.

.TH test.sh 1 .SH NIMI test.sh \- Prindi Tere või Hüvasti .SH SÜNOPSIS .B test.sh [ h ] [ b ] .SH KIRJELDUS .B test.sh See on näidisskript, mis teeb ainult 2 asja . See kas prindib "Tere", kui argument on "h" või "Bye", kui argument on "b" .SH OPTIONS .TP .BR h Trüki Tere .TP .BR b Trüki Hüvasti

Salvestage fail vajutades esmalt nuppu ESC klahvi ja seejärel tippige :wq faili salvestamiseks ja vim-konsoolist väljumiseks.

Testige äsja loodud man-lehte, kasutades allolevat käsku:

mees ./test.1

Lisateabe saamiseks mees kasutamine, jooksmine meeste man-lehed käsk terminalis.

? Näpunäide

See on man-lehtede kirjutamise põhisüntaks. Asjade lihtsustamiseks võite kasutada tööriistu, nagu txt2man, teisendada mõnes märgistuskeelevormingus faili roff-vormingusse.