1
0
mirror of https://github.com/irssi/irssi.git synced 2024-09-29 04:45:57 -04:00

Syntax documentation rewrite for D-commands

Rewrote the syntax documentation for all commands starting with the
letter D.
This commit is contained in:
Geert Hauwaerts 2014-07-03 21:37:41 +02:00
parent 3f79c8553c
commit 878411edc4
7 changed files with 129 additions and 55 deletions

View File

@ -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

View File

@ -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.
%9Parameters:%9
See also: CD
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

View File

@ -1,7 +1,20 @@
%9Syntax:%9
@SYNTAX:dehilight@
Removes the specified item from highlight list.
%9Parameters:%9
See also: HILIGHT
The id or mask of the highlight to remove.
%9Description:%9
Removes the specified highlight from the configuration.
%9Examples:%9
/DEHILIGHT 1
/DEHILIGHT 31
%9See also:%9 HILIGHT

View File

@ -1,10 +1,23 @@
%9Syntax:%9
@SYNTAX:deop@
Takes off the channel operator privileges from the
specified nick(s).
%9Parameters:%9
Wildcards in the nick are allowed.
A list of nicknames to deop.
See also: OP
%9Description:%9
Removes the channel operator privileges from the given nicknames; you
may use the wildcard character "*" in a nickname.
%9Examples:%9
/DEOP mike
/DEOP bob sarah
/DEOP jo*n
/DEOP *
%9See also:%9 DEVOICE, MODE, OP, VOICE

View File

@ -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
Wildcards in the nick are allowed.
A list of nicknames to devoice.
See also: VOICE, MODE
%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
/DEVOICE mike
/DEVOICE bob sarah
/DEVOICE jo*n
/DEVOICE *
%9See also:%9 DEOP, MODE, OP, VOICE

View File

@ -1,7 +1,15 @@
%9Syntax:%9
@SYNTAX:die@
IRC operator command. Terminates the IRC server.
%9Description:%9
See also: OPER
Terminates the IRC server; this command is reserved for IRC operators.
%9Examples:%9
/DIE
%9See also:%9 KILL, OPER, WALLOPS

View File

@ -1,9 +1,25 @@
%9Syntax:%9
@SYNTAX:disconnect@
Disconnects from the specified IRC-server.
The server tags can be seen with:
/SERVER
%9Parameters:%9
See also: CONNECT, SERVER
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
%9See also:%9 CONNECT, SERVER