From 785cb2081ff2c84453506380c97aced147df2b73 Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Tue, 11 Mar 2014 09:41:19 +0100
Subject: erts: Clarify escript's encoding of the I/O-server

A note has been added that clarifies that the encoding of
the I/O-server has to be set explicitly, irrespective of
any encoding comment.
---
 erts/doc/src/escript.xml             | 23 ++++++++++++++++++-----
 lib/stdlib/doc/src/unicode_usage.xml |  3 ++-
 2 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/erts/doc/src/escript.xml b/erts/doc/src/escript.xml
index d2b09d4515..1abbdb2180 100644
--- a/erts/doc/src/escript.xml
+++ b/erts/doc/src/escript.xml
@@ -4,7 +4,7 @@
 <comref>
   <header>
     <copyright>
-      <year>2007</year><year>2013</year>
+      <year>2007</year><year>2014</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -92,6 +92,18 @@ $ <input>escript factorial 5</input>        </pre>
           marker="stdlib:epp#encoding">encoding</seealso> it can be
           located on the second line.</p>
 
+        <note><p>
+          The encoding specified by the above mentioned comment
+          applies to the script itself. The encoding of the
+          I/O-server, however, has to be set explicitly like this:
+<code>io:setopts([{encoding, unicode}])</code></p>
+          <p>The default encoding of the I/O-server for <c>standard_io</c>
+          is <c>latin1</c>
+          since the script runs in a non-interactive terminal
+          (see <seealso marker="stdlib:unicode_usage#unicode_options_summary">
+          Using Unicode in Erlang</seealso>).
+        </p></note>
+
 	<p>On the third line (or second line depending on the presence
           of the Emacs directive), it is possible to give arguments to
           the emulator, such as </p>
@@ -141,8 +153,9 @@ halt(1).</pre>
 -include_lib("kernel/include/file.hrl").</pre>
         <p>to include the record definitions for the records used by the
           <c>file:read_link_info/1</c> function. You can also select
-          encoding here, but if there is a valid encoding comment on
-          the second line it takes precedence.</p>
+          encoding by including a encoding comment here, but if there
+          is a valid encoding comment on the second line it takes
+          precedence.</p>
 
         <p>The script will be checked for syntactic and semantic
           correctness before being run. If there are warnings (such as
@@ -163,7 +176,7 @@ halt(1).</pre>
           If much of the execution takes place in interpreted code it
           may be worthwhile to compile it, even though the compilation
           itself will take a little while. It is also possible to supply
-	  <c>native</c> instead of compile, this will compile the script 
+	  <c>native</c> instead of <c>compile</c>, this will compile the script
 	  using the native flag, again depending on the characteristics 
 	  of the escript this could or could not be worth while.</p>
 
@@ -239,7 +252,7 @@ factorial 5 = 120
         can either be returned as a binary or written to file.</p>
 
 	<p>As an example of how the function can be used, we create an
-	interpreted escript which uses emu_args to set some emulator
+	interpreted escript which uses <c>emu_args</c> to set some emulator
 	flag. In this case it happens to disable the smp_support. We
 	do also extract the different sections from the newly created
 	script:</p>
diff --git a/lib/stdlib/doc/src/unicode_usage.xml b/lib/stdlib/doc/src/unicode_usage.xml
index 75505d7d84..c843ef7736 100644
--- a/lib/stdlib/doc/src/unicode_usage.xml
+++ b/lib/stdlib/doc/src/unicode_usage.xml
@@ -996,7 +996,8 @@ ok
   </pre>
 </section>
 <section>
-  <title><marker id="unicode_options_summary"/>Summary of Options</title>
+  <title>Summary of Options</title>
+  <marker id="unicode_options_summary"/>
   <p>The Unicode support is controlled by both command line switches,
   some standard environment variables and the version of OTP you are
   using. Most options affect mainly the way Unicode data is displayed,
-- 
cgit v1.2.3