Categories
es

Cómo crear una página man en linux

Las páginas en línea del Manual de Referencia (man) proporcionan descripciones detalladas y el uso de los comandos. Puede utilizar el comando man para mostrar la entrada de la página man que explica un comando determinado. La sintaxis del comando man es la siguiente.

Visualización de las páginas man

Por ejemplo, muestre las páginas man para el comando uname utilizando el comando man.

Desplazamiento por las páginas man

La siguiente tabla muestra los comandos de teclado para desplazarse por las páginas del manual.

Comando de teclado Acción
Barra espaciadora Muestra la siguiente pantalla de una página del manual
Retorno Muestra la siguiente línea de una página de manual
b Retrocede una pantalla completa
/patrón Busca un patrón hacia adelante
n Busca la siguiente aparición de un patrón después de haber utilizado /patrón
h Proporciona una descripción de todas las posibilidades de desplazamiento
q Sale del comando man y vuelve a la línea de comandos del intérprete de comandos.

Búsqueda en las páginas Man

Existen dos formas de buscar información en las páginas del manual:

Búsqueda en las páginas del manual: Por sección

Las entradas en línea de la página man están organizadas en secciones basadas en el tipo o uso del comando o archivo. Por ejemplo, la Sección 1 contiene comandos de usuario, y la Sección 4 contiene información sobre varios formatos de archivo. Para buscar una sección específica de la página man, utilice el comando man con la opció n-s, seguido del número de sección y el nombre del comando o archivo.

La siguiente tabla muestra los números de sección del manual seguidos de los tipos de páginas que contienen.

Sección Número Descripción
1 Programas ejecutables o comandos del shell
2 Llamadas al sistema (funciones proporcionadas por el núcleo)
3 Llamadas a bibliotecas (funciones dentro de las bibliotecas de programas)
4 Archivos especiales (normalmente se encuentran en /dev)
5 Formatos de archivo y convenciones, p. ej. /etc/passwd
6 Juegos
7 Varios (incluidos paquetes de macros y convenciones), p. ej. man(7), groff(7)
8 Comandos de administración del sistema (normalmente sólo para root)
9 Rutinas del núcleo [No estándar]

La parte inferior de una página de manual, titulada ‘ VER TAMBIÉN ‘, enumera otros comandos o archivos relacionados con la página de manual. El número entre paréntesis refleja la sección en la que se encuentra la página del manual.

Búsqueda en las páginas del manual: Por palabra clave

Si no está seguro del nombre de un comando, puede utilizar el comando man con la opció n-k y una palabra clave para buscar las entradas de la página man que coincidan.

La salida del comando man proporciona una lista de comandos y descripciones que contienen la palabra clave especificada. Por ejemplo, si utiliza el comando man, podrá ver los comandos que contienen la palabra clave syslog.