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. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)remote.5 8.1 (Berkeley) 6/5/93 29.\" $FreeBSD$ 30.\" 31.Dd October 20, 2003 32.Dt REMOTE 5 33.Os 34.Sh NAME 35.Nm remote 36.Nd remote host description file 37.Sh DESCRIPTION 38The systems known by 39.Xr tip 1 40and their attributes are stored in an 41.Tn ASCII 42file which 43is structured somewhat like the 44.Xr termcap 5 45file. 46Each line in the file provides a description for a single 47.Em system . 48Fields are separated by a colon (``:''). 49Lines ending in a \e character with an immediately following newline are 50continued on the next line. 51.Pp 52The first entry is the name(s) of the host system. 53If there is more 54than one name for a system, the names are separated by vertical bars. 55After the name of the system comes the fields of the description. 56A field name followed by an `=' sign indicates a string value. 57A field name followed by a `#' sign indicates a numeric value. 58.Pp 59Entries named ``tip*'' and ``cu*'' are used as default entries by 60.Xr tip 1 , 61and the 62.Xr cu 1 63interface to 64.Nm tip , 65as follows. 66When 67.Nm tip 68is invoked with only a phone number, it looks for an entry 69of the form ``tip300'', where 300 is the data rate with 70which the connection is to be made. 71When the 72.Nm cu 73interface is used, entries of the form ``cu300'' are used. 74.Sh CAPABILITIES 75Capabilities are either strings (str), numbers (num), or boolean 76flags (bool). 77A string capability is specified by 78.Em capability Ns Ar = Ns Em value ; 79for example, ``dv=/dev/harris''. 80A numeric capability is specified by 81.Em capability Ns Ar # Ns Em value ; 82for example, ``xa#99''. 83A boolean capability is specified by simply listing the capability. 84.Bl -tag -width indent 85.It Cm \&at 86(str) 87Auto call unit type. 88.It Cm \&br 89(num) 90The data rate (bits per second) used for communications on the 91serial port. 92When a modem is used, the data rate used to communicate 93with the remote modem may be different than this rate. 94This is a decimal number. 95The default rate is 9600 bits per second. 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 FILES 175.Bl -tag -width /etc/remote -compact 176.It Pa /etc/remote 177The 178.Nm 179host description file resides in 180.Pa /etc . 181.El 182.Sh EXAMPLES 183Here is a short example showing the use of the capability continuation 184feature. 185It defines a 56k modem connection on the first serial port at 115200 186bits per second, no parity using the Hayes command set with standard 187line editing and end of file characters. 188The arpavax entry includes everything in the UNIX-57600 entry plus 189the phone number for arpavax (in this case an @ character so that it 190is retrieved from the environment). 191.Bd -literal 192UNIX-57600:\e 193:dv=/dev/cuau0:el=^D^U^C^S^Q^O@:oe=^D:du:at=hayes:br#115200:pa=none: 194arpavax|ax:\e 195:pn=\e@:tc=UNIX-57600 196.Ed 197.Sh SEE ALSO 198.Xr cu 1 , 199.Xr tip 1 , 200.Xr phones 5 201.Sh HISTORY 202The 203.Nm 204file format appeared in 205.Bx 4.2 . 206.Sh BUGS 207The 208.Xr tip 1 209utility uses its own notion of the serial ports data rate rather than the 210system default for a serial port. 211