extensions/README

   1 $Id: README 1622 2006-06-04 03:01:05Z beu $
   2
   3 This directory contains extensions (modules) to charybdis ircd that
   4 have been contributed by other people, or written by our development
   5 team.  Unsupported extensions live under unsupported/.
   6
   7
   8 Modules
   9 -------
  10
  11 createauthonly.c - Only allow authenticated (identified) users to create
  12                    channels.
  13
  14 ip_cloaking.c  - Cloak (spoof) the host for users that have umode +x.
  15
  16 m_42.c         - The Answer to Life, the Universe, and Everything.
  17                  Syntax: 42
  18
  19 m_adminwall.c  - Sends a message to all admins network-wide (umode +a)
  20                  Syntax: ADMINWALL :<message>
  21
  22 m_findforwards.c - Find channels that forward (+f) to a given channel.
  23                    Syntax: FINDFORWARDS <channel>
  24
  25 m_identify.c - Identifies to NickServ or ChanServ
  26                Syntax: IDENTIFY [nick|channel] <password>
  27
  28 m_mkpasswd.c   - MKPASSWD - generate a DES or MD5 encryption of a password
  29                  Syntax:  MKPASSWD <plaintext> [MD5|DES]
  30
  31 m_ojoin.c      - OJOIN - Join a channel through any modes or limits with
  32                          an optional status (@+)
  33                  Syntax: OJOIN [status]<channel>
  34
  35 m_olist.c      - OLIST - Lists channels like LIST, but shows hidden
  36                          channels. Oper only of course.
  37
  38 m_opme.c       - OPME - Allows an admin to op themselves in an opless channel
  39                  Syntax: OPME <channel>
  40
  41 m_omode.c      - OMODE - Allows an admin to do all sorts of evil upon a
  42                          channel, sets modes with extreme prejudice
  43
  44 no_oper_invis.c - Disallow opers setting marking themselves as invisible
  45                   (+i) unless they have the hidden_oper flag.
  46
  47 m_force.c        - Allows opers to FORCEJOIN users to any channel they
  48                    so desire, regardless of bans or restricting modes
  49                    that may be keeping them out. Similar to the SAJOIN
  50                    command in other ircds.
  51                    Syntax: FORCEJOIN <user> <channel>
  52
  53 example_module.c - An example module to be used for creating your own.
  54                    Syntax: TEST
  55
  56
  57 Spy Modules
  58 -----------
  59
  60 The following are the 'spy' parts, accessible via the +y snomask
  61
  62 spy_admin_notice.c   - Spy on clients doing ADMIN
  63 spy_info_notice.c    - Spy on clients doing INFO
  64 spy_links_notice.c   - Spy on clients doing LINKS
  65 spy_motd_notice.c    - Spy on clients doing MOTD
  66 spy_stats_notice.c   - Spy on clients doing all STATS
  67 spy_stats_p_notice.c - Spy on clients doing STATS p only
  68 spy_trace_notice.c   - Spy on clients doing TRACE
  69
  70 Note: if you have both spy_stats_notice.c and spy_stats_p_notice.c loaded
  71 you will get two messages.
  72
  73 Snomask Modules
  74 ---------------
  75
  76 sno_farconnect.c  - Remote client connect/exit notices (snomask +F)
  77 sno_globalkline.c - Global K/D/X-line activation notices
  78 sno_globaloper.c  - Global oper-up notices
  79 sno_whois.c       - Spy on clients who WHOIS you seeing idle time (snomask +W).
  80
  81 Extban Modules
  82 --------------
  83
  84 extb_account.so  - Account bans (+b $a[:mask])
  85 extb_canjoin.so  - Banned from another channel (+b $j:mask)
  86 extb_channel.so  - Other-channel bans (+b $c:mask)
  87 extb_extgecos.so - Extended ban (+b $x:mask)
  88 extb_oper.so     - Oper bans (+b $o)
  89 extb_realname.so - Realname (gecos) bans (+b $r:mask)
  90 extb_server.so   - Server bans (+b $s:mask)