Hoe maak je een Linux Man-pagina aan

Het bevel Mens op Linux is ingebed in het spiergeheugen van elke Linux-ontwikkelaar en -gebruiker. Het wordt door letterlijk iedereen gebruikt; van amateur- en beginnende ontwikkelaars tot Linux-professionals en experts.

Het wordt gebruikt voor het lezen van de man-pagina van de opdrachtregel voor een Linux-opdracht, configuratiebestand of een andere functie. Handmatige pagina's worden meestal samen met de installatie van software in Linux geïnstalleerd. Er is een gedefinieerde syntaxis voor handmatige pagina's, die wordt geparseerd door de opdracht.

Laten we een man-pagina maken voor het volgende bash-script dat ik heb geschreven: 

#!/bin/bash if [ "$1" == "h"]; echo dan "Hallo" fi if [ "$1" = "b" ]; echo dan "Dag" fi

Dit script doet maar twee dingen: het drukt "Hallo" af als optie 'h' is opgegeven als argument, en het drukt "Dag" af als optie 'b' is opgegeven als argument.

Laten we een man-pagina maken voor dit programma. Gebruiken vim of een editor naar keuze om een ​​tekstbestand te maken.

vim-test.1

De extensie '.1' geeft aan dat deze man-pagina voor een uitvoerbaar commando is. Het is geen dwang, maar eerder een algemeen gevolgde conventie bij het schrijven van manpages. De handleiding voor de mens (man man !) geeft de categorieën weer:

 1 Uitvoerbare programma's of shell-commando's 2 Systeemaanroepen (functies geleverd door de kernel) 3 Bibliotheekaanroepen (functies binnen programmabibliotheken) 4 Speciale bestanden (meestal te vinden in /dev) 5 Bestandsformaten en conventies bijv. /etc/passwd 6 Games 7 Diversen ( inclusief macropakketten en conventies), bijv man(7), groff(7) 8 Systeembeheeropdrachten (meestal alleen voor root) 9 Kernelroutines [Niet standaard]

Een man-pagina wordt gemaakt met behulp van de zeer oude roff-opmaaktaal. Het heeft commando's (lees markeringen) voor verschillende titels en secties.

  • .E – Dit zou het eerste commando in het man-bestand moeten zijn. Het wordt gebruikt om de titelkop van de man-pagina te specificeren.
  • .SH - Sectiekop.
  • .B – Het wordt gebruikt om de tekst ernaast vetgedrukt weer te geven.
  • .TP – Het wordt gebruikt om informatie over een argument (vlag) voor de opdracht weer te geven.
  • .BR – Het wordt gebruikt om tekst vet en in het normale Romeinse lettertype weer te geven.

Hieronder volgt de man-pagina voor mijn programma gemaakt met alleen de bovenstaande (eenvoudige) roff-commando's.

.TH test.sh 1 .SH NAAM test.sh \- Print Hallo of doei .SH SYNOPSIS .B test.sh [h ] [b] .SH BESCHRIJVING .B test.sh Dit is een voorbeeldscript dat maar 2 dingen doet . Het drukt ofwel "Hallo" af als het argument 'h' is, of het drukt "Dag" af als het argument 'b' is .SH OPTIONS .TP .BR h Print Hallo .TP .BR b Print Tot ziens

Sla het bestand op door eerst op de te drukken ESC toets en typ vervolgens :wq om het bestand op te slaan en de vim-console af te sluiten.

Test de man-pagina die we zojuist hebben gemaakt met behulp van de onderstaande opdracht:

man ./test.1

Voor meer info over Mens gebruik, uitvoeren man man-pagina's commando in uw terminal.

? Tip

Dit is de basissyntaxis voor het schrijven van manpages. Om het u gemakkelijker te maken, kunt u tools zoals txt2man gebruiken om een ​​bestand in een of andere opmaaktaalindeling naar roff-indeling te converteren.