1FAXMODEM(8C) FAXMODEM(8C)
2
6 faxmodem - dynamically add a modem to a HylaFAX server system
7
9 /usr/sbin/faxmodem [ -q queue-dir ] [ -c capabilities ] [ -p ] [ -P ] [
10 -u priority ] modem
11
13 faxmodem sends a message to the HylaFAX queuer process faxq(8C) telling
14 it that the specified modem is ready for use and informing it about its
15 fax-related capabilities. This is the mechanism by which modems are
16 added in a send-only configuration. Once a modem has been configured
17 its status can be reconfigured using the faxstate(8C) program. faxmo‐
18 dem can also be used to alter the capabilities and usage priority of a
19 previously configured modem.
20 The specified modem is either the terminal device name where the modem
22 is attached or a HylaFAX device identifier (see hylafax-config(5F) for
23 information on device identifiers). Device names may be given without
24 a leading directory pathname; e.g. ttyf2 instead of /dev/ttyf2.
25 To figure out the capabilities of a modem either use the probemodem(8C)
27 script or manually communicate with the modem. For a Class 2 modem the
28 capabilities are given in the response to the ``AT+FDCC=?'' query com‐
29 mand and for a Class 2.0 modem the ``AT+FCC=?'' command. To check if a
30 modem is capable of polled retrieval of documents use ``AT+FSP=?'' for
31 a Class 2.0 modem or ``AT+FSPL=?'' for a Class 2 modem; if ``1'' is
32 indicated in the response then the modem supports polling. For exam‐
33 ple,
34 hyla% cu -l ttyf2
35 Connected
36 at+fclass=2.0
37 OK
38 at+fcc=?
39 (0,1),(0-5),(0-2),(0-2),0,0,0,(0-7)
40 OK
41 at+fsp=?
42 (0,1)
43 OK
44 In this case the modem would be added using the command:
46 /usr/sbin/faxmodem -c '(0,1),(0-5),(0-2),(0-2),0,0,0,(0-7)' ttyf2
47 (by default polling is assumed to be supported).
49 Class 1 modems require a different technique. The host implements most
51 of the fax protocol so all that is needed is to identify the possible
52 signalling rates the modem supports for transmitting; this is done with
53 the ``AT+FTM=?'' command. For example,
54 hyla% cu -l ttyf2
55 Connected
56 at+fclass=1
57 OK
58 at+ftm=?
59 24,48,72,73,74,96,97,98,121,122,145,146
60 OK
61 In this case the modem supports 2400, 4800, 7200, 9600, 12200, and
63 14400 bps signalling rates so the modem would be added using:
64 /usr/sbin/faxmodem -c '(0,1),(0-5),(0-2),(0-2),(0,1),0,0,(0-7)' ttyf2
65
67 The following options are available:
68 -c Specify the fax capabilities using the syntax defined by the
70 ``Class 2'' specification:
71 ``(vr),(br),(wd),(ln),(df),(ec),(bf),(st)''. where, vr spec‐
72 ifies vertical resolution, br specifies bit rate, wd speci‐
73 fies page width, ln specifies page length, df specifies data
74 compression, ec specifies error correction, bf specifies
75 binary file transfer, and st specifies scan time/line; and
76 each of the above specifications is a range or list of num‐
77 bers that defines the exact capabilities of the modem. For
78 example, the default capabilities are
79 ``(0,1),(0-3),(0-4),(0-2),(0),(0),(0),(0-7)'' which specifies
80 the modem is capable of sending and receiving both low and
81 high resolution facsimile with a variety of page sizes; sup‐
82 ports signalling rates 0-3 (2400 bps through 9600 bps); sup‐
83 ports only 1D-encoded data compression; and does not support
84 error correction or binary file transfer. A modem's ability
85 to support polled retrieval of facsimile is specified sepa‐
86 rately with the -p and -P options.
87 -p Specify the modem is not capable of polling for remote docu‐
89 ments.
90 -P Specify the modem is capable of polling for remote documents
92 (default).
93 -q dir Use a spooling area other than /var/spool/hylafax.
95 -u priority
97 Assign the specified priority to the modem when scheduling it
98 for outbound use. Modem priorities are numbers in the range
99 [0..255] with lower numbers meaning higher priority. Modems
100 are initially assigned priority 255.
101
103 /var/spool/hylafax default spooling area
104 /var/spool/hylafax/FIFO fifo for contacting faxq
105 Consult hylafax-server(5F) for a complete discussion of the structure
107 and content of the spooling area.
108
110 hylafax-server(5F), faxgetty(8C), faxq(8C).
111 Oct 27, 1995 FAXMODEM(8C)