diff options
author | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-12 18:46:44 +0200 |
---|---|---|
committer | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-12 18:46:44 +0200 |
commit | 9fd1e2f5dadcf491755e0de26871c4a1a5c35394 (patch) | |
tree | dda6e71f19326229361ec29f91105ae27f75c7ae /docs/help/in | |
parent | ee80ed16cba6d9b82a83fb667873a3b11bc93aab (diff) | |
download | irssi-9fd1e2f5dadcf491755e0de26871c4a1a5c35394.zip |
Syntax documentation rewrite for Q-commands
Rewrote the syntax documentation for all commands starting with the
letter Q.
Diffstat (limited to 'docs/help/in')
-rw-r--r-- | docs/help/in/query.in | 24 | ||||
-rw-r--r-- | docs/help/in/quit.in | 21 | ||||
-rw-r--r-- | docs/help/in/quote.in | 18 |
3 files changed, 48 insertions, 15 deletions
diff --git a/docs/help/in/query.in b/docs/help/in/query.in index d06b7701..1c0ba5b9 100644 --- a/docs/help/in/query.in +++ b/docs/help/in/query.in @@ -1,14 +1,24 @@ +%9Syntax:%9 + @SYNTAX:query@ -Starts a private conversation with the nick. All text you -type that would normally be sent to your channel now goes to -the specified nick in the form of MSGs. +%9Parameters:%9 + + -window: Uses the active window instead of opening a new one. + -<server tag>: The server tag the target nickname is on. + + The nickname to query and the message. + +%9Description:%9 + + Starts a private conversation with a nickname. -Usually this command opens up a new window, too. +%9Examples:%9 -Note: It removes the active query from the active window when -used without parameters, like UNQUERY. + /QUERY mike + /QUERY -freenode bob + /QUERY -freenode -window sarah -See also: WINDOW, MSG, SET QUERY, UNQUERY +%9See also:%9 MSG, UNQUERY, WINDOW diff --git a/docs/help/in/quit.in b/docs/help/in/quit.in index fe6ad01b..1b9ca267 100644 --- a/docs/help/in/quit.in +++ b/docs/help/in/quit.in @@ -1,10 +1,21 @@ +%9Syntax:%9 + @SYNTAX:quit@ -This ends your IRC session. If a quit message is supplied, it -will be displayed to anyone else on any channel you were on -before quitting. If one isn't specified, the text "Leaving" is -used. +%9Parameters:%9 + + The message to advertise. + +%9Description:%9 + + Terminates the application and advertises the given message on all the + networks you are connected to. + +%9Examples:%9 + + /QUIT + /QUIT <@cartman> Screw you guys, I'm going home! -/EXIT does the same. +%9See also:%9 DISCONNECT diff --git a/docs/help/in/quote.in b/docs/help/in/quote.in index eceb409c..6d9723e5 100644 --- a/docs/help/in/quote.in +++ b/docs/help/in/quote.in @@ -1,8 +1,20 @@ +%9Syntax:%9 + @SYNTAX:quote@ -Sends server raw data without parsing. +%9Parameters:%9 + + The text to send to the IRC server. + +%9Description:%9 + + Sends raw data to the server without any parsing. + +%9Examples:%9 + + /QUOTE PRIVMSG mike: Hey, this works! + /QUOTE OPERWALL :Meow! -Example: - /QUOTE PRIVMSG cras :Hey, this works! +%9See also:%9 CONNECT, DISCONNECT, JOIN, MSG, PART |