Dokumentation Finden

Aus DebianforumWiki
Wechseln zu: Navigation, Suche
WikiGrundsatzfragen ‹ Dokumentation Finden


Im Forum werden immer wieder Fragen gestellt, die darauf schließen lassen, das der Fragende die Dokumentation nicht gelesen hat. Bei Neulingen geschieht dies sicherlich manchmal, weil sie gar nicht wissen, wo die Dokumentation zu finden ist. Diese Seite soll eine kleine Hilfestellung bei der Suche nach der passenden Dokumentation geben.

Im Programm eingebaute Hilfe

Viele Programme besitzen eine eingebaute Hilfeseite, die angezeigt wird, wenn man keine Parameter angibt, oder z.B. -?, -h, -help, --help oder --usage.

user@debian:~$ man --usage

Manchmal enthält diese Hilfe auch einen Hinweis auf die eigentliche Dokumentation, wie der entsprechenden manpage.

Unix Standard Dokumentation: man

Für die meisten Unix Programme gibt es Dokumentation in Form von manpages, die mit dem Befehl man angezeigt werden. Die manpage für den Befehl man ruft man z.B. wie folgt auf:

user@debian:~$ man man

Am Ende einer Manpage findet man oft auch Verweise auf weitere Manpages, die z.B. die Konfigurationsdateien oder ähnliches Beschreiben.

Für die Suche nach einer bestimmten manpage gibt es das Programm apropos:

user@debian:~$ apropos python

Dokumentation zu Debian Paketen

In einer normalen Debian Installation findet man innerhalb von

/usr/share/doc/

zu (nahezu) jedem installierten Paket ein Verzeichnis, in dem sich die Dokumentation zu dem Paket befindet.

Oft ist in diesem Verzeichnis auch eine Datei namens README.Debian, die dann Hinweise auf Debian-Spezifika der Installation enthält.

Bei manchen Paketen ist die Dokumentation direkt in diesen Verzeichnissen enthalten, bei anderen gibt es ein spezielles -doc Paket, das die ausführliche Dokumentation - z.B. im HTML-Format - enthält. Dies gilt z.B. für das Paket Debianpackage.png python und dessen Dokumentation Debianpackage.png python-doc.

Wenn man einmal nicht weiß, zu welchem Paket ein Programm gehört, so kann man dies mittels apt-file (aus dem Paket Debianpackage.png apt-file) herausfinden:

user@debian:~$ apt-file PROGRAMMNAME

apt-file funktioniert auch für Programme (bzw. Dateien), die nicht installiert sind.

Eine bequeme Möglichkeit die komplette Dokumentation zu einem Paket zu lesen bietet debmany, aus dem Paket Debianpackage.png debian-goodies. Es kann damit auch die Dokumentation nicht installierter Pakete gelesen werden.

user@debian:~$ debmany PAKETNAME

Originaldokumentation im Internet

In den README Dateien oder in der Ausgabe von aptitude show PAKETNAME stehen oft Links auf die original Website der Software, wie z.B. bei Debianpackage.png python. Dort findet man meist die aktuellsten Informationen.

user@debian:~$ aptitude show python

...

Homepage: http://www.python.org/
Hinweis.png Hinweis: Die Versionen in Debian - insbesondere Stable - sind in der Regel nicht aktuell. Das sollte beim Lesen der Dokumentation neuerer Features immer bedacht werden.


Ist das Paket Debianpackage.png debian-goodies installiert, kann die Homepage mit dhompage PAKETNAME direkt aufgerufen werden.