
                                 IRC

                       IRC-Client fr den Hive

              Author: Jrg Deckert (joergd@bitquell.de)

===============================================================================


Einleitung
==========

Dies ist ein IRC-Client fr den Hive (http://hive-project.de). Er sollte auf
jedem Hive mit bestcktem Netzwerk-Interface funktionieren.

Die Idee des IRC-Clients stammt von PropIRC, einem Projekt von Harrison Pham,
welches aus einer Propeller-basierten Hardware ausschlielich fr diesen Zweck
besteht (http://classic.parallax.com/tabid/701/Default.aspx). Der Administra-
Netzwerk-Stack nutzt darber hinaus die Treiber von Harrison Pham.

Der vorliegende IRC-Client hat mit PropIRC ansonsten nicht viel gemein, sondern
stellt einen ausgewachsenen IRC-Client mit den meisten der blichen
Funktionalitten dar.


Installation
============

Der Hive IRC-Client ist Bestandteil des TriOS Netzwerk-Paketes. Die aktuellste
Version steht immer im ersten Beitrag des zugehrigen Forum-Threads unter
http://hive-project.de/board/viewtopic.php?f=7&t=968 zur Verfgung.

Die Installation ist wie im Download-Archiv beschrieben vorzunehmen. Dabei wird
auch der IRC-Client in das System-Verzeichnis der TriOS SD-Card kopiert und
kann von dort gestartet werden.


Testserver
==========

Fr erste Versuche mit IRC steht ein eigener Server zur Verfgung. Dieser kann
wie folgt erreicht werden:

  IRC-Server (IP-Adresse:Port): 88.198.147.76:6667
  nutzbarer Channel:            #hive


Nutzung
=======

Start
-----

Der IRC-Client bentigt den Netzwerk-Code in Administra. Dieser kann direkt in
Administra geflasht oder durch Eingabe von "admnet" geladen werden. Beim Start
prft der IRC-Client das Vorhandensein der Netzwerk-Funktionalitten. Sind
diese nicht vorhanden, wird automatisch versucht, "/system/admnet.adm" von der
SD-Card zu laden.

Auerdem mu der Hive natrlich an ein Netzwerk mit Internet-Verbindung
angeschlossen sein und mittels "ipconfig" entsprechend konfiguriert werden.

Der Start erfolgt dann einfach durch Eingabe von "irc" am Regime-Prompt. Beim
ersten Start wird automatisch die Konfiguration aufgerufen. Nach Eingabe der
erforderlichen Parameter (s.u.) werden diese gespeichert. Nun kann mittels
Drcken von "F3" die Verbindung zum Server aufgebaut werden.


Bedienung
---------

Der IRC-Client besteht aus 3 Fenstern. Im groen oberen werden die Chat-
Mitteilungen ausgegeben. Im mittleren erscheinen verschiedene Statusmeldungen.
Im untersten Fenster werden die Mitteilungen und Befehle eingegeben.

Das aktive Fenster wird jeweils hervorgehoben und kann mittels Tabulator-Taste
umgeschalten werden. Im aktiven Fenster kann mittels Cursor hoch/runter
gescrollt werden (auer im Eingabefenster).

Die Bedienung erfolgt durch Bettigung der Funktionstasten oder die Eingabe
von Befehlen im EingabeFenster (s.u.). Alle Befehle beginnen mit einem
Schrgstrich (/).

Beim Erscheinen einer neuen Mitteilung im aktuellen Kanal blinkt die Regnatix-
LED so lange, bis eine beliebige Taste gedrckt wird. Auerdem wird ein Sound
abgespielt.


Befehlsbersicht
----------------

  Funktionstaste Eingabe 
  --------------+-------+-------------------------------------------------
  F1                     Hilfe
  F2             /set    Alle Einstellungen bearbeiten und abspeichern
  F3                     Mit Server verbinden, anmelden und Kanal betreten
  F4             /join   Kanal betreten (/join #<Kanal>)
  F5             /part   Aktuellen Kanal verlassen (/part <Mitteilung>)
  F6             /nick   Nicknamen ndern (/nick <neuer Nick>)
  F7             /user   Username ndern
  F8             /pass   Pawort ndern
  F9             /quit   Verbindung zu Server trennen
  F10                    Programm beenden
                 /msg    Private Mitteilung (/msg <Empfnger> <Text>)
                 /srv    Mit Server verbinden und anmelden (srv <IP:Port>)
                 /save   Einstellungen speichern
  Tab                    Fenster umschalten, Scrollen mit Cursor hoch/runter

Alle anderen mit '/' beginnenden Eingaben sind Befehle an den Server. Alle
Eingaben, welche nicht mit '/' beginnen, sind eine ffentliche Mitteilung an
den aktuellen Kanal.


Einstellungen
-------------

Durch Drcken von "F2" oder Eingabe von "/set" werden alle notwendigen
Einstellungen (Server, Pawort, Nickname, Username, Channel) abgefragt und
gespeichert. Zur Erstkonfiguration sollten in jedem Fall alle Parameter
mittels "F2" oder "/set" gesetzt werden.

Die Einstellungen sind auch einzeln ber die in der Befehls-bersicht
angegebenen Funktionstasten bzw. Befehle erreichbar. Mittel Eingabe
ber Befehle kann die gewnschte Einstellung meist auch als Parameter
mitgegeben werden. Im Gegensatz zu "F2" bzw. "/set" werden hier teilweise
auch gleich online die entsprechenden nderungen vorgenommen ("F6" bzw. "/nick"
ndert z.B. sofort den aktuellen Nicknamen).

Da der Hive derzeit keine Namensauflsung untersttzt, mu der Server mit IP-
Adresse und Port angegeben werden. Die IP-Adresse kann an einem PC mittels
Ping oder NSLookup ermittelt werden, der Port ist meist 6667.

Der Nickname ist der Name, unter welchem man aktuell seine Mitteilungen
schreibt. Dieser kann jederzeit gendert werden. Demgegenber ist der Username
der Name, mit welchem man sich beim Server anmeldet. Dessen nderung wirkt sich
nur bei einer erneuten Anmeldung aus. Nickname und Username knnen auch
identisch sein.

Bei der Anmeldung am Server wird auch ein vollstndiger Name bertragen. Da es
unblich ist, hier seinen richtigen Namen anzugeben, wird stattdessen ein Name
in der Form "Hive #<HiveId>" generiert. <HiveId> ist der mittels "ipconfig /i"
definierte Wert.

TODO
====

- offene Eingabefenster blockieren nicht den IRC-Empfang
- Support fr mehrere gleichzeitige Channel
