← Back to branch summary

~ubuntu-branches/debian/squeeze/erlang/squeeze

« back to all changes in this revision

Viewing changes to erts/doc/src/start_erl.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20090215164252-dxpjjuq108nz4noa
Tags: 1:12.b.5-dfsg-2
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

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