1.\" $OpenBSD: remote.5,v 1.11 2001/08/11 00:05:53 krw Exp $ 2.\" $NetBSD: remote.5,v 1.4 1997/04/20 00:05:27 mellon Exp $ 3.\" 4.\" Copyright (c) 1983, 1991, 1993 5.\" The Regents of the University of California. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 3. All advertising materials mentioning features or use of this software 16.\" must display the following acknowledgement: 17.\" This product includes software developed by the University of 18.\" California, Berkeley and its contributors. 19.\" 4. Neither the name of the University nor the names of its contributors 20.\" may be used to endorse or promote products derived from this software 21.\" without specific prior written permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" @(#)remote.5 8.1 (Berkeley) 6/5/93 36.\" 37.Dd June 5, 1993 38.Dt REMOTE 5 39.Os 40.Sh NAME 41.Nm remote 42.Nd remote host description file 43.Sh DESCRIPTION 44The systems known by 45.Xr tip 1 46and their attributes are stored in an 47.Tn ASCII 48file which is structured somewhat like the 49.Xr termcap 5 50file. 51Each line in the file provides a description for a single remote host. 52Fields are separated by a colon 53.Pq Sq \&: . 54Lines ending with a 55.Dq \e 56character immediately followed by a newline are continued on the next line. 57.Pp 58The first entry is the name(s) of the host system. 59If there is more than one name for a system, the names are separated by 60vertical bars 61.Pq Sq \&| . 62After the name of the system comes the fields of the description. 63A field name followed by an equal sign 64.Pq Sq = 65indicates a string value follows. 66A field name followed by a pound sign 67.Pq Sq # 68indicates a following numeric value. 69.Pp 70Entries named 71.Dq tip\&* 72.\"and 73.\".Dq cu\&* 74are used as default entries by 75.Xr tip 1 76.\"and the 77.\".Xr cu 1 78.\"interface to 79.\".Xr tip 1 , 80as follows. 81When 82.Xr tip 1 83is invoked with only a baud rate, it looks for an entry of the form 84.Dq tip<baud rate> . 85E.g. 86.Ic tip -300 87will cause 88.Xr tip 1 89to look for the system tip300. 90.\"When the 91.\".Xr cu 1 92.\"interface is used, entries of the form 93.\".Dq cu300 94.\"are used. 95.Sh CAPABILITIES 96Capabilities are either strings (str), numbers (num), or boolean flags (bool). 97A string capability is specified by 98.Em capability Ns Ar = Ns Em value ; 99for example, 100.Dq dv=/dev/harris . 101A numeric capability is specified by 102.Em capability Ns Ar # Ns Em value ; 103for example, 104.Dq xa#99 . 105A boolean capability is specified by simply listing the capability. 106.Bl -tag -width indent 107.It Sy \&at 108(str) 109Auto call unit type. 110.It Sy \&be 111(bool) 112Initialize the 113.Xr tip 1 114variable 115.Dq beautify 116to 117.Sy on , 118so that non-printable characters will be discarded when scripting. 119.It Sy \&br 120(num) 121The baud rate used in establishing 122a connection to the remote host. 123This is a decimal number. 124The default baud rate is 300 baud. 125.It Sy \&cm 126(str) 127An initial connection message to be sent to the remote host. 128For example, if a host is reached through port selector, this 129might be set to the appropriate sequence required to switch to the host. 130.It Sy \&cu 131(str) 132Call unit if making a phone call. 133Default is the same as the 134.Sy dv 135field. 136.It Sy \&dc 137(bool) 138This host is directly connected, and 139.Xr tip 1 140should not expect carrier detect to be high, nor should it exit if 141carrier detect drops. 142.It Sy \&di 143(str) 144Disconnect message sent to the host when a disconnect is requested by the user. 145.It Sy \&du 146(bool) 147This host is on a dial-up line. 148.It Sy \&dv 149(str) 150.Tn UNIX 151device(s) to open to establish a connection. 152If this file refers to a terminal line, 153.Xr tip 1 154attempts to perform an exclusive open on the device to ensure only 155one user at a time has access to the port. 156.It Sy \&ec 157(bool) 158Initialize the 159.Xr tip 1 160variable 161.Dq echocheck 162to 163.Sy on , 164so that 165.Xr tip 1 166will synchronize with the remote host during file 167transfer by waiting for the last character transmitted to echo. 168.It Sy \&el 169(str) 170Characters marking an end-of-line. 171The default is 172.Dv NULL . 173.Dq ~ 174escapes are only recognized by 175.Xr tip 1 176after one of the characters in 177.Sy el , 178or after a carriage-return. 179.It Sy \&es 180(str) 181The escape character for 182.Xr tip 1 . 183The default is 184.Dq ~ . 185.It Sy \&et 186(num) 187Number of seconds to wait for an echo response when 188.Dq echocheck 189mode is on. 190The default value is 10 seconds. 191.It Sy \&ex 192(str) 193Set of non-printable characters not to be discarded when scripting 194with beautification turned on. 195The default value is 196.Dq \et\en\eb\ef . 197.It Sy \&fo 198(str) 199Character used to force literal data transmission. 200The default value is 201.Sq \e020 202(^P). 203.It Sy \&fs 204(str) 205Frame size for transfers. 206The default frame size is equal to 207.Dv BUFSIZ . 208.It Sy \&hd 209(bool) 210The host uses half-duplex communication, local echo should be performed. 211.It Sy \&ie 212(str) 213Input end-of-file marks. 214The default is 215.Dv NULL . 216.It Sy \&nb 217(bool) 218Initialize the 219.Xr tip 1 220variable 221.Dq beautify 222to 223.Sy off , 224so that non-printable characters will not be discarded when scripting. 225.It Sy \&nt 226(bool) 227Initialize the 228.Xr tip 1 229variable 230.Dq tandem 231to 232.Sy off , 233so that XON/XOFF flow control will not be used to throttle data 234from the remote host. 235.It Sy \&nv 236(bool) 237Initialize the 238.Xr tip 1 239variable 240.Dq verbose 241to 242.Sy off , 243so that verbose mode will be turned off. 244.It Sy \&oe 245(str) 246Output end-of-file string. 247The default is 248.Dv NULL . 249When 250.Xr tip 1 251is transferring a file, this string is sent at end-of-file. 252.It Sy \&pa 253(str) 254The type of parity to use when sending data to the host. 255This may be one of 256.Dq even , 257.Dq odd , 258.Dq none , 259.Dq zero 260(always set bit 8 to zero), 261or 262.Dq one 263(always set bit 8 to 1). 264The default is no parity. 265.It Sy \&pn 266(str) 267Telephone number(s) for this host. 268Either a list of arbitrary dialing strings separated by 269commas, or a 270.Ql @ . 271An at sign, 272.Ql @ , 273tells 274.Xr tip 1 275to search the 276.Xr phones 5 277database for the list of telephone numbers. 278.Pp 279For modems or auto-call units that use a 280.Ql \&, 281in their dialing strings (hayes, courier, t3000) 282.Xr tip 1 283will convert any 284.Ql \&= 285in the string to a 286.Ql \&, 287when dialing. 288For modems or auto-call units that use a 289.Ql \&= 290in their dial strings, (v831), 291.Xr tip 1 292will convert any 293.Ql \&_ 294to a 295.Ql \&= 296when dialing. 297.It Sy \&pr 298(str) 299Character that indicates end-of-line on the remote host. 300The default value is 301.Sq \en . 302.It Sy \&ra 303(bool) 304Initialize the 305.Xr tip 1 306variable 307.Dq raise 308to 309.Sy on , 310so that lowercase letters are mapped to uppercase before sending 311them to the remote host. 312.It Sy \&rc 313(str) 314Character that toggles case-mapping mode. 315The default value is 316.Sq \e001 317(^A). 318.It Sy \&re 319(str) 320The file in which to record session scripts. 321The default value is 322.Pa tip.record . 323.It Sy \&rw 324(str) 325Initialize the 326.Xr tip 1 327variable 328.Dq rawftp 329to 330.Sy on , 331so that all characters will be sent as is during file transfers. 332.It Sy \&sc 333(bool) 334Initialize the 335.Xr tip 1 336variable 337.Dq script 338to 339.Sy on , 340so that everything transmitted by the remote host will be recorded. 341.It Sy \&ta 342(bool) 343Initialize the 344.Xr tip 1 345variable 346.Dq tandem 347to 348.Sy on , 349so that XON/XOFF flow control will be used to throttle data 350from the remote host. 351.It Sy \&tb 352(bool) 353Initialize the 354.Xr tip 1 355variable 356.Dq tabexpand 357to 358.Sy on , 359so that each tab will be expanded to 8 spaces during file transfers. 360.It Sy \&tc 361(str) 362Indicates that the list of capabilities is continued in the named description. 363This is used primarily to share common capability information. 364.It Sy \&vb 365(bool) 366Initialize the 367.Xr tip 1 368variable 369.Dq verbose 370to 371.Sy on , 372so that verbose mode will be turned on. 373.El 374.Pp 375Here is a short example showing the use of the capability continuation 376feature: 377.Bd -literal 378UNIX-1200:\e 379:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200: 380arpavax|ax:\e 381:pn=7654321%:tc=UNIX-1200 382.Ed 383.Sh FILES 384.Bl -tag -width /etc/remote -compact 385.It Pa /etc/remote 386Global database. 387.El 388.Sh SEE ALSO 389.Xr tip 1 , 390.Xr phones 5 391.Sh HISTORY 392The 393.Nm 394file format appeared in 395.Bx 4.2 . 396