Articolo

Documentazione in Linux

In questo articolo parleremo della documentazione in linea tipica di un sistema Linux, ed in particolare:

Come trovare informazioni su vari argomenti nella documentazione in linea.
Come sono strutturati i files di documentazione.
Come si deve scrivere e strutturare la documentazione aggiuntiva.

Premessa

La disponibilità di documentazione in linea è fondamentale.

Eliminare dal disco i files di informazione e documentazione è il peggiore dei possibili modi per risparmiare spazio:

Vi fa perdere tempo.

Vi costringe a reinstallare i packages quando ne avete bisogno.

Vi può impedire di utilizzare parte delle risorse del sistema operativo.

Spesso è più utile disporre della documentazione senza il relativo programma che del programma privo di documentazione.

Documentazione in linea

Per "documentazione in linea" si intende tutte quelle informazioni disponibili sul disco del sistema ed accessibile mediante comandi di vario tipo.

La documentazione in linea ha numerosi vantaggi rispetto a quella cartacea:

Va sempre "insieme" al sistema su cui serve.

Si possono effettuare ricerche rapide.

È più facile da mantenere "allineata".

Ma ha anche alcuni svantaggi:

È complicata da leggere a letto.

È inutile per l'installazione del sistema o per risolvere i problemi più gravi.

Richiede un sistema con più finestre o "screens".

Uno dei punti di forza (e talvolta causa di confusione) in Linux è la gran mole di documentazione disponibile (e che è bene tenere in linea).

Formati di documentazione

Ci sono tre principali formati dei file di documentazione in linea su una installazione Linux di tipo standard:

man -- Il formato tradizionale di documentazione sui comandi e sui programmi in ambiente Unix (e di conseguenza Linux). È il più vecchio, ma ancora vivo e vegeto, dei sistemi di documentazione in linea. Niente di fantasioso, semplice ed efficace.

Texinfo -- Il formato ipertestuale adottato dal progetto gnu della "Free Software Foundation". È la "madre di tutti gli ipertesti". Nato ancora prima delle storie di Topolino con le variazioni a scelta del lettore, quando ancora i documenti si leggevano dall'inizio alla fine nell'unico ordine possibile.

Tutto il resto -- Readme, HTML, SGML, POD, etc. etc. Ogni progetto di largo respiro, direttamente orientato a Linux o no, ha adottato questo o quel particolare formato per la propria documentazione.
È la migliore conferma della verità del famoso detto di Leonardo da Vinci: "Per molto variar la natura è bella".

Clueless - Copertina - RPM