ADEGMT(1) General Commands Manual ADEGMT(1)
NAME
adegmt - get module template for ADE-based software
SYNOPSIS
adegmt [ -V | --version ] [ -v | --verbose | -d level | --debug=level ]
[ -h | --help ] [ -p | --paths ] [ -n | --simulate ] [ -l | --list-tem-
plates ] [ -n | --simulate ] template-module-name new-module-path [
component ... ]
DESCRIPTION
Adegmt create files and directories for use in new ADE-based software.
It does this by cloning one of the template modules, which are distrib-
uted as part of ADE, and making sensible changes both to the names of
the files and their contents. Use adegmt -l to determine what tem-
plates are available.
The template module sources compile cleanly. The man pages in the tem-
plate modules document their bahaviour. The tests in the template mod-
ules test their behaviour and all tests (both ADE standard tests and
each modules' own tests) pass.
It is up the the user to tailor the code, documentation and tests ac-
cording to the program's required functionality.
Adegmt has no knowledge of the capability and contents of these tem-
plates. It is reponsible only for delivering all or part of them to
the user with some substitutions.
Normally adegmt should be invoked specifying a new directory for the
new-module-path argument, and without specifying any component argu-
ment. This will create a new module whose name is taken from the last
component of new-module-path.
CONFIGURATION
None.
OPTIONS
-d level, --debug=level Determines how verbose this program will be.
The message types displayed for the different
values of level are as follows: 0 displays no
messages; 1 displays only errors, 2 displays
errors and warnings; 3 displays errors, warn-
ings and informational messages; higher values
display errors, warnings, informational mes-
sages and various messages intended for debug-
ging. The default is 2.
-h, --help Displays a brief usage message.
-p, --paths Lists the compiled-in paths of various files
and directories that this program uses. -n,
--simulate Some external commands that this
program runs may be displayed rather than ac-
tually executed. BEWARE: different programs
implement different levels of simulation; so
this option may work perfectly; on the other
hand it may do nothing at all!
-v, --verbose Equivalent to -d 3.
-V, --version Prints the program's version number and exits.
shell.
-l, --list-templates Do not create any files or directories; just
list what templates are available.
-n, --simulate Do not create any files or directories; only
show the commands that would be called in or-
der to create them.
EXIT STATUS
On success adegmt returns zero. On failure it returns non-zero and dis-
plays a diagnostic message.
FILES
../../share/templates Template module sources
ENVIRONMENT VARIABLES
None.
EXAMPLES
The following command would create a new Perl module 'foo':
adegmt lxperl foo
CAVEATS
None.
STANDARDS
This manual page documents version 3.0.4 of adegmt.
SEE ALSO
bash(1), perl(1), xterm(1), ade-config(1)
AUTHOR
Alexis Huxley <alexishuxley@gmail.com>
COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2002-2024 Alexis Huxley
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.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
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.
27 Dec 2024 ADEGMT(1)
