.\"  $HeadURL$ $LastChangedRevision$
.\"
.TH ADELN 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.ne 5
.SH NAME
adeln \- create symlinks with sanity checks
.br
.ne 5
.SH SYNOPSIS
.B adeln
[
.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 \-\-no\-warn\-on\-unreadable\-dir
]
{
.B \-\-create
|
.B \-\-delete
} 
[
.I target\fR ...
]
.br
.ne 5
.SH DESCRIPTION
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of 
.B adeln\fR.
.PP 
.B Adeln
creates or deletes symbolic links into the current directory. Any
number of arguments may be specified, all of which will be interpreted
as targets for symbolic links. 
.PP
.B Adeln 
checks that the entire link chain is world-readable and that the
link is not a dangling link. These checks make it more suitable
for access to critical data, such as web page hierarchies.
.PP
.br
.ne 5
.SH CONFIGURATION
None.
.ne 5
.SH OPTIONS
.TP 25
.B \-\-create
Symbolic links will be created.
.TP
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B adeln
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 \-\-delete
Symbolic links will be deleted (not the targets, which is what must
be specified).
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-\-no\-warn\-on\-unreadable\-dir
Normally 
.B adeln
will warn if any of the directories between 
.B /
and 
.I target
are unreadable. Unreadability does not prevent access to 
the target but is often not what is actually desired; hence the
warning. This option suppresses that warning.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B adeln
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 adeln
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.
.ne 5
.SH EXAMPLES
The following command would create links 'c' and 'z' in the current
directory to 'a/b/c' and 'x/y/z' respectively:
.IP
.nf
.fam C
.B adeln --create /a/b/c x/y/z
.fam T
.fi
.PP
The following command would delete those same symlinks:
.IP
.nf
.fam C
.B adeln --delete /a/b/c x/y/z
.fam T
.fi
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH SEE ALSO
ln(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) 2003-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_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.