aboutsummaryrefslogtreecommitdiffstats
path: root/lib/erl_interface/doc/src/erl_call.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/erl_interface/doc/src/erl_call.xml')
-rw-r--r--lib/erl_interface/doc/src/erl_call.xml76
1 files changed, 38 insertions, 38 deletions
diff --git a/lib/erl_interface/doc/src/erl_call.xml b/lib/erl_interface/doc/src/erl_call.xml
index 706dd271cc..f1e52b1889 100644
--- a/lib/erl_interface/doc/src/erl_call.xml
+++ b/lib/erl_interface/doc/src/erl_call.xml
@@ -35,9 +35,9 @@
<com>erl_call</com>
<comsummary>Call/start a distributed Erlang node.</comsummary>
<description>
- <p><c><![CDATA[erl_call]]></c> makes it possible to start and/or
+ <p><c>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.
+ <c>Erl_Interface</c> library as an example application.
Its purpose is to use a 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
@@ -45,14 +45,14 @@
<p>The main use is to either start a distributed Erlang node
or to make an ordinary function call. However, it is also
- possible to pipe an Erlang module to <c><![CDATA[erl_call]]></c> and have
+ possible to pipe an Erlang module to <c>erl_call</c> and have
it 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
+ <p>Options, which cause <c>stdin</c> to be read, can be used
with 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>
+ of <c>erl_call</c> could be from (HTTP) CGI-bin scripts.</p>
</description>
<funcs>
@@ -67,65 +67,65 @@
<tag><c>-a [Mod [Fun [Args]]]]</c></tag>
<item>
<p>(<em>Optional.</em>) Applies the specified function
- and returns the result. <c><![CDATA[Mod]]></c> must be specified.
+ and returns the result. <c>Mod</c> must be specified.
However, <c>start</c> and <c>[]</c> are assumed for unspecified
- <c><![CDATA[Fun]]></c> and <c><![CDATA[Args]]></c>, respectively.
- <c><![CDATA[Args]]></c> is to be in the same format as for
+ <c>Fun</c> and <c>Args</c>, respectively.
+ <c>Args</c> is to be in the same format as for
<seealso marker="erts:erlang#apply/3">
<c>erlang:apply/3</c></seealso> in <c>ERTS</c>.</p>
<p>Notice that this flag takes exactly one argument, so quoting
- can be necessary to group <c><![CDATA[Mod]]></c>,
- <c><![CDATA[Fun]]></c>, and <c><![CDATA[Args]]></c> in a manner
+ can be necessary to group <c>Mod</c>,
+ <c>Fun</c>, and <c>Args</c> in a manner
dependent on the behavior of your command shell.</p>
</item>
<tag><c>-c Cookie</c></tag>
<item>
<p>(<em>Optional.</em>) Use this option to specify a certain cookie.
- If no cookie is specified, the <c><![CDATA[~/.erlang.cookie]]></c>
+ If no cookie is specified, the <c>~/.erlang.cookie</c>
file is read and its content is used as cookie. The Erlang node
we want to communicate with must have the same cookie.</p>
</item>
<tag><c>-d</c></tag>
<item>
<p>(<em>Optional.</em>) Debug mode. This causes all I/O to be output
- to the <c><![CDATA[~/.erl_call.out.Nodename]]></c> file, where
- <c><![CDATA[Nodename]]></c>
+ to the <c>~/.erl_call.out.Nodename</c> file, where
+ <c>Nodename</c>
is the node name of the Erlang node in question.</p>
</item>
<tag><c>-e</c></tag>
<item>
<p>(<em>Optional.</em>) Reads a sequence of Erlang expressions,
separated by comma (,) and ended with a full stop (.), from
- <c><![CDATA[stdin]]></c> until EOF (Control-D). Evaluates the
+ <c>stdin</c> until EOF (Control-D). Evaluates the
expressions and returns the result from the last expression.
- Returns <c><![CDATA[{ok,Result}]]></c> on success.</p>
+ Returns <c>{ok,Result}</c> on success.</p>
</item>
<tag><c>-h HiddenName</c></tag>
<item>
<p>(<em>Optional.</em>) Specifies the name of the hidden node
- that <c><![CDATA[erl_call]]></c> represents.</p>
+ that <c>erl_call</c> represents.</p>
</item>
<tag><c>-m</c></tag>
<item>
<p>(<em>Optional.</em>) Reads an Erlang module from
- <c><![CDATA[stdin]]></c> and compiles it.</p>
+ <c>stdin</c> and compiles it.</p>
</item>
<tag><c>-n Node</c></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
+ <p>(One of <c>-n, -name, -sname</c> is required.)
+ Has the same meaning as <c>-name</c> and can still be
used for backward compatibility reasons.</p>
</item>
<tag><c>-name Node</c></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
+ <p>(One of <c>-n, -name, -sname</c> is required.)
+ <c>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
+ <c>Node</c> is started with
+ <c>erl -name</c>, which means that fully
qualified long node names are used. If option
- <c><![CDATA[-s]]></c> is specified, an Erlang node will (if
- necessary) be started with <c><![CDATA[erl -name]]></c>.</p>
+ <c>-s</c> is specified, an Erlang node will (if
+ necessary) be started with <c>erl -name</c>.</p>
</item>
<tag><c>-q</c></tag>
<item>
@@ -135,13 +135,13 @@
<tag><c>-r</c></tag>
<item>
<p>(<em>Optional.</em>) Generates a random name of the hidden node
- that <c><![CDATA[erl_call]]></c> represents.</p>
+ that <c>erl_call</c> represents.</p>
</item>
<tag><c>-s</c></tag>
<item>
<p>(<em>Optional.</em>) Starts a distributed Erlang node if
necessary. This means that in a sequence of calls, where
- '<c><![CDATA[-s]]></c>' and '<c><![CDATA[-n Node]]></c>' are
+ '<c>-s</c>' and '<c>-n Node</c>' are
constant, only the first call starts the Erlang node. This makes
the rest of the communication very fast. This flag is currently
only available on Unix-like platforms (Linux, Mac OS X, Solaris,
@@ -149,25 +149,25 @@
</item>
<tag><c>-sname Node</c></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 -sname]]></c>, which means that
- short node names are used. If option <c><![CDATA[-s]]></c> is
+ <p>(One of <c>-n, -name, -sname</c> is required.)
+ <c>Node</c> is the name of the node to be started
+ or communicated with. It is assumed that <c>Node</c>
+ is started with <c>erl -sname</c>, which means that
+ short node names are used. If option <c>-s</c> is
specified, an Erlang node is started (if necessary) with
- <c><![CDATA[erl -sname]]></c>.</p>
+ <c>erl -sname</c>.</p>
</item>
<tag><c>-v</c></tag>
<item>
- <p>(<em>Optional.</em>) Prints a lot of <c><![CDATA[verbose]]></c>
+ <p>(<em>Optional.</em>) Prints a lot of <c>verbose</c>
information. This is only useful for the developer and maintainer
- of <c><![CDATA[erl_call]]></c>.</p>
+ of <c>erl_call</c>.</p>
</item>
<tag><c>-x ErlScript</c></tag>
<item>
<p>(<em>Optional.</em>) Specifies another name of the Erlang
startup script to be used. If not specified, the standard
- <c><![CDATA[erl]]></c> startup script is used.</p>
+ <c>erl</c> startup script is used.</p>
</item>
</taglist>
</desc>
@@ -176,7 +176,7 @@
<section>
<title>Examples</title>
- <p>To start an Erlang node and call <c><![CDATA[erlang:time/0]]></c>:</p>
+ <p>To start an Erlang node and call <c>erlang:time/0</c>:</p>
<code type="none"><![CDATA[
erl_call -s -a 'erlang time' -n madonna
@@ -184,7 +184,7 @@ erl_call -s -a 'erlang time' -n madonna
]]></code>
<p>To terminate an Erlang node by calling
- <c><![CDATA[erlang:halt/0]]></c>:</p>
+ <c>erlang:halt/0</c>:</p>
<code type="none"><![CDATA[
erl_call -s -a 'erlang halt' -n madonna