← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lib/sasl/doc/src/sasl_app.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/sasl/doc/src/sasl_app.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE appref SYSTEM "appref.dtd">
 
3
 
 
4
<appref>
 
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>sasl</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <date></date>
 
30
    <rev></rev>
 
31
  </header>
 
32
  <app>sasl</app>
 
33
  <appsummary>The SASL Application</appsummary>
 
34
  <description>
 
35
    <p>This section describes the SASL (System Architecture Support Libraries)
 
36
      application which provides the following services:</p>
 
37
    <list type="bulleted">
 
38
      <item><c>alarm_handler</c></item>
 
39
      <item><c>overload</c></item>
 
40
      <item><c>rb</c></item>
 
41
      <item><c>release_handler</c></item>
 
42
      <item><c>systools</c></item>
 
43
    </list>
 
44
    <p>The SASL application also includes <c>error_logger</c> event
 
45
      handlers for formatting SASL error and crash reports.</p>
 
46
 
 
47
    <note>
 
48
       <p>The SASL application in OTP has nothing to do with
 
49
          "Simple Authentication and Security Layer" (RFC 4422).</p>
 
50
    </note>
 
51
 
 
52
  </description>
 
53
 
 
54
  <section>
 
55
    <title>Error Logger Event Handlers</title>
 
56
    <p>The following error logger event handlers are defined in
 
57
      the SASL application.</p>
 
58
    <taglist>
 
59
      <tag><c>sasl_report_tty_h</c></tag>
 
60
      <item>
 
61
        <p>Formats and writes <em>supervisor reports</em>, <em>crash reports</em> and <em>progress reports</em> to <c>stdio</c>.</p>
 
62
      </item>
 
63
      <tag><c>sasl_report_file_h</c></tag>
 
64
      <item>
 
65
        <p>Formats and writes <em>supervisor reports</em>, <em>crash report</em> and <em>progress report</em> to a single file.</p>
 
66
      </item>
 
67
      <tag><c>error_logger_mf_h</c></tag>
 
68
      <item>
 
69
        <p>This error logger writes <em>all</em> events sent to
 
70
          the error logger to disk. It installs the <c>log_mf_h</c>
 
71
          event handler in the <c>error_logger</c> process.</p>
 
72
      </item>
 
73
    </taglist>
 
74
  </section>
 
75
 
 
76
  <section>
 
77
    <title>Configuration</title>
 
78
    <p>The following configuration parameters are defined for the SASL
 
79
      application. See <c>app(4)</c> for more information about
 
80
      configuration parameters:</p>
 
81
    <taglist>
 
82
      <tag><c><![CDATA[sasl_error_logger = Value <optional>]]></c></tag>
 
83
      <item>
 
84
        <p><c>Value</c> is one of:</p>
 
85
        <taglist>
 
86
          <tag><c>tty</c></tag>
 
87
          <item>Installs <c>sasl_report_tty_h</c> in the error logger.
 
88
           This is the default option.</item>
 
89
          <tag><c>{file,FileName}</c></tag>
 
90
          <item>Installs <c>sasl_report_file_h</c> in the error logger.
 
91
           This makes all reports go to the file <c>FileName</c>.
 
92
          <c>FileName</c> is a string.</item>
 
93
          <tag><c>false</c></tag>
 
94
          <item>
 
95
            <p>No SASL error logger handler is installed.</p>
 
96
          </item>
 
97
        </taglist>
 
98
      </item>
 
99
      <tag><c><![CDATA[errlog_type = error | progress | all <optional>]]></c></tag>
 
100
      <item>
 
101
        <p>Restricts the error logging performed by the specified
 
102
          <c>sasl_error_logger</c> to error reports, progress reports,
 
103
          or both. Default is <c>all</c>.</p>
 
104
      </item>
 
105
      <tag><c><![CDATA[error_logger_mf_dir = string() | false<optional>]]></c></tag>
 
106
      <item>
 
107
        <p>Specifies in which directory the files are stored. If this
 
108
          parameter is undefined or <c>false</c>,
 
109
          the <c>error_logger_mf_h</c> is not installed.</p>
 
110
      </item>
 
111
      <tag><c><![CDATA[error_logger_mf_maxbytes = integer() <optional>]]></c></tag>
 
112
      <item>
 
113
        <p>Specifies how large each individual file can be. If this
 
114
          parameter is undefined, the <c>error_logger_mf_h</c> is not
 
115
          installed.</p>
 
116
      </item>
 
117
      <tag><c><![CDATA[error_logger_mf_maxfiles = 0<integer()<256 <optional>]]></c></tag>
 
118
      <item>
 
119
        <p>Specifies how many files are used. If this parameter is
 
120
          undefined, the <c>error_logger_mf_h</c> is not installed.</p>
 
121
      </item>
 
122
      <tag><c><![CDATA[overload_max_intensity = float() > 0 <optional>]]></c></tag>
 
123
      <item>
 
124
        <p>Specifies the maximum intensity for <c>overload</c>. Default
 
125
          is <c>0.8</c>.</p>
 
126
      </item>
 
127
      <tag><c><![CDATA[overload_weight = float() > 0 <optional>]]></c></tag>
 
128
      <item>
 
129
        <p>Specifies the <c>overload</c> weight. Default is <c>0.1</c>.</p>
 
130
      </item>
 
131
      <tag><c><![CDATA[start_prg = string() <optional>]]></c></tag>
 
132
      <item>
 
133
        <p>Specifies which program should be used when restarting
 
134
          the system. Default is <c>$OTP_ROOT/bin/start</c>.</p>
 
135
      </item>
 
136
      <tag><c><![CDATA[masters = [atom()] <optional>]]></c></tag>
 
137
      <item>
 
138
        <p>Specifies which nodes this node uses to read/write release
 
139
          information. This parameter is ignored if
 
140
          the <c>client_directory</c> parameter is not set.</p>
 
141
      </item>
 
142
      <tag><c><![CDATA[client_directory = string() <optional>]]></c></tag>
 
143
      <item>
 
144
        <p>This parameter specifies the client directory at the master
 
145
          nodes. Refer to Release Handling in <em>OTP Design Principles</em> for more information.  This parameter is
 
146
          ignored if the <c>masters</c> parameter is not set.</p>
 
147
      </item>
 
148
      <tag><c><![CDATA[static_emulator = true | false <optional>]]></c></tag>
 
149
      <item>
 
150
        <p>Indicates if the Erlang emulator is statically installed. A
 
151
          node with a static emulator cannot switch dynamically to a
 
152
          new emulator as the executable files are written into memory
 
153
          statically.  This parameter is ignored if the <c>masters</c>
 
154
          and <c>client_directory</c> parameters are not set.</p>
 
155
      </item>
 
156
      <tag><c><![CDATA[releases_dir = string() <optional>]]></c></tag>
 
157
      <item>
 
158
        <p>Indicates where the <c>releases</c> directory is located.
 
159
          The release handler writes all its files to this directory.
 
160
          If this parameter is not set, the OS environment parameter
 
161
          <c>RELDIR</c> is used. By default, this is
 
162
          <c>$OTP_ROOT/releases</c>.</p>
 
163
      </item>
 
164
      <tag><c><![CDATA[utc_log = true | false <optional>]]></c></tag>
 
165
      <item>
 
166
        <p>If set to <c>true</c>, all dates in textual log outputs are
 
167
          displayed in Universal Coordinated Time with the string
 
168
          <c>UTC</c> appended.</p>
 
169
      </item>
 
170
    </taglist>
 
171
  </section>
 
172
 
 
173
  <section>
 
174
    <title>See Also</title>
 
175
    <p><seealso marker="alarm_handler">alarm_handler(3)</seealso>,
 
176
      error_logger(3),
 
177
      log_mf_h(3),
 
178
      <seealso marker="overload">overload(3)</seealso>,
 
179
      <seealso marker="rb">rb(3)</seealso>,
 
180
      <seealso marker="release_handler">release_handler(3)</seealso>,
 
181
      <seealso marker="systools">systools(3)</seealso></p>
 
182
  </section>
 
183
</appref>
 
184