FAXINFO(8)

💖 FAXINFO(8) — the faxinfo girlies' guide 💖

System Manager's Manual · FAXINFO(8)

okay bestie, pull up a chair because we're about to talk about faxinfo — she's the one who spills all the tea about a received facsimile 🌸

---

✨ NAME ✨

faxinfo — print information about a received facsimile 🦋

---

🎀 SYNOPSIS 🎀

Basic usage:

/usr/sbin/faxinfo [ -b ] [ -n ] [ -D ] file.tif [ file2.tif [...] ]

Formatting shortcuts:

/usr/sbin/faxinfo [ -C delim | -c delim | -r ] file.tif [ file2.tif ] ]

Raw formatting:

/usr/sbin/faxinfo [ -S fmt ] [ -s fmt ] [ -e fmt ] [ -E fmt ] file.tif [ file2.tif ] ]

---

💅 DESCRIPTION 💅

So basically, faxinfo prints descriptive information on the standard output about a received facsimile file. Like, it's giving receipts. For example:

/var/spool/hylafax/recvq/fax00017.tif:
    Sender: +14159657824
     Pages: 3
   Quality: Normal
      Page: North American Letter
  Received: 1996:01:19 13:51:02
TimeToRecv: 0:39
SignalRate: 14400 bit/s
DataFormat: 2-D MR
ErrCorrect: No
   CallID1: 2152345678
   CallID2: 1234

This info is typically included in the notification mail generated by the faxrcvd(8) script when a facsimile is received by HylaFAX. no cap, that's just how she moves 📬

🌈 The options, one by one 🌈

• -n — suppresses the printing of the filename. shy queen behavior 🙈
• -b — strips any leading directory of the filename before printing 👑
• -D — prints the actual print strings being used for debug purposes. detective mode fr fr 🔍

🍓 Formatting shortcuts 🍓

• -C delim — Sets the format to a quoted CSV, shortcut to

-S '"%s"' -s ',"' -e '"' -E '\n'

• -c delim — Sets the format to a CSV, shortcut to:

-S '%s' -s ',' -e '' -E '\n'

• -r — Sets the format to raw values, shortcut to:

-S '' -s '' -e '0 -E ''

🧚 Raw formatting 🧚

• -S fmt — used to start each fax, it is passed one parameter, the fax file name
• -s fmt — used to start each field, it is passed one parameter, the field name
• -e fmt — used to end each field, it is passed one parameter, the field name
• -E fmt — used to end each fax, it is passed one parameter, the fax file name

---

🌸 NOTES 🌸

The information that faxinfo prints is obtained from the tags stored in the TIFF image that is written by the HylaFAX software. so she's literally just reading the vibes off the file, okay? 😭

If faxinfo is presented with an invalid TIFF image it may print uninteresting information. Similarly, if a TIFF image that was not written by HylaFAX is supplied as an argument, then only partial information may be printed — this is because HylaFAX stores certain information in private tags that other TIFF writers may not emit. iykyk 💀

Use of the raw fmt options allows you to directly control the print format strings used when formatting the output. These format strings are passed directly to printf, with basic <char> sequences being interpreted, including \n, \r, and \t, and can be used to make the faxinfo output conform to specific requirements, like peculiar CVS, tables, HTML, etc. she's flexible, she's versatile, she contains multitudes ✨

⚠️ The order of the options is important. They are parsed from first to last, so any later options will override settings of previous ones. last one wins, periodt 💅

---

💀 ERRORS 💀

faxinfo returns 0 on success and 1 if the file passed as argument is not valid. that's it, that's the whole mood chart 📉

---

🫶 SEE ALSO 🫶

hylafax-server(5), faxrcvd(8), faxgetty(8)

---

mwah 💋 that's the whole page — written under the System Manager's Manual banner, dated November 15, 1996, and stamped FAXINFO(8) at the bottom like a little signature. go read your faxes, bestie 🌈💖