path: root/usr/src/man/man5/remote.5

'\" te
.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH REMOTE 5 "Jun 13, 2002"
.SH NAME
remote \- remote host description file
.SH SYNOPSIS
.LP
.nf
\fB/etc/remote\fR
.fi

.SH DESCRIPTION
.sp
.LP
The systems known by \fBtip\fR(1) and their attributes are stored in an
\fBASCII\fR file which is structured somewhat like the \fBtermcap\fR file. Each
line in the file provides a description for a single \fIsystem\fR. Fields are
separated by a colon `\fB:\fR'. Lines ending in a `\fB\e\fR\&' character with
an immediately following \fBNEWLINE\fR are continued on the next line.
.sp
.LP
The first entry is the name(s) of the host system. If there is more than one
name for a system, the names are separated by vertical bars. After the name of
the system comes the fields of the description.  A field name followed by an
`\fB=\fR' sign indicates a string value follows. A field name followed by a
`\fB#\fR' sign indicates a following numeric value.
.sp
.LP
Entries named \fBtip\fR\fIbaudrate\fR are used as default entries by \fBtip\fR,
as follows.  When \fBtip\fR is invoked with only a phone number, it looks for
an entry of the form \fBtip\fR\fIbaudrate\fR, where \fIbaudrate\fR is the baud
rate with which the connection is to be made.  For example, if the connection
is to be made at  \fB300\fR baud, \fBtip\fR looks for an entry of the form
\fBtip300\fR.
.SH CAPABILITIES
.sp
.LP
Capabilities are either strings \fB(str)\fR, numbers \fB(num)\fR, or boolean
flags \fB(bool)\fR. A string capability is specified by
\fIcapability\fR=\fIvalue\fR; for example, `\fBdv=/dev/harris\fR'. A numeric
capability is specified by \fIcapability\fR#\fIvalue\fR; for example,
`\fBxa#99\fR'. A boolean capability is specified by simply listing the
capability.
.sp
.ne 2
.na
\fB\fBat\fR\fR
.ad
.RS 6n
\fB(str)\fR Auto call unit type. The following lists valid '\fBat\fR' types and
their corresponding hardware:
.sp
.ne 2
.na
\fB\fBbiz31f\fR\fR
.ad
.RS 10n
Bizcomp 1031, tone dialing
.RE

.sp
.ne 2
.na
\fB\fBbiz31w\fR\fR
.ad
.RS 10n
Bizcomp 1031, pulse dialing
.RE

.sp
.ne 2
.na
\fB\fBbiz22f\fR\fR
.ad
.RS 10n
Bizcomp 1022, tone dialing
.RE

.sp
.ne 2
.na
\fB\fBbiz22w\fR\fR
.ad
.RS 10n
Bizcomp 1022, pulse dialing
.RE

.sp
.ne 2
.na
\fB\fBdf02\fR\fR
.ad
.RS 10n
DEC DF02
.RE

.sp
.ne 2
.na
\fB\fBdf03\fR\fR
.ad
.RS 10n
DEC DF03
.RE

.sp
.ne 2
.na
\fB\fBventel\fR\fR
.ad
.RS 10n
Ventel 212+
.RE

.sp
.ne 2
.na
\fB\fBv3451\fR\fR
.ad
.RS 10n
Vadic 3451 Modem
.RE

.sp
.ne 2
.na
\fB\fBv831\fR\fR
.ad
.RS 10n
Vadic 831
.RE

.sp
.ne 2
.na
\fB\fBhayes\fR\fR
.ad
.RS 10n
Any Hayes-compatible modem
.RE

.sp
.ne 2
.na
\fB\fBat\fR\fR
.ad
.RS 10n
Any Hayes-compatible modem
.RE

.RE

.sp
.ne 2
.na
\fB\fBbr\fR\fR
.ad
.RS 6n
\fB(num)\fR The baud rate used in establishing a connection to the remote host.
This is a decimal number. The default baud rate is  \fB300\fR baud.
.RE

.sp
.ne 2
.na
\fB\fBcm\fR\fR
.ad
.RS 6n
\fB(str)\fR An initial connection message to be sent to the remote host. For
example, if a host is reached through a port selector, this might be set to the
appropriate sequence required to switch to the host.
.RE

.sp
.ne 2
.na
\fB\fBcu\fR\fR
.ad
.RS 6n
\fB(str)\fR Call unit if making a phone call. Default is the same as the
\fBdv\fR field.
.RE

.sp
.ne 2
.na
\fB\fBdb\fR\fR
.ad
.RS 6n
\fB(bool)\fR Cause \fBtip\fR(1) to ignore the first hangup it sees.  \fBdb\fR
(dialback) allows the user to remain in \fBtip\fR while the remote machine
disconnects and places a call back to the local machine. For more information
about dialback configuration, see \fISystem Administration Guide: IP
Services\fR.
.RE

.sp
.ne 2
.na
\fB\fBdi\fR\fR
.ad
.RS 6n
\fB(str)\fR Disconnect message sent to the host when a disconnect is requested
by the user.
.RE

.sp
.ne 2
.na
\fB\fBdu\fR\fR
.ad
.RS 6n
\fB(bool)\fR This host is on a dial-up line.
.RE

.sp
.ne 2
.na
\fB\fBdv\fR\fR
.ad
.RS 6n
\fB(str)\fR Device(s) to open to establish a connection. If this file refers to
a terminal line, \fBtip\fR attempts to perform an exclusive open on the device
to insure only one user at a time has access to the port.
.RE

.sp
.ne 2
.na
\fB\fBec\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBechocheck\fR to \fBon\fR, so
that \fBtip\fR will synchronize with the remote host during file transfer by
waiting for the echo of the last character transmitted.
.RE

.sp
.ne 2
.na
\fB\fBel\fR\fR
.ad
.RS 6n
\fB(str)\fR Characters marking an end-of-line.  The default is no characters.
\fBtip\fR only recognizes `\fB~\fR' escapes after one of the characters in
\fBel\fR, or after a \fBRETURN.\fR
.RE

.sp
.ne 2
.na
\fB\fBes\fR\fR
.ad
.RS 6n
\fB(str)\fR The command prefix (escape) character for \fBtip\fR.
.RE

.sp
.ne 2
.na
\fB\fBet\fR\fR
.ad
.RS 6n
\fB(num)\fR Number of seconds to wait for an echo response when echo-check mode
is on.  This is a decimal number.  The default value is  \fB10\fR seconds.
.RE

.sp
.ne 2
.na
\fB\fBex\fR\fR
.ad
.RS 6n
\fB(str)\fR Set of non-printable characters not to be discarded when scripting
with beautification turned on.  The default value is "\fB\et\en\eb\ef\fR".
.RE

.sp
.ne 2
.na
\fB\fBfo\fR\fR
.ad
.RS 6n
\fB(str)\fR Character used to force literal data transmission.  The default
value is  `\fB\e377\fR\&'.
.RE

.sp
.ne 2
.na
\fB\fBfs\fR\fR
.ad
.RS 6n
\fB(num)\fR Frame size for transfers. The default frame size is equal to
\fB1024\fR.
.RE

.sp
.ne 2
.na
\fB\fBhd\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBhalfduplex\fR to \fBon\fR, so
local echo should be performed.
.RE

.sp
.ne 2
.na
\fB\fBhf\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBhardwareflow\fR to \fBon\fR,
so hardware flow control is used.
.RE

.sp
.ne 2
.na
\fB\fBie\fR\fR
.ad
.RS 6n
\fB(str)\fR Input end-of-file marks.  The default is a null string ("").
.RE

.sp
.ne 2
.na
\fB\fBnb\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBbeautify\fR to \fIoff\fR, so
that unprintable characters will not be discarded when scripting.
.RE

.sp
.ne 2
.na
\fB\fBnt\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBtandem\fR to \fIoff\fR, so
that  \fBXON/XOFF\fR flow control will not be used to throttle data from the
remote host.
.RE

.sp
.ne 2
.na
\fB\fBnv\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBverbose\fR to \fIoff\fR, so
that verbose mode will be turned on.
.RE

.sp
.ne 2
.na
\fB\fBoe\fR\fR
.ad
.RS 6n
\fB(str)\fR Output end-of-file string.  The default is a null string ("").
When  \fBtip\fR is transferring a file, this string is sent at end-of-file.
.RE

.sp
.ne 2
.na
\fB\fBpa\fR\fR
.ad
.RS 6n
\fB(str)\fR The type of parity to use when sending data to the host.  This may
be one of \fBeven\fR, \fBodd\fR, \fBnone\fR, \fBzero\fR (always set bit
\fB8\fR to \fB0\fR), \fBone\fR (always set bit  \fB8\fR to \fB1\fR).  The
default is \fBnone\fR.
.RE

.sp
.ne 2
.na
\fB\fBpn\fR\fR
.ad
.RS 6n
\fB(str)\fR Telephone number(s) for this host. If the telephone number field
contains an `\fB@\fR' sign, \fBtip\fR searches the \fB/etc/phones\fR file for a
list of telephone numbers \(em see \fBphones\fR(5). A `\fB%\fR' sign in the
telephone number indicates a 5-second delay for the Ventel Modem.
.sp
For Hayes-compatible modems, if the telephone number starts with an 'S', the
telephone number string will be sent to the modem without the "\fBDT\fR", which
allows reconfiguration of the modem's S-registers and other parameters; for
example, to disable auto-answer:  "\fBpn=S0=0DT5551234\fR";  or to also
restrict the modem to return only the basic result codes:
"\fBpn=S0=0X0DT5551234\fR".
.RE

.sp
.ne 2
.na
\fB\fBpr\fR\fR
.ad
.RS 6n
\fB(str)\fR Character that indicates end-of-line on the remote host.  The
default value is  \fB`\fR\en\fB\&'.\fR
.RE

.sp
.ne 2
.na
\fB\fBra\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBraise\fR to \fBon\fR, so that
lower case letters are mapped to upper case before sending them to the remote
host.
.RE

.sp
.ne 2
.na
\fB\fBrc\fR\fR
.ad
.RS 6n
\fB(str)\fR Character that toggles case-mapping mode.  The default value is
`\fB\e377\fR\&'.
.RE

.sp
.ne 2
.na
\fB\fBre\fR\fR
.ad
.RS 6n
\fB(str)\fR The file in which to record session scripts.  The default value is
\fBtip.record\fR.
.RE

.sp
.ne 2
.na
\fB\fBrw\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBrawftp\fR to \fBon\fR, so
that all characters will be sent as is during file transfers.
.RE

.sp
.ne 2
.na
\fB\fBsc\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBscript\fR to \fBon\fR, so
that everything transmitted by the remote host will be recorded.
.RE

.sp
.ne 2
.na
\fB\fBtb\fR\fR
.ad
.RS 6n
\fB(bool)\fR Initialize the \fBtip\fR variable \fBtabexpand\fR to \fBon\fR, so
that tabs will be expanded to spaces during file transfers.
.RE

.sp
.ne 2
.na
\fB\fBtc\fR\fR
.ad
.RS 6n
\fB(str)\fR Indicates that the list of capabilities is continued in the named
description.  This is used primarily to share common capability information.
.RE

.SH EXAMPLES
.LP
\fBExample 1 \fRUsing the Capability Continuation Feature
.sp
.LP
Here is a short example showing the use of the capability continuation feature:

.sp
.in +2
.nf
UNIX-1200:\e
	:dv=/dev/cua0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D
:br#1200:arpavax|ax:\e
	:pn=7654321%:tc=UNIX-1200
.fi
.in -2
.sp

.SH FILES
.sp
.ne 2
.na
\fB\fB/etc/remote\fR\fR
.ad
.RS 15n
remote host description file.
.RE

.sp
.ne 2
.na
\fB\fB/etc/phones\fR\fR
.ad
.RS 15n
remote host phone number database.
.RE

.SH SEE ALSO
.sp
.LP
.BR tip (1),
.BR phones (5)
.sp
.LP
\fISystem Administration Guide: IP Services\fR