capisuite/docs/capisuitefax.1

106 lines
2.5 KiB
Groff

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "CAPISUITEFAX" 1 "" "" ""
.SH NAME
capisuitefax \- sending faxes with the CapiSuite default scripts
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 13
\fBcapisuitefax\fR [\-q] [\-n] [\-u\ \fIuser\fR] [\-A\ \fIadr\fR] [\-S\ \fIsubj\fR] \-d\ \fInumber\fR file...
.ad
.hy
.ad l
.hy 0
.HP 13
\fBcapisuitefax\fR [\-q] \-a\ \fIid\fR
.ad
.hy
.ad l
.hy 0
.HP 13
\fBcapisuitefax\fR \-h
.ad
.hy
.ad l
.hy 0
.HP 13
\fBcapisuitefax\fR \-l
.ad
.hy
.SH "DESCRIPTION"
.PP
The default scripts for CapiSuite come with the tool \fBcapisuitefax\fR for sending faxes\&.
.PP
It will be called with some parameters telling it which file to send (it currently only supports PostScript files) and to which number\&. It will then enqueue the job converted to the right format into the send queue from which it's collected by another CapiSuite script and sent to the destination\&. If the sending was completed successfully or failed finally after trying for some time, the according user will get an email telling him/her what has happened\&.
.SH "OPTIONS"
.TP
\fB\-a id\fR
Abort the job with the given id\&. To get a job id, use the \fB\-l\fR option\&.
.TP
\fB\-A adr\fR
The addressee of the fax\&. This option is (currently) only for informational purposes and will be quoted in the sent status mail\&.
.TP
\fB\-d number\fR
The number which should be called (destination of the fax)
.TP
\fB\-h\fR
Show a short commandline help
.TP
\fB\-l\fR
Shows the jobs which are currently in the send queue\&.
.TP
\fB\-n\fR
Don't use the configured dial prefix for this job\&. Useful for internal jobs\&.
.TP
\fB\-q\fR
Be quiet, don't output informational messages
.TP
\fB\-S subj\fR
A subject for the fax\&. This option is (currently) only for informational purposes and will be quoted in the sent status mail\&.
.TP
\fB\-u user\fR
Send fax as another user\&. Only allowed if \fBcapisuitefax\fR is called as user root\&. This is mainly helpful for realizing extensions to e\&.g\&. do network faxing\&.
.TP
\fBfile\&.\&.\&.\fR
One or more PostScript files to send to this destination\&. More than one PostScript file will produce several separate fax jobs\&.
.SH "SEE ALSO"
.PP
\fBcapisuite\fR(8), \fBcapisuite\&.conf\fR(5), \fBfax\&.conf\fR(5), \fBanswering_machine\&.conf\fR(5)
.SH AUTHOR
Gernot Hillier <gernot@hillier\&.de>.