← Back to branch summary

~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/kernel/doc/src/erl_boot_server.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (3.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090215164252-q5x4rcf8a5pbesb1
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/kernel/doc/src/erl_boot_server.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1996</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>erl_boot_server</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <date></date>
 
30
    <rev></rev>
 
31
  </header>
 
32
  <module>erl_boot_server</module>
 
33
  <modulesummary>Boot Server for Other Erlang Machines</modulesummary>
 
34
  <description>
 
35
    <p>This server is used to assist diskless Erlang nodes which fetch
 
36
      all Erlang code from another machine.</p>
 
37
    <p>This server is used to fetch all code, including the start
 
38
      script, if an Erlang runtime system is started with
 
39
      the <c>-loader inet</c> command line flag. All hosts specified
 
40
      with the <c>-hosts Host</c> command line flag must have one
 
41
      instance of this server running.</p>
 
42
    <p>This server can be started with the <c>kernel</c> configuration
 
43
      parameter <c>start_boot_server</c>.</p>
 
44
    <p>The <c>erl_boot_server</c> can both read regular files as well as
 
45
      files in archives. See <seealso marker="code">code(3)</seealso>
 
46
      and <seealso marker="erl_prim_loader">erl_prim_loader(3)</seealso>.</p>
 
47
    <warning><p>The support for loading of code from archive files is
 
48
     experimental. The sole purpose of releasing it before it is ready
 
49
     is to obtain early feedback. The file format, semantics,
 
50
     interfaces etc. may be changed in a future release.</p></warning>
 
51
  </description>
 
52
  <funcs>
 
53
    <func>
 
54
      <name>start(Slaves) -> {ok, Pid} | {error, What}</name>
 
55
      <fsummary>Start the boot server</fsummary>
 
56
      <type>
 
57
        <v>Slaves = [Host]</v>
 
58
        <v>Host = atom()</v>
 
59
        <v>Pid = pid()</v>
 
60
        <v>What = term()</v>
 
61
      </type>
 
62
      <desc>
 
63
        <p>Starts the boot server. <c>Slaves</c> is a list of IP
 
64
          addresses for hosts which are allowed to use this server as a
 
65
          boot server.</p>
 
66
      </desc>
 
67
    </func>
 
68
    <func>
 
69
      <name>start_link(Slaves) -> {ok, Pid} | {error, What}</name>
 
70
      <fsummary>Start the boot server and links the caller</fsummary>
 
71
      <type>
 
72
        <v>Slaves = [Host]</v>
 
73
        <v>Host = atom()</v>
 
74
        <v>Pid = pid()</v>
 
75
        <v>What = term()()</v>
 
76
      </type>
 
77
      <desc>
 
78
        <p>Starts the boot server and links to the caller. This function
 
79
          is used to start the server if it is included in a supervision
 
80
          tree.</p>
 
81
      </desc>
 
82
    </func>
 
83
    <func>
 
84
      <name>add_slave(Slave) -> ok | {error, What}</name>
 
85
      <fsummary>Add a slave to the list of allowed slaves</fsummary>
 
86
      <type>
 
87
        <v>Slave = Host</v>
 
88
        <v>Host = atom()</v>
 
89
        <v>What = term()</v>
 
90
      </type>
 
91
      <desc>
 
92
        <p>Adds a <c>Slave</c> node to the list of allowed slave hosts.</p>
 
93
      </desc>
 
94
    </func>
 
95
    <func>
 
96
      <name>delete_slave(Slave) -> ok | {error, What}</name>
 
97
      <fsummary>Delete a slave from the list of allowed slaves</fsummary>
 
98
      <type>
 
99
        <v>Slave = Host</v>
 
100
        <v>Host = atom()</v>
 
101
        <v>What = void()</v>
 
102
      </type>
 
103
      <desc>
 
104
        <p>Deletes a <c>Slave</c> node from the list of allowed slave
 
105
          hosts.</p>
 
106
      </desc>
 
107
    </func>
 
108
    <func>
 
109
      <name>which_slaves() -> Slaves</name>
 
110
      <fsummary>Return the current list of allowed slave hosts</fsummary>
 
111
      <type>
 
112
        <v>Slaves = [Host]</v>
 
113
        <v>Host = atom()</v>
 
114
      </type>
 
115
      <desc>
 
116
        <p>Returns the current list of allowed slave hosts.</p>
 
117
      </desc>
 
118
    </func>
 
119
  </funcs>
 
120
 
 
121
  <section>
 
122
    <title>SEE ALSO</title>
 
123
    <p><seealso marker="init">init(3)</seealso>,  
 
124
      <seealso marker="erl_prim_loader">erl_prim_loader(3)</seealso></p>
 
125
  </section>
 
126
</erlref>
 
127
 
 
128