Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- project:23.shack [2010-12-26 19:25] – ::ffff:212.9.189.66
+++ project:23.shack [2010-12-28 23:19] – bumped Modulstand tv
@@ Zeile 6: / Zeile 6: @@
 ==== struktur ====
-''/root/noise/modules'' - module
+Jede ausführbare Datei im Verzeichnis
+''/root/noise/modules''
+steht dem Benutzer als Befehl zur Verfügung.
-jedes modul stellt ein executable dar.
+So kann beispielsweise ein neuer Befehl ''/foo'' hinzugefügt werden indem die Datei
-es sollte die option ''--help'' erkennen und dann eine einzeilge hilfe ausgeben
+''/root/noise/modules/foo'' erstellt wird.
+Befehle werden auch Module genannt.
+Module sollten folgende Eingenschaften aufweisen:
+  * Wird das Modul mit dem Argument ''--help'' aufgerufen, so sollte es eine kurze Befehlsbeschreibung ausgeben.  Diese Beschreibung ...
+    * ... sollte genau eine Zeile lang sein.
+    * ... sollte keine Escapesequenzen beinhalten.
+    * ... sollte maximal 42 Zeichen lang sein.
+  * Wird das Modul mit den Argumenten ''--help'' und ''--verbose'' aufgerufen, so sollte es eine vollständige Befehlsbeschreibung ausgeben.  Diese Beschreibung ...
+    * ... kann beliebig viele Zeilen lang sein.  Jede dieser Zeilen ...
+      * ... sollte maximal 78 Zeichen lang sein.
+    * ... sollte normalen Text in lila darstellen.
+      * Lila kann in Shell mit ''echo -e 'normaler text \x1B[35mLILA TEXT\x1B[m normaler Text''' erzeugt werden.
+    * ... sollte Befehle und dazugehörige Argumente in grün darstellen.
+      * Grün kann in Shell mit ''echo -e 'normal \x1B[35mgrün\x1B[m wieder normal''' erzeugt werden.
 ==== user-interface ====
@@ Zeile 23: / Zeile 40: @@
 startet das angegebene modul
-module stand 2010-12-24:
+module stand 2010-12-28:
 <code>
 type /chat to send text to everyone with @@ prepended
@@ Zeile 38: / Zeile 55: @@
 type /sendmail to send an e-mail ( "TO(s)" "SUBJECT" [string instead of EOF])
 type /set to set a variable
+type /shackstatus to report status of all shack services.
 type /sleep to pause for NUMBER seconds
 type /stream to play an audio stream