Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help

       faxaddmodem - configure a modem for use with HylaFAX

       /usr/local/sbin/faxaddmodem [ -s	speed ]	[ -f ] [ tty ]

       faxaddmodem  is	an  interactive	 shell	script that does the necessary
       setup work to configure a modem for use by the  HylaFAX	software.   To
       enable use of the configured modem one must either use the faxmodem(8C)
       program or configure the	init(8C) program  to  startup  a  faxgetty(8C)
       process	for  the  newly	configured modem.  In either case the faxq(8C)
       program must also be running if outbound	services are to	be provided.

       If the serial port name is not specified	on the command line  faxaddmo-
       dem will	prompt for it.

       The  configuration  work	done by	faxaddmodem falls into two main	areas:
       creating	the necessary files to run a  facsimile	 server	 process,  and
       defining	the contents of	the configuration database file.  The hylafax-
       config (5F) manual page has an in-depth description of the contents  of
       the configuration file and should be consulted when installing a	modem.

       Many aspects of configuring a modem are operating system-specific; fax-
       addmodem	uses a collection of support routines and parameters that  are
       generated by the	faxsetup(8C) program.  If faxsetup has not been	run on
       a machine prior to running then faxaddmodem will	abort.

       faxaddmodem can be used to install a new	modem or re-configure  an  ex-
       isting  modem.  In the latter case it will propagate all	the server-re-
       lated configuration parameters from the existing	configuration file  to
       the  new	configuration file.  These parameter include items such	as the
       phone number, area code,	and tracing control parameters.	 Modem-related
       configuration  parameters are, however, not propagated.	Instead	faxad-
       dmodem deduces the type of modem	attached to the	specified serial  port
       and  then sets up the configuration parameters using a set of prototype
       configuration files that	have been tested with like modems.  If a modem
       is  to be installed for which there is no existing prototype file, fax-
       addmodem	will work from a comprehensive template	of parameters that can
       be edited either	during or after	the installation process.

       faxaddmodem  deduces  the  type of modem	attached to the	serial port by
       sending commands	to the modem at	a fixed	speed.	By default, this speed
       is  deduced by sending commands to the modem at successively decreasing
       speeds until a valid response  is  received.   Alternatively,  a	 fixed
       speed can be specified from the command line with the -s	option.

       Because faxaddmodem needs to read and write the modem that is to	be in-
       stalled it will not proceed with	an installation	if the modem is	locked
       for  use	by another process.  If	the modem is not locked	and the	-f op-
       tion is used, then the system's fuser(1)	command	will be	invoked	to en-
       sure that faxaddmodem is	the only process using the modem.

       Finally,	note that an installation can be safely	aborted	at any time by
       hitting the interrupt key.  faxaddmodem delays making  installation-re-
       lated changes until after everything has	been setup.

       -s speed	 Communicate  with the modem at	a fixed	speed; this may	be any
		 value recognized by the stty(1) command.

       -f	 Use the fuser(1) command for exclusive	access to the device.

       faxaddmodem uses	prototype configuration	files that have	 been  created
       for  known modems.  These prototype files are kept in the config	subdi-
       rectory and, by convention, have	names that identify a brand or type of
       modem  and  the DTE-DCE flow control scheme the prototype files config-
       ures.  The faxaddmodem(8C) program that is used to  configure  a	 modem
       for  use	 with HylaFAX selects a	prototype configuration	file using in-
       formation retrieved from	the modem and comments embedded	in the	proto-
       type  files.   For Class	1 and Class 1.0	modems the product ID code re-
       turned by the command  ``ATI0''	and  the  response  from  the  command
       ``ATI3''	 are  used to select a prototype configuration file, while for
       Class 2 modems the manufacturer and model as returned  by  ``AT+FMFR?''
       and   ``AT+FMDL?'',   respectively,   are   used	 (or  ``AT+FMI?''  and
       ``AT+FMM?'' for Class 2.0 and Class 2.1 modems).

       A Class 1 prototype configuration file is identified for	use by	faxad-
       dmodem by searching for a comment of the	form:
       # CONFIG:CLASS1:144:.*:RTSCTS: Manufacturer='AT&T' Model=Dataport
       In this example ``144'' is the product ID code for an AT&T DataPort mo-
       dem, ``.*'' is a	regular	expression matched against the	result	string
       returned	by the ``ATI3''	command, and ``RTSCTS''	indicates the modem is
       configured to use hardware flow control during fax operation.  The  re-
       mainder	of  the	line is	evaluated by the sh(1) and used	to specify the
       modem's manufacturer and	model (since Class 1 modems do not have	 stan-
       dard commands to	query this information).

       Class  2,  2.0,	and 2.1	prototype configuration	files match the	string
       ``manufacturer-model-flowcontrol'' against a sh(1) glob pattern	speci-
       fied  in	 the  configuration file, where	manufacturer and model are the
       strings returned	by  querying  the  modem  and  flowcontrol  is	either
       ``RTSCTS''  for	hardware flow control or ``XONXOFF'' for software flow
       control.	 For example:
       # CONFIG: CLASS2.0: USRobotics*-XONXOFF
       are configuration comments that appear in  the  prototype  file	for  a
       ZyXEL  1496E  with Class	2 support, and for a US	Robotics Courier modem
       with Class 2.0 firmware.

       The faxaddmodem program merges server-specific configuration parameters
       into a prototype	configuration according	to comments placed in the pro-
       totype file.  All lines	between	 ``BEGIN-SERVER''  and	``END-SERVER''
       comments	 are  placed with the appropriate server configuration parame-
       ters.  Note that	this means modem-related configuration parameters must
       be placed outside this area of the file.

       /var/spool/hylafax/etc/setup.cache    master configuration parameters
       /var/spool/hylafax/etc/setup.modem    modem-related configuration support
       /var/spool/hylafax/config	     prototype configuration files
       /usr/local/sbin/ondelay		     program to	open device without waiting for	carrier
       /usr/local/sbin/lockname		     SVR4 UUCP lockfile	name generator

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

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

				 May 12, 1996		       FAXADDMODEM(8C)


Want to link to this manual page? Use this URL:

home | help