Welcome to the Slackware Documentation Project

Comment Rechercher et Consulter Efficacement les Manpages

Les Manpages sont les pages du Manuel Unix en ligne. J'espère que ce Howto pourra en aider quelques uns plus efficacement, même si je suis conscient que beaucoup de lecteurs sont déjà familiers avec ce sujet.

Recherche une Manpage

Pour rechercher des informations sur quoi que ce soit dans les pages de manuel que vous pouvez utiliser l'une des commandes suivantes:

  • apropos
  • man -k
  • whatis

apropos est juste un alias pour man -k; il n'y a aucune différence entre les deux. La différence entre whatis et les autres commandes est que whatis recherches les mots en entier alors que apropos (ou man -k) recherche une partie du mot.

Si vous ne savez pas exactement comment un mot, par exemple une commande, s'écrit, vous pouvez utiliser à propos . Si vous connaissez l'orthographe exacte du mot à rechercher, whatis sera plus efficace car il retournera moins de lignes.

Exemple

Rechercher des information sur DHCP:

Avec la commande 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

Avec la commande whatis :

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

Les deux commandes sont sensibles à la casse!

Mettre à Jour la Base de Données de ''whatis''

La commande whatis possède sa propre base de données. Les pages de manuel pour tous les paquets de l'installation par défaut de la Slackware sont déjà présents dans la base de données. C'est également vrai si vous mettez à niveau ces paquets. Mais si vous construisez vos propres paquets depuis les sources, par exemple à partir de SlackBuilds.org, les pages de manuel pour ceux-ci ne seront pas présents dans la base de données whatis. Afin de mettre à jour la base de données après l'installation de ces nouveaux paquets, Slackware fournit la commande makewhatis. Elle doit être exécuté en tant que root.

Notez que certaines distributions Linux utilisent la commande mandb pour réaliser cette tâche.

Les Sections dans le Manual

Ne confondez pas ces sections avec les sections au sein de la structure de chaque page de manuel; ils sont décrits dans le paragraphe ci-dessous.

Le manuel manpages est divisé en huit sections différentes. Voici un extrait de la page de manuel pour la commande 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 les pages de manuel pour un sujet sont divisés en différentes sections, on peut passer le numéro de la section comme un argument supplémentaire à la commande man.

Exemple

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 

Maintenant, si vous voulez lire la manpages “macros to format man pages” de la section 7, vous devrez exécuter la commande suivante:

user@darkstar$ man 7 man

Structure des Manpages

Les manpages doivent toutes (ou devraient toute) avoir la même structure:

  • Name
    • Nom de la commande et brève description de sa(ses) fonction(s)
  • Synopsis
    • Condition d'utilisation et liste des options
  • Description
    • Une explication détaillée de la commande
  • Options
    • Une explication détaillée des options de la ligne de commande
  • Bugs
    • Les problèmes connus
  • Author
    • L'auteur(s) du paquet et éventuelelment l'auteur de la manpage
  • See also
    • Conseils de mapages à consulter sur les programmes similaires ou connexes

Si l'on recherche des informations sur un sujet plutôt qu'une commande, la ligne “see also” est très intéressant.

Rechercher à l'Intérieur d'une Manpage

Le lecteur pour les pages de manuel est le programme less. Ses raccourcis clavier sont très similaire à l'éditeur vi.

  • / recherche vers le bas
  • ? recherche vers le haut
  • n recherche l'occurence suivante.

Le caractère n'a pas de signification particulière dans le champ de recherche, il est donc possible de rechercher (par exemple) l'option -k avec /-k

Exemple

Rechercher l'option -h dans la manpage de la commande ls avec -h donne :

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

Parcourir le Contenu d'une Manpage

Les commandes de déplacement sont similaire à celles de vi:

  • G aller à la fin de la manpage
  • G,G aller à la première ligne de la manpage
  • n,G aller à la nième ligne de la manpage

On peut aussi définir des repères à une ligne de la manpage

  • M,a définit un repère dans la ligne active
  • ', a saute au repère dans la manpage

Malheureusement, ces repères sont perdus lorsque vous quittez la manpage (ce qui se fait avec Q).

Formater une Manpage en un Document PDF

Si vous voulez avoir un document PDF d'une manpage, vous pouvez utiliser la commande:

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

ceci qui formatera la manpage de la commande «ls dans un document pdf nommé “ls-manpage.pdf”. ===== Lectures Complémentaires ===== Pour plus d'informations, lisez la manpage pour la commande man'' et les manpages listées dans la section “see also”.

Sources


Autres langues
Traductions de cette page?:
QR Code
QR Code fr:howtos:general_admin:searching_and_reading_manpages_efficiently (generated for current page)