Browse Source

README: updated help

Doug Le Tough 1 year ago
parent
commit
1a7f7e25f0
1 changed files with 32 additions and 29 deletions
  1. 32
    29
      README.md

+ 32
- 29
README.md View File

@@ -18,35 +18,38 @@ au préalable installer les paquets suivants:
18 18
 ## Utilisation
19 19
 
20 20
 ```shell
21
-logstreamer.py -h
22
-
23
-  usage: logstreamer.py [-h] --log LOG [--workdir WORKDIR] [--duration DURATION]
24
-                        [--amplitude AMPLITUDE] [--framerate FRAMERATE]
25
-                        [--adjust ADJUST ADJUST] [--exclude [EXCLUDE [EXCLUDE ...]]]
26
-                        --host HOST --port PORT --user USER --password PASSWORD
27
-                        --mount MOUNT [--protocol PROTOCOL] [--debug DEBUG]
28
-
29
-  optional arguments:
30
-    -h, --help            show this help message and exit
31
-    --log LOG             Le fichier de log à traiter (requis)
32
-    --workdir WORKDIR     Le répertoire de travail (défaut: /tmp)
33
-    --duration DURATION   La durée d'une note (défaut: 0.008)
34
-    --amplitude AMPLITUDE
35
-                          Le niveau sonore (défaut: 0.5)
36
-    --framerate FRAMERATE
37
-                          Le taux d'échantillonage (défaut: 44100)
38
-    --adjust ADJUST ADJUST
39
-                          Facteurs d'ajustement (défaut: 5000 20000)
40
-    --exclude [EXCLUDE [EXCLUDE ...]]
41
-                          Liste des caractères non traités (défaut: [])
42
-    --host HOST           Server Icecast2 (requis)
43
-    --port PORT           Port TCP sur lequel contacter le serveur Icecast2
44
-                          (requis)
45
-    --user USER           Nom d'utilisateur (requis)
46
-    --password PASSWORD   Mot de passe (requis)
47
-    --mount MOUNT         Point de montage Icecast2 (requis)
48
-    --protocol PROTOCOL   Protocole à utiliser (défaut: http)
49
-    --debug DEBUG         Affiche l'activité (défaut: False)
21
+logstreamer.py --help
22
+usage: logstreamer.py [-h] --log LOG --host HOST --port PORT --user USER
23
+                      --password PASSWORD --mount MOUNT [--workdir WORKDIR]
24
+                      [--duration DURATION] [--amplitude AMPLITUDE]
25
+                      [--framerate FRAMERATE] [--adjust ADJUST ADJUST]
26
+                      [--exclude [EXCLUDE [EXCLUDE ...]]]
27
+                      [--protocol PROTOCOL] [--ice_buffer ICE_BUFFER]
28
+                      [--debug DEBUG]
29
+
30
+optional arguments:
31
+  -h, --help            show this help message and exit
32
+  --log LOG             Le fichier de log à traiter (requis)
33
+  --host HOST           Server Icecast2 (requis)
34
+  --port PORT           Port TCP sur lequel contacter le serveur Icecast2
35
+                        (requis)
36
+  --user USER           Nom d'utilisateur (requis)
37
+  --password PASSWORD   Mot de passe (requis)
38
+  --mount MOUNT         Point de montage Icecast2 (requis)
39
+  --workdir WORKDIR     Le répertoire de travail (défaut: /tmp)
40
+  --duration DURATION   La durée d'une note (défaut: 0.008)
41
+  --amplitude AMPLITUDE
42
+                        Le niveau sonore (défaut: 0.5)
43
+  --framerate FRAMERATE
44
+                        Le taux d'échantillonage (défaut: 44100)
45
+  --adjust ADJUST ADJUST
46
+                        Facteurs d'ajustement (défaut: 5000 20000)
47
+  --exclude [EXCLUDE [EXCLUDE ...]]
48
+                        Liste des caractères non traités (défaut: [])
49
+  --protocol PROTOCOL   Protocole à utiliser (défaut: http)
50
+  --ice_buffer ICE_BUFFER
51
+                        Taille du tampon Icecast (défaut: 32768)
52
+  --debug DEBUG         Affiche l'activité (défaut: False)
50 53
 ```
51 54
 
52 55
 ## Démo

Loading…
Cancel
Save