texdoc

• Seite
• Diskussion
• bearbeiten
• Versionen/Autoren

texdoc ist ein Kommandozeilenprogramm, dass die Dokumentation zu einem LaTeX Paketes zeigt. Durch die Dokumentationen kann in vielen Fällen die beste Hilfe zu den jeweiligen Paketen erhalten werden. Zu beachten ist allerdings, dass die Sprache der Paketdokumentationen oftmals Englisch ist.

[bearbeiten] Verwendung

Syntax:

texdoc OPTIONEN NAME

Dabei ist NAME wahlweise der Name einer Klasse, eines Pakets oder einer Anleitung. Mögliche OPTIONEN werden im folgenden Abschnitt behandelt.

Beispiel:

texdoc pgfplots

Bei Paketen, zu denen neben der Englischen auch eine Deutsche Anleitung existiert, kann man bei der TeX-Live-Version von texdoc diese Anleitung durch anhängen der Endung "-de" erhalten. So liefert beispielweise

texdoc caption-de

die Anleitung zum Paket caption in deutscher Sprache.

[bearbeiten] Optionen von texdoc unter TeX Live

Eine Auswahl der wichtigsten Optionen zu texdoc unter TeX Live. Bei MiKTeX ist texdoc hingegen ein Alias für mthelp mit weitgehend anderen Optionen. Der Aufruf ohne Optionen ist hingegen identisch.

-h, --help

Hilfe anzeigen

-f, --files

Anzeige der Konfigurationsdatei

-l, --list

Zeigt alle verfügbare Ergebnisse an. Auch z.B. Readme Dateien.

-s, --showall

Zeigt alles an, auch weniger hilfreiche Dateien wie Lizenzen.

Derzeit werden die Hilfe, die Konfigurationsdatei und ggf. Auswahllisten als Terminalausgabe angezeigt. Bei Verwendung der Optionen sollte man daher texdoc in einem Terminal starten.

[bearbeiten] Aufruf aus einer grafischen Benutzeroberfläche

In der Regel kann man texdoc auch ohne Terminal aus einer grafischen Benutzeroberfläche heraus aufrufen.

Bei Gnome oder KDE drückt man dazu die Tastenkombination ALT+F2, unter Windows die Tastenkombination WINDOWS+R. In dem dadurch geöffneten Dialog gibt man dann »texdoc OPTIONEN NAME« (ohne die Anführungszeichen) ein. Ggf. setzt man zusätzlich Einstellungen wie »Im Terminal ausführen«, damit man auch Textausgaben erhält oder eine Listenauswahl treffen kann.

[bearbeiten] Weitere Informationen

Die pdf-Dokumentation von texdoc kann folgendermaßen aufgerufen werden:

texdoc texdoc

[bearbeiten] Links

texdoc Homepage

Kategorie: goLaTeX-Wiki