FAXSETUP(8C)

πŸ“¦
version 7.0.11 Β· 5 versions
, in fedora 43, fedora 44

πŸ’– FAXSETUP πŸ’–

okay bestie, gather round, because we're talking about faxsetup from the 8C manual β€” that's section 8, system administration, and yes it's giving main character energy πŸŽ€

✨ NAME ✨

faxsetup β€” set up a machine so it can hang with HylaFAX πŸ’…


🌸 SYNOPSIS 🌸

/usr/bin/faxsetup [ -client ] [ -server ] [ -with-VAR[=value] ]

that's it. that's the whole vibe. she's interactive, she's a shell script, she's gonna ask you questions πŸ¦‹


πŸ’œ DESCRIPTION πŸ’œ

faxsetup is an interactive shell script and her whole job is doing the setup work needed to configure a client machine or a server machine for the HylaFAX software. she's the get-ready-with-me of the HylaFAX world, no cap.

⚠️ REAL TALK: faxsetup must be run on every HylaFAX server machine before the software will function. literally. if a HylaFAX server program or script gets invoked before faxsetup is run, the command will abort with a message that says to run faxsetup. so like... run her first. periodt. πŸ’€

faxsetup may optionally be run on a HylaFAX client machine to verify the configuration of the software β€” like a vibe check for your setup ✨

By default, faxsetup checks a machine for use as both a HylaFAX client and a server. overachiever behavior, we love to see it πŸ‘‘

🫢 Client-specific checks include:

  • the installation of client programs and data
  • the installation of the Adobe Font Metric (AFM) information files used by the HylaFAX text formatting support

πŸ”₯ Server-specific checks include:

  • the installation of server programs and data
  • the existence of the UUCP lock file directory
  • the installation of the TIFF software tools
  • the configuration of the getty programs invoked for data and voice calls
  • the pathnames for various system programs used by server shell scripts
  • proper support for FIFO special files
  • proper installation of a POSTSCRIPT RIP
  • definition of a ``fax'' user
  • definitions for the hylafax'' and snpp'' services
  • startup of the HylaFAX server processes: faxq(8C) and hfaxd(8C)
  • definition of a ``FaxMaster'' mail alias for reporting server problems

For server machines, faxsetup also creates two files that the HylaFAX command scripts literally require:

  1. one file contains master configuration parameters
  2. the other contains various definitions used by scripts such as faxaddmodem(8C) that communicate with modems

two files. both mandatory. it's giving "you literally cannot function without me" 🌈


πŸŽ€ OPTIONS πŸŽ€

  • -client β€” do client-specific consistency checks 🧚
  • -server β€” do server-specific consistency checks πŸ’ͺ
  • -with-VAR[=value] β€” override the default definition for the configuration parameter named VAR; optionally specifying a new value (and if no value is specified then yes'' is used). this one is *especially* useful to override the default settings for the POSTSCRIPT interpreter package to use (e.g. -with-PS=dps''), the spooling directory (-with-DIR_SPOOL=/mumble''), the directory where the tool applications of the TIFF software distribution are located (-with-TIFFBIN=/usr/freeware''), etc. a complete list of the possible parameters can be found by looking at the contents of the faxsetup shell script; many of these configuration parameters are also described in the HTML documentation πŸ“š
  • -help β€” print a help message and terminate πŸ™‹
  • -quiet β€” do not print verbose messages to the terminal 🀫
  • -verbose β€” print informative messages to the terminal (this is the default) πŸ“’

πŸ’€ BUGS πŸ’€

not me reading the bugs section... 😭

faxsetup does not query a modem to find out its capabilities when invoking the faxmodem program to setup a server in a send-only configuration; it may be necessary to run faxmodem manually. so like, heads up, you might be doing that one yourself bestie 🫠


πŸ“ FILES πŸ“

  • /var/spool/hylafax/etc/setup.cache β€” master configuration parameters
  • /var/spool/hylafax/etc/setup.modem β€” modem-related configuration support

and if you wanna get the complete discussion of the structure and content of the spooling area, consult hylafax-server(5F). she ate, no notes πŸ’…


⭐ SEE ALSO ⭐

hylafax-server(5F), hylafax-config(5F), faxq(8C), faxgetty(8C), faxmodem(8C), faxconfig(8C), faxsend(8C)

the whole friend group, together at last 🫢✨


and that's the page!! August 26, 1996, from the FAXSETUP(8C) manual β€” iconic, timeless, a little vintage, and honestly? still slaying. mwah πŸ’‹πŸŽ€

πŸ“¦ where this page comes from