lehoff / relx

Sane, simple release creation for Erlang

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

NAME

relx - A release assembler for erlang

SYNOPSIS

relx [options] [release-specification-file]

DESCRIPTION

Reltool assembles releases for an Erlang/OTP release. Given a release specification and a list of directories in which to search for OTP applications it will generate a release output. That output depends heavily on what plugins available and what options are defined, but usually it is simple a well configured release directory.

relx -c relx.config -l ~/my-dirs  --relname foo --relvsn 0.0.1 --target-spec myapp --target-spec getopt>=0.5.1 -o output-dir

The release-specification-file is optional but otherwise contains additional specification information for releases.

BUILDING

To build relx and generate a standalone escript executable:

$ make

This creates the executable relx.

OPTIONS

-r STRING, --root STRING : Specify the root directory for the project (if different from cwd)

-n STRING, --relname STRING : Specify the name for the release that will be generated

-v STRING, --relvsn=STRING : Specify the version for the release

-g STRING, --goals STRING : Specify a goal to the system. These are usually the OTP Apps that are part of the release

-o STRING, --output-dir STRING : The output directory for the release. This is ./ by default.

-l STRING, --lib-dir STRING : Additional dirs that should be searched for OTP Apps

-V INTEGER, --verbose INTEGER : The verbosity level of the system. Valid values are 1 - 3

-c INTEGER, --config INTEGER : The custom config file for the relx system

CONFIGURATION FILES

Configuration files

SEE ALSO

reltool (1).

relx wiki

About

Sane, simple release creation for Erlang

License:Apache License 2.0


Languages

Language:Erlang 100.0%