Explain: Python-Skript kommentiert Kommandozeilen

Peter Hofmann aus der Arch-Linux-Gemeinde hat ein Python-Skript namens Explain geschrieben, mit dem sich die Bestandteile einer Kommandozeile in Ascii-Art erläutern lassen.

Die Anregung zu Explain stammt aus einem Blog-Kommentar, der Hofmanns hübsche Ascii-Art beim Erläutern von Kommandos lobte. Bisher hatte der Entwickler diese von Hand gebastelt, nun gibt es ein Python-Skript zu diesem Zweck.

Das Skript nimmt als Input eine Textdatei entgegen, die die Kommandozeile, einige Zeichen zu deren Strukturierung und die beschreibenden Texte enthält, beispielsweise Folgendes:

sed 's/hurz/herz/i' < eingabe > ausgabe ------------+- -------------------
Ersetze "hurz" mit "herz".
Nicht case-sensitive.
Lies dabei aus "eingabe" und schreibe nach "ausgabe".

Das Ergebnis:

sed 's/hurz/herz/i' < eingabe > ausgabe \-----+-----/| \--------+--------/ | | | | | \- Lies dabei aus "eingabe" und schreibe | | nach "ausgabe". | | | \- Nicht case-sensitive. | \- Ersetze "hurz" mit "herz".

Explain kennt noch einige Parameter für das Aussehen des Diagramms und kann trotz der Bezeichnung Ascii-Art auch mit UTF-8 umgehen. Einen guten Einstieg vermittelt der Blogeintrag von Peter Hofmann, den Explain-Quelltext gibt es auf Github. Eine Lizenz für sein Skript hat der Programmautor nicht angegeben.

E-Mail Benachrichtigung
Benachrichtige mich zu:
0 Kommentare
Älteste
Neuste Beste Bewertung
Inline Feedbacks
Alle Kommentare anzeigen
Nach oben