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