summaryrefslogtreecommitdiff
path: root/lib/reltool/doc/src/reltool_escript.xml
blob: 507f5ef1254fb9d170deeb31194359098f424cb4 (plain)
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
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE comref SYSTEM "comref.dtd">

<comref>
  <header>
    <copyright>
      <year>2013</year>
      <year>2013</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.

    </legalnotice>

    <title>erl</title>
    <prepared></prepared>
    <docno></docno>
    <date></date>
    <rev></rev>
    <file>reltool_escript.xml</file>
  </header>
  <com>reltool</com>
  <comsummary>Erlang/OTP release management tool</comsummary>
  <description>
    <p><em>Reltool</em> is a release management tool. It analyses a
    given Erlang/OTP installation and determines various dependencies
    between its applications. The <c>graphical</c> frontend depicts the
    dependencies and enables interactive customization of a target
    system. The backend provides a <c>batch</c> interface for
    generation of customized target systems.</p>
  </description>
  <funcs>
    <func>
      <name>reltool --gui></name>
      <fsummary>Start GUI</fsummary>
      <desc>
        <p>Starts the graphical user interface. See <em>reltool:start/1</em>.</p>
      </desc>
    </func>
    <func>
      <name>reltool [Config] --get_config [-defaults] [-derived] [File]></name>
      <fsummary>Retrieves actual config</fsummary>
      <desc>
        <p>See <em>reltool:get_config/3</em>.</p>
      </desc>
    </func>
    <func>
      <name>reltool [Config] --get_rel RelName [File]></name>
      <fsummary>Retrieves actual release info</fsummary>
      <desc>
        <p>See <em>reltool:get_rel/2</em>.</p>
      </desc>
    </func>
    <func>
      <name>reltool [Config] --get_script RelName [File]></name>
      <fsummary>Retrieves actual boot script</fsummary>
      <desc>
        <p>See <em>reltool:get_script/2</em>.</p>
      </desc>
    </func>
    <func>
      <name>reltool [Config] --create_target TargetDir></name>
      <fsummary>Generate a target system</fsummary>
      <desc>
        <p>See <em>reltool:create_target/2</em>.</p>
      </desc>
    </func>
    <func>
      <name>reltool [Config] --get_target_spec [SpecFile]</name>
      <fsummary>Retrieve spec of target system</fsummary>
      <desc>
        <p>See <em>reltool:get_target_spec/1</em>.</p>
      </desc>
    </func>
    <func>
      <name>reltool --eval_target_spec Spec RootDir TargetDir</name>
      <fsummary>Generate target system from spec</fsummary>
      <desc>
        <p>See <em>reltool:eval_target_spec/3</em>.</p>
      </desc>
    </func>
  </funcs>

   <section>
    <title>SEE ALSO</title>
    <p><seealso marker="reltool">reltool(3)</seealso></p>
  </section>
</comref>