1.\" $OpenBSD: remote.5,v 1.28 2020/02/10 13:18:20 schwarze 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: February 10 2020 $ 34.Dt REMOTE 5 35.Os 36.Sh NAME 37.Nm remote 38.Nd remote host description file 39.Sh DESCRIPTION 40The 41.Nm 42file describes remote hosts known by 43.Xr cu 1 . 44It is an ASCII file 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.Sq \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 (the 59capabilities). 60.Pp 61Capabilities are either strings (str), numbers (num), or boolean flags (bool). 62A string capability is specified by 63.Em capability Ns Ar = Ns Em value ; 64for example, 65.Sq dv=/dev/harris . 66A numeric capability is specified by 67.Em capability Ns Ar # Ns Em value ; 68for example, 69.Sq br#19200 . 70A boolean capability is specified by simply listing the capability. 71.Bl -tag -width indent 72.It Sy \&br 73(num) 74The baud rate used in establishing 75a connection to the remote host. 76This is a decimal number. 77The default baud rate is 9600 baud. 78.It Sy \&dc 79(bool) 80This host is directly connected, and 81.Xr cu 1 82should not expect carrier detect to be high, nor should it exit if 83carrier detect drops. 84.It Sy \&dv 85(str) 86Device to open to establish a connection. 87If this file refers to a terminal line, 88.Xr cu 1 89attempts to perform an exclusive open on the device to ensure only 90one user at a time has access to the port. 91.El 92.Sh FILES 93.Bl -tag -width /etc/examples/remote -compact 94.It Pa /etc/remote 95Global database. 96.It Pa /etc/examples/remote 97Example database. 98.El 99.Sh SEE ALSO 100.Xr cu 1 101.Sh HISTORY 102The 103.Nm 104file format appeared in 105.Bx 4.2 . 106