faxstat man page

faxstat — display HylaFAX status

Synopsis

faxstat [ -O config ] [ options ]

Description

faxstat reports the status of HylaFAX servers, including (potentially) the status of the send, receive, done, document, and archive directories. When invoked without options faxstat reports only the status of the server; the options described below can be used to override this behavior.

Server status information indicates the state of the server (idle, sending, receiving, etc.) and the phone number that is associated with the fax modem.

The job queue report give the status of facsimile jobs queued for transmission; by default:

·
the job identifier,
·
the job state (see below for the description of the a format in the JobFmt string),
·
the modem or modem class the job is bound to (“any” if the job can be sent though any modem),
·
the destination (phone number) of the job,
·
the time to send the job, or a blank field if the job is being processed or is to be sent immediately,
·
the job's owner,
·
and status information about the job (typically the reason why a previous attempt failed).

The receive queue report lists the facsimile documents that have been received and are awaiting delivery; by default it includes:

·
the document protection mode,
·
the number of pages,
·
the document's owner,
·
the phone number of the sender (if supplied),
·
the date and time at which the job was received, and
·
the filename of the document in the recvq directory on the server machine.

Options

-A
Login with administrative privileges.
-a
Display the contents of the archive directory on the server machine
-d
Display the status of all jobs that have completed; i.e. those jobs located in the doneq directory on the server machine. The JobFmt string defines the content and format of information reported with this option.
-f
Display the status of document files located in the docq directory on the server machine. The FileFmt string defines the content and format of information reported with this option (see below).
-g
Display times and dates in Greenwich Mean Time (GMT). NB: this is the default.
-h host
Report the status of the server on a specific host. The host may be either a symbolic name or a network address. IPv6 addresses are given in “[xx:xx::x]:port” format. If no -h option is supplied, faxstat uses the FAXSERVER environment variable to identify the HylaFAX server to contact. If this variable is not set, then faxstat checks for a setting in the configuration files (first in the per-user file and then in the system-wide file). If all of the above fails, then faxstat attempts to contact a server on the machine where it is run.
-i
Display additional status information for the server as given by /var/spool/hylafax/status/any.info. This status typically has information such as the HylaFAX version, the physical location of the server machine, and an administrative contact for the server. See status(5F).
-l
Display times and dates in the local timezone of the server.
-n
Supress the display of server and modem status.
-o login
Specify the fax owner login name. If unspecified, the user's current login name is used. The login password and admin password may also be provided by separating them from the owner login name with colons, like “owner:pass:adminpass”.
-q
Display the sequence numbers of the HylaFAX queues.
-r
Display the receive queue status for each server. The RcvFmt string defines the content and format of information reported with this option (see below).
-O config
Treat config as a configuration parameter specification that is interpreted after reading the configuration file. For example, “-O Host:fax.example.com” would set the Host configuration parameter to “fax.example.com”, overriding any setting in the configuration file.
-s
Display the status of jobs in the send queue on the server machine. The JobFmt string defines the content and format of information reported with this option (see below).
-v
Trace the protocol exchanges between faxstat and the hfaxd processes on the standard output.

Configuration Parameters

faxstat reads configuration information from the file /etc/hylafax/hyla.conf and then from the file ~/.hylarc. Configuration files follow the conventions described in hylafax-client(1). The following configuration parameters are recognized:

TagTypeDefaultDescription
FileFmtstringsee belowformat string for file status results
Hoststringlocalhosthost to contact for service
JobFmtstringsee belowformat string for job status results
ModemFmtstringsee belowformat string for modem status results
PassiveModebooleanfalsewhether or not to use passive mode
Portinteger4559port to use in contacting server
Protocolstringtcpprotocol to use in contacting server
RcvFmtstringsee belowformat string for received facsimile status results
TimeZonestringGMTtimezone to use for reporting dates and times
VerbosebooleanNowhether or not to enable protocol tracing

The configuration parameters are explained below:

FileFmt

The format string to use when returning file status information with the -f option. Formats are specified using printf(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just as for printf; e.g. %-8p for an 8-character wide, left-justified, blank-padded field containing the file protection flags.

FormatDescription
aLast access time
cCreation time
dDevice number (octal)
fFilename
gGroup identifier (decimal)
iInode number (decimal)
lLink count (decimal)
mLast modification time
oOwner (based on file GID)
pFax-style protection flags (no group bits)
qUNIX-style protection flags
rRoot device number (octal)
sFile size in bytes (decimal)
uUser identifier (decimal)
Host
The host to contact for service. (Equivalent to the -h option.)
JobFmt

The format string to use when returning job status information for the -s and -d options. Formats are specified using printf(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just as for printf; e.g. %-3j for a 3-character wide, left-justified, blank-padded field containing the job state.

FormatDescription
ADestination SubAddress
BDestination Password
CDestination company name
DTotal # dials/maximum # dials
EDesired signalling rate
FClient-specific tagline format string
GDesired min-scanline time
HDesired data format
IClient-specified scheduling priority
JClient-specified job tag string
KDesired use of ECM (one-character symbol)
LDestination geographic location
MNotification e-mail address
NDesired use of private tagline (one-character symbol)
OWhether to use continuation cover page (one-character symbol)
P# pages transmitted/total # pages to transmit
QClient-specified minimum acceptable signalling rate
RDestination person (receiver)
SSender's identity
TTotal # tries/maximum # tries
UPage chopping threshold (inches)
VJob done operation
WCommunication identifier
XJob type (one-character symbol)
YScheduled date and time
ZScheduled time in seconds since the UNIX epoch
aJob state (one-character symbol)
b# consecutive failed tries
cClient machine name
dTotal # dials
ePublic (external) format of dialstring
f# consecutive failed dials
gGroup identifier
hPage chop handling (one-character symbol)
iCurrent scheduling priority
jJob identifier
kJob kill time
lPage length in mm
mAssigned modem
nE-mail notification handling (one-character symbol)
oJob owner
p# pages transmitted
qJob retry time (MM::SS)
rDocument resolution in lines/inch
sJob status information from last failure
tTotal # tries attempted
uMaximum # tries
vClient-specified dialstring
wPage width in mm
xMaximum # dials
yTotal # pages to transmit
zTime to send job

The K format produces: “D” if ECM is to be disabled, “ ” (space) if ECM use is enabled, “H” if T.30 Annex C half duplex is enabled, or “F” if T.30 Annex C full duplex is enabled.

The N format produces: “ ” (space) if the system-wide tagline format is to be used or “P” if a private tagline format is to be used.

The O format produces: “N” if no continuation cover page is to be used or “ ” (space) if the system default handling for continuation cover pages is to be used.

The X format produces: “F” for a facsimile job or “P” for a pager job.

The a format produces: “?” for a job in an undefined state, “T” for a suspended job (not being scheduled), “P” for a pending job (waiting for its time to send to arrive), “S” for a sleeping job (waiting for a scheduled timeout such as a delay between attempts to send), “B” for a job blocked by concurrent activity to the same destination, “W” for a job waiting for resources such as a free modem, “R” for a job that is actively running, and “D” for a job that is done and was a success. “F” for a job that failed to complete.

The h format produces: “D” if page chopping is disabled, “ ” (space) for the system default page chop handling, “A” when all pages are to be chopped, or “L” if only the last page is to be chopped.

The n format produces: “ ” (space) when no notification messages are to be delivered, “D” when notification is to be sent when the job is done, “Q” when notification is to be sent each time the job is requeued, or “A” when notification is to be sent for either the job completing or being requeued.

It is recommended that all items include a field width so that the width of column title strings can be constrained when constructing headers from the format string.

ModemFmt

The format string to use when returning modem status information. Formats are specified using printf(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just as for printf; e.g. %-8h for an 8-character wide, left-justified, blank-padded field containing the name of the host the server is running on.

FormatDescription
hServer hostname
lLocal identifier string
mCanonical modem name
nFAX phone number
rMaximum pages that can be received in a single call
sStatus information string
tServer and session tracing levels (xxxxx:yyyyy)
vModem speaker volume as one-character symbol
zA “*” if a faxgetty(8C) process is running; otherwise “ ” (space)
PassiveMode
Whether or not to use passive mode in communication with the server.
Port
The network port to contact for service. (Equivalent to the -h option.)
Protocol
The name of the communication protocol to use when contacting a server. (Equivalent to the FAXSERVICE environment variable.)
RcvFmt

The format string to use when returning status information for the -r option. Formats are specified using printf(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just as for printf; e.g. %-3b for a 3-character wide, left-justified, blank-padded field containing the signalling rate.

FormatDescription
YExtended representation of the time when the receive happened
aSubAddress received from sender (if any)
bSignalling rate used during receive
dData format used during receive
eError description if an error occurred during receive
fDocument filename (relative to the recvq directory)
hTime spent receiving document (HH:MM:SS)
iCIDName value for received fax
jCIDNumber value for received fax
lPage length in mm
mFax-style protection mode string (“-rwxrwx”)
nFile size (number of bytes)
oFile owner
pNumber of pages in document
qUNIX-style protection flags
rResolution of received data
sSender identity (TSI)
tCompact representation of the time when the receive happened
wPage width in mm
zA “*” if receive is going on; otherwise “ ” (space)

It is recommended that all items include a field width so that the width of column title strings can be constrained when constructing headers from the format string.

TimeZone
Control whether times and dates are reported in the local timezone of the server (“local”) or in GMT (“gmt”). By default times are reported in GMT.
Verbose
Control protocol tracing. (Equivalent to the -v option.)

Notes

The server login user name may be specified by the FAXUSER environment variable.

Bugs

There is no way to suppress the server status report. There is no way to control the printing of headers.

Files

/etc/hylafax/hyla.confsystem-wide configuration file
~/.hylarcper-user configuration file

See Also

hylafax-client(1), sendfax(1), faxalter(1), faxrm(1), hfaxd(8C)

Referenced By

faxalter(1), faxrm(1), hfaxd.8c(8), hylafax.8c(8), hylafax-client(1), hylafax-server.5f(5), pagesizes.5f(5), sendfax(1), sendpage(1), status.5f(5).

July 9, 1996