Add config key to config.yml to store command line arguments

[perso/Immae/Projets/Python/MusicSampler.git] / documentation_fr.md

diff --git a/documentation_fr.md b/documentation_fr.md
index a55ae73de4873ff80174c157bca7d2e9a811b39f..b739aa2c752cddb5e75c62472da717b7073ec336 100644 (file)
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -103,7 +103,9 @@ gardées d'une fois sur l'autre.
 ### Options disponibles au lancement
 
 Toutes les options au lancement sont facultatives ; la plupart du temps lancer
-le programme dans le bon dossier suffit.
+le programme dans le bon dossier suffit. La plupart d'entre elles peuvent être
+définies également dans le fichier de config (à part `--config` bien sûr). Les
+arguments en ligne de commande ont toujours la priorité.
 
   * `-h, --help` : affiche une liste des options disponibles.
   * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger
@@ -111,20 +113,21 @@ le programme dans le bon dossier suffit.
     music_sampler).
   * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques
     (par défaut, le dossier courant).
-  * `-d, --debug` : Affiche les informations de déboggage (désactivé par défaut)
+  * `--no-debug, --debug` : Affiche les informations de déboggage (désactivé par
+    défaut)
   * `-V, --version` : affiche la version courante et quitte (utilisable
     uniquement pour la version compilée).
   * `-L, --language` : change la langue de l'application. Actuellement: fr, en
     (par défaut 'fr')
-  * `--no-focus-warning`: Ne pas afficher d'avertissement lorsque l'application
-    perd le focus.
+  * `--focus-warning, --no-focus-warning`: Afficher / Ne pas afficher
+    d'avertissement lorsque l'application perd le focus (activé par défaut).
 
 Les options suivantes sont plutôt réservées à un usage avancé de music_sampler,
 ou en cas de problème avec la configuration standard :
 
-  * `-m, --builtin-mixing` Effectue en interne le mixage des sons. Par défaut,
-    music_sampler confie le mixage au système : n'activer cette option que si le
-    système n'y parvient pas.
+  * `--no-builtin-mixing, --builtin-mixing` Effectue en interne le mixage des
+    sons. Par défaut, music_sampler confie le mixage au système : n'activer
+    cette option que si le système n'y parvient pas.
   * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un
     nombre de secondes (par défaut, "high")
   * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames
@@ -158,6 +161,9 @@ ne se lance pas du tout.
 Le fichier contient plusieurs sections :
 
     :::yaml
+    config:
+      ...
+
     aliases:
       ...
 
@@ -171,6 +177,15 @@ Le fichier contient plusieurs sections :
       ...
 
 
+### `config`
+
+La section config permet d'enregistrer les paramètres habituellement donnés en
+ligne de commande. Les '-' dans le nom du paramètre long doivent être remplacés
+par des '_' (par exemple '--music-path' -> 'music_path'). Pour les switches
+(`debug`, `focus_warning`, `builtin_mixing`), utilisez la version sans le 'no-'
+et spécifiez `true` / `false` en valeur. Notez que les arguments donnés en ligne
+de commande sont toujours prioritaires sur les valeurs du fichier.
+
 ### `music_properties` : propriétés des musiques
 
 Cette section sert à définir des propriétés globales des musiques.