usr.bin/tip/modems.5

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)modems.5    3/24/95
  29 .\" $FreeBSD: src/usr.bin/tip/tip/modems.5,v 1.5.2.5 2001/08/16 13:17:07 ru Exp $
  30 .\"
  31 .Dd March 24, 1995
  32 .Dt MODEMS 5
  33 .Os
  34 .Sh NAME
  35 .Nm modems
  36 .Nd modem configuration data base
  37 .Sh DESCRIPTION
  38 The modems known by
  39 .Xr tip 1
  40 and their attributes are stored in an
  41 .Tn ASCII
  42 file which
  43 is structured somewhat like the
  44 .Xr termcap 5
  45 file.  Each line in the file provides a description for a single
  46 .Em modem .
  47 Fields are separated by a colon (``:'').
  48 Lines ending in a \e character with an immediately following newline are
  49 continued on the next line.
  50 .Pp
  51 The first entry is the name(s) of the modem.  If there is more
  52 than one name for a modem, the names are separated by vertical bars.
  53 After the name of the modem comes the fields of the description.  A
  54 field name followed by an `=' sign indicates a string value follows.  A field
  55 name followed by a `#' sign indicates a following numeric value.
  56 .Pp
  57 When
  58 .Xr tip 1
  59 is invoked, an entry for a remote system is looked up in the
  60 .Pa /etc/remote
  61 database.
  62 If the entry includes an "ACU" type capability (abbreviated at),
  63 .Xr tip 1
  64 looks up the specified modem in
  65 .Pa /etc/modems .
  66 If a modem entry is found,
  67 the corresponding capabilities determine how
  68 .Xr tip 1
  69 programs the modem when connecting to and disconnecting from the
  70 remote system.
  71 .Sh CAPABILITIES
  72 Capabilities are either strings (str), numbers (num), or boolean
  73 flags (bool).  A string capability is specified by
  74 .Em capability Ns Ar = Ns Em value ;
  75 for example, ``reset_command=ATZ\\r''.  A numeric capability is specified by
  76 .Em capability Ns Ar # Ns Em value ;
  77 for example, ``intercharacter_delay#50''.  A boolean capability is specified
  78 by simply listing the capability.
  79 .Bl -tag -width intercharacter_delay
  80 .It Cm \&dial_command
  81 (str)
  82 AT command used to dial remote system (typically, "ATDT")
  83 .It Cm \&echo_off_command
  84 (str)
  85 AT command to turn off command echo.
  86 .It Cm \&escape_guard_time
  87 (num)
  88 The delay, expressed in milliseconds, used to frame return-to-command
  89 escape sequences.
  90 .It Cm \&escape_sequence
  91 (str)
  92 The return-to-command escape sequence.
  93 .It Cm \&hangup_command
  94 (str)
  95 AT command used to hangup modem.
  96 .It Cm \&hw_flow_control
  97 (bool)
  98 Enable hardware (RTS/CTS) flow control between computer and modem (DTE/DCE).
  99 .It Cm \&init_string
 100 (str)
 101 AT command used to initialize modem before dialing.
 102 .It Cm \&intercharacter_delay
 103 (num)
 104 Delay value, expressed in milliseconds, between characters when sending commands
 105 to the modem.
 106 .It Cm \&intercommand_delay
 107 (num)
 108 Minimum delay value, expressed in milliseconds, to impose between commands
 109 issued to the modem.
 110 .It Cm \&lock_baud
 111 (bool)
 112 Use a fixed bit rate between the computer and the modem (DTE / DCE). The
 113 bit rate is specified in
 114 .Pa /etc/remote .
 115 .It Cm \&reset_command
 116 (str)
 117 AT command to reset the modem.
 118 .It Cm \&reset_delay
 119 (num)
 120 The time, expressed in milliseconds, required by the modem to complete
 121 a reset and return to a ready condition.
 122 .El
 123 .Sh FILES
 124 .Bl -tag -width /etc/modems -compact
 125 .It Pa /etc/modems
 126 The
 127 .Nm
 128 configuration database file
 129 resides in
 130 .Pa /etc .
 131 .El
 132 .Sh SEE ALSO
 133 .Xr tip 1 ,
 134 .Xr remote 5
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 file format appeared in
 139 .Bx 4.4 .