summaryrefslogtreecommitdiff
path: root/docs/help/in/silence.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-30 14:29:06 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-30 14:29:06 +0200
commit822db3090f8c144833459cb7d3ed9e0422749f5e (patch)
tree5706ff105ad0cc04e8773b45a62478304d3fb6f5 /docs/help/in/silence.in
parent4beebe3238dda96efd4c3a0a6f6002ad5afc96e7 (diff)
downloadirssi-822db3090f8c144833459cb7d3ed9e0422749f5e.zip
Syntax rewrite for S-commands
Rewrote the syntax documentation for all commands starting with S.
Diffstat (limited to 'docs/help/in/silence.in')
-rw-r--r--docs/help/in/silence.in45
1 files changed, 25 insertions, 20 deletions
diff --git a/docs/help/in/silence.in b/docs/help/in/silence.in
index d4562cf7..b998c717 100644
--- a/docs/help/in/silence.in
+++ b/docs/help/in/silence.in
@@ -1,24 +1,29 @@
+%9Syntax:%9
+
@SYNTAX:silence@
-Works only in some IRC networks.
-
-SILENCE is similar in many respects to IGNORE, except that it is
-server-based. What this means is the server will never even send
-you messages from anyone you have silenced, whereas it will with
-IGNORE, where your client is responsible for filtering the messages
-out. This has the advantage of not bogging your client down with
-excessive data as it tries to filter out messages. The silence list
-is lost when you disconnect. SILENCE only affects private messages
-and invites.
-
-The default behavior is to SILENCE a nick!user@host pattern, and
-if such a pattern is not passed as the argument, it must be prepended
-with a plus ('+') to be added to your silence list. If a pattern is
-prepended with a minus ('-'), it will be removed from your silence list.
-If you only specify a nickname, you can list the patterns in the
-silence list owned by that nickname. If no arguments are given, your
-own silence list is displayed.
-
-See also: IGNORE, ACCEPT
+%9Parameters:%9
+
+ The nickname or hostname to silence; you must prepend it by the "+" or "-"
+ character to indicate whether the entry should be added or removed.
+
+ If no arguments are given, the list of silence entries will be displayed.
+
+%9Description:%9
+
+ Manages the server side ignore list; users or hostnames that match an entry
+ on the list are not able to send you any messages or invites.
+
+ This command does not work on all IRC networks.
+
+%9Examples:%9
+
+ /SILENCE
+ /SILENCE +mike
+ /SILENCE -mike
+ /SILENCE +*!*@*.irssi.org
+ /SILENCE -*!*@*.irssi.org
+
+%9See also:%9 ACCEPT, IGNORE