xref: /csrg-svn/share/man/man5/remote.5 (revision 67349)
161609Sbostic.\" Copyright (c) 1983, 1991, 1993
261609Sbostic.\"	The Regents of the University of California.  All rights reserved.
320839Smckusick.\"
449647Scael.\" %sccs.include.redist.roff%
520839Smckusick.\"
6*67349Sah.\"     @(#)remote.5	8.2 (Berkeley) 06/01/94
748928Scael.\"
849647Scael.Dd
949647Scael.Dt REMOTE 5
1049647Scael.Os BSD 4.2
1149647Scael.Sh NAME
1249647Scael.Nm remote
1349647Scael.Nd remote host description file
1449647Scael.Sh DESCRIPTION
1520839SmckusickThe systems known by
1649647Scael.Xr tip 1
1749647Scaeland their attributes are stored in an
1849647Scael.Tn ASCII
1949647Scaelfile which
2020839Smckusickis structured somewhat like the
2149647Scael.Xr termcap 5
2220839Smckusickfile.  Each line in the file provides a description for a single
2349647Scael.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.
2749647Scael.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.
3349647Scael.Pp
3420839SmckusickEntries named ``tip*'' and ``cu*''
3520839Smckusickare used as default entries by
3649647Scael.Xr tip ,
3720839Smckusickand the
3849647Scael.Xr cu
3920839Smckusickinterface to
4049647Scael.Xr tip ,
4120839Smckusickas follows.  When
4249647Scael.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
4649647Scael.Xr cu
4720839Smckusickinterface is used, entries of the form ``cu300'' are used.
4849647Scael.Sh CAPABILITIES
4920839SmckusickCapabilities are either strings (str), numbers (num), or boolean
5020839Smckusickflags (bool).  A string capability is specified by
5149647Scael.Em capability Ns Ar = Ns Em value ;
5249647Scaelfor example, ``dv=/dev/harris''.  A numeric capability is specified by
5349647Scael.Em capability Ns Ar # Ns Em value ;
5449647Scaelfor example, ``xa#99''.  A boolean capability is specified by simply listing
5520839Smckusickthe capability.
5649647Scael.Bl -tag -width indent
5749647Scael.It Cm \&at
5820839Smckusick(str)
5920839SmckusickAuto call unit type.
6049647Scael.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.
6649647Scael.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.
7349647Scael.It Cm \&cu
7420839Smckusick(str)
7520839SmckusickCall unit if making a phone call.
7620839SmckusickDefault is the same as the `dv' field.
7749647Scael.It Cm \&di
7820839Smckusick(str)
7920839SmckusickDisconnect message sent to the host when a
8020839Smckusickdisconnect is requested by the user.
8149647Scael.It Cm \&du
8220839Smckusick(bool)
8320839SmckusickThis host is on a dial-up line.
8449647Scael.It Cm \&dv
8520839Smckusick(str)
8649647Scael.Tn UNIX
8749647Scaeldevice(s) to open to establish a connection.
8820839SmckusickIf this file refers to a terminal line,
8949647Scael.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.
9249647Scael.It Cm \&el
9320839Smckusick(str)
9420839SmckusickCharacters marking an end-of-line.
9549647ScaelThe default is
9649647Scael.Dv NULL .
9749647Scael`~' escapes are only
9820839Smckusickrecognized by
9949647Scael.Xr tip
10020839Smckusickafter one of the characters in `el',
10120839Smckusickor after a carriage-return.
10249647Scael.It Cm \&fs
10320839Smckusick(str)
10420839SmckusickFrame size for transfers.
10549647ScaelThe default frame size is equal to
10649647Scael.Dv BUFSIZ .
10749647Scael.It Cm \&hd
10820839Smckusick(bool)
10920839SmckusickThe host uses half-duplex communication, local
11020839Smckusickecho should be performed.
11149647Scael.It Cm \&ie
11220839Smckusick(str)
11320839SmckusickInput end-of-file marks.
11449647ScaelThe default is
11549647Scael.Dv NULL .
11649647Scael.It Cm \&oe
11720839Smckusick(str)
11820839SmckusickOutput end-of-file string.
11949647ScaelThe default is
12049647Scael.Dv NULL .
12149647ScaelWhen
12249647Scael.Xr tip
12320839Smckusickis transferring a file, this
12420839Smckusickstring is sent at end-of-file.
125*67349Sah.ne 1i
12649647Scael.It Cm \&pa
12720839Smckusick(str)
12820839SmckusickThe type of parity to use when sending data
12920839Smckusickto the host.  This may be one of ``even'',
13020839Smckusick``odd'', ``none'', ``zero'' (always set bit 8 to zero),
13120839Smckusick``one'' (always set bit 8 to 1).  The default
13220839Smckusickis even parity.
13349647Scael.It Cm \&pn
13420839Smckusick(str)
13520839SmckusickTelephone number(s) for this host.
13620839SmckusickIf the telephone number field contains
13720839Smckusickan @ sign,
13849647Scael.Xr tip
13920839Smckusicksearches the file
14049647Scael.Pa /etc/phones
14120839Smckusickfile for a list of telephone numbers;
14249647Scael(See
14349647Scael.Xr phones 5 . )
14449647Scael.It Cm \&tc
14520839Smckusick(str)
14620839SmckusickIndicates that the list of capabilities is continued
14720839Smckusickin the named description.  This is used
14820839Smckusickprimarily to share common capability information.
14949647Scael.El
15049647Scael.Pp
15120839SmckusickHere is a short example showing the use of the capability continuation
15220839Smckusickfeature:
15349647Scael.Bd -literal
15420839SmckusickUNIX-1200:\e
15549647Scael:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
15620839Smckusickarpavax|ax:\e
15749647Scael:pn=7654321%:tc=UNIX-1200
15849647Scael.Ed
15949647Scael.Sh FILES
16049647Scael.Bl -tag -width /etc/remote -compact
16149647Scael.It Pa /etc/remote
16249647ScaelThe
16349647Scael.Nm remote
16449647Scaelhost description file
16549647Scaelresides in
16649647Scael.Pa /etc .
16749647Scael.El
16849647Scael.Sh SEE ALSO
16949647Scael.Xr tip 1 ,
17049647Scael.Xr phones 5
17149647Scael.Sh HISTORY
17249647ScaelThe
17349647Scael.Nm
17449647Scaelfile format appeared in
17549647Scael.Bx 4.2 .
176