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