FAXMODEM(8)

💖 FAXMODEM — NAME 💖

faxmodem — dynamically add a modem to a HylaFAX server system ✨

okay bestie, this is the glow-up tool that slides a modem into your HylaFAX server's DMs and tells everyone it's ready. let's go 💅

---

🦋 SYNOPSIS 🦋

/usr/sbin/faxmodem [ -q queue-dir ] [ -c capabilities ] [ -p ] [ -P ] [ -u priority ] modem

---

✨ DESCRIPTION ✨

So like, faxmodem sends a message to the HylaFAX queuer process faxq(8) being like "hey queen, this modem is ready for use 💅" and it also tells it all about that modem's fax-related capabilities. This is literally the mechanism by which modems get added in a send-only configuration. no cap.

Once a modem has been configured, its status can be reconfigured using the faxstate(8) program. And faxmodem can also be used to alter the capabilities and usage priority of a previously configured modem. it's giving multitasking main character energy 👑

The specified modem is either the terminal device name where the modem is attached, or a HylaFAX device identifier (peep hylafax-config(5) for the tea on device identifiers 🫖). Device names may be given without a leading directory pathname — like, ttyf2 instead of /dev/ttyf2. short and cute, we love that for us.

🌸 figuring out what your modem can do 🌸

To figure out the capabilities of a modem, either use the probemodem(8) script or manually communicate with the modem. Like, talk to it. it won't bite.

For a Class 2 modem, the capabilities are given in the response to the AT+FDCC=? query command, and for a Class 2.0 modem it's the AT+FCC=? command.

To check if a modem is capable of polled retrieval of documents, use AT+FSP=? for a Class 2.0 modem or AT+FSPL=? for a Class 2 modem. If 1 is indicated in the response, then the modem supports polling 🎉

For example:

hyla% cu -l ttyf2
Connected
at+fclass=2.0
OK
at+fcc=?
(0,1),(0-5),(0-2),(0-2),0,0,0,(0-7)
OK
at+fsp=?
(0,1)
OK

In this case the modem would be added using the command:

/usr/sbin/faxmodem -c '(0,1),(0-5),(0-2),(0-2),0,0,0,(0-7)' ttyf2

(by default polling is assumed to be supported 😌)

💜 class 1 modems hit different 💜

Class 1 modems require a different technique, bestie. The host implements most of the fax protocol, so all that is needed is to identify the possible signalling rates the modem supports for transmitting. This is done with the AT+FTM=? command.

For example:

hyla% cu -l ttyf2
Connected
at+fclass=1
OK
at+ftm=?
24,48,72,73,74,96,97,98,121,122,145,146
OK

In this case the modem supports 2400, 4800, 7200, 9600, 12200, and 14400 bps signalling rates, so the modem would be added using:

/usr/sbin/faxmodem -c '(0,1),(0-5),(0-2),(0-2),(0,1),0,0,(0-7)' ttyf2

ate. periodt. 🍓

---

🎀 OPTIONS 🎀

The following options are available:

• -c — Specify the fax capabilities using the syntax defined by the Class 2 specification: (vr),(br),(wd),(ln),(df),(ec),(bf),(st). where, vr specifies vertical resolution, br specifies bit rate, wd specifies page width, ln specifies page length, df specifies data compression, ec specifies error correction, bf specifies binary file transfer, and st specifies scan time/line. and each of the above specifications is a range or list of numbers that defines the exact capabilities of the modem. For example, the default capabilities are (0,1),(0-3),(0-4),(0-2),(0),(0),(0),(0-7) which specifies the modem is capable of sending and receiving both low and high resolution facsimile with a variety of page sizes; supports signalling rates 0-3 (2400 bps through 9600 bps); supports only 1D-encoded data compression; and does not support error correction or binary file transfer. A modem's ability to support polled retrieval of facsimile is specified separately with the -p and -P options. ikyk 😌
• -p — Specify the modem is not capable of polling for remote documents. 🙈
• -P — Specify the modem is capable of polling for remote documents (default). 💖
• -q dir — Use a spooling area other than /var/spool/hylafax. moving out, we love a change of scenery ✨
• -u priority — Assign the specified priority to the modem when scheduling it for outbound use. Modem priorities are numbers in the range [0..255] with lower numbers meaning higher priority. Modems are initially assigned priority 255. so like, 0 is the VIP line and 255 is the "you're on the waitlist bestie" tier 🫶

---

🌈 FILES 🌈

• /var/spool/hylafax — default spooling area
• /var/spool/hylafax/FIFO — fifo for contacting faxq

Consult hylafax-server(5) for a complete discussion of the structure and content of the spooling area. it's a whole vibe, go read it 📚

---

👑 SEE ALSO 👑

hylafax-server(5), faxgetty(8), faxq(8).

---

and that's the whole page bestie!! this one's from the System Manager's Manual, dated Oct 27, 1995 — yeah she's vintage, she's iconic, she's still slaying 💅✨ go add some modems fr fr 💖🦋🌸