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