Blog ENI : Toute la veille numérique !
-25€ dès 75€ sur les livres en ligne, vidéos... avec le code FUSEE25. J'en profite !
Accès illimité 24h/24 à tous nos livres & vidéos ! 
Découvrez la Bibliothèque Numérique ENI. Cliquez ici
  1. Livres et vidéos
  2. Linux
  3. Documentation
Extrait - Linux Principes de base de l'utilisation du système (8e édition)
Extraits du livre
Linux Principes de base de l'utilisation du système (8e édition) Revenir à la page d'achat du livre

Documentation

Introduction

Ce chapitre donne les moyens au lecteur d’aller plus loin et de trouver des informations ne figurant pas dans cet ouvrage ; savoir rechercher dans la documentation augmente fortement l’autonomie des utilisateurs.

Il est théoriquement possible de retrouver toutes les informations exposées ici dans la documentation GNU/Linux fournie avec le système.

Manuel

Un manuel électronique est installé avec la plupart des distributions GNU/Linux. 

1. Sections

Ce manuel traite de différents points comme les commandes et leurs syntaxes, les fichiers de configuration système, les bibliothèques standards de programmation...

À cette fin, le manuel est divisé en neuf sections principales :

  • Section 1 : commandes utilisateur ;

  • Section 2 : appels système ;

  • Section 3 : bibliothèques de programmation (libc, Perl, SSL, Tcl) ;

  • Section 4 : fichiers spéciaux et périphériques ;

  • Section 5 : fichiers de configuration, formats et conventions ;

  • Section 6 : jeux ;

  • Section 7 : divers ;

  • Section 8 : commandes d’administration ;

  • Section 9 : routines noyau.

La section 1 et la section 8, qui décrivent l’ensemble des commandes disponibles sous GNU/Linux, sont les plus importantes.

2. Commande man

L’appel d’une page du manuel se fait en lançant la commande man et en spécifiant, en argument sur la ligne de commande, le terme recherché. Ce terme correspond au nom de la commande, du fichier ou encore de la bibliothèque de programmation pour lesquels on recherche des informations.

Ainsi, pour afficher la page de manuel concernant la commande finger vue précédemment :

$ man finger 

La page suivante apparaît :

FINGER(1)                Manuel de reference UNIX                  FINGER(1) 
 
NOM 
       finger - Rechercher des informations sur un utilisateur. 
 
SYNOPSIS 
       finger [-lmsp] [user ...] [user@host ...] 
 
DESCRIPTION 
       finger affiche des informations sur les utilisateurs. 
 
       Options: 
 
       -s    Finger affiche le nom de login, le nom réel, le terminal et 
             l'autorisation d'écriture (" * " signifie...

Documentation Info

1. Commande info

La commande info est un outil regroupant sensiblement les mêmes informations que celles contenues dans les pages de manuel. Son principal avantage, par rapport à man, est de présenter les données de façon hiérarchique et reliées entre elles.

Pour accéder à la documentation "Info", il suffit d’invoquer la commande info :

$ info 

L’affichage suivant apparaît :

File: dir,       Node: Top,       This is the top of the INFO tree. 
 
This is the Info main menu (aka directory node). 
A few useful Info commands: 
  'q' quits; 
  'H' lists all Info commands; 
  'h' starts the Info tutorial; 
  'mTexinfo RET' visits the Texinfo manual, etc. 
 
* Menu: 
 
Archiving 
* Cpio: (cpio).                 Copy-in-copy-out archiver to tape or disk. 
* Tar: (tar).                   Making tape (or disk) archives. 
 
Basics 
* Common options: (coreutils)Common options. 
* Coreutils: (coreutils).       Core GNU (file, text, shell) utilities. 
* Date input formats: (coreutils)Date input formats. 
* File permissions: (coreutils)File permissions. 
                                Access modes. 
* Finding files: (find).        Operating on files matching certain criteria. 
-----Info: (dir)Top, 282 lines --Top----------------------------------------------- 
Welcome to Info version 6.4.  Type H for help, h for tutorial.File: dir       Node: 

Nous sommes ici à la racine de la hiérarchie (File: dir) et des liens (précédés par le caractère *) pointent vers les différents nœuds des fichiers de la documentation "Info".

Un nœud peut être considéré comme un chapitre...

Option --help des commandes sous Linux

En plus des pages de manuel et de la documentation "Info" que nous venons de voir, les commandes GNU que l’on retrouve sous Linux acceptent habituellement l’option --help.

Les commandes invoquées avec cette option retournent une aide succincte décrivant la syntaxe générale de la commande et les options les plus utilisées ; par exemple :

$ wc --help 
Usage: wc [OPTION]... [FICHIER]... 
   ou: wc [OPTION]... --reference=FICHIER-R FICHIER... 
Afficher le décompte d'octets, de mots et de nouvelles lignes pour  
chaque FICHIER et le nombre total de ligne si plus d'un FICHIER est  
spécifié. 
Sans FICHIER, ou quand FICHIER est -, lire de l'entrée standard. 
  -c, --bytes            afficher le nombre d'octets 
  -m, --chars            afficher le nombre de caractères 
  -l, --lines            afficher le nombre de nouvelles lignes 
      --files0-from=F    read input from the files specified by 
                           NUL-terminated...

Documentation HOWTO

D’une autre manière, les documents HOWTOs apportent une mine d’informations à l’utilisateur désireux de maîtriser le système d’exploitation sur lequel il travaille.

Ces documents de plusieurs pages portent sur des sujets spécifiques tels que l’impression sous Linux, la configuration réseau du système ou encore la gestion des périphériques SCSI.

Il existe également d’autres documents nommés "mini HOWTOs", plus succincts que les autres HOWTOs.

Pour ne citer qu’un seul de ces documents, le HOWTO Index recense tous les HOWTOs existants en les classant par catégories et en donnant une description rapide de chacun.

Ces fichiers sont disponibles dans différents formats :

.txt

Fichiers au format texte.

.ps

Fichiers PostScript imprimables directement sur les imprimantes reconnaissant ce format.

.pdf

Fichiers au format Adobe PDF pouvant être lus avec l’outil xpdf sous l’interface graphique.

.html

Pages HTML lisibles à partir de n’importe quel navigateur web.

.tex et .dvi

Formats de fichiers associés aux outils de mise en page et de publication TeX et LaTeX.

Lorsqu’ils sont installés sur la machine, ils se situent généralement dans le répertoire /usr/share/doc/HOWTO. Mais dans ce cas, la place occupée n’est pas négligeable....

/usr/share/doc

En sus de toute la documentation vue précédemment, les développeurs et éditeurs de logiciels fournissent généralement un ensemble complet de documents décrivant leur œuvre.

Cette documentation est placée dans des sous-répertoires de /usr/share/doc/ :

[nicolas]$ ls /usr/share/doc 
aajohan-comfortaa-fonts 
aalib-libs 
abattis-cantarell-fonts 
abrt 
abrt-dbus 
abrt-java-connector 
accountsservice 
adwaita-qt4 
alsa-lib 
alsa-plugins-pulseaudio 
alsa-utils 
apr 
apr-util 
argyllcms 
at 
... 

À l’instar des HOWTOs, les fichiers apparaissent sous différents formats ; par exemple :

[nicolas]$ pwd 
/usr/share/doc 
[nicolas]$ ls pam 
html Linux-PAM_SAG.txt rfc86.0.txt txts 
[nicolas]$ ls iproute 
README         README.distribution README.lnstat 
README.decnet  README.iproute2+tc 

Internet

1. Sites

Internet étant une immense source d’informations, voici une petite sélection de sites relatifs aux systèmes GNU/Linux.

Généralistes

https://www.gnu.org/home.fr.html

  • Titre : GNU’s Not Unix

  • Langue : multilingue

  • Description : site officiel du projet GNU.

https://tldp.org

  • Titre : The Linux Documentation Project

  • Langue : multilingue

  • Description : site officiel regroupant toute la documentation Linux à jour : HOWTOs, guides, FAQ, pages de manuel...

Éditeurs

https://www.redhat.com/fr

  • Titre : Red Hat France

  • Langue : français

  • Description : éditeur des distributions Red Hat Enterprise.

https://getfedora.org

  • Titre : Fedora

  • Langue : multilingue

  • Description : site officiel du projet Fedora.

https://www.debian.org

  • Titre : Debian

  • Langue : multilingue

  • Description : éditeur de la distribution du même nom.

https://www.suse.com/fr-fr

  • Titre : SUSE

  • Langue : multilingue

  • Description : éditeur des distributions SUSE Linux.

https://fr.opensuse.org

  • Titre : openSUSE France

  • Langue : français

  • Description : site de la distribution libre openSUSE.

https://www.ubuntu.com/

  • Titre : Ubuntu

  • Langue : anglais

  • Description : éditeur de la distribution du même nom.

2. Groupes de discussion

Parmi tous...

Exercices

Exercice 1

Consultez la page de manuel des commandes déjà abordées dans les chapitres précédents.

Solution

Exécutez la commande man avec en argument le nom de la commande pour laquelle vous souhaitez voir la page de manuel.

Exercice 2

Rendez-vous sur le site web The Linux Documentation Project et consultez les index des différents types de documentations proposés.

Solution

Rendez-vous avec votre navigateur web à l’adresse https://tldp.org :

site web The Linux Documentation Project