1 .\" $OpenBSD: cu.1,v 1.3 2006/06/07 06:35:59 mbalmer Exp $
3 .\" Copyright (c) 1980, 1990, 1993
4 .\" The Regents of the University of California. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" @(#)tip.1 8.4 (Berkeley) 4/18/94
44 .Op Fl s Ar speed | Fl Ar speed
50 establishes a full-duplex connection to another machine, giving the
51 appearance of being logged in directly on the remote CPU.
52 It goes without saying that you must have a login on the machine (or
53 equivalent) to which you wish to connect.
55 The options are as follows:
56 .Bl -tag -width indent
65 are given, then no parity is used
68 Echo characters locally (half-duplex mode).
70 Specify the line to use.
71 Either of the forms like
82 are given, then no parity is used
84 .It Fl s Ar speed | Fl Ar speed
85 Set the speed of the connection.
88 Connect via a hard-wired connection to a host on a dial-up line.
91 Typed characters are normally transmitted directly to the remote
92 machine (which does the echoing as well).
95 appearing as the first character of a line is an escape signal; the
96 following are recognized:
97 .Bl -tag -width indent
98 .It Ic ~^D No or Ic ~.
99 Drop the connection and exit.
100 Only the connection is dropped \(en the login session is not terminated.
104 (no argument implies change to home directory).
106 Escape to a shell (exiting the shell will return to
109 Copy file from local to remote.
113 prompts for the name of a local file to transmit.
115 Copy file from remote to local.
119 prompts first for the name of the file to be sent, then for a command
120 to be executed on the remote machine.
121 .It Ic ~p Ar from Op Ar to
122 Send a file to a remote
125 This command causes the remote
127 system to run the following command string,
132 .Dl "stty -echo; cat > 'to'; stty echo"
136 file is not specified, the
139 This command is actually a
141 specific version of the
144 .It Ic ~t Ar from Op Ar to
145 Take a file from a remote
154 file name if it is not specified.
155 The remote host executes the following command string
159 .Dl "cat 'from'; echo '' | tr '\e012' '\e01'"
161 Pipe the output from a remote command to a local
164 The command string sent to the local
166 system is processed by the shell.
168 Pipe the output from a local
170 process to the remote host.
171 The command string sent to the local
173 system is processed by the shell.
175 Fork a child process on the local system to perform special protocols
178 The child program will be run with the following arrangement of
180 .Bd -literal -offset indent
183 2 <-> local tty stderr
188 to the remote system.
189 For systems which do not support the necessary
191 call, the break is simulated by a sequence of line speed changes and
195 Set a variable (see the discussion below).
197 List all variables and their values (if set).
201 (only available with job control).
207 (only available with job control); the
211 the side that displays output from the remote host, is left running.
213 Get a summary of the tilde escapes.
218 prompts for an argument, for example during setup of a file transfer, the
219 line typed may be edited with the standard erase and kill characters.
220 A null line in response to a prompt, or an interrupt, will abort the
221 dialogue and return the user to the remote machine.
226 guards against multiple users connecting to a remote system by opening
227 modems and terminal lines with exclusive access, and by honoring the
228 locking protocol used by
229 .Xr uucico 8 Pq Pa ports/net/freebsd-uucp .
231 During file transfers
233 provides a running count of the number of lines transferred.
242 variables are used to recognize end-of-file when reading, and specify
243 end-of-file when writing (see below).
244 File transfers normally depend on hardwareflow or tandem mode for flow control.
245 If the remote system does not support hardwareflow or tandem mode,
247 may be set to indicate that
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 various
255 messages indicating its actions.
259 supports a variety of auto-call units and modems with the
261 capability in system descriptions.
263 Support for Ventel 212+ (ventel), Hayes AT-style (hayes),
264 USRobotics Courier (courier), Telebit T3000 (t3000) and
265 Racal-Vadic 831 (vadic) units is enabled by default.
267 Support for Bizcomp 1031[fw] (biz31[fw]), Bizcomp 1022[fw]
268 (biz22[fw]), DEC DF0[23]-AC (df0[23]), DEC DN-11 (dn11) and
269 Racal-Vadic 3451 (v3451) units can be added by recompiling
271 with the appropriate defines.
273 Note that if support for both the Racal-Vadic 831 and 3451 is enabled,
274 they are referred to as the v831 and v3451, respectively.
275 If only one of the two is supported, it is referred to as vadic.
280 maintains a set of variables which control its operation.
281 Some of these variables are read-only to normal users (root is allowed
282 to change anything of interest).
283 Variables may be displayed and set through the
286 The syntax for variables is patterned after
292 as an argument to the set command displays all variables readable by
294 Alternatively, the user may request display of a particular variable
300 displays the current escape character.
302 Variables are numeric, string, character, or boolean values.
303 Boolean variables are set merely by specifying their name; they may be
304 reset by prepending a
307 Other variable types are set by concatenating an
310 The entire assignment must not have any blanks in it.
311 A single set command may be used to interrogate as well as set a
313 Certain common variables have abbreviations.
314 The following is a list of common variables, their abbreviations, and
315 their default values:
316 .Bl -tag -width indent
319 The baud rate at which the connection was established;
324 Discard unprintable characters when a session is being
325 scripted; abbreviated
329 When dialing a phone number, the time (in seconds) to wait for a
330 connection to be established; abbreviated
334 Synchronize with the remote host during file transfer by
335 waiting for the echo of the last character transmitted; default is
339 The set of characters which signify an end-of-transmission
342 file transfer command; abbreviated
346 The string sent to indicate end-of-transmission during a
348 file transfer command; abbreviated
352 The set of characters which indicate an end-of-line.
356 will recognize escape characters only after an end-of-line.
359 The command prefix (escape) character; abbreviated
365 The set of characters which should not be discarded due to the
366 beautification switch; abbreviated
369 .Dq Li \et\en\ef\eb .
372 The character used to force literal data transmission;
379 The amount of data (in bytes) to buffer between file system
380 writes when receiving files; abbreviated
384 Whether hardware flow control (CRTSCTS) is enabled for the
385 connection; abbreviated
391 The name of the host to which you are connected; abbreviated
395 The line discipline to use; abbreviated
399 The character which indicates an end-of-line on the remote
404 This value is used to synchronize during data transfers.
405 The count of lines transferred during a file transfer command is based
406 on receipt of this character.
409 Upper case mapping mode; abbreviated
413 When this mode is enabled, all lowercase letters will be mapped to
416 for transmission to the remote machine.
419 The input character used to toggle uppercase mapping mode;
425 The name of the file in which a session script is recorded;
430 Session scripting mode; abbreviated
439 will record everything transmitted by the remote machine in the script
440 record file specified in
444 switch is on, only printable
446 characters will be included in the script file (those characters
447 between 040 and 0177).
450 is used to indicate characters which are an exception to the normal
451 beautification rules.
454 Expand tabs to spaces during file transfers; abbreviated
458 Each tab is expanded to 8 spaces.
461 Use XON/XOFF flow control to throttle data from the remote host;
468 Verbose mode; abbreviated
472 When verbose mode is enabled,
474 prints messages while dialing, shows the current number of lines
475 transferred during a file transfer operations, and more.
478 .Bl -tag -width indent
480 The home directory to use for the
484 The name of the shell to use for the
486 command; default value is
490 .Bl -tag -width ".Pa /var/spool/lock/LCK..*" -compact
491 .It Pa /var/log/aculog
493 .It Pa /var/spool/lock/LCK..*
494 lock file to avoid conflicts with
495 .Xr uucp 1 Pq Pa ports/net/freebsd-uucp
505 The full set of variables is undocumented and should, probably, be