.\"  $HeadURL$ $LastChangedRevision$
.\" vim: filetype=nroff
.\"
.TH ADEASS 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.ne 5
.SH NAME
adeass \- simple preprocessor
.br
.ne 5
.SH SYNOPSIS
.B adeass
\*[ade_standard_synopsis_component]
[
.B \-\-comment
]
[
.B \-\-format=\fIfmt\fR
[
.B \-\-modules=\fImod\fR[\fB,...\fR]
] 
.I file\fB.ass\fR
.br
.ne 5
.SH DESCRIPTION
.B Adeass
copies the following sources:
.IP 1 10
the output from the command(s)
.I mod\fB\-config \-\-format=\fIfmt
(e.g.
.B fad\-config\ \-\-format=man\fR)
according to the list of modules specified with the 
.B \-\-modules
option
.IP 2 10
the contents of the file 
.I owning\-mod\-root\fB/share/\fIowning\-mod\fB.\fIfmt
where
.I owning\-mod\-root
is the module in which 
.I file\fB.ass
is located
(e.g.
.B /usr/lib/fad/include/FAD.pm\fR)
.IP 3 10
the contents of
.I file\fB.ass
.PP
into
.I file\fR.
.PP
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 
.B man\-db 
(see 
.B man\fR(1))
sometime between versions 2.7.5 and 2.8.5. As such, its support for formats other than
.B man
is currently limited.
.ne 5
.SH CONFIGURATION
For each 
.I mod
specified
with the 
.B \-\-modules
option: the command 
.I mod\fB\-config
(see 
.B ade\-app\-config\fR)
must be available at 
.I file\fB.ass\fR's
"compile" time.
If the file
.I owning\-mod\-root\fB/share/\fIowning\-mod\fB.\fIfmt
is available at
.I file\fB.ass\fR's
"compile" time then its contents will be used; however, it is not an error for this file not to exist.
.br
.ne 5
.SH OPTIONS
\*[ade_standard_options_component]
.TP 25
.B \-\-modules=\fImod\fR[\fB,...\fR]
Output the settings from each of the specified modules' 
.I mod\fB\-config
commands.
.TP
.B \-\-comment
Write a comment of the form "this file was autogenerated; manual edits will be lost" to the top of the
output in a style corresponding to the value of
.I fmt\fR.
.TP
.B \-\-format=\fIfmt
Specify the output format. 
.I fmt
may be 
.B shell\fR,
.B perl\fR,
.B python\fR,
.B man\fR,
.B plain\fR,
.B make\fR,
.B encapsulated\-make\fR
or
.B cpp\fR.
.br
.ne 5
.SH EXIT STATUS
On success
.B adeass
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
None.
.br
.ne 5
.SH CAVEATS
.B Adeass\fR's 
support for formats other than
.B man
is limited.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B adeass\fR.
.br
.ne 5
.SH SEE ALSO
ade\-app\-config(1), bash(1), cpp(1), make(1), man(1), perl(1), python(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) 2019-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
\*[ade_standard_copyright_component]