XFERFAXSTATS(8)

✨ XFERFAXSTATS(8) ✨

ok so bestie, this is a page from the System Manager's Manual and it's all about xferfaxstats, the little script that does your HylaFAX fax math for you 💅

---

🌸 NAME 🌸

xferfaxstats — summarize HylaFAX transmission accounting

---

🎀 SYNOPSIS 🎀

/usr/sbin/xferfaxstats [ options ] [ files ]

---

🦋 DESCRIPTION 🦋

xferfaxstats is a command script that prints out a whole summary of the HylaFAX accounting statistics for jobs that got transmitted. Think of it as the receipts for your faxes, but make it cute 📊

You can sort those stats by a bunch of different keys:

• the sender's account name (this is the default, the main character)
• the job tag (lowkey perfect when you're doing 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

The stats get read from the file /var/spool/hylafax/log/xferfaxlog in the spooling area — unless you pass filenames on the command line, in which case those win, periodt.

Here's what the output looks like, bestie (this example is using the default sort key):

Destination            Pages   Time      Pg/min   Errs   TypRate   TypData
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

Okay so let's decode this table together 🔍

• The first column shows the sort key value that was used. In this example it's the sender's identity, but otherwise it could be the destination phone number, the remote CSI, etc. etc.
• The Pages column = the total number of good pages transmitted. slay.
• The Time column = the total amount of time spent transmitting.
• The Pg/min column = the average transfer rate.
• The Errs column = how many errors were encountered while transmitting facsimile. (heads up: this stat does not include problems that happened while placing a call — like busy signals, for example. so don't come for it 🙈)
• The TypRate column = the most common communication speed the facsimile were transmitted with.
• The TypData column = the most common data format the facsimile data were transmitted in.

Now, about account names 💜 Account names that aren't root and guest can get automatically mapped to a canonical format — one where the host name is stripped off and identical addresses in the same domain get merged together (this is the NIS environments situation, iykyk). For example, sam@flake.asd.sgi.com and sam@foobar.asd.sgi.com both get mapped to sam@asd.sgi.com, and their associated statistics get accumulated together. But identical account names in different domains throw a warning; e.g. loki@wpd.sgi.com and loki@corp.sgi.com. And bestie, listen: that mapping above only happens if you specify the -map option. By default, account names are not altered. no cap.

---

💅 OPTIONS 💅

• -age days — only show info for the facsimile transmitted in the last however-many days you specified.
• -csi* — sort the output by the remote party's CSI.
• -dest* — sort the output by the phone number that got called.
• -dev* — sort the output by the output device (i.e. modem) that was used.
• -format — sort the output by the negotiated data format.
• -job* — sort the output by client-specified job tag identifiers.
• -nomap — do not do the account name mapping (the one that merges statistics for the root and guest accounts and strips the leading hostname part off domain names). This is the default behavior.
• -map — do the account name mapping (the one that merges statistics for the root and guest accounts and strips the leading hostname part off domain names).
• -send* — sort the output by the sender's account name (default).
• -since time — only show info for the facsimile transmitted since the specified time; where time is of the form MM/DD/YY HH:MM (that's the date(1) format string %D %H:%M).
• -end time — only show info for the facsimile transmitted before the specified time; where time is of the same form as since.
• -speed — sort the 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. awkward 💀
• Warning, weird user address/name "%s". — during address mapping, an address was encountered that has 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(8) -f option. So be cautious — do not use this field for auditing if the fax user base isn't trusted. fr fr, that's a real one.

---

🍓 FILES 🍓

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

---

🌈 SEE ALSO 🌈

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

---

and that's the whole page, bestie 💖 this little gem dropped on May 12, 1996 and it's still giving XFERFAXSTATS(8) energy — go read your logs and slay ✨🫶