aboutsummaryrefslogtreecommitdiff
path: root/documentation_en.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation_en.md')
-rw-r--r--documentation_en.md28
1 files changed, 21 insertions, 7 deletions
diff --git a/documentation_en.md b/documentation_en.md
index 87b9bd7..1cf5cfd 100644
--- a/documentation_en.md
+++ b/documentation_en.md
@@ -39,7 +39,7 @@ must be available on your system, as well as the `portaudio` library:
39 39
40 sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family portaudio 40 sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family portaudio
41 41
42Pour compiler kivy avec la librairie SDL2, il faut certains paquets installés: 42To compile Kivy with the SDL2 library, you need some packages:
43 43
44 sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev 44 sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
45 45
@@ -96,26 +96,29 @@ understand just by looking at it.
96### Options available at launch 96### Options available at launch
97 97
98All the options below are optional; usually, running the program in the correct 98All the options below are optional; usually, running the program in the correct
99folder is enough 99folder is enough. Most of the parameters can be defined also in the config file.
100The command line parameters always take precedence.
100 101
101 * `-h, --help`: shows a list of available options 102 * `-h, --help`: shows a list of available options
102 * `-c CONFIG, --config CONFIG`: gives the configuration file to load (by 103 * `-c CONFIG, --config CONFIG`: gives the configuration file to load (by
103 default, `config.yml` in the current folder). 104 default, `config.yml` in the current folder).
104 * `-p MUSIC_PATH, --music-path MUSIC_PATH`: gives the path to find the musics 105 * `-p MUSIC_PATH, --music-path MUSIC_PATH`: gives the path to find the musics
105 (by default, the current folder) 106 (by default, the current folder)
106 * `-d, --debug`: show debug informations in the terminal (disabled by default) 107 * `--no-debug, --debug`: show debug informations in the terminal (disabled by
108 default)
107 * `-V, --version`: show current version and exit (only for the compiled 109 * `-V, --version`: show current version and exit (only for the compiled
108 version) 110 version)
109 * `-L, --language`: change application language. Current languages: fr, en 111 * `-L, --language`: change application language. Current languages: fr, en
110 (default 'fr') 112 (default 'fr')
111 * `--no-focus-warning`: don't show warning when focus gets lost. 113 * `--focus-warning, --no-focus-warning`: show / don't show warning when focus gets
114 lost (default is to show it)
112 115
113The following options are reserved for a more advanced use of Music Sampler, or 116The following options are reserved for a more advanced use of Music Sampler, or
114in case of problem with the standard configuration: 117in case of problem with the standard configuration:
115 118
116 * `-m, --builtin-mixing`: make the sound mixing locally. By default, Music 119 * `--no-builtin-mixing, --builtin-mixing`: make the sound mixing locally. By
117 Sampler will let the system do it and open one channel per music loaded. Use 120 default, Music Sampler will let the system do it and open one channel per
118 it only if the system cannot handle it. 121 music loaded. Use it only if the system cannot handle it.
119 * `-l LATENCY, --latency LATENCY`: "low", "high" or a number of seconds 122 * `-l LATENCY, --latency LATENCY`: "low", "high" or a number of seconds
120 (default "high") 123 (default "high")
121 * `-b BLOCKSIZE, --blocksize BLOCKSIZE`: Number of frames for each mixing 124 * `-b BLOCKSIZE, --blocksize BLOCKSIZE`: Number of frames for each mixing
@@ -144,6 +147,9 @@ corresponding problems) or abort.
144The file contains several sections: 147The file contains several sections:
145 148
146 :::yaml 149 :::yaml
150 config:
151 ...
152
147 aliases: 153 aliases:
148 ... 154 ...
149 155
@@ -156,6 +162,14 @@ The file contains several sections:
156 keys: 162 keys:
157 ... 163 ...
158 164
165### `config`
166
167The config section lets you store configuration parameters that you would
168normally use in the command line parameters. The '-' in the long parameter name
169should be replaced by '_' (e.g. '--music-path' -> 'music_path'). For toggles
170(`debug`, `focus_warning`, `builtin_mixing`) use the version without 'no-' and
171specify `true` or `false` as value. Note that command line arguments always take
172precedence.
159 173
160### `music_properties` 174### `music_properties`
161 175