man page (Español)

From ArchWiki

Estado de la traducción: esta traducción de man page fue revisada el 2022-01-28. Si existen cambios puede actualizarla o avisar al equipo de traducción.

Artículos relacionados

Las man pages (abreviatura de «manual pages» o páginas de manual) es una forma de documentación que está disponible en casi todos los sistemas operativos derivados de UNIX, incluyendo Arch Linux. Para acceder a estas, use el comando man.

A pesar de la amplia cantidad de temas que estas pueden abordar, están diseñadas para ser independientes entre si; limitándose a simplemente hacer mención a otras páginas de manual cuando sea necesario. Esta es una diferencia notable con el uso de enlaces en el intento de GNU por reemplazar este tradicional formato: los documentos de información.

Instalación

El paquete man-db es la implementación de man en Arch Linux, y less es el paginador que se usa por defecto. También puede utilizar mandoc.

man-pages provee las páginas de manual del sistema operativo Linux.

Están disponibles las siguientes traducciones:

También puede usar otras aplicaciones para ver las páginas de manual:

  • GNOME Help — Visor para la documentación de GNOME. Puede mostrar páginas de manual con yelp man:<name> o el atajo de teclado (no documentado) Ctrl+L desde una ventana ya abierta.
https://wiki.gnome.org/Apps/Yelp || yelp
  • KHelpCenter — Aplicación para visualizar la documentación de las aplicaciones de KDE. Las páginas de manual están en «Páginas de manual de UNIX» o puede acceder a estas ejecutando khelpcenter man:<nombre>.
https://userbase.kde.org/KHelpCenter/es || khelpcenter
  • Konqueror — Gestor de archivos y navegador de KDE. Puede mostrar páginas de manual con man:<nombre>.
https://apps.kde.org/es/konqueror/ || konqueror
  • xman — Provee una visualización organizada de las páginas de manual.
https://xorg.freedesktop.org/ || xorg-xman

Acceder a las páginas del manual

Para leer una página del manual, introduzca: 

$ man nombre_de_página

Los manuales están organizados en secciones. Para obtener una lista completa de todas las secciones en inglés, vea la sección con el título «Sections of the manual pages» en man-pages(7).

Nota:

No está disponible la página man-pages(7) en el paquete con las traducciones al español, así que se adjunta una lista de las secciones y una descripción breve:

  1. Comandos para uso del usuario (o programas)
  2. Llamadas al sistema (funciones para acceder a las operaciones del kernel)
  3. Llamadas a librerías (funciones proveídas por librerías; la mayoría de libc)
  4. Ficheros especiales (para acceder a dispositivos a través del kernel, normalmente se encuentran /dev)
  5. Formatos de archivos y archivos de configuración
  6. Juegos y comandos de ocio
  7. Descripciones de diversos temas, convenciones, protocolos, estándares de codificación de caracteres, estándares para la estructura del sistema operativo y misceláneos
  8. Comandos para la administración del sistema (que normalmente requieren privilegios de superusuario)

Para referirse a las páginas, utilice su nombre y el numero de sección en paréntesis. Pueden haber distintas páginas con el mismo nombre, como man(1) y man(7). En estos casos, para acceder a una o la otra, ingrese el numero de la sección y el nombre de la página del manual; por ejemplo use: 

$ man 5 passwd

Para leer la página acerca del archivo /etc/passwd, en vez de la que trata del comando passwd.

De igual manera, puede ingresar el nombre y el numero de sección separados por un punto: 

$ man passwd.5

Búsqueda de manuales

Para buscar una página del manual sin saber su nombre exacto, puede usar cualquiera de los siguientes comandos: 

$ man -k expresión
$ man --apropos expresión
$ apropos expresión

Note que expresión es interpretado como una expresión regular por defecto.

Para buscar palabras clave dentro del texto completo de las páginas, ocupe la opción -K.

Nota: Para realizar las búsquedas se ocupa un caché dedicado a este propósito. Por defecto, el mantenimiento de dicho caché es realizado por man-db.service, el cual es accionado periódicamente por man-db.timer. Si cada vez que realiza una búsqueda obtiene un «nada apropiado», intente volver a generar este caché manualmente ejecutando mandb como superusuario.

Puede ver una descripcion de una línea de las páginas del manual usando el comando whatis. Por ejemplo, para una breve descripción de las páginas del manual de ls en distintas secciones, escriba: 

$ whatis ls
ls (1)               - lista el contenido de un directorio
ls (1p)              - list directory contents

Ancho de página

El ancho de la página es controlado por la variable de entorno MANWIDTH.

Si el numero de columnas en la terminal es muy pequeño (p.ej cuando se usa una ventana estrecha), los saltos de línea van a quedar mal ubicados, lo cual puede resultar en un texto desagradable de leer. Puede arreglar esto estableciendo MANWIDTH al invocar man. En Bash puede hacerlo de la siguiente manera: 

~/.bashrc
man() {
    local width=$(tput cols)
    [ $width -gt $MANWIDTH ] && width=$MANWIDTH
    env MANWIDTH=$width \
    man "$@"
}

Leyendo páginas del manual locales

En vez de usar la interfaz estándar, usar navegadores como lynx y Firefox para ver las páginas del manual permite a los usuarios sacarle partido al principal beneficio de las páginas info: el texto con hipervínculos. Para hacerlo, tiene varias formas:

Convertir a HTML

mandoc

Instale el paquete mandoc. Para convertir una página, por ejemplo free(1), ejecute: 

$ mandoc -Thtml -Ostyle=style.css /usr/share/man/man1/free.1.gz > free.html

Ahora abra el fichero llamado free.html en su navegador favorito.

man2html

Primero, instale man2html desde los repositorios oficiales.

Ahora, convierta de esta forma una página del manual: 

$ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html

Otro uso para man2html es exportar texto con formato mínimo y listo para imprimir: 

$ man free | man2html -bare > ~/free.txt

man -H

La implementación de man-db de Arch Linux también puede hacer esto sin necesidad de otros paquetes: 

$ man -H free

Esto buscará la variable de entorno BROWSER para determinar que navegador usa por defecto. Sino, puede pasar como argumento el binario a la opción -H.

roffit

Primero instale roffitAUR desde el AUR.

Para convertir una página del manual: 

$ gunzip -c /usr/share/man/man1/free.1.gz | roffit > free.html

Conversión a PDF

Las páginas del manual siempre han sido imprimibles: están escritas en troff(1), que esencialmente es un lenguaje de composición tipográfica. Por esto, usted puede convertir las páginas del manual a cualquier formato según los dispositivos de salida que groff (usado por man-db) soporte. Para ver una lista de estos dispositivos, vea la opción -T en groff(1) o mandoc(1) si ocupa mandoc.

Use el siguiente comando para convertir en PDF: 

$ man -Tpdf pagina_del_manual > nombre_de_archivo

Limitaciones: Las fuentes están generalmente limitadas a Times a tamaños prefijados. Algunas páginas del manual están específicamente diseñadas para verlas en terminal, y por ello no se visualizarán correctamente en PS o en PDF.

Páginas del manual en línea

Existen numerosas bases de datos de páginas de manual en línea, incluyendo:

También está disponible una tabla de comparación entre estas.

Advertencia: Algunas distribuciones proporcionan páginas de manual parcheadas u obsoletas que difieren de aquellas proporcionadas por Arch. Sea cauto al usar páginas de manual en línea.

Páginas del manual de especial interés

A continuación se muestra una lista no exhaustiva de páginas de especial interés que podrían ayudarle a comprender muchas cosas en mayor profundidad. Algunas de ellas podrían servir como buena referencia (como la tabla ASCII).

De formas más general, eche un vistazo a las páginas de la categoría 7 (misceláneos): 

$ man -s 7 -k ".*"

Páginas específicas de Arch Linux:

Véase también