14 Documentación

In most cases packages installed with Guix come with documentation. There are two main documentation formats: “Info”, a browsable hypertext format used for GNU software, and “manual pages” (or “man pages”), the linear documentation format traditionally found on Unix. Info manuals are accessed with the info command or with Emacs, and man pages are accessed using man.

Puede buscar documentación de software instalado en su sistema por palabras clave. Por ejemplo, la siguiente orden busca información sobre “TLS” en manuales 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
…

The command below searches for the same keyword in man pages⁵²:

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

Estas búsquedas son completamente locales en su máquina de modo que tiene la garantía de que la documentación que encuentre corresponde con lo que está realmente instalado, puede acceder a ella sin conexión a la red, y se respeta su privacidad.

Una vez tenga estos resultados, puede ver la documentación relevante mediante la ejecución de, digamos:

$ info "(gnutls)Core TLS API"

o:

$ man certtool

Los manuales Info contienen secciones e índices, así como enlaces como aquellos encontrados en páginas Web. El lector info (see Info reader in Stand-alone GNU Info) y su contraparte en Emacs (see Misc Help in The GNU Emacs Manual) proporcionan combinaciones de teclas intuitivas para la navegación en los manuales. See Getting Started in Info: An Introduction, para una introducción a la navegación en Info.