Com crear una pàgina man de Linux

La comanda home a Linux està incrustat a la memòria muscular de cada desenvolupador i usuari de Linux. És utilitzat literalment per tothom; des de desenvolupadors aficionats i novells fins a professionals i experts de Linux.

S'utilitza per llegir la pàgina del manual de la línia d'ordres d'una ordre de Linux, un fitxer de configuració o qualsevol altra característica. Les pàgines manuals solen instal·lar-se juntament amb la instal·lació d'un programari a Linux. Hi ha una sintaxi definida per a les pàgines de manual, que s'analitza mitjançant l'ordre.

Creem una pàgina de manual per al següent script bash que he escrit: 

#!/bin/bash if [ "$1" == "h" ]; llavors echo "Hola" fi if [ "$1" = "b" ]; a continuació, ressò "Adéu" fi

Aquest script només fa dues coses: imprimeix "Hola" si s'especifica l'opció "h" com a argument, i imprimeix "Adéu" si s'especifica l'opció "b" com a argument.

Creem una pàgina de manual per a aquest programa. Ús vim o qualsevol editor de la vostra elecció per crear un fitxer de text.

prova vim.1

L'extensió '.1' significa que aquesta pàgina de manual és per a una ordre executable. No és una compulsió, sinó una convenció àmpliament seguida mentre escriu pàgines de manual. La pàgina de manual per a l'home (home home !) enumera les categories:

 ( incloent paquets de macros i convencions), p man(7), groff(7) 8 Ordres d'administració del sistema (normalment només per a root) 9 Rutines del nucli [No estàndard]

Es crea una pàgina de manual utilitzant el llenguatge de marques roff molt antic. Té ordres (marcadors de lectura) per a diversos títols i seccions.

  • .TH – Aquesta hauria de ser la primera ordre del fitxer man. S'utilitza per especificar l'encapçalament del títol de la pàgina de manual.
  • .SH – Encapçalament de la secció.
  • .B – S'utilitza per mostrar el text al costat en negreta.
  • .TP – S'utilitza per mostrar informació sobre un argument (marcador) a l'ordre.
  • .BR – S'utilitza per mostrar text en negreta i amb la lletra romana normal.

A continuació es mostra la pàgina de manual del meu programa creada utilitzant només les ordres roff anteriors (simples).

.TH test.sh 1 .SH NOM test.sh \- Imprimeix Hola o adéu .SH SINOPSI .B test.sh [ h ] [ b ] .SH DESCRIPCIÓ .B test.sh Aquest és un script de mostra que només fa 2 coses . Imprimeix "Hola" si l'argument és "h" o imprimeix "Adéu" si l'argument és "b". OPCIONS .SH .TP .BR h Imprimeix hola .TP .BR b Imprimeix adéu

Desa el fitxer prement primer ESC tecla i, a continuació, escriviu :wq per desar el fitxer i sortir de la consola vim.

Proveu la pàgina de manual que acabem de crear amb l'ordre següent:

home ./prova.1

Per a més informació sobre home ús, córrer pàgines man-man comanda al vostre terminal.

? Consell

Aquesta és la sintaxi bàsica per escriure pàgines man. Per facilitar-vos les coses, podeu utilitzar eines com txt2man per convertir un fitxer en algun format de llenguatge de marques en format roff.