← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lib/sasl/doc/src/rel.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:
lib/sasl/doc/src/rel.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE fileref SYSTEM "fileref.dtd">
 
3
 
 
4
<fileref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1997</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>rel</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <date></date>
 
30
    <rev></rev>
 
31
  </header>
 
32
  <file>rel</file>
 
33
  <filesummary>Release resource file</filesummary>
 
34
  <description>
 
35
    <p>The <em>release resource file</em> specifies which applications are
 
36
      are included in a release (system) based on Erlang/OTP.</p>
 
37
    <p>This file is used by the functions in <c>systools</c> when generating
 
38
      start scripts (<c>.script</c>, <c>.boot</c>) and release upgrade
 
39
      files (<c>relup</c>).</p>
 
40
  </description>
 
41
 
 
42
  <section>
 
43
    <title>FILE SYNTAX</title>
 
44
    <p>The release resource file should be called <c>Name.rel</c>.</p>
 
45
    <p>The <c>.rel</c> file contains one single Erlang term, which is
 
46
      called a <em>release specification</em>.  The file has the
 
47
      following syntax:</p>
 
48
    <code type="none">
 
49
{release, {RelName,Vsn}, {erts, EVsn},
 
50
  [{Application, AppVsn} |
 
51
   {Application, AppVsn, Type} |
 
52
   {Application, AppVsn, IncApps} |
 
53
   {Application, AppVsn, Type, IncApps}]}.
 
54
    </code>
 
55
    <list type="bulleted">
 
56
      <item>
 
57
        <p><c>RelName = string()</c> is the name of the release.</p>
 
58
      </item>
 
59
      <item>
 
60
        <p><c>Vsn = string()</c> is the version of the release.</p>
 
61
      </item>
 
62
      <item>
 
63
        <p><c>EVsn = string()</c> is the version of ERTS the release is
 
64
          intended for.</p>
 
65
      </item>
 
66
      <item>
 
67
        <p><c>Application = atom()</c> is the name of an application
 
68
          included in the release.</p>
 
69
      </item>
 
70
      <item>
 
71
        <p><c>AppVsn = string()</c> is the version of an application
 
72
          included in the release.</p>
 
73
      </item>
 
74
      <item>
 
75
        <p><c>Type = permanent | transient | temporary | load | none</c>
 
76
          is the start type of an application included in the release.</p>
 
77
        <p>If <c>Type = permanent | transient | temporary</c>,
 
78
          the application will be loaded and started in the corresponding
 
79
          way, see <c>application(3)</c>. If <c>Type = load</c>,
 
80
          the application will only be loaded. If <c>Type = none</c>,
 
81
          the application will be neither loaded nor started, although
 
82
          the code for its modules will be loaded.
 
83
          Defaults to <c>permanent</c></p>
 
84
      </item>
 
85
      <item>
 
86
        <p><c>IncApps = [atom()]</c> is a list of applications that are
 
87
          included by an application included in the release.</p>
 
88
        <p>The list must be a subset of the included applications
 
89
          specified in the application resource file
 
90
          (<c>Application.app</c>) and overrides this value. Defaults
 
91
          to the empty list.</p>
 
92
      </item>
 
93
    </list>
 
94
    <note>
 
95
      <p>The list of applications must contain the <c>kernel</c> and
 
96
        <c>stdlib</c> applications.</p>
 
97
    </note>
 
98
  </section>
 
99
 
 
100
  <section>
 
101
    <title>SEE ALSO</title>
 
102
    <p>application(3), relup(4), systools(3)</p>
 
103
  </section>
 
104
</fileref>
 
105