Import from http://svn.freenode.net/ircd-seven/private/beu/seven (r196).
[seven-1.x.git] / doc / services.txt
blob1388491fee5bc7d6961a5e1ad1fc8cdafccbd488
1 ratbox-services compatibility documentation - Lee H <lee -at- leeh.co.uk>
2 -------------------------------------------------------------------------
4 Compatibility with ratbox-services can be enabled by passing the
5 '--enable-services' flag to configure.  It will add the following features
6 to ircd:
8 1. Channel mode +r
10    A simple mode taking no parameters, will require users are logged in
11    with user services before they may join the channel.
13    Gives numeric 477 to users who arent logged in:
14    :<server> 477 <nick> <channel> :Cannot join channel (+r)
16 2. service block to ircd.conf
18    Ability to specify the names of services servers in ircd.conf:
19    service {
20        name = "services.ircd-ratbox.org";
21        name = "backup-services.ircd-ratbox.org";
22    };
24    These must be specified for certain features to work.  You may specify as
25    many name entries as you wish, however you must define only one service
26    block.
28    Entries will be listed in stats U with the flag 's'.
30 3. Services protection
32    Services will be protected from being deopped or kicked from a channel.
34 4. Username tracking through netsplits
36    When users are logged in, the username they are logged in with will be
37    preserved on a netsplit, so users will not have to relogin when the
38    network merges together.
40 5. Username given on WHOIS
42    When users are logged in, WHOIS will also give numeric 330:
43    :<server> 330 <yournick> <targetnick> <loginname> :is logged in as
45    Note this needs to be a remote whois to work when the target is
46    on a different server.
48 6. Forced nick change
50    When using nickname services and a client requests they regain a
51    nickname, services can perform a forced nick change on the client.
52    This forcibly changes the clients nickname to the one they requested
53    they regain, ensuring they can always regain their nickname.
55 # $Id: services.txt 26 2006-09-20 18:02:06Z spb $