1.\" $NetBSD: remote.5,v 1.8 1999/03/17 20:19:47 garbled Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)remote.5 8.1 (Berkeley) 6/5/93 35.\" 36.Dd June 5, 1993 37.Dt REMOTE 5 38.Os 39.Sh NAME 40.Nm remote 41.Nd remote host description file 42.Sh DESCRIPTION 43The systems known by 44.Xr tip 1 45and their attributes are stored in an 46.Tn ASCII 47file which 48is structured somewhat like the 49.Xr termcap 5 50file. 51Each line in the file provides a description for a single 52.Em system . 53Fields are separated by a colon (``:''). 54Lines ending in a \e character with an immediately following newline are 55continued on the next line. 56.Pp 57The first entry is the name(s) of the host system. 58If there is more than one name for a system, the names are separated 59by vertical bars. 60After the name of the system comes the fields of the description. 61A field name followed by an `=' sign indicates a string value follows. 62A field name followed by a `#' sign indicates a following numeric value. 63.Pp 64Entries named ``tip*'' and ``cu*'' 65are used as default entries by 66.Xr tip 1 , 67and the 68.Xr cu 1 69interface to 70.Xr tip 1 , 71as follows. 72When 73.Xr tip 1 74is invoked with only a phone number, it looks for an entry 75of the form ``tip300'', where 300 is the baud rate with 76which the connection is to be made. 77When the 78.Xr cu 1 79interface is used, entries of the form ``cu300'' are used. 80.Sh CAPABILITIES 81Capabilities are either strings (str), numbers (num), or boolean flags (bool). 82A string capability is specified by 83.Em capability Ns Ar = Ns Em value ; 84for example, ``dv=/dev/harris''. 85A numeric capability is specified by 86.Em capability Ns Ar # Ns Em value ; 87for example, ``xa#99''. 88A boolean capability is specified by simply listing the capability. 89.Bl -tag -width indent 90.It Cm \&at 91(str) 92Auto call unit type. 93.It Cm \&br 94(num) 95The baud rate used in establishing 96a connection to the remote host. 97This is a decimal number. 98The default baud rate is 300 baud. 99.It Cm \&cm 100(str) 101An initial connection message to be sent to the remote host. 102For example, if a host is reached through a port selector, this might 103be set to the appropriate sequence required to switch to the host. 104.It Cm \&cu 105(str) 106Call unit if making a phone call. 107Default is the same as the `dv' field. 108.It Cm \&dc 109(bool) 110This host is directly connected, and tip should not expect carrier detect 111to be high, nor should it exit if carrier detect drops. 112.It Cm \&di 113(str) 114Disconnect message sent to the host when a 115disconnect is requested by the user. 116.It Cm \&du 117(bool) 118This host is on a dial-up line. 119.It Cm \&dv 120(str) 121.Ux 122device(s) to open to establish a connection. 123If this file refers to a terminal line, 124.Xr tip 1 125attempts to perform an exclusive open on the device to insure only 126one user at a time has access to the port. 127.It Cm \&el 128(str) 129Characters marking an end-of-line. 130The default is 131.Dv NULL . 132`~' escapes are only 133recognized by 134.Xr tip 1 135after one of the characters in `el', 136or after a carriage-return. 137.It Cm \&fs 138(str) 139Frame size for transfers. 140The default frame size is equal to 141.Dv BUFSIZ . 142.It Cm \&hd 143(bool) 144The host uses half-duplex communication, local 145echo should be performed. 146.It Cm \&hf 147(bool) 148Use hardware (RTS/CTS) flow control. 149.It Cm \&ie 150(str) 151Input end-of-file marks. 152The default is 153.Dv NULL . 154.It Cm \&oe 155(str) 156Output end-of-file string. 157The default is 158.Dv NULL . 159When 160.Xr tip 1 161is transferring a file, this 162string is sent at end-of-file. 163.It Cm \&pa 164(str) 165The type of parity to use when sending data 166to the host. 167This may be one of ``even'', ``odd'', ``none'', ``zero'' (always 168set bit 8 to zero), ``one'' (always set bit 8 to 1). 169The default is even parity. 170.It Cm \&pn 171(str) 172Telephone number(s) for this host. 173If the telephone number field contains an @ sign, 174.Xr tip 1 175searches the file 176.Pa /etc/phones 177file for a list of telephone numbers; 178see 179.Xr phones 5 . 180.It Cm \&tc 181(str) 182Indicates that the list of capabilities is continued in the named 183description. 184This is used primarily to share common capability information. 185.El 186.Pp 187Here is a short example showing the use of the capability continuation 188feature: 189.Bd -literal 190UNIX-1200:\e 191:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200: 192arpavax|ax:\e 193:pn=7654321%:tc=UNIX-1200 194.Ed 195.Sh FILES 196.Bl -tag -width /etc/remote -compact 197.It Pa /etc/remote 198The 199.Nm remote 200host description file 201resides in 202.Pa /etc . 203.El 204.Sh SEE ALSO 205.Xr tip 1 , 206.Xr phones 5 207.Sh HISTORY 208The 209.Nm 210file format appeared in 211.Bx 4.2 . 212