source: trunk/man/arm4_control.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_control" 1 "July 2008" "arm4.org" "ARM 4 System Commands"
.SH NAME
arm4_control \- ARM 4 agent control program
.SH SYNOPSIS
.B arm4_control
\fI\-\-help|\-h\fR
.br
.B arm4_control
\fI\-\-version|\-V\fR
.br
.B arm4_control
[\fI\-\-config|\-C config_file\fR] [\fIcommands...\fR]
.SH DESCRIPTION
The
.B arm4_control
program controls the
.B arm4_daemon
program.
.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\-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.
.SH COMMANDS
.TP
\fBhelp\fR, \fBhelp commands\fR
show all available commands.
.TP
\fBhelp <command>\fR
show options for the command.
.TP
\fBarchive\fR
backup the current database to the backup directory. Unless specified in
the configuration file, the main backup directory is
\fI/var/lib/arm4/data/backup\fR.
.TP
\fBcollect\fR, \fBcollect status\fR
show the current collection state.
.TP
\fBcollect yes\fR, \fBcollect on\fR
turn collection on.
.TP
\fBcollect no\fR, \fBcollect off\fR
turn collection off.
.TP
\fBcheckpoint\fR
perform a database checkpoint operation
.TP
\fBremove\fR
remove the shared memory regions and semaphores, but leave the databases intact.
This is normally done when recovering from catastrophic failures.
.TP
\fBstatus\fR
show if an instance of the \fBarm4_daemon\fR is running.
.TP
\fBstop\fR
stop the current \fBarm4_daemon\fR instance.
.TP
\fBwipe\fR
remove the current database, shared memory regions, and semaphores. This is
normally done when upgrading versions.
.TP
\fBapplication\fR
display currently defined applications with their application ids.
.TP
\fBapplication \fIapp_id\fR
display collection parameters for the specified application.
.TP
\fBapplication \fIapp_id\fB transactions\fR
displays the transactions definitions and corresponding transaction ids associated with the specified application.
.TP
\fBtransaction\fR
displays the current transaction definitions.
.TP
\fBtransaction \fItran_id\fR
displays the configuration for a specific transaction id.
.TP
\fBtransaction \fItran_id\fB trace all\fR
trace all transaction instances.
.TP
\fBtransaction \fItran_id\fB trace none\fR
turn tracing off.
.TP
\fBtransaction \fItran_id\fB trace \fIn\fR
trace every \fIn\fRth transaction instance.
.TP
\fBtransaction \fItran_id\fB trace \fIn\fB[s|S]\fR
trace one transaction instance every \fIn\fR tenths of seconds.
.TP
\fBtransaction \fItran_id\fB trace application\fR
honor application trace requests.
.TP
\fBtransaction \fItran_id\fB trace noapplication\fR
ignore application trace requests.
.TP
\fBtransaction \fItran_id\fB trace default\fR
use application default settings.
.TP
\fBexport definitions\fR
exports application, metric, and transaction definitions in xml format to stdout.
.TP
\fBexport all\fR
exports the full database including definitions and instance data in xml format to stdout.
.TP
\fBimport \fIfilename\fR
imports an exported database in xml format from the file.
.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_daemon (1),
.BR arm4_report (1),
.BR arm4_dump (1),
.BR arm4.conf (5)