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. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)tip.1 8.4 (Berkeley) 4/18/94
33 .\" $FreeBSD: src/usr.bin/tip/tip/tip.1,v 1.7.2.7 2002/06/21 15:29:35 charnier Exp $
34 .\" $DragonFly: src/usr.bin/tip/tip/tip.1,v 1.3 2004/11/08 16:11:05 dillon Exp $
42 .Nd connect to a remote system
64 commands establish a full-duplex connection to another machine,
65 giving the appearance of being logged in directly on the
66 remote cpu. It goes without saying that you must have a login
67 on the machine (or equivalent) to which you wish to connect.
68 The preferred interface is
72 interface is included for those people attached to the
80 The options are as follows:
81 .Bl -tag -width indent
85 set the speed of the connection.
92 specify the line to use.
93 Either of the forms like
102 Typed characters are normally transmitted directly to the remote
103 machine (which does the echoing as well). A tilde (`~') appearing
104 as the first character of a line is an escape signal; the following
107 .It Ic \&~^D No or Ic \&~ .
108 Drop the connection and exit
109 (you may still be logged in on the
111 .It Ic \&~c Op Ar name
115 implies change to your home directory).
117 Escape to a shell (exiting the shell will
120 Copy file from local to remote.
123 utility prompts for the name of a local file to transmit.
125 Copy file from remote to local.
128 utility prompts first for the name of the file to be sent, then for
129 a command to be executed on the remote machine.
130 .It Ic \&~p Ar from Op Ar to
131 Send a file to a remote
133 host. The put command causes the remote
135 system to run the command string ``cat > 'to''', while
137 sends it the ``from''
138 file. If the ``to'' file isn't specified the ``from'' file name is used.
139 This command is actually a
141 specific version of the ``~>'' command.
142 .It Ic \&~t Ar from Op Ar to
143 Take a file from a remote
146 As in the put command the ``to'' file
147 defaults to the ``from'' file name if it isn't specified.
149 executes the command string ``cat 'from';echo ^A'' to send the file to
152 Pipe the output from a remote command to a local
155 The command string sent to the local
157 system is processed by the shell.
159 Pipe the output from a local
161 process to the remote host.
162 The command string sent to the local
164 system is processed by the shell.
166 Fork a child process on the local system to perform special protocols
167 such as \s-1XMODEM\s+1. The child program will be run with the following
168 somewhat unusual arrangement of file descriptors:
169 .Bd -literal -offset indent -compact
179 to the remote system.
180 For systems which don't support the
183 call the break is simulated by a sequence of line speed changes
188 Set a variable (see the discussion below).
192 (only available with job control).
194 Stop only the ``local side'' of
196 (only available with job control);
197 the ``remote side'' of
199 the side that displays output from the remote host, is left running.
201 Get a summary of the tilde escapes
206 utility uses the file
208 to find how to reach a particular
209 system and to find out how it should operate while talking
213 for a full description.
214 Each system has a default baud rate with which to
215 establish a connection. If this value is not suitable, the baud rate
216 to be used may be specified on the command line, e.g.\&
221 establishes a connection it sends out a
222 connection message to the remote system; the default value, if any,
230 prompts for an argument (e.g. during setup of
231 a file transfer) the line typed may be edited with the standard
232 erase and kill characters. A null line in response to a prompt,
233 or an interrupt, will abort the dialogue and return you to the
238 utility guards against multiple users connecting to a remote system
239 by opening modems and terminal lines with exclusive access,
240 and by honoring the locking protocol used by
243 During file transfers
245 provides a running count of the number of lines transferred.
246 When using the ~> and ~< commands, the ``eofread'' and ``eofwrite''
247 variables are used to recognize end-of-file when reading, and
248 specify end-of-file when writing (see below). File transfers
249 normally depend on tandem mode for flow control. If the remote
250 system does not support tandem mode, ``echocheck'' may be set
253 should synchronize with the remote system on the echo of each
254 transmitted character.
258 must dial a phone number to connect to a system it will print
259 various messages indicating its actions.
262 utility supports modems that use the AT command set.
265 utility uses the file
267 to find out how to operate with a particular
270 for a full description.
274 utility maintains a set of
276 which control its operation.
277 Some of these variables are read-only to normal users (root is allowed
278 to change anything of interest). Variables may be displayed
279 and set through the ``s'' escape. The syntax for variables is patterned
285 as an argument to the set command displays all variables readable by
286 the user. Alternatively, the user may request display of a particular
287 variable by attaching a `?' to the end. For example ``escape?''
288 displays the current escape character.
290 Variables are numeric, string, character, or boolean values. Boolean
291 variables are set merely by specifying their name; they may be reset
292 by prepending a `!' to the name. Other variable types are set by
293 concatenating an `=' and the value. The entire assignment must not
294 have any blanks in it. A single set command may be used to interrogate
295 as well as set a number of variables.
296 Variables may be initialized at run time by placing set commands
297 (without the ``~s'' prefix in a file
299 in one's home directory). The
303 to display the sets as they are made.
304 Certain common variables have abbreviations.
305 The following is a list of common variables,
306 their abbreviations, and their default values.
309 (bool) Discard unprintable characters when a session is being scripted;
313 (num) The baud rate at which the connection was established;
317 (num) Number of milliseconds to delay after the transmission of
322 (num) When dialing a phone number, the time (in seconds)
323 to wait for a connection to be established; abbreviated
326 (bool) Synchronize with the remote host during file transfer by
327 waiting for the echo of the last character transmitted; default is
330 (str) The set of characters which signify an end-of-transmission
331 during a ~< file transfer command; abbreviated
334 (str) The string sent to indicate end-of-transmission during
335 a ~> file transfer command; abbreviated
338 (str) The set of characters which indicate an end-of-line.
341 utility will recognize escape characters only after an end-of-line.
343 (char) The command prefix (escape) character; abbreviated
345 default value is `~'.
347 (str) The set of characters which should not be discarded
348 due to the beautification switch; abbreviated
350 default value is ``\et\en\ef\eb''.
352 (char) The character used to force literal data transmission;
355 default value is `^P'.
357 (num) The amount of data (in bytes) to buffer between file system
358 writes when receiving files; abbreviated
361 (str) The name of the host to which you are connected; abbreviated
364 (num) Number of milliseconds to delay after the transmission of
369 (str) Pathname of a login shell script to run once connected; standard input
370 and output are redirected to the remote host.
371 Leading tildes in the pathname
372 are expanded expansion; abbreviated
375 (str) Pathname of a shell script to run before disconnecting; standard input
376 and output are redirected to the remote host.
377 Leading tildes in the pathname
378 are expanded expansion; abbreviated
381 (char) The character which indicates an end-of-line on the remote
384 default value is `\en'. This value is used to synchronize during
385 data transfers. The count of lines transferred during a file transfer
386 command is based on receipt of this character.
388 (bool) Upper case mapping mode; abbreviated
392 When this mode is enabled, all lower case letters will be mapped to
395 for transmission to the remote machine.
397 (char) The input character used to toggle upper case mapping mode;
400 default value is `^A'.
402 (str) The name of the file in which a session script is recorded;
405 default value is ``tip.record''.
407 (bool) Session scripting mode; abbreviated
416 will record everything transmitted by the remote machine in
417 the script record file specified in
421 switch is on, only printable
423 characters will be included in
424 the script file (those characters between 040 and 0177). The
427 is used to indicate characters which are an exception to the normal
428 beautification rules.
430 (bool) Expand tabs to spaces during file transfers; abbreviated
434 Each tab is expanded to 8 spaces.
436 (bool) Verbose mode; abbreviated
440 When verbose mode is enabled,
442 prints messages while dialing, shows the current number
443 of lines transferred during a file transfer operations,
449 utility uses the following environment variables:
452 (str) The name of the shell to use for the ~! command; default
453 value is ``/bin/sh'', or taken from the environment.
455 (str) The home directory to use for the ~c command; default
456 value is taken from the environment.
458 Check for a default host if none specified.
467 .Bl -tag -width /var/spool/lock/LCK..* -compact
469 Global modem configuration data base.
471 Global system descriptions.
473 Global phone number data base.
475 Private system descriptions.
477 Private phone numbers.
482 .It Pa /var/log/aculog
484 .It Pa /var/spool/lock/LCK..*
485 Lock file to avoid conflicts with
489 Diagnostics are, hopefully, self explanatory.
499 The full set of variables is undocumented and should, probably, be