summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 21:37:41 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 21:37:41 +0200
commit878411edc4664c5d923347fdb3383d8fbe6f31c1 (patch)
tree79b2c125b79a17af8d4ae21b4734347708db8f5d /docs
parent3f79c8553c8087a79b9c37216ac72eb3e03584d5 (diff)
downloadirssi-878411edc4664c5d923347fdb3383d8fbe6f31c1.zip
Syntax documentation rewrite for D-commands
Rewrote the syntax documentation for all commands starting with the letter D.
Diffstat (limited to 'docs')
-rw-r--r--docs/help/in/completion.in14
-rw-r--r--docs/help/in/dcc.in74
-rw-r--r--docs/help/in/dehilight.in17
-rw-r--r--docs/help/in/deop.in21
-rw-r--r--docs/help/in/devoice.in24
-rw-r--r--docs/help/in/die.in12
-rw-r--r--docs/help/in/disconnect.in24
7 files changed, 130 insertions, 56 deletions
diff --git a/docs/help/in/completion.in b/docs/help/in/completion.in
index 68da328b..88fcc1b4 100644
--- a/docs/help/in/completion.in
+++ b/docs/help/in/completion.in
@@ -1,17 +1,17 @@
-Syntax:
+%9Syntax:%9
@SYNTAX:completion@
-Parameters:
+%9Parameters:%9
- -auto: Insert the completion without pressing a word completion character.
- -delete: Removes the completion from the list.
+ -auto: Inserts the completion without pressing a word completion character.
+ -delete: Removes the completion from the configuration.
A key and the value to use as a replacement. If no argument is given, the
list of completions will be displayed.
-Description:
+%9Description:%9
Replaces or completed words or letters; you can write just the first few
letters of the word and press TAB to insert a replacement.
@@ -20,12 +20,12 @@ Description:
matching word and replaces it; you may press TAB repeatedly to swap between
matches.
-Examples:
+%9Examples:%9
/COMPLETION w/h without
/COMPLETION -auto compr compromised
/COMPLETION -delete 'compr'
/COMPLETION -delete without
-See also: BIND
+%9See also:%9 BIND
diff --git a/docs/help/in/dcc.in b/docs/help/in/dcc.in
index b75d5713..59ac5036 100644
--- a/docs/help/in/dcc.in
+++ b/docs/help/in/dcc.in
@@ -1,37 +1,45 @@
+%9Syntax:%9
+
@SYNTAX:dcc@
-/DCC LIST
- - Shows all the open DCC connections.
-/DCC RESUME [<nick> [<file>]]
- - Resumes a DCC SEND/GET connection.
-/DCC CHAT [-passive] [<nick>]
- - Sends a chat connection request to remote client or accepts
- a chat connection if the remote end has already sent a request.
- If -passive is used then the passive DCC protocol is used (as mIRC
- can do). This is useful to bypass a NAT/firewall which limit your
- possibility in listening for remote connections.
-/DCC GET [<nick> [<file>]]
- - Gets the file offered by remote client. The file is downloaded and
- saved into the directory specified by the `dcc_download_path' setting.
-/DCC SEND [-passive] [-append | -prepend | -flush | -rmtail | -rmhead]
- <nick> <file> [<file> ...]
- - Sends a DCC SEND request to remote client. Remote end has to accept
- the request before the transmission can be started. Giving multiple
- files queues them. File names may contain shell expansion
- characters: * ? [] ~ (~ expansion may not be supported on all
- platforms). Files with spaces in their names need to be quoted (eg.
- "file name"). If -passive is used then the passive DCC protocol is
- used (as mIRC and xchat > 2.0.7 can do). This is useful to bypass a
- NAT/firewall which limit your possibility in listening for remote
- connections.
-/DCC SERVER [<+|-scf> <port>]
- - Starts a DCC SERVER on the specified port. The remote can connect
- to this server and initiate chat, send and fserve requests. You can
- specify + or - using any combination of the flags 's' (Send),
- 'c' (Chat), or 'f' (Fserver).
-/DCC CLOSE <type> <nick> [<file>]
- - Closes a DCC-connection. Type can be either SEND, GET or CHAT.
-
-See also: CD
+%9Parameters:%9
+
+ CHAT: Initiates or accept a chat request.
+ GET: Accepts a file transfer request.
+ RESUME: Resumes a file transfer.
+ SERVER: Starts a DCC server.
+ CLOSE: Closes a DCC connection.
+ LIST: Displays all the open DCC connections.
+
+ -passive: Uses the passive DCC protocol.
+ -scf: Use any combination of the flags to indicate:
+ 's' - send
+ 'c' - chat
+ 'f' - fserver
+
+ The nickname of the person to chat with, or the name of the file to
+ transfer.
+
+%9Description:%9
+
+ The DCC protocol is used to initiate client-to-client chat connections
+ and file transfers.
+
+ If you are behind NAT, or if the firewall is too restrictive, you might
+ want to try if using the passive parameter resolved your conneciton
+ problem.
+
+ You can send files which contain special character or spaces by enclosing
+ the filename within quotes. For example: "my file with spaces.txt".
+
+%9Examples:%9
+
+ /DCC CHAT mike
+ /DCC GET bob "summer vacation.mkv"
+ /DCC SEND sarah documents/resume.pdf
+ /DCC CLOSE mike
+ /DCC CLOSE bob "summer vacation.mkv"
+
+%9See also:%9 CD
diff --git a/docs/help/in/dehilight.in b/docs/help/in/dehilight.in
index d1202917..7c7fe152 100644
--- a/docs/help/in/dehilight.in
+++ b/docs/help/in/dehilight.in
@@ -1,7 +1,20 @@
+%9Syntax:%9
+
@SYNTAX:dehilight@
-Removes the specified item from highlight list.
+%9Parameters:%9
+
+ The id or mask of the highlight to remove.
+
+%9Description:%9
+
+ Removes the specified highlight from the configuration.
+
+%9Examples:%9
+
+ /DEHILIGHT 1
+ /DEHILIGHT 31
-See also: HILIGHT
+%9See also:%9 HILIGHT
diff --git a/docs/help/in/deop.in b/docs/help/in/deop.in
index e9893e6a..8c73a5c9 100644
--- a/docs/help/in/deop.in
+++ b/docs/help/in/deop.in
@@ -1,10 +1,23 @@
+%9Syntax:%9
+
@SYNTAX:deop@
-Takes off the channel operator privileges from the
-specified nick(s).
+%9Parameters:%9
+
+ A list of nicknames to deop.
+
+%9Description:%9
+
+ Removes the channel operator privileges from the given nicknames; you
+ may use the wildcard character "*" in a nickname.
+
+%9Examples:%9
-Wildcards in the nick are allowed.
+ /DEOP mike
+ /DEOP bob sarah
+ /DEOP jo*n
+ /DEOP *
-See also: OP
+%9See also:%9 DEVOICE, MODE, OP, VOICE
diff --git a/docs/help/in/devoice.in b/docs/help/in/devoice.in
index ce090191..852a0002 100644
--- a/docs/help/in/devoice.in
+++ b/docs/help/in/devoice.in
@@ -1,10 +1,26 @@
+%9Syntax:%9
+
@SYNTAX:devoice@
-Takes off the voice from the specified nick(s). This makes them
-not to be able to send messages to the moderated (+m) channel.
+%9Parameters:%9
+
+ A list of nicknames to devoice.
+
+%9Description:%9
+
+ Removes the channel voice privileges from the given nicknames; you
+ may use the wildcard character "*" in a nickname.
+
+ If a channel is moderated, the users will require a voice or op in
+ order to be able to send messages to the channel.
+
+%9Examples:%9
-Wildcards in the nick are allowed.
+ /DEVOICE mike
+ /DEVOICE bob sarah
+ /DEVOICE jo*n
+ /DEVOICE *
-See also: VOICE, MODE
+%9See also:%9 DEOP, MODE, OP, VOICE
diff --git a/docs/help/in/die.in b/docs/help/in/die.in
index c7daf2f6..1af9c5b7 100644
--- a/docs/help/in/die.in
+++ b/docs/help/in/die.in
@@ -1,7 +1,15 @@
+%9Syntax:%9
+
@SYNTAX:die@
-IRC operator command. Terminates the IRC server.
+%9Description:%9
+
+ Terminates the IRC server; this command is reserved for IRC operators.
+
+%9Examples:%9
+
+ /DIE
-See also: OPER
+%9See also:%9 KILL, OPER, WALLOPS
diff --git a/docs/help/in/disconnect.in b/docs/help/in/disconnect.in
index ec5d5559..4699b79c 100644
--- a/docs/help/in/disconnect.in
+++ b/docs/help/in/disconnect.in
@@ -1,9 +1,25 @@
+%9Syntax:%9
+
@SYNTAX:disconnect@
-Disconnects from the specified IRC-server.
-The server tags can be seen with:
-/SERVER
+%9Parameters:%9
+
+ The network to disconnect from and the message to advertise; if no parameters
+ are given, the active server will be used.
+
+%9Description:%9
+
+ Disconnects from one or more IRC servers; the list of all the servers you
+ are connected to can be retrieved via the SERVER command.
+
+ Use the wildcard character "*" if you want to disconnect from all servers.
+
+%9Examples:%9
+
+ /DISCONNECT Freenode I'm off for today, take care!
+ /DISCONNECT * Vacation time :D
+ /DISCONNECT
-See also: CONNECT, SERVER
+%9See also:%9 CONNECT, SERVER