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_oaccept.c    - OACCEPT - Add metadata to a user that will allow you to
  32                            message them even if they are +gGR.
  33                  Syntax: OACCEPT <nick>
  34
  35 m_ojoin.c      - OJOIN - Join a channel through any modes or limits with
  36                          an optional status (@+)
  37                  Syntax: OJOIN [status]<channel>
  38
  39 m_olist.c      - OLIST - Lists channels like LIST, but shows hidden
  40                          channels. Oper only of course.
  41
  42 m_opme.c       - OPME - Allows an admin to op themselves in an opless channel
  43                  Syntax: OPME <channel>
  44
  45 m_omode.c      - OMODE - Allows an admin to do all sorts of evil upon a
  46                          channel, sets modes with extreme prejudice
  47
  48 m_okick.c      - OKICK - Allows an oper to kick a user from a channel
  49                          regardless of if they have ops or not.
  50                  Syntax: OKICK <channel> <nick> :<message>
  51
  52 no_oper_invis.c - Disallow opers setting marking themselves as invisible
  53                   (+i) unless they have the hidden_oper flag.
  54
  55 m_force.c        - Allows opers to FORCEJOIN users to any channel they
  56                    so desire, regardless of bans or restricting modes
  57                    that may be keeping them out. Similar to the SAJOIN
  58                    command in other ircds.
  59                    Syntax: FORCEJOIN <user> <channel>
  60
  61 example_module.c - An example module to be used for creating your own.
  62                    Syntax: TEST
  63
  64
  65 Spy Modules
  66 -----------
  67
  68 The following are the 'spy' parts, accessible via the +y snomask
  69
  70 spy_admin_notice.c   - Spy on clients doing ADMIN
  71 spy_info_notice.c    - Spy on clients doing INFO
  72 spy_links_notice.c   - Spy on clients doing LINKS
  73 spy_motd_notice.c    - Spy on clients doing MOTD
  74 spy_stats_notice.c   - Spy on clients doing all STATS
  75 spy_stats_p_notice.c - Spy on clients doing STATS p only
  76 spy_trace_notice.c   - Spy on clients doing TRACE
  77
  78 Note: if you have both spy_stats_notice.c and spy_stats_p_notice.c loaded
  79 you will get two messages.
  80
  81 Snomask Modules
  82 ---------------
  83
  84 sno_farconnect.c  - Remote client connect/exit notices (snomask +F)
  85 sno_globalkline.c - Global K/D/X-line activation notices
  86 sno_globaloper.c  - Global oper-up notices
  87 sno_whois.c       - Spy on clients who WHOIS you seeing idle time (snomask +W).
  88
  89 Extban Modules
  90 --------------
  91
  92 extb_account.so  - Account bans (+b $a[:mask])
  93 extb_canjoin.so  - Banned from another channel (+b $j:mask)
  94 extb_channel.so  - Other-channel bans (+b $c:mask)
  95 extb_extgecos.so - Extended ban (+b $x:mask)
  96 extb_oper.so     - Oper bans (+b $o)
  97 extb_realname.so - Realname (gecos) bans (+b $r:mask)
  98 extb_server.so   - Server bans (+b $s:mask)