aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/stdlib_app.xml
blob: 43bcad9098b568d82197f39d60e1100fe9a83e79 (plain) (blame)
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
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE appref SYSTEM "appref.dtd">

<appref>
  <header>
    <copyright>
      <year>2005</year><year>2013</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>STDLIB</title>
    <prepared></prepared>
    <docno></docno>
    <date></date>
    <rev></rev>
  </header>
  <app>STDLIB</app>
  <appsummary>The STDLIB Application</appsummary>
  <description>
    <p>The STDLIB is mandatory in the sense that the minimal system
      based on Erlang/OTP consists of Kernel and STDLIB. The STDLIB
      application contains no services.</p>
  </description>

  <section>
    <title>Configuration</title>
    <p>The following configuration parameters are defined for the STDLIB
      application. See <c>app(4)</c> for more information about
      configuration parameters.</p>
    <taglist>
      <tag><c>shell_esc = icl | abort</c></tag>
      <item>
        <p>This parameter can be used to alter the behaviour of 
          the Erlang shell when ^G is pressed.</p>
      </item>
      <tag><c>restricted_shell = module()</c></tag>
      <item>
        <p>This parameter can be used to run the Erlang shell
          in restricted mode.</p>
      </item>
      <tag><c>shell_catch_exception = boolean()</c></tag>
      <item>
        <p>This parameter can be used to set the exception handling
	  of the Erlang shell's evaluator process.</p>
      </item>
      <tag><c>shell_history_length = integer() >= 0</c></tag>
      <item>
        <p>This parameter can be used to determine how many 
          commands are saved by the Erlang shell.</p>
      </item>
      <tag><c>shell_prompt_func = {Mod, Func} | default</c></tag>
      <item>
        <p>where</p>
        <list type="bulleted">
          <item><c>Mod = atom()</c></item>
          <item><c>Func = atom()</c></item>
        </list>
        <p>This parameter can be used to set a customized 
          Erlang shell prompt function.</p>
      </item>
      <tag><c>shell_saved_results = integer() >= 0</c></tag>
      <item>
        <p>This parameter can be used to determine how many 
          results are saved by the Erlang shell.</p>
      </item>
      <tag><c>shell_strings = boolean()</c></tag>
      <item>
        <p>This parameter can be used to determine how the Erlang
          shell outputs lists of integers.</p>
      </item>
    </taglist>
  </section>

  <section>
    <title>See Also</title>
    <p><seealso marker="kernel:app">app(4)</seealso>,
      <seealso marker="kernel:application">application(3)</seealso>, 
      <seealso marker="shell">shell(3)</seealso>, </p>
  </section>
</appref>