aboutsummaryrefslogtreecommitdiffstats
path: root/lib/erl_interface/doc/src/erl_call.xml
diff options
context:
space:
mode:
authorBjörn-Egil Dahlberg <[email protected]>2016-10-17 15:07:55 +0200
committerBjörn-Egil Dahlberg <[email protected]>2016-10-20 14:09:26 +0200
commit9f5b69e8def226f1d1ce9262477d5bbd1cbc1fe7 (patch)
tree6e40fddeea6a39ab6214fe17e1e457bca275efaa /lib/erl_interface/doc/src/erl_call.xml
parent8cddd5600870c64f27f555144804a1ff4104f7e6 (diff)
downloadotp-9f5b69e8def226f1d1ce9262477d5bbd1cbc1fe7.tar.gz
otp-9f5b69e8def226f1d1ce9262477d5bbd1cbc1fe7.tar.bz2
otp-9f5b69e8def226f1d1ce9262477d5bbd1cbc1fe7.zip
erl_interface: Refactor documentation
Diffstat (limited to 'lib/erl_interface/doc/src/erl_call.xml')
-rw-r--r--lib/erl_interface/doc/src/erl_call.xml35
1 files changed, 17 insertions, 18 deletions
diff --git a/lib/erl_interface/doc/src/erl_call.xml b/lib/erl_interface/doc/src/erl_call.xml
index 46015621ac..f8fe409560 100644
--- a/lib/erl_interface/doc/src/erl_call.xml
+++ b/lib/erl_interface/doc/src/erl_call.xml
@@ -11,7 +11,7 @@
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -30,14 +30,14 @@
<checked>Torbj&ouml;rn T&ouml;rnkvist</checked>
<date>97-05-16</date>
<rev>B</rev>
- <file>erl_call.sgml</file>
+ <file>erl_call.xml</file>
</header>
<com>erl_call</com>
- <comsummary>Call/Start a Distributed Erlang Node</comsummary>
+ <comsummary>Call/start a distributed Erlang node.</comsummary>
<description>
- <p><c><![CDATA[erl_call]]></c> makes it possible to start and/or communicate with
- a distributed Erlang node. It is built upon the <c><![CDATA[erl_interface]]></c>
- library as an example application. Its purpose is to use an Unix shell script to interact with a distributed Erlang node. It performs all
+ <p><c><![CDATA[erl_call]]></c> makes it possible to start and/or communicate with
+ a distributed Erlang node. It is built upon the <c><![CDATA[erl_interface]]></c>
+ library as an example application. Its purpose is to use an Unix shell script to interact with a distributed Erlang node. It performs all
communication with the Erlang <em>rex server</em>, using the standard Erlang RPC facility. It does not require any special
software to be run at the Erlang target node.</p>
<p>The main use is to either start a distributed Erlang node
@@ -46,17 +46,17 @@
compiled, or to pipe a sequence of Erlang expressions to be evaluated
(similar to the Erlang shell).</p>
<p>Options, which cause <c><![CDATA[stdin]]></c> to be read, can be used with
- advantage
- as scripts from within (Unix) shell scripts. Another
+ advantage
+ as scripts from within (Unix) shell scripts. Another
nice use of <c><![CDATA[erl_call]]></c> could be from (http) CGI-bin scripts.</p>
</description>
<funcs>
<func>
<name>erl_call &lt;options></name>
- <fsummary>Start/Call Erlang</fsummary>
+ <fsummary>Start/call Erlang.</fsummary>
<desc>
<p>Each option flag is described below with its name, type and
- meaning. </p>
+ meaning.</p>
<taglist>
<tag>-a [Mod [Fun [Args]]]]</tag>
<item>
@@ -85,7 +85,7 @@
<item>
<p>(<em>optional</em>): Reads a sequence of Erlang expressions, separated
by '<em>,</em>' and ended with a '<em>.</em>', from <c><![CDATA[stdin]]></c> until
- EOF (Control-D). Evaluates the expressions and returns the result from
+ EOF (Control-D). Evaluates the expressions and returns the result from
the last expression. Returns <c><![CDATA[{ok,Result}]]></c> if successful.</p>
<p></p>
</item>
@@ -103,18 +103,18 @@
</item>
<tag>-n Node</tag>
<item>
- <p>(one of <c><![CDATA[-n, -name, -sname]]></c> is required):
- Has the same meaning as <c><![CDATA[-name]]></c> and can still be used for
+ <p>(one of <c><![CDATA[-n, -name, -sname]]></c> is required):
+ Has the same meaning as <c><![CDATA[-name]]></c> and can still be used for
backwards compatibility reasons.</p>
<p></p>
</item>
<tag>-name Node</tag>
<item>
<p>(one of <c><![CDATA[-n, -name, -sname]]></c> is required): <c><![CDATA[Node]]></c> is the name of the node to be
- started or communicated with. It is assumed that
- <c><![CDATA[Node]]></c> is started with <c><![CDATA[erl -name]]></c>, which means that fully
- qualified long node names are used.
- If the <c><![CDATA[-s]]></c> option is given, an Erlang node will (if necessary)
+ started or communicated with. It is assumed that
+ <c><![CDATA[Node]]></c> is started with <c><![CDATA[erl -name]]></c>, which means that fully
+ qualified long node names are used.
+ If the <c><![CDATA[-s]]></c> option is given, an Erlang node will (if necessary)
be started with <c><![CDATA[erl -name]]></c>.</p>
<p></p>
</item>
@@ -238,4 +238,3 @@ start() ->
]]></code>
</section>
</comref>
-