HFAXD(8)

💖 NAME 💖

hfaxd — the HylaFAX client-server protocol server, bestie. she's the one holding it all down. 🫶

---

🌸 SYNOPSIS 🌸

/usr/sbin/hfaxd [ -d ] [ -q dir ] [ -o port ] [ -O ] [ -l bindaddress ]
[ -i port ] [ -I ] [ -s port ] [ -S ]

---

✨ DESCRIPTION ✨

okay so hfaxd is the HylaFAX program that runs the server side of two whole things, no cap:

• the client-server protocol, and
• the Simple Network Paging Protocol (SNPP), which is what you use to submit message pager jobs to the IXO/TAP and UCP support. 📟

more client-server protocols are planned, and hfaxd is literally designed to be the ``carrier'' that carries them all. main character energy, honestly.

now, hfaxd usually gets used one of two ways. either:

1. as a standalone process started at system boot time, just chilling and listening for client connections on one or more ports — and if that's the vibe, you must use the -i, -o, or -s option, fr fr. or
2. as a subservient process to the inetd(8) program. 🙇

and yes you can combine both forms!! as long as the same service isn't being provided by the standalone hfaxd and through inetd at the same time. that would be messy. don't do that. 😭

---

🦋 HYLAFAX (NEW) CLIENT-SERVER PROTOCOL SUPPORT 🦋

if hfaxd is started with the -i option, she'll service clients using the HylaFAX client-server protocol. and this protocol is strongly related to the Internet File Transfer Protocol (FTP) — like, so much so that FTP client programs with support for ``quoted commands'' can be used to talk to hfaxd with the new protocol. iconic. 💅

(it should also be possible to use FTP-aware World Wide Web browsers such as Mosaic and Netscape Navigator to access HylaFAX servers through the new protocol — but the current format for information returned in directory listings confuses them. 💀 so, like, good luck with that one.)

the hfaxd server currently recognizes the following protocol requests. case is not distinguished. and entries marked with a ¹ can only be used when the client has established administrative privileges with ADMIN. 👑

• ABOR — abort previous command
• ACCT — specify account (ignored)
• ADMIN — specify password for administrative privileges
• ALLO — allocate storage (vacuously)
• ANSWER¹ — request that call be answered
• APPE — append to a file
• CDUP — change to parent of current working directory
• CHMOD — change mode of a file
• CHOWN¹ — change owner of a file
• CWD — change working directory
• DELE — delete a file
• DISABLE¹ — disable outbound use of modem
• ENABLE¹ — enable outbound use of modem
• HELP — give help information
• FILEFMT — specify/query format for returning file status
• FILESORTFMT — specify/query format for sorting file status listing
• FORM — specify data transfer format
• IDLE — set idle-timer (in seconds)
• JDELE — delete done or suspended job
• JINTR — interrupt job
• JKILL — kill job
• JNEW — create new job
• JOB — set/query current job
• JOBFMT — specify/query format for returning job status
• JOBSORTFMT — specify/query format for sorting job status listing
• JPARM — specify/query job state parameter
• JREST — reset current job state
• JSUBM — submit job to scheduler
• JSUSP — suspend job from scheduling
• JWAIT — wait for job to complete
• JGDELE — delete group of jobs
• JGKILL — kill group of jobs
• JGINTR — interrupt group of jobs
• JGNEW — place current job in a new job group
• JGPARM — set state parameter in a group of jobs
• JGREST — reset current state for a group of jobs
• JGRP — set/query current job group
• JGSUBM — submit group of jobs to scheduler
• JGSUSP — suspend group of jobs from scheduling
• JGWAIT — wait for group of jobs to complete
• LIST — list files in a directory
• MDTM — show last modification time of file
• MODE — specify data transfer mode
• MDMFMT — specify/query format for returning modem status
• MDMSORTFMT — specify/query format for sorting modem status listing
• NLST — give name list of files in directory
• NOOP — do nothing
• PASS — specify password
• PASV — prepare for server-to-server transfer
• PORT — specify data connection port
• PWD — print the current working directory
• QUIT — terminate session
• RCVFMT — specify/query format for returning received facsimile status
• RCVSORTFMT — specify/query format for sorting received facsimile status listing
• REIN — reinitiate server state
• REST — restart incomplete transfer
• RETP — retrieve the next page in a file
• RETR — retrieve a file
• SHUT — schedule server shutdown
• SITE — non-standard commands (see next section)
• SIZE — return size of file
• STAT — return status of server or file
• STOR — store a file
• STOT — store a temporary file with a unique name
• STOU — store a file with a unique name
• STRU — specify data transfer structure
• SYST — show operating system type of server system
• TYPE — specify data transfer type
• TZONE — specify timezone handling for dates and times
• USER — specify user name
• VRFY — verify dialstring handling and/or least-cost routing

and then the following non-standard or experimental commands get supported through the SITE request. 🧚

• ADDMODEM¹ — add/configure new modem for use
• ADDUSER¹ — add client access control entry
• CONFIG¹ — send configuration parameter setting to server
• DELMODEM¹ — deconfigure/remove modem
• DELUSER¹ — remove client access control entry
• TRIGGER — register realtime event trigger
• HELP — give help information, e.g., SITE HELP

and also: FTP requests that are specified in Internet RFC 959 but not listed here are recognized — but not implemented. she sees them. she's just not doing anything about it. 🙈

oh and one more thing, this is important. the hfaxd server will abort an active data transfer only when the ABOR command is preceded by a Telnet "Interrupt Process" (IP) signal and a Telnet "Synch" signal in the command Telnet stream, as described in Internet RFC 959. and if a STAT command is received during a data transfer — again, preceded by a Telnet IP and Synch — transfer status will be returned. ⭐

---

🎀 SIMPLE NETWORK PAGING PROTOCOL (SNPP) SUPPORT 🎀

if hfaxd is started with the -s option, she'll service clients using the Simple Network Pager Protocol (SNPP) as specified in RFC 1861 — which, btw, obsoletes RFC 1645. ✨

the hfaxd server currently recognizes the SNPP protocol requests listed below. requests marked with a ¹ are non-standard extensions to RFC 1861 that may be added to SNPP at some future time. case is not distinguished, and only the first four characters of requests are used in identifying commands. iykyk. 💅

• 2WAY — preface a 2-way transaction
• ABOR¹ — abort previous command
• ACKR — set read acknowledgement handling for subsequent requests
• ALER — set the alter-level for subsequent requests
• CALL — set the caller-ID for subsequent requests
• COVE — set the alternate coverage area for subsequent requests
• DATA — specify a multi-line message
• EXPT — set the expiration time for subsequent requests
• HELP — give help information
• HOLD — set the time at which subsequent requests are to be delivered
• KTAG — kill a previously submitted request
• LEVE — set the service level for subsequent requests
• LOGI — login to server
• MCRE — specify multiple response text and code
• MESS — specify a single-line message
• MSTA — return the status of a previously submitted request
• NOQU — disable message queueing
• PAGE — specify the destination pager
• PING — locate/validate a pager
• QUIT — terminate session
• RESE — reset server state
• RTYP — set the reply type code for subsequent requests
• SEND — send message(s)
• SITE¹ — site-specific commands (see next section)
• STAT¹ — return server status
• SUBJ — set the message text for subsequent requests

the hfaxd server will abort an active SEND operation when an ABOR command is preceded by a Telnet "Interrupt Process" (IP) signal and a Telnet "Synch" signal in the command Telnet stream. 🛑

and these following non-standard or experimental commands are also supported through the SITE request:

• FROMUSER — specify the sender's identity
• IDLE — set idle-timer (in seconds)
• JPARM — query job parameter status
• JQUEUE — control whether or not job is queued
• LASTTIME — set the time to terminate an unfinished job
• MAILADDR — set the e-mail address to use for notification
• MAXDIALS — set the maximum number of times to dial the phone
• MAXTRIES — set the maximum number of times to try sending the page
• MODEM — set the modem or class of modems to use
• NOTIFY — set the e-mail notification
• RETRYTIME — set the time to delay between job retries
• SCHEDPRI — set the scheduling priority for the job
• HELP — give help information, e.g., SITE HELP

heads up bestie 🚨 — hfaxd requires that SNPP clients login first with the LOGI directive, while RFC 1861 permits clients to submit pages anonymously. so like. she's stricter than the spec. respect it. 👑

🔐 CLIENT ACCESS CONTROL 🔐

okay so here's the tea on who gets to talk to hfaxd at all. it controls client access based on whatever's chilling in /var/spool/hylafax/etc/hosts.hfaxd. that file is literally the guest list: it defines the set of users and machines that may receive service and, optionally, it defines password challenges to use in authenticating clients. 💖

so like, clients may be permitted access to services with or without a password challenge — your call. access may also be restricted based on the host machine that a request for service originates from, which is giving "we know where you live" energy. go read hosts.hfaxd(5) for the format and content of this file, iykyk. also there's the SITE ADDUSER protocol request, which is provided for adding new users to a server — and bestie, that one is available only to clients with administrative privileges. 💅

---

server resources are controlled based on clients' identities. jobs and documents, both received and submitted, are protected by the server. typically clients are permitted access to anything they own or that is publicly accessible. and then there are administrative privileges that clients may acquire, which permit them wide access to objects that reside on the server. main character privileges fr fr. 👑

ngl, a complete client-server protocol specification is still outstanding. we said what we said. 🙈

hfaxd operates with its root directory set to the top of the HylaFAX spooling area; /var/spool/hylafax. it does this so that clients see a virtual file hierarchy that is completely contained within the HylaFAX operating environment on the server machine — very demure, very contained. ✨ but administrators must be aware of this action when specifying files in the hfaxd configuration file: absolute pathnames relative to the root of the spooling should be used to specify filenames. do not come for me about this, it's just how it works. 😭

🚧 SERVER ACCESS CONTROL 🚧

the file /var/spool/hylafax/etc/shutdown, when present, specifies when to restrict access to a server machine. when this file is present and contains valid information, hfaxd will permit only users with administrative privileges to access the server. any other users that request service will be denied access, and negative server responses will include any shutdown message specified in the shutdown file. go read hylafax-shutdown(5) for the format and content of this file. 💖

the SHUT protocol request can be used to schedule a server shutdown; it is available only to clients with administrative privileges. to make a shutdown server available again, the shutdown file can be deleted with the DELE protocol request. (this is to be replaced with an ``unshut'' protocol request so that implementation details are not part of the protocol — yes that's literally what the docs say, we're not making this up.) 🫶

⚙️ CONFIGURATION FILES ⚙️

hfaxd reads configuration information from the file /etc/hylafax/hfaxd.conf each time a new server process is started (i.e. for each new client). this file uses the same conventions used by other HylaFAX configuration files; as described in hylafax-config(5). 🌸

the following configuration parameters are recognized; items marked ``(SNPP)'' are used only by the SNPP support. okay bestie, here's the whole roster, one by one, no skips: ✨

• AllowSortFormat — type: boolean, default: true — Allow client to request sorting formats
• FaxContact — type: string, default: see below — contact address to show in help text
• FileFmt — type: string, default: see below — format string for file status results
• FileSortFmt — type: string, default: - — format string for sorting file status listing
• IdleTimeout — type: integer, default: 900 — client idle timeout in seconds
• JobFmt — type: string, default: see below — format string for job status results
• JobSortFmt — type: string, default: - — format string for sorting job status listing
• JobProtection — type: octal, default: 0444 — permissions for job qfiles in sendq/doneq
• KillTimeMap — type: string, default: see below — mapping from service level to job kill time (SNPP)
• LogFacility — type: string, default: daemon — syslog facility name for tracing messages
• MaxAdminAttempts — type: integer, default: 5 — maximum admin attempts before disconnecting
• MaxConsecutiveBadCmds — type: integer, default: 10 — maximum invalid commands before disconnecting
• MaxIdleTimeout — type: integer, default: 7200 — maximum client idle timeout permitted
• MaxLoginAttempts — type: integer, default: 5 — maximum login attempts before disconnecting
• MaxMsgLength — type: integer, default: 128 — maximum pager message length (SNPP)
• ModemFmt — type: string, default: see below — format string for modem status results
• ModemSortFmt — type: string, default: - — format string for sorting modem status listing
• PagerIDMapFile — type: string, default: /var/spool/hylafax/etc/pagermap — name of file for mapping pager IDs (SNPP)
• PriorityMap — type: string, default: see below — mapping from service level to job priority (SNPP)
• PublicJobQ — type: boolean, default: true — Allow public listing access to the sendq/doneq
• PublicRecvQ — type: boolean, default: true — Allow public listing access to the recvq
• RcvFmt — type: string, default: see below — format string for received facsimile status results
• RcvSortFmt — type: string, default: - — format string for sorting received facsimile status results listing
• RetryTimeMap — type: string, default: see below — mapping from service level to job retry time (SNPP)
• ServerTracing — type: integer, default: 1 — server tracing control vector
• ShutdownFile — type: string, default: /var/spool/hylafax/etc/shutdown — name of shutdown control file
• UserAccessFile — type: string, default: /var/spool/hylafax/etc/hosts.hfaxd — name of access control file
• XferLogFile — type: string, default: /var/spool/hylafax/etc/clientlog — name of file for logging client data transfers

the configuration parameters are explained below:

AllowSortFormat

this controls whether the server accept the *SORTFMT commands which the client issues to change the server sort the listings. yes, that sentence is a little wobbly, but that's the deal: it's the switch that says whether the server takes those client-issued *SORTFMT commands or not. 💅

FaxContact

the e-mail address to display as a point of contact in the help text returned to a client in response to the HELP or SITE HELP commands. by default this is ``FaxMaster@hostname'', where hostname is the fully qualified name for the machine where the server is running. 🎀

FileFmt

the format string to use when returning file status information with the LIST and STAT commands. formats are specified using printf(3S) style conventions but using the field identifiers listed below. each item can include field width, precision, left-justification, 0-filling, etc. just as for printf; e.g. %-8p for an 8-character wide, left-justified, blank-padded field containing the file protection flags. ok so the field identifiers, all of them: ✨

• a — Last access time
• c — Creation time
• d — Device number (octal)
• f — Filename
• g — Group identifier (decimal)
• i — Inode number (decimal)
• l — Link count (decimal)
• m — Last modification time
• o — Owner (based on file GID)
• p — Fax-style protection flags (no group bits)
• q — UNIX-style protection flags
• r — Root device number (octal)
• s — File size in bytes (decimal)
• u — User identifier (decimal)

the default format string is ``%-7p %3l %8o %8s %-12.12m %.48f''. it is recommended that all items include a field width so that client applications that construct headers from the format string can constrain the width of column title strings. do it for the column alignment, bestie. 📐

FileSortFmt

the format string to use when sorting the listing for directories using the LIST command. follows the FileFmt formatting rules. so same rules, different job. 🌈

IdleTimeout

the initial/default timeout to use in timing out idle clients. this value defines the maximum amount of time (in seconds) that hfaxd will wait for a command from a client before terminating the connection. unprivileged clients may alter the idle timeout up to the value of MaxIdleTimeout; privileged clients may set the timeout to any value. 👑

JobFmt

the format string to use when returning job status information for jobs in the sendq and doneq directories. formats are specified using printf(3S) style conventions but using the field identifiers listed below. each item can include field width, precision, left-justification, 0-filling, etc. just as for printf; e.g. %-3j for a 3-character wide, left-justified, blank-padded field containing the job state.

• A — Destination SubAddress
• B — Destination Password
• C — Destination company name
• D — Total # dials / maximum # dials
• E — Desired signalling rate
• F — Client-specific tagline format string
• G — Desired min-scanline time
• H — Desired data format
• I — Client-specified scheduling priority
• J — Client-specified job tag string
• K — Desired use of ECM
• L — Destination geographic location
• M — Notification e-mail address
• N — Desired use of private tagline (one-character symbol)
• O — Whether to use continuation cover page (one-character symbol)
• P — # pages transmitted / total # pages to transmit
• Q — Client-specified minimum acceptable signalling rate
• R — Destination person (receiver)
• S — Sender's identity
• T — Total # tries / maximum # tries
• U — Page chopping threshold (inches)
• V — Job done operation
• W — Communication identifier
• X — Job type (one-character symbol)
• Y — Scheduled date and time
• Z — Scheduled time in seconds since the UNIX epoch
• a — Job state (one-character symbol)
• b — # consecutive failed tries
• c — Client machine name
• d — Total # dials
• e — Public (external) format of dialstring
• f — # consecutive failed dials
• g — Group identifier
• h — Page chop handling (one-character symbol)
• i — Current scheduling priority
• j — Job identifier
• k — Job kill time
• l — Page length in mm
• m — Assigned modem
• n — E-mail notification handling (one-character symbol)
• o — Job owner
• p — # pages transmitted
• q — Job retry time (MM::SS)
• r — Document resolution in lines/inch
• s — Job status information from last failure
• t — Total # tries attempted
• u — Maximum # tries
• v — Client-specified dialstring
• w — Page width in mm
• x — Maximum # dials
• y — Total # pages to transmit
• z — Time to send job

Okay so the default format string is literally this:

%-4j %3i %1a %6.6o %-12.12e %5P %5D %7z %.25s

and bestie, that string is engineered 🎀 — it keeps every single status line under 80 characters. And here's the pro tip: give every item a field width, because client applications like faxstat(1) that build their headers out of the format string need to be able to constrain how wide those column title strings get. iykyk 💅

---

JobSortFmt 💖

The format string used when sorting the listing for jobs in the sendq and doneq directories. It follows the exact same formatting rules as JobFmt. Copy that energy, different job. ✨

JobProtection 🔐

The file mode setting for job qfiles in the HylaFAX queues (sendq and doneq). The default of `0644` lets all users view all the job parameters in the send/done queues. But if PublicJobQ is set to false, then this file mode is what decides the permissions clients get to see jobs — following the HylaFAX permission model where the group bits control uid permissions and the other bits control other permissions. It's giving layered security, honestly. 👑

KillTimeMap 💀

The mapping from SNPP service level (0-11) to job expiration time (aka kill time ⚰️). You specify a mapping as a string of space-separate numbers, where each value is the number of minutes you're willing to let a job run.

Default mapping:

5 5 5 15 60 240 720 1440 1440 1440 1440 1440

Which means: a job expires in 5 minutes for service levels 0-2, 15 minutes for level three, 60 minutes for level four, etc. ⏰

LogFacility 📝

The symbolic name for the syslog(3) facility to use when logging error messages and informational/debugging messages that were requested through the ServerTracing parameter. You'll find the list of facility names in the system include file <syslog.h> — and comparisons are case-insensitive. 🌈

MaxAdminAttempts 🚫

The maximum number of unsuccessful attempts to gain administrative privileges with the ADMIN command that hfaxd will allow a client before it terminates the connection. Note that the count of attempts gets reset if/when the client successfully gains administrative privileges. So like, no farming the counter, bestie. 💅

MaxConsecutiveBadCmds 😭

The maximum number of consecutive unrecognized, unimplemented, syntactically incorrect, or otherwise straight-up unacceptable commands allowed before the connection gets terminated. This control has two purposes:

• to handle naive or malicious clients that send long streams of nonsense commands at a server, and
• to insure that clients are forcibly terminated when a server is marked shutdown.

Not me protecting the server from the group chat spam. 🛡️

MaxIdleTimeout 🦋

The maximum value a client is allowed to set the idle timeout to. This value is not enforced if the client has administrative privileges. Main character privileges, fr fr. 👑

MaxLoginAttempts 🔑

The maximum number of unsuccessful attempts to login with the USER and PASS commands that hfaxd will permit a client before terminating the connection. Three strikes but make it authentication. ⚡

MaxMsgLength 📏

The maximum number of characters to accept in a pager message specified with the DATA or MESS commands. Messages longer than this value are rejected. Keep it short, keep it cute. ✂️

ModemFmt 🌸

The format string to use when returning modem status information for modems listed in the status directory. Formats use printf(3S) style conventions, but with the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just like printf does — e.g. %-8h gives you an 8-character wide, left-justified, blank-padded field holding the name of the host the server is running on. 💖

• h — Server hostname
• l — Local identifier string
• m — Canonical modem name
• n — FAX phone number
• r — Maximum pages that can be received in a single call
• s — Status information string
• t — Server and session tracing levels (xxxxx:yyyyy)
• v — Modem speaker volume as one-character symbol
• z — A * if a faxgetty(8) process is running; otherwise (space)

The default format string is `Modem %m (%n): %s`. Iconic, honestly. ✨

ModemSortFmt 🎀

The format string to use when sorting the listsin for modem status information in the status directory. 🌀

PagerIDMapFile 📟

The absolute pathname</> of the file that contains directions for mapping pager identifiers to IXO/TAP or UCP service providers (and optionally a pager identification number). Go consult pagermap(5) for the tea on the format and content of this file.

Heads up bestie: absolute pathnames here are relative to the root of the spooling area. Don't get caught out. 🫶

PriorityMap ⭐

The mapping from SNPP service level (0-11) to job scheduling priority. You write it as a string of space-separate numbers, where each value is the priority assigned to a job.

Default mapping:

63 127 127 127 127 127 127 127 127 127 127 127

Which hands a high priority to service level zero and normal (default) priority to all the other service levels. Level zero said "I'm the moment." 🔥

PublicJobQ 👀

By default, HylaFAX has always made the listings of the sendq/doneq include all jobs to any client connected to hfaxd. Set this to false and hfaxd will also enforce its normal access restrictions on the listing of jobs in the sendq/doneq.

These access restrictions are based on:

• the file mode (see JobProtection), and
• the logged in uid (see hosts.hfaxd)

Locking it down, periodt. 🔒

PublicRecvQ 📬

Same deal, different queue: by default HylaFAX has always made the listings of the recvq include all faxes to any client connected to hfaxd. Set this to false and hfaxd will also enforce its normal access restrictions on the listing of faxes in the recvq.

These access restrictions are based on:

• the file mode faxgetty (and its related FaxDispatch) set for the fax, and
• the logged in uid (see hosts.hfaxd)

Two queues, one vibe check. ✅

RcvFmt 💌

The format string to use when returning status information for received facsimile in the recvq directory. Formats use printf(3S) style conventions, but with the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just as for printf — e.g. %-3b gives you a 3-character wide, left-justified, blank-padded field holding the signalling rate. 🦋

• a — SubAddress received from sender (if any)
• b — Signalling rate used during receive
• d — Data format used during receive
• e — Error description if an error occurred during receive
• f — Document filename (relative to the recvq directory)
• h — Time spent receiving document (HH:MM:SS)
• l — Page length in mm
• m — Fax-style protection mode string (`-rwxrwx`)
• n — File size (number of bytes)
• o — File owner
• p — Number of pages in document
• q — UNIX-style protection flags
• r — Resolution of received data
• s — Sender identity (TSI)
• t — Compact representation of the time when the receive happened
• w — Page width in mm
• z — A * if receive is going on; otherwise (space)

…and the default format string is ``%-7m %4p%1z %-8.8o %14.14s %7t %f''. That string keeps every status line under 80 characters, bestie — it's a whole aesthetic constraint ✨. And it's highly recommended that every item in your format string carries a field width, because client apps like faxstat(1) build their column headers straight out of that format string, and they need to know how wide to make the titles. iykyk 💅

🎀 Configuration Parameters (cont'd) 🎀

• RcvSortFmt — the format string used when sorting the listing of received facsimile in the recvq directory. It follows all the same RcvFmt formatting rules, no cap 💖
• RetryTimeMap — this one's a whole vibe check on SNPP service levels (0-11) mapped to job retry time. You write it as a string of space-separated numbers, where each value is how many seconds to delay between delivery attempts. A value of 0 means "nah, just schedule retries with the default algorithm the HylaFAX job scheduler already uses". The default mapping is:

30 60 60 180 0 0 0 0 0 0 0 0

which literally means: a level 0 job gets retried after a 30 second delay, levels 1 and 2 after 60 seconds, level 3 after 3 minutes, and every other job gets retried the usual scheduling-algorithm way. iconic 🦋

• ServerTracing — a number that controls how much tracing info a server generates. Different areas of operation are controlled individually, so if you want tracing for multiple areas, you bit-or the flag for each area together to build the value for this tag 🌈
  • 1 (0x00001) — General server operation
  • 2 (0x00002) — Client-server protocol requests and responses
  • 4 (0x00004) — File transfers from client to server
  • 8 (0x00008) — File transfers from server to client
  • 16 (0x00010) — Client logins
  • 32 (0x00020) — All network connections
  • 64 (0x00040) — FIFO messages to and from faxq(8)
  • 128 (0x00080) — TIFF Library errors and warnings
  • 256 (0x00100) — Configuration file processing

Tracing messages get sent off to syslog(3) using whatever facility you set with the LogFacility configuration parameter. Heads up though: syslogd(8) has to be configured to actually capture facility.info, facility.debug, facility.warning, and facility.err messages, or your traces just vanish into the void 😭

• ShutdownFile — the absolute pathname of the server shutdown file. Peep hylafax-shutdown(5) for the format and content deets. (Note that absolute pathnames are relative to the root of the spooling area — yes, that's the rule, don't come for me 🙈)
• UserAccessFile — the absolute pathname of the user access control file. See hosts.hfaxd(5) for the format and content. (Same note: absolute pathnames are relative to the root of the spooling area.)
• XferLogFile — the absolute pathname of the file used for logging client-server file transfers (and that only kicks in when you've enabled it through the ServerTracing parameter). (Yep — absolute pathnames are relative to the root of the spooling area.)

---

✨ OPTIONS ✨

• -q dir — treat the specified directory as the spooling area. The default spooling area, /var/spool/hylafax, gets baked in at the time the software is built 🍓
• -d — stops hfaxd from detaching itself from the controlling terminal. Normally you'd only use this when running hfaxd under a debugger, or when hfaxd gets started up from the inetd(8) process 🫶
• -l bindaddress — bind the tcp port to the specified bindaddress. But listen: this argument has to be specified before the -i, otherwise it just gets ignored, periodt 💀. A better approach for improving security would be to run hfaxd from xinetd and bind its service to the specific port — that also lets HylaFAX benefit from tcp wrappers and all the other options xinetd provides 👑
• -i port — listen on the specified port for service requests and respond with the client-server protocol. The port can be symbolic, e.g. ``hylafax'', or numeric. You can specify this flag multiple times to request service on multiple different ports. Each time you specify it, it listens on that port bound to the last -l bindaddress you gave it. If no -l bindaddress was specified, it binds to the system configured default wildcard address — which could be IPv6, or IPv4, or both, no promises 🌐
• -s port — listen on the specified port for service requests and respond with the Simple Network Paging (SNPP) protocol. The port can be symbolic, e.g. ``snpp'', or numeric. This flag can also be specified multiple times to request service on multiple different ports 📟
• -I — service the client-server protocol using standard input and output. Super useful when hfaxd is started up by inetd(8) 💜
• -S — service the Simple Network Paging (SNPP) protocol using standard input and output. Also super useful when hfaxd is started up by inetd(8) ✨

---

🩺 DIAGNOSTICS 🩺

Diagnostics generated by hfaxd are logged using syslog(3). That's the whole thing, bestie 🌸

---

📂 FILES 📂

• /etc/hylafax/hfaxd.conf — server configuration file
• /var/spool/hylafax — spooling area
• /var/spool/hylafax/FIFO — for submitting the job
• /var/spool/hylafax/sendq — where job description is placed
• /var/spool/hylafax/sendq/seqf — for assigning job identifiers
• /var/spool/hylafax/docq/seqf — for assigning document identifiers
• /var/spool/hylafax/tmp — temporary location of job-related files
• /var/spool/hylafax/docq — where document files are placed
• /var/spool/hylafax/recvq — where received facsimile are found
• /var/spool/hylafax/archive — where archived jobs are placed
• /var/spool/hylafax/log — for server log files
• /var/spool/hylafax/client — for FIFO files used in communicating with faxq
• /var/spool/hylafax/status — for server status information
• /var/spool/hylafax/config.device — for returning server status
• /var/spool/hylafax/etc/hosts.hfaxd — host access control list
• /var/spool/hylafax/etc/shutdown — server shutdown control
• /var/spool/hylafax/etc/pagermap — SNPP pager ID mapping file

---

💀 BUGS 💀

To be filled in. (The most relatable section in any manpage fr fr 😭 not me writing "TODO: bugs" and calling it documentation 💅)

---

👀 SEE ALSO 👀

sendfax(1), sendpage(1), faxalter(1), faxrm(1), faxstat(1), faxq(8), syslog(3) hylafax-server(5), hosts.hfaxd(5), status(5), hylafax-shutdown(5),

---

And that's a wrap on the whole page, bestie 🎀 this one's from the July 12, 1996 era, part of the HylaFAX HFAXD(8) manual — go forth and fax responsibly, you absolute icon 👑✨