1.\" $OpenBSD: remote.5,v 1.24 2010/07/02 09:18:54 sobrado 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 2 2010 $ 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 \&be 104(bool) 105Initialize the 106.Xr tip 1 107variable 108.Dq beautify 109to 110.Sy on , 111so that non-printable characters will be discarded when scripting. 112.It Sy \&br 113(num) 114The baud rate used in establishing 115a connection to the remote host. 116This is a decimal number. 117The default baud rate is 300 baud. 118.It Sy \&cm 119(str) 120An initial connection message to be sent to the remote host. 121For example, if a host is reached through port selector, this 122might be set to the appropriate sequence required to switch to the host. 123.It Sy \&dc 124(bool) 125This host is directly connected, and 126.Xr tip 1 127should not expect carrier detect to be high, nor should it exit if 128carrier detect drops. 129.It Sy \&di 130(str) 131Disconnect message sent to the host when a disconnect is requested by the user. 132.It Sy \&dv 133(str) 134.Tn UNIX 135device(s) to open to establish a connection. 136If this file refers to a terminal line, 137.Xr tip 1 138attempts to perform an exclusive open on the device to ensure only 139one user at a time has access to the port. 140.It Sy \&ec 141(bool) 142Initialize the 143.Xr tip 1 144variable 145.Dq echocheck 146to 147.Sy on , 148so that 149.Xr tip 1 150will synchronize with the remote host during file 151transfer by waiting for the last character transmitted to echo. 152.It Sy \&el 153(str) 154Characters marking an end-of-line. 155The default is 156.Dv NULL . 157.Dq ~ 158escapes are only recognized by 159.Xr tip 1 160after one of the characters in 161.Sy el , 162or after a carriage-return. 163.It Sy \&es 164(str) 165The escape character for 166.Xr tip 1 . 167The default is 168.Dq ~ . 169.It Sy \&et 170(num) 171Number of seconds to wait for an echo response when 172.Dq echocheck 173mode is on. 174The default value is 10 seconds. 175.It Sy \&ex 176(str) 177Set of non-printable characters not to be discarded when scripting 178with beautification turned on. 179The default value is 180.Dq \et\en\eb\ef . 181.It Sy \&fo 182(str) 183Character used to force literal data transmission. 184The default value is 185.Sq \e020 186(^P). 187.It Sy \&fs 188(str) 189Frame size for transfers. 190The default frame size is equal to 191.Dv BUFSIZ . 192.It Sy \&hd 193(bool) 194The host uses half-duplex communication, local echo should be performed. 195.It Sy \&hf 196(bool) 197Initialize the 198.Xr tip 1 199variable 200.Dq hardwareflow 201to 202.Sy on , 203so that hardware flow control (CRTSCTS) will be used for the 204connection with the remote host. 205.It Sy \&ie 206(str) 207Input end-of-file marks. 208The default is 209.Dv NULL . 210.It Sy \&ld 211(num) 212The line discipline to use for the remote tty. 213The default is to use the 214.Xr termios 4 215line discipline. 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 one). 264The default is no parity. 265.It Sy \&pr 266(str) 267Character that indicates end-of-line on the remote host. 268The default value is 269.Sq \en . 270.It Sy \&ra 271(bool) 272Initialize the 273.Xr tip 1 274variable 275.Dq raise 276to 277.Sy on , 278so that lowercase letters are mapped to uppercase before sending 279them to the remote host. 280.It Sy \&rc 281(str) 282Character that toggles case-mapping mode. 283The default value is 284.Dv NULL . 285.It Sy \&re 286(str) 287The file in which to record session scripts. 288The default value is 289.Pa tip.record . 290.It Sy \&rw 291(str) 292Initialize the 293.Xr tip 1 294variable 295.Dq rawftp 296to 297.Sy on , 298so that all characters will be sent as is during file transfers. 299.It Sy \&sc 300(bool) 301Initialize the 302.Xr tip 1 303variable 304.Dq script 305to 306.Sy on , 307so that everything transmitted by the remote host will be recorded. 308.It Sy \&ta 309(bool) 310Initialize the 311.Xr tip 1 312variable 313.Dq tandem 314to 315.Sy on , 316so that XON/XOFF flow control will be used to throttle data 317from the remote host. 318.It Sy \&tb 319(bool) 320Initialize the 321.Xr tip 1 322variable 323.Dq tabexpand 324to 325.Sy on , 326so that each tab will be expanded to 8 spaces during file transfers. 327.It Sy \&tc 328(str) 329Indicates that the list of capabilities is continued in the named description. 330This is used primarily to share common capability information. 331.It Sy \&vb 332(bool) 333Initialize the 334.Xr tip 1 335variable 336.Dq verbose 337to 338.Sy on , 339so that verbose mode will be turned on. 340.El 341.Sh FILES 342.Bl -tag -width /etc/remote -compact 343.It Pa /etc/remote 344Global database. 345.El 346.Sh SEE ALSO 347.Xr tip 1 348.Sh HISTORY 349The 350.Nm 351file format appeared in 352.Bx 4.2 . 353