NAME

       sasl - The SASL application

DESCRIPTION

       The SASL application provides the following services:

         * alarm_handler

         * overload (deprecated)

         * rb

         * release_handler

         * systools

       The  SASL  application also includes error_logger event handlers for formatting SASL error
       and crash reports.

   Note:
       The SASL application in OTP has nothing to do with  "Simple  Authentication  and  Security
       Layer" (RFC 4422).

ERROR LOGGER EVENT HANDLERS

       The following error logger event handlers are used by the SASL application.

         sasl_report_tty_h:
           Formats  and  writes supervisor reports, crash reports, and progress reports to stdio.
           This  error  logger  event  handler  uses  error_logger_format_depth  in  the   Kernel
           application to limit how much detail is printed in crash and supervisor reports.

         sasl_report_file_h:
           Formats  and  writes supervisor reports, crash report, and progress report to a single
           file. This error logger event handler uses  error_logger_format_depth  in  the  Kernel
           application to limit the details printed in crash and supervisor reports.

         log_mf_h:
           This  error  logger writes all events sent to the error logger to disk. Multiple files
           and log rotation are used. For efficiency reasons, each event is written as a  binary.
           For more information about this handler, see the STDLIB Reference Manual.

           To  activate  this  event  handler,  three  SASL configuration parameters must be set,
           error_logger_mf_dir, error_logger_mf_maxbytes, and error_logger_mf_maxfiles. The  next
           section provides more information about the configuration parameters.

CONFIGURATION

       The  following  configuration  parameters  are  defined for the SASL application. For more
       information about configuration parameters, see app(5) in Kernel.

       All configuration parameters are optional.

         sasl_error_logger = Value :
           Value is one of the following:

           tty:
             Installs sasl_report_tty_h in the error logger. This is the default option.

           {file,FileName}:
             Installs sasl_report_file_h in the error logger. All reports go  to  file  FileName,
             which is a string.

           {file,FileName,Modes}:
             Same  as {file,FileName}, except that Modes allows you to specify the modes used for
             opening the FileName given to  the  file:open/2  call.  When  not  specified,  Modes
             defaults to [write]. Use [append] to have the FileName open in append mode. FileName
             is a string.

           false:
             No SASL error logger handler is installed.

         errlog_type = error | progress | all :
           Restricts the error logging performed by  the  specified  sasl_error_logger  to  error
           reports or progress reports, or both. Default is all.

         error_logger_mf_dir = string() | false :
           Specifies  in  which  directory  log_mf_h  is to store its files. If this parameter is
           undefined or false, the log_mf_h handler is not installed.

         error_logger_mf_maxbytes = integer() :
           Specifies the maximum size of each  individual  file  written  by  log_mf_h.  If  this
           parameter is undefined, the log_mf_h handler is not installed.

         error_logger_mf_maxfiles = 0<integer()<256 :
           Specifies  the  number  of files used by log_mf_h. If this parameter is undefined, the
           log_mf_h handler is not installed.

         overload_max_intensity = float() > 0 :
           Specifies the maximum intensity for overload. Default is 0.8.

           Note that the overload module is deprected and will be removed in a future release.

         overload_weight = float() > 0 :
           Specifies the overload weight. Default is 0.1.

           Note that the overload module is deprected and will be removed in a future release.

         start_prg = string() :
           Specifies  the  program  to  be  used  when  restarting  the  system  during   release
           installation. Default is $OTP_ROOT/bin/start.

         masters = [atom()] :
           Specifies  the  nodes  used  by  this  node  to  read/write  release information. This
           parameter is ignored if parameter client_directory is not set.

         client_directory = string() :
           This parameter specifies the client directory at the master nodes.  For  details,  see
           Release  Handling  in  OTP  Design  Principles. This parameter is ignored if parameter
           masters is not set.

         static_emulator = true | false :
           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  parameters  masters  and
           client_directory are not set.

         releases_dir = string() :
           Indicates  where the releases directory is located. The release handler writes all its
           files to this directory. If this parameter is not set, the  OS  environment  parameter
           RELDIR is used. By default, this is $OTP_ROOT/releases.

         utc_log = true | false :
           If  set  to  true,  all  dates  in  textual  log  outputs  are  displayed in Universal
           Coordinated Time with the string UTC appended.

SEE ALSO

       alarm_handler(3erl),   error_logger(3erl),   log_mf_h(3erl),   overload(3erl),   rb(3erl),
       release_handler(3erl), systools(3erl)