.TH edoc_run 3erl "edoc 1.2" "" "Erlang Module Definition"
.SH NAME
edoc_run \- Interface for calling EDoc from Erlang startup options.
.SH DESCRIPTION
.LP
Interface for calling EDoc from Erlang startup options\&.
.LP
The following is an example of typical usage in a Makefile:
.LP
.nf
     docs:
             erl -noshell -run edoc_run application "'$(APP_NAME)'" \\
               '"."' '[{def,{vsn,"$(VSN)"}}]'
.fi
.LP
(note the single-quotes to avoid shell expansion, and the double-quotes enclosing the strings)\&.
.LP
\fINew feature in version 0\&.6\&.9\fR\&: It is no longer necessary to write \fI-s init stop\fR\& last on the command line in order to make the execution terminate\&. The termination (signalling success or failure to the operating system) is now built into these functions\&.
.SH "DATA TYPES"

.RS 2
.TP 2
.B
args() = [string()]:

.RE
.SH EXPORTS
.LP
.B
application(Args::args()) -> no_return()
.br
.RS
.LP
Calls edoc:application/3 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[App]\fR\&, \fI[App, Options]\fR\& or \fI[App, Dir, Options]\fR\&\&. In the first case edoc:application/1 is called instead; in the second case, edoc:application/2 is called\&.
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE

.LP
.B
file(Args::args()) -> no_return()
.br
.RS
.LP
\fIThis function is deprecated: \fR\&This is part of the old interface to EDoc and is mainly kept for backwards compatibility\&. The preferred way of generating documentation is through one of the functions application/1 and files/1\&.
.LP
Calls edoc:file/2 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[File]\fR\& or \fI[File, Options]\fR\&\&. In the first case, an empty list of options is passed to edoc:file/2\&.
.LP
The following is an example of typical usage in a Makefile:
.LP
.nf
     $(DOCDIR)/%.html:%.erl
             erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \\
               -s init stop
.fi
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE

.LP
.B
files(Args::args()) -> no_return()
.br
.RS
.LP
Calls edoc:files/2 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[Files]\fR\& or \fI[Files, Options]\fR\&\&. In the first case, edoc:files/1 is called instead\&.
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE

.SH "SEE ALSO"

.LP
edoc
.SH AUTHORS
.LP
Richard Carlsson
.I
<carlsson\&.richard@gmail\&.com>