faxsetup.8c man page

faxsetup — setup a machine for use with HylaFAX


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


faxsetup is an interactive shell script that does the necessary setup work to configure a client or server machine for the HylaFAX software. faxsetup must be run on every HylaFAX server machine before the software will function-if a HylaFAX server program or script is invoked before faxsetup is run, the command will abort with a message that says to run faxsetup. faxsetup may optionally be run on a HylaFAX client machine to verify the configuration of the software.

By default faxsetup checks a machine for use both as a HylaFAX client and server. Client-specific checks include:

Server-specific checks include:

For server machines faxsetup also creates two files that are required by the HylaFAX command scripts. One file contains master configuration parameters and the other contains various definitions used by scripts such as faxaddmodem(8C) that communicate with modems.



Do client-specific consistency checks.


Do server-specific consistency checks.


Override the default definition for the configuration parameter named VAR; optionally specifying a new value (if no value is specified then “yes” is used). This option 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 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


Print a help message and terminate.


Do not print verbose messages to the terminal.


Print informative messages to the terminal (default).


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.


/var/spool/hylafax/etc/setup.cache master configuration parameters
/var/spool/hylafax/etc/setup.modem modem-related configuration support

Consult hylafax-server(5F) for a complete discussion of the structure and content of the spooling area.

See Also

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


August 26, 1996