2012-03-07 10:28:33 +00:00
'\" t
. \" Title: capisuitefax
. \" Author: Gernot Hillier <gernot@hillier.de>
2013-08-14 08:34:48 +00:00
. \" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
. \" Date: 08/13/2013
. \" Manual: CapiSuite 0.5.git
2012-03-07 10:28:33 +00:00
. \" Source: [FIXME: source]
. \" Language: English
. \"
2013-08-14 08:34:48 +00:00
.TH "CAPISUITEFAX" "1" "08/13/2013" "[FIXME: source]" "CapiSuite 0.5.git"
2012-03-07 10:28:33 +00:00
. \" -----------------------------------------------------------------
. \" * Define some portability stuff
. \" -----------------------------------------------------------------
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" http://bugs.debian.org/507673
. \" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n (.g .ds Aq \(aq
.el .ds Aq '
. \" -----------------------------------------------------------------
. \" * set default formatting
. \" -----------------------------------------------------------------
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
. \" -----------------------------------------------------------------
. \" * MAIN CONTENT STARTS HERE *
. \" -----------------------------------------------------------------
.SH "NAME"
2004-11-27 13:03:41 +00:00
capisuitefax \- sending faxes with the CapiSuite default scripts
.SH "SYNOPSIS"
2012-03-07 10:28:33 +00:00
.HP \w '\fBcapisuitefax\fR\ 'u
2004-11-27 13:03:41 +00:00
\fB capisuitefax\fR [\- q] [\- n] [\- u\ \fI user\fR ] [\- A\ \fI adr\fR ] [\- S\ \fI subj\fR ] \- d\ \fI number\fR file...
2012-03-07 10:28:33 +00:00
.HP \w '\fBcapisuitefax\fR\ 'u
2004-11-27 13:03:41 +00:00
\fB capisuitefax\fR [\- q] \- a\ \fI id\fR
2012-03-07 10:28:33 +00:00
.HP \w '\fBcapisuitefax\fR\ 'u
2004-11-27 13:03:41 +00:00
\fB capisuitefax\fR \- h
2012-03-07 10:28:33 +00:00
.HP \w '\fBcapisuitefax\fR\ 'u
2004-11-27 13:03:41 +00:00
\fB capisuitefax\fR \- l
.SH "DESCRIPTION"
.PP
2012-03-07 10:28:33 +00:00
The default scripts for
CapiSuite
come with the tool
\fB capisuitefax\fR
for sending faxes\& .
2004-11-27 13:03:41 +00:00
.PP
2012-03-07 10:28:33 +00:00
It will be called with some parameters telling it which file to send (it currently only supports PostScript and PDF files) and to which number\& . It will then enqueue the job converted to the right format into the send queue from which it\* (Aqs 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\& .
2004-11-27 13:03:41 +00:00
.SH "OPTIONS"
2012-03-07 10:28:33 +00:00
.PP
2004-11-27 13:03:41 +00:00
\fB \- a id\fR
2012-03-07 10:28:33 +00:00
.RS 4
Abort the job with the given id\& . To get a job id, use the
\fB \- l\fR
option\& .
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- A adr\fR
2012-03-07 10:28:33 +00:00
.RS 4
2004-11-27 13:03:41 +00:00
The addressee of the fax\& . This option is (currently) only for informational purposes and will be quoted in the sent status mail\& .
2012-03-07 10:28:33 +00:00
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- d number\fR
2012-03-07 10:28:33 +00:00
.RS 4
2004-11-27 13:03:41 +00:00
The number which should be called (destination of the fax)
2012-03-07 10:28:33 +00:00
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- h\fR
2012-03-07 10:28:33 +00:00
.RS 4
2004-11-27 13:03:41 +00:00
Show a short commandline help
2012-03-07 10:28:33 +00:00
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- l\fR
2012-03-07 10:28:33 +00:00
.RS 4
2004-11-27 13:03:41 +00:00
Shows the jobs which are currently in the send queue\& .
2012-03-07 10:28:33 +00:00
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- n\fR
2012-03-07 10:28:33 +00:00
.RS 4
Don\* (Aqt use the configured dial prefix for this job\& . Useful for internal jobs\& .
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- q\fR
2012-03-07 10:28:33 +00:00
.RS 4
Be quiet, don\* (Aqt output informational messages
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- S subj\fR
2012-03-07 10:28:33 +00:00
.RS 4
2004-11-27 13:03:41 +00:00
A subject for the fax\& . This option is (currently) only for informational purposes and will be quoted in the sent status mail\& .
2012-03-07 10:28:33 +00:00
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB \- u user\fR
2012-03-07 10:28:33 +00:00
.RS 4
Send fax as another user\& . Only allowed if
\fB capisuitefax\fR
is called as user
root\& . This is mainly helpful for realizing extensions to e\& .g\& . do network faxing\& .
.RE
.PP
2004-11-27 13:03:41 +00:00
\fB file\& .\& .\& .\fR
2012-03-07 10:28:33 +00:00
.RS 4
2004-12-04 07:06:30 +00:00
One or more PostScript/PDF files to send to this destination\& . More than one PostScript file will produce several separate fax jobs\& .
2012-03-07 10:28:33 +00:00
.RE
2004-11-27 13:03:41 +00:00
.SH "SEE ALSO"
.PP
2012-03-07 10:28:33 +00:00
capisuite(8), capisuite\& .conf(5), fax\& .conf(5), answering_machine\& .conf(5)
.SH "AUTHOR"
.PP
\fB Gernot Hillier\fR <\& gernot@hillier.de\& >
.RS 4
Author.
.RE