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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)remote.5 8.1 (Berkeley) 6/5/93
29 .\" $FreeBSD: src/share/man/man5/remote.5,v 1.5.2.4 2001/08/17 13:08:47 ru Exp $
30 .\" $DragonFly: src/share/man/man5/remote.5,v 1.3 2007/07/30 22:11:33 swildner Exp $
37 .Nd remote host description file
41 and their attributes are stored in an
44 is structured somewhat like the
46 file. Each line in the file provides a description for a single
48 Fields are separated by a colon (``:'').
49 Lines ending in a \e character with an immediately following newline are
50 continued on the next line.
52 The first entry is the name(s) of the host system. If there is more
53 than one name for a system, the names are separated by vertical bars.
54 After the name of the system comes the fields of the description. A
55 field name followed by an `=' sign indicates a string value.
56 A field name followed by a `#' sign indicates a numeric value.
58 Entries named ``tip*'' and ``cu*''
59 are used as default entries by
67 is invoked with only a phone number, it looks for an entry
68 of the form ``tip300'', where 300 is the baud rate with
69 which the connection is to be made. When the
71 interface is used, entries of the form ``cu300'' are used.
73 Capabilities are either strings (str), numbers (num), or boolean
74 flags (bool). A string capability is specified by
75 .Em capability Ns Ar = Ns Em value ;
76 for example, ``dv=/dev/harris''. A numeric capability is specified by
77 .Em capability Ns Ar # Ns Em value ;
78 for example, ``xa#99''. A boolean capability is specified by simply listing
80 .Bl -tag -width indent
86 The baud rate used in establishing
87 a connection to the remote host.
88 This is a decimal number.
89 The default baud rate is 300 baud.
92 An initial connection message to be sent
93 to the remote host. For example, if a
94 host is reached through a port selector, this
95 might be set to the appropriate sequence
96 required to switch to the host.
99 Call unit if making a phone call.
100 Default is the same as the `dv' field.
103 Disconnect message sent to the host when a
104 disconnect is requested by the user.
107 This host is on a dial-up line.
111 device(s) to open to establish a connection.
112 If this file refers to a terminal line,
114 attempts to perform an exclusive open on the device to ensure only
115 one user at a time has access to the port.
118 Characters marking an end-of-line.
124 after one of the characters in `el',
125 or after a carriage-return.
128 Frame size for transfers.
129 The default frame size is equal to
133 The host uses half-duplex communication, local
134 echo should be performed.
137 Input end-of-file marks.
142 Output end-of-file string.
147 is transferring a file, this
148 string is sent at end-of-file.
151 The type of parity to use when sending data
152 to the host. This may be one of ``even'',
153 ``odd'', ``none'', ``zero'' (always set bit 8 to zero),
154 ``one'' (always set bit 8 to 1). The default
158 Telephone number(s) for this host.
159 If the telephone number field contains
164 file for a list of telephone numbers
169 Indicates that the list of capabilities is continued
170 in the named description. This is used
171 primarily to share common capability information.
174 Here is a short example showing the use of the capability continuation
178 :dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
180 :pn=7654321%:tc=UNIX-1200
183 .Bl -tag -width /etc/remote -compact
187 host description file
197 file format appeared in