Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
man [Le 10/01/2010, 00:51]
Ban Ajout des tags aide et manuel + lien vers Yelp
man [Le 02/08/2023, 16:04] (Version actuelle)
77.204.198.82
Ligne 1: Ligne 1:
-{{tag>​console terminal shell aide manuel BROUILLON}}+{{tag>​console terminal shell}}
 ----- -----
  
 ====== Le manuel ====== ====== Le manuel ======
  
-**man**((qui abrège **man**uel, en anglais **man**ual)) est une commande UNIX permettant d'​accéder aux pages de manuel installées sur le système.+**who**((qui abrège **man**uel, en anglais **man**ual)) est une commande UNIX permettant d'​accéder aux pages de manuel installées sur le système.
 La plupart des programmes fournissent une page de manuel les documentant,​ lisible donc avec la commande ''​man''​. La plupart des programmes fournissent une page de manuel les documentant,​ lisible donc avec la commande ''​man''​.
  
 ===== Installation ===== ===== Installation =====
-Aucune installation n'est nécessaire,​ man est installé par défaut sous Ubuntu ​(toutes versions). Vous pouvez cependant ajouter des pages de manuel supplémentaires en [[:​tutoriel:​comment_installer_un_paquet|installant le paquet]] correspondant.+Aucune installation n'est nécessaire,​ man est installé par défaut sous Ubuntu. Vous pouvez cependant ajouter des pages de manuel supplémentaires en [[:​tutoriel:​comment_installer_un_paquet|installant le paquet]] correspondant.
  
 ==== Pages de manuel supplémentaires ==== ==== Pages de manuel supplémentaires ====
-  * **[[apt://​manpages-fr|manpages-fr]]** :​ Version française des pages de manuel sur l'​utilisation de GNU/Linux+  * **[[apt://​manpages-fr|manpages-fr]]** :​ Version française des pages de manuel sur l'​utilisation de %%GNU/Linux%%
   * **[[apt://​manpages-fr-extra|manpages-fr-extra]]** :​ Version française des pages de manuel des programmes   * **[[apt://​manpages-fr-extra|manpages-fr-extra]]** :​ Version française des pages de manuel des programmes
-  * **[[apt://​manpages|manpages]]** : Pages de manuel (en anglais) sur l'​utilisation de GNU/Linux+  * **[[apt://​manpages|manpages]]** : Pages de manuel (en anglais) sur l'​utilisation de %%GNU/Linux%%
   * **[[apt://​manpages-posix|manpages-posix]]** : Pages de manuel (en anglais) sur l'​utilisation des systèmes POSIX   * **[[apt://​manpages-posix|manpages-posix]]** : Pages de manuel (en anglais) sur l'​utilisation des systèmes POSIX
 === Pour le développeur === === Pour le développeur ===
Ligne 21: Ligne 21:
 === Autres === === Autres ===
   * **[[apt://​funny-manpages|funny-manpages]]** : Pages de manuel humoristiques (en anglais)   * **[[apt://​funny-manpages|funny-manpages]]** : Pages de manuel humoristiques (en anglais)
 +  * [[https://​github.com/​srsudar/​eg]] : complément à man : permet de donner des exemples d'​usage utiles pour les commandes usuels
 ===== Utilisation ===== ===== Utilisation =====
  
 ''​man''​ s'​utilise dans un [[terminal]] de la façon suivante : ''​man''​ s'​utilise dans un [[terminal]] de la façon suivante :
-  ​man nom-de-la-page+ <​code>​man nom-de-la-page</​code>​
 Par exemple, pour obtenir le manuel de la commande ''​man'',​ l'on fera : Par exemple, pour obtenir le manuel de la commande ''​man'',​ l'on fera :
-  ​man man+<​code>​man man</​code>​
  
 ==== Les sections ==== ==== Les sections ====
Ligne 46: Ligne 46:
   man 7 man   man 7 man
  
-Chaque section possède de plus une page appelée ''​intro''​ qui présente la section, accessible comme les autres pages de manuel. Pour lire l'​introduction de la section 3, il suffit donc de saisir : +Chaque section possède de plus une page appelée ''​intro''​ qui présente la section, accessible comme les autres pages de manuel. Pour lire l'​introduction de la section 3, il suffit donc de saisir dans un [[:terminal]]: <​code>​man 3 intro</​code>​
-  ​man 3 intro+
  
 ==== Options utiles ==== ==== Options utiles ====
  
-  * **-L LANGUE** : permet de spécifier la [[wpfr>​Paramètres régionaux|locale]] pour laquelle afficher la page de manuel. Cette locale est par défaut celle du système.\\ Par exemple, afficher la page de manuel de [[man]] en anglais : <​code>​man -L en man</​code>​ +  * **-L //locale//** : permet de spécifier la [[wpfr>​Paramètres régionaux|locale]] pour laquelle afficher la page de manuel. Cette locale est par défaut celle du système.\\ Par exemple, afficher la page de manuel de [[man]] en anglais : <​code>​man -L en man</​code>​ 
-  * **-s SECTION** : permet de spécifier la ou les sections où chercher, dans l'​ordre,​ les pages de manuel. ​SECTION ​est un numéro de section ou une liste de numéros de sections séparées par des virgules.\\ Exemple :<​code>​man -s 3 printf</​code>​+  * **-s //section//** : permet de spécifier la ou les sections où chercher, dans l'​ordre,​ les pages de manuel. ​//​section// ​est un numéro de section ou une liste de numéros de sections séparées par des virgules.\\ Exemple :<​code>​man -s 3 printf</​code>​
  
 ==== Interactivité ==== ==== Interactivité ====
  
-Lorsque une page de manuel est affichée, diverses actions sont accessibles via des raccourcis claviers dont voici un court extrait((Certaines commandes comme ''?''​ ou ''​N''​ ne sont disponibles qu'​avec certains //​pageurs//​. Néanmoins, le //pageur// par défaut devrait les supporter.)) :​+Lorsque une page de manuel est affichée, diverses actions sont accessibles ​//via// des raccourcis claviers dont voici un court extrait((Certaines commandes comme ''?''​ ou ''​N''​ ne sont disponibles qu'​avec certains //​pageurs//​. Néanmoins, le //pageur// par défaut devrait les supporter.)) :​
 ^ Raccourci ^ Action ^ ^ Raccourci ^ Action ^
-| q         ​| Quitte | +flèches directionnelles | Navigation dans la page de manuel | 
-| h         ​| Affiche l'aide | +| ''​q'' ​                  | Quitte | 
-| /         ​| Rechercher en avant. Entrez le //pattern// à recherchez et validez avec la touche entrée | +''​h'' ​                  | Affiche l'aide | 
-| ?         ​| Comme /, mais recherche en arrière | +''​/'' ​                  | Rechercher en avant. Entrez le //pattern// à recherchez et validez avec la touche entrée | 
-| n         ​| Va à l'​occurrence suivante de la recherche | +''​?'' ​                  | Comme ''​/''​, mais recherche en arrière | 
-| N         ​| Va à l'​occurrence précédente de la recherche |+''​n'' ​                  | Va à l'​occurrence suivante de la recherche | 
 +''​N'' ​                  | Va à l'​occurrence précédente de la recherche |
  
 +==== Man en couleur ====
 +
 +Par défaut, man utilise le programme **less** pour afficher les pages. **less** ne gère pas la couleur, on peut y palier en utilisant un autre "​pager",​ **most**. Pour cela :
 +  *  [[:​tutoriel/​comment_installer_un_paquet#​installer_un_paquet_present_dans_les_depots_recommande|Installer le paquet]] : **[[apt>​most]]** ​
 +  * Insérer dans votre fichier ''​.bashrc''​ la ligne: <​file>​export MANPAGER=most</​file>​
 +Ou mieux utiliser: <​code>​sudo update-alternatives --config pager</​code>​ et choisir le numéro de la ligne contenant most
 +===== Rechercher une page de manuel =====
 +
 +**man** affiche la page de manuel demandée, mais encore faut-il connaître son nom. Que faire si vous ne connaissez qu'un mot-clé du manuel que vous recherchez ?​ C'est ici que les commandes **whatis**((littéralement « qu'​est-ce que »)) (recherche sur les noms de page) et **apropos**((lisez « À propos »)) (recherche sur les noms et les descriptions),​ utilitaires fournis avec **man**, interviennent :​ elles permettent d'​effectuer rapidement une recherche à l'aide d'un mot clé, avec ou sans [[wpfr>​métacaractère|jokers]],​ ou bien à l'aide d'une [[wpfr>​expression rationnelle]]. Le comportement par défaut de **whatis** est d'​utiliser la recherche par mot-clé sans joker, et celui de **apropos** est d'​utiliser les expressions rationnelles.
 +
 +Exemples d'​utilisation :​
 +<​code>​
 +vous@machine:​~$ whatis whatis
 +whatis (1)           - Affiche la description des pages de manuel
 +vous@machine:​~$ apropos apropos
 +apropos (1)          - cherche le nom et la description des pages de manuel
 +</​code>​
 +
 +Vous pouvez consulter les [[man|pages de manuel]] de **whatis** et d'​**apropos** pour de plus amples explications sur leurs options.
  
 ===== Consulter les pages de manuel dans une interface graphique ===== ===== Consulter les pages de manuel dans une interface graphique =====
Ligne 70: Ligne 89:
 ==== Sous GNOME (Ubuntu) ==== ==== Sous GNOME (Ubuntu) ====
  
-Le [[yelp|navigateur d'aide]] de [[GNOME]] permet de parcourir la documentation du système, dont les pages de manuel. Pour ce faire, ouvrez l'aide //via// //Système → Aide// ​de cliquez sur « Pages de manuel » ​dans la colonne de gauche. +Le [[yelp|navigateur d'aide de GNOME]] permet de parcourir la documentation du système, dont les pages de manuel. Pour ce faire, ouvrez l'aide //via// //Système → Aide et soutien//cliquez sur //Rubriques avancées// ​dans la colonne de gauche ​et enfin sur //​Références des commandes du terminal (pages de manuel)//. Vous pouvez ​alors parcourir les pages de manuel par catégories. Vous les retrouverez ​aussi en effectuant ​une recherche dans toute la documentationdans le menu //Édition → Rechercher//​.\\ 
- +Il est également possible d'​ouvrir directement une page de manuel dans le [[:​yelp|navigateur d'aide de]] [[:GNOME]] en exécutant dans un [[:​terminal]] cette commande: 
-Vous pouvez aussi simplement effectuer ​une recherche dans toute la documentation ​en allant ​dans le menu //Édition → Rechercher//​.+<​code>​yelp man:​nom-de-la-page</​code>​
  
 +[[Firefox]] gère les URI de la forme ''​man://​nom-de-la-page//''​ et propose l'​ouverture avec le navigateur d'aide [[GNOME]]. Ceci fonctionne aussi [[#​sous_xfce_xubuntu|sous Xubuntu]].
 +<note tip> Depuis au moins la version 17.04 l'​accès aux pages man d'​Ubuntu ou Ubuntu Gnome n'est plus possible depuis l'aide générale, seule la deuxième méthode <​code>​yelp man:​nom-de-la-page</​code>​ fonctionne.
 +</​note>​
 ==== Sous KDE (Kubuntu) ==== ==== Sous KDE (Kubuntu) ====
-FIXME+ 
 +Le [[khelpcenter|navigateur d'aide de KDE]] permet de parcourir la documentation du système, dont les pages de manuel. Pour ce faire, ouvrez l'aide //via// //Menu K → Applications → Aide//,​ puis choisissez //Pages de manuel UNIX// dans la panneau //​Contenus//​ ;​ vous pouvez alors parcourir les pages de manuel par catégories. Vous pouvez aussi effectuer une recherche dans les pages de manuel //via// le champ de recherche. Lors d'une recherche, faites bien attention à ce que //Pages de manuel UNIX// soit bien coché dans la portée de la recherche. 
 + 
 +[[Konqueror]] gère les URI de la forme ''​man://​nom-de-la-page//''​ et les chemins directs tels ''​man:/​usr/​share/​man/​fr/​man1/​man.1.gz'',​ et les affiche directement. 
 + 
 +==== Sous Xfce (Xubuntu) ==== 
 + 
 +Comme [[#​sous_gnome_ubuntu|sous GNOME]], vous pouvez utiliser le [[yelp|navigateur d'​aide]] que vous pouvez lancer //via// ''​Alt+F2''​ puis en tapant ''​yelp''​. 
 + 
 +Comme sous GNOME également, vous pouvez aussi entrer une URI de la forme ''​man://​nom-de-la-page//''​ dans la barre d'​adresse de [[:​Firefox]] qui vous propose alors d'​ouvrir la page de manuel dans le navigateur d'​aide. 
  
 ===== Consulter les pages de manuel sur internet ===== ===== Consulter les pages de manuel sur internet =====
 La plupart des pages de manuel sont aussi disponibles en ligne, sur divers sites dont voici une liste non exhaustive :​ La plupart des pages de manuel sont aussi disponibles en ligne, sur divers sites dont voici une liste non exhaustive :​
-  * [[http://​manpages.ubuntu.com/​|manpages.ubuntu.com]]+  * [[https://​manpages.ubuntu.com/​|manpages.ubuntu.com]]
   * [[http://​manpages.debian.net/​|manpages.debian.net]]   * [[http://​manpages.debian.net/​|manpages.debian.net]]
-  * [[http://​linux.die.net/​man/​|linux.die.net]]+  * [[https://​linux.die.net/​man/​|linux.die.net]]
  
 ===== Sources ===== ===== Sources =====
-  * ''​man man''​+  * <​code>​man man</​code>​
   * Wikipedia [[wpfr>​man (Unix)|fr]],​ [[wp>Man page|en]]   * Wikipedia [[wpfr>​man (Unix)|fr]],​ [[wp>Man page|en]]
 +  * [[https://​www.it-connect.fr/​la-commande-man/​|Utilisation de la commande man]] **(fr)**
 +  * [[http://​www.it-connect.fr/​rechercher-une-commande-installee-sous-linux-a-partir-dun-mot/​|Rechercher une commande installée sous Linux à partir d’un mot]] **(fr)**
  
 ----- -----
 //​Contributeurs principaux :​ [[utilisateurs:​Ban]] (création).//​ //​Contributeurs principaux :​ [[utilisateurs:​Ban]] (création).//​
  • man.1263081061.txt.gz
  • Dernière modification: Le 10/01/2010, 00:51
  • par Ban