source: trunk/man/arm4_daemon.1 @ 704

.\" Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others.
.\" All rights reserved.   This program and the accompanying materials
.\" are made available under the terms of the Eclipse Public License v1.0
.\" which accompanies this distribution, and is available at
.\" http://www.eclipse.org/legal/epl-v10.html
.TH "arm4_daemon" 1 "July 2008" "arm4.org" "ARM 4 System Commands"
.SH NAME
arm4_daemon \- ARM 4 collection agent
.SH SYNOPSIS
.B arm4_daemon
\fI\-\-help|\-h\fR
.br
.B arm4_daemon
\fI\-\-version|\-V\fR
.br
.B arm4_daemon
[\fI\-\-verbose|\-v\fR] [\fI\-\-debug|\-d\fR]
            [\fI\-\-config|\-C config_file\fR]
            [\fI\-\-stats|\-s\fR] [\fI\-\-off|\-o\fR]
.SH DESCRIPTION
The
.B arm4_daemon
program collects \fIARM 4\fR measurement data from the \fIARM 4\fR libraries
and saves the measurements in a local database.  While there will normally
be many instances of the instrumented applications, there will typically be
only one instance of the
.B arm4_daemon
running at a time.
.SH CONFIGURATION
Configuration options are set in the configuration file. The default
configuration is \fI/etc/arm4.conf\fR, although this can be overridden using
the \fI\-\-config\fR command line option. See \fBarm4.conf\fR(5) for more
information.
.SH DATAFILES
The
.B arm4_daemon
program uses the Berkeley database to store transaction information. Rather
than a single file, this database uses separate files fore each database
table. For simplicity, all database files are stored in a single
directory. Therefore specifying a database or database archive location
is really specifying the directory in which the files are stored.
.P
The default location for the database files is \fI/var/lib/arm4/data\fR. For
backup files, a time stamped directory is created under
\fI/var/lib/arm4/data/backup\fR. Each of these directories can be changed
using the \fIarm4.conf\fR configuration file.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
display the command line options
.TP
\fB\-V\fR, \fB\-\-Version\fR
display the program version and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
output diagnostic information as the program is run. This may not be suitable
when running in the background as a true daemon but can be useful for
debugging.
.TP
\fB\-C\fR, \fB\-\-Config\fR \fIconfig_file\fR
specifies a configuration file for this instance instead of using the default
configuration file. The default configuration file
\fI/etc/arm4.conf\fR is used if none is specified.
.TP
\fB\-d\fR, \fB\-\-debug\fR
run the daemon as a foreground process. This is primarily used for debugging.
.TP
\fB\-s\fR, \fB\-\-stats\fR
periodically display statistics on the message queues and database processes.
.TP
\fB\-o\fR, \fB\-\-off\fR
Start the agent as a "null" collector. Although the collector is active,
no data is actually collected. This can be controlled using the
\fBarm4_control\fR utility.
.SH "REPORTING BUGS"
Report bugs at <http://www.arm4.org>
.SH COPYRIGHT
Copyright \(co 2005\-2008 David Carter <dcarter@arm4.org> and others.
.P
All rights reserved.   This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
.SH "SEE ALSO"
.LP
.BR arm4_control (1),
.BR arm4_dump (1),
.BR arm4_export (1),
.BR arm4_report (1),
.BR arm4_conf (5)