📖 🤖 manpages als Standard-Set für holm.tools-CLIs #1

New issue

Open

opened 2026-07-10 22:33:41 +02:00 by holm · 0 comments

holm commented

2026-07-10 22:33:41 +02:00

Owner

Dimension	Bewertung	Einschätzung
Aufwand	`████░░░░░░`	Mittel — pro Tool eine man-Quelle + Generator/CI
Nutzen	`███████░░░`	Hoch — Informationserhalt: Interface abrufbar ohne Source-Lesen (Mensch UND Agent)
Bruchhäufigkeit	`██░░░░░░░░`	Niedrig
Nachhaltigkeit	`████████░░`	Hoch — einmal im Standard-Set, dauerhaft
Dringlichkeit	`███░░░░░░░`	Niedrig

Idee

Jedes holm.tools-CLI bekommt eine manpage als Standard-Set-Item (wie README/CHANGELOG/cliff.toml).

Auslöser

Beim Anbinden von pwgenz6c (WSM25/mikrotik-manager) musste das Interface erst aus dem Source gelesen werden (usage() + getopts), weil kein man pwgenz6c existiert. Eine manpage liefert den Informationserhalt sofort.

Vorschlag

Quelle man/<tool>.1 via scdoc/ronn (Markdown-nah) ODER generiert aus dem usage()-Block (single source of truth).
Konsistenz --help ↔ manpage.
In repo-template aufnehmen (Scaffold + Standard-Set-Doku), damit neue Tools es erben.

🤖 angelegt von Claude v00 (API/Token holm)

| Dimension | Bewertung | Einschätzung | |---|---|---| | Aufwand | `████░░░░░░` | Mittel — pro Tool eine man-Quelle + Generator/CI | | Nutzen | `███████░░░` | Hoch — Informationserhalt: Interface abrufbar ohne Source-Lesen (Mensch UND Agent) | | Bruchhäufigkeit | `██░░░░░░░░` | Niedrig | | Nachhaltigkeit | `████████░░` | Hoch — einmal im Standard-Set, dauerhaft | | Dringlichkeit | `███░░░░░░░` | Niedrig | ## Idee Jedes holm.tools-CLI bekommt eine **manpage** als Standard-Set-Item (wie README/CHANGELOG/cliff.toml). ## Auslöser Beim Anbinden von `pwgenz6c` (WSM25/mikrotik-manager) musste das Interface erst aus dem Source gelesen werden (`usage()` + `getopts`), weil kein `man pwgenz6c` existiert. Eine manpage liefert den Informationserhalt sofort. ## Vorschlag - Quelle `man/<tool>.1` via scdoc/ronn (Markdown-nah) ODER generiert aus dem `usage()`-Block (single source of truth). - Konsistenz `--help` ↔ manpage. - In `repo-template` aufnehmen (Scaffold + Standard-Set-Doku), damit neue Tools es erben. > 🤖 angelegt von Claude v00 (API/Token holm)

holm added the

Kind/Documentation

Kind/Enhancement

Priority/Low

labels

2026-07-10 22:34:46 +02:00