From eb1c58024bf588ff59b19457449907e0f0647676 Mon Sep 17 00:00:00 2001 From: jamulix Date: Tue, 18 Mar 2025 04:26:54 +0100 Subject: [PATCH] Aktualisierte README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 01f25b9..28954ef 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,36 @@ Erstelle eine Datei `.NameToUnix.conf` im Arbeitsverzeichnis mit folgendem Inhal "ß" = "ss" ``` +### Verwendung von NameToUnix + +Um die Verwendung von `NameToUnix` zu verstehen, kannst du die folgende Hilfe ausgeben: + +```text +NameToUnix --help +``` + +Die Ausgabe sieht wie folgt aus: + +```text +Ein Tool zum Anpassen von Verzeichnis- und Dateinamen an Linux-Konventionen + +Usage: NameToUnix [OPTIONS] [PATHS]... + +Arguments: +[PATHS]... Pfade (Dateien und Verzeichnisse) zum rekursiven Anpassen + +Options: +-q, --quiet Ausgaben unterdrücken (keine Umbenennungsinfos auf stdout) +-n, --no-changes Nur anzeigen, aber keine realen Änderungen vornehmen +-f, --force Existierende Dateien überschreiben +-e, --exclude Zu ignorierende Muster (-e "*.py", mehrere können angegeben werden) +-v, --verbose Ausführliche Debug-Informationen + --modify-root Erlaubt, auch das Wurzelverzeichnis anzupassen +-h, --help Print help +-V, --version Print version + +``` + ## Test Im Verzeichnis [***./test***](./test) gibt es ein bash-Skript [***create_test_tree.sh***](test/create_test_tree.sh), das lokal 21 Test-Verzeichnisse und 400 Dateien mit skurrilen Zufallsnamen erzeugt. Damit kannst Du ***NameToUnix*** ausprobieren: