Das perldoc Programm

perldoc ist ein Programm, mit dem man verschiedene Teile der Perl-Dokumentation lesen kann.

Es gibt verschiedene Möglichkeiten, perldoc aufzurufen:

perldoc Handbuchseite:

Es wird die entsprechende Handbuchseite aus der mitgelieferten Perl-Dokumentation aufgerufen. Welche Handbuchseiten es gibt, erfährt man mit perldoc perl.

Beispiel: perldoc perlre zeigt die Handbuchseite zu Perls RegularExpressions? an.

perldoc Modulname:

Es wird die Handbuchseite zum Modul Modulname angezeigt. Wenn es keine eigene Handbuch-Datei (POD-Datei) gibt, dann wird der Modulcode selber (.pm-Datei) nach POD-Teilen durchsucht und diese angezeigt. Das ist sehr praktisch, weil man so nur sein Modul passend zu den POD-Richtlinien kommentieren muss, und schon hat man das Handbuch.

Beispiel: perldoc CGI zeigt die Handbuchseite zum Modul CGI.pm an.

perldoc -f Funktion: (-f wie function)

Es wird aus der Handbuchseite perlfunc.pod die genannte Funktion herausgesucht und deren Beschreibung ausgegeben.

Beispiel: perldoc -f open zeigt die Beschreibung der Funktion open() an.

perldoc -q Suchtext: (-q wie query)

Es wird in der mitgelieferten Perl-FAQ (d. h. in den Dokumenten perlfaq1.pod bis perlfaq9.pod) nach einem Treffer für Suchtext gesucht.

Beispiel: perldoc -q random zeigt einige FAQs zu Zufallszahlen an.

Alles weitere erfährt man - natürlich - durch perldoc perldoc!

Wie funktioniert perldoc?

Die Perl-Dokumentation liegt im sogenannten PodFormat? vor. POD ist ein ASCII-basiertes Format, d. h. einfacher Text, mit zusätzlichen Formatierungsbefehlen. Der Befehl perldoc wandelt diese Dokumentation in eine formatierte Hilfeseite um (unter Unix/Linux als sogenannte ManPage?).

-- HaraldBongartz - 15 Mar 2003