Vous n'êtes pas identifié(e).
L'icône rouge permet de télécharger chaque page du wiki visitée au format PDF et la grise au format ODT →
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
doc:systeme:man [12/06/2010 17:55] smolski |
doc:systeme:man [15/01/2017 10:25] (Version actuelle) nIQnutn [Remerciement :] |
||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
+ | ====== man ====== | ||
+ | * Objet : man | ||
+ | * Niveau requis : {{tag>débutant avisé}} | ||
+ | * Commentaires : //Manuel d'information des commandes Linux disponibles // | ||
+ | * Débutant, à savoir : [[:doc:systeme:commandes:le_debianiste_qui_papillonne|Utiliser GNU/Linux en ligne de commande, tout commence là !.]] :-) | ||
+ | * Suivi : | ||
+ | * Création par [[user>smolski]] le 12-06-2010 | ||
+ | * Testé le ... 2014 | ||
+ | * Commentaires sur le forum : [[http://debian-facile.org/viewtopic.php?id=2675 | Lien vers le forum concernant ce tuto]]((N'hésitez pas à y faire part de vos remarques, succès, améliorations ou échecs !)) | ||
+ | |||
+ | |||
+ | |||
+ | ===== Syntaxe ===== | ||
+ | |||
+ | Syntaxe : | ||
+ | man <commande> | ||
+ | |||
+ | Remplacer <commande> par la commande dont vous désirez obtenir des informations. | ||
+ | |||
+ | ===== Utilisation ===== | ||
+ | |||
+ | |||
+ | Exemple : | ||
+ | <code user>man cp</code> | ||
+ | |||
+ | Nous obtenons : | ||
+ | |||
+ | <file bash extrait du retour affiché par la commande ci-dessus> | ||
+ | CP(1) Commandes CP(1) | ||
+ | |||
+ | NOM | ||
+ | cp - Copier des fichiers et des répertoires | ||
+ | |||
+ | SYNOPSIS | ||
+ | cp [OPTION]... [-T] SOURCE CIBLE | ||
+ | cp [OPTION]... SOURCE... RÉPERTOIRE | ||
+ | cp [OPTION]... -t RÉPERTOIRE SOURCE... | ||
+ | |||
+ | DESCRIPTION | ||
+ | Copier la SOURCE vers la CIBLE, ou de multiples SOURCEs vers le RÉPER‐ | ||
+ | TOIRE. | ||
+ | |||
+ | Les paramètres obligatoires pour les options de forme longue le sont | ||
+ | aussi pour les options de forme courte. | ||
+ | |||
+ | -a, --archive | ||
+ | identique à -dpR | ||
+ | |||
+ | --backup[=MODE] | ||
+ | archiver chaque fichier cible existant | ||
+ | .../... | ||
+ | </file> | ||
+ | |||
+ | ===== Utilisation ===== | ||
+ | |||
+ | Man est l'interface de consultation des manuels de référence en ligne. | ||
+ | |||
+ | ==== Option man -u ==== | ||
+ | |||
+ | Rafraîchir la base de donnée du man : | ||
+ | <code user>man -u</code> | ||
+ | |||
+ | ==== Option man -f <commande> ==== | ||
+ | |||
+ | Affiche, si elle est disponible, une courte description de la page de manuel de la commande.\\ | ||
+ | Équivalent à whatis.\\ | ||
+ | Voir ''man whatis'' pour obtenir des précisions. | ||
+ | |||
+ | <code user> | ||
+ | man -f man | ||
+ | man (1) - Interface de consultation des manuels de référence en ligne | ||
+ | man (7) - Macros pour la mise en forme des pages de manuel | ||
+ | </code> | ||
+ | |||
+ | Donc, pour l'interface "man" :<code user>man 1 man</code> | ||
+ | Et pour la macro "man" :<code user>man 7 man</code> | ||
+ | |||
+ | ==== Option man -k <mot clef> ==== | ||
+ | |||
+ | Recherche la description courte et le nom des pages de manuel dans lesquelles le ''mot-clé'' a été trouvé. | ||
+ | |||
+ | <code user> | ||
+ | man -k which | ||
+ | which (1) - localise une commande | ||
+ | getcpu (2) - determine CPU and NUMA node on which the calling thread is running | ||
+ | getgrouplist (3) - get list of groups to which a user belongs | ||
+ | lcf (1) - Determine which of the historical versions of a config is installed | ||
+ | pam_exec (8) - PAM module which calls an external command | ||
+ | pam_warn (8) - PAM module which logs all PAM items if called | ||
+ | sched_getcpu (3) - determine CPU on which the calling thread is running | ||
+ | securetty (5) - file which lists ttys from which root can log in | ||
+ | URI::WithBase (3pm) - URIs which remember their base | ||
+ | </code> | ||
+ | |||
+ | ==== man [1-8] ==== | ||
+ | |||
+ | Le tableau ci-dessous indique le numéro des sections de manuel ainsi que le type de pages qu’elles contiennent. | ||
+ | ^ Num ^ Description ^ | ||
+ | | 1 | Programmes exécutables ou commandes de l’interpréteur de commandes (shell).| | ||
+ | | 2 | Appels système (Fonctions fournies par le noyau).| | ||
+ | | 3 | Appels de bibliothèque (fonctions fournies par les bibliothèques des programmes).| | ||
+ | | 4 | Fichiers spéciaux (situés généralement dans /dev).| | ||
+ | | 5 | Formats des fichiers et conventions. Par exemple /etc/passwd.| | ||
+ | | 6 | Jeux.| | ||
+ | | 7 | Divers (y compris les macropaquets et les conventions). Par exemple, man(7), groff(7).| | ||
+ | | 8 | Commandes de gestion du système (généralement réservées au superutilisateur).| | ||
+ | | 9 | Sous-programmes du noyau [hors standard].| | ||
+ | |||
+ | === Exemple : === | ||
+ | |||
+ | <code user>man -f cpgr | ||
+ | cpgr (8) - copy with locking the given file to the password or group file.</code> | ||
+ | Le chiffre ''(8)'' indique que la commande ''cpgr'' est réservée à l'usage de root, le super-utilisateur (administrateur) du système. | ||
+ | |||
+ | ==== Conventions pour écrire des "man-pages" ==== | ||
+ | <code user>man man-pages</code> | ||
+ | |||
+ | ==== Astuce ==== | ||
+ | |||
+ | === man pages non traduites : === | ||
+ | |||
+ | Visualiser une "man page" dans sa version non traduite peut permettre d'éviter les erreurs de traductions, d'interprétations et les omissions.\\ | ||
+ | |||
+ | La ligne de commande suivante vous permettra de visualiser la page ''man'' de la commande ''locale'' dans la langue par défaut de votre installation. | ||
+ | <code user>man locale</code> | ||
+ | <file bash extrait du retour de la commande ci-dessus> | ||
+ | LOCALE(1) Debian GNU/Linux LOCALE(1) | ||
+ | |||
+ | NOM | ||
+ | locale - Récupérer des informations des paramètres régionaux | ||
+ | |||
+ | SYNOPSIS | ||
+ | locale [ -a | -m] | ||
+ | |||
+ | locale [ -ck ] nom... | ||
+ | |||
+ | DESCRIPTION | ||
+ | Le programme locale affiche des informations pour la localisation (NdT : la localisation est aussi appelée paramètres | ||
+ | régionaux, ou « locale » en anglais) en cours, ou pour toutes les localisations, sur la sortie standard. | ||
+ | ... | ||
+ | </file> | ||
+ | La ligne de commande suivante vous permettra de visualiser la page ''man'' de la commande ''locale'' dans sa version et sa langue originale (POSIX). | ||
+ | <code user>man -L C locale</code> | ||
+ | <file bash extrait du retour de la commande ci-dessus> | ||
+ | LOCALE(1) Debian GNU/Linux LOCALE(1) | ||
+ | |||
+ | NAME | ||
+ | locale - Get locale-specific information. | ||
+ | |||
+ | SYNOPSIS | ||
+ | locale [ -a | -m] | ||
+ | |||
+ | locale [ -ck ] name... | ||
+ | |||
+ | DESCRIPTION | ||
+ | The locale program writes information about the current locale environment, or all locales, to standard output. | ||
+ | .... | ||
+ | </file> | ||
+ | |||
+ | |||
+ | ===== Pages man en couleur ===== | ||
+ | Pour pouvoir profiter de la coloration syntaxique des pages man, ajoutez ces lignes à la fin de votre fichier **~/.bashrc** ou dans un des scripts qui seront lancés par **~/.bashrc** (par exemple, le fichier **~/.bash_functions**) | ||
+ | <code user>######### pages man en couleur | ||
+ | man() { | ||
+ | env \ | ||
+ | LESS_TERMCAP_mb=$(printf "\e[1;31m") \ | ||
+ | LESS_TERMCAP_md=$(printf "\e[1;38;5;74m") \ | ||
+ | LESS_TERMCAP_me=$(printf "\e[0m") \ | ||
+ | LESS_TERMCAP_se=$(printf "\e[0m") \ | ||
+ | LESS_TERMCAP_so=$(printf "\e[1;44;33m") \ | ||
+ | LESS_TERMCAP_ue=$(printf "\e[0m") \ | ||
+ | LESS_TERMCAP_us=$(printf "\e[1;32m") \ | ||
+ | man "$@" | ||
+ | } | ||
+ | </code> | ||
+ | ===== Version française des pages de manuel ===== | ||
+ | |||
+ | <code root>apt-get install manpages-fr manpages-fr-extra</code> | ||
+ | |||
+ | ===== Remerciement : ===== | ||
+ | |||
+ | Un krô merci à Scott Grannemann et son ouvrage : | ||
+ | * Linux - L'essentiel du code et des commandes - CampusPress | ||