Erlang -- rel

User's Guide
Reference Manual
Release Notes
PDF
Top

System Application Support Libraries (SASL)
Reference Manual
Version 2.1.9.3

Expand All
Contract All

Table of Contents

- sasl (App)
- alarm_handler
  - Top of manual page
  - clear_alarm/1
  - get_alarms/0
  - set_alarm/1
- overload
  - Top of manual page
  - request/0
  - get_overload_info/0
- rb
  - Top of manual page
  - filter/1
  - filter/2
  - grep/1
  - h/0
  - help/0
  - list/0
  - list/1
  - rescan/0
  - rescan/1
  - show/0
  - show/1
  - start/0
  - start/1
  - start_log/1
  - stop/0
  - stop_log/0
- release_handler
  - Top of manual page
  - check_install_release/1
  - create_RELEASES/4
  - install_file/2
  - install_release/1
  - install_release/2
  - make_permanent/1
  - remove_release/1
  - reboot_old_release/1
  - set_removed/1
  - set_unpacked/2
  - unpack_release/1
  - which_releases/0
  - upgrade_app/2
  - downgrade_app/2
  - downgrade_app/3
  - upgrade_script/2
  - downgrade_script/3
  - eval_appup_script/4
- systools
  - Top of manual page
  - make_relup/3
  - make_relup/4
  - make_script/1
  - make_script/2
  - make_tar/1
  - make_tar/2
  - script2boot/1
- appup
- rel
- relup
- script

# rel

### FILE

rel

### FILE SUMMARY

Release resource file

### DESCRIPTION

The release resource file specifies which applications are are included in a release (system) based on Erlang/OTP.

This file is used by the functions in systools when generating start scripts (.script, .boot) and release upgrade files (relup).

### FILE SYNTAX

The release resource file should be called Name.rel.

The .rel file contains one single Erlang term, which is called a release specification. The file has the following syntax:

    {release, {RelName,Vsn}, {erts, EVsn},
      [{Application, AppVsn} |
       {Application, AppVsn, Type} |
       {Application, AppVsn, IncApps} |
       {Application, AppVsn, Type, IncApps}]}.

- RelName = string() is the name of the release.

- Vsn = string() is the version of the release.

- EVsn = string() is the version of ERTS the release is intended for.

- Application = atom() is the name of an application included in the release.

- AppVsn = string() is the version of an application included in the release.

- Type = permanent | transient | temporary | load | none is the start type of an application included in the release.

  If Type = permanent | transient | temporary, the application will be loaded and started in the corresponding way, see application(3). If Type = load, the application will only be loaded. If Type = none, the application will be neither loaded nor started, although the code for its modules will be loaded. Defaults to permanent

- IncApps = [atom()] is a list of applications that are included by an application included in the release.

  The list must be a subset of the included applications specified in the application resource file (Application.app) and overrides this value. Defaults to the empty list.

Note

The list of applications must contain the kernel and stdlib applications.

### SEE ALSO

application(3), relup(4), systools(3)