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