mirror of
https://github.com/irssi/irssi.git
synced 2024-12-04 14:46:39 -05:00
Syntax documentation rewrite for H-I-commands
This commit is contained in:
Geert Hauwaerts
parent
1be75a4bef
commit
591e10b3b6
@ -25,7 +25,8 @@
|
|||||||
|
|
||||||
%9Description:%9
|
%9Description:%9
|
||||||
|
|
||||||
Opens a new connection to the specified network or server. Existing connections are kept.
|
Opens a new connection to the specified network or server; existing
|
||||||
|
connections are kept.
|
||||||
|
|
||||||
%9Examples:%9
|
%9Examples:%9
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,22 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:hash@
|
@SYNTAX:hash@
|
||||||
|
|
||||||
Not available.
|
%9Description:%9
|
||||||
|
|
||||||
|
This is an ancient command that is no longer used; if you on an IRC server
|
||||||
|
that supports this command, please contact us to we can update the
|
||||||
|
documentation.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/HASH
|
||||||
|
|
||||||
|
%9References:%9
|
||||||
|
|
||||||
|
http://www.irssi.org
|
||||||
|
https://github.com/irssi
|
||||||
|
|
||||||
|
%9See also:%9 DIE, KILL, OPER
|
||||||
|
|
||||||
|
|||||||
@ -1,13 +1,27 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:help@
|
@SYNTAX:help@
|
||||||
|
|
||||||
Shows help on commands. Try:
|
%9Parameters:%9
|
||||||
/HELP command
|
|
||||||
|
|
||||||
Also try, for example:
|
The command to display the documentation for; if no argument is given, the
|
||||||
/SET beep
|
list of commands will be displayed.
|
||||||
or
|
|
||||||
/SET auto
|
|
||||||
|
|
||||||
See also:
|
%9Description:%9
|
||||||
|
|
||||||
|
Displays the documentation for the given command.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/HELP
|
||||||
|
/HELP AWAY
|
||||||
|
/HELP CONNECT
|
||||||
|
|
||||||
|
%9References:%9
|
||||||
|
|
||||||
|
http://www.irssi.org
|
||||||
|
https://github.com/irssi
|
||||||
|
|
||||||
|
%9See also:%9 CONNECT, MSG, NETWORK, SERVER
|
||||||
|
|
||||||
|
|||||||
@ -1,32 +1,41 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:hilight@
|
@SYNTAX:hilight@
|
||||||
|
|
||||||
-mask: Match only for nick, <text> is a nick mask
|
%9Parameters:%9
|
||||||
-regexp: <text> is a regular expression
|
|
||||||
-full: <text> must match to full words
|
|
||||||
-nick: Hilight only the nick, not the whole line (default)
|
|
||||||
-word: Hilight only the word (default with non-public messages)
|
|
||||||
-line: Hilight the whole line with the hilight color.
|
|
||||||
-color: Print the message with <color>. color is in %%code format
|
|
||||||
(see docs/formats.txt)
|
|
||||||
-actcolor: Color to show in statusbar activity, or don't change if %%n.
|
|
||||||
-level: Match only for <level> messages, default is
|
|
||||||
publics,msgs,notices,actions
|
|
||||||
-channels: Match only in <channels> (comma separated list)
|
|
||||||
-priority: Priority to use when multiple hilights match. Default is 0.
|
|
||||||
|
|
||||||
Examples:
|
-nick: Highlights only the nickname and not the whole line.
|
||||||
|
-word: Highlights only the word and not the whole line.
|
||||||
|
-line: Highlights the whole line.
|
||||||
|
-mask: Highlights all messages from users matching the mask.
|
||||||
|
-full: The text must match the full word.
|
||||||
|
-regexp: The text is a regular expression.
|
||||||
|
-color: The color the display the highlight in.
|
||||||
|
-actcolor: The color to mark the highlight activity in the statusbar.
|
||||||
|
-level: Matches only on the given message level.
|
||||||
|
-channels: Matches only on the given channels.
|
||||||
|
-priority: The priority to use when multiple highlights match.
|
||||||
|
|
||||||
Hilight lines that have "mynick" word:
|
The text to highlight on; if no argument is given, the list of highlights
|
||||||
/HILIGHT mynick
|
will be displayed.
|
||||||
|
|
||||||
Hilight all messages from "mynick":
|
%9Description:%9
|
||||||
/HILIGHT -mask mynick!*@*
|
|
||||||
|
|
||||||
Hilight lines that were written by nicks from *.fi with bold green
|
Highlights the keyword or pattern to make sure that you don't miss any
|
||||||
/HILIGHT -color %%G -mask *!*@*.fi
|
important messages.
|
||||||
|
|
||||||
For regular expressions, see `man 7 regex`.
|
%9Examples:%9
|
||||||
|
|
||||||
See also: DEHILIGHT, SET HILIGHT
|
/HILIGHT
|
||||||
|
/HILIGHT mike
|
||||||
|
/HILIGHT -regexp mi+ke+
|
||||||
|
/HILIGHT -mask bob!*@*.google.com -color %%G
|
||||||
|
/HILIGHT -full -color %%G -actcolor %%Y redbull
|
||||||
|
|
||||||
|
%9References:%9
|
||||||
|
|
||||||
|
https://github.com/irssi/irssi/blob/master/docs/formats.txt
|
||||||
|
|
||||||
|
%9See also:%9 DEHILIGHT, LEVELS
|
||||||
|
|
||||||
|
|||||||
@ -1,59 +1,41 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:ignore@
|
@SYNTAX:ignore@
|
||||||
|
|
||||||
-regexp: <pattern> is a regular expression
|
%9Parameters:%9
|
||||||
-full: <pattern> must match to full words
|
|
||||||
-pattern: <pattern> must match to the message's text
|
|
||||||
-except: *DON'T* ignore - overrides an existing ignore.
|
|
||||||
-replies: Ignore replies to nick in channels. For example
|
|
||||||
"/IGNORE -replies *!*@*.fi PUBLIC" ignores everyone
|
|
||||||
from Finland, but also anyone sending message
|
|
||||||
"tofinnishnick: blahblah".
|
|
||||||
-network: Ignore only on this network.
|
|
||||||
-ircnet: Same as -network. Deprecated. Do not use.
|
|
||||||
-channels: Ignore only in channels (comma separated list)
|
|
||||||
-time: <secs> seconds after the ignore is removed
|
|
||||||
<mask>: Either a nick mask or list of channels
|
|
||||||
<levels>: List of levels to ignore. You can use -<level> to remove levels
|
|
||||||
from ignore (/help levels for details).
|
|
||||||
<^levels>: List of levels to NOT ignore
|
|
||||||
(/ignore -except nick notices = /ignore nick ^notices)
|
|
||||||
|
|
||||||
|
-regexp: Indicates that the pattern is a regular expression.
|
||||||
|
-full: Indicates that the pattern must match a full word.
|
||||||
|
-pattern: The text pattern to ignore.
|
||||||
|
-except: Negates the ignore.
|
||||||
|
-replies: Also ignore nicknames who are talking to anyone who matches the ignore.
|
||||||
|
-network: Ignores only on a specific network.
|
||||||
|
-channels: Ignores only on specific channels.
|
||||||
|
-time: The timeout to automatically remove the ignore.
|
||||||
|
|
||||||
/IGNORE without any arguments displays list of ignores. If you want to remove
|
The mask, channels and levels to ignore; if no argument is provided, the
|
||||||
some levels of the ignore, use /IGNORE <mask> -<level> -<level2> etc
|
list of ignores will be displayed.
|
||||||
|
|
||||||
The best match always wins, so you can have:
|
%9Description:%9
|
||||||
|
|
||||||
|
Ignores nicknames or text that matches a pattern.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/IGNORE
|
||||||
|
/IGNORE * JOINS
|
||||||
/IGNORE * CTCPS
|
/IGNORE * CTCPS
|
||||||
/IGNORE -except *!*@host.org CTCPS
|
/IGNORE -except *!*@*.google.com CTCPS
|
||||||
|
/IGNORE #irssi ALL -PUBLIC -ACTIONS
|
||||||
Examples:
|
/IGNORE -replies *!*@*.google.com ALL
|
||||||
|
|
||||||
/IGNORE * JOINS - ignore joins in all channels
|
|
||||||
/IGNORE #channel ALL -PUBLIC -ACTIONS - ignore all but public/actions
|
|
||||||
/IGNORE #channel -JOINS - don't ignore joins anymore
|
|
||||||
/IGNORE -replies *!user@*.host.org ALL - ignore user and all replies
|
|
||||||
|
|
||||||
Some suggestions for ignoring annoying public aways:
|
|
||||||
/IGNORE -regexp -pattern "is (away|gone|back)" * ACTIONS
|
/IGNORE -regexp -pattern "is (away|gone|back)" * ACTIONS
|
||||||
/IGNORE *zzz* NICKS
|
/IGNORE *zzz* NICKS
|
||||||
/IGNORE *afk* NICKS
|
/IGNORE *afk* NICKS
|
||||||
/IGNORE *away* NICKS
|
/IGNORE *away* NICKS
|
||||||
|
/IGNORE #irssi NO_ACT JOINS PARTS QUITS
|
||||||
|
/IGNORE mike NO_ACT -MSGS
|
||||||
|
/IGNORE -regexp -pattern
|
||||||
|
|
||||||
The special level "NO_ACT" can be used to ignore activity ("Act:") but not
|
%9See also:%9 ACCEPT, SILENCE, UNIGNORE
|
||||||
actually ignore the message entirely. It is somewhat special because it is
|
|
||||||
allowed in addition to another ignore for the same target.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
/IGNORE #channel NO_ACT JOINS PARTS QUITS - hide joins, etc from activity
|
|
||||||
/IGNORE nick NO_ACT -MSGS - ignore activity from nick, except for /MSG
|
|
||||||
/IGNORE -regexp -pattern . -except nick NO_ACT HILIGHT
|
|
||||||
- combined with the ignore above show hilights from this nick (needs to be
|
|
||||||
an except as "PUBLIC HILIGHT" still matches public, the regexp is used to
|
|
||||||
have more than one ignore for "nick").
|
|
||||||
|
|
||||||
For regular expressions, see `man 7 regex`.
|
|
||||||
|
|
||||||
See also: UNIGNORE, SILENCE, ACCEPT
|
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,21 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:info@
|
@SYNTAX:info@
|
||||||
|
|
||||||
Shows information about the IRC server software and the current
|
%9Parameters:%9
|
||||||
server instance.
|
|
||||||
|
The server to display the information for; if no argument is given, the
|
||||||
|
active server will be used.
|
||||||
|
|
||||||
|
%9Description:%9
|
||||||
|
|
||||||
|
Displays information about the IRC server software.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/INFO
|
||||||
|
/INFO orwell.freenode.net
|
||||||
|
|
||||||
|
%9See also:%9 ADMIN
|
||||||
|
|
||||||
|
|||||||
@ -1,10 +1,21 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:invite@
|
@SYNTAX:invite@
|
||||||
|
|
||||||
Invites the specified nick to the current or specified channel.
|
%9Parameters:%9
|
||||||
|
|
||||||
Example:
|
The nickname to invite and the channel to invite him or her to; if no
|
||||||
/INVITE buddy #mychannel
|
channel is given, the active channel will be used.
|
||||||
|
|
||||||
See also: MODE
|
%9Description:%9
|
||||||
|
|
||||||
|
Invites the specified nick to a channel.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/INVITE mike
|
||||||
|
/INVITE bob #irssi
|
||||||
|
|
||||||
|
%9See also:%9 MODE, WHOIS
|
||||||
|
|
||||||
|
|||||||
@ -1,9 +1,20 @@
|
|||||||
|
|
||||||
@SYNTAX:invitelist@
|
%9Syntax:%9
|
||||||
|
|
||||||
Shows the +I modes of the current channel. +I mode
|
INVITELIST
|
||||||
allows free joins of clients with certain userhost masks
|
|
||||||
even if the channel is invite only.
|
|
||||||
|
|
||||||
See also: INVITE, MODE
|
%9Description:%9
|
||||||
|
|
||||||
|
Displays the invitelist for the active channel; nicknames who match the
|
||||||
|
masks will be able to join the channel if its invite only.
|
||||||
|
|
||||||
|
This is not a command, but a default alias.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/INVITELIST
|
||||||
|
|
||||||
|
%9References:%9
|
||||||
|
|
||||||
|
/ALIAS INVITELIST MODE $C +I
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +0,0 @@
|
|||||||
IRCNET
|
|
||||||
|
|
||||||
Deprecated. Use NETWORK instead.
|
|
||||||
|
|
||||||
@ -1,7 +1,20 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:ison@
|
@SYNTAX:ison@
|
||||||
|
|
||||||
Tells whether specified nicks (space-separated) are online.
|
%9Parameters:%9
|
||||||
|
|
||||||
See also: WHOIS, WHOWAS, NOTIFY
|
The nicknames, separated by space, to check.
|
||||||
|
|
||||||
|
%9Description:%9
|
||||||
|
|
||||||
|
Displays whether the specified nicknames are online.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/ISON mike
|
||||||
|
/ISON sarah bob
|
||||||
|
|
||||||
|
%9See also:%9 NOTIFY, WHOAS, WHOIS
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user