README: updated help

This commit is contained in:
Doug Le Tough 2019-08-27 19:54:34 +11:00
parent ddafd5c1e9
commit 1a7f7e25f0

View File

@ -18,35 +18,38 @@ au préalable installer les paquets suivants:
## Utilisation ## Utilisation
```shell ```shell
logstreamer.py -h logstreamer.py --help
usage: logstreamer.py [-h] --log LOG --host HOST --port PORT --user USER
--password PASSWORD --mount MOUNT [--workdir WORKDIR]
[--duration DURATION] [--amplitude AMPLITUDE]
[--framerate FRAMERATE] [--adjust ADJUST ADJUST]
[--exclude [EXCLUDE [EXCLUDE ...]]]
[--protocol PROTOCOL] [--ice_buffer ICE_BUFFER]
[--debug DEBUG]
usage: logstreamer.py [-h] --log LOG [--workdir WORKDIR] [--duration DURATION] optional arguments:
[--amplitude AMPLITUDE] [--framerate FRAMERATE] -h, --help show this help message and exit
[--adjust ADJUST ADJUST] [--exclude [EXCLUDE [EXCLUDE ...]]] --log LOG Le fichier de log à traiter (requis)
--host HOST --port PORT --user USER --password PASSWORD --host HOST Server Icecast2 (requis)
--mount MOUNT [--protocol PROTOCOL] [--debug DEBUG] --port PORT Port TCP sur lequel contacter le serveur Icecast2
(requis)
optional arguments: --user USER Nom d'utilisateur (requis)
-h, --help show this help message and exit --password PASSWORD Mot de passe (requis)
--log LOG Le fichier de log à traiter (requis) --mount MOUNT Point de montage Icecast2 (requis)
--workdir WORKDIR Le répertoire de travail (défaut: /tmp) --workdir WORKDIR Le répertoire de travail (défaut: /tmp)
--duration DURATION La durée d'une note (défaut: 0.008) --duration DURATION La durée d'une note (défaut: 0.008)
--amplitude AMPLITUDE --amplitude AMPLITUDE
Le niveau sonore (défaut: 0.5) Le niveau sonore (défaut: 0.5)
--framerate FRAMERATE --framerate FRAMERATE
Le taux d'échantillonage (défaut: 44100) Le taux d'échantillonage (défaut: 44100)
--adjust ADJUST ADJUST --adjust ADJUST ADJUST
Facteurs d'ajustement (défaut: 5000 20000) Facteurs d'ajustement (défaut: 5000 20000)
--exclude [EXCLUDE [EXCLUDE ...]] --exclude [EXCLUDE [EXCLUDE ...]]
Liste des caractères non traités (défaut: []) Liste des caractères non traités (défaut: [])
--host HOST Server Icecast2 (requis) --protocol PROTOCOL Protocole à utiliser (défaut: http)
--port PORT Port TCP sur lequel contacter le serveur Icecast2 --ice_buffer ICE_BUFFER
(requis) Taille du tampon Icecast (défaut: 32768)
--user USER Nom d'utilisateur (requis) --debug DEBUG Affiche l'activité (défaut: False)
--password PASSWORD Mot de passe (requis)
--mount MOUNT Point de montage Icecast2 (requis)
--protocol PROTOCOL Protocole à utiliser (défaut: http)
--debug DEBUG Affiche l'activité (défaut: False)
``` ```
## Démo ## Démo