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

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

diff --git a/documentation_en.md b/documentation_en.md
index 87b9bd723a05784e7f5e7e5efe46bfb72b6a4292..1cf5cfdc2e587e4c6476134a255acd681b329e7d 100644 (file)
--- a/documentation_en.md
+++ b/documentation_en.md
@@ -39,7 +39,7 @@ must be available on your system, as well as the `portaudio` library:
 
     sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family portaudio
 
-Pour compiler kivy avec la librairie SDL2, il faut certains paquets installés:
+To compile Kivy with the SDL2 library, you need some packages:
 
     sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
 
@@ -96,26 +96,29 @@ understand just by looking at it.
 ### Options available at launch
 
 All the options below are optional; usually, running the program in the correct
-folder is enough
+folder is enough. Most of the parameters can be defined also in the config file.
+The command line parameters always take precedence.
 
   * `-h, --help`: shows a list of available options
   * `-c CONFIG, --config CONFIG`: gives the configuration file to load (by
     default, `config.yml` in the current folder).
   * `-p MUSIC_PATH, --music-path MUSIC_PATH`: gives the path to find the musics
     (by default, the current folder)
-  * `-d, --debug`: show debug informations in the terminal (disabled by default)
+  * `--no-debug, --debug`: show debug informations in the terminal (disabled by
+    default)
   * `-V, --version`: show current version and exit (only for the compiled
     version)
   * `-L, --language`: change application language. Current languages: fr, en
     (default 'fr')
-  * `--no-focus-warning`: don't show warning when focus gets lost.
+  * `--focus-warning, --no-focus-warning`: show / don't show warning when focus gets
+    lost (default is to show it)
 
 The following options are reserved for a more advanced use of Music Sampler, or
 in case of problem with the standard configuration:
 
-  * `-m, --builtin-mixing`: make the sound mixing locally. By default, Music
-    Sampler will let the system do it and open one channel per music loaded. Use
-    it only if the system cannot handle it.
+  * `--no-builtin-mixing, --builtin-mixing`: make the sound mixing locally. By
+    default, Music Sampler will let the system do it and open one channel per
+    music loaded. Use it only if the system cannot handle it.
   * `-l LATENCY, --latency LATENCY`: "low", "high" or a number of seconds
     (default "high")
   * `-b BLOCKSIZE, --blocksize BLOCKSIZE`: Number of frames for each mixing
@@ -144,6 +147,9 @@ corresponding problems) or abort.
 The file contains several sections:
 
     :::yaml
+    config:
+      ...
+
     aliases:
       ...
 
@@ -156,6 +162,14 @@ The file contains several sections:
     keys:
       ...
 
+### `config`
+
+The config section lets you store configuration parameters that you would
+normally use in the command line parameters. The '-' in the long parameter name
+should be replaced by '_' (e.g. '--music-path' -> 'music_path'). For toggles
+(`debug`, `focus_warning`, `builtin_mixing`) use the version without 'no-' and
+specify `true` or `false` as value. Note that command line arguments always take
+precedence.
 
 ### `music_properties`