]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - conf/inspircd.helpop.example
Document users/auspex priv, also clarify documentation a tiny bit to make them sound...
[user/henk/code/inspircd.git] / conf / inspircd.helpop.example
index 109a934a39debe1cea8fe1324fa5f027b17b228f..a02847ad04106c8bd1d27a85f12c0c405317461c 100644 (file)
@@ -1 +1,83 @@
-# Sample configuration file for m_helpop.so\r# You can either copy this into your conf folder and set up the module to use it,\r# or you can customize the responses for your network and/or add more.\r#\r# The way the new helpop system works is simple. You use one or more helpop tags.\r#   <helpop key="moo" value="something here">.\r# key is what the user is looking for (i.e. /helpop moo), and value is what they get back\r# (note that it can span multiple lines!).\r#   -- w00t 16/dec/2006\r#\r\r<helpop key="start" value="     InspIRCd help system\r     --------------------\r-\rThis system provides help for commands and modes.\rSpecify your question or a command name as the\rparameter for this command.\r-\r/HELPOP COMMANDS      -      To see a list of commands\r/HELPOP UMODES        -      To see a list of user modes\r/HELPOP CHMODES       -      To see a list of channel modes">\r\r<helpop key="nohelp" value="There is no help for the topic\rYou searched for. Please try again.">\r\r<helpop key="commands" value="User Commands\r-------------\rUSER     NICK    QUIT    VERSION     PING\rPONG     ADMIN   PRIVMSG INFO        TIME\rWHOIS    NOTICE  JOIN    NAMES       PART\rKICK     MODE    TOPIC   WHO         MOTD\rRULES    OPER    LIST    LUSERS      STATS\rUSERHOST AWAY    ISON    SUMMON      USERS\rINVITE   PASS    WHOWAS  LINKS       MAP\rCOMMANDS MODULES\r \rOper Commands\r-------------\rDIE      RESTART KILL    REHASH      TRACE\rCONNECT  SQUIT   MODULES KLINE       ZLINE\rQLINE    GLINE   ELINE">\r\r\r<helpop key="umodes" value="User Modes\r----------\ro                Is an IRC operator\ri                Is invisible to /WHO\rw                Can receive wallops messages\rs                Can receive server notices\rn [mask]         Can receive server notices specified by [mask], or * for all.\rx                Cloaked hostname (requires cloaking module)\rh                Will receive helpops notification (requires helpop module)">\r\r<helpop key="chmodes" value="Channel Modes\r-------------\rv [nickname]     Gives voice to [nickname] (can talk on +m channel)\rh [nickname]     Gives halfops to [nickname] (requires halfop module)\ro [nickname]     Gives ops to [nickname]\rb [hostmask]     Bans [hostmask] on the channel\ra [nickname]     Give protected status to [nickname] (+q only)\rq [nickname]     Give founder status to [nickname] (ulines only)\ri                Make the channel invite only, must /INVITE users\rk [key]          Set the channel key (password) to [key]\rl [limit]        Set the maximum possible users to [limit]\rm                Enable moderation. Only +vo(h) can speak\rn                Only users who are members of the channel may message it\rp                Make channel private (hide from /LIST)\rs                Make channel secret (can't be used at the same time as +p)\rO                Channel is IRCops only (can only be set by IRCops)\rt                Only halfops and above can change the topic\rQ                Only U-Lined servers/nicks can kick\rT                Only halfops/ops can send NOTICEs to the channel\rC                No CTCPs allowed to the channel\rc                mIRC colour codes blocked on the channel\rK                No /KNOCK allowed to channel (if knock module is loaded)\rL [channel]      If the channel is full, redirect users to [channel]\rN                No nickchanges while on the channel\r-------------\rNOTE: A large number of these modes are dependent upon server-side modules\rbeing loaded by a server/network administrator. The actual modes available\ron your network may be very different to this list. Please consult your\rhelp channel if you have any questions.">\r\r
\ No newline at end of file
+# Sample configuration file for m_helpop.so
+# You can either copy this into your conf folder and set up the module to use it,
+# or you can customize the responses for your network and/or add more.
+#
+# The way the new helpop system works is simple. You use one or more helpop tags.
+#   <helpop key="moo" value="something here">.
+# key is what the user is looking for (i.e. /helpop moo), and value is what they get back
+# (note that it can span multiple lines!).
+#   -- w00t 16/dec/2006
+#
+
+<helpop key="start" value="     InspIRCd help system
+     --------------------
+-
+This system provides help for commands and modes.
+Specify your question or a command name as the
+parameter for this command.
+-
+/HELPOP COMMANDS      -      To see a list of commands
+/HELPOP UMODES        -      To see a list of user modes
+/HELPOP CHMODES       -      To see a list of channel modes">
+
+<helpop key="nohelp" value="There is no help for the topic
+You searched for. Please try again.">
+
+<helpop key="commands" value="User Commands
+-------------
+USER     NICK    QUIT    VERSION     PING
+PONG     ADMIN   PRIVMSG INFO        TIME
+WHOIS    NOTICE  JOIN    NAMES       PART
+KICK     MODE    TOPIC   WHO         MOTD
+RULES    OPER    LIST    LUSERS      STATS
+USERHOST AWAY    ISON    SUMMON      USERS
+INVITE   PASS    WHOWAS  LINKS       MAP
+COMMANDS MODULES
+Oper Commands
+-------------
+DIE      RESTART KILL    REHASH      TRACE
+CONNECT  SQUIT   MODULES KLINE       ZLINE
+QLINE    GLINE   ELINE">
+
+
+<helpop key="umodes" value="User Modes
+----------
+o                Is an IRC operator
+i                Is invisible to /WHO
+w                Can receive wallops messages
+s                Can receive server notices
+n [mask]         Can receive server notices specified by [mask], or * for all.
+x                Cloaked hostname (requires cloaking module)
+h                Will receive helpops notification (requires helpop module)">
+
+<helpop key="chmodes" value="Channel Modes
+-------------
+v [nickname]     Gives voice to [nickname] (can talk on +m channel)
+h [nickname]     Gives halfops to [nickname] (requires halfop module)
+o [nickname]     Gives ops to [nickname]
+b [hostmask]     Bans [hostmask] on the channel
+a [nickname]     Give protected status to [nickname] (+q only)
+q [nickname]     Give founder status to [nickname] (ulines only)
+i                Make the channel invite only, must /INVITE users
+k [key]          Set the channel key (password) to [key]
+l [limit]        Set the maximum possible users to [limit]
+m                Enable moderation. Only +vo(h) can speak
+n                Only users who are members of the channel may message it
+p                Make channel private (hide from /LIST)
+s                Make channel secret (can't be used at the same time as +p)
+O                Channel is IRCops only (can only be set by IRCops)
+t                Only halfops and above can change the topic
+Q                Only U-Lined servers/nicks can kick
+T                Only halfops/ops can send NOTICEs to the channel
+C                No CTCPs allowed to the channel
+c                mIRC colour codes blocked on the channel
+K                No /KNOCK allowed to channel (if knock module is loaded)
+L [channel]      If the channel is full, redirect users to [channel]
+N                No nickchanges while on the channel
+-------------
+NOTE: A large number of these modes are dependent upon server-side modules
+being loaded by a server/network administrator. The actual modes available
+on your network may be very different to this list. Please consult your
+help channel if you have any questions.">
+