Update example config for passforward and RPC module changes [jdhore]

[user/henk/code/inspircd.git] / docs / modules.conf.example

diff --git a/docs/modules.conf.example b/docs/modules.conf.example
index 82e722f59872119491998f10a349a6e787a092f9..4db33190d820324d9041b78918fdf927236a24c3 100644 (file)
--- a/docs/modules.conf.example
+++ b/docs/modules.conf.example
@@ -1243,6 +1243,26 @@
 # This module is oper-only. For the user equivalent, see m_conn_umodes
 #<module name="m_opermodes.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Password forwarding module: Forwards a password users can send on connect
+# to the specified client below. The client is usually nickserv and this
+# module is usually used to authenticate users with nickserv using their
+# connect password.
+#<module name="m_passforward.so">
+
+<passforward
+               # nick: nick to forward connect passwords to.
+               nick="NickServ"
+
+               # forwardmsg: Message to send to users using a connect password.
+               # $nick will be the users' nick, $nickrequired will be the nick
+               # of where the password is going (the nick above).
+               forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
+
+               # cmd: Command for the nick to run when it recieves a connect
+               # password. 
+               cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper password hash module: Allows hashed oper passwords
 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
@@ -1407,14 +1427,6 @@
 # use glob. For this reason, is recommended to use a real regex engine
 # so that at least \s or [[:space:]] is available.
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# JSON-RPC module: Encode and decode JSON-RPC requests for modules
-#<module name="m_rpc_json.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# RPC test module: A test of the RPC API
-#<module name="m_rpctest.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SAJOIN module: Adds the /SAJOIN command
 # This module is oper-only.