

[1mMicroIRC[0m
********

Welcome to [3mMicroIRC[0m, the AmigaOS IRC client.

Copyright
*********

Copyright
=========

MicroIRC has been designed, developed and written by

     Oliver Wagner
     Landsberge 5
     45549 Sprockhövel
     Germany
     E-Mail: (o.wagner@lsd.wupper.de)

All Rights Reserved.

Thanksgiving
============

The author wishes to thank the following people for their help during
MicroIRC development:

[3mYet to write, see About ;-)[0m
What is IRC, by the way?
************************

Introduction
============

Yet to write

Getting MicroIRC to run
***********************

Requirements
============

Yet to write

Connecting to a server
**********************

Setup
=====

Yet to write

Sending commands to other people
********************************

Introduction
============

Yet to write

Direct client connections
*************************



Yet to write

Commands
********

Overview
========

MicroIRC has several builtin commands. Some of this commands are
processed locally, whereas others are send to the IRC server.

Commands generally start with a / to differentiate them from normal
text. If you want to use the / character at the start of normal text,
use [1m//[0m instead.

Many commands require a channel name as a parameter. MicroIRC will
automatically fill in the channel name of the current window if you
don't specify a channel name on your own.

For commands which require a nick name (e.g. [1m/MSG[0m or [1m/OP[0m, there
are three special shortcut arguments:

[1m.[0m
     The period is replaced with the nickname of the last person you
     have send a private message to.

[1m,[0m
     The comma is replaced with the nickname of the last person who
     send a message to you. Be careful with this, since you might
     easily address the wrong person if someone sends you a message
     while you are still typing this command!

[1m:[0m
     The colon is replaced with the nickname of the last person which
     you haved a addressed with a [1mnick:[0m prefix inside a channel.

Reference
=========

JOIN
----

Usage: [1m/JOIN channel[,channel[,...]] [key[,key[,...]]][0m
Usage: [1m/CHANNEL channel[,channel[,...]] [key[,key[,...]]][0m

DESCRIPTION:

Join a channel on the IRC.  If the channel doesn't exists, it is
automatically created.

There are two kinds of channels:  Channel names starting with an
[3m#[0m are global channels and available on all IRC servers which
are connected to the net you are currently on.  Channels which begin
with [3m&[0m are local to the chat server you are connected to.

If a channel requires a special keyword to join, you must submit this
after the channel name.

MicroIRC will look for a channel window which isn't currently bound to
a channel. If it doesn't find one, a new window will be created and
bound to this channel.

EXAMPLES:

[1m/JOIN #Amigager[0m
     Join channel [3m#AmigaGER[0m

[1m/JOIN #Amigager,#Amiga[0m
     Join channels [3m#AmigaGER[0m and [3m#Amiga[0m

[1m/JOIN #Amigawarez coolstuff[0m
     Join channel [3m#Amigawarez[0m with keyword [3mcoolstuff[0m.

RELATED TOPICS:

See LEAVE.

LEAVE
-----

Usage: [1m/LEAVE [channel[,channel[,...]][0m

DESCRIPTION:

Leaves a channel. If you don't give a channel name as a parameter, the
channel currently bound to the window in which in the command is
entered will be left.

EXAMPLES:

[1m/LEAVE[0m
     Leave the channel currently bound to this window.

[1m/LEAVE #Amigawarez[0m
     Leave channel [3m#Amigawarez[0m.

RELATED TOPICS:

See JOIN.

RAW
---

Usage: [1m/RAW text[0m

DESCRIPTION:

Sends text directly to the IRC server without any further processing.
[3mWarning:[0m Don't even think about using this command without interior
knowledge of the IRC protocol, or you might run into severe trouble.
See `RFC 1459' for a description of the IRC protocol.

EXAMPLES:

[1m/RAW JOIN #IRC-Heros[0m
     Send the string [3mJOIN #IRC-Heros[0m directly to the IRC server.

RELATED TOPICS:

`RFC 1459'.

Customizing your environment
****************************

Overview
========

Yet to write

CTCP commands
*************

Overview
========

Yet to write

MicroIRC's ARexx Port
*********************

Overview
========

MicroIRC supports a versatile ARexx Port.

Reference
=========

SAY
---

Usage: [1mSAY TEXT/F[0m

DESCRIPTION:

Treats [3mTEXT[0m just like it has been entered in the string gadget of the
current window.

EXAMPLES:

    [1msay '/JOIN #Amigager'[0m

RELATED TOPICS:

ISCONNECTED
-----------

Usage: [1mISCONNECTED[0m

DESCRIPTION:

Checks whether a connection is currently established. Returns RC 0 if
the link is up, RC 5 otherwise.

EXAMPLES:

    [1mISCONNECTED; say rc[0m

RELATED TOPICS:

GETMYNICK
---------

Usage: [1mGETMYNICK[0m

DESCRIPTION:

Returns your current nickname.

EXAMPLES:

    [1mGETMYNICK; say result[0m

RELATED TOPICS: See RX_GETSERVERNAME.

GETSERVERNAME
-------------

Usage: [1mGETSERVERNAME[0m

DESCRIPTION:

Returns the name of the IRC server you are currently connected to.

EXAMPLES:

    [1mGETSERVERNAME; say result[0m

RELATED TOPICS: See RX_GETMYNICK.

USERHOST
--------

Usage: [1mUSERHOST NICK/A[0m

DESCRIPTION:

Returns the userhost specification belonging to [3mNICK[0m.
AMIRC keeps a internal list of the userhosts of every nick that occured
yet. You can query this database with this command.  Note however that
it is possible that the userhost isn't in the database yet; this
command will [3mnot[0m query the server than, but simply return an error.

EXAMPLES:

    [1mUSERHOST Olli; say result[0m

RELATED TOPICS: See RX_GETMYNICK.

NYI
***

Overview
========

Yet to write

Index
*****


