YAJHFC

NAME

cyajhfc - Yet Another Java HylaFAX Client

SYNOPSIS

cyajhfc [options] [documents to send]...

DESCRIPTION

This manual page documents the cyajhfc command.

YajHFC is a client for the HylaFAX fax server written in Java.

Features:
* 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

This command 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.

OPTIONS

-A, --admin

Start up in admin mode.

--admin-password=PASSWORD

Specifies the administrative password to use.

--appendlogfile=LOGFILE

Append debug information to the given log file.

--archive-job[=yes|no]

Set the HylaFAX "archive" flag for this job.

-b, --batch[=FILE]

Submits multiple faxes. The specified file (or stdin) should contain one set of valid command line options per line.

--batch-format=cmdline

The format of the batch file. Currently only "cmdline" is supported.

--comment=COMMENT

The comment for the cover page. You can read the comment from a file by specifying "@filename" here.

-c, --configdir=DIRECTORY

Sets the configuration directory to use instead of ~/.yajhfc

--custom-cover=FILE

The path to the cover page template to use for this fax job.

-P, --custom-property=KEY=VALUE

Sets a custom HylaFAX property (JPARM) for this fax job. To set multiple properties, specify this multiple times.

-d, --debug

Output some debugging information.

--enable-mail-recipients

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.

--error-dir=DIRECTORY

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),

--error-mail=EMAIL-ADDRESS

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[=yes|no]

Extract recipients from the specified files or stdin by searching for @@recipient:<faxnumber>@@ tags.

--from-identity=IDENTITY-SPEC

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).

-h, --help[=COLUMNS]

Displays this text (formatted for COLUMNS columns if given).

-H, --host=HOSTNAME

Specifies the host name of the HylaFAX server to connect to.

--hylafax-encoding=CHARSET

Specifies the character encoding (character set) to use for communicating with the HylaFAX server.

-I, --identity=IDENTITY

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".

-k, --kill-time=TIMESPEC

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.

--loaddriver=JARFILE

Specifies the location of a JDBC driver JAR file to load.

--loadplugin=JARFILE

Specifies a jar file of a YajHFC plugin to load.

-l, --logfile=LOGFILE

The log file to log debug information to (if not specified, use stdout).

--max-dials=DIALS

Specifies the maximum number of dials when trying to send a fax.

-m, --max-tries=TRIES

The maximum number of attempts in delivering the fax HylaFAX will perform.

-M, --modem=MODEM

Sets the modem to send the fax. Specify either the modem’s name (e.g. ttyS0) or "any" to use any modem.

--no-check

Suppresses the check for the Java version at startup.

--no-plugins

Disables loading plugins from the plugin.lst file.

-N, --notification=none|done|requeue|done+requeue

The type of mail status notification for this fax job done by HylaFAX.

--notify-address=EMAIL

Specifies the e-mail address to be used by the HylaFAX server fax status notifications.

--number-prefix=NUMBERS

Specifies a prefix prepended to all fax numbers before sending them to the HylaFAX server.

--override-setting=KEY=VALUE

Overrides the value of the specified setting for this session. The overridden setting is not saved.

-p, --paper-size=a4|a5|legal|letter

The paper size to use for sending the fax.

--passive[=yes|no]

Use passive mode (yes) or active mode (no) when communicating with the HylaFAX server?

-w, --password=PASSWORD

Specifies the password to use.

--port=1-65535

Specifies the TCP port to connect to on the HylaFAX server.

--print-jobids[=FILE]

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".

-Q, --query-job-status=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.

--query-property=PROPERTYNAME

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.

-q, --quiet

Print less messages. You can specify this multiple times to be more quiet.

-r, --recipient=IDENTITY-SPEC

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.

-R, --resolution=low|high|extended

The resolution to use for sending the fax.

-t, --send-time=TIMESPEC

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.

-S, --server=SERVER

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".

--stdin

Read the file to send from standard input.

-s, --subject=SUBJECT

The fax subject for the cover page.

--success-dir=DIRECTORY

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),

-C, --use-cover[=yes|no]

Use a cover page for sending a fax.

-U, --user=USERNAME

Specifies the user name to log into the HylaFAX server.

-v, --verbose

Print more messages. You can specify this multiple times to be more verbose.

--version

Prints version information.

SEE ALSO

yajhfc(1), 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/

AUTHOR

YajHFC was written by Jonas Wolz <jonas@yajhfc.de>.