Syntax documentation rewrite for L-commands

Rewrote the syntax documentation for all commands starting with L.
This commit is contained in:
Geert Hauwaerts 2014-07-07 19:47:51 +02:00
commit 5e8947a8b0
9 changed files with 207 additions and 117 deletions

View file

@ -1,35 +1,40 @@
Message levels (or in short, levels) are used almost everywhere.
They describe what kind of messages we're dealing with. Here's a
list of them all:
CRAP - Can be almost anything
MSGS - Private messages
PUBLIC - Public messages in channel
NOTICES - Notices
SNOTES - Server notices
CTCPS - CTCP messages
ACTIONS - Actions (/me) - usually ORed with PUBLIC or MSGS
JOINS - Someone joins a channel
PARTS - Someone parts a channel
QUITS - Someone quits IRC
KICKS - Someone gets kicked from channel
MODES - Channel mode is changed
TOPICS - Channel topic is changed
WALLOPS - Wallop is received
INVITES - Invite is received
NICKS - Someone changes nick
DCC - DCC related messages
DCCMSGS - DCC chat messages
CLIENTNOTICE - Irssi's notices
CLIENTERROR - Irssi's error messages
CLIENTCRAP - Some other messages from Irssi
%9Description:%9
And a few special ones that could be included with the
levels above:
These are the message levels that are used throughout Irssi; they describe
what kind of message is displayed.
HILIGHT - Text is highlighted
NOHILIGHT - Don't check highlighting for this message
NO_ACT - Don't trigger channel activity when printing
this message
NEVER - Never ignore or log this message
These are the common levels you can use:
ACTIONS Actions by a nickname.
CLIENTCRAP Irssi's internal messages.
CLIENTERROR Irssi's internal error messages.
CLIENTNOTICE Irssi's internal notices.
CRAP Can be almost anything.
CTCPS CTCP messages.
DCC DCC protocol related messages.
DCCMSGS DCC chat messages.
INVITES An invite is received.
JOINS A nickname joins a channel.
KICKS A nickname gets kicked from a channel.
MODES A channel mode is modified.
MSGS Private messages.
NICKS A nickname changes to another nickname.
NOTICES Notices sent from a nickname.
PARTS A nickname leaves a channel.
PUBLIC Public messages in a channel.
QUITS A nickname disconnects from IRC.
SNOTES Notices sent from a server.
TOPICS A channel topic is modified.
WALLOPS A wallop is received.
These are the special levels you can use:
HILIGHT The text is highlighted.
NEVER Never ignores or logs the message.
NO_ACT Doesn't trigger any activity in the statusbar.
NOHILIGHT The text is not highlighted.
When using levels from Irssi scripts, you need to prepend the level with
"MSGLEVEL_"; for example "CRAP" will be "MSGLEVEL_CRAP".