summaryrefslogtreecommitdiff
path: root/docs/help/in/recode.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-15 19:52:56 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-15 19:52:56 +0200
commit6e68b8372322c8d1f794f0b69886d618a33756e9 (patch)
treedb360582050120077b9a0bad1297898d566e7c7f /docs/help/in/recode.in
parentdde8540e3efccb7e1a86cfe9c57395a7cb5f4071 (diff)
downloadirssi-6e68b8372322c8d1f794f0b69886d618a33756e9.zip
Syntax rewrite for R-commands
Rewrote the syntax documentation for all commands starting with the letter R.
Diffstat (limited to 'docs/help/in/recode.in')
-rw-r--r--docs/help/in/recode.in68
1 files changed, 24 insertions, 44 deletions
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