Zugehörige Blogposts

explain

Es kommt nicht selten vor, dass man jemandem zum Beispiel über das Netz einen langen Shell-Befehl erklären will. Im Prinzip hat man dabei nur zwei Möglichkeiten: Entweder man verweist in den erklärenden Sätzen auf Teile des Befehls („das ‚-p‘ bewirkt …“), was aber schnell unübersichtlich werden kann: „Die dritte öffnende Klammer von links nach dem Ausrufezeichen …“ Die Alternative wäre, Verbindungspfeile zu den entsprechenden Teilen zu ziehen. Genau das tut explain.

In einer Quelldatei hat man einen oder mehrere zu erklärende Befehle stehen. Diese versieht man dann mit einfachem Markup, um die Verbindung zwischen „Teil des Befehls“ und „erklärenden Worten“ herzustellen. Die Ausgabe ist entweder ASCII-Art oder auch UTF-8-Linien.

Eine ausführliche Erklärung der Syntax und Benutzung findet sich in der manpage.

Links

Screenshots