xref: /freebsd/share/man/man5/remote.5 (revision afe61c15161c324a7af299a9b8457aba5afc92db)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)remote.5	8.1 (Berkeley) 6/5/93
33.\"
34.Dd June 5, 1993
35.Dt REMOTE 5
36.Os BSD 4.2
37.Sh NAME
38.Nm remote
39.Nd remote host description file
40.Sh DESCRIPTION
41The systems known by
42.Xr tip 1
43and their attributes are stored in an
44.Tn ASCII
45file which
46is structured somewhat like the
47.Xr termcap 5
48file.  Each line in the file provides a description for a single
49.Xr system .
50Fields are separated by a colon (``:'').
51Lines ending in a \e character with an immediately following newline are
52continued on the next line.
53.Pp
54The first entry is the name(s) of the host system.  If there is more
55than one name for a system, the names are separated by vertical bars.
56After the name of the system comes the fields of the description.  A
57field name followed by an `=' sign indicates a string value follows.  A field
58name followed by a `#' sign indicates a following numeric value.
59.Pp
60Entries named ``tip*'' and ``cu*''
61are used as default entries by
62.Xr tip ,
63and the
64.Xr cu
65interface to
66.Xr tip ,
67as follows.  When
68.Xr tip
69is invoked with only a phone number, it looks for an entry
70of the form ``tip300'', where 300 is the baud rate with
71which the connection is to be made.  When the
72.Xr cu
73interface is used, entries of the form ``cu300'' are used.
74.Sh CAPABILITIES
75Capabilities are either strings (str), numbers (num), or boolean
76flags (bool).  A string capability is specified by
77.Em capability Ns Ar = Ns Em value ;
78for example, ``dv=/dev/harris''.  A numeric capability is specified by
79.Em capability Ns Ar # Ns Em value ;
80for example, ``xa#99''.  A boolean capability is specified by simply listing
81the capability.
82.Bl -tag -width indent
83.It Cm \&at
84(str)
85Auto call unit type.
86.It Cm \&br
87(num)
88The baud rate used in establishing
89a connection to the remote host.
90This is a decimal number.
91The default baud rate is 300 baud.
92.It Cm \&cm
93(str)
94An initial connection message to be sent
95to the remote host.  For example, if a
96host is reached through port selector, this
97might be set to the appropriate sequence
98required to switch to the host.
99.It Cm \&cu
100(str)
101Call unit if making a phone call.
102Default is the same as the `dv' field.
103.It Cm \&di
104(str)
105Disconnect message sent to the host when a
106disconnect is requested by the user.
107.It Cm \&du
108(bool)
109This host is on a dial-up line.
110.It Cm \&dv
111(str)
112.Tn UNIX
113device(s) to open to establish a connection.
114If this file refers to a terminal line,
115.Xr tip 1
116attempts to perform an exclusive open on the device to insure only
117one user at a time has access to the port.
118.It Cm \&el
119(str)
120Characters marking an end-of-line.
121The default is
122.Dv NULL .
123`~' escapes are only
124recognized by
125.Xr tip
126after one of the characters in `el',
127or after a carriage-return.
128.It Cm \&fs
129(str)
130Frame size for transfers.
131The default frame size is equal to
132.Dv BUFSIZ .
133.It Cm \&hd
134(bool)
135The host uses half-duplex communication, local
136echo should be performed.
137.It Cm \&ie
138(str)
139Input end-of-file marks.
140The default is
141.Dv NULL .
142.It Cm \&oe
143(str)
144Output end-of-file string.
145The default is
146.Dv NULL .
147When
148.Xr tip
149is transferring a file, this
150string is sent at end-of-file.
151.It Cm \&pa
152(str)
153The type of parity to use when sending data
154to the host.  This may be one of ``even'',
155``odd'', ``none'', ``zero'' (always set bit 8 to zero),
156``one'' (always set bit 8 to 1).  The default
157is even parity.
158.It Cm \&pn
159(str)
160Telephone number(s) for this host.
161If the telephone number field contains
162an @ sign,
163.Xr tip
164searches the file
165.Pa /etc/phones
166file for a list of telephone numbers;
167(See
168.Xr phones 5 . )
169.It Cm \&tc
170(str)
171Indicates that the list of capabilities is continued
172in the named description.  This is used
173primarily to share common capability information.
174.El
175.Pp
176Here is a short example showing the use of the capability continuation
177feature:
178.Bd -literal
179UNIX-1200:\e
180:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
181arpavax|ax:\e
182:pn=7654321%:tc=UNIX-1200
183.Ed
184.Sh FILES
185.Bl -tag -width /etc/remote -compact
186.It Pa /etc/remote
187The
188.Nm remote
189host description file
190resides in
191.Pa /etc .
192.El
193.Sh SEE ALSO
194.Xr tip 1 ,
195.Xr phones 5
196.Sh HISTORY
197The
198.Nm
199file format appeared in
200.Bx 4.2 .
201