mistangl/piccreate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doku: Optionen mit Kurz- und Langform

Browse Source 
- Tabellen für piccreate, svgconvert, webscan mit -x, --lang <wert>
- neue Optionstabelle für glyphextract, --version in der Übersicht

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Michael Stangl
2026-10-09 09:40:26 +02:00
co-authored by Claude Opus 5.5
parent 6bdaa62a7d
commit c5598f2304
1 changed files with 40 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/README.md
+40 -32
View File
@@ -70,6 +70,7 @@ Alle Programme benutzen für dieselbe Aufgabe denselben Schalter:
| `-y`, `--dry` | Probelauf, keine Dateien schreiben | ✓ | ✓ | | | | `-y`, `--dry` | Probelauf, keine Dateien schreiben | ✓ | ✓ | | |
| `-v`, `--verbose` | ausführliche Ausgabe | | ✓ | ✓ | | | `-v`, `--verbose` | ausführliche Ausgabe | | ✓ | ✓ | |
| `-h`, `--help` | Hilfe | ✓ | ✓ | ✓ | ✓ | | `-h`, `--help` | Hilfe | ✓ | ✓ | ✓ | ✓ |
| `--version` | Versionsnummer | ✓ | ✓ | ✓ | ✓ |
Ältere Namen funktionieren weiter: `--cfg` für `--config` und bei svgconvert Ältere Namen funktionieren weiter: `--cfg` für `--config` und bei svgconvert
`--svgfolder` für `--outdir`. `--svgfolder` für `--outdir`.
@@ -80,13 +81,13 @@ Alle Programme benutzen für dieselbe Aufgabe denselben Schalter:
./piccreate -c punkteraetsel -i test ./piccreate -c punkteraetsel -i test
``` ```
| Option | Bedeutung | | Option | Bedeutung |
|-------------------|------------------------------------------------------------| |-----------------------------|-----------|
| `-c`, `--config` | Konfiguration aus `cfg/` (Endung `.cfg` optional) | | `-c`, `--config <datei>` | Konfiguration aus `cfg/` (Endung `.cfg` optional) |
| `-i`, `--infile` | CSV-Datei aus `in/` (Endung `.csv` optional) | | `-i`, `--infile <datei>` | CSV-Datei aus `in/` (Endung `.csv` optional) |
| `-o`, `--outdir` | Ausgabeverzeichnis (Standard: `$PICCREATE_OUT`) | | `-o`, `--outdir <ordner>` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) |
| `-s`, `--startfrom` | Nummerierung bei jedem Wort / Großbuchstaben neu beginnen | | `-s`, `--startfrom` | Nummerierung bei jedem Wort / Großbuchstaben neu beginnen |
| `-y`, `--dry` | SVG nur auf der Konsole ausgeben, keine Dateien schreiben | | `-y`, `--dry` | SVG nur auf der Konsole ausgeben, keine Dateien schreiben |
Für jede CSV-Zeile entsteht `<customerid>.svg` im Ausgabeverzeichnis. Für jede CSV-Zeile entsteht `<customerid>.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 Auflösung kommen aus der Sektion `--section` der Konfiguration (Standard
`[png]`, für große JPGs z. B. `--section jpgs`). `[png]`, für große JPGs z. B. `--section jpgs`).
| Option | Bedeutung | | Option | Bedeutung |
|-----------------|--------------------------------------------------------| |--------------------------------|-----------|
| `-c` | Konfiguration aus `cfg/` (Endung `.cfg` optional) | | `-c`, `--config <datei>` | Konfiguration aus `cfg/` (Endung `.cfg` optional) |
| `-o` | Ordner mit den SVGs, auch für die Bilder (Standard `$PICCREATE_OUT`) | | `-o`, `--outdir <ordner>` | Ordner mit den SVGs, auch für die Bilder (Standard `$PICCREATE_OUT`) |
| `--section` | Sektion mit den Bildmaßen (Standard `png`) | | `--section <name>` | Sektion mit den Bildmaßen (Standard `png`) |
| `--format` | `jpg` oder `png` (überschreibt die Konfiguration) | | `--format <jpg\|png>` | Bildformat, überschreibt die Konfiguration |
| `-i` | CSV aus `in/` prüfen: fehlende Bilder melden, nur diese umwandeln | | `-i`, `--infile <datei>` | CSV aus `in/` prüfen: fehlende Bilder melden, nur diese umwandeln |
| `-j` | Anzahl paralleler Jobs (Standard 8) | | `-j`, `--jobs <n>` | Anzahl paralleler Jobs (Standard 8) |
| `-b` | Hintergrundfarbe, `none` für transparent | | `-b`, `--background <farbe>` | Hintergrundfarbe, `none` für transparent |
| `-f` | vorhandene Bilder überschreiben | | `-f`, `--force` | vorhandene Bilder überschreiben |
| `-p` / `-v` | Fortschrittsbalken / ausführliche Ausgabe | | `-p`, `--progress` | Fortschrittsbalken anzeigen |
| `-t <n>` | `n` Test-SVGs erzeugen und umwandeln | | `-v`, `--verbose` | ausführliche Ausgabe |
| `-y` | Probelauf ohne Umwandlung | | `-t`, `--test <n>` | `n` Test-SVGs erzeugen und umwandeln |
| `-y`, `--dry` | Probelauf ohne Umwandlung |
## Vorschaubilder von Webseiten (webscan) ## Vorschaubilder von Webseiten (webscan)
@@ -230,18 +232,18 @@ Aufruf:
./webscan.sh -c webscan -i kunden ./webscan.sh -c webscan -i kunden
``` ```
| Option | Bedeutung | | Option | Bedeutung |
|-----------------|---------------------------------------------------------| |-----------------------------|-----------|
| `-c` | Konfiguration (Standard `webscan`) | | `-c`, `--config <datei>` | Konfiguration aus `cfg/` (Standard `webscan`) |
| `-i` | Eingabedatei aus `in/` oder mit Pfad | | `-i`, `--infile <datei>` | Eingabedatei aus `in/` oder mit Pfad |
| `-o` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) | | `-o`, `--outdir <ordner>` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) |
| `--section` | Sektion mit den Bildmaßen (Standard `webscan`) | | `--section <name>` | Sektion mit den Bildmaßen (Standard `webscan`) |
| `--format` | `jpg` oder `png` (überschreibt die Konfiguration) | | `--format <jpg\|png>` | Bildformat, überschreibt die Konfiguration |
| `-j` | Anzahl gleichzeitig geladener Seiten (Standard 4) | | `-j`, `--jobs <n>` | Anzahl gleichzeitig geladener Seiten (Standard 4) |
| `--timeout` | Wartezeit pro Seite in Sekunden (Standard 20) | | `--timeout <sekunden>` | Wartezeit pro Seite (Standard 20) |
| `-f` | vorhandene Bilder überschreiben | | `-f`, `--force` | vorhandene Bilder überschreiben |
| `--browser` | Pfad zu einem eigenen Chromium | | `--browser <pfad>` | eigenes Chromium statt des Playwright-Browsers (Standard `$PICCREATE_BROWSER`) |
| `-v` | ausführliche Ausgabe | | `-v`, `--verbose` | ausführliche Ausgabe |
Seiten ohne URL oder mit Ladefehler werden übersprungen und am Ende Seiten ohne URL oder mit Ladefehler werden übersprungen und am Ende
aufgelistet; der Exit-Code ist dann 1. 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 python3 glyphextract.py -i ../in/ausgangsschrift/a.svg -e
``` ```
| Option | Bedeutung |
|----------------------------------|-----------|
| `-i`, `--infile <datei\|font>` | ein Buchstabe (`.svg`) oder ein Font (Ordner in `in/` oder Pfad) |
| `-e`, `--extract` | Glyphen für den Font extrahieren, bei einem Font zusätzlich `<name>.cfg`; ohne `-e` Testbilder |
| `-o`, `--outdir <ordner>` | Ausgabeverzeichnis (Standard `$PICCREATE_OUT`) |
Alle schreiben nach `$PICCREATE_OUT` (oder `-o <ordner>`). Das Ergebnis Alle schreiben nach `$PICCREATE_OUT` (oder `-o <ordner>`). Das Ergebnis
(Glyph-SVGs und `<name>.cfg`) wird anschließend nach `fonts/<name>/` (Glyph-SVGs und `<name>.cfg`) wird anschließend nach `fonts/<name>/`
übernommen. Werte wie `XSTEP` kann man danach in der `.cfg` noch von Hand übernommen. Werte wie `XSTEP` kann man danach in der `.cfg` noch von Hand