Added tag shadowircd-6.3.0 for changeset 031bedf7e340

[irc/rqf/shadowircd.git] / extensions / README

diff --git a/extensions/README b/extensions/README
index 51bd10c697e6638ea5757fdb5fcd22a5c832b326..d1b5b0d5cc2ccfd2830ec78a09f6fb3d08aa7cbb 100644 (file)
--- a/extensions/README
+++ b/extensions/README
@@ -11,19 +11,32 @@ Modules
 createauthonly.c - Only allow authenticated (identified) users to create
                    channels.
 
-ip_cloaking.c  - Cloak (spoof) the host for users that have umode +h.
+ip_cloaking.c  - Cloak (spoof) the host for users that have umode +x.
 
 m_42.c         - The Answer to Life, the Universe, and Everything.
                  Syntax: 42
 
+m_adminwall.c  - Sends a message to all admins network-wide (umode +a)
+                 Syntax: ADMINWALL :<message>
+
+m_cycle - Server-side /CYCLE (also called /HOP in some clients/servers).
+          Syntax: CYCLE <#channel>
+
 m_findforwards.c - Find channels that forward (+f) to a given channel.
                    Syntax: FINDFORWARDS <channel>
 
+m_identify.c - Identifies to NickServ or ChanServ
+               Syntax: IDENTIFY [nick|channel] <password>
+
 m_mkpasswd.c   - MKPASSWD - generate a DES or MD5 encryption of a password
                  Syntax:  MKPASSWD <plaintext> [MD5|DES]
 
+m_oaccept.c    - OACCEPT - Add metadata to a user that will allow you to
+                           message them even if they are +gGR.
+                 Syntax: OACCEPT <nick>
+
 m_ojoin.c      - OJOIN - Join a channel through any modes or limits with 
-                         an optional status (@%+)
+                         an optional status (!@%+)
                  Syntax: OJOIN [status]<channel>
 
 m_olist.c      - OLIST - Lists channels like LIST, but shows hidden
@@ -35,9 +48,21 @@ m_opme.c       - OPME - Allows an admin to op themselves in an opless channel
 m_omode.c      - OMODE - Allows an admin to do all sorts of evil upon a
                         channel, sets modes with extreme prejudice
 
+m_okick.c      - OKICK - Allows an oper to kick a user from a channel
+                         regardless of if they have ops or not.
+                 Syntax: OKICK <channel> <nick> :<message>
+
+m_roleplay.c   - ROLEPLAY - Allows a variety of roleplaying commands.
+
 no_oper_invis.c - Disallow opers setting marking themselves as invisible
                   (+i) unless they have the hidden_oper flag.
 
+m_force.c        - Allows opers to FORCEJOIN users to any channel they
+                   so desire, regardless of bans or restricting modes
+                   that may be keeping them out. Similar to the SAJOIN
+                   command in other ircds.
+                   Syntax: FORCEJOIN <user> <channel>
+
 example_module.c - An example module to be used for creating your own.
                    Syntax: TEST
 
@@ -45,7 +70,7 @@ example_module.c - An example module to be used for creating your own.
 Spy Modules
 -----------
 
-The following are the 'spy' parts, accessible via the +y usermode
+The following are the 'spy' parts, accessible via the +y snomask
 
 spy_admin_notice.c   - Spy on clients doing ADMIN
 spy_info_notice.c    - Spy on clients doing INFO
@@ -53,9 +78,7 @@ spy_links_notice.c   - Spy on clients doing LINKS
 spy_motd_notice.c    - Spy on clients doing MOTD
 spy_stats_notice.c   - Spy on clients doing all STATS
 spy_stats_p_notice.c - Spy on clients doing STATS p only
-spy_trace_notice.c   - Spy on clients doing TRACE/LTRACE
-spy_whois_notice.c   - Spy on local clients who WHOIS you.
-spy_whois_notice_global.c - Spy on remote clients who WHOIS you.
+spy_trace_notice.c   - Spy on clients doing TRACE
 
 Note: if you have both spy_stats_notice.c and spy_stats_p_notice.c loaded
 you will get two messages.
@@ -66,3 +89,15 @@ Snomask Modules
 sno_farconnect.c  - Remote client connect/exit notices (snomask +F)
 sno_globalkline.c - Global K/D/X-line activation notices
 sno_globaloper.c  - Global oper-up notices
+sno_whois.c       - Spy on clients who WHOIS you seeing idle time (snomask +W).
+
+Extban Modules
+--------------
+
+extb_account.so  - Account bans (+b $a[:mask])
+extb_canjoin.so  - Banned from another channel (+b $j:mask)
+extb_channel.so  - Other-channel bans (+b $c:mask)
+extb_extgecos.so - Extended ban (+b $x:mask)
+extb_oper.so     - Oper bans (+b $o)
+extb_realname.so - Realname (gecos) bans (+b $r:mask)
+extb_server.so   - Server bans (+b $s:mask)