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.2 2003/06/17 04:29:32 dillon Exp $
41 .Nd connect to a remote system
54 command establishes a full-duplex connection to another machine,
55 giving the appearance of being logged in directly on the
56 remote cpu. It goes without saying that you must have a login
57 on the machine (or equivalent) to which you wish to connect.
60 .Bl -tag -width indent
65 Typed characters are normally transmitted directly to the remote
66 machine (which does the echoing as well). A tilde (`~') appearing
67 as the first character of a line is an escape signal; the following
70 .It Ic \&~^D No or Ic \&~ .
71 Drop the connection and exit
72 (you may still be logged in on the
74 .It Ic \&~c Op Ar name
78 implies change to your home directory).
80 Escape to a shell (exiting the shell will
83 Copy file from local to remote.
86 utility prompts for the name of a local file to transmit.
88 Copy file from remote to local.
91 utility prompts first for the name of the file to be sent, then for
92 a command to be executed on the remote machine.
93 .It Ic \&~p Ar from Op Ar to
94 Send a file to a remote
96 host. The put command causes the remote
98 system to run the command string ``cat > 'to''', while
100 sends it the ``from''
101 file. If the ``to'' file isn't specified the ``from'' file name is used.
102 This command is actually a
104 specific version of the ``~>'' command.
105 .It Ic \&~t Ar from Op Ar to
106 Take a file from a remote
109 As in the put command the ``to'' file
110 defaults to the ``from'' file name if it isn't specified.
112 executes the command string ``cat 'from';echo ^A'' to send the file to
115 Pipe the output from a remote command to a local
118 The command string sent to the local
120 system is processed by the shell.
122 Pipe the output from a local
124 process to the remote host.
125 The command string sent to the local
127 system is processed by the shell.
129 Fork a child process on the local system to perform special protocols
130 such as \s-1XMODEM\s+1. The child program will be run with the following
131 somewhat unusual arrangement of file descriptors:
132 .Bd -literal -offset indent -compact
142 to the remote system.
143 For systems which don't support the
146 call the break is simulated by a sequence of line speed changes
151 Set a variable (see the discussion below).
155 (only available with job control).
157 Stop only the ``local side'' of
159 (only available with job control);
160 the ``remote side'' of
162 the side that displays output from the remote host, is left running.
164 Get a summary of the tilde escapes
169 utility uses the file
171 to find how to reach a particular
172 system and to find out how it should operate while talking
176 for a full description.
177 Each system has a default baud rate with which to
178 establish a connection. If this value is not suitable, the baud rate
179 to be used may be specified on the command line, e.g.\&
184 establishes a connection it sends out a
185 connection message to the remote system; the default value, if any,
193 prompts for an argument (e.g. during setup of
194 a file transfer) the line typed may be edited with the standard
195 erase and kill characters. A null line in response to a prompt,
196 or an interrupt, will abort the dialogue and return you to the
201 utility guards against multiple users connecting to a remote system
202 by opening modems and terminal lines with exclusive access,
203 and by honoring the locking protocol used by
206 During file transfers
208 provides a running count of the number of lines transferred.
209 When using the ~> and ~< commands, the ``eofread'' and ``eofwrite''
210 variables are used to recognize end-of-file when reading, and
211 specify end-of-file when writing (see below). File transfers
212 normally depend on tandem mode for flow control. If the remote
213 system does not support tandem mode, ``echocheck'' may be set
216 should synchronize with the remote system on the echo of each
217 transmitted character.
221 must dial a phone number to connect to a system it will print
222 various messages indicating its actions.
225 utility supports modems that use the AT command set.
228 utility uses the file
230 to find out how to operate with a particular
233 for a full description.
237 utility maintains a set of
239 which control its operation.
240 Some of these variables are read-only to normal users (root is allowed
241 to change anything of interest). Variables may be displayed
242 and set through the ``s'' escape. The syntax for variables is patterned
248 as an argument to the set command displays all variables readable by
249 the user. Alternatively, the user may request display of a particular
250 variable by attaching a `?' to the end. For example ``escape?''
251 displays the current escape character.
253 Variables are numeric, string, character, or boolean values. Boolean
254 variables are set merely by specifying their name; they may be reset
255 by prepending a `!' to the name. Other variable types are set by
256 concatenating an `=' and the value. The entire assignment must not
257 have any blanks in it. A single set command may be used to interrogate
258 as well as set a number of variables.
259 Variables may be initialized at run time by placing set commands
260 (without the ``~s'' prefix in a file
262 in one's home directory). The
266 to display the sets as they are made.
267 Certain common variables have abbreviations.
268 The following is a list of common variables,
269 their abbreviations, and their default values.
272 (bool) Discard unprintable characters when a session is being scripted;
276 (num) The baud rate at which the connection was established;
280 (num) Number of milliseconds to delay after the transmission of
285 (num) When dialing a phone number, the time (in seconds)
286 to wait for a connection to be established; abbreviated
289 (bool) Synchronize with the remote host during file transfer by
290 waiting for the echo of the last character transmitted; default is
293 (str) The set of characters which signify an end-of-transmission
294 during a ~< file transfer command; abbreviated
297 (str) The string sent to indicate end-of-transmission during
298 a ~> file transfer command; abbreviated
301 (str) The set of characters which indicate an end-of-line.
304 utility will recognize escape characters only after an end-of-line.
306 (char) The command prefix (escape) character; abbreviated
308 default value is `~'.
310 (str) The set of characters which should not be discarded
311 due to the beautification switch; abbreviated
313 default value is ``\et\en\ef\eb''.
315 (char) The character used to force literal data transmission;
318 default value is `^P'.
320 (num) The amount of data (in bytes) to buffer between file system
321 writes when receiving files; abbreviated
324 (str) The name of the host to which you are connected; abbreviated
327 (num) Number of milliseconds to delay after the transmission of
332 (str) Pathname of a login shell script to run once connected; standard input
333 and output are redirected to the remote host.
334 Leading tildes in the pathname
335 are expanded expansion; abbreviated
338 (str) Pathname of a shell script to run before disconnecting; standard input
339 and output are redirected to the remote host.
340 Leading tildes in the pathname
341 are expanded expansion; abbreviated
344 (char) The character which indicates an end-of-line on the remote
347 default value is `\en'. This value is used to synchronize during
348 data transfers. The count of lines transferred during a file transfer
349 command is based on receipt of this character.
351 (bool) Upper case mapping mode; abbreviated
355 When this mode is enabled, all lower case letters will be mapped to
358 for transmission to the remote machine.
360 (char) The input character used to toggle upper case mapping mode;
363 default value is `^A'.
365 (str) The name of the file in which a session script is recorded;
368 default value is ``tip.record''.
370 (bool) Session scripting mode; abbreviated
379 will record everything transmitted by the remote machine in
380 the script record file specified in
384 switch is on, only printable
386 characters will be included in
387 the script file (those characters between 040 and 0177). The
390 is used to indicate characters which are an exception to the normal
391 beautification rules.
393 (bool) Expand tabs to spaces during file transfers; abbreviated
397 Each tab is expanded to 8 spaces.
399 (bool) Verbose mode; abbreviated
403 When verbose mode is enabled,
405 prints messages while dialing, shows the current number
406 of lines transferred during a file transfer operations,
412 utility uses the following environment variables:
415 (str) The name of the shell to use for the ~! command; default
416 value is ``/bin/sh'', or taken from the environment.
418 (str) The home directory to use for the ~c command; default
419 value is taken from the environment.
421 Check for a default host if none specified.
430 .Bl -tag -width /var/spool/lock/LCK..* -compact
432 Global modem configuration data base.
434 Global system descriptions.
436 Global phone number data base.
438 Private system descriptions.
440 Private phone numbers.
445 .It Pa /var/log/aculog
447 .It Pa /var/spool/lock/LCK..*
448 Lock file to avoid conflicts with
452 Diagnostics are, hopefully, self explanatory.
463 The full set of variables is undocumented and should, probably, be