.TH ELLCC 1
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
.SH NAME
ellcc \- Program to compile an emacs dynamic module
.SH SYNOPSIS
.B ellcc
[--mode={compile,link,init,verbose}] [--mod-name=NAME] [--mod-title=TITLE]
[--mod-version=VERSION] [Any compiler command line args]
.br
.SH DESCRIPTION
This manual page documents briefly the
.BR ellcc ,
command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
.PP
The following is taken directly from the comments in the source.
.PP
Here's the scoop. We would really like this to be a shell script, but
the various Windows platforms don't have reliable scripting that suits
our needs. We don't want to rely on perl or some other such language
so we have to roll our own executable to act as a front-end for the
compiler.
.PP
This program is used to invoke the compiler, the linker and to generate
the module specific documentation and initialization code.  We assume we
are in 'compile' mode unless we encounter an argument which tells us
that we're not.  We take all arguments and pass them on directly to the
compiler, except for a few which are specific to this program:
.PP
The idea is that Makefiles will use ellcc as the compiler for making
dynamic Emacs modules, and life should be as simple as:
.PP
  make CC=ellcc LD='ellcc --mode=link'
.PP
The only additional requirement is an entry in the Makefile to produce
the module initialization file, which will usually be something along
the lines of:
.PP

.SH OPTIONS
.TP 8
.BI \--mode=VALUE
This sets the program mode. VALUE can be one of
compile, link, init or verbose.
.TP 8
.BI \--mod-name=NAME
Sets the module name to the string NAME.
.TP 8
.BI \--mod-title=TITLE
Sets the module title to the string TITLE.
.TP 8
.BI \--mod-version=VERSION
Sets the module version to the string VER.
.br
.\" .SH SEE ALSO
.SH EXAMPLE
.RS 4
modinit.c: $(SRCS)
.br
             ellcc --mode=init --mod-name=\"$(MODNAME)\" \
.br
               --mod-title=\"$(MODTITLE)\" --mod-version=\"$(MODVERSION)\" \
.br
               -o $@ $(SRCS)
.br
See the samples for more details.
.br

.SH AUTHOR
This manual page was written by James LewisMoss <dres@debian.org>,
for the Debian GNU/Linux system (but may be used by others).
