[precedente] Clueless - Copertina - RPM [successivo]
man - Documentazione in Linux - il resto

Articolo


Texinfo

Il sistema Texinfo è stato originariamente sviluppato come supporto per l'editore di testi emacs.

La Free Software Foundation lo ha successivamente adottato come sistema di documentazione per il software prodotto sotto il "marchio" GNU.

Poiché Linux utilizza ampiamente software GNU, molta documentazione si trova in questo ambiente. Anzi utilizzando il comando man per reperire informazioni si ottiene spesso il seguente avviso iniziale (un po' terroristico):


       THIS  MAN PAGE IS OBSOLETE!  See the Texinfo documentation
       instead.  You can read it either  in  Emacs  or  with  the
       standalone  info  program which comes with the GNU texinfo
       distribution.

info è il nome del programma di "navigazione" in grado di utilizzare files di documentazione in formato Texinfo.

Il programma info si attiva molto semplicemente:

laptop-lfini-84:info
Il programma presenta quindi una pagina di menù in cui sono raccolte tutte le informazioni disponibili.

Ecco un esempio di pagina generata da info:



File: mtools.info,  Node: Top,  Next: Location,  Prev: (dir),  Up: (dir)

Introduction
************

   Mtools is a public domain collection of tools to allow Unix systems
to manipulate MS-DOS files: read, write, and move around files on an
MS-DOS filesystem (typically a floppy disk).  Where reasonable, each
program attempts to emulate the MS-DOS equivalent command. However,
unnecessary restrictions and oddities of DOS are not emulated. For
instance, it is possible to move subdirectories from one subdirectory
to another.

   Mtools is sufficient to give access to MS-DOS filesystems.  For
instance, commands such as `mdir a:' work on the `a:' floppy without
any preliminary mounting or initialization (assuming the default
`/etc/mtools.conf' works on your machine).  With mtools, one can change
floppies too without unmounting and mounting.

* Menu:

* Location::          Where to find mtools and early bug fixes
* Common features::   Common features of all mtools commands
* Configuration::     How to configure mtools for your environment
* Commands::          The available mtools commands
* Compiling mtools::  Architecture specific compilation flags
* Porting mtools::    Porting mtools to architectures which are not
                      yet supported

* Command Index::     Command Index
* Variable Index::    Variable Index
--zz-Info: (mtools.info.gz)Top, 51 lines --Top---------------------------------
Il programma info è ovviamente dotato di documentazione in linea per i numerosissimi comandi di "navigazione".

I comandi più comuni per "navigare"

I comandi principali:

h - Lancia l'help in linea di info

q - Termina info

Per selezionare altri nodi:

n - Seleziona il nodo successivo (next)

p - Seleziona il nodo precedente (previous)

u - Seleziona il nodo superiore (up)

m - Seleziona la voce di menù specificata

l - Ritorna all'ultimo nodo visitato (last)

Per muoversi all'interno di un nodo:

spazio - Avanza di una pagina

del - Retrocede di una pagina

b - Ritorna all'inizio del nodo (beginning)

e - Va alla fine del nodo (end)

s - Cerca una stringa specificata

Altri comandi:

1..9 - Seleziona la prima..nona voce di menù

0 - Seleziona l'ultima voce di menù

Scrivere documenti Texinfo

Ecco un esempio di file scritto in Texinfo:


\input texinfo   @c -*-texinfo-*-
     @c %**start of header
     @setfilename NAME-OF-INFO-FILE
     @settitle NAME-OF-MANUAL
     @setchapternewpage odd
     @c %**end of header
     
     @ifinfo
     This file documents ...
     
     Copyright YEAR COPYRIGHT-OWNER
     
     Permission is granted to ...
     @end ifinfo
     
     @c  This title page illustrates only one of the
     @c  two methods of forming a title page.
     
     @titlepage
     @title NAME-OF-MANUAL-WHEN-PRINTED
     @subtitle SUBTITLE-IF-ANY
     @subtitle SECOND-SUBTITLE
     @author AUTHOR
     
     @c  The following two commands
     @c  start the copyright page.
     @page
     @vskip 0pt plus 1filll
     Copyright @copyright{} YEAR COPYRIGHT-OWNER

     Published by ...
     
     Permission is granted to ...
     @end titlepage
     
     @node Top, Overview, , (dir)
     
     @ifinfo
     This document describes ...
     
     This document applies to version ...
     of the program named ...
     @end ifinfo
     
     @menu
     * Copying::          Your rights and freedoms.
     * First Chapter::    Getting started ...
     * Second Chapter::              ...
       ...
       ...
     @end menu
     
     @node    First Chapter, Second Chapter, top,      top
     @comment node-name,     next,           previous, up
     @chapter First Chapter
     @cindex Index entry for First Chapter

Il file viene processato mediante i comandi:

Ricerca dei files e "numeri:

Il comando ? in info fornisce, fra le altre informazioni, anche l'elenco delle directories dove vengono cercoati i files info:

/usr/info
/usr/local/info
/usr/local/lib/info
/usr/lib/info
/usr/local/gnu/info
/usr/local/gnu/lib/info
/usr/gnu/info
/usr/gnu/lib/info
/opt/gnu/info
/usr/share/info
/usr/share/lib/info
/usr/local/share/info
/usr/local/share/lib/info
/usr/gnu/lib/emacs/info
/usr/local/gnu/lib/emacs/info
/usr/local/lib/emacs/info
/usr/local/emacs/info
Nella mia installazione l'occupazione di disco e' la seguente:
      Directory     Num.Files    Kbytes
=======================================
/usr/info           227            3579    
/usr/local/info      15       (586) 186

Nota: i files info possono essere compressi con gzip.
man - Documentazione in Linux - il resto
[precedente] Clueless - Copertina - RPM [successivo]