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