diff options
author | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-15 19:52:56 +0200 |
---|---|---|
committer | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-15 19:52:56 +0200 |
commit | 6e68b8372322c8d1f794f0b69886d618a33756e9 (patch) | |
tree | db360582050120077b9a0bad1297898d566e7c7f | |
parent | dde8540e3efccb7e1a86cfe9c57395a7cb5f4071 (diff) | |
download | irssi-6e68b8372322c8d1f794f0b69886d618a33756e9.zip |
Syntax rewrite for R-commands
Rewrote the syntax documentation for all commands starting with the
letter R.
-rw-r--r-- | docs/help/in/rawlog.in | 29 | ||||
-rw-r--r-- | docs/help/in/recode.in | 68 | ||||
-rw-r--r-- | docs/help/in/reconnect.in | 20 | ||||
-rw-r--r-- | docs/help/in/rehash.in | 21 | ||||
-rw-r--r-- | docs/help/in/reload.in | 18 | ||||
-rw-r--r-- | docs/help/in/restart.in | 16 | ||||
-rw-r--r-- | docs/help/in/rmreconns.in | 12 | ||||
-rw-r--r-- | docs/help/in/rmrejoins.in | 14 |
8 files changed, 119 insertions, 79 deletions
diff --git a/docs/help/in/rawlog.in b/docs/help/in/rawlog.in index 666b7dcc..b0405eb0 100644 --- a/docs/help/in/rawlog.in +++ b/docs/help/in/rawlog.in @@ -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 + + SAVE: Saves the raw server buffer into a file. + OPEN: Opens a logfile and start logging all raw data. + CLOSE: Closes the logfile + + The filename to store the raw data into. + +%9Description:%9 + + Saves all the raw data that is received from and transmitted to the active + server into a logfile. -/RAWLOG SAVE <filename> - Save the current raw log buffer to file +%9Examples:%9 -/RAWLOG OPEN <filename> - Like /RAWLOG SAVE, but keep the log file - open and write all new log to it. + /RAWLOG SAVE ~/server.log + /RAWLOG OPEN ~/debug.log + /RAWLOG CLOSE -/RAWLOG CLOSE - Close the open raw log - -/SET rawlog_lines <count> - Specify the number of raw log lines to - keep in memory. +%9See also:%9 LOG diff --git a/docs/help/in/recode.in b/docs/help/in/recode.in index 8801c565..0668ec95 100644 --- a/docs/help/in/recode.in +++ b/docs/help/in/recode.in @@ -1,59 +1,39 @@ -@SYNTAX:recode@ - -RECODE - %|List the conversion database - -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. - -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) +%9Syntax:%9 -To specify your local charset you have to set term_charset - -Example: - -/SET term_charset <charset> - -To see the recode settings: /SET recode +@SYNTAX:recode@ -You can change them with /SET +%9Parameters:%9 -Examples: + ADD: Adds an entry into the conversion database. + REMOVE: Removes an entry from the conversion database. -/SET recode OFF -to turn off recode completely + The network tag and channel or nickname to add or remove; if no target is + given, the active nickname or channel will be used. -/SET recode_fallback <charset> -to set the fallback charset for incoming events +%9Description:%9 -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. + Recodes the data transmitted to and received from nicknames and channels + into a specific charset. -/SET recode_out_default_charset <charset> -to set the global outgoing charset + To get a list of supported charsets on your system, you can generally use + the "iconv -l" command. -When it's set to a charset it will be used -if no conversion for the target is set. +%9Examples:%9 -/SET recode_transliterate ON -to enable the global transliteration. + /RECODE + /RECODE ADD Freenode/mike utf-8 + /RECODE ADD #korea euc-kr + /RECODE REMOVE #korea -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> +%9Special Examples:%9 -/SET recode_autodetect_utf8 OFF -to turn automatic UTF-8 detection off. + /SET term_charset utf-8 + /SET recode_fallback ISO-8859-15 + /SET recode_out_default_charset ISO-8859-15 -Hint: <charset> can be almost everything listed by 'iconv -l' + /TOGGLE recode_transliterate + /TOGGLE recode_autodetect_utf8 -See also: NETWORK +%9See also:%9 CONNECT, MSG, NETWORK, SERVER diff --git a/docs/help/in/reconnect.in b/docs/help/in/reconnect.in index 81a7fc46..aa1dc946 100644 --- a/docs/help/in/reconnect.in +++ b/docs/help/in/reconnect.in @@ -1,10 +1,22 @@ +%9Syntax:%9 + @SYNTAX:reconnect@ -You can reconnect to server with /RECONNECT <n>. +%9Parameters:%9 + + The network tag and message to advertise; if no arguments are given, the + active server and default message will be used. + +%9Description:%9 + + Disconnect and reconnect from a network. + +%9Examples:%9 -/RECONNECT without any arguments will disconnect from the -active server and reconnect back immediately. + /RECONNECT + /RECONNECT Freenode + /RECONNECT EFnet BRB :) -See also: SERVER, DISCONNECT, RMRECONNS +%9See also:%9 CONNECT, DISCONNECT, NETWORK, RMRECONNS, SERVER diff --git a/docs/help/in/rehash.in b/docs/help/in/rehash.in index ab09c631..a7e774e6 100644 --- a/docs/help/in/rehash.in +++ b/docs/help/in/rehash.in @@ -1,14 +1,21 @@ +%9Syntax:%9 + @SYNTAX:rehash@ -IRC Operator command. +%9Parameters:%9 + + The raw parameters to send to the server, if no arguments are given, none + will be sent to the server. + +%9Description:%9 + + Reloads the configuration of the IRC server you are are connected to; this + command is restricted to IRC operators. -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. +%9Examples:%9 -Some servers have various types of rehashes, specified by an additional -parameter. + /REHASH -See also: OPER, RESTART +%9See also:%9 DIE, KILL, OPER diff --git a/docs/help/in/reload.in b/docs/help/in/reload.in index f9e6f6e2..80cfcc4d 100644 --- a/docs/help/in/reload.in +++ b/docs/help/in/reload.in @@ -1,7 +1,21 @@ +%9Syntax:%9 + @SYNTAX:reload@ -Reloads irssi's configuration file. +%9Parameters:%9 + + 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 -See also: SAVE +%9See also:%9 SAVE diff --git a/docs/help/in/restart.in b/docs/help/in/restart.in index c4090636..6677b795 100644 --- a/docs/help/in/restart.in +++ b/docs/help/in/restart.in @@ -1,12 +1,16 @@ +%9Syntax:%9 + @SYNTAX:restart@ -IRC Operator command. +%9Description:%9 + + Restarts the active IRC server; this command is restricted to IRC + administrators. + +%9Examples:%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. + /RESTART -See also: OPER, DIE +%9See also:%9 DIE, KILL, OPER, REHASH diff --git a/docs/help/in/rmreconns.in b/docs/help/in/rmreconns.in index e6e4e92c..4295d4a0 100644 --- a/docs/help/in/rmreconns.in +++ b/docs/help/in/rmreconns.in @@ -1,7 +1,15 @@ +%9Syntax:%9 + @SYNTAX:rmreconns@ -Removes the pending reconnections from the reconnect list. +%9Description:%9 + + Removes all active and pending reconnections. + +%9Examples:%9 + + /RMRECONNS -See also: CONNECT, RECONNECT, SERVER +%9See also:%9 CONNECT, DISCONNECT, NETWORK, SERVER diff --git a/docs/help/in/rmrejoins.in b/docs/help/in/rmrejoins.in index a485e93a..bfc4f860 100644 --- a/docs/help/in/rmrejoins.in +++ b/docs/help/in/rmrejoins.in @@ -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 + + Removes all active and pending join requests. + +%9Examples:%9 + + /RMREJOINS -See also: JOIN +%9See also:%9 JOIN, PART |