<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- sasl</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/sasl-2.2.1.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>System Application Support Libraries (SASL)</strong><br><strong>Reference Manual</strong><br><small>Version 2.2.1</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li title="sasl (App)"><a href="sasl_app.html">sasl (App)
</a></li>
<li id="no" title="alarm_handler " expanded="false">alarm_handler<ul>
<li><a href="alarm_handler.html">
Top of manual page
</a></li>
<li title="clear_alarm-1"><a href="alarm_handler.html#clear_alarm-1">clear_alarm/1</a></li>
<li title="get_alarms-0"><a href="alarm_handler.html#get_alarms-0">get_alarms/0</a></li>
<li title="set_alarm-1"><a href="alarm_handler.html#set_alarm-1">set_alarm/1</a></li>
</ul>
</li>
<li id="no" title="overload " expanded="false">overload<ul>
<li><a href="overload.html">
Top of manual page
</a></li>
<li title="request-0"><a href="overload.html#request-0">request/0</a></li>
<li title="get_overload_info-0"><a href="overload.html#get_overload_info-0">get_overload_info/0</a></li>
</ul>
</li>
<li id="no" title="rb " expanded="false">rb<ul>
<li><a href="rb.html">
Top of manual page
</a></li>
<li title="filter-1"><a href="rb.html#filter-1">filter/1</a></li>
<li title="filter-2"><a href="rb.html#filter-2">filter/2</a></li>
<li title="grep-1"><a href="rb.html#grep-1">grep/1</a></li>
<li title="h-0"><a href="rb.html#h-0">h/0</a></li>
<li title="help-0"><a href="rb.html#help-0">help/0</a></li>
<li title="list-0"><a href="rb.html#list-0">list/0</a></li>
<li title="list-1"><a href="rb.html#list-1">list/1</a></li>
<li title="rescan-0"><a href="rb.html#rescan-0">rescan/0</a></li>
<li title="rescan-1"><a href="rb.html#rescan-1">rescan/1</a></li>
<li title="show-0"><a href="rb.html#show-0">show/0</a></li>
<li title="show-1"><a href="rb.html#show-1">show/1</a></li>
<li title="start-0"><a href="rb.html#start-0">start/0</a></li>
<li title="start-1"><a href="rb.html#start-1">start/1</a></li>
<li title="start_log-1"><a href="rb.html#start_log-1">start_log/1</a></li>
<li title="stop-0"><a href="rb.html#stop-0">stop/0</a></li>
<li title="stop_log-0"><a href="rb.html#stop_log-0">stop_log/0</a></li>
</ul>
</li>
<li id="no" title="release_handler " expanded="false">release_handler<ul>
<li><a href="release_handler.html">
Top of manual page
</a></li>
<li title="check_install_release-1"><a href="release_handler.html#check_install_release-1">check_install_release/1</a></li>
<li title="check_install_release-2"><a href="release_handler.html#check_install_release-2">check_install_release/2</a></li>
<li title="create_RELEASES-4"><a href="release_handler.html#create_RELEASES-4">create_RELEASES/4</a></li>
<li title="install_file-2"><a href="release_handler.html#install_file-2">install_file/2</a></li>
<li title="install_release-1"><a href="release_handler.html#install_release-1">install_release/1</a></li>
<li title="install_release-2"><a href="release_handler.html#install_release-2">install_release/2</a></li>
<li title="make_permanent-1"><a href="release_handler.html#make_permanent-1">make_permanent/1</a></li>
<li title="remove_release-1"><a href="release_handler.html#remove_release-1">remove_release/1</a></li>
<li title="reboot_old_release-1"><a href="release_handler.html#reboot_old_release-1">reboot_old_release/1</a></li>
<li title="set_removed-1"><a href="release_handler.html#set_removed-1">set_removed/1</a></li>
<li title="set_unpacked-2"><a href="release_handler.html#set_unpacked-2">set_unpacked/2</a></li>
<li title="unpack_release-1"><a href="release_handler.html#unpack_release-1">unpack_release/1</a></li>
<li title="which_releases-0"><a href="release_handler.html#which_releases-0">which_releases/0</a></li>
<li title="which_releases-1"><a href="release_handler.html#which_releases-1">which_releases/1</a></li>
<li title="upgrade_app-2"><a href="release_handler.html#upgrade_app-2">upgrade_app/2</a></li>
<li title="downgrade_app-2"><a href="release_handler.html#downgrade_app-2">downgrade_app/2</a></li>
<li title="downgrade_app-3"><a href="release_handler.html#downgrade_app-3">downgrade_app/3</a></li>
<li title="upgrade_script-2"><a href="release_handler.html#upgrade_script-2">upgrade_script/2</a></li>
<li title="downgrade_script-3"><a href="release_handler.html#downgrade_script-3">downgrade_script/3</a></li>
<li title="eval_appup_script-4"><a href="release_handler.html#eval_appup_script-4">eval_appup_script/4</a></li>
</ul>
</li>
<li id="no" title="systools " expanded="false">systools<ul>
<li><a href="systools.html">
Top of manual page
</a></li>
<li title="make_relup-3"><a href="systools.html#make_relup-3">make_relup/3</a></li>
<li title="make_relup-4"><a href="systools.html#make_relup-4">make_relup/4</a></li>
<li title="make_script-1"><a href="systools.html#make_script-1">make_script/1</a></li>
<li title="make_script-2"><a href="systools.html#make_script-2">make_script/2</a></li>
<li title="make_tar-1"><a href="systools.html#make_tar-1">make_tar/1</a></li>
<li title="make_tar-2"><a href="systools.html#make_tar-2">make_tar/2</a></li>
<li title="script2boot-1"><a href="systools.html#script2boot-1">script2boot/1</a></li>
</ul>
</li>
<li title="appup"><a href="appup.html">appup</a></li>
<li title="rel"><a href="rel.html">rel</a></li>
<li title="relup"><a href="relup.html">relup</a></li>
<li title="script"><a href="script.html">script</a></li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>sasl</h1></center>
<h3>APPLICATION</h3>
<div class="REFBODY">sasl</div>
<h3>APPLICATION SUMMARY</h3>
<div class="REFBODY">The SASL Application</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>This section describes the SASL (System Architecture Support Libraries)
application which provides the following services:</p>
<ul>
<li><span class="code">alarm_handler</span></li>
<li><span class="code">overload</span></li>
<li><span class="code">rb</span></li>
<li><span class="code">release_handler</span></li>
<li><span class="code">systools</span></li>
</ul>
<p>The SASL application also includes <span class="code">error_logger</span> event
handlers for formatting SASL error and crash reports.</p>
<div class="note">
<div class="label">Note</div>
<div class="content"><p>
<p>The SASL application in OTP has nothing to do with
"Simple Authentication and Security Layer" (RFC 4422).</p>
</p></div>
</div>
</p></div>
<h3><a name="id65408">Error Logger Event Handlers</a></h3>
<div class="REFBODY">
<p>The following error logger event handlers are defined in
the SASL application.</p>
<dl>
<dt><strong><span class="code">sasl_report_tty_h</span></strong></dt>
<dd>
<p>Formats and writes <strong>supervisor reports</strong>, <strong>crash reports</strong> and <strong>progress reports</strong> to <span class="code">stdio</span>.</p>
</dd>
<dt><strong><span class="code">sasl_report_file_h</span></strong></dt>
<dd>
<p>Formats and writes <strong>supervisor reports</strong>, <strong>crash report</strong> and <strong>progress report</strong> to a single file.</p>
</dd>
<dt><strong><span class="code">error_logger_mf_h</span></strong></dt>
<dd>
<p>This error logger writes <strong>all</strong> events sent to
the error logger to disk. It installs the <span class="code">log_mf_h</span>
event handler in the <span class="code">error_logger</span> process.</p>
<p>To activate this event handler, the following three sasl
configuration parameters must be set:
<span class="code">error_logger_mf_dir</span>, <span class="code">error_logger_mf_maxbytes</span>
and <span class="code">error_logger_mf_maxfiles</span>. See below for more
information about the configuration parameters.</p>
</dd>
</dl>
</div>
<h3><a name="id62857">Configuration</a></h3>
<div class="REFBODY">
<p>The following configuration parameters are defined for the SASL
application. See <span class="code">app(4)</span> for more information about
configuration parameters:</p>
<dl>
<dt><strong><span class="code">sasl_error_logger = Value <optional></span></strong></dt>
<dd>
<p><span class="code">Value</span> is one of:</p>
<dl>
<dt><strong><span class="code">tty</span></strong></dt>
<dd>Installs <span class="code">sasl_report_tty_h</span> in the error logger.
This is the default option.</dd>
<dt><strong><span class="code">{file,FileName}</span></strong></dt>
<dd>Installs <span class="code">sasl_report_file_h</span> in the error logger.
This makes all reports go to the file <span class="code">FileName</span>.
<span class="code">FileName</span> is a string.</dd>
<dt><strong><span class="code">false</span></strong></dt>
<dd>
<p>No SASL error logger handler is installed.</p>
</dd>
</dl>
</dd>
<dt><strong><span class="code">errlog_type = error | progress | all <optional></span></strong></dt>
<dd>
<p>Restricts the error logging performed by the specified
<span class="code">sasl_error_logger</span> to error reports, progress reports,
or both. Default is <span class="code">all</span>.</p>
</dd>
<dt><strong><span class="code">error_logger_mf_dir = string() | false<optional></span></strong></dt>
<dd>
<p>Specifies in which directory the files are stored. If this
parameter is undefined or <span class="code">false</span>,
the <span class="code">error_logger_mf_h</span> is not installed.</p>
</dd>
<dt><strong><span class="code">error_logger_mf_maxbytes = integer() <optional></span></strong></dt>
<dd>
<p>Specifies how large each individual file can be. If this
parameter is undefined, the <span class="code">error_logger_mf_h</span> is not
installed.</p>
</dd>
<dt><strong><span class="code">error_logger_mf_maxfiles = 0<integer()<256 <optional></span></strong></dt>
<dd>
<p>Specifies how many files are used. If this parameter is
undefined, the <span class="code">error_logger_mf_h</span> is not installed.</p>
</dd>
<dt><strong><span class="code">overload_max_intensity = float() > 0 <optional></span></strong></dt>
<dd>
<p>Specifies the maximum intensity for <span class="code">overload</span>. Default
is <span class="code">0.8</span>.</p>
</dd>
<dt><strong><span class="code">overload_weight = float() > 0 <optional></span></strong></dt>
<dd>
<p>Specifies the <span class="code">overload</span> weight. Default is <span class="code">0.1</span>.</p>
</dd>
<dt><strong><span class="code">start_prg = string() <optional></span></strong></dt>
<dd>
<p>Specifies which program should be used when restarting
the system. Default is <span class="code">$OTP_ROOT/bin/start</span>.</p>
</dd>
<dt><strong><span class="code">masters = [atom()] <optional></span></strong></dt>
<dd>
<p>Specifies which nodes this node uses to read/write release
information. This parameter is ignored if
the <span class="code">client_directory</span> parameter is not set.</p>
</dd>
<dt><strong><span class="code">client_directory = string() <optional></span></strong></dt>
<dd>
<p>This parameter specifies the client directory at the master
nodes. Refer to Release Handling in <strong>OTP Design Principles</strong> for more information. This parameter is
ignored if the <span class="code">masters</span> parameter is not set.</p>
</dd>
<dt><strong><span class="code">static_emulator = true | false <optional></span></strong></dt>
<dd>
<p>Indicates if the Erlang emulator is statically installed. A
node with a static emulator cannot switch dynamically to a
new emulator as the executable files are written into memory
statically. This parameter is ignored if the <span class="code">masters</span>
and <span class="code">client_directory</span> parameters are not set.</p>
</dd>
<dt><strong><span class="code">releases_dir = string() <optional></span></strong></dt>
<dd>
<p>Indicates where the <span class="code">releases</span> directory is located.
The release handler writes all its files to this directory.
If this parameter is not set, the OS environment parameter
<span class="code">RELDIR</span> is used. By default, this is
<span class="code">$OTP_ROOT/releases</span>.</p>
</dd>
<dt><strong><span class="code">utc_log = true | false <optional></span></strong></dt>
<dd>
<p>If set to <span class="code">true</span>, all dates in textual log outputs are
displayed in Universal Coordinated Time with the string
<span class="code">UTC</span> appended.</p>
</dd>
</dl>
</div>
<h3><a name="id61887">See Also</a></h3>
<div class="REFBODY">
<p><span class="bold_code"><a href="alarm_handler.html">alarm_handler(3)</a></span>,
error_logger(3),
log_mf_h(3),
<span class="bold_code"><a href="overload.html">overload(3)</a></span>,
<span class="bold_code"><a href="rb.html">rb(3)</a></span>,
<span class="bold_code"><a href="release_handler.html">release_handler(3)</a></span>,
<span class="bold_code"><a href="systools.html">systools(3)</a></span></p>
</div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
1263
