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