Annotation of src/usr.bin/cu/cu.1, Revision 1.22
1.22 ! jsg 1: .\" $OpenBSD: cu.1,v 1.21 2020/12/12 06:35:37 bentley Exp $
1.1 nicm 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: .\"
1.22 ! jsg 30: .Dd $Mdocdate: December 12 2020 $
1.1 nicm 31: .Dt CU 1
32: .Os
33: .Sh NAME
34: .Nm cu
35: .Nd serial terminal emulator
36: .Sh SYNOPSIS
37: .Nm
1.16 deraadt 38: .Op Fl dr
1.19 nicm 39: .Op Fl E Ar escape_char
1.1 nicm 40: .Op Fl l Ar line
1.13 bentley 41: .Op Fl s Ar speed | Fl Ar speed
1.12 nicm 42: .Nm
1.10 nicm 43: .Op Ar host
1.1 nicm 44: .Sh DESCRIPTION
45: .Nm
46: is used to connect to another system over a serial link.
47: In the era before modern networks, it was typically used to
48: connect to a modem in order to dial in to a remote host.
49: It is now frequently used for tasks such as attaching to the
50: serial console of another machine for administrative or
51: debugging purposes.
52: .Pp
53: The options are as follows:
54: .Bl -tag -width 4n
1.15 nicm 55: .It Fl d
56: Specify that the line is directly connected and
57: .Nm
58: should not allow the driver to block waiting for a carrier to be detected.
1.19 nicm 59: .It Fl E Ar escape_char
60: Specify an escape character to use instead of the default tilde.
1.1 nicm 61: .It Fl l Ar line
62: Specify the line to use.
63: Either of the forms like
1.9 nicm 64: .Pa cua00
1.1 nicm 65: or
1.9 nicm 66: .Pa /dev/cua00
1.1 nicm 67: are permitted.
68: The default is
69: .Pa /dev/cua00 .
1.9 nicm 70: See
1.1 nicm 71: .Xr cua 4
1.9 nicm 72: for information on terminal devices.
1.1 nicm 73: Users in group
74: .Dq dialer
75: are permitted to use
76: .Xr cua 4
1.9 nicm 77: devices by default.
1.17 jmc 78: .It Fl r
79: Start
80: .Nm
81: in restricted mode.
1.18 jmc 82: This prevents all local filesystem operations
83: .Po
84: .Cm ~R ,
85: .Cm ~X ,
86: and
87: .Cm ~>
88: .Pc
89: and command executions
90: .Po
91: .Cm ~C
92: and
93: .Cm ~$
94: .Pc .
1.13 bentley 95: .It Fl s Ar speed | Fl Ar speed
1.1 nicm 96: Set the speed of the connection.
97: The default is 9600.
98: .El
99: .Pp
1.10 nicm 100: If
101: .Ar host
102: is given,
103: .Nm
104: uses the
105: .Xr remote 5
1.11 nicm 106: database to retrieve the
1.15 nicm 107: .Sy dc Pq directly connected ,
1.10 nicm 108: .Sy dv Pq device
109: and
110: .Sy br Pq baud rate
111: capabilities for that host.
112: The
113: .Nm
114: utility ignores other capabilities found in that database.
115: .Pp
1.1 nicm 116: Typed characters are normally transmitted directly to the remote
117: machine (which does the echoing as well).
118: A tilde
119: .Pq Ql ~
120: appearing as the first character of a line is an escape signal; the
121: following are recognized:
122: .Bl -tag -offset indent -width Fl
123: .It Ic ~^D No or Ic ~.
124: Drop the connection and exit.
125: Only the connection is dropped \(en the login session is not terminated.
1.18 jmc 126: .It Ic ~>
1.1 nicm 127: Copy file from local to remote.
128: .Nm
129: prompts for the name of a local file to transmit.
130: .It Ic ~$
131: Pipe the output from a local
132: .Ux
133: process to the remote host.
134: The command string sent to the local
135: .Ux
136: system is processed by the shell.
137: .It Ic ~#
138: Send a
139: .Dv BREAK
140: to the remote system.
141: .It Ic ~^Z
142: Stop
143: .Nm
144: (only available with job control).
1.3 nicm 145: .It Ic ~C
146: Fork a child process on the local system to perform special protocols
147: such as XMODEM.
148: The child program will be run with the following arrangement of
149: file descriptors:
1.21 bentley 150: .Pp
151: .Bl -item -compact -offset indent
152: .It
153: 0 \(<> remote tty in
154: .It
155: 1 \(<> remote tty out
156: .It
157: 2 \(<> local tty stderr
158: .El
1.7 nicm 159: .It Ic ~D
160: Deassert the data terminal ready (DTR) line briefly.
1.5 nicm 161: .It Ic ~R
162: Record all output from the remote system to a file.
163: If the given file already exists, it is appended to.
164: If no file is specified, any existing recording is stopped.
1.2 nicm 165: .It Ic ~S
166: Change the speed of the connection.
1.4 nicm 167: .It Ic ~X
1.6 nicm 168: Send a file with the XMODEM protocol.
1.1 nicm 169: .It Ic ~?
170: Get a summary of the tilde escapes.
171: .El
172: .Pp
173: When
174: .Nm
175: prompts for an argument, for example during setup of a file transfer,
176: the line typed may be edited with the standard erase and kill characters.
177: A null line in response to a prompt, or an interrupt, will abort the
178: dialogue and return the user to the remote machine.
179: .Pp
180: .Nm
181: guards against multiple users connecting to a remote system by opening
182: modems and terminal lines with exclusive access.
1.10 nicm 183: .Sh ENVIRONMENT
1.11 nicm 184: .Bl -tag -width REMOTEXXX
185: .It Ev HOST
186: The default value for
187: .Ar host
188: if none is specified via the command line.
189: .It Ev REMOTE
190: A system description, or an absolute path to a
1.10 nicm 191: .Xr remote 5
1.11 nicm 192: system description database.
193: .El
1.10 nicm 194: .Sh FILES
195: .Bl -tag -width /etc/remote
196: .It Pa /etc/remote
197: host description file
198: .El
1.11 nicm 199: .Sh EXIT STATUS
200: .Ex -std cu
201: .Sh SEE ALSO
202: .Xr remote 5
1.1 nicm 203: .Sh HISTORY
204: The
205: .Nm
1.22 ! jsg 206: .Pq Dq Call Unix
! 207: command first appeared outside of Bell Labs in PWB/UNIX 1.0.
! 208: It was reimplemented as part of the
! 209: .Nm tip
! 210: command in
! 211: .Bx 4.1c .
! 212: The current version was written for
! 213: .Ox 5.4 .
! 214: .Sh AUTHORS
! 215: .An Nicholas Marriott Aq Mt nicm@openbsd.org
![[BACK]](/icons/back.gif){kind=icon}
Return to cu.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / cu