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.\" 30.Dd October 20, 2003 31.Dt REMOTE 5 32.Os 33.Sh NAME 34.Nm remote 35.Nd remote host description file 36.Sh DESCRIPTION 37The systems known by 38.Xr tip 1 39and their attributes are stored in an 40.Tn ASCII 41file which 42is structured somewhat like the 43.Xr termcap 5 44file. 45Each line in the file provides a description for a single 46.Em system . 47Fields are separated by a colon (``:''). 48Lines ending in a \e character with an immediately following newline are 49continued on the next line. 50.Pp 51The first entry is the name(s) of the host system. 52If there is more 53than one name for a system, the names are separated by vertical bars. 54After the name of the system comes the fields of the description. 55A field name followed by an `=' sign indicates a string value. 56A field name followed by a `#' sign indicates a numeric value. 57.Pp 58Entries named ``tip*'' and ``cu*'' are used as default entries by 59.Xr tip 1 , 60and the 61.Xr cu 1 62interface to 63.Nm tip , 64as follows. 65When 66.Nm tip 67is invoked with only a phone number, it looks for an entry 68of the form ``tip300'', where 300 is the data rate with 69which the connection is to be made. 70When the 71.Nm cu 72interface is used, entries of the form ``cu300'' are used. 73.Sh CAPABILITIES 74Capabilities are either strings (str), numbers (num), or boolean 75flags (bool). 76A string capability is specified by 77.Em capability Ns Ar = Ns Em value ; 78for example, ``dv=/dev/harris''. 79A numeric capability is specified by 80.Em capability Ns Ar # Ns Em value ; 81for example, ``xa#99''. 82A boolean capability is specified by simply listing the capability. 83.Bl -tag -width indent 84.It Cm \&at 85(str) 86Auto call unit type. 87.It Cm \&br 88(num) 89The data rate (bits per second) used for communications on the 90serial port. 91When a modem is used, the data rate used to communicate 92with the remote modem may be different than this rate. 93This is a decimal number. 94The default rate is 115200 bits per second. 95.It Cm \&cm 96(str) 97An initial connection message to be sent to the remote host. 98For example, if a host is reached through a port selector, this 99might be set to the appropriate sequence required to switch to the host. 100.It Cm \&cu 101(str) 102Call unit if making a phone call. 103Default is the same as the `dv' field. 104.It Cm \&di 105(str) 106Disconnect message sent to the host when a disconnect is requested by 107the user. 108.It Cm \&du 109(bool) 110This host is on a dial-up line. 111.It Cm \&dv 112(str) 113.Ux 114device(s) to open to establish a connection. 115If this file refers to a terminal line, 116.Xr tip 1 117attempts to perform an exclusive open on the device to ensure only 118one user at a time has access to the port. 119.It Cm \&el 120(str) 121Characters marking an end-of-line. 122The default is 123.Dv NULL . 124`~' escapes are only 125recognized by 126.Nm tip 127after one of the characters in `el', or after a carriage-return. 128.It Cm \&fs 129(str) 130Frame size for transfers. 131The default frame size is equal to 132.Dv BUFSIZ . 133.It Cm \&hd 134(bool) 135The host uses half-duplex communication, local echo should be performed. 136.It Cm \&ie 137(str) 138Input end-of-file marks. 139The default is 140.Dv NULL . 141.It Cm \&oe 142(str) 143Output end-of-file string. 144The default is 145.Dv NULL . 146When 147.Nm tip 148is transferring a file, this 149string is sent at end-of-file. 150.It Cm \&pa 151(str) 152The type of parity to use when sending data 153to the host. 154This may be one of ``even'', 155``odd'', ``none'', ``zero'' (always set bit 8 to zero), 156``one'' (always set bit 8 to 1). 157The default is even parity. 158.It Cm \&pn 159(str) 160Telephone number(s) for this host. 161If the telephone number field contains an @ sign, 162.Nm tip 163searches the file 164.Pa /etc/phones 165file for a list of telephone numbers (see 166.Xr phones 5 ) . 167.It Cm \&tc 168(str) 169Indicates that the list of capabilities is continued in the named 170description. 171This is used primarily to share common capability information. 172.El 173.Sh FILES 174.Bl -tag -width /etc/remote -compact 175.It Pa /etc/remote 176The 177.Nm 178host description file resides in 179.Pa /etc . 180.El 181.Sh EXAMPLES 182Here is a short example showing the use of the capability continuation 183feature. 184It defines a 56k modem connection on the first serial port at 115200 185bits per second, no parity using the Hayes command set with standard 186line editing and end of file characters. 187The arpavax entry includes everything in the UNIX-57600 entry plus 188the phone number for arpavax (in this case an @ character so that it 189is retrieved from the environment). 190.Bd -literal 191UNIX-57600:\e 192:dv=/dev/cuau0:el=^D^U^C^S^Q^O@:oe=^D:du:at=hayes:br#115200:pa=none: 193arpavax|ax:\e 194:pn=\e@:tc=UNIX-57600 195.Ed 196.Sh SEE ALSO 197.Xr cu 1 , 198.Xr tip 1 , 199.Xr phones 5 200.Sh HISTORY 201The 202.Nm 203file format appeared in 204.Bx 4.2 . 205.Sh BUGS 206The 207.Xr tip 1 208utility uses its own notion of the serial ports data rate rather than the 209system default for a serial port. 210