diff options
Diffstat (limited to 'usr.bin/tip/tip.1')
| -rw-r--r-- | usr.bin/tip/tip.1 | 194 |
1 files changed, 123 insertions, 71 deletions
diff --git a/usr.bin/tip/tip.1 b/usr.bin/tip/tip.1 index c08e400f588..759d771d599 100644 --- a/usr.bin/tip/tip.1 +++ b/usr.bin/tip/tip.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tip.1,v 1.5 1998/11/11 23:01:47 aaron Exp $ +.\" $OpenBSD: tip.1,v 1.6 1999/06/05 01:21:43 aaron Exp $ .\" $NetBSD: tip.1,v 1.7 1994/12/08 09:31:05 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -36,19 +36,19 @@ .\" .Dd April 18, 1994 .Dt TIP 1 -.Os BSD 4 +.Os .Sh NAME -.Nm tip +.Nm tip .\" .Nm cu .Nd connect to a remote system .Sh SYNOPSIS .Nm tip .Op Fl nv -.Fl Ns Ns Ar speed +.Fl Ns Ns Ar speed .Ar system\-name .Nm tip .Op Fl nv -.Fl Ns Ns Ar speed +.Fl Ns Ns Ar speed .Ar phone\-number .\" .Nm cu .\" .Ar phone\-number @@ -76,7 +76,7 @@ on the machine (or equivalent) to which you wish to connect. .\" describes only .\" .Nm tip . .Pp -Available options: +The options are as follows: .Bl -tag -width indent .It Fl v Set verbose mode. @@ -85,7 +85,9 @@ No escape (disable tilde). .El .Pp Typed characters are normally transmitted directly to the remote -machine (which does the echoing as well). A tilde (`~') appearing +machine (which does the echoing as well). A tilde +.Pq Ql ~ +appearing as the first character of a line is an escape signal; the following are recognized: .Bl -tag -width flag @@ -93,7 +95,7 @@ are recognized: Drop the connection and exit (you may still be logged in on the remote machine). -.It Ic \&~c Op Ar name +.It Ic \&~c Op Ar name Change directory to .Ar name (no argument @@ -110,26 +112,41 @@ Copy file from remote to local. .Nm tip 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 +.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 +system to run the command string +.Dq cat > 'to' , +while .Nm tip -sends it the ``from'' -file. If the ``to'' file isn't specified the ``from'' file name is used. -This command is actually a +sends it the +.Dq from +file. If the +.Dq to +file isn't specified the +.Dq from +file name is used. +this command is actually a .Ux -specific version of the ``~>'' command. -.It Ic \&~t Ar from Op Ar to +specific version of the +.Ic ~> +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. +As in the put command the +.Dq to +file +defaults to the +.Dq from +file name if it isn't specified. The remote host -executes the command string ``cat 'from';echo ^A'' to send the file to +executes the command string +.Dq cat 'from';echo ^A +to send the file to .Nm tip . .It Ic \&~| Pipe the output from a remote command to a local @@ -166,27 +183,29 @@ For systems which don't support the necessary .Fn ioctl call the break is simulated by a sequence of line speed changes -and -.Dv DEL -characters. +and DEL characters. .It Ic \&~s Set a variable (see the discussion below). .It Ic \&~^Z Stop -.Nm tip +.Nm (only available with job control). .It Ic \&~^Y -Stop only the ``local side'' of -.Nm tip +Stop only the +.Dq local side +of +.Nm (only available with job control); -the ``remote side'' of +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 -.Nm tip +.Nm uses the file .Pa /etc/remote to find how to reach a particular @@ -201,7 +220,7 @@ to be used may be specified on the command line, e.g. .Ql "tip -300 mds" . .Pp When -.Nm tip +.Nm establishes a connection it sends out a connection message to the remote system; the default value, if any, is defined in @@ -210,37 +229,45 @@ is defined in .Xr remote 5 ) . .Pp When -.Nm tip +.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 -.Nm tip +.Nm 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 tip +.Nm provides a running count of the number of lines transferred. -When using the ~> and ~< commands, the ``eofread'' and ``eofwrite'' +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, ``echocheck'' may be set -to indicate -.Nm tip +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 tip +.Nm must dial a phone number to connect to a system it will print various messages indicating its actions. -.Nm tip +.Nm supports the .Tn DEC DN Ns-11 and @@ -252,35 +279,46 @@ and Ventel 212+, Racal-Vadic 3451, and Bizcomp 1031 and 1032 integral call unit/modems. .Ss VARIABLES -.Nm tip +.Nm maintains a set of 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 ``s'' escape. The syntax for variables is patterned -after -.Xr vi 1 +and set through the +.Sq s +escape. The syntax for variables is patterned after +.Xr vi 1 and -.Xr Mail 1 . -Supplying ``all'' +.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 `?' to the end. For example ``escape?'' +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 `!' to the name. Other variable types are set by -concatenating an `=' and the value. The entire assignment must not +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 ``~s'' prefix in a file +(without the +.Ql ~s +prefix in a file .Pa .tiprc in one's home directory). The .Fl v option causes -.Nm tip +.Nm to display the sets as they are made. Certain common variables have abbreviations. The following is a list of common variables, @@ -304,30 +342,36 @@ 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 ~< file transfer command; abbreviated +during a +.Ic ~< +file transfer command; abbreviated .Ar eofr . .It Ar eofwrite -(str) The string sent to indicate end-of-transmission during -a ~> file transfer command; abbreviated +(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. -.Nm tip +.Nm 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 `~'. +.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 ``\et\en\ef\eb''. +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 `^P'. +default value is +.Ql ^P . .It Ar framesize (num) The amount of data (in bytes) to buffer between file system writes when receiving files; abbreviated @@ -338,29 +382,33 @@ writes when receiving files; abbreviated .It Ar prompt (char) The character which indicates an end-of-line on the remote host; abbreviated -.Ar pr ; -default value is `\en'. This value is used to synchronize during +.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 ; +.Ar ra ; default value is .Ar off . When this mode is enabled, all lower case letters will be mapped to upper case by -.Nm tip +.Nm for transmission to the remote machine. .It Ar raisechar (char) The input character used to toggle upper case mapping mode; abbreviated -.Ar rc ; -default value is `^A'. +.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 ``tip.record''. +.Ar rec ; +default value is +.Dq tip.record . .It Ar script (bool) Session scripting mode; abbreviated .Ar sc ; @@ -370,7 +418,7 @@ When .Ar script is .Li true, -.Nm tip +.Nm will record everything transmitted by the remote machine in the script record file specified in .Ar record . @@ -396,21 +444,25 @@ Each tab is expanded to 8 spaces. default is .Ar true . When verbose mode is enabled, -.Nm tip +.Nm prints messages while dialing, shows the current number of lines transferred during a file transfer operations, and more. .El .Sh ENVIRONMENT -.Nm tip +.Nm uses the following environment variables: .Bl -tag -width Fl .It Ev SHELL -(str) The name of the shell to use for the ~! command; default -value is ``/bin/sh'', or taken from the environment. +(str) The name of the shell to use for the +.Ic ~! +command; default value is +.Dq /bin/sh , +or taken from the environment. .It Ev HOME -(str) The home directory to use for the ~c command; default -value is taken from the environment. +(str) The home directory to use for the +.Ic ~c +command; default value is taken from the environment. .It Ev HOST Check for a default host if none specified. .El @@ -447,7 +499,7 @@ Diagnostics are, hopefully, self-explanatory. .Xr remote 5 .Sh HISTORY The -.Nm tip +.Nm appeared command in .Bx 4.2 . .Sh BUGS |