3. Conventions utilisées dans ce manuel

3.1. Conventions typographiques

Exemple formaté Signification
inode Signale un terme technique.
ls -lta Type utilisé pour une commande et ses arguments (voir la section Section 3.2.1, « Synopsis d'une commande »).
un_fichier Type utilisé pour les noms de fichier. Il peut aussi représenter un nom de paquetage RPM.
ls(1) Référence à une page de manuel (aussi appelée page de man). Pour consulter la page correspondante, tapez man 1 ls dans un shell (ou ligne de commande).
$ ls *.pid
Ce style est utilisé pour une copie d'écran texte de ce que vous êtes censé voir à l'écran, comme une interaction utilisateur-ordinateur ou le code source d'un programme.
localhost Données littérales qui ne correspondent généralement pas à une des catégories précédemment définies, comme un mot clé tiré d'un fichier de configuration, par exemple.
OpenOffice.org Désigne le nom des applications. Selon le contexte, une application et la commande qui la représente peuvent être formatées différemment. Par exemple, la plupart des noms de commande s'écrivent en minuscule, alors que les noms d'application commencent par une majuscule.
Fichier Entrée de menu ou label des interfaces graphiques. La lettre soulignée, si présente, indique le raccourci clavier, auquel vous pouvez accéder en appuyant sur la touche Alt et la lettre soulignée.
Once upon a time... Citation en langue étrangère.
Attention ! Type réservé pour les sujets que nous voulons accentuer. Lisez-les à voix haute !
[Note] Note

Cette icône introduit une note. Il s'agit généralement d'une remarque dans le contexte courant pour donner une information complémentaire.

[Astuce] Astuce

Cette icône introduit une astuce. Il peut s'agir d'un conseil d'ordre général sur la meilleure façon d'arriver à un but spécifique ou une fonctionnalité intéressante qui peut vous rendre la vie plus facile, comme les raccourcis clavier.

[Avertissement] Avertissement

Soyez très attentif lorsque vous rencontrez cette icône. Il s'agit toujours d'informations très importantes sur le sujet en cours de discussion.

3.2. Conventions générales

3.2.1. Synopsis d'une commande

L'exemple ci-dessous présente les symboles que vous rencontrerez lorsque nous décrirons les arguments d'une commande :

commande <argument non littéral> [--option={arg1,arg2,arg3} [argument optionnel...]

Ces conventions étant standardisées, vous les retrouverez en bien d'autres occasions (dans les pages de man, par exemple).

Les signes « < » (inférieur) et « > » (supérieur) indiquent un argument obligatoire qui ne doit pas être recopié tel quel, mais remplacé par votre texte spécifique. Par exemple : <fichier> désigne le nom d'un fichier ; si ce fichier est toto.txt, vous devrez taper toto.txt, et non <toto.txt> ou <fichier>.

Les crochets (« [ ] ») indiquent des arguments optionnels que vous déciderez ou non d'inclure dans la ligne de commande.

Les points de suspension (« ... ») signifient qu'un nombre illimité d'arguments peut être inséré à cet endroit.

Les accolades (« { } ») contiennent les arguments autorisés à cet endroit. Il faudra obligatoirement en insérer un à cet endroit précis.

3.2.2. Notations particulières

De temps à autre, il vous sera demandé d'appuyer sur les touches Ctrl-R. Cela signifie que vous devez maintenir la touche Ctrl enfoncée pendant que vous appuyez sur la touche R. Il en va de même pour les touches Alt et Shift.

[Note] Note

Nous utilisons des lettres majuscules pour représenter les touches clavier. Ceci n'implique pas que vous deviez les utiliser en majuscule. Toutefois, dans certaines applications, il est possible que le fait de taper R ou r n'ait pas le même effet. Nous vous le signalerons lorsque ce sera le cas.

De même, à propos des menus, aller sur l'entrée de menu FichierRelire la configuration utilisateur (Ctrl-R) signifie : cliquez sur le label Fichier du menu (généralement en haut et à gauche de la fenêtre) ; puis, sur le menu vertical qui apparaît, cliquez sur Relire la configuration utilisateur. De plus, vous pouvez également utiliser la combinaison de touches Ctrl-R, comme décrit ci-dessus pour arriver au même résultat.

3.2.3. Utilisateurs système génériques

Chaque fois que cela est possible, nous utilisons deux utilisateurs génériques dans nos exemples :

Reine Pingusa reine C'est l'utilisateur par défaut que nous utilisons dans la plupart des exemples de ce manuel.
Pierre Pingus pierre Cet utilisateur peut ensuite être créé par l'administrateur système. Nous l'utilisons quelques fois afin de varier le texte.