From 5f5fb466630db9dc8e17895c90ed74105852e827 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Fri, 21 Oct 2016 15:44:49 +0200 Subject: erl_interface: Remove CDATA tag except for example code --- lib/erl_interface/doc/src/erl_call.xml | 76 +++++++++++++++++----------------- 1 file changed, 38 insertions(+), 38 deletions(-) (limited to 'lib/erl_interface/doc/src/erl_call.xml') 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 @@ erl_call Call/start a distributed Erlang node. -

makes it possible to start and/or +

erl_call makes it possible to start and/or communicate with a distributed Erlang node. It is built upon the - library as an example application. + Erl_Interface 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 rex server, using the standard Erlang RPC facility. It does not @@ -45,14 +45,14 @@

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 and have + possible to pipe an Erlang module to erl_call and have it compiled, or to pipe a sequence of Erlang expressions to be evaluated (similar to the Erlang shell).

-

Options, which cause to be read, can be used +

Options, which cause stdin to be read, can be used with advantage, as scripts from within (Unix) shell scripts. Another nice use - of could be from (HTTP) CGI-bin scripts.

+ of erl_call could be from (HTTP) CGI-bin scripts.

 @@ -67,65 +67,65 @@ -a [Mod [Fun [Args]]]]

(Optional.) Applies the specified function - and returns the result. must be specified. + and returns the result. Mod must be specified. However, start and [] are assumed for unspecified - and , respectively. - is to be in the same format as for + Fun and Args, respectively. + Args is to be in the same format as for erlang:apply/3 in ERTS.

Notice that this flag takes exactly one argument, so quoting - can be necessary to group , - , and in a manner + can be necessary to group Mod, + Fun, and Args in a manner dependent on the behavior of your command shell.

 -c Cookie

(Optional.) Use this option to specify a certain cookie. - If no cookie is specified, the + If no cookie is specified, the ~/.erlang.cookie file is read and its content is used as cookie. The Erlang node we want to communicate with must have the same cookie.

 -d

(Optional.) Debug mode. This causes all I/O to be output - to the file, where - + to the ~/.erl_call.out.Nodename file, where + Nodename is the node name of the Erlang node in question.

 -e

(Optional.) Reads a sequence of Erlang expressions, separated by comma (,) and ended with a full stop (.), from - until EOF (Control-D). Evaluates the + stdin until EOF (Control-D). Evaluates the expressions and returns the result from the last expression. - Returns on success.

+ Returns {ok,Result} on success.

 -h HiddenName

(Optional.) Specifies the name of the hidden node - that represents.

+ that erl_call represents.

 -m

(Optional.) Reads an Erlang module from - and compiles it.

+ stdin and compiles it.

 -n Node -

(One of is required.) - Has the same meaning as and can still be +

(One of -n, -name, -sname is required.) + Has the same meaning as -name and can still be used for backward compatibility reasons.

 -name Node -

(One of is required.) - is the name of the node to be +

(One of -n, -name, -sname is required.) + Node is the name of the node to be started or communicated with. It is assumed that - is started with - , which means that fully + Node is started with + erl -name, which means that fully qualified long node names are used. If option - is specified, an Erlang node will (if - necessary) be started with .

+ -s is specified, an Erlang node will (if + necessary) be started with erl -name.

 -q @@ -135,13 +135,13 @@ -r

(Optional.) Generates a random name of the hidden node - that represents.

+ that erl_call represents.

 -s

(Optional.) Starts a distributed Erlang node if necessary. This means that in a sequence of calls, where - '' and '' are + '-s' and '-n Node' 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 @@ -sname Node -

(One of is required.) - is the name of the node to be started - or communicated with. It is assumed that - is started with , which means that - short node names are used. If option is +

(One of -n, -name, -sname is required.) + Node is the name of the node to be started + or communicated with. It is assumed that Node + is started with erl -sname, which means that + short node names are used. If option -s is specified, an Erlang node is started (if necessary) with - .

+ erl -sname.

 -v -

(Optional.) Prints a lot of +

(Optional.) Prints a lot of verbose information. This is only useful for the developer and maintainer - of .

+ of erl_call.

 -x ErlScript

(Optional.) Specifies another name of the Erlang startup script to be used. If not specified, the standard - startup script is used.

+ erl startup script is used.

 @@ -176,7 +176,7 @@
Examples -

To start an Erlang node and call :

+

To start an Erlang node and call erlang:time/0:

To terminate an Erlang node by calling - :

+ erlang:halt/0: