Help:Reading (Français)

From ArchWiki
État de la traduction: Cet article est la version francophone de Help:Reading. Date de la dernière traduction: 2021-12-21. Vous pouvez aider à synchroniser la traduction s'il y a eu des changements dans la version anglaise.

La grande majorité du ArchWiki contient des indications qui peuvent avoir besoin d'être clarifiées pour les utilisateurs novices d'Arch Linux (ou de GNU/Linux en général), ce récapitulatif des procédures de base a été écrit à la fois pour éviter la confusion dans la compréhension des articles et pour éliminer les répétitions dans le contenu lui-même.

Organisation

La plupart des articles sur ArchWiki n'essaient pas de fournir une introduction complète à un sujet ; ils sont plutôt écrits en adhérant au principe DRY, en supposant que l'utilisateur cherchera et lira tout matériel de référence qu'il ne comprend pas encore. Dans la mesure du possible, ces informations sont indiquées dans l'article par un formatage spécial, consultez #Mise en forme.

En raison de cette organisation, il peut être nécessaire d'examiner plusieurs sources connexes afin de comprendre pleinement un article sur ArchWiki. En particulier, les utilisateurs qui sont nouveaux sur Arch (ou GNU/Linux en général) doivent s'attendre à lire un grand nombre d'articles, même pour résoudre des problèmes simples. Il est particulièrement important d'étudier le matériel de référence avant de chercher de l'aide supplémentaire auprès d'autres utilisateurs.

Mise en forme

Utilisateur ou root

Certaines lignes sont écrites comme ceci :

# mkinitcpio -p linux

D'autres ont un préfixe différent :

$ makepkg -s

Le signe dièse (#) indique que la commande doit être exécutée en tant que root (les termes super-utilisateur ou administrateur peuvent aussi être rencontré), tandis que le signe dollar ($) indique que la commande doit être exécutée en tant qu'utilisateur normal.

Note: Les commandes préfixées par # sont destinées à être exécutées à partir d'un shell root, qui peut par exemple être facilement accessible avec sudo -i. Exécuter sudo command à partir d'un shell non privilégié au lieu de command à partir d'un shell «root» fonctionnera également dans la plupart des cas, avec quelques exceptions notables comme les redirections et les substitutions, qui nécessitent strictement un shell racine. Consultez également Sudo.

Une exception notable dont il faut se méfier :

# Cet alias fait en sorte que ls colore la liste.
alias ls='ls --color=auto'.

Dans cet exemple, le contexte entourant le signe numérique indique que l'alias ne doit pas être exécuté comme une commande ; il doit plutôt être édité dans un fichier. Donc, dans ce cas, le signe numérique indique un commentaire. Un commentaire peut être un texte explicatif qui ne sera pas interprété par le programme associé. Il se trouve que la dénotation des scripts Bash pour les commentaires coïncide avec le symbole «root» d'une invite de commande (PS1).

Si on regarde attentivement, les signes annonciateurs sont l'utilisation d'un caractère majuscule à la suite du signe #. Habituellement, les commandes Unix ne sont pas écrites de cette façon et la plupart du temps, il s'agit de courtes abréviations au lieu de mots anglais complets (par exemple, Copy devient cp).

Quoi qu'il en soit, la plupart des articles rendent la chose facile à discerner en avertissant le lecteur :

Ajoutez à ~/path/to/file :

# Cet alias fait en sorte que ls colore la liste.
alias ls='ls --color=auto' (en anglais)

Postposer, ajouter, créer, modifier

Lorsqu'on vous demande d'ajouter à la fin d'un fichier (le terme anglais append désigne un ajout spécifiquement effectué à la fin), d'ajouter (le terme add en anglais indique un ajout sans que sa position dans le fichier ne soit impératif), de créer ou de modifier un ou plusieurs fichiers, il est sous-entendu que vous devez utiliser l'une des méthodes suivantes.

Pour créer ou modifier des fichiers multilignes, il est suggéré d'utiliser un éditeur de texte. Par exemple, l'utilisation de la commande nano pour modifier le fichier /etc/bash.bashrc est la suivante :

# nano /etc/bash.bashrc

Pour créer ou écraser un fichier à partir d'une chaîne, il peut être plus simple d'utiliser les redirections. L'exemple suivant crée ou écrase le contenu du fichier /etc/hostname avec le texte myhostname.

# echo myhostname > /etc/hostname

La redirection de sortie peut également être utilisée pour ajouter une chaîne de caractères à la fin un fichier. L'exemple suivant ajoute le texte [custom-repo] au fichier /etc/pacman.conf.

# echo "[custom-repo]" >> /etc/pacman.conf

Lorsque vous êtes invité à créer des répertoires, utilisez la commande mkdir :

# mkdir /mnt/boot

Rendre exécutable

Après avoir créé un fichier, s'il est destiné à être exécuté en tant que script (manuellement ou appelé par un autre programme), il doit être défini comme exécutable, par exemple avec :

$ chmod +x script.

Consultez chmod. Certaines applications telles que les gestionnaires de fichiers peuvent fournir des interfaces graphiques pour faire la même chose.

Sourcer

Certaines applications, notamment les «shells» en ligne de commandes, utilisent des scripts pour leur configuration : après les avoir modifiés, ils doivent être sourcés pour que les changements soient appliqués. Dans le cas de bash, par exemple, cela se fait en exécutant (vous pouvez également remplacer source par .) :

$ source ~/.bashrc

Lorsque le wiki vous suggérera de modifier un tel script de configuration, il ne vous rappellera pas explicitement de sourcer le fichier et seulement dans certains cas, il vous dirigera vers cette section avec un lien de rappel.

Installation de paquets

Lorsqu'un article vous invite à installer certains paquets de manière conventionnelle, il n'indique pas les instructions détaillées pour le faire, mais mentionne simplement le nom des paquets à installer.

Note: Fréquemment, les liens installer, installez ou installé sont utilisés pour pointer vers cette section de l'article. Cependant, JavaScript doit être activé pour que ces liens fonctionnent.

Les sous-sections ci-dessous donnent un aperçu des procédures d'installation génériques en fonction du type de paquet.

Paquets officiels

Pour les paquets provenant des dépôts officiels, vous lirez quelque chose comme :

Installez le paquet foobar.

Cela signifie que vous devez exécuter :

# pacman -S foobar

L'article pacman contient des explications détaillées pour effectuer la gestion des paquets dans Arch Linux de manière efficace.

Arch User Repository

Pour les paquets provenant de l'Arch User Repository (AUR), vous lirez quelque chose comme :

Installez le paquet foobarAUR.

Cela signifie qu'en général, vous devez suivre le lien foobarAUR, télécharger l'archive PKGBUILD, l'extraire, vérifier le contenu et enfin exécuter, dans le même dossier :

$ makepkg -sri
Note: Le groupe de paquets base-devel est nécessaire pour construire des paquets depuis l'AUR ou avec l'ABS.

L'article Arch User Repository contient toutes les explications détaillées et les meilleures pratiques pour utiliser les paquets AUR.

Contrôle des unités de systemd

Lorsqu'un article invite à démarrer, activer, arrêter ou redémarrer certaines unités systemd (par exemple un service), il n'indiquera pas les instructions détaillées pour le faire, mais vous lirez plutôt quelque chose comme :

Démarrez example.service.

Cela signifie que vous devez exécuter :

# systemctl start exemple.service

Le lien démarrez vous mènera vers l'article systemd, qui contient toutes les explications détaillées pour utiliser les unités de systemd dans Arch Linux de manière efficace.

Note: Les liens démarrez, activez, stoppez, redémarrez... sont des redirections vers des sections spécifiques, qui ne fonctionnent que si JavaScript est activé.

Configuration globale du système ou configuration spécifique à l'utilisateur

Il est important de se rappeler qu'il existe deux types de configurations différentes sur un système GNU/Linux. La configuration système affecte tous les utilisateurs. Étant donné que les configurations à l'échelle du système sont généralement situées dans le répertoire /etc, les privilèges root sont nécessaires pour les modifier. Par exemple, pour appliquer un paramètre Bash qui affecte tous les utilisateurs, il faut modifier /etc/bash.bashrc.

Une configuration spécifique à un utilisateur n'affecte qu'un seul utilisateur. Les Dotfiles sont utilisés pour la configuration spécifique à un utilisateur. Par exemple, le fichier ~/.bashrc est le fichier de configuration spécifique à l'utilisateur. L'idée est que chaque utilisateur puisse définir ses propres paramètres, tels que les alias, les fonctions et autres caractéristiques interactives comme l'invite, sans affecter les préférences des autres utilisateurs.

Note: ~/ et $HOME sont des raccourcis pour le répertoire personnel de l'utilisateur, généralement /home/username/.

Fichiers shell courants

Bash et d'autres interpréteurs de commandes compatibles avec Bourne, tels que Zsh, contiennent également des fichiers sources selon que l'interpréteur de commandes est un interpréteur de commandes de connexion ou un interpréteur de commandes interactif. Consultez Bash#Configuration files et Zsh#Startup/Shutdown files pour plus de détails.

Pseudo-variables dans les exemples de code

Certains blocs de code peuvent contenir des pseudo-variables qui, comme leur nom l'indique, ne sont pas des variables réelles utilisées dans le code. Il s'agit plutôt de substitutions génériques qui doivent être remplacées manuellement par des éléments de configuration spécifiques au système avant que le code ne soit exécuté ou analysé. Les shells courants tels que bash et zsh fournissent une auto-complétion pour compléter automatiquement les paramètres des commandes courantes telles que systemctl.

Dans les articles conformes à Help:Style/Formatting and punctuation, les pseudo-variables sont formatées en italique. Par exemple :

  • Activez le dhcpcd@interface_name.service pour l'interface réseau identifiée à partir de la sortie de la commande ip link.

Dans ce cas, nom_de_l'interface est utilisé comme un substitut de pseudo-variable dans une unité de modèle systemd. Toutes les unités de modèle systemd, identifiables par le signe @, nécessitent un élément de configuration spécifique au système comme argument. Consultez Systemd (Français)#Unité.

  • La commande dd if=data_source of=/dev/sdX bs=sector_size count=sector_number seek=partitions_start_sector peut être exécutée en tant que root pour effacer une partition avec les paramètres spécifiques.

Dans ce cas, les pseudo-variables sont utilisées pour décrire les paramètres qui doivent leur être substitués. Les détails sur la façon de les rassembler sont développés dans la section Securely wipe disk#Calculate blocks to wipe manually, qui présente la commande.

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: Mentionnez d'autres exemples, idéalement issus d'autres catégories de périphériques (par exemple, le stockage), avec des liens vers des articles de fond. Les exemples ont pour but d'éviter de répéter des explications existantes dans d'autres articles. (Discuss in Help talk:Reading)

Dans le cas des exemples de fichiers, coller des pseudo-variables dans des fichiers de configuration réels pourrait casser les programmes qui les utilisent.

Ellipses

Dans la plupart des cas, les ellipses (...) ne font pas partie du contenu réel du fichier ou de la sortie du code, et représentent plutôt du texte omis ou facultatif qui n'est pas pertinent pour le sujet traité.

Par exemple HOOKS="... encrypt ... filesystems ..." ou :

/etc/X11/xorg.conf.d/50-synaptics.conf
Section "InputClass"
    ...
    Option "CircularScrolling" "on"
    Option "CircScrollTrigger" "0"
    ...
EndSection

Sachez cependant que, dans quelques cas, les ellipses peuvent être une partie significative de la syntaxe du code : les utilisateurs attentifs seront capables de reconnaître facilement ces cas par le contexte.