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.Dd October 20, 2003 29.Dt REMOTE 5 30.Os 31.Sh NAME 32.Nm remote 33.Nd remote host description file 34.Sh DESCRIPTION 35The systems known by 36.Xr tip 1 37and their attributes are stored in an 38.Tn ASCII 39file which 40is structured somewhat like the 41.Xr termcap 5 42file. 43Each line in the file provides a description for a single 44.Em system . 45Fields are separated by a colon (``:''). 46Lines ending in a \e character with an immediately following newline are 47continued on the next line. 48.Pp 49The first entry is the name(s) of the host system. 50If there is more 51than one name for a system, the names are separated by vertical bars. 52After the name of the system comes the fields of the description. 53A field name followed by an `=' sign indicates a string value. 54A field name followed by a `#' sign indicates a numeric value. 55.Pp 56Entries named ``tip*'' and ``cu*'' are used as default entries by 57.Xr tip 1 , 58and the 59.Xr cu 1 60interface to 61.Nm tip , 62as follows. 63When 64.Nm tip 65is invoked with only a phone number, it looks for an entry 66of the form ``tip300'', where 300 is the data rate with 67which the connection is to be made. 68When the 69.Nm cu 70interface is used, entries of the form ``cu300'' are used. 71.Sh CAPABILITIES 72Capabilities are either strings (str), numbers (num), or boolean 73flags (bool). 74A string capability is specified by 75.Em capability Ns Ar = Ns Em value ; 76for example, ``dv=/dev/harris''. 77A numeric capability is specified by 78.Em capability Ns Ar # Ns Em value ; 79for example, ``xa#99''. 80A boolean capability is specified by simply listing the capability. 81.Bl -tag -width indent 82.It Cm \&at 83(str) 84Auto call unit type. 85.It Cm \&br 86(num) 87The data rate (bits per second) used for communications on the 88serial port. 89When a modem is used, the data rate used to communicate 90with the remote modem may be different than this rate. 91This is a decimal number. 92The default rate is 115200 bits per second. 93.It Cm \&cm 94(str) 95An initial connection message to be sent to the remote host. 96For example, if a host is reached through a port selector, this 97might be set to the appropriate sequence required to switch to the host. 98.It Cm \&cu 99(str) 100Call unit if making a phone call. 101Default is the same as the `dv' field. 102.It Cm \&di 103(str) 104Disconnect message sent to the host when a disconnect is requested by 105the user. 106.It Cm \&du 107(bool) 108This host is on a dial-up line. 109.It Cm \&dv 110(str) 111.Ux 112device(s) to open to establish a connection. 113If this file refers to a terminal line, 114.Xr tip 1 115attempts to perform an exclusive open on the device to ensure only 116one user at a time has access to the port. 117.It Cm \&el 118(str) 119Characters marking an end-of-line. 120The default is 121.Dv NULL . 122`~' escapes are only 123recognized by 124.Nm tip 125after one of the characters in `el', or after a carriage-return. 126.It Cm \&fs 127(str) 128Frame size for transfers. 129The default frame size is equal to 130.Dv BUFSIZ . 131.It Cm \&hd 132(bool) 133The host uses half-duplex communication, local echo should be performed. 134.It Cm \&ie 135(str) 136Input end-of-file marks. 137The default is 138.Dv NULL . 139.It Cm \&oe 140(str) 141Output end-of-file string. 142The default is 143.Dv NULL . 144When 145.Nm tip 146is transferring a file, this 147string is sent at end-of-file. 148.It Cm \&pa 149(str) 150The type of parity to use when sending data 151to the host. 152This may be one of ``even'', 153``odd'', ``none'', ``zero'' (always set bit 8 to zero), 154``one'' (always set bit 8 to 1). 155The default is even parity. 156.It Cm \&pn 157(str) 158Telephone number(s) for this host. 159If the telephone number field contains an @ sign, 160.Nm tip 161searches the file 162.Pa /etc/phones 163file for a list of telephone numbers (see 164.Xr phones 5 ) . 165.It Cm \&tc 166(str) 167Indicates that the list of capabilities is continued in the named 168description. 169This is used primarily to share common capability information. 170.El 171.Sh FILES 172.Bl -tag -width /etc/remote -compact 173.It Pa /etc/remote 174The 175.Nm 176host description file resides in 177.Pa /etc . 178.El 179.Sh EXAMPLES 180Here is a short example showing the use of the capability continuation 181feature. 182It defines a 56k modem connection on the first serial port at 115200 183bits per second, no parity using the Hayes command set with standard 184line editing and end of file characters. 185The arpavax entry includes everything in the UNIX-57600 entry plus 186the phone number for arpavax (in this case an @ character so that it 187is retrieved from the environment). 188.Bd -literal 189UNIX-57600:\e 190:dv=/dev/cuau0:el=^D^U^C^S^Q^O@:oe=^D:du:at=hayes:br#115200:pa=none: 191arpavax|ax:\e 192:pn=\e@:tc=UNIX-57600 193.Ed 194.Sh SEE ALSO 195.Xr cu 1 , 196.Xr tip 1 , 197.Xr phones 5 198.Sh HISTORY 199The 200.Nm 201file format appeared in 202.Bx 4.2 . 203.Sh BUGS 204The 205.Xr tip 1 206utility uses its own notion of the serial ports data rate rather than the 207system default for a serial port. 208