1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" @(#)remote.5 8.1 (Berkeley) 6/5/93
33 .\" $FreeBSD: src/share/man/man5/remote.5,v 1.5.2.4 2001/08/17 13:08:47 ru Exp $
34 .\" $DragonFly: src/share/man/man5/remote.5,v 1.2 2003/06/17 04:37:00 dillon Exp $
41 .Nd remote host description file
45 and their attributes are stored in an
48 is structured somewhat like the
50 file. Each line in the file provides a description for a single
52 Fields are separated by a colon (``:'').
53 Lines ending in a \e character with an immediately following newline are
54 continued on the next line.
56 The first entry is the name(s) of the host system. If there is more
57 than one name for a system, the names are separated by vertical bars.
58 After the name of the system comes the fields of the description. A
59 field name followed by an `=' sign indicates a string value.
60 A field name followed by a `#' sign indicates a numeric value.
62 Entries named ``tip*'' and ``cu*''
63 are used as default entries by
71 is invoked with only a phone number, it looks for an entry
72 of the form ``tip300'', where 300 is the baud rate with
73 which the connection is to be made. When the
75 interface is used, entries of the form ``cu300'' are used.
77 Capabilities are either strings (str), numbers (num), or boolean
78 flags (bool). A string capability is specified by
79 .Em capability Ns Ar = Ns Em value ;
80 for example, ``dv=/dev/harris''. A numeric capability is specified by
81 .Em capability Ns Ar # Ns Em value ;
82 for example, ``xa#99''. A boolean capability is specified by simply listing
84 .Bl -tag -width indent
90 The baud rate used in establishing
91 a connection to the remote host.
92 This is a decimal number.
93 The default baud rate is 300 baud.
96 An initial connection message to be sent
97 to the remote host. For example, if a
98 host is reached through a port selector, this
99 might be set to the appropriate sequence
100 required to switch to the host.
103 Call unit if making a phone call.
104 Default is the same as the `dv' field.
107 Disconnect message sent to the host when a
108 disconnect is requested by the user.
111 This host is on a dial-up line.
115 device(s) to open to establish a connection.
116 If this file refers to a terminal line,
118 attempts to perform an exclusive open on the device to ensure only
119 one user at a time has access to the port.
122 Characters marking an end-of-line.
128 after one of the characters in `el',
129 or after a carriage-return.
132 Frame size for transfers.
133 The default frame size is equal to
137 The host uses half-duplex communication, local
138 echo should be performed.
141 Input end-of-file marks.
146 Output end-of-file string.
151 is transferring a file, this
152 string is sent at end-of-file.
155 The type of parity to use when sending data
156 to the host. This may be one of ``even'',
157 ``odd'', ``none'', ``zero'' (always set bit 8 to zero),
158 ``one'' (always set bit 8 to 1). The default
162 Telephone number(s) for this host.
163 If the telephone number field contains
168 file for a list of telephone numbers
173 Indicates that the list of capabilities is continued
174 in the named description. This is used
175 primarily to share common capability information.
178 Here is a short example showing the use of the capability continuation
182 :dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
184 :pn=7654321%:tc=UNIX-1200
187 .Bl -tag -width /etc/remote -compact
191 host description file
201 file format appeared in