summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2009-02-07 11:48:40 +0000
committerEli Zaretskii <eliz@gnu.org>2009-02-07 11:48:40 +0000
commit7d2a859fabcea25051efff5bc6fec78b7290c2b6 (patch)
tree06719d6362742fd08290c6337eeadd100e487949 /doc
parentab992d66299ccc1269033f23f8b4ea33daca99a3 (diff)
downloademacs-7d2a859fabcea25051efff5bc6fec78b7290c2b6.tar.gz
(Explicit Encoding): Document the `charset' text property produced by
decode-coding-region and decode-coding-string.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog2
-rw-r--r--doc/lispref/nonascii.texi16
2 files changed, 18 insertions, 0 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 64e05276e36..dd57b11860a 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -5,6 +5,8 @@
* keymaps.texi (Searching Keymaps):
* nonascii.texi (Translation of Characters): Reinstate
documentation of translation-table-for-input.
+ (Explicit Encoding): Document the `charset' text property produced
+ by decode-coding-region and decode-coding-string.
2009-01-27 Alan Mackenzie <acm@muc.de>
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi
index f425c19d3d4..7e4c767ad43 100644
--- a/doc/lispref/nonascii.texi
+++ b/doc/lispref/nonascii.texi
@@ -1568,6 +1568,10 @@ inserting it.
If decoded text is inserted in some buffer, this command returns the
length of the decoded text.
+
+This command puts a @code{charset} text property on the decoded text.
+The value of the property states the character set used to decode the
+original text.
@end deffn
@defun decode-coding-string string coding-system &optional nocopy buffer
@@ -1583,6 +1587,18 @@ contains 8-bit bytes in their multibyte form).
If optional argument @var{buffer} specifies a buffer, the decoded text
is inserted in that buffer after point (point does not move). In this
case, the return value is the length of the decoded text.
+
+@cindex @code{charset}, text property
+This function puts a @code{charset} text property on the decoded text.
+The value of the property states the character set used to decode the
+original text:
+
+@example
+@group
+(decode-coding-string "Gr\374ss Gott" 'latin-1)
+ @result{} #("Gr@"uss Gott" 0 9 (charset iso-8859-1))
+@end group
+@end example
@end defun
@defun decode-coding-inserted-region from to filename &optional visit beg end replace