cyajhfc - Yet Another Java HylaFAX Client
cyajhfc [options] [documents to send]...
This manual page documents the cyajhfc command.
YajHFC is a client for the HylaFAX fax server written in Java.
* Faxing documents in PostScript, PDF and various other formats
* Polling faxes
* Support for generating cover pages from templates
* Viewing sent and received faxes
* Phone book (entries can optionally be read from SQL databases or LDAP directories)
* Visible table columns may be selected in a dialog
* Supports ten languages: Chinese, English, French, German, Greek, Italian, Polish, Russian, Spanish and Turkish
implements a command line only interface. For a graphical
interface, please see yajhfc.
Please also note that the configuration has to be done using the graphical interface of the yajhfc command.
Start up in admin mode.
Specifies the administrative password to use.
Append debug information to the given log file.
Set the HylaFAX "archive" flag for this job.
Submits multiple faxes. The specified file (or stdin) should contain one set of valid command line options per line.
The format of the batch file. Currently only "cmdline" is supported.
The comment for the cover page. You can read the comment from a file by specifying "@filename" here.
Sets the configuration directory to use instead of ~/.yajhfc
The path to the cover page template to use for this fax job.
Sets a custom HylaFAX property (JPARM) for this fax job. To set multiple properties, specify this multiple times.
Output some debugging information.
Allows the usage of @@mailrecipient@@ tags in the specified documents. To these recipients e-mail is sent instead of faxes. Only works if the mail plugin is installed.
Saves faxes that could not be successfully submitted to HylaFAX in the specified directory. NOTE: This does *not* include faxes that failed to send *after* they have been submitted to HylaFAX (e.g. if the recipient’s fax number was wrong),
Sents faxes that could not be successfully submitted to HylaFAX to the specified e-mail address. NOTE: This does *not* include faxes that failed to send *after* they have been submitted to HylaFAX (e.g. if the recipient’s fax number was wrong),
Extract recipients from the specified files or stdin by searching for @@recipient:<faxnumber>@@ tags.
Sets fields of the sender identity used by the cover page. The format of the argument is the same as for --recipient. Fields not specified in the argument string use the values of the current identity (i.e. the identity selected by --identity is used as a template).
Displays this text (formatted for COLUMNS columns if given).
Specifies the host name of the HylaFAX server to connect to.
Specifies the character encoding (character set) to use for communicating with the HylaFAX server.
Sets the sender identity to use when sending the fax. Specify either the identity’s name (e.g. "My identity"), the identity’s list index (0 is the first element) or the ID in the form "#ID".
The time to "kill" the fax job after if it has not been sent successfully until that point of time. You can specify the time in the following formats: "+n days|hours|minutes|seconds" or "yyyy-MM-dd hh:mm:ss" or your locale’s default short date format.
Specifies the location of a JDBC driver JAR file to load.
Specifies a jar file of a YajHFC plugin to load.
The log file to log debug information to (if not specified, use stdout).
Specifies the maximum number of dials when trying to send a fax.
The maximum number of attempts in delivering the fax HylaFAX will perform.
Sets the modem to send the fax. Specify either the modem’s name (e.g. ttyS0) or "any" to use any modem.
Suppresses the check for the Java version at startup.
Disables loading plugins from the plugin.lst file.
The type of mail status notification for this fax job done by HylaFAX.
Specifies the e-mail address to be used by the HylaFAX server fax status notifications.
Specifies a prefix prepended to all fax numbers before sending them to the HylaFAX server.
Overrides the value of the specified setting for this session. The overridden setting is not saved.
The paper size to use for sending the fax.
Use passive mode (yes) or active mode (no) when communicating with the HylaFAX server?
Specifies the password to use.
Poll the recipient for faxes instead of sending one to it.
Specifies the TCP port to connect to on the HylaFAX server.
Prints the job IDs of newly sent faxes to stdout or to the specified file. One job per line is printed, in the format "yyyy-mm-dd hh:mm:ss NEW_FAXJOB jobid".
Querys the status of the fax job identified by the given ID. You can specify this parameter multiple times to query the status of multiple jobs.
In addition to the status, query HylaFAX for additional fax job properties ("JPARMs"). You can specify this argument multiple times to query multiple additional properties.
Print less messages. You can specify this multiple times to be more quiet.
Specifies a recipient to send the fax to. You may specify either a fax number or detailed cover page information (see the FAQ for the format in the latter case). You may specify --recipient multiple times for multiple recipients.
The resolution to use for sending the fax.
The point of time when the first attempt to send the fax will be made. You can specify the time in the following formats: "now" or "+n days|hours|minutes|seconds" or "yyyy-MM-dd hh:mm:ss" or your locale’s default short date format.
Sets the server to send the fax over. Specify either the server’s name (e.g. "My server"), the server’s list index (0 is the first element) or the ID in the form "#ID".
Read the file to send from standard input.
The fax subject for the cover page.
Saves faxes that were successfully submitted to HylaFAX in the specified directory. NOTE: This does *not* mean the fax has been sent successfully, only it has been accepted by HylaFAX for further processing (e.g. if the recipient’s fax number was wrong, the fax can still fail),
Use a cover page for sending a fax.
Specifies the user name to log into the HylaFAX server.
Print more messages. You can specify this multiple times to be more verbose.
Prints version information.
hylafax(1), sendfax(1), java(1),
More documentation is available in PDF and HTML format in the YajHFC FAQ and README files at /usr/share/doc/yajhfc or /usr/share/doc/yajhfc-console and on the homepage at http://www.yajhfc.de/
YajHFC was written by Jonas Wolz <firstname.lastname@example.org>.