[Guida] Man pages, la struttura e come usarle al meglio

Nelle precedenti guide, vi ho spesso suggerito di dare uno sguardo anche alle man pages. man è un comando dei sistemi operativi Unix e Unix-like che consente di accedere alle pagine del manuale il quale offre un’ampia documentazion. Torna utile, ad esempio, per consultare tutte le opzioni disponibili nella creazione di un volume logico. Oppure se vogliamo scoprire funzionalità aggiuntive di logrotate. In questa mini-guida andremo a scoprire come utilizzare proprio il comando per accedere alle pagine del manuale, in ambito sysadmin GNU/Linux o BSD.

Man pages, come accedervi in maniera efficiente

Iniziamo con il capire la struttura del manuale stesso. Una sua buona comprensione ci permette di aumentare la nostra efficienza nel suo utilizzo. L’insieme delle pagine del manuale è raggruppato in varie sezioni numerate. Per un sistema GNU/Linux o FreeBSD, possiamo riferirci al seguente schema:

General Commands Manual
System Calls Manual
Library Functions Manual
Kernel Interfaces Manual
File Formats Manual
Games Manual
Miscellaneous Information Manual
System Manager’s Manual
Kernel Developer’s Manual

Apriamo il terminale e digitiamo nel terminale l’istruzione man -k systemd. Possiamo notare che ogni risultato conterrà il riferimento al numero di sezione. Ad esempio man systemd-shutdown aprirà una pagina appartenente alla sezione sysadmin. Ogni singola pagina del manuale, relativa quindi ad un comando specifico, ha a sua volta una struttura complessa. Il layout tipico è il seguente:

NAME, il nome del comando seguito dalla sua descrizione in breve;
SYNOPSIS – ossia la sintassi dell’istruzione;
DESCRIPTION – una descrizione testuale del funzionamento del comando o della funzione;
EXAMPLES;
SEE ALSO – altri comandi o funzioni correlate.

Per navigare all’interno di ciascuna pagina si possono utilizzare i tasti j e k, che consentono di avanzare o indietreggiare di una linea per volta. Per muoverci di una schermata, invece, i tasti da usare sono f e b. Il tasto q servirà ad uscire. In una qualsiasi schermata del manuale h richiamerà l’elenco completo delle macro per scorrere le varie pagine. Fondamentale anche il tasto /. Se ad esempio non ricordiamo una particolare opzione di un comando per sysadmin, premendo / apparirà una stringa di ricerca.Con n ci si può poi spostare tra le varie corrispondenze.

Le istruzioni utili da ricordare

Vediamo adesso quali sono i set di istruzioni più utili, che permettono al sysadmin di ottimizzare l’utilizzo delle man pages.

man -f stringa, cerca le pagine di manuale indicate da espressione e mostra una breve descrizione di tutte quelle trovate;
man -k stringa, cerca la parola chiave stringa nelle descrizioni brevi e nei nomi delle pagine considerandola una espressione regolare. Questa istruzione, in pipeline con il programma grep, risulta molto utile. Quando ad esempio non ricordiamo un particolare comando, ma sappiamo descriverlo. Proviamo man -k partition | grep “manipulate” ad esempio;
man comando | grep -e “-opzione” per trovare la descrizione di una specifica opzione relativa ad un comando, senza aprirne il manuale. Ad esempio man ls | grep -e ‘-a’;
man numero_sezione comando, per navigare in una specifica sezione di una pagina. Ad esempio, dando da terminale man -f uname, notiamo che esistono due sezioni, la generale e la systemcall. Per andare visualizzare la seconda basterà utilizzare la sintassi man 2 uname.

Per maggiori dettagli, ancora una volta vi rimando alla pagina del manuale, man man.

Seguiteci sul nostro canale Telegram, sulla nostra pagina Facebook e su Google News. Nel campo qui sotto è possibile commentare e creare spunti di discussione inerenti le tematiche trattate sul blog.