OTP-8393 The new function shell:prompt_func/1 and the new application

          configuration parameter shell_prompt_func can be used for
          customizing the Erlang shell prompt.

1 files changed, 21 insertions, 13 deletions

diff --git a/lib/stdlib/doc/src/stdlib_app.xml b/lib/stdlib/doc/src/stdlib_app.xml
index da046b8a8d..a615c1bf88 100644
--- a/lib/stdlib/doc/src/stdlib_app.xml
+++ b/lib/stdlib/doc/src/stdlib_app.xml
@@ -4,23 +4,21 @@
 <appref>
   <header>
     <copyright>
-      <year>2005</year>
-      <year>2007</year>
-      <holder>Ericsson AB, All Rights Reserved</holder>
+      <year>2005</year><year>2010</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
-  The contents of this file are subject to the Erlang Public License,
-  Version 1.1, (the "License"); you may not use this file except in
-  compliance with the License. You should have received a copy of the
-  Erlang Public License along with this software. If not, it can be
-  retrieved online at http://www.erlang.org/.
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
 
-  Software distributed under the License is distributed on an "AS IS"
-  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-  the License for the specific language governing rights and limitations
-  under the License.
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
 
-  The Initial Developer of the Original Code is Ericsson AB.
     </legalnotice>
 
     <title>STDLIB</title>
@@ -63,6 +61,16 @@
         <p>This parameter can be used to determine how many 
           commands are saved by the Erlang shell.</p>
       </item>
+      <tag><c>shell_prompt_func = {Mod, Func} | default</c></tag>
+      <item>
+        <p>where</p>
+        <list type="bulleted">
+          <item><c>Mod = atom()</c></item>
+          <item><c>Func = atom()</c></item>
+        </list>
+        <p>This parameter can be used to set a customized 
+          Erlang shell prompt function.</p>
+      </item>
       <tag><c>shell_saved_results = integer() >= 0</c></tag>
       <item>
         <p>This parameter can be used to determine how many