.\" $Id$ .\" .\" HylaFAX Facsimile Software .\" .\" Copyright (c) 1993-1996 Sam Leffler .\" Copyright (c) 1993-1996 Silicon Graphics, Inc. .\" HylaFAX is a trademark of Silicon Graphics .\" .\" Permission to use, copy, modify, distribute, and sell this software and .\" its documentation for any purpose is hereby granted without fee, provided .\" that (i) the above copyright notices and this permission notice appear in .\" all copies of the software and related documentation, and (ii) the names of .\" Sam Leffler and Silicon Graphics may not be used in any advertising or .\" publicity relating to the software without the specific, prior written .\" permission of Sam Leffler and Silicon Graphics. .\" .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. .\" .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE .\" OF THIS SOFTWARE. .\" .if n .po 0 .ds Fx \fIHyla\s-1FAX\s+1\fP .TH XFERFAXSTATS 8 "May 12, 1996" .SH NAME xferfaxstats \- summarize \*(Fx transmission accounting .SH SYNOPSIS .B /usr/sbin/xferfaxstats [ .I options ] [ .I files ] .SH DESCRIPTION .I xferfaxstats is a command script that prints a summary of the \*(Fx accounting statistics for transmitted jobs. The statistics can be sorted using one of several keys: the sender's account name (default), the job tag (useful when used for accounting purposes), the remote party's \s-1CSI\s+1, the called phone number, the output device used for the call, the communication speed, and the communication data format. Statistics are read from the file .B /var/spool/hylafax/log/xferfaxlog in the spooling area, unless filenames are specified on the command line. .PP The following table is an example of the output from .I xferfaxstats (using the default sort key): .sp .5 .nf .ta \w'richardn@mfg.sgi.com 'u +\w'Pages 'u +\w'25:49:13 'u +\w'Pg/min 'u +\w'Errs 'u +\w'TypRate 'u \fBDestination Pages Time Pg/min Errs TypRate TypData\fP cadsmith@esd.sgi.com 34 24:05 1.4 0 9600 1-D MH ctb@corp.sgi.com 32 20:43 1.5 2 9600 2-D MR edmark@esd.sgi.com 42 29:30 1.4 3 9600 1-D MH fredc@mfg.sgi.com 157 1:37:52 1.6 0 9600 2-D MR jlw@engr.sgi.com 81 57:29 1.4 1 9600 1-D MH jlw@wpd.sgi.com 346 3:57:57 1.5 100 9600 1-D MH karlton@asd.sgi.com 68 36:57 1.8 0 9600 1-D MH kerrie@mfg.sgi.com 48 32:29 1.5 1 9600 2-D MR kgraf@mfg.sgi.com 128 1:48:21 1.2 2 9600 1-D MH kubey@wpd.sgi.com 264 3:22:13 1.3 6 9600 1-D MH loki@wpd.sgi.com 205 2:56:45 1.2 5 9600 2-D MR moondog@esd.sgi.com 112 1:23:01 1.3 4 9600 2-D MR mpolen@mti.sgi.com 122 1:39:32 1.2 1 9600 1-D MH nancyf@mfg.sgi.com 174 2:08:44 1.4 2 9600 2-D MR paulh@mfg.sgi.com 56 1:29:24 0.6 0 9600 2-D MR richardn@mfg.sgi.com 34 24:42 1.4 1 9600 1-D MH rosa@corp.sgi.com 32 28:00 1.1 2 9600 1-D MH sam@asd.sgi.com 65 46:25 1.4 5 9600 1-D MH seth@asd.sgi.com 34 25:04 1.4 0 9600 1-D MH -------------------------------------------------------------------------- Total 2034 25:49:13 1.3 135 .sp .5 .fi The first column column shows the sort key value used (the sender's identity here, but otherwise the destination phone number, remote \s-1CSI\s+1, etc.). The .I Pages column is the total number of good pages transmitted. The .I time column shows the total amount of time spent transmitting. The .I Pg/min column displays the average transfer rate. The .I Errs column indicates how many errors were encountered while transmitting facsimile. (Note that this statistic does not include problems encountered while placing a call; e.g. busy signals.) The .I TypRate column displays the most common communication speed with which facsimile were transmitted. The .I TypData column shows the most common data format in which facsimile data were transmitted. .PP Account names other than ``root'' and ``guest'' can be automatically mapped to a canonical format in which the host name is removed and identical addresses in the same domain are merged together (i.e. for NIS environments). For example, ``sam@flake.asd.sgi.com'' and ``sam@foobar.asd.sgi.com'' are both mapped to ``sam@asd.sgi.com'' with the associated statistics accumulated. Identical account names in different domains generate a warning; e.g. ``loki@wpd.sgi.com'' and ``loki@corp.sgi.com''. The above mapping is done only if the .B \-map option is specified, by default account names are not altered. .ne 1i .SH OPTIONS .TP 12 .BI \-age " days" Show information only for the facsimile transmitted in the last specified number of .IR days . .TP 12 .B \-csi* Sort output by the remote party's .SM CSI. .TP .B \-dest* Sort output by the phone number called. .TP .B \-dev* Sort output by the output device (i.e. modem) used. .TP .B \-format Sort output by the negotiated data format. .TP .B \-job* Sort output by client-specified job tag identifiers. .TP .B \-nomap Do not perform the account name mapping by which statistics for the ``root'' and ``guest'' accounts are merged and leading hostname part of domain names are stripped. This is the default behavior. .TP .B \-map Perform the account name mapping by which statistics for the ``root'' and ``guest'' accounts are merged and leading hostname part of domain names are stripped. .TP .B \-send* Sort output by sender's account name (default). .TP 12 .BI \-since " time" Show information only for the facsimile transmitted since the specified .IR time ; where .I time is of the form ``MM/DD/YY HH:MM'' (the .IR date (1) format string %D %H:%M). .TP 12 .BI \-end " time" Show information only for the facsimile transmitted before the specified .IR time ; where .I time is of the same form as .B since. .TP .B \-speed Sort output by the signalling rate. .SH DIAGNOSTICS .PP ``\fBWarning, address clash, "%s" and "%s".\fP'' During address mapping two mapped addresses were found for the same account name. .PP ``\fBWarning, weird user address/name "%s".\fP'' During address mapping an address was encountered that multiple ``@'' symbols in it. .SH NOTES The sender field does not necessarily represent the submitter's actual identity. For example, it reflects the value given by the .IR sendfax (8) ``-f'' option. Be cautious that this field is not utilized for auditing if the fax user base is not trusted. .SH FILES .nf .ta \w'/var/spool/hylafax 'u /var/spool/hylafax spooling area log/xferfaxlog default file from which to read statistics .fi .SH "SEE ALSO" .IR faxq (8), .IR faxsend (8), .IR recvstats (8), .IR hylafax-log (5)