.\"  $HeadURL$ $LastChangedRevision$
.\"
.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
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel\fR
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
[
.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
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of 
.B adegmt\fR.
.PP 
.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. For information on the template
contents see 
.B adeintro\fR(1).
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
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B adegmt
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.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.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B adegmt
uses.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.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 $ADEROOT_LIB/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 SEE ALSO
adeintro(1), aderoot(1), perl(1), sh(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
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.