summaryrefslogtreecommitdiff
path: root/doc/ref/api-io.texi
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2009-11-15 14:46:33 +0100
committerLudovic Courtès <ludo@gnu.org>2009-11-16 09:23:45 +0100
commit4c7b997519050243fa5474b03f8164da03be04d8 (patch)
tree2c094729171859285c3b1763dbd88d9b1eeeb497 /doc/ref/api-io.texi
parentb9fd657add26c7936fdfda80fc382630181cb113 (diff)
downloadguile-4c7b997519050243fa5474b03f8164da03be04d8.tar.gz
Improve documentation of supported encoding names.
* doc/ref/api-evaluation.texi (Character Encoding of Source Files): Mention IANA as the list of supported character encodings. Thanks to Bruno Haible for pointing this out. * doc/ref/api-io.texi (Ports): Likewise. Improve documentation of `%default-port-encoding'.
Diffstat (limited to 'doc/ref/api-io.texi')
-rw-r--r--doc/ref/api-io.texi12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/ref/api-io.texi b/doc/ref/api-io.texi
index a5ffa2319..b64ff6719 100644
--- a/doc/ref/api-io.texi
+++ b/doc/ref/api-io.texi
@@ -107,19 +107,21 @@ Equivalent to @code{(or (input-port? @var{x}) (output-port?
@deffn {Scheme Procedure} set-port-encoding! port enc
@deffnx {C Function} scm_set_port_encoding_x (port, enc)
-Sets the character encoding that will be used to interpret all port
-I/O. @var{enc} is a string containing the name of an encoding.
+Sets the character encoding that will be used to interpret all port I/O.
+@var{enc} is a string containing the name of an encoding. Valid
+encoding names are those
+@url{http://www.iana.org/assignments/character-sets, defined by IANA}.
@end deffn
@defvr {Scheme Variable} %default-port-encoding
A fluid containing containing @code{#f} or the name of the encoding to
be used by default for newly created ports (@pxref{Fluids and Dynamic
States}). The value @code{#f} is equivalent to @code{"ISO-8859-1"}.
-@end defvr
New ports are created with the encoding appropriate for the current
-locale if @code{setlocale} has been called or ISO-8859-1 otherwise,
-and this procedure can be used to modify that encoding.
+locale if @code{setlocale} has been called or the value specified by
+this fluid otherwise.
+@end defvr
@deffn {Scheme Procedure} port-encoding port
@deffnx {C Function} scm_port_encoding