| 1 | .\" Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 2 | .\" All rights reserved. This program and the accompanying materials |
|---|
| 3 | .\" are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 4 | .\" which accompanies this distribution, and is available at |
|---|
| 5 | .\" http://www.eclipse.org/legal/epl-v10.html |
|---|
| 6 | .TH "arm4_report" 1 "July 2008" "arm4.org" "ARM 4 User Commands" |
|---|
| 7 | .SH NAME |
|---|
| 8 | arm4_report \- report on ARM 4 transactions |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | .B arm4_report |
|---|
| 11 | \fI\-\-help|\-h\fR |
|---|
| 12 | .br |
|---|
| 13 | .B arm4_report |
|---|
| 14 | \fI\-\-version|\-V\fR |
|---|
| 15 | .br |
|---|
| 16 | .B arm4_report |
|---|
| 17 | [[\fI\-\-summary|\-s\fR] | [\fI\-\-detailed|\-d\fR]] |
|---|
| 18 | [\fI\-\-config|\-C config_file\fR] [\fI\-\-archive|\-a archive_directory\fR] |
|---|
| 19 | .SH WARNING |
|---|
| 20 | \fBThis program is deprecated and may not exist in a future release\fP |
|---|
| 21 | .SH DESCRIPTION |
|---|
| 22 | The |
|---|
| 23 | .B arm4_report |
|---|
| 24 | program is a simple reporting interface to the \fIARM 4\fR transaction |
|---|
| 25 | database. Two types of reports are available. The summary report shows response |
|---|
| 26 | time statistics for all instances of a transaction instead of individual |
|---|
| 27 | instances. The detailed report shows the results of individual transactions. |
|---|
| 28 | .SH OPTIONS |
|---|
| 29 | .TP |
|---|
| 30 | \fB\-h\fR, \fB\-\-help\fR |
|---|
| 31 | display the command line options. |
|---|
| 32 | .TP |
|---|
| 33 | \fB\-V\fR, \fB\-\-Version\fR |
|---|
| 34 | display the program version and exit. |
|---|
| 35 | .TP |
|---|
| 36 | \fB\-s\fR, \fB\-\-summary\fR |
|---|
| 37 | display summary information for each of the transaction types in the database. |
|---|
| 38 | This is the default if neither summary nor detailed reports are specified. |
|---|
| 39 | .TP |
|---|
| 40 | \fB\-d\fR, \fB\-\-detailed\fR |
|---|
| 41 | show detailed information for each transaction instance. |
|---|
| 42 | .TP |
|---|
| 43 | \fB\-C\fR, \fB\-\-Config\fR \fIconfig_file\fR |
|---|
| 44 | specifies a configuration file for this instance instead of using the default |
|---|
| 45 | configuration file. The default configuration file |
|---|
| 46 | \fI/etc/arm4.conf\fR is used if none is specified. |
|---|
| 47 | .TP |
|---|
| 48 | \fB\-a\fR, \fB\-\-archive\fR \fIarchive_directory\fR |
|---|
| 49 | read an archive created using the |
|---|
| 50 | .B arm4_control |
|---|
| 51 | \fI\-\-archive\fR command. |
|---|
| 52 | .SH "KNOWN BUGS" |
|---|
| 53 | Although intended to be used as a user space program, the current |
|---|
| 54 | implementation accesses the database directly. This means that the program |
|---|
| 55 | must be run by the database owner or as root. |
|---|
| 56 | .SH "REPORTING BUGS" |
|---|
| 57 | Report bugs at <http://www.arm4.org> |
|---|
| 58 | .SH COPYRIGHT |
|---|
| 59 | Copyright \(co 2005\-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 60 | .P |
|---|
| 61 | All rights reserved. This program and the accompanying materials |
|---|
| 62 | are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 63 | which accompanies this distribution, and is available at |
|---|
| 64 | http://www.eclipse.org/legal/epl-v10.html |
|---|
| 65 | .SH "SEE ALSO" |
|---|
| 66 | .LP |
|---|
| 67 | .BR arm4_control (1), |
|---|
| 68 | .BR arm4_daemon (1), |
|---|
| 69 | .BR arm4_dump (1), |
|---|
| 70 | .BR arm4_export (1), |
|---|
| 71 | .BR arm4_conf (5) |
|---|
