From 1a7f7e25f0e317151aac22f6f23c08777ac70006 Mon Sep 17 00:00:00 2001 From: Doug Le Tough Date: Tue, 27 Aug 2019 19:54:34 +1100 Subject: [PATCH] README: updated help --- README.md | 59 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 8f94c07..e0aecf5 100644 --- a/README.md +++ b/README.md @@ -18,35 +18,38 @@ au préalable installer les paquets suivants: ## Utilisation ```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] - [--amplitude AMPLITUDE] [--framerate FRAMERATE] - [--adjust ADJUST ADJUST] [--exclude [EXCLUDE [EXCLUDE ...]]] - --host HOST --port PORT --user USER --password PASSWORD - --mount MOUNT [--protocol PROTOCOL] [--debug DEBUG] - - optional arguments: - -h, --help show this help message and exit - --log LOG Le fichier de log à traiter (requis) - --workdir WORKDIR Le répertoire de travail (défaut: /tmp) - --duration DURATION La durée d'une note (défaut: 0.008) - --amplitude AMPLITUDE - Le niveau sonore (défaut: 0.5) - --framerate FRAMERATE - Le taux d'échantillonage (défaut: 44100) - --adjust ADJUST ADJUST - Facteurs d'ajustement (défaut: 5000 20000) - --exclude [EXCLUDE [EXCLUDE ...]] - Liste des caractères non traités (défaut: []) - --host HOST Server Icecast2 (requis) - --port PORT Port TCP sur lequel contacter le serveur Icecast2 - (requis) - --user USER Nom d'utilisateur (requis) - --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) +optional arguments: + -h, --help show this help message and exit + --log LOG Le fichier de log à traiter (requis) + --host HOST Server Icecast2 (requis) + --port PORT Port TCP sur lequel contacter le serveur Icecast2 + (requis) + --user USER Nom d'utilisateur (requis) + --password PASSWORD Mot de passe (requis) + --mount MOUNT Point de montage Icecast2 (requis) + --workdir WORKDIR Le répertoire de travail (défaut: /tmp) + --duration DURATION La durée d'une note (défaut: 0.008) + --amplitude AMPLITUDE + Le niveau sonore (défaut: 0.5) + --framerate FRAMERATE + Le taux d'échantillonage (défaut: 44100) + --adjust ADJUST ADJUST + Facteurs d'ajustement (défaut: 5000 20000) + --exclude [EXCLUDE [EXCLUDE ...]] + Liste des caractères non traités (défaut: []) + --protocol PROTOCOL Protocole à utiliser (défaut: http) + --ice_buffer ICE_BUFFER + Taille du tampon Icecast (défaut: 32768) + --debug DEBUG Affiche l'activité (défaut: False) ``` ## Démo