14 Documentation

Dans la plupart des cas les paquets installés avec Guix ont une documentation. Il y a deux formats de documentation principaux : « Info », un format hypertexte navigable utilisé par les logiciels GNU et les « pages de manuel » (ou « pages de man »), le format de documentation linéaire traditionnel chez Unix. Les manuels Info sont disponibles via la commande info ou avec Emacs, et les pages de man sont accessibles via la commande man.

Vous pouvez chercher de la documentation pour les logiciels installés sur votre système par mot-clef. Par exemple, la commande suivante recherche des informations sur « TLS » dans les manuels Info :

$ 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
…

La commande ci-dessous recherche le même mot-clé dans les pages de manuel³⁷ :

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

Ces recherches sont purement locales à votre ordinateur donc vous savez que la documentation trouvée correspond à ce qui est effectivement installé, vous pouvez y accéder hors ligne et votre vie privée est préservée.

Une fois que vous avez ces résultats, vous pouvez visualiser la documentation appropriée avec, disons :

$ info "(gnutls)Core TLS API"

ou :

$ man certtool

Les manuels Info contiennent des sections et des indexs ainsi que des hyperliens comme ce qu’on trouve sur les pages Web. Le lecteur info (voir Info reader dans Stand-alone GNU Info) et sa contre-partie dans Emacs (voir Misc Help dans The GNU Emacs Manual) fournissent des raccourcis claviers intuitifs pour naviguer dans les manuels Voir Getting Started dans Info: An Introduction pour trouver une introduction sur la navigation dans info.