summaryrefslogtreecommitdiff
path: root/docs/help/in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-09 18:21:39 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-09 18:21:39 +0200
commit8014fd2cb0d05b41a7b3b9bbe26e91a5fd040651 (patch)
treeb6cc4346b30a47f9288ae53c9eeb808ea3c15a12 /docs/help/in
parentc8dd54c2f669f023538670b28a7593cf14aa3d8e (diff)
downloadirssi-8014fd2cb0d05b41a7b3b9bbe26e91a5fd040651.zip
Syntax documentation rewrite for N-commands.
Rewrote the syntax documentation for all commands starting with the letter N.
Diffstat (limited to 'docs/help/in')
-rw-r--r--docs/help/in/names.in30
-rw-r--r--docs/help/in/nctcp.in18
-rw-r--r--docs/help/in/netsplit.in14
-rw-r--r--docs/help/in/nick.in17
-rw-r--r--docs/help/in/note.in32
-rw-r--r--docs/help/in/notice.in24
-rw-r--r--docs/help/in/notify.in32
7 files changed, 105 insertions, 62 deletions
diff --git a/docs/help/in/names.in b/docs/help/in/names.in
index 2d515c1c..0a122864 100644
--- a/docs/help/in/names.in
+++ b/docs/help/in/names.in
@@ -1,21 +1,27 @@
+%9Syntax:%9
+
@SYNTAX:names@
- -ops: show channel operators in list
- -halfops: show half operators in list
- -voices: show voiced people in list
- -normal: show rest of the people in list
+%9Parameters:%9
+
+ -count: Displays the amount of users in the channel.
+ -ops: Displays the channel operators.
+ -halfops: Displays the channel demi-operators.
+ -voices: Displays the users who are voiced in a channel.
+
+ 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.
-Shows the names (nicks) in the specified channels. /NAMES ** shows all
-nicks in all channels, you probably don't want to do this.
+%9Description:%9
-Examples:
+ Displays the users who are in a channel; you can provide multiple channels
+ by separating them with the comma "," character.
-/NAMES
- - shows nicks in the current channel.
+%9Examples:%9
-/NAMES -ops #c1,#c2
- - shows operators in channels #c1 and #c2
+ /NAMES -ops
+ /NAMES -voices #irssi,#freenode
-See also: WHO, CHANNEL
+%9See also:%9 JOIN, PART, WHO, WHOIS
diff --git a/docs/help/in/nctcp.in b/docs/help/in/nctcp.in
index 58b80545..3e6858f6 100644
--- a/docs/help/in/nctcp.in
+++ b/docs/help/in/nctcp.in
@@ -1,7 +1,21 @@
+%9Syntax:%9
+
@SYNTAX:nctcp@
-Sends a CTCP reply notice to the nick/channel.
+%9Parameters:%9
+
+ 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
-See also: CTCP, ACTION, MSG, NOTICE
+%9See also:%9 CTCP
diff --git a/docs/help/in/netsplit.in b/docs/help/in/netsplit.in
index 2e244ca1..e1667179 100644
--- a/docs/help/in/netsplit.in
+++ b/docs/help/in/netsplit.in
@@ -1,6 +1,16 @@
+%9Syntax:%9
+
@SYNTAX:netsplit@
-Irssi keeps track of people who were lost in net splits. With this
-command you can get a list of them.
+%9Description:%9
+
+ Displays some information about users who are currently lost in one or
+ more netsplits.
+
+%9Examples:%9
+
+ /NETSPLIT
+
+%9See also:%9 JOIN, LINKS, MAP, PART
diff --git a/docs/help/in/nick.in b/docs/help/in/nick.in
index 195520a0..59e15cab 100644
--- a/docs/help/in/nick.in
+++ b/docs/help/in/nick.in
@@ -1,5 +1,20 @@
+%9Syntax:%9
+
@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
diff --git a/docs/help/in/note.in b/docs/help/in/note.in
deleted file mode 100644
index da5a8b1a..00000000
--- a/docs/help/in/note.in
+++ /dev/null
@@ -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
-
diff --git a/docs/help/in/notice.in b/docs/help/in/notice.in
index 6b4da9b0..c715c8a6 100644
--- a/docs/help/in/notice.in
+++ b/docs/help/in/notice.in
@@ -1,10 +1,24 @@
+%9Syntax:%9
+
@SYNTAX:notice@
-Sends a notice to the nick or the channel. Usually notices are
-used in bots and scripts for different kinds of replies. The
-IRC protocol states that notices may not generate replies to
-avoid msg loops.
+%9Parameters:%9
+
+ 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
-See also: NCTCP, MSG
+%9See also:%9 CTCP, MSG, NCTCP
diff --git a/docs/help/in/notify.in b/docs/help/in/notify.in
index 5f56bf4d..14253c15 100644
--- a/docs/help/in/notify.in
+++ b/docs/help/in/notify.in
@@ -1,13 +1,29 @@
+%9Syntax:%9
+
@SYNTAX:notify@
- -away: Notifies about away-status changes
- -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
-list are online or offline.
+%9Parameters:%9
+
+ -away: Notifies you if the target modifies its away status.
+ -list: Displays the list of notifications.
+
+ 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
-See also: UNNOTIFY, SET NOTIFY
+%9See also:%9 AWAY, HILIGHT, UNNOTIFY