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