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 .\" 4. 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 .\" $DragonFly: src/usr.bin/tip/tip/modems.5,v 1.2 2003/06/17 04:29:32 dillon Exp $
  31 .\"
  32 .Dd March 24, 1995
  33 .Dt MODEMS 5
  34 .Os
  35 .Sh NAME
  36 .Nm modems
  37 .Nd modem configuration data base
  38 .Sh DESCRIPTION
  39 The modems known by
  40 .Xr tip 1
  41 and their attributes are stored in an
  42 .Tn ASCII
  43 file which
  44 is structured somewhat like the
  45 .Xr termcap 5
  46 file.  Each line in the file provides a description for a single
  47 .Em modem .
  48 Fields are separated by a colon (``:'').
  49 Lines ending in a \e character with an immediately following newline are
  50 continued on the next line.
  51 .Pp
  52 The first entry is the name(s) of the modem.  If there is more
  53 than one name for a modem, the names are separated by vertical bars.
  54 After the name of the modem comes the fields of the description.  A
  55 field name followed by an `=' sign indicates a string value follows.  A field
  56 name followed by a `#' sign indicates a following numeric value.
  57 .Pp
  58 When
  59 .Xr tip 1
  60 is invoked, an entry for a remote system is looked up in the
  61 .Pa /etc/remote
  62 database.
  63 If the entry includes an "ACU" type capability (abbreviated at),
  64 .Xr tip 1
  65 looks up the specified modem in
  66 .Pa /etc/modems .
  67 If a modem entry is found,
  68 the corresponding capabilities determine how
  69 .Xr tip 1
  70 programs the modem when connecting to and disconnecting from the
  71 remote system.
  72 .Sh CAPABILITIES
  73 Capabilities are either strings (str), numbers (num), or boolean
  74 flags (bool).  A string capability is specified by
  75 .Em capability Ns Ar = Ns Em value ;
  76 for example, ``reset_command=ATZ\\r''.  A numeric capability is specified by
  77 .Em capability Ns Ar # Ns Em value ;
  78 for example, ``intercharacter_delay#50''.  A boolean capability is specified
  79 by simply listing the capability.
  80 .Bl -tag -width intercharacter_delay
  81 .It Cm \&dial_command
  82 (str)
  83 AT command used to dial remote system (typically, "ATDT")
  84 .It Cm \&echo_off_command
  85 (str)
  86 AT command to turn off command echo.
  87 .It Cm \&escape_guard_time
  88 (num)
  89 The delay, expressed in milliseconds, used to frame return-to-command
  90 escape sequences.
  91 .It Cm \&escape_sequence
  92 (str)
  93 The return-to-command escape sequence.
  94 .It Cm \&hangup_command
  95 (str)
  96 AT command used to hangup modem.
  97 .It Cm \&hw_flow_control
  98 (bool)
  99 Enable hardware (RTS/CTS) flow control between computer and modem (DTE/DCE).
 100 .It Cm \&init_string
 101 (str)
 102 AT command used to initialize modem before dialing.
 103 .It Cm \&intercharacter_delay
 104 (num)
 105 Delay value, expressed in milliseconds, between characters when sending commands
 106 to the modem.
 107 .It Cm \&intercommand_delay
 108 (num)
 109 Minimum delay value, expressed in milliseconds, to impose between commands
 110 issued to the modem.
 111 .It Cm \&lock_baud
 112 (bool)
 113 Use a fixed bit rate between the computer and the modem (DTE / DCE). The
 114 bit rate is specified in
 115 .Pa /etc/remote .
 116 .It Cm \&reset_command
 117 (str)
 118 AT command to reset the modem.
 119 .It Cm \&reset_delay
 120 (num)
 121 The time, expressed in milliseconds, required by the modem to complete
 122 a reset and return to a ready condition.
 123 .El
 124 .Sh FILES
 125 .Bl -tag -width /etc/modems -compact
 126 .It Pa /etc/modems
 127 The
 128 .Nm
 129 configuration database file
 130 resides in
 131 .Pa /etc .
 132 .El
 133 .Sh SEE ALSO
 134 .Xr tip 1 ,
 135 .Xr remote 5
 136 .Sh HISTORY
 137 The
 138 .Nm
 139 file format appeared in
 140 .Bx 4.4 .