src/usr.bin/tip/tip.1 - diff

Return to tip.1 CVS log

Up to [local] / src / usr.bin / tip

Diff for /src/usr.bin/tip/Attic/tip.1 between version 1.13 and 1.14

version 1.13, 2001/07/31 09:18:21

version 1.14, 2001/08/11 00:05:53

Line 44

.Sh SYNOPSIS

.Nm tip

.Op Fl nv

.Fl Ns Ns Ar speed

.Op Fl Ar speed

.Ar system\-name

.Op Ar system\-name

.Nm tip

.Op Fl nv

.Fl Ns Ns Ar speed

.Ar phone\-number

.\" .Nm cu

.\" .Ar phone\-number

.\" .Op Fl t

Line 61

Line 57

.Nm

.\" and

.\" .Nm cu

establishes a full-duplex connection to another machine,

establishes a full-duplex connection to another machine, giving the

giving the appearance of being logged in directly on the

appearance of being logged in directly on the remote CPU.

remote CPU.

It goes without saying that you must have a login on the machine (or

It goes without saying that you must have a login

equivalent) to which you wish to connect.

on the machine (or equivalent) to which you wish to connect.

.\" The preferred interface is

.\" .Nm tip .

.\" The

Line 78

Line 73

.\" .Nm tip .

.Pp

The options are as follows:

.Bl -tag -width Ds

.Bl -tag -offset indent -width 4n

.It Fl v

Set verbose mode.

.It Fl n

No escape (disable tilde).

.El

.Pp

.Ar speed

is specified it will override any baudrate specified in the system

description being used.

.Pp

If neither

.Ar speed

nor

.Ar system-name

are specified,

.Ar system-name

will be set to the value of the

.Ev HOST

environment variable.

.Pp

.Ar speed

is specified but

.Ar system-name

is not,

.Ar system-name

will be set to a value of 'tip' with

.Ar speed

appended.

e.g.

.Ic tip -1200

will set

.Ar system-name

to 'tip1200'.

.Pp

Typed characters are normally transmitted directly to the remote

machine (which does the echoing as well).

A tilde

.Pq Ql ~

appearing

appearing as the first character of a line is an escape signal; the

as the first character of a line is an escape signal; the following

following are recognized:

are recognized:

.Bl -tag -offset indent -width Fl

.Bl -tag -width flag

.It Ic \&~^D No or Ic \&~ .

Drop the connection and exit

Drop the connection and exit (you may still be logged in on the remote

(you may still be logged in on the

machine).

remote machine).

.It Ic \&~c Op Ar name

Change directory to

.Ar name

(no argument

(no argument implies change to your home directory).

implies change to your home directory).

.It Ic \&~!

Escape to a shell (exiting the shell will return you to

.Nm tip Ns ).

Line 112

Line 134

.It Ic \&~<

Copy file from remote to local.

.Nm

prompts first for the name of the file to be sent, then for

prompts first for the name of the file to be sent, then for a command

a command to be executed on the remote machine.

to be executed on the remote machine.

.It Ic \&~p Ar from Op Ar to

Send a file to a remote

.Ux

Line 143

Line 165

host.

As in the put command the

.Dq to

file

file defaults to the

defaults to the

.Dq from

file name if it isn't specified.

The remote host

The remote host executes the command string

executes the command string

.Dq cat 'from';echo ^A

to send the file to

.Nm tip .

Line 169

Line 189

.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

The child program will be run with the following somewhat unusual

somewhat unusual arrangement of file descriptors:

arrangement of file descriptors:

.nf

.Bd -literal -offset indent

.in +1i

0 <-> local tty in

1 <-> local tty out

2 <-> local tty out

3 <-> remote tty in

4 <-> remote tty out

.in -1i

.Ed

.fi

.It Ic \&~#

Send a

.Dv BREAK

to the remote system.

For systems which don't support the

For systems which don't support the necessary

necessary

.Fn ioctl

call the break is simulated by a sequence of line speed changes

call the break is simulated by a sequence of line speed changes and

and DEL characters.

DEL characters.

.It Ic \&~s

Set a variable (see the discussion below).

.It Ic \&~^Z

Line 200

Line 217

.Dq local side

.Nm

(only available with job control);

(only available with job control); the

the

.Dq remote side

.Nm tip ,

Line 210

Line 226

Get a summary of the tilde escapes.

.El

.Pp

To find the system description and thus the operating characteristics

.Ar system-name ,

.Nm

uses the file

searches for a system description with a name identical to

.Pa /etc/remote

.Ar system-name .

to find how to reach a particular

The search order is

system and to find out how it should operate while talking

.Bl -enum -offset indent

to the system;

.It

refer to

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

for a full description.

database, and the specified database is searched.

Each system has a default baud rate with which to

.It

establish a connection.

The default

If this value is not suitable, the baud rate

.Xr remote 5

to be used may be specified on the command line, e.g.,

database,

.Pa /etc/remote ,

is searched.

.El

.Pp

See

.Xr remote 5

for full documentation on system descriptions.

.Pp

The

.Ar ba

capability is used in system descriptions to specify the baud rate

with which to establish a connection.

If the value specified is not suitable, the baud rate to be used may

be given on the command line, e.g.,

.Ql "tip -300 mds" .

.Pp

When

.Nm

establishes a connection it sends out a

establishes a connection it sends out the connection message

connection message to the remote system; the default value, if any,

specified in the

is defined in

.Ar cm

.Pa /etc/remote

capability of the system description being used.

(see

.Xr remote 5 ) .

.Pp

When

.Nm

prompts for an argument (e.g., during setup of

prompts for an argument (e.g., during setup of a file transfer) the

a file transfer) the line typed may be edited with the standard

line typed may be edited with the standard erase and kill characters.

erase and kill characters.

A null line in response to a prompt, or an interrupt, will abort the

A null line in response to a prompt,

dialogue and return you to the remote machine.

or an interrupt, will abort the dialogue and return you to the

remote machine.

.Pp

.Nm

guards against multiple users connecting to a remote system

guards against multiple users connecting to a remote system by opening

by opening modems and terminal lines with exclusive access,

modems and terminal lines with exclusive access, and by honoring the

and by honoring the locking protocol used by

locking protocol used by

.Xr uucico 8 .

.Pp

During file transfers

Line 260

Line 299

.Dq eofread

and

.Dq eofwrite

variables are used to recognize end-of-file when reading, and

variables are used to recognize end-of-file when reading, and specify

specify end-of-file when writing (see below).

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

Line 272

Line 311

.Pp

When

.Nm

must dial a phone number to connect to a system it will print

must dial a phone number to connect to a system it will print various

various messages indicating its actions.

messages indicating its actions.

.Nm

supports the

supports a variety of auto-call units and modems with the

.Tn DEC DN Ns -11

.Ar at

and

capability in system descriptions.

Racal-Vadic 831 auto-call-units;

.Pp

the

Support for Ventel 212+ (ventel), Hayes AT-style (hayes),

.Tn DEC DF Ns \&02

USRobotics Courier (courier), Telebit T3000 (t3000) and

and

Racal-Vadic 831 (vadic) units is enabled by default.

.Tn DF Ns \&03 ,

.Pp

Ventel 212+, Racal-Vadic 3451, and

Support for Bizcomp 1031[fw] (biz31[fw]), Bizcomp 1022[fw]

Bizcomp 1031 and 1032 integral call unit/modems.

(biz22[fw]), DEC DF0[23]-AC (df0[23]), DEC DN-11 (dn11) and

Racal-Vadic 3451 (v3451) units can be added by recompiling

.Xr tip 1

with the appropriate defines.

.Pp

Note that if support for both the Racal-Vadic 831 and 3451 is enabled

they are referred to as the v831 and v3451 respectively.

If only one of the two is supported, it is referred to as vadic.

.Ss VARIABLES

.Nm

maintains a set of variables

maintains a set of variables which control its operation.

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

Line 302

Line 347

.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

Alternatively, the user may request display of a particular variable

variable by attaching a

by attaching a

.Ql ?

to the end.

For example,

Line 311

Line 356

displays the current escape character.

.Pp

Variables are numeric, string, character, or boolean values.

Boolean

Boolean variables are set merely by specifying their name; they may be

variables are set merely by specifying their name; they may be reset

reset by prepending a

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

A single set command may be used to interrogate as well as set a

as well as set a number of variables.

number of variables.

Variables may be initialized at run time by placing set commands

(without the

.Ql ~s

Line 334

Line 378

.Nm

to display the sets as they are made.

Certain common variables have abbreviations.

The following is a list of common variables,

The following is a list of common variables, their abbreviations, and

their abbreviations, and their default values:

their default values:

.Bl -tag -width Ar

.It Ar beautify

(bool) Discard unprintable characters when a session is being scripted;

(bool) Discard unprintable characters when a session is being

abbreviated

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)

(num) When dialing a phone number, the time (in seconds) to wait for a

to wait for a connection to be established; abbreviated

connection to be established; abbreviated

.Ar dial .

.It Ar echocheck

(bool) Synchronize with the remote host during file transfer by

Line 374

Line 418

default value is

.Ql ~ .

.It Ar exceptions

(str) The set of characters which should not be discarded

(str) The set of characters which should not be discarded due to the

due to the beautification switch; abbreviated

beautification switch; abbreviated

.Ar ex ;

default value is

.Dq \et\en\ef\eb .

Line 399

Line 443

default value is

.Ql \en .

This value is used to synchronize during data transfers.

The count of lines transferred during a file transfer

The count of lines transferred during a file transfer command is based

command is based on receipt of this character.

on receipt of this character.

.It Ar raise

(bool) Upper case mapping mode; abbreviated

.Ar ra ;

Line 432

Line 476

.Li true ,

.Nm

will record everything transmitted by the remote machine in

will record everything transmitted by the remote machine in the script

the script record file specified in

record file specified in

.Ar record .

If the

.Ar beautify

switch is on, only printable

.Tn ASCII

characters will be included in

characters will be included in the script file (those characters

the script file (those characters between 040 and 0177).

between 040 and 0177).

The variable

.Ar exceptions

is used to indicate characters which are an exception to the normal

Line 458

Line 502

.Ar true .

When verbose mode is enabled,

.Nm

prints messages while dialing, shows the current number

prints messages while dialing, shows the current number of lines

of lines transferred during a file transfer operations,

transferred during a file transfer operations, and more.

and more.

.El

.Sh ENVIRONMENT

.Bl -tag -width Fl

.It Ev SHELL

(str) The name of the shell to use for the

The name of the shell to use for the

.Ic ~!

command; default value is

.Dq /bin/sh ,

.Dq /bin/sh .

or taken from the environment.

.It Ev HOME

(str) The home directory to use for the

The home directory to use for the

.Ic ~c

command; default value is taken from the environment.

command.

.It Ev HOST

Check for a default host if none specified.

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

.Pp

The variables

.Ev ${REMOTE}

and

.Ev ${PHONES}

are also exported.

.Sh FILES

.Bl -tag -width /var/spool/lock/LCK..* -compact

.Bl -tag -width "/var/spool/lock/LCK..*" -compact

.It Pa /etc/remote

global system descriptions

global

.Xr remote 5

database

.It Pa /etc/phones

global phone number database

default

.It ${REMOTE}

.Xr phones 5

private system descriptions

file

.It ${PHONES}

private phone numbers

.It Pa ~/.tiprc

initialization file

.It Pa tip.record