Voici un exemple minimal de fichier Texinfo. Il sera étoffé tout au long de ce document, et figurera en version complète à sa fin. L'exemple est traditionnel: c'est le manuel d'une machine à café.
\input texinfo @c -*-texinfo-*- @c %**start of header @setfilename cafe.info @settitle Manuel Machine @`a caf@'e @c %**end of header @titlepage @title Machine @`a caf@'e @subtitle v1.2 - 25 septembre 1997 @author Benjamin Drieu @end titlepage Ce manuel va vous expliquer comment utiliser la machine @`a caf@'e. @bye
Le principe d'un document Texinfo est qu'il est composé d'un en-tête, suivi du corps du document.
Une ligne peut comporter une commande Texinfo qui commence toujours
par '@
', et peut comporter des arguments.
Décortiquons ligne-à-ligne l'exemple ci-dessus:
'\input texinfo @c -*-texinfo-*-'
charge les macros Texinfo lors du formatage par TeX. Celà se fait par
le chargement du fichier texinfo.tex
au moment du
formatage. Si vous voulez personnaliser la mise en page de vos
documents Texinfo formatés (par exemple franciser les titres), vous
pouvez éditer ce fichier qui est au format TeX.
'@c
commentaire'
ligne de commentaire: tout ce qui est compris en '@c'
et le
caractère de fin de ligne ne sera pas formaté. Les commentaires
'%**start of header'
et '%**end of header'
sont
destinés à Emacs.
'@setfilename
nom de fichier'
spécifie le nom de fichier en sortie lors du formatage par TeX (voir
plus loin).
'@settitle
titre'
spécifie le titre du document
'@titlepage'
tout ce qui suit initialise la page de titre: on entre dans la section
titlepage
.
'@title
titre'
spécifie le titre de la page qui sera imprimé en page de couverture
dans le cas d'un formatage par TeX.
'@subtitle
sous-titre'
spécifie un sous-titre qui sera imprimé sur la page de couverture
après le titre. Plusieurs sous-titres peuvent être spécifiés.
'@author
auteur'
spécifie l'auteur du document. Plusieurs auteurs peuvent être
spécifiés.
'@end titlepage'
permet de sortir de la section titlepage
pour revenir dans le
corps du document. Les choses sérieuses peuvent commencer.
'@bye'
spécifie au formateur de textes de s'arrèter lorsqu'il rencontrera
cette ligne.
Remarquons l'insertion de commandes telles que '@`a'
au
milieu du texte. Ces commandes ont pour but d'insérer un caractère
accentué à l'endroit ou elles se trouvent.
Effectuer une sortie papier est relativement simple. Elle est faite
par le biais de la commande texi2dvi
puis de la commande
dvips
.
L'appel de la commande texi2dvi
est tout simplement :
texi2dvi
fichier.texi
Si tout s'est bien passé, un fichier fichier.dvi
a
été créé dans le répertoire courant. Il s'agit d'un fichier au format
dvi (DeVice Independant), qui est une étape
intermédiaire vers l'impression du document.
L'étape suivante consiste à convertire ce fichier en PostScript, ce qui s'effectue par la commande :
dvips
fichier.dvi -o
fichier.ps
.
Un fichier PostScript devrait être généré à partir du fichier
.dvi
, ce qui permet ensuite une impression. (Notez que
l'appel de dvips
sans les arguments -o
fichier.ps
envoie directement le résultat à
l'imprimante).
Il existe de plus un programme visionneur de fichiers dvi :
xdvi
.
Le plus simple est d'ouvrir le fichier texinfo dans un buffer d'Emacs
(voir
http://www.april.org/groupes/doc/emacs/emacs.html), puis
d'effectuer un M-x texinfo-format-buffer
. Ceci génèrera un
nouveau buffer qui est la sortie info de ce fichier.