1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/extended-join.txt	Tue Apr 19 04:53:14 2011 -0400
     1.3 @@ -0,0 +1,36 @@
     1.4 +extended-join client capability specification
     1.5 +---------------------------------------------
     1.6 +
     1.7 +Copyright (c) 2011 Kiyoshi Aman <kiyoshi.aman@gmail.com>
     1.8 +
     1.9 +Unlimited redistribution and modification of this document is allowed
    1.10 +provided that the above copyright notice and this permission notice
    1.11 +remains intact.
    1.12 +
    1.13 +The extended-join capability extends the JOIN message to include the
    1.14 +account name, or a placeholder if the user hasn't identified with
    1.15 +services. This capability MUST be referred to as 'extended-join' at
    1.16 +capability negotiation time.
    1.17 +
    1.18 +When enabled, the JOIN message will designate the account name of the
    1.19 +user when he/she joins a channel.
    1.20 +
    1.21 +The JOIN message is one of the following:
    1.22 +
    1.23 +    :nick!user@host JOIN #channelname accountname :Real Name
    1.24 +
    1.25 +This message represents that the user identified by nick!user@host has
    1.26 +logged in to an acount prior to channel ingress. The penultimate
    1.27 +parameter is the display name of that account. The last parameter is
    1.28 +the user's GECOS.
    1.29 +
    1.30 +    :nick!user@host JOIN #channelname * :Real Name
    1.31 +
    1.32 +This message represents that the user has not logged in to an account
    1.33 +prior to channel ingress. As the penultimate parameter is an asterisk,
    1.34 +this means that an asterisk is not a valid account name (which it is
    1.35 +not in P10 or TS6 or ESVID).
    1.36 +
    1.37 +Please see the documentation in account-notify.txt for how to take
    1.38 +advantage of this capability.
    1.39 +