summaryrefslogtreecommitdiff
path: root/documentation/help/knock.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/help/knock.markdown')
-rw-r--r--documentation/help/knock.markdown47
1 files changed, 47 insertions, 0 deletions
diff --git a/documentation/help/knock.markdown b/documentation/help/knock.markdown
new file mode 100644
index 0000000..b192013
--- /dev/null
+++ b/documentation/help/knock.markdown
@@ -0,0 +1,47 @@
+---
+layout: page
+title: "Help: knock"
+---
+
+{% comment %}
+
+Please submit changes to
+- https://github.com/irssi/irssi/blob/master/docs/help/in/knock.in
+- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c
+
+
+{% endcomment %}
+[Help index](/documentation/help)
+
+### Syntax ###
+
+<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">KNOCK</span> <span class="synB05">&lt;channel></span></code></pre></div>
+
+
+
+### Parameters ###
+
+The channel you wish to get invited to.
+
+### Description ###
+
+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:
+
+* 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.
+
+### Examples ###
+
+ /KNOCK #irssi
+ /KNOCK #freenode
+ /KNOCK #github
+
+### See also ###
+[INVITE](/documentation/help/invite), [JOIN](/documentation/help/join)
+