diff options
author | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-06 15:00:46 +0200 |
---|---|---|
committer | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-06 15:00:46 +0200 |
commit | 120508c14f42440408ab0ae4d32367a62bf9a9b2 (patch) | |
tree | 3aa5b5901fccd6f7812a861a7e15fa8e51b6078a /docs/help/in/knock.in | |
parent | 06b6371ac544dc950291d4d4a72bf5e1a8e58441 (diff) | |
download | irssi-120508c14f42440408ab0ae4d32367a62bf9a9b2.zip |
Syntax documentation rewrite for J-K commands
Rewrote the syntax documentation for all commands starting with the
letters J and K.
Diffstat (limited to 'docs/help/in/knock.in')
-rw-r--r-- | docs/help/in/knock.in | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/docs/help/in/knock.in b/docs/help/in/knock.in index c7b23c56..f5c2cf53 100644 --- a/docs/help/in/knock.in +++ b/docs/help/in/knock.in @@ -1,16 +1,30 @@ +%9Syntax:%9 + @SYNTAX:knock@ -Works only in some IRC networks (hybrid-like ircds). +%9Parameters:%9 + + The channel you wish to get invited to. + +%9Description:%9 + + Sends an invitation request to the channel operators of the target channel; + this command may not work on all IRC servers. + + The following conditions must be met: -KNOCK is a feature that lets you request access to a channel they cannot join without an invite, a key or a raised limit. + * You are not banned from the channel. + * The channel is not private. + * You may not be already in the channel. + * The channel must be invite only, have a key or has exceeded its user + limit. -The following conditions must be met for KNOCK to work: +%9Examples:%9 - - You are not banned from the channel - - Channel is not private (+p) - - You are not already on the channel - - Channel is invite only (+i), has a key (+k) or limit is full + /KNOCK #irssi + /KNOCK #freenode + /KNOCK #github -When successful KNOCK is issued, it sends a notice to channel operators. Use of KNOCK is rate limited by the server. +%9See also:%9 INVITE, JOIN |