IRCX Draft
		Next

IRCX Draft

Dalen Abraham

Edited by

Keith Gable

Copyright © 1998 Dalen Abraham

This is an INTERNET-DRAFT written by Dalen Abraham of Microsoft Corporation. It has been translated into DocBook format by Keith Gable of The Ignition Project.

Copyright (c) 1998 Dalen Abraham. DocBook translation Copyright (c) 2004 Keith Gable.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Table of Contents

Changes Made to the IRCX Draft

Status of this Memo

1. Modified UTF8 Encoding of UNICODE characters

2. Terms and Definitions

User Access Levels
Prefixes

3. IRCX Client Messages

ACCESS command (new IRCX command)

Parameters
Results
Possible Errors
Remarks
Examples

AUTH Command (new IRCX command)

Parameters
Results
Possible Errors
Remarks
Example

CREATE (new IRCX command)

Parameters
Results
Possible Errors
Remarks
Example

DATA / REQUEST / REPLY (new IRCX command)

Parameters
Results
Possible Errors
Remarks
Example

EVENT (new IRCX command)

Parameters
Results
Possible Errors
Remarks
Examples

IRCX (new IRCX command)

Parameters
Results
Example

ISIRCX (new IRCX command)

Parameters
Results
Example

LISTX (new IRCX command)

Parameters
Results
Remarks

MODE (extension to RFC1459 command)

Parameters
Results
Remarks

NOTICE (extension to RFC1459 command)

Results

PRIVMSG (extension to RFC1459 command)

Results

PROP (new IRCX command)

Results
Possible Errors
Remarks
Examples

WHISPER (new IRCX command)

Results
Possible Errors
Remarks
Examples

4. IRCX Server Messages

AUTH (new IRCX message)

Parameters
Remarks

CLONE (new IRCX message)

Parameters
Remarks
Example

CREATE (new IRCX message)

Remarks
Example

DATA / REQUEST / REPLY (new IRCX messages)

Parameters
Remarks

EVENT (new IRCX message)

Parameters
Example

KNOCK (new IRCX message)

Parameters
Remarks

REDIRECT (new IRCX message)

Parameters
Remarks
Example

WHISPER (new IRCX message)

Parameters
Remarks
Example

5. User Modes and Properties

OWNER (IRCX +q)
GAG (IRCX +z)

6. Channel Modes and Properties

PUBLIC (RFC1459 default)
PRIVATE (RFC1459 +p)
HIDDEN (IRCX +h)
SECRET (RFC1459 +s)
MODERATED (RFC1459 +m)
NOEXTERN (RFC1459 +n)
TOPICOP (RFC1459 +t)
INVITE (RFC1459 +i)
KNOCK (IRCX +u)
NOFORMAT (IRCX +f)
NOWHISPER (IRCX +w)
AUDITORIUM (IRCX +x)
REGISTERED (IRCX +r)
SERVICE (IRCX +z)
AUTHONLY (IRCX +a)
CLONEABLE (IRCX +d)
CLONE (IRCX +e)

OID (Read Only)
NAME (Read Only)
CREATION (Read Only)
LANGUAGE
OWNERKEY (Write Only)
HOSTKEY (Write Only)
MEMBERKEY (Write Only)
PICS
TOPIC
SUBJECT
CLIENT
ONJOIN
ONPART
LAG
ACCOUNT
CLIENTGUID
SERVICEPATH

7. IRCX Command Responses

Command Replies

800 - IRCRPL_IRCX
801 - IRCRPL_ACCESSADD
802 - IRCRPL_ACCESSDELETE
803 - IRCRPL_ACCESSSTART
804 - IRCRPL_ACCESSLIST
805 - IRCRPL_ACCESSEND
806 - IRCRPL_EVENTADD
807 - IRCRPL_EVENTDEL
808 - IRCRPL_EVENTSTART
809 - IRCRPL_EVENTLIST
810 - IRCRPL_EVENTEND
811 - IRCRPL_LISTXSTART
812 - IRCRPL_LISTXLIST
813 - IRCRPL_LISTXPICS
816 - IRCRPL_LISTXTRUNC
817 - IRCRPL_LISTXEND
818 - IRCRPL_PROPLIST
819 - IRCRPL_PROPEND

IRCX Error Replies

900 - IRCERR_BADCOMMAND
901 - IRCERR_TOOMANYARGUMENTS
902 - IRCERR_BADFUNCTION
903 - IRCERR_BADLEVEL
904 - IRCERR_BADTAG
905 - IRCERR_BADPROPERTY
906 - IRCERR_BADVALUE
907 - IRCERR_RESOURCE
908 - IRCERR_SECURITY
909 - IRCERR_ALREADYAUTHENTICATED
910 - IRCERR_AUTHENTICATIONFAILED
911 - IRCERR_AUTHENTICATIONSUSPENDED
912 - IRCERR_UNKNOWNPACKAGE
913 - IRCERR_NOACCESS
914 - IRCERR_DUPACCESS
915 - IRCERR_MISACCESS
916 - IRCERR_TOOMANYACCESSES
918 - IRCERR_EVENTDUP
919 - IRCERR_EVENTMIS
920 - IRCERR_NOSUCHEVENT
921 - IRCERR_TOOMANYEVENTS
923 - IRCERR_NOWHISPER
926 - IRCERR_CHANNELEXIST
927 - IRCERR_ALREADYONCHANNEL
999 - IRCERR_UNKNOWNERROR

8. Security Considerations

9. Acknowledgements

10. References

11. Authors' Addresses

A. GNU Free Documentation License

PREAMBLE
APPLICABILITY AND DEFINITIONS
VERBATIM COPYING
COPYING IN QUANTITY
MODIFICATIONS
COMBINING DOCUMENTS
COLLECTIONS OF DOCUMENTS
AGGREGATION WITH INDEPENDENT WORKS
TRANSLATION
TERMINATION
FUTURE REVISIONS OF THIS LICENSE
ADDENDUM: How to use this License for your documents

List of Tables

1.1. Character Quoting in UTF-8
2.1. Definition of Terms
2.2. Definition of Client Levels
2.3. Object identifiers
3.1. Access Levels
3.2. Query terms for LIST command
3.3. Character escaping in mask-string

List of Examples

3.1. Make a user, "piper", a channel host when they join the channel, "#mychan"
3.2. Grant normal access to the network to a few people but deny access to all others
3.3. Delete the DENY access record on the network that denies access to '*'
3.4. Clear all DENY-level entries on the local server
3.5. Clear all access entries of any level for a channel
3.6. Authentication Example
3.7. Creation Example
3.8. Sending ad banners from server sysop to channel, "#Channel"
3.9. Add channel events
3.10. List all events with no active events returned
3.11. Enable IRCX for the connection on a server that supports IRCX and three authentication packages
3.12. Check the server's IRCX support on a server that does not support authentication, before the user has enabled IRCX
3.13. Possible way to handle a "contextual NOTICE"
3.14. Possible way to handle a "contextual PRIVMSG"
3.15. Check two properties
3.16. Change the TOPIC property
3.17. Send a WHSIPER to a user who is using IRCX
3.18. Send a WHISPER to a user who is not using IRCX
4.1. A clone of #MyChat is created
4.2. #MyChat1 was created
4.3. Event generated when a user logs on
4.4. Redirect Example
4.5. Whisper Message Example

		Next
		Changes Made to the IRCX Draft