fax.conf man page on OpenSuSE

Man page or keyword search:  
man Server   25941 pages
apropos Keyword Search (all sections)
Output format
OpenSuSE logo
[printable version]

FAX.CONF(5)							   FAX.CONF(5)

NAME
       fax.conf - configuration of the CapiSuite fax services

DESCRIPTION
       This  file holds all available config options for the fax services pro‐
       vided by the default scripts distributed with  CapiSuite.  It  is  read
       from	/etc/capisuite/fax.conf	   or/usr/local/etc/capisuite/fax.conf
       (depending on the installation).

       It is divided into one or more sections. A section begins with the sec‐
       tion  name  in  square  brackets	 like  [section] while the options are
       key="value" lines.

       A special section called [GLOBAL] and one section for each user	called
       [<username>] are required.The <username> must be a valid system user.

       The  [GLOBAL]-section  defines  some  global options like pathnames and
       default settings for options that can be overridden  in	the  user-sec‐
       tions. The user-sections hold all the options which belong to a partic‐
       ular user.

THE [GLOBAL] SECTION
       spool_dir="/path/to/spooldir/"
	      This directory is used to archive sent (or failed) jobs. It must
	      exist  and the user CapiSuite runs as must have write permission
	      to its subdirectories. Two subdirectories are used:

	      spooldir/done/
		     Jobs finished successfully are moved to this directory.

	      spooldir/failed/
		     Job which have failed finally end up here.

	      This option is mandatory.

       fax_user_dir="/path/to/userdir/"
	      This directory is used to store fax jobs and received  documents
	      to. It must exist and the user CapiSuite runs as must have write
	      permission to it. It will contain one subdirectory for each con‐
	      figured  user (named like his userid). The following subdirecto‐
	      ries are used below the user-specific dir:

	      user_dir/username/received/
		     Received faxes are saved here.

	      user_dir/username/sendq/
		     Fax files to be sent are queued here by capisuitefax.

	      This option is mandatory.

       send_tries="10"
	      When a fax can't be sent to the destination for any reason, it's
	      tried  for  several  times.  This	 setting  limits the number of
	      tries. If all tries failed, the job will be moved to the	failed
	      dir (see fax_spool_dir) and the user will get a mail.

	      This option is optional. If not given, it defaults to 10 tries.

       send_delays="60,60,60,300,300,3600,3600,18000,36000"
	      When a fax can't be sent to the destination for any reason, it's
	      tried again.  This  setting  specifies  the  delays  in  seconds
	      between  subsequent  tries.  The	different values are separated
	      with commas and no blanks. The  list  should  have  send_tries-1
	      (see  fax_send_tries)  values  -	if  not,  surplus  entries are
	      ignored and missing entries are filled up with the  last	value.
	      The  default  should just be ok giving you increasing delays for
	      up to 10 tries.

	      This option is optional. If not given, it defaults to  the  list
	      shown above.

       send_controller="1"
	      If you have more than one ISDN controller installed (some active
	      cards for more than one basic rate interface like the AVM C2  or
	      C4  are also represented as multiple controllers for CAPI appli‐
	      cations like CapiSuite), you can decide  which  controller  (and
	      therefore which basic rate interface) should be used for sending
	      your faxes. All controllers are numbered	starting  with	1.  If
	      you're  not sure which controller has which number, increase the
	      log level to at least 2 in  CapiSuite  (see  [xref  to  sect2]),
	      restart it and have a look in the log file where all controllers
	      will be listed then. Unfortunately, CapiSuite isn't able to  use
	      more  than one controller for sending faxes at the moment, so no
	      list is allowed here. If you  have  only	one  controller,  just
	      leave it at 1

	      This option is optional. If not given, it defaults controller 1.

       outgoing_MSN="<your MSN>"
	      This  number  is	used  as our own number for outgoing calls. If
	      it's not given, the first number of  fax_numbers	is  used  (see
	      user  sections).	If this one is also empty, the user can't send
	      faxes. Please replace with one valid MSN of your ISDN  interface
	      or  leave	 empty. This value can be overwritten in the user sec‐
	      tions individually.

	      This option is optional. If not given, it defaults to empty.

       outgoing_timeout="60"
	      Default setting which defines how many seconds we will wait  for
	      a successful connection after dialing the number. This value can
	      be overwritten in the user sections individually.

	      This option is optional. If not given, it defaults  to  60  sec‐
	      onds.

       dial_prefix=""
	      If  anything  is entered here, it will be used as a prefix which
	      is added to any number given to capisuitefax as prefix. This  is
	      e.g.  very  helpful  if  your ISDN adapter is connected to a PBX
	      which needs "0" for external calls. It's also possible  to  dis‐
	      able its usage later for a certain fax document, so setting this
	      will certainly not prevent you from placing internal calls with‐
	      out prefix.

	      This  option  is optional. If not given, it defaults to an empty
	      prefix.

       fax_stationID="<your faxID>"
	      Default fax station ID to use when sending a fax	document.  The
	      station ID is usually the number of your fax station in interna‐
	      tional format, so an example would be "+49 89 123456" for a num‐
	      ber  in  Munich,	Germany.  Station  IDs may only consist of the
	      "+"-sign, spaces and the digits 0-9. The maximal length  is  20.
	      This value can be overwritten in the user sections individually.

	      This option is mandatory.

       fax_headline="<your faxheadline>"
	      Default  fax  headline to use when sending a fax document. Where
	      and if this headline will be presented depends on the  implemen‐
	      tation  of  your CAPI driver. The headline should have a reason‐
	      able length to fit on the top of a page, but there's no definite
	      limit given.

	      This  option  is optional. If not given, it defaults to an empty
	      headline.

       fax_email_from="<mailaddress>"
	      You can  set  a  default	originator  ("From"-address)  for  the
	      e-mails CapiSuite sends here.

	      This option is optional. If you set this to an empty string, the
	      destinator is used as originator (i.e. if	 "gernot"  receives  a
	      fax, the mail comes from "gernot" to "gernot").

THE USER SECTIONS
       outgoing_MSN
	      User specific value for the corresponding global option

       outgoing_timeout
	      User specific value for the corresponding global option

       fax_stationID
	      User specific value for the corresponding global option

       fax_headline
	      User specific value for the corresponding global option

       fax_email_from
	      User specific value for the corresponding global option

       fax_numbers="<number1>,<number2>,..."
	      A	 list  containing  the	numbers	 on  which  this user wants to
	      receive incoming fax calls. These numbers	 are  used  to	differ
	      between  users - so the same number must not appear in more than
	      one user section! The numbers are separated with commas  and  no
	      blanks  are allowed. The first number of the list also serves as
	      our own number for sending a fax if outgoing_MSN is not set (see
	      outgoing_MSN).

	      If  you  want to use the same number for receiving fax and voice
	      calls, pleasedo not enter it here. Use the voice_numbers	option
	      instead  (see answering_machine.conf(5)) - the answering machine
	      has a built in fax detection and can also receive faxes.

	      When this list is set to *,all incoming calls will  be  accepted
	      for  this user (use with care!). This is only useful for a setup
	      with only one user which wants to receive any call as fax.

	      If for any reason no destination number is signalled for special
	      MSNs  (austrian telecom seems to do this for the main MSN, where
	      it is called "Global Call"), you can  use	 the  special  sign  -
	      which means "no destination number available".

	      This  option  is	optional. If not given, the user can't receive
	      fax documents.

       fax_email=""
	      If  given,  this	string	indicates  email-addresses  where  the
	      received	faxes will be sent to. More addresses are separated by
	      commas. If it is empty, they will be sent to the user account on
	      the  system CapiSuite is running on. The address is also used to
	      send status reports for sent fax jobs  to.  If  you  don't  want
	      emails  to  be  sent  at	all, use the action option (see option
	      fax_action) below.

	      This option is optional. If not given, the mail is sent  to  the
	      system account.

       fax_action="MailAndSave"
	      Here  you	 can  define  what action will be taken when a call is
	      received. Currently, two possible actions are supported:

	      MailAndSave
		     The received call will be mailed  to  the	given  address
		     (seefax_email  above)  and saved to the fax_user_dir (see
		     global options)

	      SaveOnly
		     The call will be only  saved  to  the  fax_user_dir  (see
		     global options)

	      This option is mandatory.

SEE ALSO
       capisuite(8),  capisuite.conf(5), answering_machine.conf(5), capisuite‐
       fax(1)

AUTHOR
       Gernot Hillier <gernot@hillier.de>.

								   FAX.CONF(5)
[top]

List of man pages available for OpenSuSE

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net