14 Dokumentation

In den meisten Fällen liegt den mit Guix installierten Paketen auch Dokumentation bei, die diese beschreibt. Die zwei üblichsten Formate für Dokumentation sind „Info“, ein durchsuchbares Hypertextformat, das für GNU-Software benutzt wird, und sogenannte „Handbuchseiten“ (englisch „Manual Pages“, kurz Man-Pages), das linear aufgebaute Dokumentationsformat, das auf Unix traditionell mitgeliefert wird. Info-Handbücher können mit dem Befehl info oder mit Emacs abgerufen werden, auf Handbuchseiten kann mit dem Befehl man zugegriffen werden.

Sie können die Dokumentation von auf Ihrem System installierter Software nach einem Schlüsselwort durchsuchen. Zum Beispiel suchen Sie mit folgendem Befehl in den Info-Handbüchern nach „TLS“.

$ info -k TLS
"(emacs)Network Security" -- STARTTLS
"(emacs)Network Security" -- TLS
"(gnutls)Core TLS API" -- gnutls_certificate_set_verify_flags
"(gnutls)Core TLS API" -- gnutls_certificate_set_verify_function
…

Mit folgendem Befehl suchen Sie dasselbe Schlüsselwort in Handbuchseiten³⁴:

$ man -k TLS
SSL (7)              - OpenSSL SSL/TLS library
certtool (1)         - GnuTLS certificate tool
…

Diese Suchvorgänge finden ausschließlich lokal auf Ihrem Rechner statt, wodurch gewährleistet ist, dass die Fundstellen zur von Ihnen auch tatsächlich installierten Software passen, Sie für den Zugriff keine Internetverbindung brauchen und Datenschutz gewährleistet bleibt.

Sobald Sie die Fundstellen kennen, können Sie zum Beispiel so die entsprechende Dokumentation anzeigen lassen:

$ info "(gnutls)Core TLS API"

oder

$ man certtool

Info-Handbücher sind in Abschnitte unterteilt und verfügen über Register sowie Hyperlinks, wie jene, die Sie auch von Webseiten kennen. Der info-Betrachter (siehe Info-Betrachter in Stand-alone GNU Info) und sein Gegenstück für Emacs (siehe Misc Help in The GNU Emacs Manual) verfügen über leicht erlernbare Tastenkürzel, mit denen Sie in Handbüchern navigieren können. Siehe Getting Started in Info: An Introduction für eine Einführung in die Info-Navigation.