Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

elixir (1)

Name

elixir - The Elixir script runner

Synopsis

elixir [OPTIONS] file ...

Description

ELIXIR(1)                 BSD General Commands Manual                ELIXIR(1)

NAME
     elixir -- The Elixir script runner

SYNOPSIS
     elixir [OPTIONS] file ...

DESCRIPTION
     The program starts the runtime system typically for the execution of one
     or more scripts. It is similar to iex(1), but elixir exits when the exe-
     cuted script does.

OPTIONS
     Note that many of the options mentioned here were borrowed from the
     Erlang shell, therefore erl(1) can be used as an additional source of
     information on the options.

     -e expression
             Evaluates the specified expression.

     -r file
             Requires the specified file. In other words, the file is checked
             for existence at the start of elixir.

     -S script
             Runs the specified script.

     -pa directory
             Adds the specified directory to the beginning of the code path.
             If the directory already exists, it will be removed from its old
             position and put to the beginning.

             See also the function Code.prepend_path/1.

     -pr file
             Does the same thing as -r (see above) but in parallel.

     -pz directory
             Adds the specified directory to the end of the code path. If the
             directory already exists, it will be neither removed from its old
             position nor put to the end.

             See also the function Code.append_path/1.

     --app application
             Starts the specified application and all its dependencies.

     --erl parameters
             Serves the same purpose as ELIXIR_ERL_OPTIONS (see the
             ENVIRONMENT section)

     --cookie value
             Specifies the magic cookie value. If the value isn't specified
             via the option when the node starts, it will be taken from the
             file ~/.erlang.cookie (see the FILES section).  Distributed nodes
             can interact with each other only when their magic cookies are
             equal.

             See also the function Node.set_cookie/2.

     --detached
             Runs the Erlang runtime system detached from the controlling ter-
             minal.

     --hidden
             Starts a hidden node.

             Connections between nodes are transitive. For example, if node A
             is connected to node B, and node B is connected to node C, then
             node A is connected to node C. The option --hidden allows creat-
             ing a node which can be connected to another node, escaping
             redundant connections.

             The function Node.list/0 allows getting the list of nodes con-
             nected to the target node, however the list won't include hidden
             nodes. Depending on the input parameter, the function Node.list/1
             allows getting the list which contains only hidden nodes (the
             parameter :hidden) or both hidden and not hidden nodes (the
             parameter :connected).

     --sname name
             Gives a node a short name and starts it. Short names take the
             form of name@host, where host is the name of the target host
             (hostname(1)) which runs the node. The nodes with short names can
             interact with each other only in the same local network.

     --name name
             Gives a node a long name and starts it. Long names take the form
             of name@host, where host is the IP address of the host which runs
             the node. In contrast to the nodes with short names, the nodes
             with long names aren't limited by boundaries of a local network
             (see above).

     --no-halt
             Does not halt the Erlang VM after execution.

     --      Separates the options passed to the compiler from the options
             passed to the executed code.

ENVIRONMENT
     ELIXIR_ERL_OPTIONS
             Allows passing parameters to the Erlang runtime.

FILES
     ~/.erlang.cookie
             Stores the magic cookie value which is used only when it wasn't
             specified via the option --cookie (see above).  If the file
             doesn't exist when a node starts, it will be created.


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+-----------------------+
     |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
     +---------------+-----------------------+
     |Availability   | runtime/elixir        |
     +---------------+-----------------------+
     |Stability      | Pass-through volatile |
     +---------------+-----------------------+
SEE ALSO
     elixirc(1), iex(1), mix(1)

AUTHOR
     This manual page contributed by Evgeny Golyshev.

INTERNET RESOURCES
     Main website: http://elixir-lang.org

     Documentation: http://elixir-lang.org/docs.html


NOTES
     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://github.com/elixir-lang/elixir/archive/v1.7.3/elixir-1.7.3.tar.gz

     Further information about this software can be found on the open source
     community website at https://elixir-lang.org/.

BSD                             April 10, 2015                             BSD