ADE-APP-CONFIG(1) General Commands Manual ADE-APP-CONFIG(1)
NAME
ade-app-config, app-config - display application's core configuration
variables
SYNOPSIS
ade-app-config [ -V | --version ] [ -v | --verbose | -d level | --de-
bug=level ] [ -h | --help ] [ -p | --paths ] [ -n | --simulate ] [
--format=format ] [ --[in]direct ] [ -a appname | --appname=appname ]
variable ...
app-config ...
DESCRIPTION
The application-specific app-config program (e.g. ade-config(1),
fad-config(1)) invokes ade-app-config, passing it variable assignments
on the latter's standard input. A variable which is not specified will
be derived from other variables' values or defaulted, depending what
has been specified. Ade-app-config then displays these assignments in
a syntax that one of several other programs can understand (default
plain text format).
If no arguments are specified, all variable assignments are displayed.
If lower case variable names are specified as arguments then only these
are displayed.
Neither ade-app-config nor app-config are intended to be called di-
rectly by users. Ade-app-config is intended to be called by the vari-
ous app-config programs; app-config is intended to be called by the
other programs in the app package and by the Makefiles in app's source
distribution.
CONFIGURATION
Ade-app-config requires no configuration. App-config requires only
compile-time configuration (as detailed in the installation instruc-
tions in the application's source distribution).
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.
--direct variable assignments are written to standard
output (this is the default).
--format=format Display the variable settings in the syntax
specified by format, which may be one of the
following, which result in format described:
shell variable=value
man .ds variable value
perl $variable = "value";
plain value
make variable = value
encapsulated-make a complex single statement
with embedded assignments
capable of being parsed by
GNU make(1) only.
cpp #define variable "value"
--indirect variable assignments are written to a tempo-
rary file, and code in the format specified by
the --format option is generated to read that
file. Using format plain makes little sense
with this option.
EXIT STATUS
On success ade-app-config returns zero. On failure it returns non-zero
and displays a diagnostic message.
FILES
None.
ENVIRONMENT VARIABLES
The values of all variables managed by app-config may be overruled by
setting the capitalised version of the same variable name in the envi-
ronment. (See EXAMPLES below.)
EXAMPLES
In the following examples bear in mind that ADE's own application-spe-
cific app-config is called ade-config.
ade-config --format=perl ade_share_prefix
$ade_share_prefix = "/usr/share/ade";
ade-config --format=shell --indirect
. /tmp/ade-app-config.WeXa3541
rm /tmp/ade-app-config.WeXa3541
export ADE_MAN_PREFIX=/home/fred/opt/man
ade-config --format=make ade_man1_prefix
ADE_MAN1_PREFIX = /home/fred/opt/man/man1
CAVEATS
None.
STANDARDS
This manual page documents version 3.0.4 of ade-app-config.
SEE ALSO
bash(1), make(1), perl(1), groff(1), nroff(1), cpp(1)
AUTHOR
Alexis Huxley <alexishuxley@gmail.com>
COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2007-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 ADE-APP-CONFIG(1)
