Le mpg-blog

La principale fonction de texdoc est de localiser rapidement la documentation d’un module donné et de l’afficher. Je parlerai plus tard des fonctions de recherches et me concentre aujourd’hui sur l’affichage du document. Voyons donc comment indiquer à texdoc quel est votre visualisateur préféré pour chaque type de document, et comment texdoc essaye de trouver le bon en l’absence de configuration de votre part.## Fichiers de configuration

Pour indiquer à texdoc vos visualisateur favoris, il suffit d’insérer quelques lignes dans votre fichier de configuration texdoc personnel. Pour trouver celui-ci, lancez texdoc -f et repérez le fichier indiqué par une étoile. Il est probable que ce fichier et le répertoire qui doit le contenir n’existent pas encore, il vous faudra alors les créer.

Texdoc utilise simultanément plusieurs fichiers de configuration : en général, l’un est livré avec TeX Live, un autre est destiné à l’administrateur de la machine, et un dernier est réservé à votre usage personnel. (Quelques autres fichiers peuvent être utilisés dans des cas particuliers, comme une installation partagée entre plusieurs machines, ou pour utiliser la version de développement de texdoc.) De plus, la liste exacte peut dépendre de la version de texdoc utilisée (par exemple, dans des paquets Debian, les emplacements des fichiers voire leur nombre peut être modifiée). L’option -f a pour but de vous aider à vous retrouver parmi cette jungle de fichiers.

Directives de configuration

À chaque type de fichier correspond une variable de configuration : par exemple, pour les pdf, c’est viewer_pdf. Les valeurs de ces variables se règlent ainsi, une par ligne :

viewer_pdf = xpdf %s &
viewer_txt = view

Les espaces autour du signe égal ne comptent pas. Le signe %s représente le nom du fichier à visualiser ; on peut l’omettre lorsque c’est le dernier élément de la ligne. Dans le premier cas, observez l’usage de & pour lancer le visualisateur en arrière-plan (syntaxe shell standard).

Pour les curieux : méthode de choix par défaut

Sous Windows et Mac OS X, pour ce genre de choses, la vie est plus facile. En effet, il existe des associations entre types de fichiers et visualisateurs, définies au niveau global, et il est facile d’ouvrir un fichier en utilisant ces associations (commande open sous OS X et start sous Windows). C’est donc ce que fait texdoc, sauf pour les fichiers de type texte. En effet, ceux-ci sont parfois dépourvus d’extension, donc texdoc force l’utilisation d’un pager par souci d’uniformité (more sous Windows, less sous OS X).

Sous un Unix général, les choses se corsent. Des environnements de bureau comme KDE, Gnome, ou encore XFCE, définissent aussi des associations et des commandes pour ouvrir les fichiers en utilisant ces associations. Cependant, il serait faut de croire que parce que gnome-open existe, l’utilisateur est effectivement sous Gnome. Il faut donc détecter la présence d’un environnement de bureau de façon adaptée : pour cela, texdoc utilise désormais une technique largement inspirée de xdg-open, du projet XdgUtils.

Si aucun environnement de bureau n’est détecté, texdoc explore le PATH à la recherche de visualisateurs connus parmi une liste embarquée dans le code. L’ordre de cette liste n’a alors plus aucune raison de refléter les goûts d’un utilisateur particulier, mais il faut bien choisir…

Par ailleurs, certaines distributions, dans leur paquet texdoc, modifient le lecteur par défaut pour utiliser un outil spécifique à la distribution, comme la commande see sous Debian et dérivés.

Historique

Jusqu’à TeX Live 2007, la seule façon de configurer les visualisateurs était d’utiliser des variables d’environnements comme TEXDOCVIEW_pdf. Cette méthode est toujours acceptée même si les fichiers de configuration sont désormais la méthode recommandée. Par ailleurs, en l’absence de configuration explicite, le nom du lecteur était codé en dur, sans alternative. Depuis TeX Live 2008, plusieurs lecteurs sont essayé dans ce cas ; leur liste a évolué depuis, et le mécanisme de détection des environnements de bureau n’est apparu qu’après TeX Live 2009.