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