Sådan opretter du en Linux Man Page

Kommandoen mand på Linux er indlejret i muskelhukommelsen hos enhver Linux-udvikler og -bruger. Det bruges af bogstaveligt talt alle; fra amatører og nybegyndere til Linux-professionelle og eksperter.

Det bruges til at læse kommandolinjens manualside for en Linux-kommando, konfigurationsfil eller enhver anden funktion. Manuelle sider installeres normalt sammen med installation af en software i Linux. Der er en defineret syntaks for manuelle sider, som parses af kommandoen.

Lad os oprette en man-side til følgende bash-script, jeg har skrevet:

#!/bin/bash if [ "$1" == "h" ]; derefter ekko "Hej" fi if [ "$1" = "b" ]; derefter ekko "Bye" fi

Dette script gør kun to ting: Det udskriver "Hej", hvis mulighed 'h' er angivet som argument, og det udskriver "Bye", hvis mulighed 'b' er angivet som argument.

Lad os oprette en man-side til dette program. Brug vim eller en hvilken som helst editor efter eget valg for at oprette en tekstfil.

vim test.1

Udvidelsen '.1' betyder, at denne man-side er til en eksekverbar kommando. Det er ikke en tvang, men snarere en almindeligt fulgt konvention, mens man skriver man-sider. Manualsiden for mand (mand mand !) viser kategorierne:

 1 Eksekverbare programmer eller shell-kommandoer 2 Systemkald (funktioner leveret af kernen) 3 Bibliotekkald (funktioner i programbiblioteker) 4 Specialfiler (findes normalt i /dev) 5 Filformater og konventioner f.eks. /etc/passwd 6 Spil 7 Diverse ( inklusive makropakker og konventioner), f.eks man(7), groff(7) 8 Systemadministrationskommandoer (normalt kun for root) 9 Kernelrutiner [Ikke standard]

En man-side oprettes ved at bruge det meget gamle roff markup-sprog. Den har kommandoer (læsemarkører) til forskellige titler og sektioner.

  • .TH – Dette bør være den første kommando i man-filen. Det bruges til at angive overskriften på man-siden.
  • .SH – Afsnitsoverskrift.
  • .B – Det bruges til at vise teksten ved siden af ​​med fed skrift.
  • .TP – Det bruges til at vise information om et argument (flag) til kommandoen.
  • .BR – Det bruges til at vise tekst med fed skrift og med normal romersk skrift.

Følgende er man-siden til mit program oprettet ved kun at bruge ovenstående (simple) roff-kommandoer.

.TH test.sh 1 .SH NAVN test.sh \- Udskriv Hej eller Hej .SH SYNOPSIS .B test.sh [h] [b] .SH BESKRIVELSE .B test.sh Dette er et eksempelscript, der kun gør 2 ting . Den udskriver enten "Hej", hvis argumentet er 'h', eller den udskriver "Bye", hvis argumentet er 'b' .SH OPTIONS .TP .BR h Udskriv Hej .TP .BR b Udskriv Hej

Gem filen ved først at trykke på ESC tast, og skriv derefter :wq for at gemme filen og afslutte vim-konsollen.

Test man-siden, vi lige har oprettet ved hjælp af kommandoen nedenfor:

mand ./test.1

For mere info vedr mand brug, løb man-sider kommando i din terminal.

? Tip

Dette er den grundlæggende syntaks til at skrive man-sider. For at gøre tingene lettere, kan du bruge værktøjer som txt2man konvertere en fil i et eller andet markup-sprogformat til roff-format.