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