shroudBNC 1.1 TCL Befehle

Befehle und Variablen die als Teil der Eggdrop Emulation implementiert wurden sind in dieser Datei nicht gelistet. Für eine Liste dieser Befehle sollten Sie die „tcl-commands.doc“ (die Teil des Eggdrop Paketes ist) lesen.

Diese Liste ist aus dem englischen Teil des Wikis übersetzt. Ich habe teilweise Fachbegriffe übersetzt an Stellen an denen ich es für sinnvoll erachtet habe. Bei Problemen konsultieren Sie die englische Liste.

Benutzer Management

addbncuser

  • Syntax: addbncuser <Benutzer> <Passwort>
  • Beschreibung: Erstellt einen neuen Bouncer Benutzer.
  • Rückgabe: Nichts.

bnccheckpassword

  • Syntax: bnccheckpassword <Benutzer> <Passwort>
  • Beschreibung: Prüft ob das eingegebene Passwort zu dem des Benutzer passt.
  • Rückgabe: 1 wenn das <Passwort> korrekt ist, 0 bei allem anderen.

bncuserlist

  • Syntax:
  • Beschreibung: Gibt eine Liste aller Bouncer-Accounts wieder.
  • Rückgabe: Eine TCL Liste.

delbncuser

  • Syntax: delbncuser <Benutzer>
  • Beschreibung: Löscht einen Bouncer Benutzer.
  • Rückgabe: Nichts.

getbncuser

  • Syntax: getbncuser <Benutzer> <Typ> [Parameter]
  • Beschreibung: Gibt einen Wert aus der Konfigurationsdatei des Benutzers aus.
  • Rückgabe: Eine TCL Liste.

setbncuser

  • Syntax: setbncuser <Benutzer> <Typ> [<Wert>] [<Wert2>]
  • Beschreibung: Setzt einen Wert in der Benutzer Konfigurationsdatei.
  • Rückgabe: Nichts.

trafficstats

  • Syntax: trafficstats <Benutzer> [<Verbindungstyp>] [<Typ>]
  • Beschreibung: Gibt eine Traffic-Statistik für den angegeben Benutzer aus. Verbingstyp kann „client“ oder „server“ sein. Typ kann „in“ oder „out“ sein.
  • Rückgabe: Die Traffic (in Bytes).

User Interaktion

floodcontrol

  • Syntax: floodcontrol <Funktion>
  • Beschreibung: Schaltet den Flood-Schutz ein oder aus, oder gibt Status Informationen über den Benutzer zurück.

Gültige Werte für <Funktion>:

  bytes – Gibt die Anzahl der Bytes in Warteschlange des Benutzers wieder.
  items – Wie 'bytes', gibt aber die Anzahl der Teile wieder.
  on – Schaltet den Flood-Schutz ein.
  off – Schaltet den Flood-Schutz aus.
  • Rückgabe: 1 bei Erfolg, sonst 0, z.B. wenn <Funktion> keine gültige Funktion ist.

putclient

  • Syntax: putclient <Text>
  • Beschreibung: Sendet <Text> an einen Benutzer der mit seinem Bouncer verbunden sind.
  • Rückgabe: 1 wenn erfolgreich, sonst 0 , z.B. wenn denn der Text ungültig ist oder der User nicht verbunden ist.

simul

  • Syntax: simul <Benutzer> <Befehl>
  • Beschreibung: Simuliert den <Befehl> aus Sicht von <Benutzer>. shroudBNC führt den <Befehl> aus als hätte der Benutzer /<Befehl> geschrieben.
  • Rückgabe: 1 wenn erfolgreich, sonst 0 , z.B. wenn <Benutzer> kein Gültiger Benutzer ist.

Kontext Management

getctx

  • Syntax: getctx
  • Beschreibung: Gibt den aktuellen Kontext zurück
  • Rückgabe: Einen Kontext.

setctx

  • Syntax: setctx <Kontext>
  • Beschreibung: Setzt den Kontext der für ausführbare Befehle verwendet wird.
  • Rückgabe: Nichts.

Interne Befehle

internalbind

  • Syntax: internalbind <Typ> <Proc>
  • Beschreibung: Erstellt einen internalbind.
  • Rückgabe: Nichts.

internalbinds

  • Syntax: internalbinds
  • Beschreibung: Gibt eine Liste der aktuellen internelbinds aus.
  • Rückgabe: Eine Liste.

internalchanlist

  • Syntax: internalchanlist <Channel>
  • Beschreibung: Gibt eine Liste von Nicks aus die sich im angegebenen Channel befinden.
  • Rückgabe: Eine TCL Liste.

internalclosesocket

  • Syntax: internalclosesocket <idx>
  • Beschreibung: Diesen Befehl nicht benutzen. Benutzen Sie lieber 'killdcc'. Für mehr Details in die tcl-commands.doc schauen.
  • Rückgabe: Nichts.

internalconnect

  • Syntax: internalconnect <Host> <Port>
  • Beschreibung: Diesen Befehl nicht benutzen. Benutzen Sie lieber 'connect'. Für mehr Details in die tcl-commands.doc schauen.
  • Rückgabe: Einen 'dcc' idx.

internalgetchanidle

  • Syntax: internalgetchanidle <Nick> <Channel>
  • Beschreibung: Diesen Befehl nicht benutzen. Benutzen Sie lieber 'getchanidle'. Für mehr Details in die tcl-commands.doc schauen.
  • Rückgabe: Die Idle-Zeit des Nicks in Sekunden.

internallisten

  • Syntax: internallisten <Port> <Typ> <Optionen> <Flag>
  • Beschreibung: Diesen Befehl nicht benutzen. Benutzen Sie lieber 'listen'. Für mehr Details in die tcl-commands.doc schauen.
  • Rückgabe: Einen 'dcc' idx.

internalsocketwriteln

  • Syntax: internalsocketwriteln <idx> <Linie>
  • Beschreibung: Diesen Befehl nicht benutzen. Benutzen Sie lieber 'putdoc'. Für mehr Detail in die tcl-commands.doc schauen.
  • Rückgabe: Nichts.

internalunbind

  • Syntax: internalunbind <Typ> <Proc> [<Muster>] [<Benutzer>]
  • Beschreibung: Hebt einen internalbind auf.
  • Rückgabe: Nichts.

Sonstige Befehle

bncaddcommand

  • Syntax: bncaddcommand <Name> <Kategorie> <Beschreibung> [<Hilfe-Text>]
  • Beschreibung: Fügt einen neuen Befehl der /sbnc help hinzu. Der Befehl kann nur verwendet werden wenn das „internal command“-proc auf den „help“ Befehl ausgelöst wird.
  • Rückgabe: Nichts.

bnccommand

  • Syntax: bnccommand <Befehl> <Parameter>
  • Beschreibung: Führt einen Modul spezifischen Befehl aus. Dieser Befehl wird für die Kommunikation mit anderen sBNC Modulen verwendet.
  • Rückgabe: Die Rückgabe ist Modul spezifisch. Wenn kein Modul den Befehl verarbeitet wird ein leerer String zurückgegeben.

bncdeletecommand

  • Syntax: bncdeletecommand <Name>
  • Beschreibung: Löscht einen Befehl (der mit 'bncaddcommand' hinzugefügt wurde) aus der Befehlshilfe.
  • Rückgabe: Nichts.

bncdisconnect

  • Syntax: bncdisconnect <Grund>
  • Beschreibung: Trennt die Verbindung zischen einem Benutzer und dem IRC Server.
  • Rückgabe: Nichts.

bncgetglobaltag

  • Syntax: bncgetglobaltag <Name>
  • Beschreibung: Gibt einen Wert eines Globalen Tags zurück.
  • Rückgabe: Einen String oder NULL.

bncgetgvhost

  • Syntax: bncgetgvhost
  • Beschreibung: Gibt den Standard-Vhost zurück.
  • Rückgabe: Einen String.

bncgetmotd

  • Syntax: bncgetmotd
  • Beschreibung: Gibt das aktuelle motd zurück.
  • Rückgabe: Einen String.

bncgettag

  • Syntax: bncgettag <Channel> <Nick> <Tag>
  • Beschreibung:
  • Rückgabe:

bncjoinchans

  • Syntax: bncjoinchans <User>
  • Beschreibung:
  • Rückgabe:

bnckill

  • Syntax: bnckill <Grund>
  • Beschreibung: Trennt die Verbindung eines Benutzers zum Bouncer.
  • Rückgabe: Nichts.

bncmodules

  • Syntax: bncmodules
  • Beschreibung: Gibt eine List der geladenen Module zurück.
  • Rückgabe: Eine Liste der geladenen Module.

bncnumversion

  • Syntax: bncnumversion
  • Beschreibung: Gibt die sBNC Version zurück, z.B. 0090000
  • Rückgabe: Einen String mit der aktuellen Version.

bncreply

  • Syntax: bncreply <Text>
  • Beschreibung: Sendet eine notice/msg an den aktuellen Benutzer (richtet sich nach dem Benutzer den den Befehl ausgeführt hat).
  • Rückgabe: Nichts.

bncsetglobaltag

  • Syntax: bncsetglobaltag <Name> <Wert>
  • Beschreibung: Erstellt/Setzt einen Globalen Tag. Globale Tags werden in der sbnc.conf Konfigurationsdatei gespeichert.
  • Rückgabe: Nichts.

bncsetgvhost

  • Syntax: bncsetgvhost <Host>
  • Beschreibung: Setzt den Standard Vhost.
  • Rückgabe: Nichts.

bncsetmotd

  • Syntax: bncsetmotd <motd>
  • Beschreibung: Setzt die motd.
  • Rückgabe: Nichts.

bncsettag

  • Syntax: bncsettag <Channel> <Nick> <Tag> <Wert>
  • Beschreibung:
  • Rückgabe:

bncuptime

  • Syntax: bncuptime
  • Beschreibung: Gibt die Zeit an an der sBNC gestartet wurde.
  • Rückgabe: Eine UNIX timestamp.

bncvalidusername

  • Syntax: bncvalidusername <Benutzername>
  • Beschreibung: Prüft ob es sich um einen gültigen Benutzernamen handelt.
  • Rückgabe: 1 wenn der Benutzername gültig ist, sonst 0.

bncversion

  • Syntax: bncversion
  • Beschreibung: Gibt die Version des sBNC zurück, z.B. 0090000.
  • Rückgabe: Einen String mit der aktuellen Versionsnummer.

debugout

  • Syntax: debugout <String>
  • Beschreibung: Gibt den <String> in der Debug-Konsole aus. Dieser Befehl ist Win32-Spezifisch.
  • Rückgabe: Nichts.

getchanprefix

  • Syntax: getchanprefix <Channel> <Nick>
  • Beschreibung: Gibt den „besten“ Präfix für den Nick zurück.
  • Rückgabe: Den Präfix (z.B. @ oder +).

getchanrealname

  • Syntax: getchanrealname <Channel> [<Nick>]
  • Beschreibung: Gibt den Realname des Benutzer zurück.
  • Rückgabe: Einen String oder NULL.

getcurrentnick

  • Syntax: getcurrentnick
  • Beschreibung: Benutzen Sie lieber '$::botnick'.
  • Rückgabe: Der aktuelle Nick des Bots.

getisupport

  • Syntax: getisupport <Feature>
  • Beschreibung: Gibt einen spezifischen Feature-Wert einer 005 Server-Antwort zurück.
  • Rückgabe: Der Wert des Features.

haltoutput

  • Syntax: haltoutput
  • Beschreibung: Hält die weitere Prozesse und Ausgaben an.
  • Rückgabe: Nichts.

isprefixmode

  • Syntax: isprefixmode <Modus>
  • Beschreibung: Gibt an ob ein Channel-Modus an Nicks vergeben werden kann (z.B. +o oder +v).
  • Rückgabe: 1 wenn der Modus vergeben werden kann, sonst 0.

md5

  • Syntax: md5 <String>
  • Beschreibung: Berechnet den MD5 Hash für <String>.
  • Rückgabe: Ein MD5 Hash.

requiresparam

  • Syntax: requiresparam <Mode>
  • Beschreibung: Gibt an ob ein Channel-Modus einen Parameter benötigt.
  • Rückgabe: 3 falls der Modus eine Liste ist (z.B. die Banliste) und einen Parameter zum Setzten/Entfernen benötigt, 2 falls der Modus einen Parameter zum Setzten/Entfernen benötigt, 1 falls der Modus einen Parameter zum Setzen benötigt, 0 falls der Modus keine Parameter zum Setzten benötigt.

synthwho

  • Syntax: synthwho <Channel> <Simulation>
  • Beschreibung: Erstellt eine /who-Antwort für den angegebenen Channel.
  • Rückgabe: 1 falls erfolgreich, sonst 0. Undefiniertes Verhalten kann auftreten wenn die Simulation und die die Antwort beide 0 sind.
 
de/1.1/tclcommands.txt · Last modified: 2011/08/27 15:15 (external edit)
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki