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