386BSD 0.1 development

[unix-history] / usr / src / usr.bin / tip / tip.1

diff --git a/usr/src/usr.bin/tip/tip.1 b/usr/src/usr.bin/tip/tip.1
index 8904184..f1764c6 100644 (file)
--- a/usr/src/usr.bin/tip/tip.1
+++ b/usr/src/usr.bin/tip/tip.1
@@ -1,11 +1,37 @@
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" 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.

 .\"
 .\"

-.\"     @(#)tip.1      6.5 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.Dd 
+.\"    @(#)tip.1       6.8 (Berkeley) 7/27/91
+.\"
+.Dd July 27, 1991

 .Dt TIP 1
 .Os BSD 4
 .Sh NAME
 .Dt TIP 1
 .Os BSD 4
 .Sh NAME


@@ -15,15 +41,11 @@
 .Sh SYNOPSIS
 .Nm tip
 .Op Fl v
 .Sh SYNOPSIS
 .Nm tip
 .Op Fl v

-.Cx Fl
-.Ar speed
-.Cx
+.Fl Ns Ns Ar speed 

 .Ar system\-name
 .Nm tip
 .Op Fl v
 .Ar system\-name
 .Nm tip
 .Op Fl v

-.Cx Fl
-.Ar speed
-.Cx
+.Fl Ns Ns Ar speed 

 .Ar phone\-number
 .Nm cu
 .Ar phone\-number
 .Ar phone\-number
 .Nm cu
 .Ar phone\-number


@@ -45,99 +67,111 @@ The preferred interface is
 The
 .Ar cu
 interface is included for those people attached to the
 The
 .Ar cu
 interface is included for those people attached to the

-``call UNIX'' command of version 7.  This manual page
+``call
+.Ux Ns ''
+command of version 7.  This manual page

 describes only
 .Nm tip  .
 .Pp
 describes only
 .Nm tip  .
 .Pp

-Options:
-.Tp Fl v
+Available Option:
+.Bl -tag -width indent
+.It Fl v

 Set verbose mode.
 Set verbose mode.

-.Tp
+.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:
 .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:

-.Tw Ds
-.Tp Ic \&~^D \&~ .
+.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).
 Drop the connection and exit
 (you may still be logged in on the
 remote machine).

-.Pp
-.Tp Cx Ic \&~c
-.Cx \&\ \&
-.Op Ar name
-.Cx
-Change directory to name (no argument
+.It Ic \&~c Op Ar name 
+Change directory to
+.Ar name
+(no argument

 implies change to your home directory).
 implies change to your home directory).

-.Tp Ic \&~!
+.It Ic \&~!

 Escape to a shell (exiting the shell will
 return you to tip).
 Escape to a shell (exiting the shell will
 return you to tip).

-.Tp Ic \&~>
+.It Ic \&~>

 Copy file from local to remote.
 .Nm Tip
 prompts for the name of a local file to transmit.
 Copy file from local to remote.
 .Nm Tip
 prompts for the name of a local file to transmit.

-.Tp Ic \&~<
+.It Ic \&~<

 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.
 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.

-.Tp Cx Ic \&~p
-.Cx \&\ \&
-.Ar from
-.Cx \&\ \&
-.Op Ar to
-.Cx
-Send a file to a remote UNIX host.  The put command causes the remote UNIX
+.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 tip
 sends it the ``from''
 file.  If the ``to'' file isn't specified the ``from'' file name is used.
 system to run the command string ``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 UNIX specific version of the ``~>'' command.
-.Tp Cx Ic \&~t
-.Cx \&\ \&
-.Ar from
-.Cx \&\ \&
-.Op Ar to
-.Cx
-Take a file from a remote UNIX host.
+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 tip  .
 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 tip  .

-.Tp Ic \&~
-Pipe the output from a remote command to a local UNIX process.
-The command string sent to the local UNIX system is processed by the shell.
-.Tp Ic \&~$
-Pipe the output from a local UNIX process to the remote host.
-The command string sent to the local UNIX system is processed by the shell.
-.Tp Ic \&~#
-Send a BREAK to the remote system.
+.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 \&~#
+Send a
+.Dv BREAK
+to the remote system.

 For systems which don't support the
 necessary
 .Ar ioctl
 call the break is simulated by a sequence of line speed changes
 For systems which don't support the
 necessary
 .Ar ioctl
 call the break is simulated by a sequence of line speed changes

-and DEL characters.
-.Tp Ic \&~s
+and
+.Dv DEL
+characters.
+.It Ic \&~s

 Set a variable (see the discussion below).
 Set a variable (see the discussion below).

-.Tp Ic \&~^Z
+.It Ic \&~^Z

 Stop
 .Nm tip
 (only available with job control).
 Stop
 .Nm tip
 (only available with job control).

-.Tp Ic \&~^Y
+.It Ic \&~^Y

 Stop only the ``local side'' of
 .Nm tip
 (only available with job control);
 the ``remote side'' of
 .Nm tip  ,
 the side that displays output from the remote host, is left running.
 Stop only the ``local side'' of
 .Nm tip
 (only available with job control);
 the ``remote side'' of
 .Nm tip  ,
 the side that displays output from the remote host, is left running.

-.Tp Ic \&~?
+.It Ic \&~?

 Get a summary of the tilde escapes
 Get a summary of the tilde escapes

-.Tp
+.El

 .Pp
 .Nm Tip
 .Pp
 .Nm Tip

-uses the file /etc/remote to find how to reach a particular
+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
 system and to find out how it should operate while talking
 to the system;
 refer to


@@ -145,14 +179,16 @@ refer to
 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
 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. ``tip -300 mds''.
+to be used may be specified on the command line, e.g.
+.Ql "tip -300 mds" .

 .Pp
 When
 .Nm tip
 establishes a connection it sends out a
 connection message to the remote system; the default value, if any,
 is defined in
 .Pp
 When
 .Nm tip
 establishes a connection it sends out a
 connection message to the remote system; the default value, if any,
 is defined in

-.Pa /etc/remote (see
+.Pa /etc/remote
+(see

 .Xr remote 5 ) .
 .Pp
 When
 .Xr remote 5 ) .
 .Pp
 When


@@ -187,8 +223,15 @@ When
 must dial a phone number to connect to a system it will print
 various messages indicating its actions.
 .Nm Tip
 must dial a phone number to connect to a system it will print
 various messages indicating its actions.
 .Nm Tip

-supports the DEC DN-11 and Racal-Vadic 831 auto-call-units;
-the DEC DF02 and DF03, Ventel 212+, Racal-Vadic 3451, and
+supports the
+.Tn DEC DN Ns-11
+and
+Racal-Vadic 831 auto-call-units;
+the
+.Tn DEC DF Ns \&02
+and
+.Tn DF Ns \&03 ,
+Ventel 212+, Racal-Vadic 3451, and

 Bizcomp 1031 and 1032 integral call unit/modems.
 .Ss VARIABLES
 .Nm Tip
 Bizcomp 1031 and 1032 integral call unit/modems.
 .Ss VARIABLES
 .Nm Tip


@@ -225,64 +268,64 @@ 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.
 Certain common variables have abbreviations.
 The following is a list of common variables,
 their abbreviations, and their default values.

-.Tw Ar
-.Tp Ar beautify
+.Bl -tag -width Ar
+.It Ar beautify

 (bool) Discard unprintable characters when a session is being scripted;
 abbreviated
 .Ar be  .
 (bool) Discard unprintable characters when a session is being scripted;
 abbreviated
 .Ar be  .

-.Tp Ar baudrate
+.It Ar baudrate

 (num) The baud rate at which the connection was established;
 abbreviated
 .Ar ba  .
 (num) The baud rate at which the connection was established;
 abbreviated
 .Ar ba  .

-.Tp Ar dialtimeout
+.It Ar dialtimeout

 (num) When dialing a phone number, the time (in seconds)
 to wait for a connection to be established; abbreviated
 .Ar dial  .
 (num) When dialing a phone number, the time (in seconds)
 to wait for a connection to be established; abbreviated
 .Ar dial  .

-.Tp Ar echocheck
+.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  .
 (bool) Synchronize with the remote host during file transfer by
 waiting for the echo of the last character transmitted; default is
 .Ar off  .

-.Tp Ar eofread
+.It Ar eofread

 (str) The set of characters which signify and end-of-tranmission
 during a ~< file transfer command; abbreviated
 .Ar eofr  .
 (str) The set of characters which signify and end-of-tranmission
 during a ~< file transfer command; abbreviated
 .Ar eofr  .

-.Tp Ar eofwrite
+.It Ar eofwrite

 (str) The string sent to indicate end-of-transmission during
 a ~> file transfer command; abbreviated
 .Ar eofw  .
 (str) The string sent to indicate end-of-transmission during
 a ~> file transfer command; abbreviated
 .Ar eofw  .

-.Tp Ar eol
+.It Ar eol

 (str) The set of characters which indicate an end-of-line.
 .Nm Tip
 will recognize escape characters only after an end-of-line.
 (str) The set of characters which indicate an end-of-line.
 .Nm Tip
 will recognize escape characters only after an end-of-line.

-.Tp Ar escape
+.It Ar escape

 (char) The command prefix (escape) character; abbreviated
 .Ar es  ;
 default value is `~'.
 (char) The command prefix (escape) character; abbreviated
 .Ar es  ;
 default value is `~'.

-.Tp Ar exceptions
+.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''.
 (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''.

-.Tp Ar force
+.It Ar force

 (char) The character used to force literal data transmission;
 abbreviated
 .Ar fo  ;
 default value is `^P'.
 (char) The character used to force literal data transmission;
 abbreviated
 .Ar fo  ;
 default value is `^P'.

-.Tp Ar framesize
+.It Ar framesize

 (num) The amount of data (in bytes) to buffer between file system
 writes when receiving files; abbreviated
 .Ar fr  .
 (num) The amount of data (in bytes) to buffer between file system
 writes when receiving files; abbreviated
 .Ar fr  .

-.Tp Ar host
+.It Ar host

 (str) The name of the host to which you are connected; abbreviated
 .Ar ho  .
 (str) The name of the host to which you are connected; abbreviated
 .Ar ho  .

-.Tp Ar prompt
+.It Ar prompt

 (char) The character which indicates and end-of-line on the remote
 host; abbreviated
 .Ar pr  ;
 default value is `\en'.  This value is used to synchronize during
 data transfers.  The count of lines transferred during a file transfer
 command is based on recipt of this character.
 (char) The character which indicates and end-of-line on the remote
 host; abbreviated
 .Ar pr  ;
 default value is `\en'.  This value is used to synchronize during
 data transfers.  The count of lines transferred during a file transfer
 command is based on recipt of this character.

-.Tp Ar raise
+.It Ar raise

 (bool) Upper case mapping mode; abbreviated
 .Ar ra  ;
 default value is
 (bool) Upper case mapping mode; abbreviated
 .Ar ra  ;
 default value is


@@ -291,17 +334,17 @@ When this mode is enabled, all lower case letters will be mapped to
 upper case by
 .Nm tip
 for transmission to the remote machine.
 upper case by
 .Nm tip
 for transmission to the remote machine.

-.Tp Ar raisechar
+.It Ar raisechar

 (char) The input character used to toggle upper case mapping mode;
 abbreviated
 .Ar rc  ;
 default value is `^A'.
 (char) The input character used to toggle upper case mapping mode;
 abbreviated
 .Ar rc  ;
 default value is `^A'.

-.Tp Ar record
+.It Ar record

 (str) The name of the file in which a session script is recorded;
 abbreviated
 .Ar rec  ;
 default value is ``tip.record''.
 (str) The name of the file in which a session script is recorded;
 abbreviated
 .Ar rec  ;
 default value is ``tip.record''.

-.Tp Ar script
+.It Ar script

 (bool) Session scripting mode; abbreviated
 .Ar sc  ;
 default is
 (bool) Session scripting mode; abbreviated
 .Ar sc  ;
 default is


@@ -316,19 +359,21 @@ the script record file specified in
 .Ar record  .
 If the
 .Ar beautify
 .Ar record  .
 If the
 .Ar beautify

-switch is on, only printable ASCII characters will be included in
+switch is on, only printable
+.Tn ASCII
+characters will be included in

 the script file (those characters betwee 040 and 0177).  The
 variable
 .Ar exceptions
 is used to indicate characters which are an exception to the normal
 beautification rules.
 the script file (those characters betwee 040 and 0177).  The
 variable
 .Ar exceptions
 is used to indicate characters which are an exception to the normal
 beautification rules.

-.Tp Ar tabexpand
+.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.
 (bool) Expand tabs to spaces during file transfers; abbreviated
 .Ar tab  ;
 default value is
 .Ar false  .
 Each tab is expanded to 8 spaces.

-.Tp Ar verbose
+.It Ar verbose

 (bool) Verbose mode; abbreviated
 .Ar verb  ;
 default is
 (bool) Verbose mode; abbreviated
 .Ar verb  ;
 default is


@@ -338,19 +383,20 @@ When verbose mode is enabled,
 prints messages while dialing, shows the current number
 of lines transferred during a file transfer operations,
 and more.
 prints messages while dialing, shows the current number
 of lines transferred during a file transfer operations,
 and more.

-.Tp
+.El

 .Sh ENVIRONMENT
 .Nm Tip
 .Sh ENVIRONMENT
 .Nm Tip

-uses the followinf environment variables:
-.Tp Ar SHELL
+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 ~! command; default
 value is ``/bin/sh'', or taken from the environment.

-.Tp Ar HOME
+.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 ~c command; default
 value is taken from the environment.

-.Tp Ar HOST
+.It Ev HOST

 Check for a default host if none specified.
 Check for a default host if none specified.

-.Tp
+.El

 .Pp
 The variables
 .Ev ${REMOTE}
 .Pp
 The variables
 .Ev ${REMOTE}


@@ -358,32 +404,35 @@ and
 .Ev ${PHONES}
 are also exported.
 .Sh FILES
 .Ev ${PHONES}
 are also exported.
 .Sh FILES

-.Dw /var/spool/uucp/LCK..*
-.Di L
-.Dp Pa /etc/remote
-global system descriptions
-.Dp Pa /etc/phones
-global phone number data base
-.Dp ${REMOTE}
-private system descriptions
-.Dp ${PHONES}
-private phone numbers
-.Dp ~/.tiprc
-initialization file.
-.Dp /var/log/aculog
-line access log
-.Dp Pa /var/spool/uucp/LCK..*
-lock file to avoid conflicts with
-.Xr uucp
-.Dp
+.Bl -tag -width /var/spool/uucp/LCK..* -compact
+.It Pa /etc/remote
+Global system descriptions.
+.It Pa /etc/phones
+Global phone number data base.
+.It ${REMOTE}
+Private system descriptions.
+.It ${PHONES}
+Private phone numbers.
+.It ~/.tiprc
+Initialization file.
+.It Pa tip.record
+Record file.
+.It /var/log/aculog
+Line access log.
+.It Pa /var/spool/uucp/LCK..*
+Lock file to avoid conflicts with
+.Xr uucp .
+.El

 .Sh DIAGNOSTICS
 Diagnostics are, hopefully, self explanatory.
 .Sh SEE ALSO
 .Xr remote 5 ,
 .Xr phones 5
 .Sh HISTORY
 .Sh DIAGNOSTICS
 Diagnostics are, hopefully, self explanatory.
 .Sh SEE ALSO
 .Xr remote 5 ,
 .Xr phones 5
 .Sh HISTORY

-.Nm Tip
-appeared in 4.2 BSD.
+The
+.Nm tip
+appeared command in
+.Bx 4.2 .

 .Sh BUGS
 The full set of variables is undocumented and should, probably, be
 paired down.
 .Sh BUGS
 The full set of variables is undocumented and should, probably, be
 paired down.