User's Guide
Reference Manual
Release Notes
PDF
Top

System Application Support Libraries (SASL)
Reference Manual
Version 2.3.2

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
  - check_install_release/2
  - 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
  - which_releases/1
  - 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

# relup

### FILE

relup

### FILE SUMMARY

Release upgrade file

### DESCRIPTION

The release upgrade file describes how a release is upgraded in a running system.

This file is automatically generated by systools:make_relup/3,4, using a release resource file (.rel), application resource files (.app) and application upgrade files (.appup) as input.

### FILE SYNTAX

In a target system, the release upgrade file should be located in the OTP_ROOT/erts-EVsn/Vsn directory.

The relup file contains one single Erlang term, which defines the instructions used to upgrade the release. The file has the following syntax:

    {Vsn,
      [{UpFromVsn, Descr, Instructions}, ...],
      [{DownToVsn, Descr, Instructions}, ...]}.

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

- UpFromVsn = string() is an earlier version of the release to upgrade from.

- Descr = term() is a user defined parameter passed from the systools:make_relup/3,4 function. It will be used in the return value of release_handler:install_release/1,2.

- Instructions is a list of low-level release upgrade instructions, see appup(4).

  It consists of the release upgrade instructions from the respective application upgrade files (high-level instructions are translated to low-level instructions), in the same order as in the start script.

- DownToVsn = string() is an earlier version of the release to downgrade to.

When upgrading from UpFromVsn with release_handler:install_release/1,2, there does not have to be an exact match of versions, but UpFromVsn can be a sub-string of the current release version.

### SEE ALSO

app(4), appup(4), rel(4), release_handler(3), systools(3)