From 9fd1e2f5dadcf491755e0de26871c4a1a5c35394 Mon Sep 17 00:00:00 2001 From: Geert Hauwaerts Date: Sat, 12 Jul 2014 18:46:44 +0200 Subject: [PATCH] Syntax documentation rewrite for Q-commands Rewrote the syntax documentation for all commands starting with the letter Q. --- docs/help/in/query.in | 24 +++++++++++++++++------- docs/help/in/quit.in | 21 ++++++++++++++++----- 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 -Usually this command opens up a new window, too. + -window: Uses the active window instead of opening a new one. + -: The server tag the target nickname is on. -Note: It removes the active query from the active window when -used without parameters, like UNQUERY. + The nickname to query and the message. -See also: WINDOW, MSG, SET QUERY, UNQUERY +%9Description:%9 + + Starts a private conversation with a nickname. + +%9Examples:%9 + + /QUERY mike + /QUERY -freenode bob + /QUERY -freenode -window sarah + +%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 -/EXIT does the same. + 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! + +%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 -Example: - /QUOTE PRIVMSG cras :Hey, this works! + 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! + +%9See also:%9 CONNECT, DISCONNECT, JOIN, MSG, PART