Kommandoen Mann på Linux er innebygd i muskelminnet til hver Linux-utvikler og -bruker. Den brukes av bokstavelig talt alle; fra amatører og nybegynnere til Linux-fagfolk og eksperter.
Den brukes til å lese kommandolinjemanualsiden for en Linux-kommando, konfigurasjonsfil eller en hvilken som helst annen funksjon. Manuelle sider installeres vanligvis sammen med installasjon av programvare i Linux. Det er en definert syntaks for manuelle sider, som analyseres av kommandoen.
La oss lage en man-side for følgende bash-skript jeg har skrevet:
#!/bin/bash if [ "$1" == "h" ]; ekko deretter "Hei" fi if [ "$1" = "b" ]; deretter ekko "Bye" fiDette skriptet gjør bare to ting: Det skriver ut "Hei" hvis alternativet "h" er spesifisert som argument, og det skriver ut "Bye" hvis alternativet "b" er spesifisert som argument.
La oss lage en man-side for dette programmet. Bruk vim eller et hvilket som helst redigeringsprogram for å lage en tekstfil.
vim test.1Utvidelsen '.1' betyr at denne man-siden er for en kjørbar kommando. Det er ikke en tvang, men snarere en mye fulgt konvensjon mens du skriver man-sider. Manualsiden for mann (mann mann !) viser kategoriene:
1 Kjørbare programmer eller skallkommandoer 2 Systemanrop (funksjoner levert av kjernen) 3 Bibliotekkall (funksjoner i programbiblioteker) 4 Spesialfiler (finnes vanligvis i /dev) 5 Filformater og konvensjoner f.eks. /etc/passwd 6 Spill 7 Diverse ( inkludert makropakker og konvensjoner), f.eks man(7), groff(7) 8 systemadministrasjonskommandoer (vanligvis bare for root) 9 kjernerutiner [Ikke standard]En man-side opprettes ved å bruke det svært gamle markup-språket Roff. Den har kommandoer (lesemarkører) for ulike titler og seksjoner.
.TH– Dette skal være første kommando i man-filen. Den brukes til å spesifisere titteloverskriften til man-siden..SH– Seksjonsoverskrift..B– Den brukes til å vise teksten ved siden av med fet skrift..TP– Den brukes til å vise informasjon om et argument (flagg) til kommandoen..BR– Den brukes til å vise tekst med fet skrift og vanlig romersk skrift.
Følgende er man-siden for programmet mitt opprettet med bare de ovennevnte (enkle) roff-kommandoene.
.TH test.sh 1 .SH NAVN test.sh \- Skriv ut Hello or Bye .SH SYNOPSIS .B test.sh [h] [b] .SH BESKRIVELSE .B test.sh Dette er et eksempelskript som bare gjør 2 ting . Den skriver enten ut "Hallo" hvis argumentet er 'h' eller den skriver ut "Bye" hvis argumentet er 'b' .SH OPTIONS .TP .BR h Skriv ut Hei .TP .BR b Skriv ut HeiLagre filen ved først å trykke på ESC tast, og skriv deretter :wq for å lagre filen og gå ut av vim-konsollen.
Test man-siden vi nettopp opprettet ved å bruke kommandoen nedenfor:
mann ./test.1
For mer info om Mann bruk, løp man-sider kommandoen i terminalen din.
? Tips
Dette er den grunnleggende syntaksen for å skrive man-sider. For å gjøre ting enklere, kan du bruke verktøy som txt2man konvertere en fil i et eller annet merkespråkformat til roff-format.