.\"  $HeadURL$ $LastChangedRevision$
.\"
.pso ade-config --format=man
.so \*[ade_include_prefix]/ade.man
.SH SYNOPSIS
.TH ADEGMT 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.ne 5
.SH NAME
adegmt \- get module template for ADE-based software
.br
.ne 5
.SH SYNOPSIS
.B adegmt
\*[ade_standard_synopsis_component] 
[
.B \-L
.I lang
|
.B \-\-language=\fIlang\fR
] 
[
.B \-\-scm\-dirs
] 
[
.B \-n 
|
.B \-\-simulate
]
.I new\-module\-path
[
.I component\fR ...
]
.br
.ne 5
.SH DESCRIPTION
.B Adegmt
create files and directories for use in new ADE-based software.
.PP
It creates files based on templates, which are distributed as part 
of ADE. The program files it creates compile and run, but do nothing. The
manual pages it creates document this behaviour. The tests it
creates test this behaviour and all pass. It is up the
the user to tailor the code, documentation and tests according to 
the program's required functionality.
.PP
.B Adegmt
has no knowledge of the capability and contents of these templates.
It is reponsible only for delivering all or part of them to the 
user with some substitutions. 
However,
.B adegmt
can draw files from one of several zero-functionality modules, each
of which is written in different languages. Currently there exist
template modules for Shell and Perl.
.PP
Normally 
.B adegmt
should be invoked specifying a new directory for the
.I new\-module\-path
argument, and without specifying any
.I component\fR
argument. This will create a new module whose name is taken from
the last component of 
.I new\-module\-path\fR.
.B 
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
\*[ade_standard_options_component]
.TP
.B \-L \fIlang\fR, \fB\-\-language=\fIlang
Specify the language of the zero-function to be created. Valid
values of 
.I lang
are
.B shell
or
.B perl\fR.
The default is 
.B shell\fR.
.TP
.B \-n\fR, \fB\-\-simulate
Do not create any files or directories; only show the commands that
would be called in order to create them.
.br
.ne 5
.SH EXIT STATUS
On success
.B adegmt
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
.TP 25
.B \*[ade_lib_prefix]/template_modules
Template module sources
.br
.ne 5
.SH ENVIRONMENT VARIABLES
.TP 25 
.B ADEROOT
.B adegmt
uses this to determine where to retrieve files from, if it is set. Otherwise
it calls
.B aderoot\fR(1)
to determine the same information.
.ne 5
.SH EXAMPLES
The following command would create a new Perl module \(oqfoo':
.IP
.nf
.fam C
.B adegmt -L perl foo
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B adegmt\fR.
.br
.ne 5
.SH SEE ALSO
aderoot(1), perl(1), sh(1), ade-config(1)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2002-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
\*[ade_standard_copyright_component]