mirror of
https://github.com/irssi/irssi.git
synced 2024-12-04 14:46:39 -05:00
Syntax rewrite for R-commands
Rewrote the syntax documentation for all commands starting with the letter R.
This commit is contained in:
Geert Hauwaerts
parent
dde8540e3e
commit
6e68b83723
@ -1,17 +1,26 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:rawlog@
|
||||
|
||||
All data that is received or sent to server is kept in a raw log
|
||||
buffer for a while. Also event redirections are kept there. This is
|
||||
very useful for debugging purposes.
|
||||
%9Parameters:%9
|
||||
|
||||
/RAWLOG SAVE <filename> - Save the current raw log buffer to file
|
||||
SAVE: Saves the raw server buffer into a file.
|
||||
OPEN: Opens a logfile and start logging all raw data.
|
||||
CLOSE: Closes the logfile
|
||||
|
||||
/RAWLOG OPEN <filename> - Like /RAWLOG SAVE, but keep the log file
|
||||
open and write all new log to it.
|
||||
The filename to store the raw data into.
|
||||
|
||||
/RAWLOG CLOSE - Close the open raw log
|
||||
|
||||
/SET rawlog_lines <count> - Specify the number of raw log lines to
|
||||
keep in memory.
|
||||
%9Description:%9
|
||||
|
||||
Saves all the raw data that is received from and transmitted to the active
|
||||
server into a logfile.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/RAWLOG SAVE ~/server.log
|
||||
/RAWLOG OPEN ~/debug.log
|
||||
/RAWLOG CLOSE
|
||||
|
||||
%9See also:%9 LOG
|
||||
|
||||
|
||||
@ -1,59 +1,39 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:recode@
|
||||
|
||||
RECODE
|
||||
%|List the conversion database
|
||||
%9Parameters:%9
|
||||
|
||||
RECODE ADD %|[<tag>]|[[<tag>/]<target>] <charset>
|
||||
%|Add an entry to the conversion database (if tag or target is
|
||||
omitted, the current channel or query will be used). You can specify
|
||||
the <tag> to have different charsets for the same <target> for
|
||||
different networks. You can omit the target, and specify only the tag
|
||||
if you want to add an entry for the network.
|
||||
ADD: Adds an entry into the conversion database.
|
||||
REMOVE: Removes an entry from the conversion database.
|
||||
|
||||
RECODE REMOVE %|[<tag>|<target>]
|
||||
%|Remove an entry from the conversion database (if tag or target is
|
||||
omitted, the current channel or query will be used)
|
||||
The network tag and channel or nickname to add or remove; if no target is
|
||||
given, the active nickname or channel will be used.
|
||||
|
||||
To specify your local charset you have to set term_charset
|
||||
%9Description:%9
|
||||
|
||||
Example:
|
||||
Recodes the data transmitted to and received from nicknames and channels
|
||||
into a specific charset.
|
||||
|
||||
/SET term_charset <charset>
|
||||
To get a list of supported charsets on your system, you can generally use
|
||||
the "iconv -l" command.
|
||||
|
||||
To see the recode settings: /SET recode
|
||||
%9Examples:%9
|
||||
|
||||
You can change them with /SET
|
||||
/RECODE
|
||||
/RECODE ADD Freenode/mike utf-8
|
||||
/RECODE ADD #korea euc-kr
|
||||
/RECODE REMOVE #korea
|
||||
|
||||
Examples:
|
||||
%9Special Examples:%9
|
||||
|
||||
/SET recode OFF
|
||||
to turn off recode completely
|
||||
/SET term_charset utf-8
|
||||
/SET recode_fallback ISO-8859-15
|
||||
/SET recode_out_default_charset ISO-8859-15
|
||||
|
||||
/SET recode_fallback <charset>
|
||||
to set the fallback charset for incoming events
|
||||
/TOGGLE recode_transliterate
|
||||
/TOGGLE recode_autodetect_utf8
|
||||
|
||||
This charset is used if your term_charset is UTF-8
|
||||
and the conversion for the target is not set and
|
||||
the text is not UTF-8.
|
||||
|
||||
/SET recode_out_default_charset <charset>
|
||||
to set the global outgoing charset
|
||||
|
||||
When it's set to a charset it will be used
|
||||
if no conversion for the target is set.
|
||||
|
||||
/SET recode_transliterate ON
|
||||
to enable the global transliteration.
|
||||
|
||||
The transliteration is based on your locale settings,
|
||||
if it doesn't work properly your locale settings may be wrong.
|
||||
You can enable it per target by adding //TRANSLIT to the <charset>
|
||||
|
||||
/SET recode_autodetect_utf8 OFF
|
||||
to turn automatic UTF-8 detection off.
|
||||
|
||||
Hint: <charset> can be almost everything listed by 'iconv -l'
|
||||
|
||||
See also: NETWORK
|
||||
%9See also:%9 CONNECT, MSG, NETWORK, SERVER
|
||||
|
||||
|
||||
@ -1,10 +1,22 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:reconnect@
|
||||
|
||||
You can reconnect to server with /RECONNECT <n>.
|
||||
%9Parameters:%9
|
||||
|
||||
/RECONNECT without any arguments will disconnect from the
|
||||
active server and reconnect back immediately.
|
||||
The network tag and message to advertise; if no arguments are given, the
|
||||
active server and default message will be used.
|
||||
|
||||
See also: SERVER, DISCONNECT, RMRECONNS
|
||||
%9Description:%9
|
||||
|
||||
Disconnect and reconnect from a network.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/RECONNECT
|
||||
/RECONNECT Freenode
|
||||
/RECONNECT EFnet BRB :)
|
||||
|
||||
%9See also:%9 CONNECT, DISCONNECT, NETWORK, RMRECONNS, SERVER
|
||||
|
||||
|
||||
@ -1,14 +1,21 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:rehash@
|
||||
|
||||
IRC Operator command.
|
||||
%9Parameters:%9
|
||||
|
||||
This command is used to force the current server to reload its
|
||||
ircd.conf configuration file. This is useful for effecting
|
||||
configuration changes without starting a new server.
|
||||
The raw parameters to send to the server, if no arguments are given, none
|
||||
will be sent to the server.
|
||||
|
||||
Some servers have various types of rehashes, specified by an additional
|
||||
parameter.
|
||||
%9Description:%9
|
||||
|
||||
See also: OPER, RESTART
|
||||
Reloads the configuration of the IRC server you are are connected to; this
|
||||
command is restricted to IRC operators.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/REHASH
|
||||
|
||||
%9See also:%9 DIE, KILL, OPER
|
||||
|
||||
|
||||
@ -1,7 +1,21 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:reload@
|
||||
|
||||
Reloads irssi's configuration file.
|
||||
%9Parameters:%9
|
||||
|
||||
See also: SAVE
|
||||
The filename of any Irssi configuration; if no parameter is given, the
|
||||
active configuration file will be used.
|
||||
|
||||
%9Description:%9
|
||||
|
||||
Reloads the Irssi configuration file.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/RELOAD
|
||||
/RELOAD ~/test.irssi.conf
|
||||
|
||||
%9See also:%9 SAVE
|
||||
|
||||
|
||||
@ -1,12 +1,16 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:restart@
|
||||
|
||||
IRC Operator command.
|
||||
%9Description:%9
|
||||
|
||||
This command is used to completely restart the server, breaking all
|
||||
connections. A side effect of this is that the configuration file
|
||||
will be read again. However, it is generally more useful for upgrading
|
||||
the server software.
|
||||
Restarts the active IRC server; this command is restricted to IRC
|
||||
administrators.
|
||||
|
||||
See also: OPER, DIE
|
||||
%9Examples:%9
|
||||
|
||||
/RESTART
|
||||
|
||||
%9See also:%9 DIE, KILL, OPER, REHASH
|
||||
|
||||
|
||||
@ -1,7 +1,15 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:rmreconns@
|
||||
|
||||
Removes the pending reconnections from the reconnect list.
|
||||
%9Description:%9
|
||||
|
||||
See also: CONNECT, RECONNECT, SERVER
|
||||
Removes all active and pending reconnections.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/RMRECONNS
|
||||
|
||||
%9See also:%9 CONNECT, DISCONNECT, NETWORK, SERVER
|
||||
|
||||
|
||||
@ -1,9 +1,15 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:rmrejoins@
|
||||
|
||||
Removes the pending rejoins from the channel rejoin list in active
|
||||
server. Channels are added to rejoin list when join failed because of
|
||||
netsplits in server ("Channel is temporarily unavailable").
|
||||
%9Description:%9
|
||||
|
||||
See also: JOIN
|
||||
Removes all active and pending join requests.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/RMREJOINS
|
||||
|
||||
%9See also:%9 JOIN, PART
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user