1 .\" Copyright (c) 1980, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)tip.1 8.4 (Berkeley) 4/18/94
29 .\" $FreeBSD: src/usr.bin/tip/tip/tip.1,v 1.7.2.7 2002/06/21 15:29:35 charnier Exp $
30 .\" $DragonFly: src/usr.bin/tip/tip/tip.1,v 1.3 2004/11/08 16:11:05 dillon Exp $
38 .Nd connect to a remote system
60 commands establish a full-duplex connection to another machine,
61 giving the appearance of being logged in directly on the
62 remote cpu. It goes without saying that you must have a login
63 on the machine (or equivalent) to which you wish to connect.
64 The preferred interface is
68 interface is included for those people attached to the
76 The options are as follows:
77 .Bl -tag -width indent
81 set the speed of the connection.
88 specify the line to use.
89 Either of the forms like
98 Typed characters are normally transmitted directly to the remote
99 machine (which does the echoing as well). A tilde (`~') appearing
100 as the first character of a line is an escape signal; the following
103 .It Ic \&~^D No or Ic \&~ .
104 Drop the connection and exit
105 (you may still be logged in on the
107 .It Ic \&~c Op Ar name
111 implies change to your home directory).
113 Escape to a shell (exiting the shell will
116 Copy file from local to remote.
119 utility prompts for the name of a local file to transmit.
121 Copy file from remote to local.
124 utility prompts first for the name of the file to be sent, then for
125 a command to be executed on the remote machine.
126 .It Ic \&~p Ar from Op Ar to
127 Send a file to a remote
129 host. The put command causes the remote
131 system to run the command string ``cat > 'to''', while
133 sends it the ``from''
134 file. If the ``to'' file isn't specified the ``from'' file name is used.
135 This command is actually a
137 specific version of the ``~>'' command.
138 .It Ic \&~t Ar from Op Ar to
139 Take a file from a remote
142 As in the put command the ``to'' file
143 defaults to the ``from'' file name if it isn't specified.
145 executes the command string ``cat 'from';echo ^A'' to send the file to
148 Pipe the output from a remote command to a local
151 The command string sent to the local
153 system is processed by the shell.
155 Pipe the output from a local
157 process to the remote host.
158 The command string sent to the local
160 system is processed by the shell.
162 Fork a child process on the local system to perform special protocols
163 such as \s-1XMODEM\s+1. The child program will be run with the following
164 somewhat unusual arrangement of file descriptors:
165 .Bd -literal -offset indent -compact
175 to the remote system.
176 For systems which don't support the
179 call the break is simulated by a sequence of line speed changes
184 Set a variable (see the discussion below).
188 (only available with job control).
190 Stop only the ``local side'' of
192 (only available with job control);
193 the ``remote side'' of
195 the side that displays output from the remote host, is left running.
197 Get a summary of the tilde escapes
202 utility uses the file
204 to find how to reach a particular
205 system and to find out how it should operate while talking
209 for a full description.
210 Each system has a default baud rate with which to
211 establish a connection. If this value is not suitable, the baud rate
212 to be used may be specified on the command line, e.g.\&
217 establishes a connection it sends out a
218 connection message to the remote system; the default value, if any,
226 prompts for an argument (e.g. during setup of
227 a file transfer) the line typed may be edited with the standard
228 erase and kill characters. A null line in response to a prompt,
229 or an interrupt, will abort the dialogue and return you to the
234 utility guards against multiple users connecting to a remote system
235 by opening modems and terminal lines with exclusive access,
236 and by honoring the locking protocol used by
239 During file transfers
241 provides a running count of the number of lines transferred.
242 When using the ~> and ~< commands, the ``eofread'' and ``eofwrite''
243 variables are used to recognize end-of-file when reading, and
244 specify end-of-file when writing (see below). File transfers
245 normally depend on tandem mode for flow control. If the remote
246 system does not support tandem mode, ``echocheck'' may be set
249 should synchronize with the remote system on the echo of each
250 transmitted character.
254 must dial a phone number to connect to a system it will print
255 various messages indicating its actions.
258 utility supports modems that use the AT command set.
261 utility uses the file
263 to find out how to operate with a particular
266 for a full description.
270 utility maintains a set of
272 which control its operation.
273 Some of these variables are read-only to normal users (root is allowed
274 to change anything of interest). Variables may be displayed
275 and set through the ``s'' escape. The syntax for variables is patterned
281 as an argument to the set command displays all variables readable by
282 the user. Alternatively, the user may request display of a particular
283 variable by attaching a `?' to the end. For example ``escape?''
284 displays the current escape character.
286 Variables are numeric, string, character, or boolean values. Boolean
287 variables are set merely by specifying their name; they may be reset
288 by prepending a `!' to the name. Other variable types are set by
289 concatenating an `=' and the value. The entire assignment must not
290 have any blanks in it. A single set command may be used to interrogate
291 as well as set a number of variables.
292 Variables may be initialized at run time by placing set commands
293 (without the ``~s'' prefix in a file
295 in one's home directory). The
299 to display the sets as they are made.
300 Certain common variables have abbreviations.
301 The following is a list of common variables,
302 their abbreviations, and their default values.
305 (bool) Discard unprintable characters when a session is being scripted;
309 (num) The baud rate at which the connection was established;
313 (num) Number of milliseconds to delay after the transmission of
318 (num) When dialing a phone number, the time (in seconds)
319 to wait for a connection to be established; abbreviated
322 (bool) Synchronize with the remote host during file transfer by
323 waiting for the echo of the last character transmitted; default is
326 (str) The set of characters which signify an end-of-transmission
327 during a ~< file transfer command; abbreviated
330 (str) The string sent to indicate end-of-transmission during
331 a ~> file transfer command; abbreviated
334 (str) The set of characters which indicate an end-of-line.
337 utility will recognize escape characters only after an end-of-line.
339 (char) The command prefix (escape) character; abbreviated
341 default value is `~'.
343 (str) The set of characters which should not be discarded
344 due to the beautification switch; abbreviated
346 default value is ``\et\en\ef\eb''.
348 (char) The character used to force literal data transmission;
351 default value is `^P'.
353 (num) The amount of data (in bytes) to buffer between file system
354 writes when receiving files; abbreviated
357 (str) The name of the host to which you are connected; abbreviated
360 (num) Number of milliseconds to delay after the transmission of
365 (str) Pathname of a login shell script to run once connected; standard input
366 and output are redirected to the remote host.
367 Leading tildes in the pathname
368 are expanded expansion; abbreviated
371 (str) Pathname of a shell script to run before disconnecting; standard input
372 and output are redirected to the remote host.
373 Leading tildes in the pathname
374 are expanded expansion; abbreviated
377 (char) The character which indicates an end-of-line on the remote
380 default value is `\en'. This value is used to synchronize during
381 data transfers. The count of lines transferred during a file transfer
382 command is based on receipt of this character.
384 (bool) Upper case mapping mode; abbreviated
388 When this mode is enabled, all lower case letters will be mapped to
391 for transmission to the remote machine.
393 (char) The input character used to toggle upper case mapping mode;
396 default value is `^A'.
398 (str) The name of the file in which a session script is recorded;
401 default value is ``tip.record''.
403 (bool) Session scripting mode; abbreviated
412 will record everything transmitted by the remote machine in
413 the script record file specified in
417 switch is on, only printable
419 characters will be included in
420 the script file (those characters between 040 and 0177). The
423 is used to indicate characters which are an exception to the normal
424 beautification rules.
426 (bool) Expand tabs to spaces during file transfers; abbreviated
430 Each tab is expanded to 8 spaces.
432 (bool) Verbose mode; abbreviated
436 When verbose mode is enabled,
438 prints messages while dialing, shows the current number
439 of lines transferred during a file transfer operations,
445 utility uses the following environment variables:
448 (str) The name of the shell to use for the ~! command; default
449 value is ``/bin/sh'', or taken from the environment.
451 (str) The home directory to use for the ~c command; default
452 value is taken from the environment.
454 Check for a default host if none specified.
463 .Bl -tag -width /var/spool/lock/LCK..* -compact
465 Global modem configuration data base.
467 Global system descriptions.
469 Global phone number data base.
471 Private system descriptions.
473 Private phone numbers.
478 .It Pa /var/log/aculog
480 .It Pa /var/spool/lock/LCK..*
481 Lock file to avoid conflicts with
485 Diagnostics are, hopefully, self explanatory.
495 The full set of variables is undocumented and should, probably, be