mirror of
https://github.com/irssi/irssi.git
synced 2024-12-04 14:46:39 -05:00
Syntax documentation rewrite for N-commands.
Rewrote the syntax documentation for all commands starting with the letter N.
This commit is contained in:
parent
c8dd54c2f6
commit
8014fd2cb0
@ -1,21 +1,27 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:names@
|
@SYNTAX:names@
|
||||||
|
|
||||||
-ops: show channel operators in list
|
%9Parameters:%9
|
||||||
-halfops: show half operators in list
|
|
||||||
-voices: show voiced people in list
|
|
||||||
-normal: show rest of the people in list
|
|
||||||
|
|
||||||
Shows the names (nicks) in the specified channels. /NAMES ** shows all
|
-count: Displays the amount of users in the channel.
|
||||||
nicks in all channels, you probably don't want to do this.
|
-ops: Displays the channel operators.
|
||||||
|
-halfops: Displays the channel demi-operators.
|
||||||
|
-voices: Displays the users who are voiced in a channel.
|
||||||
|
|
||||||
Examples:
|
The channels to report or ** for all channels you have joined; if no
|
||||||
|
arguments are given, the users in the active channel will be displayed.
|
||||||
|
|
||||||
/NAMES
|
%9Description:%9
|
||||||
- shows nicks in the current channel.
|
|
||||||
|
|
||||||
/NAMES -ops #c1,#c2
|
Displays the users who are in a channel; you can provide multiple channels
|
||||||
- shows operators in channels #c1 and #c2
|
by separating them with the comma "," character.
|
||||||
|
|
||||||
See also: WHO, CHANNEL
|
%9Examples:%9
|
||||||
|
|
||||||
|
/NAMES -ops
|
||||||
|
/NAMES -voices #irssi,#freenode
|
||||||
|
|
||||||
|
%9See also:%9 JOIN, PART, WHO, WHOIS
|
||||||
|
|
||||||
|
@ -1,7 +1,21 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:nctcp@
|
@SYNTAX:nctcp@
|
||||||
|
|
||||||
Sends a CTCP reply notice to the nick/channel.
|
%9Parameters:%9
|
||||||
|
|
||||||
See also: CTCP, ACTION, MSG, NOTICE
|
A target nickname or channel, a command and the data.
|
||||||
|
|
||||||
|
%9Description:%9
|
||||||
|
|
||||||
|
Sends a CTCP reply to a nickname or channel; you can provide multiple
|
||||||
|
targets by separating them with the comma "," character.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/NCTCP #irssi VERSION King of the Jungle v1.0
|
||||||
|
/NCTCP bob,#freenode USERINFO I am bob :p
|
||||||
|
|
||||||
|
%9See also:%9 CTCP
|
||||||
|
|
||||||
|
@ -1,6 +1,16 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:netsplit@
|
@SYNTAX:netsplit@
|
||||||
|
|
||||||
Irssi keeps track of people who were lost in net splits. With this
|
%9Description:%9
|
||||||
command you can get a list of them.
|
|
||||||
|
Displays some information about users who are currently lost in one or
|
||||||
|
more netsplits.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/NETSPLIT
|
||||||
|
|
||||||
|
%9See also:%9 JOIN, LINKS, MAP, PART
|
||||||
|
|
||||||
|
@ -1,5 +1,20 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:nick@
|
@SYNTAX:nick@
|
||||||
|
|
||||||
Changes your nick.
|
%9Parameters:%9
|
||||||
|
|
||||||
|
Your new nickname.
|
||||||
|
|
||||||
|
%9Description:%9
|
||||||
|
|
||||||
|
Changes your nickname on the active server.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/NICK mike
|
||||||
|
/NICK bob
|
||||||
|
|
||||||
|
%9See also:%9 CONNECT, JOIN, MSG, PART
|
||||||
|
|
||||||
|
@ -1,32 +0,0 @@
|
|||||||
|
|
||||||
@SYNTAX:note@
|
|
||||||
|
|
||||||
NOTE is a sort of turbo-charged messaging system for irc. In short,
|
|
||||||
it achieves at the server level what the client attempts to do with MSG
|
|
||||||
and NOTIFY. The messaging system resembles modern voicemail systems
|
|
||||||
(except in text); messages can be sent, stored, or set for deferred
|
|
||||||
delivery. The client notification system works like NOTIFY, except with
|
|
||||||
greater accuracy and flexibility.
|
|
||||||
|
|
||||||
The most common uses of NOTE are its SPY and SEND functions. SPY is similar
|
|
||||||
to NOTIFY, except it can accept a full address to spy on, not just a nickname.
|
|
||||||
SEND, as its name implies, sends a note to a user; if that user is not currently
|
|
||||||
online, it will be delivered if the user logs onto irc within a set time period.
|
|
||||||
|
|
||||||
When referring to a particular user, NOTE can deal with the standard
|
|
||||||
nick!user@host notation. Wildcards are allowed, and any portion may be omitted,
|
|
||||||
so long as the identifier remains unambiguous.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
To send a note to Joebob (whose account is jbriggs@drivein.com):
|
|
||||||
/NOTE SEND joebob!jbriggs@drivein.com Hey there! Great movie!
|
|
||||||
|
|
||||||
To spy on anyone from blah.com for the next 30 days:
|
|
||||||
/NOTE SPY +30 *!*@*.blah.com A blah.com user is active
|
|
||||||
|
|
||||||
This command is not available in the IRCNet. However, you've service NoteServ
|
|
||||||
available there, which allows you to do similiar things like with /NOTE command
|
|
||||||
on other IRC networks. Type /SQUERY NoteServ HELP to get more info about it.
|
|
||||||
|
|
||||||
See also: NOTIFY, SQUERY
|
|
||||||
|
|
@ -1,10 +1,24 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:notice@
|
@SYNTAX:notice@
|
||||||
|
|
||||||
Sends a notice to the nick or the channel. Usually notices are
|
%9Parameters:%9
|
||||||
used in bots and scripts for different kinds of replies. The
|
|
||||||
IRC protocol states that notices may not generate replies to
|
|
||||||
avoid msg loops.
|
|
||||||
|
|
||||||
See also: NCTCP, MSG
|
The targets and the message to notify.
|
||||||
|
|
||||||
|
%9Description:%9
|
||||||
|
|
||||||
|
Sends a notice to the target nickname or channel; these are often used in
|
||||||
|
automated bots or scripts.
|
||||||
|
|
||||||
|
You can provide multiple targets by separating them with the comma ","
|
||||||
|
character.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/NOTICE mike You sir, are just awesome!
|
||||||
|
/NOTICE bob,#irssi Fish go blub :p
|
||||||
|
|
||||||
|
%9See also:%9 CTCP, MSG, NCTCP
|
||||||
|
|
||||||
|
@ -1,13 +1,29 @@
|
|||||||
|
|
||||||
|
%9Syntax:%9
|
||||||
|
|
||||||
@SYNTAX:notify@
|
@SYNTAX:notify@
|
||||||
|
|
||||||
-away: Notifies about away-status changes
|
%9Parameters:%9
|
||||||
-list: Lists the notify list entries with all their settings
|
|
||||||
<mask>: Either a simple "nick" or "nick!*@*blah.org".
|
|
||||||
The nick can't contain wildcards, but the user/host can.
|
|
||||||
|
|
||||||
/NOTIFY without any arguments displays if the people in notify
|
-away: Notifies you if the target modifies its away status.
|
||||||
list are online or offline.
|
-list: Displays the list of notifications.
|
||||||
|
|
||||||
See also: UNNOTIFY, SET NOTIFY
|
The nickname or mask to get a notification for; if no arguments are given,
|
||||||
|
the current matching notifications will be displayed.
|
||||||
|
|
||||||
|
You may also provide the network that the target must be on.
|
||||||
|
|
||||||
|
%9Description:%9
|
||||||
|
|
||||||
|
Notifies you when a nickname or users matching a host on the notification
|
||||||
|
list comes online or offline.
|
||||||
|
|
||||||
|
%9Examples:%9
|
||||||
|
|
||||||
|
/NOTIFY -list
|
||||||
|
/NOTIFY -away mike
|
||||||
|
/NOTIFY bob
|
||||||
|
/NOTIFY *!*@staff.irssi.org
|
||||||
|
|
||||||
|
%9See also:%9 AWAY, HILIGHT, UNNOTIFY
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user