1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE comref SYSTEM "comref.dtd">
<comref>
<header>
<copyright>
<year>1998</year><year>2016</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
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
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</legalnotice>
<title>start_erl</title>
<prepared>Patrik Nyblom</prepared>
<responsible></responsible>
<docno></docno>
<approved></approved>
<checked></checked>
<date>98-08-05</date>
<rev></rev>
<file>start_erl.xml</file>
</header>
<com>start_erl</com>
<comsummary>Start Erlang for embedded systems on Windows NT®</comsummary>
<description>
<p>This describes the <c><![CDATA[start_erl]]></c> program specific to Windows
NT. Although there exists programs with the same name on other
platforms, their functionality is not the same.</p>
<p>The <c><![CDATA[start_erl]]></c> program is distributed both in compiled
form (under <Erlang root>\\erts-<version>\\bin) and
in source form (under <Erlang
root>\\erts-<version>\\src).
The purpose of the source code is to make it possible to easily
customize the program for local needs, such as cyclic restart
detection etc. There is also a "make"-file, written for the
<c><![CDATA[nmake]]></c> program distributed with Microsoft® Visual
C++®. The program can however be compiled with
any Win32 C compiler (possibly with slight modifications).</p>
<p>The purpose of the program is to aid release handling on
Windows NT®. The program should be called by the
<c><![CDATA[erlsrv]]></c> program, read up the release data file
start_erl.data and start Erlang. Certain options to start_erl
are added and removed by the release handler during upgrade with
emulator restart (more specifically the <c><![CDATA[-data]]></c> option).</p>
</description>
<funcs>
<func>
<name>start_erl [<erl options>] ++ [<start_erl options>]</name>
<fsummary>Start the Erlang emulator with the correct release data</fsummary>
<desc>
<p>The <c><![CDATA[start_erl]]></c> program in its original form
recognizes the following options:</p>
<taglist>
<tag>++</tag>
<item>Mandatory, delimits start_erl options from normal Erlang
options. Everything on the command line <em>before</em> the
<c><![CDATA[++]]></c> is interpreted as options to be sent to the
<c><![CDATA[erl]]></c> program. Everything <em>after</em><c><![CDATA[++]]></c> is
interpreted as options to <c><![CDATA[start_erl]]></c> itself.</item>
<tag>-reldir <release root></tag>
<item>Mandatory if the environment variable
<c><![CDATA[RELDIR]]></c> is not specified and no
<c>-rootdir</c> option is given. Tells start_erl where the
root of the release tree is placed in the file-system (typically
<Erlang root>\\releases). The
<c><![CDATA[start_erl.data]]></c> file is expected to be
placed in this directory (if not otherwise specified). If
only the <c>-rootdir</c> option is given, the directory is
assumed to be <Erlang root>\\releases.</item>
<tag>-rootdir <Erlang root directory></tag>
<item>Mandatory if <c>-reldir</c> is not given and there is
no <c><![CDATA[RELDIR]]></c> in the environment. This
specifies the Erlang installation root directory (under
which the <c>lib</c>, <c>releases</c> and
<c>erts-<Version></c> directories are placed). If only
<c>-reldir</c> (or the environment variable
<c><![CDATA[RELDIR]]></c>) is given, the Erlang root is assumed to
be the directory exactly one level above the release
directory.</item>
<tag>-data <data file name></tag>
<item>Optional, specifies another data file than start_erl.data
in the <release root>. It is specified relative to the
<release root> or absolute (including drive letter
etc.). This option is used by the release handler during
upgrade and should not be used during normal
operation. The release data file should not normally be
named differently.</item>
<tag>-bootflags <boot flags file name></tag>
<item>Optional, specifies a file name relative to actual release
directory (that is the subdirectory of <release
root> where the <c><![CDATA[.boot]]></c> file etc. are placed).
The contents of this file is appended to the command line
when Erlang is started. This makes it easy to start the
emulator with different options for different releases.</item>
</taglist>
</desc>
</func>
</funcs>
<section>
<title>NOTES</title>
<p>As the source code is distributed, it can easily be modified to
accept other options. The program must still accept the
<c><![CDATA[-data]]></c> option with the semantics described above for the
release handler to work correctly.</p>
<p>The Erlang emulator is found by examining the registry keys for
the emulator version specified in the release data file. The new
emulator needs to be properly installed before the upgrade for
this to work.</p>
<p>Although the program is located together with files specific to
emulator version, it is not expected to be specific to the
emulator version. The release handler does <em>not</em> change the
<c><![CDATA[-machine]]></c> option to <c><![CDATA[erlsrv]]></c> during emulator restart.
Place the (possibly customized) <c><![CDATA[start_erl]]></c> program so that
it is not overwritten during upgrade. </p>
<p>The <c><![CDATA[erlsrv]]></c> program's default options are not
sufficient for release handling. The machine <c><![CDATA[erlsrv]]></c>
starts should be specified as the <c><![CDATA[start_erl]]></c> program and
the arguments should contain the <c><![CDATA[++]]></c> followed by desired
options.</p>
</section>
<section>
<title>SEE ALSO</title>
<p>erlsrv(1), release_handler(3)</p>
</section>
</comref>
|
