-spec start() -> ignore | {error, _} | {ok, pid()}.

Create the alcove port using the default options

-spec start(proplists:proplist()) -> ignore | {error, _} | {ok, pid()}.

Create the alcove port

See start_link/1 for options.

-spec start_link() -> ignore | {error, _} | {ok, pid()}.

Create and link against the alcove port using the default options

-spec start_link(proplists:proplist()) -> ignore | {error, _} | {ok, pid()}.

Create and link against the alcove port

Create the alcove port.

* stderr_to_stdout

The behaviour of stderr from the port differs from child processes. Standard error from the port goes to the console while stderr from child processes is tagged and sent to the controlling Erlang process.

This option merges stderr and stdout from the port. Since stdout is used for communicating with the Erlang side and is tagged with a header, this will likely mess things up.

Only use this option if you want to call execvp/3,4 in the port.

* {env, [{Key,Val}]}

Set the environment for the port.

* {exec, Exec}

Default: ""

Sets a command to run the port, such as sudo.

* {progname, Path}

Default: priv/alcove

Sets the path to the alcove executable.

* {ctldir, Path}

Default: priv

Sets the path to the alcove control directory. The directory must be writable by the alcove user.

For the remaining options, see alcove:getopt/2,3.