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 $
40 .Nd connect to a remote system
53 command establishes a full-duplex connection to another machine,
54 giving the appearance of being logged in directly on the
55 remote cpu. It goes without saying that you must have a login
56 on the machine (or equivalent) to which you wish to connect.
59 .Bl -tag -width indent
64 Typed characters are normally transmitted directly to the remote
65 machine (which does the echoing as well). A tilde (`~') appearing
66 as the first character of a line is an escape signal; the following
69 .It Ic \&~^D No or Ic \&~ .
70 Drop the connection and exit
71 (you may still be logged in on the
73 .It Ic \&~c Op Ar name
77 implies change to your home directory).
79 Escape to a shell (exiting the shell will
82 Copy file from local to remote.
85 utility prompts for the name of a local file to transmit.
87 Copy file from remote to local.
90 utility prompts first for the name of the file to be sent, then for
91 a command to be executed on the remote machine.
92 .It Ic \&~p Ar from Op Ar to
93 Send a file to a remote
95 host. The put command causes the remote
97 system to run the command string ``cat > 'to''', while
100 file. If the ``to'' file isn't specified the ``from'' file name is used.
101 This command is actually a
103 specific version of the ``~>'' command.
104 .It Ic \&~t Ar from Op Ar to
105 Take a file from a remote
108 As in the put command the ``to'' file
109 defaults to the ``from'' file name if it isn't specified.
111 executes the command string ``cat 'from';echo ^A'' to send the file to
114 Pipe the output from a remote command to a local
117 The command string sent to the local
119 system is processed by the shell.
121 Pipe the output from a local
123 process to the remote host.
124 The command string sent to the local
126 system is processed by the shell.
128 Fork a child process on the local system to perform special protocols
129 such as \s-1XMODEM\s+1. The child program will be run with the following
130 somewhat unusual arrangement of file descriptors:
131 .Bd -literal -offset indent -compact
141 to the remote system.
142 For systems which don't support the
145 call the break is simulated by a sequence of line speed changes
150 Set a variable (see the discussion below).
154 (only available with job control).
156 Stop only the ``local side'' of
158 (only available with job control);
159 the ``remote side'' of
161 the side that displays output from the remote host, is left running.
163 Get a summary of the tilde escapes
168 utility uses the file
170 to find how to reach a particular
171 system and to find out how it should operate while talking
175 for a full description.
176 Each system has a default baud rate with which to
177 establish a connection. If this value is not suitable, the baud rate
178 to be used may be specified on the command line, e.g.\&
183 establishes a connection it sends out a
184 connection message to the remote system; the default value, if any,
192 prompts for an argument (e.g. during setup of
193 a file transfer) the line typed may be edited with the standard
194 erase and kill characters. A null line in response to a prompt,
195 or an interrupt, will abort the dialogue and return you to the
200 utility guards against multiple users connecting to a remote system
201 by opening modems and terminal lines with exclusive access,
202 and by honoring the locking protocol used by
205 During file transfers
207 provides a running count of the number of lines transferred.
208 When using the ~> and ~< commands, the ``eofread'' and ``eofwrite''
209 variables are used to recognize end-of-file when reading, and
210 specify end-of-file when writing (see below). File transfers
211 normally depend on tandem mode for flow control. If the remote
212 system does not support tandem mode, ``echocheck'' may be set
215 should synchronize with the remote system on the echo of each
216 transmitted character.
220 must dial a phone number to connect to a system it will print
221 various messages indicating its actions.
224 utility supports modems that use the AT command set.
227 utility uses the file
229 to find out how to operate with a particular
232 for a full description.
236 utility maintains a set of
238 which control its operation.
239 Some of these variables are read-only to normal users (root is allowed
240 to change anything of interest). Variables may be displayed
241 and set through the ``s'' escape. The syntax for variables is patterned
247 as an argument to the set command displays all variables readable by
248 the user. Alternatively, the user may request display of a particular
249 variable by attaching a `?' to the end. For example ``escape?''
250 displays the current escape character.
252 Variables are numeric, string, character, or boolean values. Boolean
253 variables are set merely by specifying their name; they may be reset
254 by prepending a `!' to the name. Other variable types are set by
255 concatenating an `=' and the value. The entire assignment must not
256 have any blanks in it. A single set command may be used to interrogate
257 as well as set a number of variables.
258 Variables may be initialized at run time by placing set commands
259 (without the ``~s'' prefix in a file
261 in one's home directory). The
265 to display the sets as they are made.
266 Certain common variables have abbreviations.
267 The following is a list of common variables,
268 their abbreviations, and their default values.
271 (bool) Discard unprintable characters when a session is being scripted;
275 (num) The baud rate at which the connection was established;
279 (num) Number of milliseconds to delay after the transmission of
284 (num) When dialing a phone number, the time (in seconds)
285 to wait for a connection to be established; abbreviated
288 (bool) Synchronize with the remote host during file transfer by
289 waiting for the echo of the last character transmitted; default is
292 (str) The set of characters which signify an end-of-transmission
293 during a ~< file transfer command; abbreviated
296 (str) The string sent to indicate end-of-transmission during
297 a ~> file transfer command; abbreviated
300 (str) The set of characters which indicate an end-of-line.
303 utility will recognize escape characters only after an end-of-line.
305 (char) The command prefix (escape) character; abbreviated
307 default value is `~'.
309 (str) The set of characters which should not be discarded
310 due to the beautification switch; abbreviated
312 default value is ``\et\en\ef\eb''.
314 (char) The character used to force literal data transmission;
317 default value is `^P'.
319 (num) The amount of data (in bytes) to buffer between file system
320 writes when receiving files; abbreviated
323 (str) The name of the host to which you are connected; abbreviated
326 (num) Number of milliseconds to delay after the transmission of
331 (str) Pathname of a login shell script to run once connected; standard input
332 and output are redirected to the remote host.
333 Leading tildes in the pathname
334 are expanded expansion; abbreviated
337 (str) Pathname of a shell script to run before disconnecting; standard input
338 and output are redirected to the remote host.
339 Leading tildes in the pathname
340 are expanded expansion; abbreviated
343 (char) The character which indicates an end-of-line on the remote
346 default value is `\en'. This value is used to synchronize during
347 data transfers. The count of lines transferred during a file transfer
348 command is based on receipt of this character.
350 (bool) Upper case mapping mode; abbreviated
354 When this mode is enabled, all lower case letters will be mapped to
357 for transmission to the remote machine.
359 (char) The input character used to toggle upper case mapping mode;
362 default value is `^A'.
364 (str) The name of the file in which a session script is recorded;
367 default value is ``tip.record''.
369 (bool) Session scripting mode; abbreviated
378 will record everything transmitted by the remote machine in
379 the script record file specified in
383 switch is on, only printable
385 characters will be included in
386 the script file (those characters between 040 and 0177). The
389 is used to indicate characters which are an exception to the normal
390 beautification rules.
392 (bool) Expand tabs to spaces during file transfers; abbreviated
396 Each tab is expanded to 8 spaces.
398 (bool) Verbose mode; abbreviated
402 When verbose mode is enabled,
404 prints messages while dialing, shows the current number
405 of lines transferred during a file transfer operations,
411 utility uses the following environment variables:
414 (str) The name of the shell to use for the ~! command; default
415 value is ``/bin/sh'', or taken from the environment.
417 (str) The home directory to use for the ~c command; default
418 value is taken from the environment.
420 Check for a default host if none specified.
429 .Bl -tag -width /var/spool/lock/LCK..* -compact
431 Global modem configuration data base.
433 Global system descriptions.
435 Global phone number data base.
437 Private system descriptions.
439 Private phone numbers.
444 .It Pa /var/log/aculog
446 .It Pa /var/spool/lock/LCK..*
447 Lock file to avoid conflicts with
451 Diagnostics are, hopefully, self explanatory.
462 The full set of variables is undocumented and should, probably, be