Le mpg-blog

Comme promis à la fin du billet d’hier, je raconte aujourd’hui quelques options de texdoc ; plus précisément ses différents modes de présentation des résultats.## Les modes

Par défaut, quand vous tapez texdoc live, texdoc ouvre dans un lecteur qu’il juge approprié le résultat qu’il juge le plus pertinent ; c’est le mode view, le plus adapté pour consulter rapidement un document quand vous savez bien ce que vous voulez.

Il est possible néanmoins que plusieurs documents soient intéressants pour un mot-clé donné et que vous vouliez tous les examiner ; ou bien, texdoc peut s’être trompé dans son estimation de pertinence et ne pas vous présenter le meilleur résultat en mode view. Dans ce cas, vous pouvez utiliser le mode list pour que texdoc vous présente la liste des documents trouvés et vous permette de choisir lequel afficher.

mpg@roth:~% texdoc -l xargs
 1 /home/mpg/tl/trunk/Master/texmf-dist/doc/latex/xargs/xargs.pdf
   = [en] Package documentation (English)
 2 /home/mpg/tl/trunk/Master/texmf-dist/doc/latex/xargs/xargs-fr.pdf
   = [fr] Package documentation (French)
Please enter the number of the file to view, anything else to skip: 2

Par ailleurs, vous pouvez avoir le meilleur de ces deux modes : s’il n’y qu’un seul résultat, l’ouvrir directement pour gagner du temps, sinon, afficher la liste et vous laisser choisir ; c’est le mode mixed.

Un dernier mode, showall, force texdoc à afficher aussi des résultats qu’il juge probablement mauvais (ce qu’il fait automatiquement s’il ne trouve aucun « bon » résultat). À l’heure actuelle, je ne connais pas de cas où il est utile.

Par défaut, quand texdoc vous présente une liste, il vous demande de choisir un résultat à afficher ; de plus, si les résultats sont trop nombreux, il vous demande une confirmation avant d’en afficher la liste. Si vous n’aimez pas qu’on vous pose des questions, il est possible de désactiver toute interaction.

Sélection en ligne de commande

Il est possible de sélectionner le mode à l’aide d’options au nom explicite : --view (-w), --list, (-l), --mixed, (-m), --showall (-s). De plus, vous pouvez désactiver toute interaction avec --nointeract (-I) ou au contraire l’activer avec --interact (-i).

Sélection par le fichier de configuration

Si le mode par défaut n’est pas votre mode préféré, il est fastidieux d’avoir à saisir l’option correspondante à chaque fois. Il est plus pratique de configurer celui-ci une fois pour toute dans un fichier de configuration. Pour connaître le nom et l’emplacement du fichier à utiliser, exécutez texdoc --files et regardez la ligne indiquée par une étoile. Il faudra probablement créer ce fichier et le répertoire.

Vous pouvez alors indiquer votre mode préféré en insérant une ligne mode = nom-du-mode, activer ou non les interaction avec interact_switch = true-ou-false. Par exemple,

mode = list
interact_switch = false

pour que texdoc vous présente par défaut la liste des résultats en mode non interactif.

Historique

Le mode mixed est apparu dans texdoc 0.4 (TeX Live 2008). C’est aussi à ce moment que le mode list est devenu un menu permettant de choisir le document à afficher, et que sont apparues les possibilités de désactiver cette fonctionnalité et de configurer le mode par défaut via un fichier de configuration.

Depuis, la signification des modes a légèrement changé au fur et à mesure que les mécanismes de recherche de texdoc ont évolué. Avant la version 0.6, le mode showall s’appelait search ; avant 0.4 il signifiait que la recherche s’effectuait directement sur le disque (sans utiliser d’index) et que l’argument était interprété comme une expression régulière. Ce sens a subsisté un moment sous la forme du mode regex, aujourd’hui déprécié et qui devrait disparaître dans une prochaine version de texdoc.