Annotation of 43BSDReno/usr.bin/tip/tip.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1980, 1990 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)tip.1      6.6 (Berkeley) 7/24/90
                     19: .\"
                     20: .Dd July 24, 1990
                     21: .Dt TIP 1
                     22: .Os BSD 4
                     23: .Sh NAME
                     24: .Nm tip ,
                     25: .Nm cu
                     26: .Nd connect to a remote system
                     27: .Sh SYNOPSIS
                     28: .Nm tip
                     29: .Op Fl v
                     30: .Cx Fl
                     31: .Ar speed
                     32: .Cx
                     33: .Ar system\-name
                     34: .Nm tip
                     35: .Op Fl v
                     36: .Cx Fl
                     37: .Ar speed
                     38: .Cx
                     39: .Ar phone\-number
                     40: .Nm cu
                     41: .Ar phone\-number
                     42: .Op Fl t
                     43: .Op Fl s Ar speed
                     44: .Op Fl a Ar acu
                     45: .Op Fl l Ar line
                     46: .Op Fl #
                     47: .Sh DESCRIPTION
                     48: .Nm Tip
                     49: and
                     50: .Ar cu
                     51: establish a full-duplex connection to another machine,
                     52: giving the appearance of being logged in directly on the
                     53: remote cpu.  It goes without saying that you must have a login
                     54: on the machine (or equivalent) to which you wish to connect.
                     55: The preferred interface is
                     56: .Nm tip  .
                     57: The
                     58: .Ar cu
                     59: interface is included for those people attached to the
                     60: ``call UNIX'' command of version 7.  This manual page
                     61: describes only
                     62: .Nm tip  .
                     63: .Pp
                     64: Available Option:
                     65: .Tw Ds
                     66: .Tp Fl v
                     67: Set verbose mode.
                     68: .Tp
                     69: .Pp
                     70: Typed characters are normally transmitted directly to the remote
                     71: machine (which does the echoing as well).  A tilde (`~') appearing
                     72: as the first character of a line is an escape signal; the following
                     73: are recognized:
                     74: .Tw Ds
                     75: .Tp Ic \&~^D \&~ .
                     76: Drop the connection and exit
                     77: (you may still be logged in on the
                     78: remote machine).
                     79: .Pp
                     80: .Tp Cx Ic \&~c
                     81: .Cx \&\ \&
                     82: .Op Ar name
                     83: .Cx
                     84: Change directory to
                     85: .Ar name
                     86: (no argument
                     87: implies change to your home directory).
                     88: .Tp Ic \&~!
                     89: Escape to a shell (exiting the shell will
                     90: return you to tip).
                     91: .Tp Ic \&~>
                     92: Copy file from local to remote.
                     93: .Nm Tip
                     94: prompts for the name of a local file to transmit.
                     95: .Tp Ic \&~<
                     96: Copy file from remote to local.
                     97: .Nm Tip
                     98: prompts first for the name of the file to be sent, then for
                     99: a command to be executed on the remote machine.
                    100: .Tp Cx Ic \&~p
                    101: .Cx \&\ \&
                    102: .Ar from
                    103: .Cx \&\ \&
                    104: .Op Ar to
                    105: .Cx
                    106: Send a file to a remote UNIX host.  The put command causes the remote UNIX
                    107: system to run the command string ``cat > 'to''', while
                    108: .Nm tip
                    109: sends it the ``from''
                    110: file.  If the ``to'' file isn't specified the ``from'' file name is used.
                    111: This command is actually a UNIX specific version of the ``~>'' command.
                    112: .Tp Cx Ic \&~t
                    113: .Cx \&\ \&
                    114: .Ar from
                    115: .Cx \&\ \&
                    116: .Op Ar to
                    117: .Cx
                    118: Take a file from a remote UNIX host.
                    119: As in the put command the ``to'' file
                    120: defaults to the ``from'' file name if it isn't specified.
                    121: The remote host
                    122: executes the command string ``cat 'from';echo ^A'' to send the file to
                    123: .Nm tip  .
                    124: .Tp Ic \&~
                    125: Pipe the output from a remote command to a local UNIX process.
                    126: The command string sent to the local UNIX system is processed by the shell.
                    127: .Tp Ic \&~$
                    128: Pipe the output from a local UNIX process to the remote host.
                    129: The command string sent to the local UNIX system is processed by the shell.
                    130: .Tp Ic \&~#
                    131: Send a BREAK to the remote system.
                    132: For systems which don't support the
                    133: necessary
                    134: .Ar ioctl
                    135: call the break is simulated by a sequence of line speed changes
                    136: and DEL characters.
                    137: .Tp Ic \&~s
                    138: Set a variable (see the discussion below).
                    139: .Tp Ic \&~^Z
                    140: Stop
                    141: .Nm tip
                    142: (only available with job control).
                    143: .Tp Ic \&~^Y
                    144: Stop only the ``local side'' of
                    145: .Nm tip
                    146: (only available with job control);
                    147: the ``remote side'' of
                    148: .Nm tip  ,
                    149: the side that displays output from the remote host, is left running.
                    150: .Tp Ic \&~?
                    151: Get a summary of the tilde escapes
                    152: .Tp
                    153: .Pp
                    154: .Nm Tip
                    155: uses the file
                    156: .Pa /etc/remote
                    157: to find how to reach a particular
                    158: system and to find out how it should operate while talking
                    159: to the system;
                    160: refer to
                    161: .Xr remote  5
                    162: for a full description.
                    163: Each system has a default baud rate with which to
                    164: establish a connection.  If this value is not suitable, the baud rate
                    165: to be used may be specified on the command line, e.g. ``tip -300 mds''.
                    166: .Pp
                    167: When
                    168: .Nm tip
                    169: establishes a connection it sends out a
                    170: connection message to the remote system; the default value, if any,
                    171: is defined in
                    172: .Pa /etc/remote
                    173: (see
                    174: .Xr remote 5 ) .
                    175: .Pp
                    176: When
                    177: .Nm tip
                    178: prompts for an argument (e.g. during setup of
                    179: a file transfer) the line typed may be edited with the standard
                    180: erase and kill characters.  A null line in response to a prompt,
                    181: or an interrupt, will abort the dialogue and return you to the
                    182: remote machine.
                    183: .Pp
                    184: .Nm Tip
                    185: guards against multiple users connecting to a remote system
                    186: by opening modems and terminal lines with exclusive access,
                    187: and by honoring the locking protocol used by
                    188: .Xr uucp 1 .
                    189: .Pp
                    190: During file transfers
                    191: .Nm tip
                    192: provides a running count of the number of lines transferred.
                    193: When using the ~> and ~< commands, the ``eofread'' and ``eofwrite''
                    194: variables are used to recognize end-of-file when reading, and
                    195: specify end-of-file when writing (see below).  File transfers
                    196: normally depend on tandem mode for flow control.  If the remote
                    197: system does not support tandem mode, ``echocheck'' may be set
                    198: to indicate
                    199: .Nm tip
                    200: should synchronize with the remote system on the echo of each
                    201: transmitted character.
                    202: .Pp
                    203: When
                    204: .Nm tip
                    205: must dial a phone number to connect to a system it will print
                    206: various messages indicating its actions.
                    207: .Nm Tip
                    208: supports the DEC DN-11 and Racal-Vadic 831 auto-call-units;
                    209: the DEC DF02 and DF03, Ventel 212+, Racal-Vadic 3451, and
                    210: Bizcomp 1031 and 1032 integral call unit/modems.
                    211: .Ss VARIABLES
                    212: .Nm Tip
                    213: maintains a set of
                    214: .Ar variables
                    215: which control its operation.
                    216: Some of these variable are read-only to normal users (root is allowed
                    217: to change anything of interest).  Variables may be displayed
                    218: and set through the ``s'' escape.  The syntax for variables is patterned
                    219: after
                    220: .Xr vi  1
                    221: and
                    222: .Xr Mail  1  .
                    223: Supplying ``all''
                    224: as an argument to the set command displays all variables readable by
                    225: the user.  Alternatively, the user may request display of a particular
                    226: variable by attaching a `?' to the end.  For example ``escape?''
                    227: displays the current escape character.
                    228: .Pp
                    229: Variables are numeric, string, character, or boolean values.  Boolean
                    230: variables are set merely by specifying their name; they may be reset
                    231: by prepending a `!' to the name.  Other variable types are set by
                    232: concatenating an `=' and the value.  The entire assignment must not
                    233: have any blanks in it.  A single set command may be used to interrogate
                    234: as well as set a number of variables.
                    235: Variables may be initialized at run time by placing set commands
                    236: (without the ``~s'' prefix in a file
                    237: .Pa .tiprc
                    238: in one's home directory).  The
                    239: .Fl v
                    240: option causes
                    241: .Nm tip
                    242: to display the sets as they are made.
                    243: Certain common variables have abbreviations.
                    244: The following is a list of common variables,
                    245: their abbreviations, and their default values.
                    246: .Tw Ar
                    247: .Tp Ar beautify
                    248: (bool) Discard unprintable characters when a session is being scripted;
                    249: abbreviated
                    250: .Ar be  .
                    251: .Tp Ar baudrate
                    252: (num) The baud rate at which the connection was established;
                    253: abbreviated
                    254: .Ar ba  .
                    255: .Tp Ar dialtimeout
                    256: (num) When dialing a phone number, the time (in seconds)
                    257: to wait for a connection to be established; abbreviated
                    258: .Ar dial  .
                    259: .Tp Ar echocheck
                    260: (bool) Synchronize with the remote host during file transfer by
                    261: waiting for the echo of the last character transmitted; default is
                    262: .Ar off  .
                    263: .Tp Ar eofread
                    264: (str) The set of characters which signify and end-of-tranmission
                    265: during a ~< file transfer command; abbreviated
                    266: .Ar eofr  .
                    267: .Tp Ar eofwrite
                    268: (str) The string sent to indicate end-of-transmission during
                    269: a ~> file transfer command; abbreviated
                    270: .Ar eofw  .
                    271: .Tp Ar eol
                    272: (str) The set of characters which indicate an end-of-line.
                    273: .Nm Tip
                    274: will recognize escape characters only after an end-of-line.
                    275: .Tp Ar escape
                    276: (char) The command prefix (escape) character; abbreviated
                    277: .Ar es  ;
                    278: default value is `~'.
                    279: .Tp Ar exceptions
                    280: (str) The set of characters which should not be discarded
                    281: due to the beautification switch; abbreviated
                    282: .Ar ex  ;
                    283: default value is ``\et\en\ef\eb''.
                    284: .Tp Ar force
                    285: (char) The character used to force literal data transmission;
                    286: abbreviated
                    287: .Ar fo  ;
                    288: default value is `^P'.
                    289: .Tp Ar framesize
                    290: (num) The amount of data (in bytes) to buffer between file system
                    291: writes when receiving files; abbreviated
                    292: .Ar fr  .
                    293: .Tp Ar host
                    294: (str) The name of the host to which you are connected; abbreviated
                    295: .Ar ho  .
                    296: .Tp Ar prompt
                    297: (char) The character which indicates and end-of-line on the remote
                    298: host; abbreviated
                    299: .Ar pr  ;
                    300: default value is `\en'.  This value is used to synchronize during
                    301: data transfers.  The count of lines transferred during a file transfer
                    302: command is based on recipt of this character.
                    303: .Tp Ar raise
                    304: (bool) Upper case mapping mode; abbreviated
                    305: .Ar ra  ;
                    306: default value is
                    307: .Ar off  .
                    308: When this mode is enabled, all lower case letters will be mapped to
                    309: upper case by
                    310: .Nm tip
                    311: for transmission to the remote machine.
                    312: .Tp Ar raisechar
                    313: (char) The input character used to toggle upper case mapping mode;
                    314: abbreviated
                    315: .Ar rc  ;
                    316: default value is `^A'.
                    317: .Tp Ar record
                    318: (str) The name of the file in which a session script is recorded;
                    319: abbreviated
                    320: .Ar rec  ;
                    321: default value is ``tip.record''.
                    322: .Tp Ar script
                    323: (bool) Session scripting mode; abbreviated
                    324: .Ar sc  ;
                    325: default is
                    326: .Ar off  .
                    327: When
                    328: .Ar script
                    329: is
                    330: .Li true  ,
                    331: .Nm tip
                    332: will record everything transmitted by the remote machine in
                    333: the script record file specified in
                    334: .Ar record  .
                    335: If the
                    336: .Ar beautify
                    337: switch is on, only printable ASCII characters will be included in
                    338: the script file (those characters betwee 040 and 0177).  The
                    339: variable
                    340: .Ar exceptions
                    341: is used to indicate characters which are an exception to the normal
                    342: beautification rules.
                    343: .Tp Ar tabexpand
                    344: (bool) Expand tabs to spaces during file transfers; abbreviated
                    345: .Ar tab  ;
                    346: default value is
                    347: .Ar false  .
                    348: Each tab is expanded to 8 spaces.
                    349: .Tp Ar verbose
                    350: (bool) Verbose mode; abbreviated
                    351: .Ar verb  ;
                    352: default is
                    353: .Ar true  .
                    354: When verbose mode is enabled,
                    355: .Nm tip
                    356: prints messages while dialing, shows the current number
                    357: of lines transferred during a file transfer operations,
                    358: and more.
                    359: .Tp
                    360: .Sh ENVIRONMENT
                    361: .Nm Tip
                    362: uses the following environment variables:
                    363: .Tw Fl
                    364: .Tp Ev SHELL
                    365: (str) The name of the shell to use for the ~! command; default
                    366: value is ``/bin/sh'', or taken from the environment.
                    367: .Tp Ev HOME
                    368: (str) The home directory to use for the ~c command; default
                    369: value is taken from the environment.
                    370: .Tp Ev HOST
                    371: Check for a default host if none specified.
                    372: .Tp
                    373: .Pp
                    374: The variables
                    375: .Ev ${REMOTE}
                    376: and
                    377: .Ev ${PHONES}
                    378: are also exported.
                    379: .Sh FILES
                    380: .Dw /var/spool/uucp/LCK..*
                    381: .Di L
                    382: .Dp Pa /etc/remote
                    383: global system descriptions
                    384: .Dp Pa /etc/phones
                    385: global phone number data base
                    386: .Dp ${REMOTE}
                    387: private system descriptions
                    388: .Dp ${PHONES}
                    389: private phone numbers
                    390: .Dp ~/.tiprc
                    391: initialization file.
                    392: .Dp Pa tip.record
                    393: record file
                    394: .Dp /var/log/aculog
                    395: line access log
                    396: .Dp Pa /var/spool/uucp/LCK..*
                    397: lock file to avoid conflicts with
                    398: .Xr uucp
                    399: .Dp
                    400: .Sh DIAGNOSTICS
                    401: Diagnostics are, hopefully, self explanatory.
                    402: .Sh SEE ALSO
                    403: .Xr remote 5 ,
                    404: .Xr phones 5
                    405: .Sh HISTORY
                    406: .Nm Tip
                    407: appeared in 4.2 BSD.
                    408: .Sh BUGS
                    409: The full set of variables is undocumented and should, probably, be
                    410: paired down.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.