iex.1.in

.Dd April 10, 2015
.Dt IEX 1
.Os
.Sh NAME
.Nm iex
.Nd The Elixir shell
.Sh SYNOPSIS
.Nm
.Op Ar OPTIONS
.Sh DESCRIPTION
The interactive shell is used for evaluation, debugging and introspection of the Elixir runtime system. It is also possible to use the program for testing the work of small pieces of code escaping the stage of saving the code in a file.
.Sh OPTIONS
Note that many of the options mentioned here were borrowed from the Erlang shell, therefore
.Xr erl 1
can be used as an additional source of information on the options.
.Bl -tag -width Ds
{COMMON}
.It Fl -dot-iex Ar file
Loads the specified file instead of
.Pa .iex.exs
.Pq see the Sy FILES No section .
.It Fl -remsh Ar node
Connects to the specified node which was started with the
.Fl -sname
or
.Fl -name
options
.Pq see above .
.It Fl -
Separates the options passed to the compiler from the options passed to the executed code.
.El
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev ELIXIR_ERL_OPTIONS
Allows passing parameters to the Erlang runtime.
.El
.Sh FILES
.Bl -tag -width Ds
.It Pa ~/.erlang.cookie
Stores the magic cookie value which is used only when it wasn't specified via the option
.Fl -cookie
.Pq see above .
If the file doesn't exist when a node starts, it will be created.
.It Pa .iex.exs
After
.Nm
starts, it seeks the file
.Pa .iex.exs
and, in a case of success, executes the code from the file in the context of the shell. At first the search starts in the current working directory, then, if necessary, it continues in the home directory.
.El
.Sh SEE ALSO
.Xr elixir 1 ,
.Xr elixirc 1 ,
.Xr mix 1
.Sh AUTHOR
This manual page contributed by Evgeny Golyshev.
.Sh INTERNET RESOURCES
.Bl -tag -width Ds
.It Main website: http://elixir-lang.org
.It Documentation: http://elixir-lang.org/docs.html
.El