Hier auf TeXwelt, aber auch sonst im Internet wird häufig auch das Lesen der Anleitung zu einem Paket oder einer Klasse empfohlen. Dem Anfänger stellt sich dabei jedoch oft die Frage: Wo und wie er die entsprechende Anleitung finden kann? Muss er dazu erst bei einer Suchmaschine wie Google auf die Suche gehen?

gefragt 26 Jun '14, 04:19

Ijon%20Tichy's gravatar image

Ijon Tichy
4.4k618
Akzeptiert: 100%

bearbeitet 18 Jul '14, 08:11

esdd's gravatar image

esdd
14.2k53251


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.

Permanenter link

beantwortet 26 Jun '14, 04:43

Ijon%20Tichy's gravatar image

Ijon Tichy
4.4k618

bearbeitet 24 Nov, 04:17

saputello's gravatar image

saputello
18.4k22352

Für Leute, die nicht mit Kommandozeilen vertraut sind, ist vielleicht Wie kompiliere ich in der Eingabeaufforderung / im Terminal? als Link nützlich

(26 Jun '14, 06:46) Clemens

Wobei man das ganze Verzeichnisgewese, das die Sache dort verkompliziert, für texdoc nicht benötigt wird. Für texdoc ist das Arbeitsverzeichnis unwichtig.

(26 Jun '14, 07:14) Ijon Tichy

@Ijon stimmt :)

(26 Jun '14, 07:15) Clemens

Bei MiKTeX muss man mitunter leider genauer wissen, was man sucht. Zum Beispiel wird mit texdoc tikz nichts gefunden, da muss man schon texdoc pgf eingeben. Noch schwieriger ist es, die symbols-a4.pdf aufzurufen. Das geht nur mit texdoc symbols-a4.

(26 Jun '14, 07:32) esdd

Bei TeX Live gibt es für solche Probleme die texdoc-Mailingliste. texdoc -l tikz liefert übrigens bei mir mit TeX Live 25 Dateien und die erste ist auch gleich pgfmanual.pdf. Mit texdoc -l symbols findet man nicht nur symbols-a4.pdf, sondern u. a. auch unimath-symbols.pdf.

Bei MiKTeX kann man eventuell auf Umwegen auch den Paketmanager zur Suche nach der Doku missbrauchen. Ich hoffe meine entsprechende Ergänzung ist korrekt. Wenn nicht, bitte melden, dann lösche ich das wieder oder korrigiere es.

(26 Jun '14, 08:51) Ijon Tichy
1

Das ist alles korrekt. Wobei man beim Suchen dann auch Platzhalter einsetzen kann. Wenn die zu einem Paket angezeigte Dateienliste nicht zu lang ist, dann sieht man auch gleich wie die Dokumentation heißt und wo im texmf Baum sie liegt.

(26 Jun '14, 09:36) esdd
Ergebnis 5 von 6 Alle anzeigen

Was hier m.E. nicht unerwähnt bleiben sollte, ist sehr praktische Übersicht bei TeX Live, und zwar die Datei doc.html - diese gibt neben dem Handbuch, sofern vorhanden, auch Weiteres her, etwa Beispiele, Readmes, Bilddateien etc.

Bei mir liegt diese direkt im Ordner C:/texlive/2013/; sie liefert, geöffnet in einem Internet-Browser:

alt text

darin dann

alt text

Permanenter link

beantwortet 26 Jun '14, 07:25

cis's gravatar image

cis
5.4k860168

bearbeitet 26 Jun '14, 07:26

@cis Das Dokument listet aber nur die TeX-Live-Pakete und die darin enthaltenen Anleitungen auf. Wenn man zu einer LaTeX-Klasse oder einem LaTeX-Paket die Anleitung sucht, muss man also zuerst das zugehörige TeX-Live-Paket wissen.

(26 Jun '14, 09:03) Ijon Tichy

@Ijon : richtig. Aber die Übersicht ist wirklich toll und Du findest / entdeckst (!) da tolle Sachen und nicht nur Handbücher. Ein Bsp.: Mit dem texdoc ... könntest Du auch manch anderes erreichen, etwa geht auch texdoc thumbs-example - so kommst Du an thumbs-example.pdf, willst Du auch thumbs-example.tex ansehen, kannst Du in doc.html schauen. Mit den examples ist aber leider auch nicht alles immer einheitlich, z.B. auch xyz_example.pdf o.ä. Um da nicht immer alles durchzuprobieren oder sämtlich Kommandozeilenbefhele zu kennen, lohnt ein Blick in diese Übersicht immer.

(26 Jun '14, 11:33) cis

@cis Ich will die Nützlichkeit nicht in Abrede stellen, ich wollte nur darauf hinweisen, dass es eben auch Nachteile hat. Ich persönlich finde es vor allem praktisch, um mir einen Überblick zu verschaffen, wenn ich ein zu einem Problem passendes Paket suche. Für die Suche nach Doku finde ich persönlich texdoc besser geeignet. Ich werde aber bestimmt niemanden davon abhalten, es anders zu machen und auch anders besser zu finden. Menschen sind unterschiedlich → Alternativen sind immer gut (entsprechend auch mein Daumen für Deine Antwort).

(26 Jun '14, 11:56) Ijon Tichy

Man kann auch texdoctk aufrufen:

alt text

Permanenter link

beantwortet 09 Aug '15, 16:14

Herbert's gravatar image

Herbert
5.0k34

Deine Antwort auf die Frage (nicht auf andere Antworten)
Knebel-Vorschau

Folge dieser Frage

Per E-Mail:

Wenn Du Dich anmeldest, kannst Du Updates hier abonnieren

Per RSS:

Antworten

Antworten und Kommentare

Aktuelle Buch-Infos

LaTeX Cookbook

LaTeX Beginners Guide

Limitierter Rabatt ebook
50% Coupon code tDRet6Y

Markdown-Grundlagen

  • *kursiv* oder _kursiv_
  • **Fett** oder __Fett__
  • Link:[Text](http://url.com/ "Titel")
  • Bild?![alt Text](/path/img.jpg "Titel")
  • nummerierte Liste: 1. Foo 2. Bar
  • zum Hinzufügen ein Zeilenumbruchs füge einfach zwei Leerzeichen an die Stelle ein, an der die neue Zeile sein soll.
  • grundlegende HTML-Tags werden ebenfalls unterstützt

Zugeordnete Themen:

×108
×7
×3
×2

Frage gestellt: 26 Jun '14, 04:19

Frage wurde angeschaut: 6,287 Mal

Zuletzt aktualisiert: 09 Aug '15, 16:14