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

NAME

4     elixir — The Elixir script runner
5

SYNOPSIS

7     elixir [OPTIONS] file ...
8

DESCRIPTION

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

OPTIONS

15     Note that many of the options mentioned here were borrowed from the
16     Erlang shell, therefore erl(1) can be used as an additional source of
17     information on the options.
18
19     -e expression
20             Evaluates the specified expression.
21
22     -r file
23             Requires the specified file. In other words, the file is checked
24             for existence at the start of elixir.
25
26     -S script
27             Runs the specified script.
28
29     -pa directory
30             Adds the specified directory to the beginning of the code path.
31             If the directory already exists, it will be removed from its old
32             position and put to the beginning.
33
34             See also the function Code.prepend_path/1.
35
36     -pr file
37             Does the same thing as -r (see above) but in parallel.
38
39     -pz directory
40             Adds the specified directory to the end of the code path. If the
41             directory already exists, it will be neither removed from its old
42             position nor put to the end.
43
44             See also the function Code.append_path/1.
45
46     --app application
47             Starts the specified application and all its dependencies.
48
49     --erl parameters
50             Serves the same purpose as ELIXIR_ERL_OPTIONS (see the
51             ENVIRONMENT section)
52
53     --cookie value
54             Specifies the magic cookie value. If the value isn't specified
55             via the option when the node starts, it will be taken from the
56             file ~/.erlang.cookie (see the FILES section).  Distributed nodes
57             can interact with each other only when their magic cookies are
58             equal.
59
60             See also the function Node.set_cookie/2.
61
62     --detached
63             Runs the Erlang runtime system detached from the controlling ter‐
64             minal.
65
66     --hidden
67             Starts a hidden node.
68
69             Connections between nodes are transitive. For example, if node A
70             is connected to node B, and node B is connected to node C, then
71             node A is connected to node C. The option --hidden allows creat‐
72             ing a node which can be connected to another node, escaping
73             redundant connections.
74
75             The function Node.list/0 allows getting the list of nodes con‐
76             nected to the target node, however the list won't include hidden
77             nodes. Depending on the input parameter, the function Node.list/1
78             allows getting the list which contains only hidden nodes (the
79             parameter :hidden) or both hidden and not hidden nodes (the
80             parameter :connected).
81
82     --sname name
83             Gives a node a short name and starts it. Short names take the
84             form of name@host, where host is the name of the target host
85             (hostname(1)) which runs the node. The nodes with short names can
86             interact with each other only in the same local network.
87
88     --name name
89             Gives a node a long name and starts it. Long names take the form
90             of name@host, where host is the IP address of the host which runs
91             the node. In contrast to the nodes with short names, the nodes
92             with long names aren't limited by boundaries of a local network
93             (see above).
94
95     --no-halt
96             Does not halt the Erlang VM after execution.
97
98     --      Separates the options passed to the compiler from the options
99             passed to the executed code.
100

ENVIRONMENT

102     ELIXIR_ERL_OPTIONS
103             Allows passing parameters to the Erlang runtime.
104

FILES

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

SEE ALSO

112     elixirc(1), iex(1), mix(1)
113

AUTHOR

115     This manual page contributed by Evgeny Golyshev.
116

INTERNET RESOURCES

118     Main website: http://elixir-lang.org
119
120     Documentation: http://elixir-lang.org/docs.html
121
122BSD                             April 10, 2015                             BSD
Impressum