aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/shell_default.xml
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2016-05-18 15:53:35 +0200
committerBjörn Gustavsson <[email protected]>2016-06-13 12:05:57 +0200
commit68d53c01b0b8e9a007a6a30158c19e34b2d2a34e (patch)
tree4613f513b9465beb7febec6c74c8ef0502f861fe /lib/stdlib/doc/src/shell_default.xml
parent99b379365981e14e2c8dde7b1a337c8ff856bd4a (diff)
downloadotp-68d53c01b0b8e9a007a6a30158c19e34b2d2a34e.tar.gz
otp-68d53c01b0b8e9a007a6a30158c19e34b2d2a34e.tar.bz2
otp-68d53c01b0b8e9a007a6a30158c19e34b2d2a34e.zip
Update STDLIB documentation
Language cleaned up by the technical writers xsipewe and tmanevik from Combitech. Proofreading and corrections by Björn Gustavsson and Hans Bolinder.
Diffstat (limited to 'lib/stdlib/doc/src/shell_default.xml')
-rw-r--r--lib/stdlib/doc/src/shell_default.xml38
1 files changed, 21 insertions, 17 deletions
diff --git a/lib/stdlib/doc/src/shell_default.xml b/lib/stdlib/doc/src/shell_default.xml
index 4a90b7d7cc..81c99bce10 100644
--- a/lib/stdlib/doc/src/shell_default.xml
+++ b/lib/stdlib/doc/src/shell_default.xml
@@ -32,25 +32,27 @@
<checked>Joe Armstrong</checked>
<date>1996-09-09</date>
<rev>A</rev>
- <file>shell_default.sgml</file>
+ <file>shell_default.xml</file>
</header>
<module>shell_default</module>
- <modulesummary>Customizing the Erlang Environment</modulesummary>
+ <modulesummary>Customizing the Erlang environment.</modulesummary>
<description>
- <p>The functions in <c>shell_default</c> are called when no module
- name is given in a shell command.
- </p>
- <p>Consider the following shell dialogue:</p>
+ <p>The functions in this module are called when no module name is
+ specified in a shell command.</p>
+
+ <p>Consider the following shell dialog:</p>
+
<pre>
-1 > <input>lists:reverse("abc").</input>
+1> <input>lists:reverse("abc").</input>
"cba"
-2 > <input>c(foo).</input>
-{ok, foo} </pre>
- <p>In command one, the module <c>lists</c> is called. In command
- two, no module name is specified. The shell searches the modules
- <c>user_default</c> followed by <c>shell_default</c> for the
- function <c>foo/1</c>.
- </p>
+2> <input>c(foo).</input>
+{ok, foo}</pre>
+
+ <p>In command one, module <seealso marker="lists"><c>lists</c></seealso> is
+ called. In command two, no module name is specified. The shell searches
+ module <c>user_default</c> followed by module <c>shell_default</c> for
+ function <c>foo/1</c>.</p>
+
<p><c>shell_default</c> is intended for "system wide"
customizations to the shell. <c>user_default</c> is intended for
"local" or individual user customizations.</p>
@@ -60,10 +62,12 @@
<title>Hint</title>
<p>To add your own commands to the shell, create a module called
<c>user_default</c> and add the commands you want. Then add the
- following line as the <em>first</em> line in your <c>.erlang</c> file in your
- home directory. </p>
+ following line as the <em>first</em> line in your <c>.erlang</c> file in
+ your home directory.</p>
+
<pre>
-code:load_abs("$PATH/user_default"). </pre>
+code:load_abs("$PATH/user_default").</pre>
+
<p><c>$PATH</c> is the directory where your
<c>user_default</c> module can be found.</p>
</section>