.\"  $HeadURL$ $LastChangedRevision$
.\"
.TH ADEROOT 1 "SPPSYM_RELEASE_DATE_MAN"
.ne 5
.SH NAME
aderoot \- report ADE software root directory
.br
.ne 5
.SH SYNOPSIS
.B aderoot
[
.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 ADEROOT_INCLUDE=\fIdir\fR, \fBADEROOT_BIN=\fIdir\fR, \fBADEROOT_SBIN=\fIdir\fR, \fBADEROOT_LIB=\fIdir
]
{
.B include
|
.B bin
|
.B sbin
|
.B lib
}
.br
.ne 5
.SH DESCRIPTION
This manual page documents version SPPSYM_RELEASE_ID of 
.B aderoot\fR.
.PP 
.B Aderoot
reports the directory from which files for the selected component of ADE are read.
.PP
Its purpose is to relieve the user of the requirement to
set 
.B ADEROOT_INCLUDE\fR, \fBADEROOT_BIN\fR, \fBADEROOT_SBIN\fR, and \fBADEROOT_LIB\fR
in his environment, and still to allow access him to 
flexibly located ADE files.
.PP
It is meant to be invoked by Makefiles, and not
by humans.
.br
.ne 5
.SH CONFIGURATION
If you only have one installation of ADE on your system,
and aderoot is in your PATH, then no configuration is
necessary.
.PP
If you have multiple installations, then in order that
the
.B aderoot
found first in your PATH can direct Makefiles to use
a different root of ADE software, you need to set the
enviroment variables
.B ADEROOT_INCLUDE\fR, \fBADEROOT_BIN\fR, \fBADEROOT_SBIN\fR, and \fBADEROOT_LIB\fR.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B aderoot
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 \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B aderoot
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 aderoot
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
.TP 25 
.B ADEROOT_INCLUDE\fR, \fBADEROOT_BIN\fR, \fBADEROOT_SBIN\fR, \fBADEROOT_LIB\fR
These are used by various programs in ADE (see
.B adeintro\fR(1)).
.br
.ne 5
.SH EXAMPLES
Use of 
.B aderoot
by humans is strongly discouraged.
.br
.ne 5
.SH CAVEATS
The arguments
\(oq\fBADEROOT_INCLUDE=\fIdir\fR', 
etc, are experimental and should probably not be used.
.PP
As stated above, 
.B aderoot
is not intended for use by humans, only by Makefiles. 
.br
.ne 5
.SH SEE ALSO
adegmt(1), adeintro(1), make(1)
.br
.ne 5
.SH AUTHOR
SPPSYM_AUTHOR_NAME <SPPSYM_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2002-SPPSYM_RELEASE_YEAR SPPSYM_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.