Aller au contenu principal

Aide et documentation


Table des matières

  1. Les pages man
  2. L'option --help
  3. La commande info
  4. Documentation en ligne
  5. Communauté et forums


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

Les pages man utilisent less comme pager :

ToucheAction
EspacePage suivante
bPage précédente
/texteRechercher
nOccurrence suivante
qQuitter
hAide

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

SectionContenu
NAMENom et description courte
SYNOPSISSyntaxe d'utilisation
DESCRIPTIONDescription détaillée
OPTIONSListe des options
EXAMPLESExemples d'utilisation
FILESFichiers associés
SEE ALSOCommandes liées
BUGSBugs connus
AUTHORAuteur(s)

Sections du manuel

Les pages man sont organisées en sections :

SectionContenu
1Commandes utilisateur
2Appels système
3Fonctions de bibliothèque
4Fichiers spéciaux
5Formats de fichiers
6Jeux
7Divers
8Commandes 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
astuce

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

Aspectman--help
DétailCompletRésumé
NavigationPaginé (less)Affiché d'un coup
ExemplesSouvent présentsRarement
RapiditéPlus lentPlus 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 ?

SituationUtiliser
Rappel rapide des options--help
Comprendre en détailman
Chercher une commandeman -k
Exemples d'utilisationman

🔝 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
ToucheAction
EspacePage suivante
BackspacePage précédente
TabLien suivant
EnterSuivre un lien
uRemonter d'un niveau
nNœud suivant
pNœud précédent
qQuitter
?Aide

Caractéristiques

  • Documentation plus détaillée que man
  • Format hypertexte avec liens
  • Principalement pour les outils GNU
  • Structure hiérarchique
remarque

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

RessourceURLContenu
Ubuntu Docsdocs.ubuntu.comDocumentation officielle Ubuntu
Debian Wikiwiki.debian.orgWiki communautaire Debian
Arch Wikiwiki.archlinux.orgDocumentation très complète
Linux.die.netlinux.die.net/manPages man en ligne
TLDPtldp.orgLinux 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
astuce

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

SiteURLSpécialité
Stack Overflowstackoverflow.comProgrammation
Unix & Linux SEunix.stackexchange.comQuestions Linux/Unix
Ask Ubuntuaskubuntu.comQuestions Ubuntu
Server Faultserverfault.comAdministration système
Reddit r/linuxreddit.com/r/linuxCommunauté Linux

Comment poser une bonne question

  1. Recherchez d'abord : votre question a probablement déjà une réponse
  2. Soyez précis : décrivez exactement le problème
  3. Donnez le contexte : version d'OS, commandes utilisées
  4. Montrez ce que vous avez essayé
  5. 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

TypeRessources
Cours gratuitsLinux Journey, Linuxize
Cours payantsLinux Foundation, A Cloud Guru
VidéosYouTube, Udemy
Livres"The Linux Command Line", "LPIC-1 Study Guide"

Certifications Linux

CertificationNiveauÉditeur
Linux EssentialsDébutantLPI
LPIC-1IntermédiaireLPI
LPIC-2AvancéLPI
RHCSAIntermédiaireRed Hat
RHCEAvancéRed Hat

🔝 Retour à la table des matières



Points clés à retenir

  • man commande = documentation complète
  • commande --help = aide rapide
  • man -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 →