1.\" $NetBSD: remote.5,v 1.10 2000/11/17 10:14:20 lukem 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 54.Pq Dq \&: . 55Lines ending in a \e character with an immediately following newline are 56continued on the next line. 57.Pp 58The first entry is the name(s) of the host system. 59If there is more than one name for a system, the names are separated 60by vertical bars. 61After the name of the system comes the fields of the description. 62A field name followed by an `=' sign indicates a string value follows. 63A field name followed by a `#' sign indicates a following numeric value. 64.Pp 65Entries named 66.Dq tip* 67and 68.Dq cu* 69are used as default entries by 70.Xr tip 1 , 71and the 72.Xr cu 1 73interface to 74.Xr tip 1 , 75as follows. 76When 77.Xr tip 1 78is invoked with only a phone number, it looks for an entry 79of the form 80.Dq tip300 , 81where 300 is the baud rate with 82which the connection is to be made. 83When the 84.Xr cu 1 85interface is used, entries of the form 86.Dq cu300 87are used. 88.Sh CAPABILITIES 89Capabilities are either strings (str), numbers (num), or boolean flags (bool). 90A string capability is specified by 91.Em "capability=value" ; 92for example, 93.Dq Li dv=/dev/harris . 94A numeric capability is specified by 95.Em "capability#value" ; 96for example, 97.Dq Li xa#99 . 98A boolean capability is specified by simply listing the capability. 99.Bl -tag -width indent 100.It Cm \&at 101(str) 102Auto call unit type. 103.It Cm \&br 104(num) 105The baud rate used in establishing 106a connection to the remote host. 107This is a decimal number. 108The default baud rate is 300 baud. 109.It Cm \&cm 110(str) 111An initial connection message to be sent to the remote host. 112For example, if a host is reached through a port selector, this might 113be set to the appropriate sequence required to switch to the host. 114.It Cm \&cu 115(str) 116Call unit if making a phone call. 117Default is the same as the `dv' field. 118.It Cm \&dc 119(bool) 120This host is directly connected, and tip should not expect carrier detect 121to be high, nor should it exit if carrier detect drops. 122.It Cm \&di 123(str) 124Disconnect message sent to the host when a 125disconnect is requested by the user. 126.It Cm \&du 127(bool) 128This host is on a dial-up line. 129.It Cm \&dv 130(str) 131.Ux 132device(s) to open to establish a connection. 133If this file refers to a terminal line, 134.Xr tip 1 135attempts to perform an exclusive open on the device to ensure only 136one user at a time has access to the port. 137.It Cm \&el 138(str) 139Characters marking an end-of-line. 140The default is 141.Dv NULL . 142`~' escapes are only 143recognized by 144.Xr tip 1 145after one of the characters in `el', 146or after a carriage-return. 147.It Cm \&fs 148(str) 149Frame size for transfers. 150The default frame size is equal to 151.Dv BUFSIZ . 152.It Cm \&hd 153(bool) 154The host uses half-duplex communication, local 155echo should be performed. 156.It Cm \&hf 157(bool) 158Use hardware (RTS/CTS) flow control. 159.It Cm \&ie 160(str) 161Input end-of-file marks. 162The default is 163.Dv NULL . 164.It Cm \&oe 165(str) 166Output end-of-file string. 167The default is 168.Dv NULL . 169When 170.Xr tip 1 171is transferring a file, this 172string is sent at end-of-file. 173.It Cm \&pa 174(str) 175The type of parity to use when sending data 176to the host. 177This may be one of 178.Sy even , 179.Sy odd , 180.Sy none , 181.Sy zero 182(always set bit 8 to zero), 183.Sy one 184(always set bit 8 to one). 185The default is even parity. 186.It Cm \&pn 187(str) 188Telephone number(s) for this host. 189If the telephone number field contains an @ sign, 190.Xr tip 1 191searches the file 192.Pa /etc/phones 193file for a list of telephone numbers; 194see 195.Xr phones 5 . 196.It Cm \&tc 197(str) 198Indicates that the list of capabilities is continued in the named 199description. 200This is used primarily to share common capability information. 201.El 202.Pp 203Here is a short example showing the use of the capability continuation 204feature: 205.Bd -literal 206UNIX-1200:\e 207:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200: 208arpavax|ax:\e 209:pn=7654321%:tc=UNIX-1200 210.Ed 211.Sh FILES 212.Bl -tag -width /etc/remote -compact 213.It Pa /etc/remote 214The 215.Nm remote 216host description file 217resides in 218.Pa /etc . 219.El 220.Sh SEE ALSO 221.Xr tip 1 , 222.Xr phones 5 223.Sh HISTORY 224The 225.Nm 226file format appeared in 227.Bx 4.2 . 228