.\" $HeadURL$ $LastChangedRevision$
.\"
.TH AODMS 8 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.SH NAME
aodms \- action-orientated Debian maintainer script executor
.br
.ne 5
.SH SYNOPSIS
.B aodms
[
.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
]
.I functions\-file
.I mode
.I submode
\.\.\.
.br
.ne 5
.SH DESCRIPTION
.B Aodms
enables Debian package developers to specify code to be executed to 
do specific tasks, without having to worry about at what times these
tasks need to be done.
.PP
As an example, consider when a database application should create
a database administrator account; clearly it should be done at
package installation time, but in the 
.B preinst
or
.B postinst
script? And what about when these scripts are called with 
.B install\fR,
.B uggrade\fR,
.B failed\-upgrade\fR,
etc. 
.B Aodms
takes care of all this. You just need to specify that the account
needs to be created and not worry about when.
.PP
.B Aodms
is not intended to be called by humans; maintainer scripts, which
call it, are generated by 
.B aodms-helper\fR(1).
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B aodms
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 aodms
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 aodms
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 Aodms
is not meant to be called by humans.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B aodms\fR.
.br
.ne 5
.SH SEE ALSO
aodms-helper(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) 2004-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.