XFERFAXSTATS(8C)

📦
version 7.0.11 · 5 versions
, in fedora 43, fedora 44

💖 XFERFAXSTATS 💖 (section 8C)

okay bestie, gather round, because xferfaxstats is literally the girl who does your fax accounting for you and she is so organized. 🎀

✨ NAME ✨

xferfaxstats — summarize HylaFAX transmission accounting

🌸 SYNOPSIS 🌸

/usr/bin/xferfaxstats [ options ] [ files ]

🦋 DESCRIPTION 🦋

xferfaxstats is a command script that prints a summary of the HylaFAX accounting statistics for transmitted jobs. No cap, it just reads the receipts and hands you the vibe check. 💅

You can sort those stats by one of several keys:

  • the sender's account name (this is the default, main character behavior)
  • the job tag (super useful when you're using it for accounting purposes)
  • the remote party's CSI
  • the called phone number
  • the output device used for the call
  • the communication speed
  • the communication data format

Statistics get read from the file /var/spool/hylafax/etc/xferfaxlog in the spooling area, unless you specify filenames on the command line. Then it reads those instead, periodt.

Here's an example of what the output looks like (using the default sort key), and it is honestly kind of iconic:

Destination            Pages   Calls   Time      Pg/min   Errs   TypRate   TypData
cadsmith@esd.sgi.com   34      41      24:05     1.4      0      9600      1-D MH
ctb@corp.sgi.com       32      42      20:43     1.5      2      9600      2-D MR
edmark@esd.sgi.com     42      53      29:30     1.4      3      9600      1-D MH
fredc@mfg.sgi.com      157     174     1:37:52   1.6      0      9600      2-D MR
jlw@engr.sgi.com       81      90      57:29     1.4      1      9600      1-D MH
jlw@wpd.sgi.com        346     411     3:57:57   1.5      100    9600      1-D MH
karlton@asd.sgi.com    68      71      36:57     1.8      0      9600      1-D MH
kerrie@mfg.sgi.com     48      58      32:29     1.5      1      9600      2-D MR
kgraf@mfg.sgi.com      128     130     1:48:21   1.2      2      9600      1-D MH
kubey@wpd.sgi.com      264     289     3:22:13   1.3      6      9600      1-D MH
loki@wpd.sgi.com       205     225     2:56:45   1.2      5      9600      2-D MR
moondog@esd.sgi.com    112     120     1:23:01   1.3      4      9600      2-D MR
mpolen@mti.sgi.com     122     129     1:39:32   1.2      1      9600      1-D MH
nancyf@mfg.sgi.com     174     180     2:08:44   1.4      2      9600      2-D MR
paulh@mfg.sgi.com      56      56      1:29:24   0.6      0      9600      2-D MR
richardn@mfg.sgi.com   34      30      24:42     1.4      1      9600      1-D MH
rosa@corp.sgi.com      32      30      28:00     1.1      2      9600      1-D MH
sam@asd.sgi.com        65      65      46:25     1.4      5      9600      1-D MH
seth@asd.sgi.com       34      30      25:04     1.4      0      9600      1-D MH
--------------------------------------------------------------------------
Total                  2034    2224    25:49:13  1.3      135

Let's decode those columns together, because this is the part where it gets good:

  • The first column shows the sort key value used (the sender's identity here, but otherwise it's the destination phone number, remote CSI, etc.).
  • Pages is the total number of good pages transmitted. good pages only, we don't count the messy ones. 🙈
  • Calls is the total number of calls placed.
  • Time shows the total amount of time spent transmitting.
  • Pg/min displays the average transfer rate.
  • Errs indicates how many errors were encountered while transmitting facsimile. ⚠️ Heads up: this statistic does not include problems encountered while placing a call, e.g. busy signals. So a busy signal is not counted here, bestie.
  • TypRate displays the most common communication speed with which facsimile were transmitted.
  • TypData shows the most common data format in which facsimile data were transmitted.

Now the fun part — account name mapping. 🌈

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. Slay, merging is self-care.

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 -map option is specified. By default, account names are not altered. iykyk.

💅 OPTIONS 💅

  • -age days — Show information only for the facsimile transmitted in the last specified number of days.
  • -csi* — Sort output by the remote party's CSI.
  • -dest* — Sort output by the phone number called.
  • -dev* — Sort output by the output device (i.e. modem) used.
  • -format — Sort output by the negotiated data format.
  • -job* — Sort output by client-specified job tag identifiers.
  • -nomap — Do not perform the account name mapping by which statistics for the root and guest accounts are merged and the leading hostname part of domain names are stripped. This is the default behavior.
  • -map — Perform the account name mapping by which statistics for the root and guest accounts are merged and the leading hostname part of domain names are stripped.
  • -send* — Sort output by sender's account name (default).
  • -since time — Show information only for the facsimile transmitted since the specified time; where time is of the form MM/DD/YY HH:MM (the date(1) format string %D %H:%M).
  • -end time — Show information only for the facsimile transmitted before the specified time; where time is of the same form as since.
  • -speed — Sort output by the signalling rate.

😭 DIAGNOSTICS 😭

  • ``Warning, address clash, "%s" and "%s".'' — During address mapping two mapped addresses were found for the same account name. 💀
  • ``Warning, weird user address/name "%s".'' — During address mapping an address was encountered that multiple @ symbols in it.

⭐ NOTES ⭐

The sender field does not necessarily represent the submitter's actual identity. For example, it reflects the value given by the sendfax(8C) -f option.

Be cautious that this field is not utilized for auditing if the fax user base is not trusted. 👀 fr fr, do not build your audit on this.

🎀 FILES 🎀

  • /var/spool/hylafax — spooling area
  • etc/xferfaxlog — default file from which to read statistics

🫶 SEE ALSO 🫶

faxq(8C), faxsend(8C), recvstats(8C), hylafax-log(5F)

and that's the whole page, bestie. xferfaxstats, page 8C, dated May 12, 1996 — the source/version line was XFERFAXSTATS(8C) at the bottom and honestly she ate. mwah 💋✨

📦 where this page comes from