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 data 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 data rate (bits per second) used for communications on the 94serial port. 95When a modem is used, the data rate used to communicate 96with the remote modem may be different than this rate. 97This is a decimal number. 98The default rate is 9600 bits per second. 99.It Cm \&cm 100(str) 101An initial connection message to be sent to the remote host. 102For example, if a host is reached through a port selector, this 103might be set to the appropriate sequence required to switch to the host. 104.It Cm \&cu 105(str) 106Call unit if making a phone call. 107Default is the same as the `dv' field. 108.It Cm \&di 109(str) 110Disconnect message sent to the host when a disconnect is requested by 111the user. 112.It Cm \&du 113(bool) 114This host is on a dial-up line. 115.It Cm \&dv 116(str) 117.Ux 118device(s) to open to establish a connection. 119If this file refers to a terminal line, 120.Xr tip 1 121attempts to perform an exclusive open on the device to ensure only 122one user at a time has access to the port. 123.It Cm \&el 124(str) 125Characters marking an end-of-line. 126The default is 127.Dv NULL . 128`~' escapes are only 129recognized by 130.Nm tip 131after one of the characters in `el', or after a carriage-return. 132.It Cm \&fs 133(str) 134Frame size for transfers. 135The default frame size is equal to 136.Dv BUFSIZ . 137.It Cm \&hd 138(bool) 139The host uses half-duplex communication, local echo should be performed. 140.It Cm \&ie 141(str) 142Input end-of-file marks. 143The default is 144.Dv NULL . 145.It Cm \&oe 146(str) 147Output end-of-file string. 148The default is 149.Dv NULL . 150When 151.Nm tip 152is transferring a file, this 153string is sent at end-of-file. 154.It Cm \&pa 155(str) 156The type of parity to use when sending data 157to the host. 158This may be one of ``even'', 159``odd'', ``none'', ``zero'' (always set bit 8 to zero), 160``one'' (always set bit 8 to 1). 161The default is even parity. 162.It Cm \&pn 163(str) 164Telephone number(s) for this host. 165If the telephone number field contains an @ sign, 166.Nm tip 167searches the file 168.Pa /etc/phones 169file for a list of telephone numbers (see 170.Xr phones 5 ) . 171.It Cm \&tc 172(str) 173Indicates that the list of capabilities is continued in the named 174description. 175This is used primarily to share common capability information. 176.El 177.Sh EXAMPLES 178Here is a short example showing the use of the capability continuation 179feature. 180It defines a 56k modem connection on the first serial port at 115200 181bits per second, no parity using the Hayes command set with standard 182line editing and end of file characters. 183The arpavax entry includes everything in the UNIX-57600 entry plus 184the phone number for arpavax (in this case an @ character so that it 185is retrieved from the environment). 186.Bd -literal 187UNIX-57600:\e 188:dv=/dev/cuaa0:el=^D^U^C^S^Q^O@:oe=^D:du:at=hayes:br#115200:pa=none: 189arpavax|ax:\e 190:pn=\e@:tc=UNIX-57600 191.Ed 192.Sh FILES 193.Bl -tag -width /etc/remote -compact 194.It Pa /etc/remote 195The 196.Nm 197host description file resides in 198.Pa /etc . 199.El 200.Sh SEE ALSO 201.Xr cu 1 , 202.Xr tip 1 , 203.Xr phones 5 204.Sh HISTORY 205The 206.Nm 207file format appeared in 208.Bx 4.2 . 209.Sh BUGS 210The 211.Xr tip 1 212utility uses its own notion of the serial ports data rate rather than the 213system default for a serial port. 214