Add helpful comments about the encoding of a new iochannel. (Amaury

Thu Nov 21 15:52:04 2002  Owen Taylor  <otaylor@redhat.com>

        * glib/tmpl/iochannels.sgml: Add helpful comments about
        the encoding of a new iochannel. (Amaury Jacquot,
        #96444)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index e15adcd..4eaa986 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+Thu Nov 21 15:52:04 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/tmpl/iochannels.sgml: Add helpful comments about
+       the encoding of a new iochannel. (Amaury Jacquot,
+       #96444)
+
 2002-11-21  Matthias Clasen  <maclas@gmx.de>
 
        * glib/tmpl/string_utils.sgml: Add note on including gprintf.h,

diff --git a/docs/reference/glib/tmpl/iochannels.sgml b/docs/reference/glib/tmpl/iochannels.sgml
index acae9f6..380e7b3 100644 (file)
--- a/docs/reference/glib/tmpl/iochannels.sgml
+++ b/docs/reference/glib/tmpl/iochannels.sgml
@@ -86,6 +86,17 @@ On UNIX systems this works for plain files, pipes, and sockets.
 <para>
 The returned #GIOChannel has a reference count of 1.
 </para>
+<para>
+The default encoding for #GIOChannel is UTF-8. If your application
+is reading output from a command using via pipe, you may need to
+set the encoding to the encoding of the current locale (see
+g_get_charset()) with the g_io_channel_set_encoding() function.
+</para>
+<para>
+If you want to read raw binary data without interpretation, then
+call the g_io_charset_set_encoding() function with %NULL for the
+encoding argument.
+</para>
 
 @fd: a file descriptor.
 @Returns: a new #GIOChannel.