Sie sind hier

Wie finde ich die Anleitung zu einem Paket?

Alle aktuellen LaTeX-Distributionen werden mit einem Programm ausgeliefert, das unter dem Namen texdoc angeprochen werden kann. Dieses Programm ist dazu gedacht, die Anleitungen zu den installierten Klassen und Paketen anzuzeigen.

Nebenbei bemerkt: Unter TeX Live war dies früher ein Shell-Script. Bereits seit TeX Live 2010 handelt es sich dabei jedoch um eine lua-Datei, die automatisch mit texlua ausgeführt wird. Unter MiKTeX handelt es sich in Wirklichkeit um das Programm mthelp, das zur Vereinheitlichung zusätzlich unter dem Namen texdoc verfügbar ist.

Das Programm texdoc erwartet min. einen Parameter, der angibt, welches Dokument man sucht. Hier gibt man am einfachsten den Paketnamen an.

Um das Programm unter Windows zu starten drückt man einfach die Tastenkombination [WINDOWS]+[R]. Es öffnet sich ein Dialog, in dem man nun den Programmnamen gefolgt vom Parameter eingibt und mit der Eingabetaste oder dem [OK] Knopf bestätigt.

Um das Programm unter KDE oder Gnome zu starten drückt man einfach die Tastenkombination [ALT]+[F2]. Es öffnet sich ein Dialog, in dem man nun den Programmnamen gefolgt vom Parameter eingibt und mit der Taste [RETURN] oder [ENTER] bestätigt.

Wie bei anderen Linux-Desktops oder Mac OSX ein Console-Programm gestartet werden kann, ist der Anleitung zum jeweiligen System bzw. Desktop zu entnehmen.

In einigen Fällen wird texdoc weder eine DVI-Datei noch eine PDF-Datei, sondern nur eine einfache Textdatei als Anleitung finden. Startet man texdoc wie oben angegeben, wird dann leider meist gar nichts angezeigt, weil für die Textanzeige meist ein Terminal notwendig ist. In diesem Fall sollte eine Terminal geöffnet werden (bei KDE beispielsweise konsole. bei Gnome gnome-terminal). Darin gibt man dann direkt den Aufruf für texdoc ein. Der Start des Terminals kann übrigens analog zum Start von texdoc erfolgen. Die meisten grafischen Desktops bieten dafür aber auch Menüs oder Tastenkombinationen.

Will man beispielsweise die Anleitung zu tocstyle erhalten, so gibt man

texdoc tocstyle

ein. Die Anleitung zu texdoc selbst, in der weitere Möglichkeiten des Programms genannt werden, ist zumindest bei TeX Live per

texdoc texdoc

zu erreichen.

Die deutsche KOMA-Script-Anleitung erhält man übrigens über den Umweg einer HTML-Vorschaltseite beispielsweise bei der Suche nach der Anleitung für eine beliebige KOMA-Script-Klasse. Mit

texdoc scrguide

erhält man sie zumindest bei TeX Live auf direktem Weg.

Bitte beachte auch die Anleitung zur jeweils verwendeten TeX-Distribution. Links zu den Distributionen und damit auch zu deren Anleitungen sind oben zu finden. Teilweise sind auch diese per texdoc erreichbar.

Comments for "Wie finde ich die Anleitung zu einem Paket?" abonnieren