diff options
Diffstat (limited to 'documentation_fr.md')
-rw-r--r-- | documentation_fr.md | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/documentation_fr.md b/documentation_fr.md index a55ae73..b739aa2 100644 --- a/documentation_fr.md +++ b/documentation_fr.md | |||
@@ -103,7 +103,9 @@ gardées d'une fois sur l'autre. | |||
103 | ### Options disponibles au lancement | 103 | ### Options disponibles au lancement |
104 | 104 | ||
105 | Toutes les options au lancement sont facultatives ; la plupart du temps lancer | 105 | Toutes les options au lancement sont facultatives ; la plupart du temps lancer |
106 | le programme dans le bon dossier suffit. | 106 | le programme dans le bon dossier suffit. La plupart d'entre elles peuvent être |
107 | définies également dans le fichier de config (à part `--config` bien sûr). Les | ||
108 | arguments en ligne de commande ont toujours la priorité. | ||
107 | 109 | ||
108 | * `-h, --help` : affiche une liste des options disponibles. | 110 | * `-h, --help` : affiche une liste des options disponibles. |
109 | * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger | 111 | * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger |
@@ -111,20 +113,21 @@ le programme dans le bon dossier suffit. | |||
111 | music_sampler). | 113 | music_sampler). |
112 | * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques | 114 | * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques |
113 | (par défaut, le dossier courant). | 115 | (par défaut, le dossier courant). |
114 | * `-d, --debug` : Affiche les informations de déboggage (désactivé par défaut) | 116 | * `--no-debug, --debug` : Affiche les informations de déboggage (désactivé par |
117 | défaut) | ||
115 | * `-V, --version` : affiche la version courante et quitte (utilisable | 118 | * `-V, --version` : affiche la version courante et quitte (utilisable |
116 | uniquement pour la version compilée). | 119 | uniquement pour la version compilée). |
117 | * `-L, --language` : change la langue de l'application. Actuellement: fr, en | 120 | * `-L, --language` : change la langue de l'application. Actuellement: fr, en |
118 | (par défaut 'fr') | 121 | (par défaut 'fr') |
119 | * `--no-focus-warning`: Ne pas afficher d'avertissement lorsque l'application | 122 | * `--focus-warning, --no-focus-warning`: Afficher / Ne pas afficher |
120 | perd le focus. | 123 | d'avertissement lorsque l'application perd le focus (activé par défaut). |
121 | 124 | ||
122 | Les options suivantes sont plutôt réservées à un usage avancé de music_sampler, | 125 | Les options suivantes sont plutôt réservées à un usage avancé de music_sampler, |
123 | ou en cas de problème avec la configuration standard : | 126 | ou en cas de problème avec la configuration standard : |
124 | 127 | ||
125 | * `-m, --builtin-mixing` Effectue en interne le mixage des sons. Par défaut, | 128 | * `--no-builtin-mixing, --builtin-mixing` Effectue en interne le mixage des |
126 | music_sampler confie le mixage au système : n'activer cette option que si le | 129 | sons. Par défaut, music_sampler confie le mixage au système : n'activer |
127 | système n'y parvient pas. | 130 | cette option que si le système n'y parvient pas. |
128 | * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un | 131 | * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un |
129 | nombre de secondes (par défaut, "high") | 132 | nombre de secondes (par défaut, "high") |
130 | * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames | 133 | * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames |
@@ -158,6 +161,9 @@ ne se lance pas du tout. | |||
158 | Le fichier contient plusieurs sections : | 161 | Le fichier contient plusieurs sections : |
159 | 162 | ||
160 | :::yaml | 163 | :::yaml |
164 | config: | ||
165 | ... | ||
166 | |||
161 | aliases: | 167 | aliases: |
162 | ... | 168 | ... |
163 | 169 | ||
@@ -171,6 +177,15 @@ Le fichier contient plusieurs sections : | |||
171 | ... | 177 | ... |
172 | 178 | ||
173 | 179 | ||
180 | ### `config` | ||
181 | |||
182 | La section config permet d'enregistrer les paramètres habituellement donnés en | ||
183 | ligne de commande. Les '-' dans le nom du paramètre long doivent être remplacés | ||
184 | par des '_' (par exemple '--music-path' -> 'music_path'). Pour les switches | ||
185 | (`debug`, `focus_warning`, `builtin_mixing`), utilisez la version sans le 'no-' | ||
186 | et spécifiez `true` / `false` en valeur. Notez que les arguments donnés en ligne | ||
187 | de commande sont toujours prioritaires sur les valeurs du fichier. | ||
188 | |||
174 | ### `music_properties` : propriétés des musiques | 189 | ### `music_properties` : propriétés des musiques |
175 | 190 | ||
176 | Cette section sert à définir des propriétés globales des musiques. | 191 | Cette section sert à définir des propriétés globales des musiques. |