FAXRM(1)

💅 FAXRM(1) — the "okay so delete that" era ✨

okay bestie, welcome to faxrm(1), from the General Commands Manual era (iykyk). This is your little go-to for yeeting jobs and documents off a HylaFAX server. Let's get into it 🎀

---

✨ NAME ✨

faxrm — remove a HylaFAX job or document from a server 🗑️💖

---

🌸 SYNOPSIS 🌸

faxrm [ -a ] [ -d ] [ -p pass[:adminpass] ] [ -u user ] [ -O config ] [ -v ] [ -h hostname ] id...

---

🦋 DESCRIPTION 🦋

okay so. faxrm removes one or more jobs or documents from a HylaFAX server. That's the whole vibe. 💅 And here's the iconic part: if a job that's about to be removed is currently being processed by a server, it gets aborted first. no half-deletes, no ghost jobs, periodt. ✨

An id is either a number that identifies a job (this is the default behavior, bestie) or — if you pass the -d option — a document pathname. Two completely different flavors of id, so know which one you're in.

Where do you even get these ids, you ask? literally so many places:

• Job identifiers are printed by sendfax(1) when jobs are queued for transmission. 🫶
• They can also be displayed with faxstat(1).
• The names of documents associated with outbound jobs can be seen by supplying the -f option to faxstat.
• Documents in the receive queue can be viewed with the -r option to faxstat.

Now, the permissions tea 🍓: unprivileged users can only remove jobs or documents that they own. Clients with administrative privileges can remove any job or document — see the -a option below, it's giving main character energy 👑.

Oh and also, the user name may be specified by the FAXUSER environment variable. 💜

---

🎀 OPTIONS 🎀

• -a — Use administrative privileges; faxrm will prompt for the password to set administrative privileges. 💅
• -d — Interpret each id as a document pathname. And the cute little detail: if a pathname does not begin with / then faxrm automatically prepends /docq/. 🩷
• -h host — Contact the server at the specified host. The host may be either a symbolic name or a network address. IPv6 addresses are given in [xx:xx::x]:port format. If no server is specified then If no -h option is supplied, faxrm uses the FAXSERVER environment variable to identify the HylaFAX server to contact. If this variable is not set, then faxrm checks for a setting in the configuration files (first in the per-user file and then in the system-wide file). If all of the above fails, then faxrm attempts to contact a server on the machine where it is run. it's a whole journey fr fr 😭
• -O config — Treat config as a configuration parameter specification that is interpreted after reading the configuration file. For example, -O Host:fax.example.com would set the Host configuration parameter to fax.example.com, overriding any setting in the configuration file. iconic override behavior ✨
• -p pass:adminpass — The login password and optionally the associated admin password (separated by a colon). If no password is given then the user will be prompted if one is required. If -a is used and no adminpass is given, then the user will be prompted for it. 🫶
• -u user — The login username to use in client-server communication protocol. If no user is given then the user will be prompted if one is required.
• -v — Trace the protocol messages to and from the server. ngl this one's for the girlies who love seeing the raw receipts 🔥

---

🌈 CONFIGURATION PARAMETERS 🌈

faxrm reads configuration information from the file /etc/hylafax/hyla.conf and then from the file ~/.hylarc. Configuration files follow the conventions described in hylafax-client(1). 💖

The following configuration parameters are recognized:

• Host — Type: string; Default: localhost; host to contact for service
• PassiveMode — Type: boolean; Default: false; whether or not to use passive mode
• Port — Type: integer; Default: 4559; port to use in contacting server
• Protocol — Type: string; Default: tcp; protocol to use in contacting server
• Timeout — Type: integer; Default: 3600; timeout in seconds waiting for server response
• Verbose — Type: boolean; Default: No; whether or not to enable protocol tracing

---

💜 The configuration parameters, explained 💜

The configuration parameters are explained below:

• Host — The host to contact for service. (Equivalent to the -h option.)
• PassiveMode — Whether or not to use passive mode in communication with the server.
• Port — The network port to contact for service. (Equivalent to the -h option.)
• Protocol — The name of the communication protocol to use when contacting a server. (Equivalent to the FAXSERVICE environment variable.)
• Timeout — The timeout, in seconds, to wait for a server response.
• Verbose — Control protocol tracing. (Equivalent to the -v option.)

---

💀 DIAGNOSTICS 💀

when it works, it tells you it worked, and honestly? we love a communicative tool 🫶

• Job %s removed. — A confirmation that the job was successfully removed from the sendq directory. ✨
• Job %s removed (from doneq). — A confirmation that the job was successfully removed from the done directory; the directory where jobs are placed once they are finished. 🎀
• %s removed. — A confirmation that the document was successfully deleted from the server. 💖

Additionally faxrm returns 0 when all jobs were successfully removed or 1 when one or more jobs couldn't be removed. 👑

no cap: 1 means something didn't get yeeted. check your ids, check your permissions, bestie. 😭

---

⭐ SEE ALSO ⭐

hylafax-client(1), sendfax(1), faxalter(1), faxstat(1), hfaxd(8C)

---

and that's the whole page, bestie 🦋 mwah 💋 this one's from the General Commands Manual, dated May 12, 1996 — like, vintage vintage, but the girlies still use it. stay slaying, and may all your jobs exit 0 💅✨🧚