.\"  $HeadURL$ $LastChangedRevision$
.\" vim: filetype=nroff
.\"
.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
|
.B \-\-list\-templates
]
[
.B \-n 
|
.B \-\-simulate
]
.I template\-module\-name
.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 does this by cloning one of the template modules, which are distributed as part 
of ADE, and making sensible changes both to the names of the files and their contents. 
Use 
.B adegmt\ \-l
to determine what templates are available.
.PP
The template module sources compile cleanly.
The man pages in the template modules document their bahaviour. The tests in
the template modules test their behaviour and all tests (both ADE standard tests and
each modules' own tests) pass. 
.PP
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. 
.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.
.PP
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
\*[ade_standard_options_component]
.B shell\fR.
.TP
.B \-l\fR, \fB\-\-list\-templates
Do not create any files or directories; just list what templates are available.
.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_share_prefix]/templates
Template module sources
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
The following command would create a new Perl module \(oqfoo':
.IP
.nf
.fam C
.B adegmt lxperl 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
bash(1), perl(1), xterm(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]