This is an interface module for the Reltool application
Reltool is a release management tool. It analyses a given Erlang/OTP installation and determines various dependencies between applications. The graphical frontend depicts the dependencies and enables interactive customization of a target system. The backend provides a batch interface for generation of customized target systems.
The tool uses an installed Erlang/OTP system as input. root_dir is the root directory of the analysed system and it defaults to the system executing reltool. Applications may also be located outside root_dir. lib_dirs defines additional library directories where applications additional may reside and it defaults to the the directories listed by the operating system environment variable ERL_LIBS. See the module code for more info. Finally single modules and entire applications may be read from Escripts. The names of the Escripts are given in the configuration parameter escripts. By default, no Escripts are included.
Some configuration parameters control the behavior of Reltool on system (sys) level. Others provide control on application (app) level and yet others are on module (mod) level. Module level parameters overrides application level parameters and application level parameters overrides system level parameters.
The following top level options are supported:
Besides the already mentioned source parameters root_dir, lib_dirs and escripts, the following system (sys) level options are supported:
On application (app) level,the following options are supported:
On module (mod) level,the following options are supported:
options() = [option()]
option() = {config, config() | file()}
| {trap_exit, bool()}
| {wx_debug, term()}
config() = {sys, [sys()]}
sys() = {root_dir, root_dir()}
| {lib_dirs, [lib_dir()]}
| {escripts, [escript()]}
| {erts, app()}
| {app, app_name(), [app()]}
| {mod_cond, mod_cond()}
| {incl_cond, incl_cond()}
| {boot_rel, boot_rel()}
| {rel, rel_name(), rel_vsn(), [rel_app()]}
| {app_file, app_file()}
| {debug_info, debug_info()}
| {incl_erts_dirs, [incl_erts_dir()]}
| {excl_erts_dirs, [excl_erts_dir()]}
| {incl_app_dirs, [incl_app_dir()]}
| {excl_app_dirs, [excl_app_dir()]}
app() = {vsn, app_vsn()}
| {mod, mod_name(), mod()}
| {mod_cond, mod_cond()}
| {incl_cond, incl_cond()}
| {debug_info, debug_info()}
| {app_file, app_file()}
| {incl_app_dirs, [incl_app_dir()]}
| {excl_app_dirs, [excl_app_dir()]}
mod() = {vsn, app_vsn()}
| {incl_cond, incl_cond()}
| {debug_info, debug_info()}
rel_app() = app_name()
| {app_name(), app_type()}
| {app_name(), [incl_app()]}
| {app_name(), app_type(), [incl_app()]}
app_name() = atom()
app_type() = permanent | transient | temporary | load | none
app_vsn() = string()
boot_rel() = rel_name()
app_file() = keep | strip | all
debug_info() = keep | strip
dir() = string()
escript() = file()
escript_arg() = string()
excl_app_dir() = dir()
excl_erts_dir() = dir()
file() = string()
incl_app() = app_name()
incl_app_dir() = dir()
incl_cond() = include | exclude | derived
incl_erts_dir() = dir()
lib_dir() = dir()
mod_cond() = all | app | ebin | derived | none
mod_name() = atom()
reason() = string()
rel_file() = term()
rel_name() = string()
rel_vsn() = string()
root_dir() = dir()
script_file() = term()
server() = server_pid() | options()
server_pid() = pid()
window_pid() = pid()
create_target(Server, TargetDir) -> ok | {error, Reason}
Types:
Server = server()
TargetDir = dir()
Reason = reason()
Create a target system. In order to be able to run the target system, it must be installed first.
get_config(Server) -> {ok, Config} | {error, Reason}
Types:
Server = server()
Config = config()
Reason = reason()
Get reltool configuration. Only configuration parameters with values that differs from their defaults are returned.
get_rel(Server, Relname) -> {ok, RelFile} | {error, Reason}
Types:
Server = server()
RelName = rel_name()
RelFile = rel_file()
Reason = reason()
Get contents of a release file. See rel(4) for more details.
get_script(Server, Relname) -> {ok, ScriptFile | {error, Reason}
Types:
Server = server()
RelName = rel_name()
ScriptFile = script_file()
Reason = reason()
Get contents of a boot script file. See script(4) for more details.
install(Server, TargetDir) -> ok | {error, Reason}
Types:
Server = server()
TargetDir = dir()
Reason = reason()
Install a created target system
start(Options) -> {ok, WindowPid} | {error, Reason}
Types:
Options = options()
WindowPid = window_pid()
Reason = reason()
Start a main window process with options
start_server(Options) -> {ok, ServerPid} | {error, Reason}
Types:
Options = options()
ServerPid = server_pid()
Reason = reason()
Start a server process with options. The server process identity can be given as argument to several other functions in the API.
stop(Pid) -> ok | {error, Reason}
Types:
Pid = server_pid() | window_pid()()
Reason = reason()
Stop a server or window process