texdoc wtf?

teaser with terminal lookMomentan gibts auf der TL mailing-list mal wieder eine Diskussion um texdoc. Das möchte ich zu Anlass nehmen, mal wieder, texdoc vorzustellen. Es handelt sich dabei um ein Kommando-Zeilen Tool, das mit TL ausgeliefert wird. Unter MikTeX ist texdoc ein alias für die MikTeX-Lösung. Mit Hilfe von texdoc kann man aus der Kommando-Zeile auf die Dokumentationen der TeX-Pakete zugreifen. Das Aufruf ist denkbar einfach:

texdoc name-des-pakets

Beginnen sollte man seine Reise durch das mystische Universum der Dokumentationen, die mit TL mitgeliefert werden vielleicht mit

texdoc texdoc

Auch sehr empfehlenswert ist das folgende

texdoc koma-de biblatex-en source2e l2tabu lshort-en

Bei diesem Aufruf erkennt man auch gleich zwei Dinge: 1. texdoc ist in der Lage mehrere Argumente zu verarbeiten und die entsprechenden Dokumente zu öffnen und 2. liegen die Dokumente in mehreren Sprachen vor, so kann man mit Name-Sprachkürzel auf die jeweilige Sprache zu greifen. Im Normalfall — KOMA ist eine Ausnahme, da Markus Kohm Deutscher (oder zumindest deutschsprachig) ist —  ist die englische Dokumentation die bessere, da neuer und meist auch vom Autor selbst geschrieben.

Optionen

texdoc kennt einige interessante Optionen. Die Option -s ziegt alle auch nur irgendwie verwanden Dokumente an. Der Aufruf

texdoc -s biblatex

gibt bei mir (MacTeX 2011) eine Liste mit 95 Dokumenten aus, aus welcher ich über die Nummerneingabe ein Dokument auswählen kann.
Weitere nützliche Optionen sind -h für eine Hilfe, -f für die Anzeige der texdoc-Konfigurationsdateien und -l für die Anzeige weiterer näher verwandter Dokumente.

texdoc -l biblatex

ergibt bei mir momentan 47 Ergebnisse.

Warum jetzt also texdoc?

Die Verwendung von texdoc hat den Vorteil, dass man immer die aktuelle (bzw. zu der Paket-Version passende) Dokumentation zur Hand hat, was bei zufälligen Funden im Internet nicht unbedingt der Fall sein muss. Zudem senkt die Verwendung von texdoc die Hemmschwelle eine Dokumentation zu lesen enorm, da es einfach schnell geht. Und das ist besonders für Anfänger wichtig. Eine gute Dokumentation ist einer kurzen Erklärung in einem Forum (und ich finde Foren toll) immer vorzuziehen*. Zudem lässt sich texdoc zumindest unter unixoiden Betriebssystemen sehr schön in den Workflow einbauen.

Nicht desto Trotz möchte ich nicht verschweigen, dass texdoc manchmal komische Ergebnisse liefert. Im Normalfall hilft dann aber -s oder -l um die gewünschte Dokumentation zu finden.

 Also bitte bitte texdoc nutzen!

Weiter Infos auch hier: www.golatex.de/wiki/index.php?title=texdoc

* Kapieren statt Kopieren

Dieser Beitrag wurde unter (La)TeX, Helpers abgelegt und mit , , , verschlagwortet. Setze ein Lesezeichen auf den Permalink.

Ein Kommentar zu texdoc wtf?

  1. cgnieder says:

    Danke für den Hinweis auf die Optionen! Ich nutze texdoc auch exzessiv (wie oft muss man mal was nachschlagen?), hatte aber bisher keine Ahnung, dass texdoc auch Optionen hat. Zugegeben — ich hatte mir auch nicht die Mühe gemacht, das mal nachzuschlagen, aber dennoch.

    Clemens

Hinterlasse eine Antwort

Deine E-Mail-Adresse wird nicht veröffentlicht. Required fields are marked *

*

You may use these HTML tags and attributes:
<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>