Ou comment éviter le fatidique RTFM[*] :-)
Les sources d'information dans le monde de l'Open Source sont extrêmement nombreuses. Avantage : vous cherchez de l'info, vous allez trouver pléthore de documents. Inconvénient : vous risquez de vous noyer dans toute cette masse, surtout en débutant.
L'objectif du document est de lister les principales sources et d'en donner un mode d'emploi simple.
Sur Linux, vous disposez d'une aide en ligne précieuse sur les commandes et fichiers de configuration. Bien que la présentation en soit rébarbative, il est intéressant de savoir la lire car elle sera disponible même en local, bien utile quand vous ne pouvez pas vous connecter. Son petit nom : le « man », du nom de la commande qui permet de le consulter.
Avant de voir les commandes à votre disposition pour interroger le man d'une commande et le manipuler, nous allons dans un premier temps examiner l'organisation des différentes section de cette aide en ligne puis le contenu des pages..
L'ensemble du man est organisé (si si !) en sections numérotées de 1 à 9 pour les plus courantes :
Lorsque vous interrogez la documentation à propos d'un terme présent dans plusieurs sections (ex : passwd, à la fois commande et fichier de configuration), si vous ne précisez pas le numéro de section, c'est toujours la section de numérotation la moins élevée qui sera affichée.
Chaque page de man est structurée en paragraphes contenant des éléments particuliers. Pour les détailler, nous allons utiliser la page de man de la commande cp (copie de fichiers) et la page de man de passwd (le fichier /etc/passwd).
Maintenant que nous avons vu l'organisation de la documentation et son contenu, voyons les commandes.
Syntaxe :
Le [#organise_man numéro de section] est facultatif.
Exemples :
==> Permet d'afficher la documentation sur la commande cp. Comme la section n'est pas précisée, c'est la section 1 qui sera choisie par défaut
==> Permet d'afficher la documentation sur le fichier passwd dans la section 5 du manuel.
Vous ne connaissez pas exactement le nom de la commande... Dans une certaine mesure, le man vous permet de retrouver la commande ou le fichier : man -k mot-clé
Exemple : je recherche des informations concernant une commande en rapport avec les mots de passe (extrait de la sortie écran).
anne@pingu$ man -k passwd chpasswd (8) - update password file in batch gpasswd (1) - administer the /etc/group file htpasswd (1) - Create and update user authentication files passwd (1) - update a user's authentication tokens(s) passwd (5) - password file smbpasswd (5) - The Samba encrypted password file smbpasswd (8) - change a user's SMB password userpasswd (1) - A graphical tool to allow users to change their passwords ...
Vous obtenez la liste des fichiers et commandes en rapport avec votre mot-clé, ainsi que la section concernée et un bref descriptif.
Déplacement et recherche dans le man : il vous faudra utiliser des touches ou combinaisons de touches particulières pour naviguer dans les pages de man. Vous avez également la possibilité de rechercher des chaines.
Ci-dessous les principales commandes à connaitre :
Voilà pour les principaux éléments à connaître concernant le man. Pour de plus amples informations,
Dernières remarques (et pas des moindres...) :
Exemple : afficher le man de la commande cdrecord
Outre le man, vous disposez d'une autre source d'aide en ligne, la commande info. Il s'agit d'une documentation organisée au moyen de liens d'hypertextes. Vous pouvez y accéder de 2 manières :
Pour se déplacer dans la documentation :
Vous cherchez comment utiliser une commande, sa syntaxe et les différentes options possibles. La plupart des commandes disposent d'une option --help (ou parfois -h) qui s'utilise très simplement : $ commande --help. Exemple : afficher l'aide de la commande cat
$ cat --help Usage: cat [OPTION] [FICHIER]... Concaténer le(s) FICHIER(s), ou de l'ENTRÉE standard, vers la sortie standard. -A, --show-all équivalent à -vET -b, --number-nonblank numéroter que les lignes non vides -e équivalent à -vE -E, --show-ends afficher $ à la fin de chaque ligne -n, --number numéroter toutes les lignes -s, --squeeze-blank afficher jamais plus qu'une seule ligne vide -t équivalent à -vT -T, --show-tabs afficher les caractères TAB comme ^I -u (ignoré) -v, --show-nonprinting utiliser la notation ^ et M- , excepté pour LFD et TAB --help afficher l'aide-mémoire --version afficher le nom et la version du logiciel Sans FICHIER, ou quand le FICHIER est -, lire de l'entrée standard.
Pour tout logiciel ou fonctionnalité installé sur votre machine, vous disposez de documentation fort précieuse sur leur installation, configuration et utilisation. Cette mine d'information est située dans le répertoire /usr/share/doc et plus rarement dans /usr/local/share/doc. Exemple :
$ ls /usr/share/doc alsa-utils-0.9.6/ gnome-system-monitor-2.4.0/ libkrb51-1.3/ apache2-2.0.47/ gnome-telnet-2.4/ liblcms1-1.10/ apache2-common-2.0.47/ gnome-terminal-2.4.0.1/ liblinc1-1.0.3/ ....
Concernant le support du matériel et des différents drivers non matériels sur votre manchot préféré, vous trouverez des informations dans la documentation des sources du noyau : /usr/src/linux/Documentation. Exemple :
BK-usage/ cdrom/ cpu-freq/ cris/ crypto/ cryptoapi/ DocBook/ fb/ filesystems/ firmware_class/ i2c/ i386/ ia64/ input/ ...
Je ne ferai pas ici la liste des documentations en ligne. Vous avez à votre disposition votre moteur de recherche préféré mais aussi le Léannuaire qui se compose de sites proposés par nos visiteurs. Vous disposez également de documents dits "HOWTO" ou "comment faire" en bon français.. Extrêmement nombreux et parfois traduits en français (sisi ! :p), ils constituent une source plutôt complète d'information sur un produit particulier. De nombreux sites les proposent. On citera en particulier Traduc.org, qui a le mérite de proposer une de nombreuses traductions de Howtos.
Il existe tout autour de la planète des groupes d'utilisateurs de logiciels libres. Il y en a sûrement un près de chez vous. Ces groupes réunissent des passionnés qui aiment se retrouver pour parler de Linux et des logiciels libres, et qui sont généralement prêt à aider les autres. Ce serait dommage de ne pas en profiter !
*RTFM : Read The Fucking Manual - couramment utilisé pour conseiller à un débutant de chercher la réponse à ses questions avant de solliciter de l'aide sur un forum ou un canal IRC.
*RTFM : Read The Frenchy Manual - lit la documentation de Léa-Linux (LéaBook), couramment utilisé sur le canal IRC de Léa ;-)
▶ Découvrir Linux, la suite : Choisir une distribution GNU/Linux vous permettra de choisir une distribution adaptée à vos besoins et vos envies.
@ Retour à la rubrique Découvrir Linux
Cette page fut créée par Anne le 08/11/2003. À peine modifié par Jiel en 2009, 2011, 2018.
© 2003 Anne Nicolas
![]() ![]() ![]() |
Ce document est publié sous licence Creative Commons Attribution, Partage à l'identique 4.0 : https://creativecommons.org/licenses/by-sa/4.0/ |