From f8c9d8d9be681e450e2f0a9940ee4ddd2e58e40b Mon Sep 17 00:00:00 2001 From: Kiyoshi Aman Date: Tue, 19 Apr 2011 04:52:56 -0400 Subject: [PATCH] doc/extended-join.txt: Document CAP extended-join. --- doc/extended-join.txt | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 doc/extended-join.txt diff --git a/doc/extended-join.txt b/doc/extended-join.txt new file mode 100644 index 00000000..35e52e71 --- /dev/null +++ b/doc/extended-join.txt @@ -0,0 +1,36 @@ +extended-join client capability specification +--------------------------------------------- + +Copyright (c) 2011 Kiyoshi Aman + +Unlimited redistribution and modification of this document is allowed +provided that the above copyright notice and this permission notice +remains intact. + +The extended-join capability extends the JOIN message to include the +account name, or a placeholder if the user hasn't identified with +services. This capability MUST be referred to as 'extended-join' at +capability negotiation time. + +When enabled, the JOIN message will designate the account name of the +user when he/she joins a channel. + +The JOIN message is one of the following: + + :nick!user@host JOIN #channelname accountname :Real Name + +This message represents that the user identified by nick!user@host has +logged in to an acount prior to channel ingress. The penultimate +parameter is the display name of that account. The last parameter is +the user's GECOS. + + :nick!user@host JOIN #channelname * :Real Name + +This message represents that the user has not logged in to an account +prior to channel ingress. As the penultimate parameter is an asterisk, +this means that an asterisk is not a valid account name (which it is +not in P10 or TS6 or ESVID). + +Please see the documentation in account-notify.txt for how to take +advantage of this capability. +