510 lines
13 KiB
Groff
510 lines
13 KiB
Groff
.\" $OpenBSD: tip.1,v 1.19 2001/09/23 06:15:30 pvalchev Exp $
|
|
.\" $NetBSD: tip.1,v 1.7 1994/12/08 09:31:05 jtc Exp $
|
|
.\"
|
|
.\" Copyright (c) 1980, 1990, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)tip.1 8.4 (Berkeley) 4/18/94
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd April 18, 1994
|
|
.Dt TIP 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm tip
|
|
.Nd connect to a remote system
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl v
|
|
.Fl Ns Ns Ar speed
|
|
.Ar system\-name
|
|
.Nm
|
|
.Op Fl v
|
|
.Fl Ns Ns Ar speed
|
|
.Ar phone\-number
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
command establishes a full-duplex connection to another machine,
|
|
giving the appearance of being logged in directly on the
|
|
remote cpu. It goes without saying that you must have a login
|
|
on the machine (or equivalent) to which you wish to connect.
|
|
.Pp
|
|
Available Option:
|
|
.Bl -tag -width indent
|
|
.It Fl v
|
|
Set verbose mode.
|
|
.El
|
|
.Pp
|
|
Typed characters are normally transmitted directly to the remote
|
|
machine (which does the echoing as well). A tilde (`~') appearing
|
|
as the first character of a line is an escape signal; the following
|
|
are recognized:
|
|
.Bl -tag -width flag
|
|
.It Ic \&~^D No or Ic \&~ .
|
|
Drop the connection and exit
|
|
(you may still be logged in on the
|
|
remote machine).
|
|
.It Ic \&~c Op Ar name
|
|
Change directory to
|
|
.Ar name
|
|
(no argument
|
|
implies change to your home directory).
|
|
.It Ic \&~!
|
|
Escape to a shell (exiting the shell will
|
|
return you to tip).
|
|
.It Ic \&~>
|
|
Copy file from local to remote.
|
|
The
|
|
.Nm
|
|
utility prompts for the name of a local file to transmit.
|
|
.It Ic \&~<
|
|
Copy file from remote to local.
|
|
The
|
|
.Nm
|
|
utility prompts first for the name of the file to be sent, then for
|
|
a command to be executed on the remote machine.
|
|
.It Ic \&~p Ar from Op Ar to
|
|
Send a file to a remote
|
|
.Ux
|
|
host. The put command causes the remote
|
|
.Ux
|
|
system to run the command string ``cat > 'to''', while
|
|
.Nm
|
|
sends it the ``from''
|
|
file. If the ``to'' file isn't specified the ``from'' file name is used.
|
|
This command is actually a
|
|
.Ux
|
|
specific version of the ``~>'' command.
|
|
.It Ic \&~t Ar from Op Ar to
|
|
Take a file from a remote
|
|
.Ux
|
|
host.
|
|
As in the put command the ``to'' file
|
|
defaults to the ``from'' file name if it isn't specified.
|
|
The remote host
|
|
executes the command string ``cat 'from';echo ^A'' to send the file to
|
|
.Nm .
|
|
.It Ic \&~|
|
|
Pipe the output from a remote command to a local
|
|
.Ux
|
|
process.
|
|
The command string sent to the local
|
|
.Ux
|
|
system is processed by the shell.
|
|
.It Ic \&~$
|
|
Pipe the output from a local
|
|
.Ux
|
|
process to the remote host.
|
|
The command string sent to the local
|
|
.Ux
|
|
system is processed by the shell.
|
|
.It Ic \&~C
|
|
Fork a child process on the local system to perform special protocols
|
|
such as \s-1XMODEM\s+1.
|
|
The child program will be run with the following somewhat unusual
|
|
arrangement of file descriptors:
|
|
.Bd -literal -offset indent
|
|
0 <-> local tty in
|
|
1 <-> local tty out
|
|
2 <-> local tty out
|
|
3 <-> remote tty in
|
|
4 <-> remote tty out
|
|
.Ed
|
|
.It Ic \&~#
|
|
Send a
|
|
.Dv BREAK
|
|
to the remote system.
|
|
For systems which don't support the necessary
|
|
.Fn ioctl
|
|
call the break is simulated by a sequence of line speed changes and
|
|
DEL characters.
|
|
.It Ic \&~s
|
|
Set a variable (see the discussion below).
|
|
.It Ic \&~v
|
|
List all variables and their values (if set).
|
|
.It Ic \&~^Z
|
|
Stop
|
|
.Nm
|
|
(only available with job control).
|
|
.It Ic \&~^Y
|
|
Stop only the
|
|
.Dq local side
|
|
of
|
|
.Nm
|
|
(only available with job control); the
|
|
.Dq remote side
|
|
of
|
|
.Nm tip ,
|
|
the side that displays output from the remote host, is left running.
|
|
.It Ic \&~?
|
|
Get a summary of the tilde escapes.
|
|
.El
|
|
.Pp
|
|
To find the system description and thus the operating characteristics
|
|
of
|
|
.Ar system-name ,
|
|
.Nm
|
|
searches for a system description with a name identical to
|
|
.Ar system-name .
|
|
The search order is
|
|
.Bl -enum -offset indent
|
|
.It
|
|
If the environment variable
|
|
.Ev REMOTE
|
|
does not start with a
|
|
.Ql \&/
|
|
it is assumed to be a system description, and is considered first.
|
|
.It
|
|
If the environment variable
|
|
.Ev REMOTE
|
|
begins with a
|
|
.Ql \&/
|
|
it is assumed to be a path to a
|
|
.Xr remote 5
|
|
database, and the specified database is searched.
|
|
.It
|
|
The default
|
|
.Xr remote 5
|
|
database,
|
|
.Pa /etc/remote ,
|
|
is searched.
|
|
.El
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility uses the file
|
|
.Pa /etc/remote
|
|
to find how to reach a particular
|
|
system and to find out how it should operate while talking
|
|
to the system;
|
|
refer to
|
|
.Xr remote 5
|
|
for a full description.
|
|
Each system has a default baud rate with which to
|
|
establish a connection. If this value is not suitable, the baud rate
|
|
to be used may be specified on the command line, e.g.\&
|
|
.Ql "tip -300 mds" .
|
|
.Pp
|
|
When
|
|
.Nm
|
|
establishes a connection it sends out the connection message
|
|
specified in the
|
|
.Ar cm
|
|
capability of the system description being used.
|
|
.Pp
|
|
When
|
|
.Nm
|
|
prompts for an argument (e.g., during setup of a file transfer) the
|
|
line typed may be edited with the standard erase and kill characters.
|
|
A null line in response to a prompt, or an interrupt, will abort the
|
|
dialogue and return you to the remote machine.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility guards against multiple users connecting to a remote system
|
|
by opening modems and terminal lines with exclusive access,
|
|
and by honoring the locking protocol used by
|
|
.Xr uucico 8 .
|
|
.Pp
|
|
During file transfers
|
|
.Nm
|
|
provides a running count of the number of lines transferred.
|
|
When using the
|
|
.Ic ~>
|
|
and
|
|
.Ic ~<
|
|
commands, the
|
|
.Dq eofread
|
|
and
|
|
.Dq eofwrite
|
|
variables are used to recognize end-of-file when reading, and specify
|
|
end-of-file when writing (see below).
|
|
File transfers normally depend on tandem mode for flow control.
|
|
If the remote system does not support tandem mode,
|
|
.Dq echocheck
|
|
may be set to indicate
|
|
.Nm
|
|
should synchronize with the remote system on the echo of each
|
|
transmitted character.
|
|
.Pp
|
|
When
|
|
.Nm
|
|
must dial a phone number to connect to a system it will print
|
|
various messages indicating its actions.
|
|
The
|
|
.Nm
|
|
utility supports modems that use the AT command set.
|
|
The
|
|
.Nm
|
|
utility uses the file
|
|
.Pa /etc/modems
|
|
to find out how to operate with a particular
|
|
modem; refer to
|
|
.Xr modems 5
|
|
for a full description.
|
|
.Ss VARIABLES
|
|
The
|
|
.Nm
|
|
utility maintains a set of
|
|
.Ar variables
|
|
which control its operation.
|
|
Some of these variables are read-only to normal users (root is allowed
|
|
to change anything of interest).
|
|
Variables may be displayed and set through the
|
|
.Sq s
|
|
escape.
|
|
The syntax for variables is patterned after
|
|
.Xr vi 1
|
|
and
|
|
.Xr Mail 1 .
|
|
Supplying
|
|
.Dq all
|
|
as an argument to the set command displays all variables readable by
|
|
the user.
|
|
Alternatively, the user may request display of a particular variable
|
|
by attaching a
|
|
.Ql ?
|
|
to the end.
|
|
For example,
|
|
.Dq escape?
|
|
displays the current escape character.
|
|
.Pp
|
|
Variables are numeric, string, character, or boolean values.
|
|
Boolean variables are set merely by specifying their name; they may be
|
|
reset by prepending a
|
|
.Ql !
|
|
to the name.
|
|
Other variable types are set by concatenating an
|
|
.Ql =
|
|
and the value.
|
|
The entire assignment must not have any blanks in it.
|
|
A single set command may be used to interrogate as well as set a
|
|
number of variables.
|
|
Variables may be initialized at run time by placing set commands
|
|
(without the
|
|
.Ql ~s
|
|
prefix in a file
|
|
.Pa .tiprc
|
|
in one's home directory).
|
|
The
|
|
.Fl v
|
|
option causes
|
|
.Nm
|
|
to display the sets as they are made.
|
|
Certain common variables have abbreviations.
|
|
The following is a list of common variables, their abbreviations, and
|
|
their default values:
|
|
.Bl -tag -width Ar
|
|
.It Ar beautify
|
|
(bool) Discard unprintable characters when a session is being
|
|
scripted; abbreviated
|
|
.Ar be .
|
|
.It Ar baudrate
|
|
(num) The baud rate at which the connection was established;
|
|
abbreviated
|
|
.Ar ba .
|
|
.It Ar dialtimeout
|
|
(num) When dialing a phone number, the time (in seconds) to wait for a
|
|
connection to be established; abbreviated
|
|
.Ar dial .
|
|
.It Ar echocheck
|
|
(bool) Synchronize with the remote host during file transfer by
|
|
waiting for the echo of the last character transmitted; default is
|
|
.Ar off .
|
|
.It Ar eofread
|
|
(str) The set of characters which signify an end-of-transmission
|
|
during a
|
|
.Ic ~<
|
|
file transfer command; abbreviated
|
|
.Ar eofr .
|
|
.It Ar eofwrite
|
|
(str) The string sent to indicate end-of-transmission during a
|
|
.Ic ~>
|
|
file transfer command; abbreviated
|
|
.Ar eofw .
|
|
.It Ar eol
|
|
(str) The set of characters which indicate an end-of-line.
|
|
The
|
|
.Nm
|
|
utility will recognize escape characters only after an end-of-line.
|
|
.It Ar escape
|
|
(char) The command prefix (escape) character; abbreviated
|
|
.Ar es ;
|
|
default value is
|
|
.Ql ~ .
|
|
.It Ar exceptions
|
|
(str) The set of characters which should not be discarded due to the
|
|
beautification switch; abbreviated
|
|
.Ar ex ;
|
|
default value is
|
|
.Dq \et\en\ef\eb .
|
|
.It Ar force
|
|
(char) The character used to force literal data transmission;
|
|
abbreviated
|
|
.Ar fo ;
|
|
default value is
|
|
.Ql ^P .
|
|
.It Ar framesize
|
|
(num) The amount of data (in bytes) to buffer between filesystem
|
|
writes when receiving files; abbreviated
|
|
.Ar fr .
|
|
.It Ar host
|
|
(str) The name of the host to which you are connected; abbreviated
|
|
.Ar ho .
|
|
.It Ar prompt
|
|
(char) The character which indicates an end-of-line on the remote
|
|
host; abbreviated
|
|
.Ar pr ;
|
|
default value is
|
|
.Ql \en .
|
|
This value is used to synchronize during data transfers.
|
|
The count of lines transferred during a file transfer command is based
|
|
on receipt of this character.
|
|
.It Ar raise
|
|
(bool) Upper case mapping mode; abbreviated
|
|
.Ar ra ;
|
|
default value is
|
|
.Ar off .
|
|
When this mode is enabled, all lowercase letters will be mapped to
|
|
uppercase by
|
|
.Nm
|
|
for transmission to the remote machine.
|
|
.It Ar raisechar
|
|
(char) The input character used to toggle uppercase mapping mode;
|
|
abbreviated
|
|
.Ar rc ;
|
|
default value is
|
|
.Ql ^A .
|
|
.It Ar record
|
|
(str) The name of the file in which a session script is recorded;
|
|
abbreviated
|
|
.Ar rec ;
|
|
default value is
|
|
.Dq tip.record .
|
|
.It Ar script
|
|
(bool) Session scripting mode; abbreviated
|
|
.Ar sc ;
|
|
default is
|
|
.Ar off .
|
|
When
|
|
.Ar script
|
|
is
|
|
.Li true ,
|
|
.Nm
|
|
will record everything transmitted by the remote machine in the script
|
|
record file specified in
|
|
.Ar record .
|
|
If the
|
|
.Ar beautify
|
|
switch is on, only printable
|
|
.Tn ASCII
|
|
characters will be included in the script file (those characters
|
|
between 040 and 0177).
|
|
The variable
|
|
.Ar exceptions
|
|
is used to indicate characters which are an exception to the normal
|
|
beautification rules.
|
|
.It Ar tabexpand
|
|
(bool) Expand tabs to spaces during file transfers; abbreviated
|
|
.Ar tab ;
|
|
default value is
|
|
.Ar false .
|
|
Each tab is expanded to 8 spaces.
|
|
.It Ar verbose
|
|
(bool) Verbose mode; abbreviated
|
|
.Ar verb ;
|
|
default is
|
|
.Ar true .
|
|
When verbose mode is enabled,
|
|
.Nm
|
|
prints messages while dialing, shows the current number of lines
|
|
transferred during a file transfer operations, and more.
|
|
.El
|
|
.Sh ENVIRONMENT
|
|
The
|
|
.Nm
|
|
utility uses the following environment variables:
|
|
.Bl -tag -width Fl
|
|
.It Ev SHELL
|
|
The name of the shell to use for the
|
|
.Ic ~!
|
|
command; default value is
|
|
.Dq /bin/sh .
|
|
.It Ev HOME
|
|
The home directory to use for the
|
|
.Ic ~c
|
|
command.
|
|
.It Ev HOST
|
|
The default value for
|
|
.Ar system-name
|
|
if none is specified via the command line.
|
|
.It Ev REMOTE
|
|
A system description, or an absolute path to a
|
|
.Xr remote 5
|
|
system description database.
|
|
.It Ev PHONES
|
|
A path to a
|
|
.Xr phones 5
|
|
database.
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width "/var/spool/lock/LCK..*" -compact
|
|
.It Pa /etc/remote
|
|
global
|
|
.Xr remote 5
|
|
database
|
|
.It Pa /etc/phones
|
|
default
|
|
.Xr phones 5
|
|
file
|
|
.It Pa ~/.tiprc
|
|
initialization file
|
|
.It Pa tip.record
|
|
record file
|
|
.It Pa /var/log/aculog
|
|
line access log
|
|
.It Pa /var/spool/lock/LCK..*
|
|
lock file to avoid conflicts with
|
|
.Xr uucp
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr phones 5 ,
|
|
.Xr remote 5
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
appeared command in
|
|
.Bx 4.2 .
|
|
.Sh BUGS
|
|
The full set of variables is undocumented and should, probably, be
|
|
pared down.
|