Wo bzw. wie finde ich die Anleitung zu einem Paket oder einer Klasse

Wenn man ein Paket oder eine Klasse bereits installiert hat, dann ist in der Regel auch die Anleitung dazu gleich mit installiert worden. Zwar kann man bei der Installation einiger TeX Systeme, beispielsweise TeX Live, die Installation von Anleitungen auch abschalten, in der Voreinstellung, die man in diesem Punkt unbedingt beibehalten sollte, werden Anleitungen aber immer mit installiert. Nun muss man also nur noch die Anleitung auf dem eigenen Rechner finden. Das geht sowohl bei MiKTeX als auch bei TeX Live mit dem Kommandozeilenwerkzeug texdoc.

Die Kommandozeile (bzw. ein Terminal) öffnet man unter Windows einfach mit WINDOWS+R und anschließender Eingabe von CMD. Alternativ kann man CMD auch über die Windows-Suche starten oder findet es (meist als Eingabeaufforderung) im Startmenü. Unter Linux startet man je nach Desktop eine Terminalanwendung wie Konsole (KDE), xterm (X11 allgemein), gnome-terminal (Gnome), Terminal (XFCE).

Im Terminalfenster gibt man dann texdoc gefolgt von dem Paketnamen oder dem Klassennamen ein, beispielsweise

texdoc mwe

für das mwe-Paket, das für die Erstellung von vollständigen Minimalbeispielen sehr nützlich ist. Je nach TeX-System öffnet sich nun eine Auswahl an Dokumenten (MiKTeX) oder direkt die Hauptanleitung (TeX Live) zum Paket bzw. der Klasse.

Findet MiKTeX bei Angabe des Klassen- oder des Paketnamens keine Anleitung, kann es helfen, den Paketmanager zu starten und dort zunächst über den Dateifilter (File name) nach dem Paket zu suchen, das die Klassendatei bzw. die Paketdatei enthält. Dabei können auch Platzhalter für eine unscharfe Suche verwendet werden. Als nächstes kann man dann texdoc für den MiKTeX-Paketnamen probieren. Klickt man im Paketmanager mit der rechten Maustaste auf den Paketnamen öffnet sich ein Kontextmenü über das man auch eine Liste von enthaltenen Dateien bekommt. Damit erfährt man auch, welche weiteren Klassen, Pakete und Anleitungsdateien enthalten sind, um weitere Argumente für texdoc ausprobieren zu können.

Will man bei TeX Live für den Fall, dass mehrere Dokumente verfügbar sind, ebenfalls eine Auswahl an Dokumenten, so verwendet man zusätzlich Option -l. Für das Beispiel mwe erhält man dabei beispielsweise:

 1 /usr/local/texlive/2014/texmf-dist/doc/latex/mwe/mwe.pdf
   = Package documentation
 2 /usr/local/texlive/2014/texmf-dist/doc/latex/mwe/README
   = Readme
 3 /usr/local/texlive/2014/texmf-dist/doc/latex/mwe/INSTALL
 4 /usr/local/texlive/2014/texmf-dist/doc/latex/morehype/wiki_mwe.pdf
Please enter the number of the file to view, anything else to skip: 

Nun kann man beispielsweise mit 2 gefolgt von der RETURN-Taste das README zu mwe an Stelle der Anleitung mwe.pdf anzeigen lassen.

Hinweis: Theoretisch kann man auch texdoc direkt (unter Linux beispielsweise häufig über ALT+F2) aufrufen. Allerdings haben einige Pakete keine Anleitung im PDF-Format. Auch die README-Datei in obigem Beispiel ist eine reine Text-Datei. Solche Text-Dateien werden zumindest von TeX Live unter Linux in der Regel direkt im Terminal angezeigt. Solche Anleitungen sieht man dann eventuell gar nicht erst, obwohl sie existieren.

Wenn man ein Paket oder eine Klasse noch nicht installiert hat, dann findet man die Anleitung in der Regel auf CTAN über die Information zum zugehörigen CTAN-Paket. Das hat allerdings den Nachteil, dass man erst einmal den Namen des CTAN-Pakets herausfinden muss. Einfacher geht es stattdessen über TeXdoc.net. Dort kann man ebenfalls einfach den Namen der Klasse oder des Pakets eingeben, wie man das auch bei texdoc (siehe oben) machen würde, und erhält dann eine Übersicht über Anleitungen, wie sie auch von texdoc -l (siehe oben) ausgegeben wird.

Nachteil bei TeXdoc.net ist, dass ebenfalls nur nach Paketen gesucht werden kann, die über TeX Live angeboten werden. So wird man beispielsweise bei der Suche nach picins nicht fündig werden. In solchen Fällen bleibt nur, das Paket über CTAN zu suchen. In den Informationen zum Paket findet man dann in der Regel auch einen Link zur Anleitung.

Abschließend sei darauf hingewiesen, dass es immer von Vorteil ist, wenn man die Anleitung zum installierten Paket bzw. zur installierten Klasse liest. Eine Online-Anleitung kann sich immer auf eine andere Version beziehen und so ggf. Dinge beschreiben, die von der installierten Version so nicht unterstützt werden oder bereits obsolet sind.