diff --git a/doc/README.md b/doc/README.md index cf0c163..b0b3baf 100644 --- a/doc/README.md +++ b/doc/README.md @@ -70,6 +70,7 @@ Alle Programme benutzen für dieselbe Aufgabe denselben Schalter: | `-y`, `--dry` | Probelauf, keine Dateien schreiben | ✓ | ✓ | | | | `-v`, `--verbose` | ausführliche Ausgabe | | ✓ | ✓ | | | `-h`, `--help` | Hilfe | ✓ | ✓ | ✓ | ✓ | +| `--version` | Versionsnummer | ✓ | ✓ | ✓ | ✓ | Ältere Namen funktionieren weiter: `--cfg` für `--config` und bei svgconvert `--svgfolder` für `--outdir`. @@ -80,13 +81,13 @@ Alle Programme benutzen für dieselbe Aufgabe denselben Schalter: ./piccreate -c punkteraetsel -i test ``` -| Option | Bedeutung | -|-------------------|------------------------------------------------------------| -| `-c`, `--config` | Konfiguration aus `cfg/` (Endung `.cfg` optional) | -| `-i`, `--infile` | CSV-Datei aus `in/` (Endung `.csv` optional) | -| `-o`, `--outdir` | Ausgabeverzeichnis (Standard: `$PICCREATE_OUT`) | -| `-s`, `--startfrom` | Nummerierung bei jedem Wort / Großbuchstaben neu beginnen | -| `-y`, `--dry` | SVG nur auf der Konsole ausgeben, keine Dateien schreiben | +| Option | Bedeutung | +|-----------------------------|-----------| +| `-c`, `--config ` | Konfiguration aus `cfg/` (Endung `.cfg` optional) | +| `-i`, `--infile ` | CSV-Datei aus `in/` (Endung `.csv` optional) | +| `-o`, `--outdir ` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) | +| `-s`, `--startfrom` | Nummerierung bei jedem Wort / Großbuchstaben neu beginnen | +| `-y`, `--dry` | SVG nur auf der Konsole ausgeben, keine Dateien schreiben | Für jede CSV-Zeile entsteht `.svg` im Ausgabeverzeichnis. @@ -160,19 +161,20 @@ ImageMagick um; die Bilder landen im selben Ordner. Breite, Höhe, Format und Auflösung kommen aus der Sektion `--section` der Konfiguration (Standard `[png]`, für große JPGs z. B. `--section jpgs`). -| Option | Bedeutung | -|-----------------|--------------------------------------------------------| -| `-c` | Konfiguration aus `cfg/` (Endung `.cfg` optional) | -| `-o` | Ordner mit den SVGs, auch für die Bilder (Standard `$PICCREATE_OUT`) | -| `--section` | Sektion mit den Bildmaßen (Standard `png`) | -| `--format` | `jpg` oder `png` (überschreibt die Konfiguration) | -| `-i` | CSV aus `in/` prüfen: fehlende Bilder melden, nur diese umwandeln | -| `-j` | Anzahl paralleler Jobs (Standard 8) | -| `-b` | Hintergrundfarbe, `none` für transparent | -| `-f` | vorhandene Bilder überschreiben | -| `-p` / `-v` | Fortschrittsbalken / ausführliche Ausgabe | -| `-t ` | `n` Test-SVGs erzeugen und umwandeln | -| `-y` | Probelauf ohne Umwandlung | +| Option | Bedeutung | +|--------------------------------|-----------| +| `-c`, `--config ` | Konfiguration aus `cfg/` (Endung `.cfg` optional) | +| `-o`, `--outdir ` | Ordner mit den SVGs, auch für die Bilder (Standard `$PICCREATE_OUT`) | +| `--section ` | Sektion mit den Bildmaßen (Standard `png`) | +| `--format ` | Bildformat, überschreibt die Konfiguration | +| `-i`, `--infile ` | CSV aus `in/` prüfen: fehlende Bilder melden, nur diese umwandeln | +| `-j`, `--jobs ` | Anzahl paralleler Jobs (Standard 8) | +| `-b`, `--background ` | Hintergrundfarbe, `none` für transparent | +| `-f`, `--force` | vorhandene Bilder überschreiben | +| `-p`, `--progress` | Fortschrittsbalken anzeigen | +| `-v`, `--verbose` | ausführliche Ausgabe | +| `-t`, `--test ` | `n` Test-SVGs erzeugen und umwandeln | +| `-y`, `--dry` | Probelauf ohne Umwandlung | ## Vorschaubilder von Webseiten (webscan) @@ -230,18 +232,18 @@ Aufruf: ./webscan.sh -c webscan -i kunden ``` -| Option | Bedeutung | -|-----------------|---------------------------------------------------------| -| `-c` | Konfiguration (Standard `webscan`) | -| `-i` | Eingabedatei aus `in/` oder mit Pfad | -| `-o` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) | -| `--section` | Sektion mit den Bildmaßen (Standard `webscan`) | -| `--format` | `jpg` oder `png` (überschreibt die Konfiguration) | -| `-j` | Anzahl gleichzeitig geladener Seiten (Standard 4) | -| `--timeout` | Wartezeit pro Seite in Sekunden (Standard 20) | -| `-f` | vorhandene Bilder überschreiben | -| `--browser` | Pfad zu einem eigenen Chromium | -| `-v` | ausführliche Ausgabe | +| Option | Bedeutung | +|-----------------------------|-----------| +| `-c`, `--config ` | Konfiguration aus `cfg/` (Standard `webscan`) | +| `-i`, `--infile ` | Eingabedatei aus `in/` oder mit Pfad | +| `-o`, `--outdir ` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) | +| `--section ` | Sektion mit den Bildmaßen (Standard `webscan`) | +| `--format ` | Bildformat, überschreibt die Konfiguration | +| `-j`, `--jobs ` | Anzahl gleichzeitig geladener Seiten (Standard 4) | +| `--timeout ` | Wartezeit pro Seite (Standard 20) | +| `-f`, `--force` | vorhandene Bilder überschreiben | +| `--browser ` | eigenes Chromium statt des Playwright-Browsers (Standard `$PICCREATE_BROWSER`) | +| `-v`, `--verbose` | ausführliche Ausgabe | Seiten ohne URL oder mit Ladefehler werden übersprungen und am Ende aufgelistet; der Exit-Code ist dann 1. @@ -287,6 +289,12 @@ python3 glyphextract.py -i ausgangsschrift # = fonttest.sh python3 glyphextract.py -i ../in/ausgangsschrift/a.svg -e ``` +| Option | Bedeutung | +|----------------------------------|-----------| +| `-i`, `--infile ` | ein Buchstabe (`.svg`) oder ein Font (Ordner in `in/` oder Pfad) | +| `-e`, `--extract` | Glyphen für den Font extrahieren, bei einem Font zusätzlich `.cfg`; ohne `-e` Testbilder | +| `-o`, `--outdir ` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) | + Alle schreiben nach `$PICCREATE_OUT` (oder `-o `). Das Ergebnis (Glyph-SVGs und `.cfg`) wird anschließend nach `fonts//` übernommen. Werte wie `XSTEP` kann man danach in der `.cfg` noch von Hand