mirror of
https://github.com/osmarks/ngircd.git
synced 2025-01-09 15:20:28 +00:00
Enhance documentation for the WEBIRC command
This commit is contained in:
parent
53fecf5a2b
commit
07f241ff6d
@ -161,3 +161,17 @@ and therefore can't be omitted. The parameter <limit> must be ignored when
|
|||||||
a channel has no user limit (the parameter <modes> doesn't list the "l"
|
a channel has no user limit (the parameter <modes> doesn't list the "l"
|
||||||
channel mode). In this case <limit> should be "0".
|
channel mode). In this case <limit> should be "0".
|
||||||
|
|
||||||
|
|
||||||
|
II.4 Update webchat/proxy client information
|
||||||
|
|
||||||
|
Command: WEBIRC
|
||||||
|
Parameters: <password> <username> <hostname> <ip-address>
|
||||||
|
Used by: unregistered clients only
|
||||||
|
|
||||||
|
The WEBIRC command is used by some Web-to-IRC gateways to set the correct
|
||||||
|
user name and host name of users instead of their own. It must be the very
|
||||||
|
first command sent to the server, even before USER and NICK commands!
|
||||||
|
|
||||||
|
The <password> must be set in the server configuration file to prevent
|
||||||
|
unauthorized clients to fake their identity; it is an arbitrary string.
|
||||||
|
|
||||||
|
@ -596,8 +596,14 @@ IRC_SERVICE(CLIENT *Client, REQUEST *Req)
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handler for the IRC command "WEBIRC".
|
* Handler for the IRC "WEBIRC" command.
|
||||||
* Syntax: WEBIRC <password> <username> <real-hostname> <real-IP-address>
|
*
|
||||||
|
* See doc/Protocol.txt, section II.4:
|
||||||
|
* "Update webchat/proxy client information".
|
||||||
|
*
|
||||||
|
* @param Client The client from which this command has been received.
|
||||||
|
* @param Req Request structure with prefix and all parameters.
|
||||||
|
* @returns CONNECTED or DISCONNECTED.
|
||||||
*/
|
*/
|
||||||
GLOBAL bool
|
GLOBAL bool
|
||||||
IRC_WEBIRC(CLIENT *Client, REQUEST *Req)
|
IRC_WEBIRC(CLIENT *Client, REQUEST *Req)
|
||||||
|
Loading…
Reference in New Issue
Block a user