1
0
mirror of https://github.com/irssi/irssi.git synced 2024-12-04 14:46:39 -05:00

Rewrote the syntax documentation for all the commands starting with A.

This commit is contained in:
Geert Hauwaerts 2014-07-02 22:25:33 +02:00
parent f077280643
commit b2f265f44e
5 changed files with 102 additions and 58 deletions

View File

@ -1,28 +1,30 @@
Syntax:
@SYNTAX:accept@
MODE <your nick> <+|->g
Works only in some IRC networks.
Parameters:
ACCEPT allows you to specify who you want to receive private messages
and notices from while you are in callerid (+g) mode.
When you have user mode +g enabled, messages from other users are blocked and
the sender is notified; you are also notified but at most once per minute.
IRC operators and services can usually send through +g.
A comma-separated list of nicknames to add or remove. If no argument is
given, your accept list is displayed.
The accept list is lost when you disconnect.
Users are automatically removed from the accept list if they quit, split
or change nick.
Description:
The argument is a comma-separated list of nicks to add or (when prefixed
with a '-') to remove. No output is returned for users successfully added
or removed.
If no arguments are given, your accept list is displayed (ACCEPT * on the
protocol level).
Allows you to specify who you want to receive private messages and notices
from while you have callerid enabled.
Example:
/ACCEPT user1,user2,-user3,-user4 - Adds user1 and user2 and removes
user3 and user4.
When you have callerid enabled, messages from other users are blocked and
the sender is notified; you are also notified but at most once per minute.
Users are automatically removed from the accept list if they quit, split
or change nickname; the accept list is lost when you disconnect.
This command only works on IRC servers that support the callerid user mode.
Examples:
/ACCEPT mike,bob,-john,-sarah
/ACCEPT sarah,-bob
See also: IGNORE, SILENCE

View File

@ -1,9 +1,23 @@
Syntax:
@SYNTAX:action@
Same as ME, but gets channel or nick as an additional parameter.
Example: /ACTION #irssi yawns
(This outputs the following to #irssi: * Nick yawns)
Parameters:
-<server tag>: The server tag you want to send the action emote to.
A target nickname or channel and the message.
Description:
Sends an action emote to a nickname or a channel.
Examples:
/ACTION #irssi is hungry!
/ACTION mike had an awesome day @ work
/ACTION -efnet #irssi is happy it's Friday
See also: ME

View File

@ -1,8 +1,22 @@
Syntax:
@SYNTAX:admin@
Displays the administrative details about the given server. If
no server is specified, the server you are connected to is
used. If a nickname is supplied then it gives the administrative
information for that person's current server.
Parameters:
A nickname or server for which you want to know the administrative details;
if no argument is given, the server you are connected to will be used.
Description:
Displays the administrative details of a server.
Examples:
/ADMIN
/ADMIN orwell.freenode.net
/ADMIN mike
See also: INFO

View File

@ -1,22 +1,32 @@
Syntax:
@SYNTAX:alias@
Creates a new alias or shows matching defined aliases. Without
parameters shows all defined aliases. Multiple commands can be run if
separated with ';' character. Parameters given to alias are in $0..$9
variables, if you don't use them in your alias, all parameters are
automatically appended after it.
Parameters:
A name of the alias and the command to execute. You can prepend the alias
with the '-' character to remove the alias. If no argument is given, your
aliases will be displayed.
Description:
Creates or updates an alias. You can use the ';' character to separate
multiple commands.
The parametesr given to the alias are expanded in '$[\d]' For example $0,
$1, $2, $8, $12, ...
If you don't use any parameters in your alias, all parameters will be
automatically appended after it.
Examples:
/ALIAS w
- shows all defined aliases starting with letter w.
/ALIAS COMEBACK SAY I was hoping for a battle of wits, but you seem to be unarmed.
/ALIAS -COMEBACK
/ALIAS ATAG SCRIPT EXEC Irssi::active_win->change_server(Irssi::server_find_tag("$0"));
/ALIAS UNACT SCRIPT EXEC foreach $$w (Irssi::windows()) { Irssi::command("window goto $$w->{refnum}")\;} ; WINDOW GOTO $winref
/ALIAS QOP ^MSG Q op $C
/ALIAS send echo Sending file $1 to $0;dcc send $0-
- creates alias 'send'.
/ALIAS -send
- removes alias 'send'.
See also: UNALIAS
See also: BIND, UNALIAS

View File

@ -1,28 +1,32 @@
Syntax:
@SYNTAX:away@
-one
-all
Parameters:
This command marks you as being "away". It is used to tell people that
you currently aren't paying attention to your screen. You might use it
if you are taking a nap, in the shower, getting some food, or otherwise
just aren't there at the moment. When you're "away" you will see "(zZzZ)"
in your statusbar.
-one: Marks yourself as away on the server you are connected to.
-all: Marks yourself as away on all the servers you are connected to.
Anyone who does a WHOIS on your nickname will see that you are away,
as well as your away message. Anyone doing a WHO that returns information
about you will also see that you're gone.
You away message; if no argument is given, your away status will be removed.
By default, if someone sends you a MSG while you are away, your client
will beep. You can turn this off by setting BEEP_WHEN_AWAY to OFF.
Description:
If you send a MSG to someone who is away, you will automatically be
notified of this. By default, you will only receive this notification
once. If you wish to see it every time (to tell when a person is no
longer marked away, for instance), change SHOW_AWAY_ONCE to OFF.
Marks yourself as "away"; this method is used to inform people that you
are not paying attention to your screen.
You can remove your away status by using AWAY with no arguments.
You might use it when you are taking a nap, in the shower, getting some
food, or otherwise engaged. When you're "away" you will see "(zZzZ)" in
your statusbar.
See also: SET AWAY
Anyone who does a WHOIS on your nickname will see that you are away, as
well as your away message.
Examples:
/AWAY I'm getting some food.
/AWAY zZzZ
/AWAY -one Feeding the cat!
See also: DISCONNECT