Kommandot man på Linux är inbäddat i muskelminnet hos varje Linux-utvecklare och användare. Det används av bokstavligen alla; från amatörer och nybörjare till Linux-proffs och experter.
Den används för att läsa kommandoradens manualsida för ett Linux-kommando, konfigurationsfil eller någon annan funktion. Manuella sidor installeras vanligtvis tillsammans med installation av programvara i Linux. Det finns en definierad syntax för manuella sidor, som tolkas av kommandot.
Låt oss skapa en man-sida för följande bash-script som jag har skrivit:
#!/bin/bash if [ "$1" == "h" ]; upprepa sedan "Hej" fi if [ "$1" = "b" ]; eka sedan "Bye" fiDet här skriptet gör bara två saker: Det skriver ut "Hej" om alternativet "h" är angivet som argument, och det skriver ut "Bye" om alternativet "b" är angivet som argument.
Låt oss skapa en man-sida för detta program. Använda sig av vim eller valfri redigerare för att skapa en textfil.
vim test.1Tillägget '.1' betyder att denna man-sida är för ett körbart kommando. Det är inte ett tvång utan snarare en allmänt följd konvention när man skriver man-sidor. Manualsidan för man (man man !) listar kategorierna:
1 Körbara program eller skalkommandon 2 Systemanrop (funktioner som tillhandahålls av kärnan) 3 Biblioteksanrop (funktioner inom programbibliotek) 4 Specialfiler (finns vanligtvis i /dev) 5 Filformat och konventioner t.ex. /etc/passwd 6 Spel 7 Övrigt ( inklusive makropaket och konventioner), t.ex man(7), groff(7) 8 systemadministrationskommandon (vanligtvis endast för root) 9 kärnrutiner [icke standard]En man-sida skapas med det mycket gamla märkningsspråket Roff. Den har kommandon (läsmarkörer) för olika titlar och avsnitt.
.TH– Detta bör vara det första kommandot i man-filen. Den används för att ange titelrubrik för man-sidan..SH– Avsnittsrubrik..B– Den används för att visa texten bredvid den i fet stil..TP– Den används för att visa information om ett argument (flagga) till kommandot..BR– Den används för att visa text i fetstil och med det normala romerska teckensnittet.
Följande är mansidan för mitt program skapad med endast ovanstående (enkla) roff-kommandon.
.TH test.sh 1 .SH NAMN test.sh \- Skriv ut Hej eller hej .SH SYNOPSIS .B test.sh [h] [b] .SH BESKRIVNING .B test.sh Detta är ett exempelskript som bara gör 2 saker . Den skriver antingen ut "Hej" om argumentet är 'h' eller så skrivs det ut "Bye" om argumentet är 'b' .SH ALTERNATIV .TP .BR h Skriv ut Hej .TP .BR b Skriv ut HejdåSpara filen genom att först trycka på ESC tangent och skriv sedan :wq för att spara filen och avsluta vim-konsolen.
Testa mansidan vi just skapade med kommandot nedan:
man ./test.1
För mer info om man användning, kör man-sidor kommandot i din terminal.
? Dricks
Detta är den grundläggande syntaxen för att skriva man-sidor. För att göra saker enklare kan du använda verktyg som txt2man konvertera en fil i något märkspråksformat till roff-format.