xref: /openbsd-src/share/man/man5/remote.5 (revision c9d6433d50ff1ac58fa567b9a0e2cfcd09ff7590)
1*c9d6433dSschwarze.\"	$OpenBSD: remote.5,v 1.28 2020/02/10 13:18:20 schwarze Exp $
28f296559Smillert.\"	$NetBSD: remote.5,v 1.4 1997/04/20 00:05:27 mellon Exp $
3df930be7Sderaadt.\"
4df930be7Sderaadt.\" Copyright (c) 1983, 1991, 1993
5df930be7Sderaadt.\"	The Regents of the University of California.  All rights reserved.
6df930be7Sderaadt.\"
7df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
8df930be7Sderaadt.\" modification, are permitted provided that the following conditions
9df930be7Sderaadt.\" are met:
10df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
11df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
12df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
13df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
14df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
1529295d1cSmillert.\" 3. Neither the name of the University nor the names of its contributors
16df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
17df930be7Sderaadt.\"    without specific prior written permission.
18df930be7Sderaadt.\"
19df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29df930be7Sderaadt.\" SUCH DAMAGE.
30df930be7Sderaadt.\"
31df930be7Sderaadt.\"     @(#)remote.5	8.1 (Berkeley) 6/5/93
32df930be7Sderaadt.\"
33*c9d6433dSschwarze.Dd $Mdocdate: February 10 2020 $
34df930be7Sderaadt.Dt REMOTE 5
35fc8533a3Saaron.Os
36df930be7Sderaadt.Sh NAME
37df930be7Sderaadt.Nm remote
38df930be7Sderaadt.Nd remote host description file
39df930be7Sderaadt.Sh DESCRIPTION
4018d88c86SnicmThe
4118d88c86Snicm.Nm
4218d88c86Snicmfile describes remote hosts known by
4318d88c86Snicm.Xr cu 1 .
4418d88c86SnicmIt is an ASCII file structured somewhat like the
45df930be7Sderaadt.Xr termcap 5
461f53fde1Saaronfile.
47821815efSkrwEach line in the file provides a description for a single remote host.
48ae8c025fSaaronFields are separated by a colon
49ae8c025fSaaron.Pq Sq \&: .
50ae8c025fSaaronLines ending with a
5118d88c86Snicm.Sq \e
52431305c8Saaroncharacter immediately followed by a newline are continued on the next line.
53df930be7Sderaadt.Pp
541f53fde1SaaronThe first entry is the name(s) of the host system.
55431305c8SaaronIf there is more than one name for a system, the names are separated by
56431305c8Saaronvertical bars
57ae8c025fSaaron.Pq Sq \&| .
5818d88c86SnicmAfter the name of the system comes the fields of the description (the
5918d88c86Snicmcapabilities).
60df930be7Sderaadt.Pp
61431305c8SaaronCapabilities are either strings (str), numbers (num), or boolean flags (bool).
621f53fde1SaaronA string capability is specified by
63df930be7Sderaadt.Em capability Ns Ar = Ns Em value ;
64ae8c025fSaaronfor example,
6518d88c86Snicm.Sq dv=/dev/harris .
66ae8c025fSaaronA numeric capability is specified by
67df930be7Sderaadt.Em capability Ns Ar # Ns Em value ;
68ae8c025fSaaronfor example,
6918d88c86Snicm.Sq br#19200 .
70431305c8SaaronA boolean capability is specified by simply listing the capability.
71df930be7Sderaadt.Bl -tag -width indent
720fb97a5aSaaron.It Sy \&br
73df930be7Sderaadt(num)
74df930be7SderaadtThe baud rate used in establishing
75df930be7Sderaadta connection to the remote host.
76df930be7SderaadtThis is a decimal number.
7718d88c86SnicmThe default baud rate is 9600 baud.
78a05b009aSremi.It Sy \&dc
79a05b009aSremi(bool)
80a05b009aSremiThis host is directly connected, and
81a05b009aSremi.Xr cu 1
82a05b009aSremishould not expect carrier detect to be high, nor should it exit if
83a05b009aSremicarrier detect drops.
840fb97a5aSaaron.It Sy \&dv
85243df24fSanton(str)
86243df24fSantonDevice to open to establish a connection.
87df930be7SderaadtIf this file refers to a terminal line,
8818d88c86Snicm.Xr cu 1
89267400e7Shughattempts to perform an exclusive open on the device to ensure only
90df930be7Sderaadtone user at a time has access to the port.
91df930be7Sderaadt.El
92df930be7Sderaadt.Sh FILES
93*c9d6433dSschwarze.Bl -tag -width /etc/examples/remote -compact
94df930be7Sderaadt.It Pa /etc/remote
95821815efSkrwGlobal database.
96*c9d6433dSschwarze.It Pa /etc/examples/remote
97*c9d6433dSschwarzeExample database.
98df930be7Sderaadt.El
99df930be7Sderaadt.Sh SEE ALSO
10018d88c86Snicm.Xr cu 1
101df930be7Sderaadt.Sh HISTORY
102df930be7SderaadtThe
103df930be7Sderaadt.Nm
104df930be7Sderaadtfile format appeared in
105df930be7Sderaadt.Bx 4.2 .
106