# Conventions dans la documentation

## Convention des Symboles `$` et `#` dans les Commandes Linux

### Introduction

Dans les documentations, tutoriels, et exemples de commandes Linux, vous verrez souvent les symboles `$` et `#` au début des lignes de commande. Ces symboles ne font pas partie de la commande elle-même, mais servent à indiquer dans quel contexte la commande doit être exécutée, que ce soit en tant qu'utilisateur normal ou administrateur (root).

### Symbole `$`

Le symbole `$` est utilisé pour représenter l'invite de commande d'un **utilisateur non-root** (c'est-à-dire un utilisateur sans privilèges administratifs). Cela signifie que la commande peut être exécutée directement par un utilisateur classique.

#### Exemple :

```bash
$ ls -l
```

Dans cet exemple :

- `$` indique que la commande `ls -l` est exécutée par un utilisateur normal.
- La sortie de la commande (le résultat) apparaîtra après l'exécution.

### Symbole `#`

Le symbole `#`, quant à lui, est utilisé pour représenter l'invite de commande d'un **superutilisateur (root)** ou lorsque la commande nécessite des privilèges administratifs. Si vous voyez une commande précédée de `#`, cela signifie que vous devez l'exécuter avec des privilèges élevés, généralement en utilisant `sudo` (si vous êtes un utilisateur non-root).

#### Exemple :

```bash
# apt update
```

Dans cet exemple :

- `#` signifie que la commande `apt update` nécessite des privilèges root pour s'exécuter correctement.
- Vous devrez soit vous connecter en tant que root, soit précéder la commande de `sudo` : ```bash
    $ sudo apt update
    ```

### Résumé

- **`$`** : Invite de commande d'un utilisateur non-administrateur. Exécutez les commandes directement.
- **`#`** : Invite de commande pour un superutilisateur (root). Exécutez les commandes avec `sudo` si vous n'êtes pas root.

### Exemple Comparatif :

```bash
$ lsmod | grep 8021q      # Commande exécutée par un utilisateur normal
# systemctl restart nginx  # Commande nécessitant des privilèges root
```

### Remarque

Le symbole `$` ou `#` n'est **pas** à taper lors de l'exécution des commandes, il est uniquement là pour indiquer le contexte d'exécution.

### Conclusion

Ces conventions sont très courantes dans les environnements Unix/Linux et aident à comprendre rapidement si une commande peut être exécutée par un utilisateur classique ou si elle nécessite des droits d'administrateur.