xref: /csrg-svn/share/man/man5/remote.5 (revision 49647)
1*49647Scael.\" Copyright (c) 1983, 1991 Regents of the University of California.
2*49647Scael.\" All rights reserved.
320839Smckusick.\"
4*49647Scael.\" %sccs.include.redist.roff%
520839Smckusick.\"
6*49647Scael.\"     @(#)remote.5	6.3 (Berkeley) 05/10/91
748928Scael.\"
8*49647Scael.Dd
9*49647Scael.Dt REMOTE 5
10*49647Scael.Os BSD 4.2
11*49647Scael.Sh NAME
12*49647Scael.Nm remote
13*49647Scael.Nd remote host description file
14*49647Scael.Sh DESCRIPTION
1520839SmckusickThe systems known by
16*49647Scael.Xr tip 1
17*49647Scaeland their attributes are stored in an
18*49647Scael.Tn ASCII
19*49647Scaelfile which
2020839Smckusickis structured somewhat like the
21*49647Scael.Xr termcap 5
2220839Smckusickfile.  Each line in the file provides a description for a single
23*49647Scael.Xr system .
2420839SmckusickFields are separated by a colon (``:'').
2520839SmckusickLines ending in a \e character with an immediately following newline are
2620839Smckusickcontinued on the next line.
27*49647Scael.Pp
2820839SmckusickThe first entry is the name(s) of the host system.  If there is more
2920839Smckusickthan one name for a system, the names are separated by vertical bars.
3020839SmckusickAfter the name of the system comes the fields of the description.  A
3120839Smckusickfield name followed by an `=' sign indicates a string value follows.  A field
3220839Smckusickname followed by a `#' sign indicates a following numeric value.
33*49647Scael.Pp
3420839SmckusickEntries named ``tip*'' and ``cu*''
3520839Smckusickare used as default entries by
36*49647Scael.Xr tip ,
3720839Smckusickand the
38*49647Scael.Xr cu
3920839Smckusickinterface to
40*49647Scael.Xr tip ,
4120839Smckusickas follows.  When
42*49647Scael.Xr tip
4320839Smckusickis invoked with only a phone number, it looks for an entry
4420839Smckusickof the form ``tip300'', where 300 is the baud rate with
4520839Smckusickwhich the connection is to be made.  When the
46*49647Scael.Xr cu
4720839Smckusickinterface is used, entries of the form ``cu300'' are used.
48*49647Scael.Sh CAPABILITIES
4920839SmckusickCapabilities are either strings (str), numbers (num), or boolean
5020839Smckusickflags (bool).  A string capability is specified by
51*49647Scael.Em capability Ns Ar = Ns Em value ;
52*49647Scaelfor example, ``dv=/dev/harris''.  A numeric capability is specified by
53*49647Scael.Em capability Ns Ar # Ns Em value ;
54*49647Scaelfor example, ``xa#99''.  A boolean capability is specified by simply listing
5520839Smckusickthe capability.
56*49647Scael.Bl -tag -width indent
57*49647Scael.It Cm \&at
5820839Smckusick(str)
5920839SmckusickAuto call unit type.
60*49647Scael.It Cm \&br
6120839Smckusick(num)
6220839SmckusickThe baud rate used in establishing
6320839Smckusicka connection to the remote host.
6420839SmckusickThis is a decimal number.
6520839SmckusickThe default baud rate is 300 baud.
66*49647Scael.It Cm \&cm
6720839Smckusick(str)
6820839SmckusickAn initial connection message to be sent
6920839Smckusickto the remote host.  For example, if a
7020839Smckusickhost is reached through port selector, this
7120839Smckusickmight be set to the appropriate sequence
7220839Smckusickrequired to switch to the host.
73*49647Scael.It Cm \&cu
7420839Smckusick(str)
7520839SmckusickCall unit if making a phone call.
7620839SmckusickDefault is the same as the `dv' field.
77*49647Scael.It Cm \&di
7820839Smckusick(str)
7920839SmckusickDisconnect message sent to the host when a
8020839Smckusickdisconnect is requested by the user.
81*49647Scael.It Cm \&du
8220839Smckusick(bool)
8320839SmckusickThis host is on a dial-up line.
84*49647Scael.It Cm \&dv
8520839Smckusick(str)
86*49647Scael.Tn UNIX
87*49647Scaeldevice(s) to open to establish a connection.
8820839SmckusickIf this file refers to a terminal line,
89*49647Scael.Xr tip 1
9020839Smckusickattempts to perform an exclusive open on the device to insure only
9120839Smckusickone user at a time has access to the port.
92*49647Scael.It Cm \&el
9320839Smckusick(str)
9420839SmckusickCharacters marking an end-of-line.
95*49647ScaelThe default is
96*49647Scael.Dv NULL .
97*49647Scael`~' escapes are only
9820839Smckusickrecognized by
99*49647Scael.Xr tip
10020839Smckusickafter one of the characters in `el',
10120839Smckusickor after a carriage-return.
102*49647Scael.It Cm \&fs
10320839Smckusick(str)
10420839SmckusickFrame size for transfers.
105*49647ScaelThe default frame size is equal to
106*49647Scael.Dv BUFSIZ .
107*49647Scael.It Cm \&hd
10820839Smckusick(bool)
10920839SmckusickThe host uses half-duplex communication, local
11020839Smckusickecho should be performed.
111*49647Scael.It Cm \&ie
11220839Smckusick(str)
11320839SmckusickInput end-of-file marks.
114*49647ScaelThe default is
115*49647Scael.Dv NULL .
116*49647Scael.It Cm \&oe
11720839Smckusick(str)
11820839SmckusickOutput end-of-file string.
119*49647ScaelThe default is
120*49647Scael.Dv NULL .
121*49647ScaelWhen
122*49647Scael.Xr tip
12320839Smckusickis transferring a file, this
12420839Smckusickstring is sent at end-of-file.
125*49647Scael.It Cm \&pa
12620839Smckusick(str)
12720839SmckusickThe type of parity to use when sending data
12820839Smckusickto the host.  This may be one of ``even'',
12920839Smckusick``odd'', ``none'', ``zero'' (always set bit 8 to zero),
13020839Smckusick``one'' (always set bit 8 to 1).  The default
13120839Smckusickis even parity.
132*49647Scael.It Cm \&pn
13320839Smckusick(str)
13420839SmckusickTelephone number(s) for this host.
13520839SmckusickIf the telephone number field contains
13620839Smckusickan @ sign,
137*49647Scael.Xr tip
13820839Smckusicksearches the file
139*49647Scael.Pa /etc/phones
14020839Smckusickfile for a list of telephone numbers;
141*49647Scael(See
142*49647Scael.Xr phones 5 . )
143*49647Scael.It Cm \&tc
14420839Smckusick(str)
14520839SmckusickIndicates that the list of capabilities is continued
14620839Smckusickin the named description.  This is used
14720839Smckusickprimarily to share common capability information.
148*49647Scael.El
149*49647Scael.Pp
15020839SmckusickHere is a short example showing the use of the capability continuation
15120839Smckusickfeature:
152*49647Scael.Bd -literal
15320839SmckusickUNIX-1200:\e
154*49647Scael:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
15520839Smckusickarpavax|ax:\e
156*49647Scael:pn=7654321%:tc=UNIX-1200
157*49647Scael.Ed
158*49647Scael.Sh FILES
159*49647Scael.Bl -tag -width /etc/remote -compact
160*49647Scael.It Pa /etc/remote
161*49647ScaelThe
162*49647Scael.Nm remote
163*49647Scaelhost description file
164*49647Scaelresides in
165*49647Scael.Pa /etc .
166*49647Scael.El
167*49647Scael.Sh SEE ALSO
168*49647Scael.Xr tip 1 ,
169*49647Scael.Xr phones 5
170*49647Scael.Sh HISTORY
171*49647ScaelThe
172*49647Scael.Nm
173*49647Scaelfile format appeared in
174*49647Scael.Bx 4.2 .
175