]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - conf/inspircd.helpop.example
As we have an enum for type, why not ..use it?
[user/henk/code/inspircd.git] / conf / inspircd.helpop.example
1 # Sample configuration file for m_helpop.so
2 # You can either copy this into your conf folder and set up the module to use it,
3 # or you can customize the responses for your network and/or add more.
4 #
5 # The way the new helpop system works is simple. You use one or more helpop tags.
6 #   <helpop key="moo" value="something here">.
7 # key is what the user is looking for (i.e. /helpop moo), and value is what they get back
8 # (note that it can span multiple lines!).
9 #   -- w00t 16/dec/2006
10 #
11
12 <helpop key="start" value="     InspIRCd help system
13      --------------------
14 -
15 This system provides help for commands and modes.
16 Specify your question or a command name as the
17 parameter for this command.
18 -
19 /HELPOP COMMANDS      -      To see a list of commands
20 /HELPOP UMODES        -      To see a list of user modes
21 /HELPOP CHMODES       -      To see a list of channel modes">
22
23 <helpop key="nohelp" value="There is no help for the topic
24 You searched for. Please try again.">
25
26 <helpop key="commands" value="User Commands
27 -------------
28 USER     NICK    QUIT    VERSION     PING
29 PONG     ADMIN   PRIVMSG INFO        TIME
30 WHOIS    NOTICE  JOIN    NAMES       PART
31 KICK     MODE    TOPIC   WHO         MOTD
32 RULES    OPER    LIST    LUSERS      STATS
33 USERHOST AWAY    ISON    SUMMON      USERS
34 INVITE   PASS    WHOWAS  LINKS       MAP
35 COMMANDS MODULES
36  
37 Oper Commands
38 -------------
39 DIE      RESTART KILL    REHASH      TRACE
40 CONNECT  SQUIT   MODULES KLINE       ZLINE
41 QLINE    GLINE   ELINE">
42
43
44 <helpop key="umodes" value="User Modes
45 ----------
46 o                Is an IRC operator
47 i                Is invisible to /WHO
48 w                Can receive wallops messages
49 s                Can receive server notices
50 n [mask]         Can receive server notices specified by [mask], or * for all.
51 x                Cloaked hostname (requires cloaking module)
52 h                Will receive helpops notification (requires helpop module)">
53
54 <helpop key="chmodes" value="Channel Modes
55 -------------
56 v [nickname]     Gives voice to [nickname] (can talk on +m channel)
57 h [nickname]     Gives halfops to [nickname] (requires halfop module)
58 o [nickname]     Gives ops to [nickname]
59 b [hostmask]     Bans [hostmask] on the channel
60 a [nickname]     Give protected status to [nickname] (+q only)
61 q [nickname]     Give founder status to [nickname] (ulines only)
62 i                Make the channel invite only, must /INVITE users
63 k [key]          Set the channel key (password) to [key]
64 l [limit]        Set the maximum possible users to [limit]
65 m                Enable moderation. Only +vo(h) can speak
66 n                Only users who are members of the channel may message it
67 p                Make channel private (hide from /LIST)
68 s                Make channel secret (can't be used at the same time as +p)
69 O                Channel is IRCops only (can only be set by IRCops)
70 t                Only halfops and above can change the topic
71 Q                Only U-Lined servers/nicks can kick
72 T                Only halfops/ops can send NOTICEs to the channel
73 C                No CTCPs allowed to the channel
74 c                mIRC colour codes blocked on the channel
75 K                No /KNOCK allowed to channel (if knock module is loaded)
76 L [channel]      If the channel is full, redirect users to [channel]
77 N                No nickchanges while on the channel
78 -------------
79 NOTE: A large number of these modes are dependent upon server-side modules
80 being loaded by a server/network administrator. The actual modes available
81 on your network may be very different to this list. Please consult your
82 help channel if you have any questions.">
83