/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 \*(Fx software. faxsetup must be run on every \*(Fx server machine before the software will function-if a \*(Fx 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 \*(Fx client machine to verify the configuration of the software.

By default faxsetup checks a machine for use both as a \*(Fx client and server. Client-specific checks include:

  • the installation of client programs and data,

  • the installation of the Adobe Font Metric (\s-1AFM\s+1) information files used by the \*(Fx text formatting support.

Server-specific checks include:

  • the installation of server programs and data,

  • the existence of the \s-1UUCP\s+1 lock file directory,

  • the installation of the \s-1TIFF\s+1 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 \s-1FIFO\s+1 special files,

  • proper installation of a \*(Ps \s-1RIP\s+1,

  • definition of a ``fax'' user,

  • definitions for the ``hylafax'' and ``snpp'' services,

  • startup of the \*(Fx server processes: faxq(8) and hfaxd(8),

  • definition of a ``FaxMaster'' mail alias for reporting server problems.

For server machines faxsetup also creates two files that are required by the \*(Fx command scripts. One file contains master configuration parameters and the other contains various definitions used by scripts such as faxaddmodem(8) 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 \*(Ps 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 online 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(5) for a complete discussion of the structure and content of the spooling area.

RELATED TO faxsetup…