1fax(1)                       mgetty+sendfax manual                      fax(1)
2
3
4

NAME

6       fax - fax sending and receiving with mgetty+sendfax
7

SYNOPSIS

9       faxspool [options] phone-number file
10
11       faxrm job-id
12
13       faxq [options]
14
15       faxrunq [options]
16
17       faxrunqd [options]
18
19       sendfax [options] phone-number file
20
21       mgetty [options] tty
22
23       pbm2g3 [options] [pbm-file]
24
25       g32pbm [options] [pbm-file]
26
27       g3cat [options] [g3-file(s)]
28
29

DESCRIPTION

31       This manpage very briefly describes every program from the mgetty+send‐
32       fax fax/modem software suite. For details, see the  manpages  for  each
33       program.
34
35       faxspool is used to queue jobs for later transmission by fax.  faxspool
36       accepts different input formats, converts them into the  proper  format
37       required  by sendfax and places the jobs into the outgoing spool direc‐
38       tory.
39
40       faxq displays the current FAX work queue.
41
42       faxrm removes one or more jobs from the current  fax  work  queue.  You
43       have to specify the job id (returned by faxq) on the command line.
44
45       faxrunq  processes  all the faxes in the fax work queue, and sends them
46       one-by-one.  If transmission isn't possible, the job  will  be  retried
47       later.  While meant to be run from cron, faxrunq can as well be started
48       from the shell (but you must have access  to  the  fax  queue  and  the
49       modems, which means you must be 'root' or 'fax')
50
51       faxrunqd  is  a replacement for faxrunq to be used in environments that
52       send a high number of faxes per day, or need more flexibility.
53
54       sendfax is the backend used by faxrunq for actually sending the fax. It
55       is  not meant to be ever called directly, but can be used in own appli‐
56       cations.
57
58       faxq-helper is a helper program that is  used  by  faxspool,  faxq  and
59       faxrm  to  access the fax spool directory (which is not world-writeable
60       since mgetty version 1.1.29).
61
62
63
64       mgetty is the part of the program suite that  handles  incoming  calls.
65       Data calls are handled as getty does it (login, shell), while fax calls
66       are  handled   internally.   The   received   faxes   are   stored   in
67       /var/spool/fax/incoming. See the mgetty(8) manpage for details.  mgetty
68       can not be called directly, it must be called by /etc/init.
69
70
71       pbm2g3 is used to convert portable bitmaps to G3 fax  data  (for  send‐
72       fax).  Do  not use the pbmtog3 program from the pbmplus or netpbm tool‐
73       kit, it will create broken G3 data.
74
75       g32pbm is used to convert received faxes (which are stored in  G3  for‐
76       mat)  to  portable bitmap format. PBM can be converted to other formats
77       with the named pbmplus toolkit.
78
79       g3cat is used to concat multiple G3 files, as cat does with text files.
80
81

FILES

83       /var/spool/fax/outgoing/
84              outgoing fax spool directory
85
86       /var/spool/fax/incoming/
87              incoming faxes
88
89       /usr/lib64/mgetty+sendfax/
90              The cover page program, faxq-helper, and a few font  files  live
91              here.
92
93       /etc/mgetty+sendfax/
94              most configuration files for mgetty and sendfax live here.
95
96       /usr/sbin
97              mgetty, sendfax and faxrunqd live here
98
99       /usr/bin
100              all the other programs
101
102       /etc/mgetty+sendfax/faxaliases
103              global fax alias file
104
105       $HOME/.faxnrs
106              private fax alias file
107
108       /etc/mgetty+sendfax/fax.allow
109              list of allowed users
110
111       /etc/mgetty+sendfax/fax.deny
112              list of denied users
113
114       /etc/mgetty+sendfax/faxheader
115              fax page header
116
117       /usr/lib64/mgetty+sendfax/make.coverpg
118              program to create fax cover page (see coverpg(1)).
119
120       /etc/mgetty+sendfax/login.config
121              login configuration file for mgetty.
122
123       /etc/mgetty+sendfax/dialin.config
124              caller ID setup file for mgetty (optional).
125
126       /etc/mgetty+sendfax/mgetty.config
127              runtime configuration file for mgetty (not implemented yet).
128
129       /etc/mgetty+sendfax/sendfax.config
130              runtime configuration file for sendfax (optional).
131
132

BUGS

134       Look into the responding man pages.
135
136

SEE ALSO

138       faxspool(1),  faxq(1),  faxrunq(1),  faxrunqd(8), sendfax(8), faxrm(1),
139       mgetty(8), pbm2g3(1), g32pbm(1), g3cat(1), faxqueue(5),  mgettydefs(4),
140       coverpg(1)
141
142       mgetty.info
143

AUTHOR

145       The  mgetty+sendfax  program  suite  is Copyright (C) 1993-2010 by Gert
146       Doering, <gert@greenie.muc.de>.  Parts of the programs  kindly  donated
147       by Chris Lewis, Paul Sutcliffe, Klaus Weidner, and numerous others.
148
149
150
151greenie                            23 Nov 02                            fax(1)
Impressum