Annotation of src/usr.bin/cu/cu.1, Revision 1.1
1.1 ! nicm 1: .\" $OpenBSD: cu.1,v 1.13 2010/07/22 08:32:58 jmc Exp $
! 2: .\"
! 3: .\" Copyright (c) 1980, 1990, 1993
! 4: .\" The Regents of the University of California. All rights reserved.
! 5: .\"
! 6: .\" Redistribution and use in source and binary forms, with or without
! 7: .\" modification, are permitted provided that the following conditions
! 8: .\" are met:
! 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.
! 17: .\"
! 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
! 28: .\" SUCH DAMAGE.
! 29: .\"
! 30: .\" @(#)tip.1 8.4 (Berkeley) 4/18/94
! 31: .\"
! 32: .Dd $Mdocdate: July 22 2010 $
! 33: .Dt CU 1
! 34: .Os
! 35: .Sh NAME
! 36: .Nm cu
! 37: .Nd serial terminal emulator
! 38: .Sh SYNOPSIS
! 39: .Nm
! 40: .Op Fl l Ar line
! 41: .Op Fl s Ar speed \*(Ba Fl Ar speed
! 42: .Sh DESCRIPTION
! 43: .Nm
! 44: is used to connect to another system over a serial link.
! 45: In the era before modern networks, it was typically used to
! 46: connect to a modem in order to dial in to a remote host.
! 47: It is now frequently used for tasks such as attaching to the
! 48: serial console of another machine for administrative or
! 49: debugging purposes.
! 50: .Pp
! 51: The options are as follows:
! 52: .Bl -tag -width 4n
! 53: .It Fl l Ar line
! 54: Specify the line to use.
! 55: Either of the forms like
! 56: .Pa tty00
! 57: or
! 58: .Pa /dev/tty00
! 59: are permitted.
! 60: The default is
! 61: .Pa /dev/cua00 .
! 62: .Pp
! 63: For reasons outlined in
! 64: .Xr tty 4 ,
! 65: .Xr cua 4
! 66: devices should be used on architectures which have them.
! 67: For those which do not,
! 68: .Xr tty 4
! 69: devices can be used.
! 70: Users in group
! 71: .Dq dialer
! 72: are permitted to use
! 73: .Xr cua 4
! 74: devices by default;
! 75: permissions on
! 76: .Pa /dev/tty00
! 77: or
! 78: .Pa /dev/ttya
! 79: can be changed,
! 80: but they will revert to their defaults
! 81: after an upgrade or (re)install.
! 82: .It Fl s Ar speed \*(Ba Fl Ar speed
! 83: Set the speed of the connection.
! 84: The default is 9600.
! 85: .El
! 86: .Pp
! 87: Typed characters are normally transmitted directly to the remote
! 88: machine (which does the echoing as well).
! 89: A tilde
! 90: .Pq Ql ~
! 91: appearing as the first character of a line is an escape signal; the
! 92: following are recognized:
! 93: .Bl -tag -offset indent -width Fl
! 94: .It Ic ~^D No or Ic ~.
! 95: Drop the connection and exit.
! 96: Only the connection is dropped \(en the login session is not terminated.
! 97: .It Ic ~\*(Gt
! 98: Copy file from local to remote.
! 99: .Nm
! 100: prompts for the name of a local file to transmit.
! 101: .It Ic ~$
! 102: Pipe the output from a local
! 103: .Ux
! 104: process to the remote host.
! 105: The command string sent to the local
! 106: .Ux
! 107: system is processed by the shell.
! 108: .It Ic ~#
! 109: Send a
! 110: .Dv BREAK
! 111: to the remote system.
! 112: .It Ic ~^Z
! 113: Stop
! 114: .Nm
! 115: (only available with job control).
! 116: .It Ic ~?
! 117: Get a summary of the tilde escapes.
! 118: .El
! 119: .Pp
! 120: When
! 121: .Nm
! 122: prompts for an argument, for example during setup of a file transfer,
! 123: the line typed may be edited with the standard erase and kill characters.
! 124: A null line in response to a prompt, or an interrupt, will abort the
! 125: dialogue and return the user to the remote machine.
! 126: .Pp
! 127: .Nm
! 128: guards against multiple users connecting to a remote system by opening
! 129: modems and terminal lines with exclusive access.
! 130: .Sh HISTORY
! 131: The
! 132: .Nm
! 133: command appeared in
! 134: .Bx 4.2 .
! 135: This version was written for
! 136: .Ox 5.2
! 137: by Nicholas Marriott.