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