ADEASS(1) General Commands Manual ADEASS(1)
NAME
adeass - simple preprocessor
SYNOPSIS
adeass [ -V | --version ] [ -v | --verbose | -d level | --debug=level ]
[ -h | --help ] [ -p | --paths ] [ -n | --simulate ] [ --comment ] [
--format=fmt [ --modules=mod[,...] ] file.ass
DESCRIPTION
Adeass copies the following sources:
1 the output from the command(s) mod-config --format=fmt (e.g.
fad-config --format=man) according to the list of modules
specified with the --modules option
2 the contents of the file owning-mod-root/share/owning-mod.fmt
where owning-mod-root is the module in which file.ass is lo-
cated (e.g. /usr/lib/fad/include/FAD.pm)
3 the contents of file.ass
into file.
Its intention is to make variable definitions and macros available to a
program source in order to "compile" the program. It was originally
written in order to overcome restrictions introduced to man-db (see
man(1)) sometime between versions 2.7.5 and 2.8.5. As such, its support
for formats other than man is currently limited.
CONFIGURATION
For each mod specified with the --modules option: the command mod-con-
fig (see ade-app-config) must be available at file.ass's "compile"
time. If the file owning-mod-root/share/owning-mod.fmt is available at
file.ass's "compile" time then its contents will be used; however, it
is not an error for this file not to exist.
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.
--modules=mod[,...] Output the settings from each of the specified
modules' mod-config commands.
--comment Write a comment of the form "this file was au-
togenerated; manual edits will be lost" to the
top of the output in a style corresponding to
the value of fmt.
--format=fmt Specify the output format. fmt may be shell,
perl, python, man, plain, make, encapsu-
lated-make or cpp.
EXIT STATUS
On success adeass returns zero. On failure it returns non-zero and dis-
plays a diagnostic message.
FILES
None.
ENVIRONMENT VARIABLES
None.
EXAMPLES
None.
CAVEATS
Adeass's support for formats other than man is limited.
STANDARDS
This manual page documents version 3.0.4 of adeass.
SEE ALSO
ade-app-config(1), bash(1), cpp(1), make(1), man(1), perl(1), python(1)
AUTHOR
Alexis Huxley <alexishuxley@gmail.com>
COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2019-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 ADEASS(1)
