yaps.html

使用Modem发送网上传呼

<Dt> conv-table &lt;text&gt;
<Dd> The value is a filename to a character conversion table. This affects
only the message (and depending on the protocol the pagerid) and allows
transforming illegal characters to valid ones.
<Dt> convert &lt;text&gt;
<Dd> This is comma seperated list of direct change entries of the convertion
table. If you want to include more than one pair, the block construct using
curly brackets (<em>{..}</em>) must be used. Each line contains a source and
a destination character, i.e. if the source character is encountered in a
message, the destination character is used for it. There are also some
predefined convertion rules, which all starts with an asterisk:
     <Ul Compact>
     <Li> <strong>*no-control</strong> control characters are suppressed
     <Li> <strong>*control</strong> control characters are inserted literal
     <Li> <strong>*no-8bit</strong> no characters with 8'th bit set are
          included
     <Li> <strong>*8bit</strong> use also characters with 8'th bit set.
     <Li> <strong>*numeric</strong> only numeric characters are allowed.
     </Ul>
<Dt> cost &lt;text&gt;
<Dd> This string is used to calculate the costs for each call. The
description is a comma seperated list of variables with equal sign seperated
optional value. These variables are currently implemented:
     <Dl Compact>
     <Dt> fixed
     <Dd> This tells the software, that the cost are fixed per call, i.e.
	  no real calculation takes place according to the used entities.
     <Dt> entity-length=&lt;entity&gt;
     <Dd> This is the length of one entity. This is interpreted as a
	  floating point number.
     <Dt> max-entities=&lt;count&gt;
     <Dd> Some providers only charge until a maximum of entites had
	  been used and stop then charging.
     <Dt> dial-overhead=&lt;seconds&gt;
     <Dd> The counter starts before dialing. Typically it takes some
	  time from dialing to the first billed entity. This time can
	  be specified using this variable.
     <Dt> cost=&lt;cost&gt;
     <Dd> This is the cost per entity (or the whole cost on fixed charging
	  services). This is a floating point number.
     <Dt> unit=&lt;string&gt;
     <Dd> This string is appended in the logfile for the currency. This is
	  only of cosmetic value.
     <Dt> remainder=&lt;digits&gt;
     <Dd> This is the number of digits after the point in the cost display.
	  This value is typical two.
     <Dt> timetable=&lt;description&gt;
     <Dd> If a timetable entry is given, then the cost are calculated
	  depending on weekday and time. On fixed charging services the
	  value describes the complete costs for the call, in the other
	  case the value is the entity-length for this day/time. The
	  description is a semi-colon seperated list of single entries of
	  the form:<BR>
<strong>&lt;Weekday(s)&gt;&lt;from&gt;-&lt;to&gt;=&lt;value&gt;</strong><BR>
	  Each weekday is a two letter sequence (So, Mo, Tu, We, Th, Fr, Sa)
	  and there are three special &quot;weekdays&quot;: <em>Wk</em> for
	  working days (monday to friday), <em>Ss</em> for weekend
	  (saturday and sunday) and <em>al</em> for all days. A typical
	  example may look like:
	  <strong>Wk0800-1800=12;Wk1800-0800=24;Ss=24</strong>, but this
	  could be written shorter as:
	  <strong>=24;Wk0800-1800=12</strong> because the first entry is
	  taken as the default, if no match is found. And the construct
	  <em>=24</em> does not contain any weekday, so it is invalid for
	  any regular check.
     </Dl>
<Dt> force &lt;bool&gt;
<Dd> If a feature is requested, but this service do not support it, the
message will still be delivered, if this variable is set to True.
<Dt> can-delay &lt;bool&gt;
<Dd> Set this to True, if the service provider accepts a delay for sending
the message.
<Dt> can-expire &lt;bool&gt;
<Dd> Set this to True, if the service provider allowes the setting of an
expiration timestamp.
<Dt> can-rds &lt;bool&gt;
<Dd> Set this to True, if the service provider allowes the request for a
delivery status.
<Dt> rds &lt;bool&gt;
<Dd> Set this to True, if <em>can-rds</em> is True and you always want to
get a delivery status.
<Dt> check-call-id &lt;check&gt;
<Dd> The caller id must match the <strong>check</strong> expression.
<Dt> check-pager-id &lt;check&gt;
<Dd> Each pager id must match the <strong>check</strong> expression.
</Dl>

<H2>Modem section</H2>

Each modem should have its own section. Following entries are currently
supported:

<Dl>
<Dt> device &lt;text&gt;
<Dd> The filename for the device where the modem is attached to.
<Dt> lock-prefix &lt;text&gt;
<Dd> This is the pathname to prefix the basename of the modemdevice to
create lockfiles. This can be used to enable more than one application to
use the modem.
<Dt> lock-method &lt;text&gt;
<Dd> This is a comma seperated list of locking mechanism. Currently these
flags are supported:
     <Ul Compact>
     <Li> <em>ascii</em> PID is stored as ASCII text in lockfile.
     <Li> <em>binary</em> PID is stored in machine representation in
	  lockfile. 
     <Li> <em>lower</em> converts device part of lockfile to lower case.
     <Li> <em>upper</em> converts device part of lockfile to upper case.
     <Li> <em>sysv4</em> append SysV4 style infos to lockfile instead of the
	  basename of the device.
     <Li> <em>timeout=&lt;secs&gt;</em> tries to lock the device
	  <strong>secs</strong> seconds.
     </Ul>
<Dt> init &lt;text&gt;
<Dd> This is the init sequence to initialize the modem.
<Dt> dial &lt;text&gt;
<Dd> This is the dial sequence to dial a phone number with the modem. An
<strong>\L</strong> in the string will be replaced by the phone number.
<Dt> timeout &lt;num&gt;
<Dd> This is the default timeout to wait for responses of the modem.
<Dt> reset &lt;text&gt;
<Dd> This is the sequence to reset the modem.
<Dt> local-init &lt;text&gt;
<Dd> This is used to customize an existing modem entry for different purpose
(e.g. force a specific connect rate, etc.)
</Dl>

Beside this the section may contain protocol specific entries to adapt the
protocol for this service.

<H2>ASCII based protocol</H2>

A <strong>\C</strong> is replaced with the caller id, if available. If
request a delivery report is switched on, a <strong>\R</strong> is replaced
with <em>1</em>, else with <em>0</em>.

<Dl>
<Dt> asc-timeout &lt;num&gt;
<Dd> This is the default timeout for sequences when communicating with the
remote side.
<Dt> asc-login &lt;text&gt;
<Dd> This is the sequence to login to the remote service.
<Dt> asc-logout &lt;text&gt;
<Dd> This is the sequence to logout from the remote service.
<Dt> asc-pagerid &lt;text&gt;
<Dd> This is the sequence to embedded the pager id to be sent.
<strong>\P</strong> is replaced with the pager id.
<Dt> asc-message &lt;text&gt;
<Dd> Dito for the message, <strong>\M</strong> is replaced with the message.
<Dt> asc-next &lt;text&gt;
<Dd> This is the sequence to start the next transmission.
<Dt> asc-sync &lt;text&gt;
<Dd> If we get out of sync, then this sequence should bring us back to a
stage as if we had just loged in.
</Dl>

<H2>Script specific</H2>

<Dl>
<Dt> script-type &lt;text&gt;
<Dd> This is the scripting language to choose. Currently these are
supported: <strong>SLang</strong>, <strong>Lua</strong>.
<Dt> script-name &lt;text&gt;
<Dd> This is the name (e.g. the name of the variable containing) the script.
If the name starts with a slash or a plus sign, then the value is treated as
a filename from where the script should be read. The plus sign is stripped
off before opening the file.
<Dt> scr-login &lt;text&gt;
<Dd> This is the function/label where to start at login. If the caller id is
available (and the language supports it) the caller id is passed as an
argument.
<Dt> scr-logout &lt;text&gt;
<Dd> Dito for logout.
<Dt> scr-pagerid &lt;text&gt;
<Dd> Dito for sending the pagerid. The pagerid is passed as an argument.
<Dt> scr-message &lt;text&gt;
<Dd> Dito for sending the message. The message is passed as an argument.
<Dt> scr-next &lt;text&gt;
<Dd> Dito to go to the next message.
<Dt> scr-sync &lt;text&gt;
<Dd> Dito to sync to a definite state (i.e. as if we had just loged in.)
</Dl>

<H2>TAP specific</H2>

<Dl>
<Dt> tap-t1, tap-t2, tap-t3, tap-t4, tap-t5 &lt;num&gt;
<Dd> This is the timeout for each stage defined in the TAP specification.
See 
<a href="http://www.mot.com/MIMS/MSPG/pcia_protocols/tap_v1p8/timing_retry_parameters.html#params">
there</a>
for details.
<Dt> tap-n1, tap-n2, tap-n3 &lt;num&gt;
<Dd> This is the retry count for each stage defined int the TAP
specification. See 
<a href="http://www.mot.com/MIMS/MSPG/pcia_protocols/tap_v1p8/timing_retry_parameters.html#params">
there</a>
for details.
<Dt> tap-login-count &lt;num&gt;
<Dd> This is the number of tries to login to the remote service.
<Dt> tap-logout-count &lt;num&gt;
<Dd> This is the number of tries to logout from the remote service.
</Dl>

<H2>UCP specific</H2>

<Dl>
<Dt> ucp-timeout &lt;num&gt;
<Dd> This is the time to wait for an answer from the remote system. The
documentation says that this could be about 40 to 60 seconds. This depends
on the provider.
<Dt> ucp-retry &lt;num&gt;
<Dd> This specifies how often a message should be sent, until the program
gives up.
<Dt> ucp-extend &lt;bool&gt;
<Dd> If this is True then the extend UCP implementation is used, i.e. the
more complex, but more flexibel protocol (currently only possible on german
cellular phone provider Mannesmann D2.)
<Dt> ucp-ds-timeout &lt;num&gt;
<Dd> Wait a maximum of this value seconds for receiving of the delivery
status.
</Dl>

<H2>Alias section</H2>

The entries in this section are not able to access the global entries. Each
entry contains an alias name with its real number.


<H1 ID="cmdline">Command Line</H1>

Yaps support several command line parameter which can overwrite the possibly
used default values in the configuration files. Following options are
understood by this program (on some systems, there are is also support for
long options):

<Dl>
<Dt> -C &lt;configfile&gt;, --config=&lt;configfile&gt;
<Dd> Use <strong>cfgfile</strong> instead of the default global
configuration file <em>/etc/yaps.rc</em>.
<Dt> -s &lt;service&gt;, --service=&lt;service&gt;
<Dd> Use paging service <strong>service</strong> instead of the default of
the configuration file.
<Dt> -t, --truncate
<Dd> If this is set, then a message is truncated, if it is longer than the
allowed limit of the choosen service.
<Dt> -c &lt;callid&gt;, --call-id=&lt;callid&gt;
<Dd> Use <strong>callid</strong> as the caller id.
<Dt> -S &lt;signature&gt;, --signature=&lt;signature&gt;
<Dd> If signature appending is enabled by the service, use this string as
the signature.
<Dt> -l &lt;logfile&gt;, --logfile=&lt;logfile&gt;
<Dd> Write status of transmission to <strong>logfile</strong>.
<Dt> -L &lt;logstr&gt;, --logstring=&lt;logstr&gt;
<Dd> This is used to select the messages written to the logfile. See 
<a href="#logstr">above</a> unter the configuration entry
<em>logstring</em> for a detailed description.
<Dt> -f, --force
<Dd> Force sending of messages, even if -d/-e/-r is not supported by the
service.
<Dt> -d &lt;date&gt;, --delay=&lt;date&gt;
<Dd> If the service supports it, the message is delayed and sent at
<strong>date</strong>.
<Dt> -e &lt;date&gt;, --expire=&lt;date&gt;
<Dd> If the service supports it, the message is deleted, if this date is
reached and the message had not been transmitted until then.
<Dt> -r, --request-delivery-status
<Dd> If the service supports it, a delivery status is requested.
<Dt> -R &lt;fname&gt;, --final-report=&lt;fname&gt;
<Dd> A final report is written to <em>fname</em> (or stdout, if fname is
<strong>-</strong>.) This feature is useful to check which message had been
delivered successfully or not.
<Dt> -z &lt;fname&gt;, --message-file=&lt;fname&gt;
<Dd> Reads pager-ids and messages form <em>fname</em>. Each line contains
one pair, seperated by whitespace(s).
<Dt> -v, --verbose
<Dd> Increase the verbosity of yaps, more -v's give more debug output.
<Dt> -p, --print-config
<Dd> This is used to printout configuration values for testing purpose. The
remaining paramters are variables to print out with their value.
</Dl>

Following the options the user has to give receiver/message pairs, all using
the same service. A receiver is either the pager id itself or an alias. If
the first character is a colon, then the colon is cut off and the remaining
part is taken as an alias, if the first character is a slash, it is cut off
as well and the remaining is taken as the pager id. If the first character
is a digit, it is taken as a pager id, otherwise as an alias. It is possible
to specify multiple receiver, if the receiver is a comma seperate list of
individual receivers. If the first character of the message is a plus sign,
then the remaining message is treated as a filename and the real message is
read from this file. If the message is just a minus (<strong>-</strong>),
then the message is read from stdin, if it is just a dot
(<strong>.</strong>), then the message is empty.<P>