Aide et documentation
Table des matières
1 - Les pages man
man = manual
Les pages man sont la documentation intégrée de Linux. Presque toutes les commandes ont une page man.
Utilisation de base
# Afficher le manuel d'une commande
man ls
man cp
man grep
Navigation dans man
Les pages man utilisent less comme pager :
| Touche | Action |
|---|---|
Espace | Page suivante |
b | Page précédente |
/texte | Rechercher |
n | Occurrence suivante |
q | Quitter |
h | Aide |
Structure d'une page man
LS(1) User Commands LS(1)
NAME
ls - list directory contents
SYNOPSIS
ls [OPTION]... [FILE]...
DESCRIPTION
List information about the FILEs...
OPTIONS
-a, --all
do not ignore entries starting with .
-l use a long listing format
...
EXAMPLES
ls -la
List all files in long format
SEE ALSO
dir(1), vdir(1)
Sections des pages man
| Section | Contenu |
|---|---|
| NAME | Nom et description courte |
| SYNOPSIS | Syntaxe d'utilisation |
| DESCRIPTION | Description détaillée |
| OPTIONS | Liste des options |
| EXAMPLES | Exemples d'utilisation |
| FILES | Fichiers associés |
| SEE ALSO | Commandes liées |
| BUGS | Bugs connus |
| AUTHOR | Auteur(s) |
Sections du manuel
Les pages man sont organisées en sections :
| Section | Contenu |
|---|---|
| 1 | Commandes utilisateur |
| 2 | Appels système |
| 3 | Fonctions de bibliothèque |
| 4 | Fichiers spéciaux |
| 5 | Formats de fichiers |
| 6 | Jeux |
| 7 | Divers |
| 8 | Commandes d'administration |
# Accéder à une section spécifique
man 5 passwd # Format du fichier /etc/passwd
man 1 passwd # Commande passwd
# Voir toutes les sections disponibles
man -f passwd
# ou
whatis passwd
Rechercher dans le manuel
# Rechercher par mot-clé
man -k copy
man -k "list files"
# Équivalent avec apropos
apropos copy
apropos network
man -k est très utile quand vous ne connaissez pas le nom exact d'une commande !
🔝 Retour à la table des matières
2 - L'option --help
Presque toutes les commandes acceptent --help pour afficher une aide rapide.
Utilisation
# Aide rapide
ls --help
cp --help
grep --help
# Forme courte (parfois disponible)
ls -h
Différence avec man
| Aspect | man | --help |
|---|---|---|
| Détail | Complet | Résumé |
| Navigation | Paginé (less) | Affiché d'un coup |
| Exemples | Souvent présents | Rarement |
| Rapidité | Plus lent | Plus rapide |
Exemple de sortie --help
$ mkdir --help
Usage: mkdir [OPTION]... DIRECTORY...
Create the DIRECTORY(ies), if they do not already exist.
Mandatory arguments to long options are mandatory for short options too.
-m, --mode=MODE set file mode (as in chmod), not a=rwx - umask
-p, --parents no error if existing, make parent directories as needed
-v, --verbose print a message for each created directory
--help display this help and exit
--version output version information and exit
Quand utiliser quoi ?
| Situation | Utiliser |
|---|---|
| Rappel rapide des options | --help |
| Comprendre en détail | man |
| Chercher une commande | man -k |
| Exemples d'utilisation | man |
🔝 Retour à la table des matières
3 - La commande info
info est un système de documentation alternatif, plus structuré que man.
Utilisation
info ls
info coreutils
info bash
Navigation dans info
| Touche | Action |
|---|---|
Espace | Page suivante |
Backspace | Page précédente |
Tab | Lien suivant |
Enter | Suivre un lien |
u | Remonter d'un niveau |
n | Nœud suivant |
p | Nœud précédent |
q | Quitter |
? | Aide |
Caractéristiques
- Documentation plus détaillée que man
- Format hypertexte avec liens
- Principalement pour les outils GNU
- Structure hiérarchique
info est moins utilisé que man au quotidien. Si la page info n'existe pas, info affiche la page man à la place.
🔝 Retour à la table des matières
4 - Documentation en ligne
Sites officiels
| Ressource | URL | Contenu |
|---|---|---|
| Ubuntu Docs | docs.ubuntu.com | Documentation officielle Ubuntu |
| Debian Wiki | wiki.debian.org | Wiki communautaire Debian |
| Arch Wiki | wiki.archlinux.org | Documentation très complète |
| Linux.die.net | linux.die.net/man | Pages man en ligne |
| TLDP | tldp.org | Linux Documentation Project |
Arch Wiki - Une référence
Le Arch Wiki est une excellente ressource, même si vous n'utilisez pas Arch Linux :
- Documentation très détaillée
- Exemples pratiques
- Mise à jour régulière
- Applicable à toutes les distributions
https://wiki.archlinux.org/
Commandes explain
# Installer tldr (pages simplifiées)
sudo apt install tldr
# Utiliser tldr
tldr tar
tldr grep
tldr find
# Mise à jour de la base
tldr --update
tldr vs man
# man tar (très long et complexe)
man tar
# tldr tar (exemples pratiques)
tldr tar
Exemple de sortie tldr :
tar
Archiving utility.
More information: https://www.gnu.org/software/tar
- Create an archive from files:
tar cf target.tar file1 file2 file3
- Create a gzipped archive:
tar czf target.tar.gz file1 file2 file3
- Extract an archive:
tar xf source.tar
Installez tldr ! C'est un complément idéal à man pour avoir des exemples pratiques rapidement.
🔝 Retour à la table des matières
5 - Communauté et forums
Forums et Q&A
| Site | URL | Spécialité |
|---|---|---|
| Stack Overflow | stackoverflow.com | Programmation |
| Unix & Linux SE | unix.stackexchange.com | Questions Linux/Unix |
| Ask Ubuntu | askubuntu.com | Questions Ubuntu |
| Server Fault | serverfault.com | Administration système |
| Reddit r/linux | reddit.com/r/linux | Communauté Linux |
Comment poser une bonne question
- Recherchez d'abord : votre question a probablement déjà une réponse
- Soyez précis : décrivez exactement le problème
- Donnez le contexte : version d'OS, commandes utilisées
- Montrez ce que vous avez essayé
- Incluez les messages d'erreur complets
Template de question
## Environnement
- OS : Ubuntu 22.04
- Version : Linux 5.15.0
## Problème
Je veux [objectif] mais j'obtiens [problème]
## Ce que j'ai essayé
1. Commande 1 : `xxx`
Résultat : ...
2. Commande 2 : `yyy`
Résultat : ...
## Message d'erreur
[message complet]
Ressources d'apprentissage
| Type | Ressources |
|---|---|
| Cours gratuits | Linux Journey, Linuxize |
| Cours payants | Linux Foundation, A Cloud Guru |
| Vidéos | YouTube, Udemy |
| Livres | "The Linux Command Line", "LPIC-1 Study Guide" |
Certifications Linux
| Certification | Niveau | Éditeur |
|---|---|---|
| Linux Essentials | Débutant | LPI |
| LPIC-1 | Intermédiaire | LPI |
| LPIC-2 | Avancé | LPI |
| RHCSA | Intermédiaire | Red Hat |
| RHCE | Avancé | Red Hat |
🔝 Retour à la table des matières
Points clés à retenir
man commande= documentation complètecommande --help= aide rapideman -k mot= rechercher une commande- Arch Wiki = excellente documentation pour tous
tldr= exemples pratiques simplifiés- Stack Exchange = Q&A de qualité
- Toujours rechercher avant de demander
🔝 Retour à la table des matières
← Chapitre précédent | Chapitre suivant : Exercices récapitulatifs →