summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTimo Sirainen <cras@irssi.org>2000-08-13 15:24:23 +0000
committercras <cras@dbcabf3a-b0e7-0310-adc4-f8d773084564>2000-08-13 15:24:23 +0000
commit83b03a1b4b2c0b1b4340a7889803dd79e21e1ad9 (patch)
treedeea087bbfc6ccdd5624ad9f36c98dec06da897a /docs
parent92fb184facc074bd223620025d9973c3d23159b8 (diff)
downloadirssi-83b03a1b4b2c0b1b4340a7889803dd79e21e1ad9.zip
updated
git-svn-id: http://svn.irssi.org/repos/irssi/trunk@600 dbcabf3a-b0e7-0310-adc4-f8d773084564
Diffstat (limited to 'docs')
-rw-r--r--docs/help/in/ban.in7
-rw-r--r--docs/help/in/connect.in2
-rw-r--r--docs/help/in/cycle.in3
-rw-r--r--docs/help/in/dcc.in14
-rw-r--r--docs/help/in/disconnect.in2
-rw-r--r--docs/help/in/invite.in7
-rw-r--r--docs/help/in/ison.in2
-rw-r--r--docs/help/in/lusers.in2
-rw-r--r--docs/help/in/mode.in67
-rw-r--r--docs/help/in/perlflush.in3
-rw-r--r--docs/help/in/quote.in3
-rw-r--r--docs/help/in/reconnect.in2
-rw-r--r--docs/help/in/set.in5
-rw-r--r--docs/help/in/squery.in7
-rw-r--r--docs/help/in/topic.in2
-rw-r--r--docs/help/in/unban.in4
-rw-r--r--docs/help/in/userhost.in2
-rw-r--r--docs/help/in/who.in10
-rw-r--r--docs/help/in/wquery.in3
19 files changed, 111 insertions, 36 deletions
diff --git a/docs/help/in/ban.in b/docs/help/in/ban.in
index 26c4c36f..babd961c 100644
--- a/docs/help/in/ban.in
+++ b/docs/help/in/ban.in
@@ -2,6 +2,13 @@
@SYNTAX:ban@
Bans the specified nick or userhost mask.
+If nick is given as parameter, the current
+BANTYPE affects the ban mask.
+
+Example:
+ /BAN looser - This bans the nick 'looser'
+ /BAN *!*@*.org - This bans all the users coming from any
+ .org domain.
See also: BANTYPE, KNOCKOUT
diff --git a/docs/help/in/connect.in b/docs/help/in/connect.in
index e7d652a0..e5ba96e1 100644
--- a/docs/help/in/connect.in
+++ b/docs/help/in/connect.in
@@ -5,7 +5,7 @@
-host the host
This command makes irssi to connect to specified server.
-Current connections are kept and another one is created.
+Current connections are kept and a new one is created.
See also: SERVER
diff --git a/docs/help/in/cycle.in b/docs/help/in/cycle.in
index 27ee6ae6..7e8a8fb5 100644
--- a/docs/help/in/cycle.in
+++ b/docs/help/in/cycle.in
@@ -1,7 +1,8 @@
@SYNTAX:cycle@
-Cycles (leaves and joins) the current channel or the specified channel.
+Cycles (leaves and joins) the current channel or the specified
+channel.
See also: JOIN, LEAVE, PART
diff --git a/docs/help/in/dcc.in b/docs/help/in/dcc.in
index 771f5bfa..d30a4e68 100644
--- a/docs/help/in/dcc.in
+++ b/docs/help/in/dcc.in
@@ -5,16 +5,20 @@ This is a command to handle different DCC-connections. DCC is mainly
used for more reliable and faster chatting and for sending and receiving
files.
-/DCC CHAT nick
+/DCC LIST
+ - Shows all the open DCC connections.
+/DCC RESUME <nick> [<file>]
+ - Resumes a DCC SEND/GET connection.
+/DCC CHAT <nick>
- Sends a chat connection request to remote client or accepts
- a chat connection, if the remote end has already sent a request.
-/DCC GET nick
+ a chat connection if the remote end has already sent a request.
+/DCC GET <nick> [<file>]
- Gets the file offered by remote client. The file is downloaded and
saved into the current working directory.
-/DCC SEND nick file
+/DCC SEND <nick> <file>
- Sends a DCC SEND request to remote client. Remote end has to accept
the request before the transmission can be started.
-/DCC CLOSE type nick
+/DCC CLOSE <type> <nick> [<file>]
- Closes a DCC-connection. Type can be either SEND, GET or CHAT.
See also: CD
diff --git a/docs/help/in/disconnect.in b/docs/help/in/disconnect.in
index c296e0be..cfd221d5 100644
--- a/docs/help/in/disconnect.in
+++ b/docs/help/in/disconnect.in
@@ -2,6 +2,8 @@
@SYNTAX:disconnect@
Disconnects from the specified IRC-server.
+The server tags can be seen with:
+/SERVER LIST
See also: CONNECT, SERVER
diff --git a/docs/help/in/invite.in b/docs/help/in/invite.in
index 53afd898..1e7f69b1 100644
--- a/docs/help/in/invite.in
+++ b/docs/help/in/invite.in
@@ -1,7 +1,10 @@
@SYNTAX:invite@
-Invites the specified nick to the current channel.
+Invites the specified nick to the current or specified channel.
-See also:
+Example:
+ /INVITE buddy #mychannel
+
+See also: MODE
diff --git a/docs/help/in/ison.in b/docs/help/in/ison.in
index 01033f9f..b97ff5de 100644
--- a/docs/help/in/ison.in
+++ b/docs/help/in/ison.in
@@ -3,5 +3,5 @@
Tells whether specified nicks are online.
-See also:
+See also: WHOIS, WHOWAS, NOTIFY
diff --git a/docs/help/in/lusers.in b/docs/help/in/lusers.in
index 24d76bb3..abcd55c4 100644
--- a/docs/help/in/lusers.in
+++ b/docs/help/in/lusers.in
@@ -3,5 +3,3 @@
Shows user statistics of the current IRC network.
-See also:
-
diff --git a/docs/help/in/mode.in b/docs/help/in/mode.in
index aabbe224..baccf1f8 100644
--- a/docs/help/in/mode.in
+++ b/docs/help/in/mode.in
@@ -1,24 +1,51 @@
@SYNTAX:mode@
-Changes and/or views modes. You can either change
-your own modes or channel modes (given that you're
-a channel operator).
-
-Examples:
-
-/MODE * +s
- - Makes the current channel secret
-
-/MODE #irssi -o Beel0
- - Deops user Beel0 on channel #irssi
-
-/MODE * +b *!*@*.org
- - Bans on the current channel all users coming
- from .org hosts.
-
-/MODE yournick +w
- - Makes you to see the wallops.
-
-See also: BAN, VOICE, OP, DEOP
+Both channels and users have modes associated with them. For channels,
+they determine who is a channel operator, the number of people who may
+join the channel, who may not enter the channel, and myriad other things.
+For users, they determine whether the user is an IRC operator, whether
+the user will receive special server notices, etc.
+
+Modes are enabled when prepended with a "+", and disabled when with a "-".
+
+Standard User Modes:
+ i When enabled, you are "invisible" to NAMES and WHO queries from
+ anyone not on a channel common to you. Additionally, you are also
+ hidden from WHOIS unless you exact nickname is specified.
+ o When enabled, this gives you IRC operator status.
+ s When enabled, you will receive special server notices.
+ w When enabled, you will receive IRC operator WALLOPS, as well as
+ notices of any remote CONNECTs or SQUITs.
+
+Standard Channel Modes:
+ b When enabled, this prevents the specified nick!user@host mask from
+ entering the channel.
+ i When enabled, users may only join the channel if INVITEd.
+ k When enabled, users may only join the channel if they specify the
+ proper "key".
+ l When enabled, only the specified number of users may enter the channel.
+ m When enabled, only users with +o or +v may speak on the channel.
+ n When enabled, public messages from outside the channel are not allowed.
+ o When enabled, grants the specified nickname channel operator status.
+ p When enabled, the channel is made private. The channel name will not show
+ up in WHO, WHOIS, NAMES, or LIST replies.
+ s When enabled, makes the channel secret. This is the same as +p, except
+ the channel will not show up in any WHO/WHOIS /etc. queries from a
+ person not on the channel. Anyone who is on a +s channel is effectively
+ invisible, as per user mode +i.
+ t When enabled, only channnel operators may set a topic.
+ v When enabled, grants the specified nickname voice status.
+
+Examples:
+ /MODE your_nick +sw - Receive operator WALLOPS and server notices
+ /MODE your_nick +s+w (both examples are equivalent).
+ /MODE #channel +l 35 - Set a channel limit
+ /MODE #channel +o theirnick
+ - Make theirnick a channel operator.
+ /MODE #channel +bk-o *!*some@*.ban.com Secret_Key foobar
+ - Set a ban, a key, and remove chanop status
+ from 'foobar'.
+
+See also: BAN, VOICE, OP, DEOP, INVITE
diff --git a/docs/help/in/perlflush.in b/docs/help/in/perlflush.in
index 0226d8d9..27fc509f 100644
--- a/docs/help/in/perlflush.in
+++ b/docs/help/in/perlflush.in
@@ -1,7 +1,8 @@
@SYNTAX:perlflush@
-Stops and removes all Perl-scripts which have been run.
+Stops and removes all Perl scripts which have been run.
+Also undefines all the commands defined by Perl scripts.
See also: RUN
diff --git a/docs/help/in/quote.in b/docs/help/in/quote.in
index 2e92037b..eceb409c 100644
--- a/docs/help/in/quote.in
+++ b/docs/help/in/quote.in
@@ -3,3 +3,6 @@
Sends server raw data without parsing.
+Example:
+ /QUOTE PRIVMSG cras :Hey, this works!
+
diff --git a/docs/help/in/reconnect.in b/docs/help/in/reconnect.in
index 08c14689..81a7fc46 100644
--- a/docs/help/in/reconnect.in
+++ b/docs/help/in/reconnect.in
@@ -6,5 +6,5 @@ You can reconnect to server with /RECONNECT <n>.
/RECONNECT without any arguments will disconnect from the
active server and reconnect back immediately.
-See also: SERVER, DISCONNECT
+See also: SERVER, DISCONNECT, RMRECONNS
diff --git a/docs/help/in/set.in b/docs/help/in/set.in
index f21f81af..e355aaba 100644
--- a/docs/help/in/set.in
+++ b/docs/help/in/set.in
@@ -14,5 +14,10 @@ when /TOGGLE behaves exactly like /SET.
Remember that changes are not saved until you use /SAVE!
+Examples:
+ /SET autolog OFF - Sets value for setting 'autolog'
+ /SET close - Shows all settings whose variable name
+ contains 'close'. Very practical.
+
See also: TOGGLE
diff --git a/docs/help/in/squery.in b/docs/help/in/squery.in
index 05f9b294..a0bb4f11 100644
--- a/docs/help/in/squery.in
+++ b/docs/help/in/squery.in
@@ -1,5 +1,10 @@
@SYNTAX:squery@
-/SQUERY sends a query to specified service.
+ <service> - Service name
+ <commands> - Commands to pass to the service.
+
+/SQUERY sends a query to the specified service.
+
+See also: SERVLIST
diff --git a/docs/help/in/topic.in b/docs/help/in/topic.in
index 1c86ba31..ae2564f8 100644
--- a/docs/help/in/topic.in
+++ b/docs/help/in/topic.in
@@ -1,6 +1,8 @@
@SYNTAX:topic@
+ -delete - Deletes the topic.
+
Shows or/and changes the topic of the current or specified
channel.
diff --git a/docs/help/in/unban.in b/docs/help/in/unban.in
index 797a33f4..a22963a1 100644
--- a/docs/help/in/unban.in
+++ b/docs/help/in/unban.in
@@ -3,5 +3,9 @@
Removes the specified ban(s) from the channel.
+Examples:
+ /UNBAN *!*@*.fi
+ /UNBAN larry!*@* *!me@*.mydomain.net
+
See also: BAN, KNOCKOUT
diff --git a/docs/help/in/userhost.in b/docs/help/in/userhost.in
index 55073771..a1039f9d 100644
--- a/docs/help/in/userhost.in
+++ b/docs/help/in/userhost.in
@@ -3,3 +3,5 @@
Shows the userhost info of the specified nick.
+See also: WHOIS
+
diff --git a/docs/help/in/who.in b/docs/help/in/who.in
index 7885b29c..014231ee 100644
--- a/docs/help/in/who.in
+++ b/docs/help/in/who.in
@@ -5,9 +5,19 @@ Without parameters, shows all users and their user infos
on the current channel. If you specify a channel, shows
the all users of the given channel.
+If you specify an string with wildcards, you will be
+shown all users whose nick, userhost or realname matches
+the wildcard expression.
+
If a channel is secret or private and you're not on it,
you will be shown only those channel members, who do not
have the invisible (+i) mode set.
+Examples:
+ /WHO - Shows users on current channel
+ /WHO #irssi - Shows users on channel #irssi
+ /WHO timo* - Shows users whose nick, userhost,
+ or realname begins with string 'timo'
+
See also: WHOIS, CHANNEL
diff --git a/docs/help/in/wquery.in b/docs/help/in/wquery.in
index 6a94e5b7..ae4799af 100644
--- a/docs/help/in/wquery.in
+++ b/docs/help/in/wquery.in
@@ -1,7 +1,8 @@
@SYNTAX:wquery@
-Creates a query to the current window.
+Starts a query in the current window without
+opening a new window.
See also: QUERY, WINDOW, SET AUTOCREATE