En las distribuciones de UNIX y Linux, los programas de línea de comandos vienen con su propia documentación llamada páginas de manual o páginas man.
Las páginas de manual generalmente las escribe el desarrollador del programa correspondiente. Generalmente, las páginas del manual se dividen en varias secciones.
La siguiente es la lista de todas las secciones man disponibles. Cada sección tiene un número único y contiene solo un tipo específico de páginas man. Por ejemplo, la sección man número 3 contiene solo páginas man de llamadas de biblioteca.
- 1 – Programas o comandos ejecutables
- 2 – Llamadas al sistema (funciones proporcionadas por el núcleo)
- 3 – Llamadas de biblioteca (funciones proporcionadas por la biblioteca)
- 4 – Archivos especiales
- 5 – Formatos de archivo y convenciones (archivos de configuración)
- 6 – Juegos
- 7 – Varios
- 8 – Comandos de administración del sistema
Sintaxis:
man <TOPICNAME>
1. Ver página man de un comando UNIX
Para leer la página de manual de un comando de UNIX, pase el nombre del comando como argumento a man. Lo siguiente mostrará la página de manual para el comando passwd.
$ man passwd
PASSWD(1) User Commands PASSWD(1)
NAME
passwd - change user password
... Algunos temas incluso pueden tener páginas man en más de una sección. En tal caso, el comando man mostrará la página que tiene el número de sección más bajo.
En este ejemplo, el comando passwd tiene páginas de manual en varias secciones. Pero, por defecto, muestra la página man de la sección 1.
La “PASSWD(1)” que se muestra en la primera línea de la salida del comando man indica que está mostrando la página del manual de la sección 1. La salida de la página del manual muestra el nombre del comando, la sintaxis de los comandos, la descripción de lo que hace el comando, opciones proporcionadas por el comando, etc…
2. Ver página man desde una sección específica
Para leer la página del manual de una sección en particular, proporcione el número de sección de la siguiente manera. El comando passwd tiene una página de manual tanto en la sección 1 como en la sección 5. De manera predeterminada, si no especifica el número de sección, mostrará la página de manual de la sección 1.
Para mostrar la página de manual de la sección 5, especifique el número de sección como se muestra a continuación.
$ man 5 passwd
Ahora mostrará la página del manual para el archivo de configuración /etc/passwd, ya que la sección número 5 es para formatos de archivo y conversiones.
3. Lista de secciones man disponibles para un comando
También puede enumerar todas las secciones disponibles sobre un tema en particular usando la opción -aw.
$ man -aw printf /usr/share/man/man1/printf.1.gz /usr/share/man/man3/printf.3.gz
De la salida anterior, podemos saber que hay 2 manuales de printf, uno en la sección "Comandos" y otro en "Llamadas a la biblioteca". Por lo tanto, puede ejecutar el siguiente comando man para ver ambas páginas man.
$ man printf $ man 3 printf
4. Ver todas las páginas man de un comando:mostrar todas las secciones
Para ver todas las páginas man de un tema en particular, use la opción “-a”. Primero verá la página del manual con el número más bajo. Cuando salga de esa página y presione "Enter", aparecerá la siguiente página man.
$ man -a printf
El comando anterior mostrará primero la página de manual del comando printf(1). Cuando presiona "q" y presiona "Enter", se mostrará la página de manual de la función de biblioteca printf(3).
5. Ver la página del manual en formato HTML en un navegador
También puede ver la página de manual en formato HTML usando cualquier navegador de su deseo usando el argumento "-H". Esto abrirá la página de manual para el comando printf en Firefox como página HTML.
$ export BROWSER=/usr/bin/firefox $ man -H printf
6. Cambiar el buscapersonas predeterminado utilizado por Man Command
Por defecto, el comando man usará la variable de entorno $PAGER para identificar qué buscapersonas usar para mostrar la salida. El usuario puede cambiar el buscapersonas en el que prefiere ver la página de manual usando la opción '-P'.
El siguiente comando mostrará la página de manual usando más buscapersonas de comandos.
$ man -P more printf
7. Buscar página man contra la sección NOMBRE
Para buscar en la página del manual contra la sección NOMBRE, use la opción "-f" como se muestra a continuación.
$ man -f printf printf (3) - formatted output conversion printf (1) - format and print data
Esto es equivalente a usar el comando whatis shell.
El comando anterior busca los nombres de las páginas del manual y muestra la descripción del tema dado si los nombres de las páginas del manual coinciden con el tema dado. También puede pasar varios temas en la misma línea de comando.
8. Buscar en la página de manual contra la sección NOMBRE y DESCRIPCIÓN
Para buscar en la página del manual contra la sección NOMBRE Y DESCRIPCIÓN, use la opción "-k". Es equivalente a usar el comando de shell "a propósito".
$ man -k printf asprintf (3) - print to allocated string dprintf (3) - print to a file descriptor fprintf (3) - formatted output conversion fwprintf (3) - formatted wide-character output conversion printf (1) - format and print data printf (3) - formatted output conversion snprintf (3) - formatted output conversion sprintf (3) - formatted output conversion ... ...
El comando anterior buscará la palabra clave "printf" como expresión regular y mostrará todas las páginas man que coincidan con la palabra clave.