Man pages

Manuales offline

¿Qué son?

Las páginas de manual o man pages son un manual de usuario que por defecto se crean en la mayoría de las distribuciones Linux y también en sistemas operativos basados en Unix durante el proceso de instalación del sistema.

Las man pages proveen documentación extensiva sobre los comandos que se usan en la consola así como de otros aspectos del sistema, incluidos archivos de configuración, system calls, librerías y el kernel.

¿Cómo consultar las man pages?

El comando man es usado para formatear y mostrar las páginas de manual.

El comando en sí mismo es muy simple de usar. La sintaxis básica es la siguiente:

man [option(s)] keyword(s)

Comúnmente es usado sin ninguna opción y con solamente una keyword. La keyword es exactamente el comando u otro ítem que se quiere consultar. En el siguiente ejemplo se consulta el manual del comando ls, el cual es usado para listar el contenido de algún directorio específico.

$ man ls

man automáticamente envía el output a un paginador, usualmente es el programa less. Al pie de la pantalla less escribe el símbolo : para indicar el final de la página. Para moverse a la siguiente página se utiliza la barra espaciadora y para volver a la página anterior la tecla b. Presionando la tecla q se cierra el manual retornando al usuario a la shell.

Secciones

La man pages están organizadas en secciones. Cada una contiene páginas específicas acerca de una categoría tal como se muestra en el siguiente listado:

Each man page is a self-contained article that is divided into a number of sections, the headers for which are labeled with upper case letters. The sections for commands are typically something like NAME, SYNOPSIS, DESCRIPTION, OPTIONS, AUTHOR, BUGS, COPYRIGHT, HISTORY and SEE ALSO, although there may be some differences according to the particular command. Some of these might be broken down into subsections, particularly OPTIONS in the case of a command that has numerous options.

Also, the man pages as a whole are organized into sections, each containing pages about a specific category of topics as shown below. The section to which an article belongs is indicted in parenthesis in the top line, before the NAME header.

Sección

Descripción

1

General Commands

2

System Calls

3

Library functions, covering in particular the C standard library

4

Special files (usually devices, those found in /dev) and drivers

5

File formats and conventions

6

Games and screensavers

7

Miscellanea

8

System administration commands and daemons

Para consultar sobre algún tema en alguna sección específica la sintaxis del comando man es la siguiente:

man section_number keyword

Por ejemplo:

$ man 2 mount

Algunos trucos con man

-f option

$ man -f echo

Se mostrará una descripción breve del comando printf, similar a:

echo (1) - display a line of text

-k option

man -k echo

Con este comando se buscan las descripciones breves de las páginas de manual relacionadas a la keyword utilizada y se mostrarán todas las coincidencias.

echo (1) - display a line of text
lessecho (1) - expand metacharacters
pam_echo (8) - PAM module for printing text messages
ping (8) - send ICMP ECHO_REQUEST to network hosts
ping6 (8) - send ICMP ECHO_REQUEST to network hosts
xmessage (1) - display a message or query in a window (X-based /bin/echo)

-w option

$ man -w echo

Se muestra el path a los archivos nroff que luego son formateados al generar el manual.

/usr/share/man/man1/echo.1.gz

-K option

$ man -K echo

Se mostrarán todas las entradas de man pages que contienen la keyword echo; una vez que cada una de las páginas es visualizada, se puede presionar enter para continuar con la siguiente. Por ejemplo, el siguiente output es mostrado para continuar con la segunda entrada de man. Se puede omitir o finalizar la ejecución del comando.

--Man-- next: bash(1) [ view (return) | skip (Ctrl-D) | quit (Ctrl-C) ]