mirror of
https://github.com/irssi/irssi.git
synced 2024-11-03 04:27:19 -05:00
Syntax documentation rewrite for J-K commands
Rewrote the syntax documentation for all commands starting with the letters J and K.
This commit is contained in:
parent
06b6371ac5
commit
120508c14f
@ -1,15 +1,26 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:join@
|
||||
|
||||
-window: Join channel, placing channel window item in currently active window
|
||||
-invite: Join last invited channel
|
||||
-<server tag>: Join channel on server with specified tag
|
||||
%9Parameters:%9
|
||||
|
||||
Joins a specified channel. Channel names usually begin with #-sign,
|
||||
which may be omitted here.
|
||||
-window Joins a channel in the active window.
|
||||
-invite Joins the channel you were last invited to.
|
||||
-<server tag> The server tag on which you want to join the channel.
|
||||
|
||||
JOIN is aliased to J by default. Example: /j irssi
|
||||
(This joins to the channel #irssi)
|
||||
The channel names, separated by a commma, to join and the channel key.
|
||||
|
||||
See also: PART, WINDOW CLOSE
|
||||
%9Description:%9
|
||||
|
||||
Joins the given channels.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/JOIN #irssi
|
||||
/JOIN #google secret_lair
|
||||
/JOIN -invite
|
||||
/JOIN -freenode #github,#freenode,#irssi
|
||||
|
||||
%9See also:%9 KICK, PART
|
||||
|
||||
|
@ -1,16 +1,24 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:kick@
|
||||
|
||||
This command "kicks" the specified user off of the specified
|
||||
channel. It is typically used to remove troublemakers, flooders,
|
||||
or people otherwise making a nuisance of themselves on the channel.
|
||||
The reason for the kick is recommended, but not required by the IRC
|
||||
servers.
|
||||
%9Parameters%9
|
||||
|
||||
If the <channel> is omitted, removes the nick from the current
|
||||
channel.
|
||||
The channel and the nicknames, separated by a comma, to kick from the
|
||||
channel and the reason thereof; if no channel is given, the active channel
|
||||
will be used.
|
||||
|
||||
The default alias for /KICK is /K.
|
||||
%9Description:%9
|
||||
|
||||
See also: KNOCKOUT
|
||||
Removes the given nicknames from the specified channel; this command is
|
||||
typically used to remove troublemakers, flooders or people otherwise making
|
||||
a nuisance of themselves.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/KICK mike Please... chill down!
|
||||
/KICK #irssi bob,sarah Stop flooding!
|
||||
|
||||
%9See also:%9 BAN, KICKBAN, KNOCKOUT
|
||||
|
||||
|
@ -1,10 +1,22 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:kickban@
|
||||
|
||||
Kicks off and bans a nick from the current channel.
|
||||
A reason for the kick can be supplied.
|
||||
%9Parameters:%9
|
||||
|
||||
Default alias for /KICKBAN is /KB.
|
||||
The channel and the nicknames, separated by a comma, to kickban from the
|
||||
channel and the reason thereof; if no channel is given, the active channel
|
||||
will be used.
|
||||
|
||||
See also: KNOCKOUT, BANTYPE
|
||||
%9Description:%9
|
||||
|
||||
Removes and then bans the given nicknames from the specified channel.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/KICKBAN mike Please... chill down!
|
||||
/KICKBAN #irssi bob,sarah You guys broke the rules for the last time.
|
||||
|
||||
%9See also:%9 BAN, KICK, KNOCKOUT
|
||||
|
||||
|
@ -1,18 +1,24 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:kill@
|
||||
|
||||
IRC operator command.
|
||||
%9Parameters:%9
|
||||
|
||||
KILL is used to forcibly remote a client from the irc network.
|
||||
It works similarly to KICK, except that a reason must be
|
||||
given (even if it is meaningless or flat-out wrong).
|
||||
The nickname to remove from the network and the reason thereof.
|
||||
|
||||
In general, KILL is useful only as a warning tool for abusive
|
||||
users. Modern irc clients (this one included) have automated
|
||||
means for reconnecting to a server after a disconnection (whether
|
||||
due to a KILL or something else), so KILL is by no means a
|
||||
permanent solution. It is not intended as a means for personal
|
||||
vendettas; this practice is generally frowned upon.
|
||||
%9Description:%9
|
||||
|
||||
See also: OPER
|
||||
Terminates a nickname's connection from the network; this command is
|
||||
reserved for IRC operators.
|
||||
|
||||
You should not use this command for personal vendettas or for trolling;
|
||||
these practices are generally frowned upon.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/KILL mike Get off my lawn
|
||||
/KILL bob Stop breaking the network rules!
|
||||
|
||||
%9See also:%9 DIE, OPER, WALLOPS
|
||||
|
||||
|
@ -1,16 +1,30 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:knock@
|
||||
|
||||
Works only in some IRC networks (hybrid-like ircds).
|
||||
%9Parameters:%9
|
||||
|
||||
KNOCK is a feature that lets you request access to a channel they cannot join without an invite, a key or a raised limit.
|
||||
The channel you wish to get invited to.
|
||||
|
||||
The following conditions must be met for KNOCK to work:
|
||||
%9Description:%9
|
||||
|
||||
- You are not banned from the channel
|
||||
- Channel is not private (+p)
|
||||
- You are not already on the channel
|
||||
- Channel is invite only (+i), has a key (+k) or limit is full
|
||||
Sends an invitation request to the channel operators of the target channel;
|
||||
this command may not work on all IRC servers.
|
||||
|
||||
When successful KNOCK is issued, it sends a notice to channel operators. Use of KNOCK is rate limited by the server.
|
||||
The following conditions must be met:
|
||||
|
||||
* You are not banned from the channel.
|
||||
* The channel is not private.
|
||||
* You may not be already in the channel.
|
||||
* The channel must be invite only, have a key or has exceeded its user
|
||||
limit.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/KNOCK #irssi
|
||||
/KNOCK #freenode
|
||||
/KNOCK #github
|
||||
|
||||
%9See also:%9 INVITE, JOIN
|
||||
|
||||
|
@ -1,11 +1,26 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:knockout@
|
||||
|
||||
Kicks user off the channel and bans him/her. Ban
|
||||
lasts the given number of seconds or 5 minutes
|
||||
by default.
|
||||
%9Parameters:%9
|
||||
|
||||
Default alias for /KNOCKOUT is /KN.
|
||||
The time, expressed in seconds, the nicknames, separated by a comma, and the
|
||||
reason thereof; if no time is provided, the ban will be lifted after 5
|
||||
minutes.
|
||||
|
||||
See also: BAN, KICK
|
||||
%9Description:%9
|
||||
|
||||
Removes and then bans the given nicknames from the active channel; the ban
|
||||
will be automatically lifted after the specified time.
|
||||
|
||||
The ban will not be lifted if you leave the channel or disconnect from the
|
||||
network.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/KNOCKOUT 3600 mike Your connection is unstable.
|
||||
/KNOCKOUT bob,sarah Chill down a bit.
|
||||
|
||||
%9See also:%9 BAN, KICK, KICKBAN
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user