1.1. Individuare la documentazione elettronica

Dopo l'installazione di una distribuzione Linux, nell'hard disk del proprio calcolatore, insieme a una quantità di applicazioni di ogni genere, si avranno una relativa serie di documenti, in formati diversi, dietro alcune directory di /usr, cioè la zona, partendo dalla radice del filesystem (il segno / iniziante un percorso vale come radice, il punto di partenza, altrimenti delimita le directory), che contiene materiale per gli utenti (users) del calcolatore.

I nomi delle directory standard in cui viene introdotta documentazione in un sistema operativo del tipo Unix sono questi: doc, info, man. Queste directory si possono trovare subito dopo /usr, dopo /usr/X11R6 compiendo una separazione dalla documentazione per i programmi X-Window (una soluzione grafica comune fra gli Unix), comunemente in /usr/share, luogo adibito ai dati non dipendenti dall'architettura, dove può presentarsi subito una ramificazione per nomi dei programmi, insieme alle altre tre directory.

Vanno citate anche i percorsi /usr/local (dati che tendono ad essere esclusi da una rete, dopo l'installazione di Linux di norma è vuota), /opt/nome applicazione (optional, cioè serie di programmi opzionali, nel senso di non di base) e /home/nome utente (la zona riservata di un utente).

Mentre nelle directory doc solitamente si può trovare documentazione in diversi formati[1], in man ed info la documentazione si trova solo in un formato testo con una speciale formattazione di cui si parlerà più avanti[2]. Con un gestore di file si può navigare in queste directory e visualizzare, senza problemi di formato, tutti questi file. Midnight Commander (mc in modalità riga di comando, gmc per una versione grafica che richiede X-Window e GNOME), è un gestore di file che non manca mai nelle distribuzioni.

La documentazione che viene allegata ad un programma comunemente si divide in diversi file con ben definite caratteristiche. Innanzitutto ci sono una serie di file che stanno in prima linea rispetto al resto della documentazione, dovrebbero stare in directory tipo /usr/doc oppure nella directory di partenza del programma.

Il file più in evidenza viene chiamato LEGGIMI, ma visto che la produzione di software è quasi sempre a livello internazionale si conviene nell'uso del file README (possibili varianti come README.italian, README.it, README.linux e diverse altre, multiformi, anche con solo R maiuscola).

Questo file è non raramente molto breve, contiene essenzialmente semplici informazioni base sul progetto. Quindi si potrà trovare una breve descrizione della funzione del programma, magari accompagnata da uno schema che elenca le sue caratteristiche (in inglese solitamente preceduto dalla scritta Features:), i requisiti necessari per eseguirlo, compilarlo o installarlo, dati sull'autore (all'inizio o verso la fine), ma se ci sono più autori sarà più informativo CREDITS, una breve descrizione della licenza, che in maniera estesa e completa viene invece spiegata in file come COPYING, COPYRIGHTS o LICENSE. A volte, invece, README fa solo da intermediario, indicando dove si trovano gli eventuali manuali del software.

Contents:
---------
  Requirements
  GNOME edition requirements
  Features
  Midnight Commander editions
  Where to get more information
  The Midnight Commander
  Mini-docs
  Obtaining the Midnight Commander
  Reporting problems.

This version of the Midnight Commander comes with two interfaces: a
graphical one for the GNOME desktop (http://www.gnome.org) and a text
mode interface (the same old user interface we have had for a long
time). 

Most of the engine is shared between both versions, but they come with
radically different interfaces:  the GNOME version is aimed to be a
simple to use tool for novice users.