Come creare una pagina man di Linux

Il comando uomo su Linux è incorporato nella memoria muscolare di ogni sviluppatore e utente Linux. È usato letteralmente da tutti; da sviluppatori dilettanti e principianti a professionisti ed esperti di Linux.

Viene utilizzato per leggere la pagina del manuale della riga di comando per un comando Linux, un file di configurazione o qualsiasi altra funzionalità. Le pagine di manuale vengono solitamente installate insieme all'installazione di un software in Linux. Esiste una sintassi definita per le pagine di manuale, che viene analizzata dal comando.

Creiamo una pagina man per il seguente script bash che ho scritto:

#!/bin/bash if [ "$1" == "h" ]; then echo "Ciao" fi if [ "$1" = "b" ]; poi echo "Ciao" fi

Questo script fa solo due cose: stampa "Ciao" se l'opzione "h" è specificata come argomento e stampa "Ciao" se l'opzione "b" è specificata come argomento.

Creiamo una pagina man per questo programma. Uso vim o qualsiasi editor di tua scelta per creare un file di testo.

vim test.1

L'estensione '.1' significa che questa pagina man è per un comando eseguibile. Non è una costrizione, ma piuttosto una convenzione ampiamente seguita durante la scrittura delle pagine man. La pagina di manuale per man (uomo uomo !) elenca le categorie:

 1 Programmi eseguibili o comandi della shell 2 Chiamate di sistema (funzioni fornite dal kernel) 3 Chiamate di libreria (funzioni all'interno delle librerie di programma) 4 File speciali (di solito si trovano in /dev) 5 Formati di file e convenzioni es. /etc/passwd 6 Giochi 7 Varie ( inclusi pacchetti macro e convenzioni), ad es man(7), groff(7) 8 Comandi di amministrazione del sistema (di solito solo per root) 9 Routine del kernel [Non standard]

Viene creata una pagina man utilizzando il vecchio linguaggio di markup roff. Dispone di comandi (marcatori di lettura) per vari titoli e sezioni.

  • .TH – Questo dovrebbe essere il primo comando nel file man. Viene utilizzato per specificare l'intestazione del titolo della pagina man.
  • .SH – Titolo della sezione.
  • .B – Viene utilizzato per visualizzare il testo accanto in grassetto.
  • .TP – Viene utilizzato per visualizzare informazioni su un argomento (flag) per il comando.
  • .BR – Viene utilizzato per visualizzare il testo in grassetto e nel normale carattere romano.

Di seguito è riportata la pagina man per il mio programma creato utilizzando solo i comandi roff sopra (semplici).

.TH test.sh 1 .SH NOME test.sh \- Stampa Ciao o ciao .SH SINOSSI .B test.sh [ h ] [ b ] .SH DESCRIZIONE .B test.sh Questo è uno script di esempio che fa solo 2 cose . Stampa "Ciao" se l'argomento è 'h' o stampa "Ciao" se l'argomento è 'b' .SH OPZIONI .TP .BR h Stampa Ciao .TP .BR b Stampa Ciao

Salva il file premendo prima il tasto ESC chiave, quindi digitare :wq per salvare il file ed uscire dalla console vim.

Testa la pagina man che abbiamo appena creato usando il comando seguente:

uomo ./test.1

Per maggiori info su uomo utilizzo, esecuzione man pagine man comando nel tuo terminale.

? Consiglio

Questa è la sintassi di base per scrivere pagine man. Per semplificare le cose, puoi usare strumenti come txt2man per convertire un file in un formato di linguaggio di markup in formato roff.