Welcome to the Slackware Documentation Project

Cómo buscar y leer las páginas de manual eficientemente.

Las páginas de manual son páginas del Manual de Unix en línea. Espero que este Howto pueda ayudar a algunos de ustedes a usarlos de manera más efectiva, aunque soy consciente de que muchos de los lectores ya están familiarizados con este tema.

Buscando una página de manual

Para buscar información sobre cualquier cosa en las páginas de manual, puede utilizar uno de los siguientes comandos:

  • apropos
  • man -k
  • whatis

apropos es solo un alias para man -k ; no hay diferencia entre ellos. La diferencia entre whatis y los otros comandos es que whatis busca palabras completas mientras que apropos (o man -k respectivamente) busca por partes de cadenas de caracteres.

Si no sabe exactamente cómo se escribe una palabra, por ejemplo un comando, puede usar apropos . Si sabe exactamente la palabra que debe buscar, whatis sería más eficiente porque da como resultado menos líneas de salida.

Ejemplo

Buscando mas informacion acerca de DHCP:

Con el comando apropos:

user@darkstar$ apropos dhcp
dhclient []          (8)  - script - DHCP client network configuration script
dhclient.conf []     (5)  - DHCP client configuration file
dhclient.leases []   (5)  - DHCP client lease database
dhcp []              (5)  - eval - ISC DHCP conditional evaluation
dhcp []              (5)  - options - Dynamic Host Configuration Protocol options
dhcpcd []            (8)  - an RFC 2131 compliant DHCP client
dhcpcd []            (8)  - run-hooks - DHCP client configuration script
dhcpcd.conf []       (5)  - dhcpcd configuration file
dhcpctl_initialize [] (3)  - dhcpctl library initialization
dhcpctl_initialize [] (3p)  - dhcpctl library initialization
dhcpd []             (8)  - Dynamic Host Configuration Protocol Server
dhcpd.conf []        (5)  - dhcpd configuration file
dhcpd.leases []      (5)  - DHCP client lease database
dnsmasq []           (8)  - A lightweight DHCP and caching DNS server

Con el comando whatis:

user@darkstar$ whatis dhcp
dhcp []              (5)  - eval - ISC DHCP conditional evaluation
dhcp []              (5)  - options - Dynamic Host Configuration Protocol options

Para ambos comandos, la búsqueda no distingue entre mayúsculas y minúsculas!

Actualizando la base de datos de ''whatis''

El comando whatis tiene su propia base de datos. Las páginas de manual de cualquier paquete de la instalación de Slackware en stock ya están presentes en la base de datos. Esto también es cierto si actualiza dichos paquetes. Pero si construye sus propios paquetes desde la fuente, por ejemplo desde SlackBuilds.org, las páginas de manual de estos paquetes aún no están presentes en la base de datos whatis . Para actualizar la base de datos después de instalar nuevos paquetes, Slackware proporciona el comando makewhatis . Tiene que ser ejecutado como root.

Tenga en cuenta que algunas distribuciones utilizan el comando “mandb” para este propósito.

Secciones en el manual

No confunda estas secciones con las secciones dentro de la estructura de cada página de manual; se describen en el párrafo siguiente.

El manual de páginas está dividido en ocho secciones diferentes. Aquí hay un extracto de la página del manual para el comando man .

MANUAL SECTIONS 
       The standard sections of the manual include: 
       1      User Commands 
       2      System Calls 
       3      C Library Functions 
       4      Devices and Special Files 
       5      File Formats and Conventions 
       6      Games et. Al. 
       7      Miscellanea
       8      System Administration tools and Daemons

Si las páginas del manual de un tema se dividen en diferentes secciones, se puede pasar el número de la sección como un argumento adicional al comando man .

Ejemplo

user@darkstar$ apropos man  
 ... 
makecontext []       (3)  - manipulate user context 
makedev []           (3)  - manage a device number 
man []               (1)  - format and display the on-line manual pages 
man []               (7)  - macros to format man pages 
man []               (7)  - pages - conventions for writing Linux man pages 
man.conf []          (5)  - configuration data for man 
man2html []          (1)  - format a manual page in html 
manuals with []      (7)  - mdoc 

Ahora, si desea leer la página del manual sobre “macros para dar formato a las páginas del manual” en la sección 7, deberá ejecutar el siguiente comando:

user@darkstar$ man 7 man

La Estructura de las paginas de manual

Todas las páginas de manual tienen (o deberían tener) la misma estructura:

  • Nombre
    • Nombre del comando y una breve descripción de su función(es)
  • Sinopsis
    • Una declaración de uso que incluye una lista corta de las opciones
  • Descripción
    • Una explicación detallada del comando.
  • Opciones
    • Explicación detallada de las opciones de línea de comando para el comando.
  • Bugs
    • Bugs conocidos.
  • Autor
    • El autor (es) del paquete y tal vez el autor de la página del manual
  • Ver también
    • Consejos para páginas de manual sobre programas similares o relacionados.

Si uno busca información sobre un tema en lugar de un solo comando, la línea “vea también” es muy interesante.

Buscando dentro de una página de manual

El lector de las páginas de manual es el programa less . Sus combinaciones de teclas son muy similares a las del editor vi.

  • / busca el documento hacia adelante
  • ? Busca el documento al revés
  • n El cursor salta a la siguiente concidencia.

La tecla no tiene un significado especial en los patrones de búsqueda, por lo que es posible buscar (por ejemplo) la opción -k con / - k

Ejemplo

Buscando la opción - h en la página de manual del comando ls con -h nos da

 -h, --human-readable 
              with -l, print sizes in human readable format (e.g., 1K 234M 2G)

Los comandos de navegación son como los de vi:

  • G fin de la página del manual
  • G,G primera linea de la pagina del manual
  • n,G línea n de la página del manual

También se pueden hacer marcas en una línea de la página del manual.

  • M,a los conjuntos marcan a en la línea actual
  • ', a salta para marcar a en la página de manual

Desafortunadamente, estas marcas se pierden al salir de la página de manual (que se realiza con Q).

Formateando una página de manual como documento PDF

Si desea tener una página de manual como documento PDF, puede utilizar el comando:

man -t ls | ps2pdf - > ls-manpage.pdf

que da formato a la página de manual del comando ls en un documento pdf llamado “ls-manpage.pdf”.

Otras lecturas

Para obtener más información, lea la página del manual del comando man y las páginas del manual que se enumeran en “see also”.

Sources


En otros idiomas
Traducciones de esta página?:
QR Code
QR Code es:howtos:general_admin:searching_and_reading_manpages_efficiently (generated for current page)