Dieses kleine HOWTO bezieht sich auf die GNU/Linux-Distribution Ubuntu 10.10. Zuerst prüft man, ob das Paket
perl-doc
installiert ist. Also..
apt-cache policy perl-doc
Wenn dann sowas kommt wie..
perl-doc:
Installiert: 5.10.1-12ubuntu2
Kandidat: 5.10.1-12ubuntu2
Versionstabelle:
*** 5.10.1-12ubuntu2 0
500 http://de.archive.ubuntu.com/ubuntu/ maverick/main amd64 Packages
100 /var/lib/dpkg/status
ist man auf der sicheren Seite, und kann sofort den Befehl
perldoc
verwenden. Ansonsten installiert man das Paket einfach mit..
sudo apt-get install perl-doc
nach. Wenn man perldoc ohne Parameter aufruft, kriegt man eine minimale Hilfe, wie das Programm zu verwenden ist.
perldoc -f PerlFunc
perldoc -q FAQKeywords
Das -f steht für Funktion, das -q steht für 'perlfaq-search-regexp', also etwa: 'perl-wiederkehrend-gestellte-fragen-suche-regulärer-ausdrücke'.
Also angenommen wird hier als Beispiel, daß man sich eine Liste, mit allen in Perl eingebauten (build-in) Funktionen ausgeben lassen, und sich anschließend die Dokumentation zu jeder Funktion anschauen will.
Nach einem..
perldoc perltoc
toc = table of contents (Inhaltsverzeichnis)
bekommt man nun eine Inhaltsübersicht über die gesamte Perl-Dokumentation.
Wer nicht auf Anhieb den Schlüsselbegriff 'functions' und den dazugehörigen Abschnitt
perlintro
sieht, kann ihn sich ja mit..
/functions
anzeigen lassen. Mit 'q' verlassen wir den Pager, und rufen ihn danach gleich erneut auf..
perldoc perlintro
Ok - hier wird es jetzt ein bisschen haarig. Wir suchen nach Funktionen, und geben deshalb den Schlüsselbegriff
function
ein. Nach dreimaligem Drücken auf die Taste 'n' (next), lesen wir im Unterabschnitt
Files and I/O
etwas über
It's documented in extravagant detail in perlfunc [..]
Nun aber schnell.. (erneuter Aufruf)
perldoc perlfunc
Und nun sind wir auch schon am Ziel. Hier gibt es einen Unterabschnitt
Perl Functions by Category
Damit können wir jeden Funktionsnamen abgreifen, und das Muster..
perldoc -f FunktionsName
erfolgreich anwenden. Also z.B.
perldoc -f hex
Wer den Zauberparameter '-f ' allerdings vergisst miteinzugeben, ist bald ein Fall für die 'Klapse'.
Warum..
perldoc -f m//
nicht klappt, hab ich bisher noch nicht rausgefunden. Es handelt sich um einen Regulären Ausdruck, und auch ein
perldoc -f "m//"
bringt nichts.