From 43159073d32743b71a4d0c8d456ccdcec66c1249 Mon Sep 17 00:00:00 2001 From: emkael Date: Sat, 5 Nov 2016 12:58:46 +0100 Subject: * documentation for command line switches completed --- README.md | 23 ++++++++++++++++++++++- src/bidding_data.py | 2 +- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a7f614a..ad8c255 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,26 @@ Narzędzie obsługuje niestandardowe zakresy numeracji rozdań w turnieju. Mapowanie numeru rozdań z Par na numer rozdania w BWS (numer fizycznego pudełka) odbywa się automatycznie (na podstawie danych z BWS). +Opcjonalne argumenty linii poleceń +---------------------------------- + +``` +bidding_data.py [-h] [-V] [-q | -v] [-l POZIOM_LOGÓW] [-f PLIK_LOGÓW] + [-s [ADRES_GOŃCA]] + DANE_SESJI.bws PLIK_TURNIEJU.html +``` + +Opis argumentów: + * `-h`, `--help`: wyświetla opis argumentów + * `-V`, `--version`: wyświetla numer wersji programu + * `-q`, `--quiet`: ucisza ostrzeżenia na standardowym wyjściu błędu + * `-v`, `--verbose`: wypisuje szczegółowe komunikaty na wyjściu błędu + * `-l LOGÓW`, `--log-level POZIOM`: ustawia szczegółowość logowania +(`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`) + * `-f PLIK`, `--log-file PLIK`: ścieżka pliku logów + * `-s [GONIEC]`, `--send-files [GONIEC]`: włącza transmisję Gońcem +(domyślny adres: `localhost:8090`) + Użycie (wersja z interfejsem okienkowym) ---------------------------------------- @@ -85,7 +105,8 @@ Wersja operująca na wyeksportowanych plikach CSV (np. przez `mdb-export`), kompatybilna z pozostałymi systemami operacyjnymi i niewymagająca ODBC, dostępna jest w gałęzi [csv](//github.com/emkael/jfrpary-bidding-data/tree/csv). -Do wersji z gałęzi CSV nie ma interfejsu graficznego. +Do wersji z gałęzi CSV nie ma interfejsu graficznego. Wersja z gałęzi CSV +została porzucona w wersji ok. 1.0, z czystego lenistwa. Lista przyszłych usprawnień --------------------------- diff --git a/src/bidding_data.py b/src/bidding_data.py index 331419f..d63a2b8 100644 --- a/src/bidding_data.py +++ b/src/bidding_data.py @@ -581,7 +581,7 @@ def main(): argument_parser.add_argument('-f', '--log-file', metavar='LOGFILE', help='log file path', default='bidding_data.log') - argument_parser.add_argument('-s', '--send-files', metavar='GONIEC_PORT', + argument_parser.add_argument('-s', '--send-files', metavar='GONIEC_HOST', help='use Goniec to send modified files', nargs='?', default=None, const='localhost:8090') -- cgit v1.2.3