Annotation of src/usr.bin/cu/cu.1, Revision 1.13
1.13 ! bentley 1: .\" $OpenBSD: cu.1,v 1.12 2015/02/08 17:33:35 nicm 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: .\"
30: .\" @(#)tip.1 8.4 (Berkeley) 4/18/94
31: .\"
1.13 ! bentley 32: .Dd $Mdocdate: February 8 2015 $
1.1 nicm 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
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
55: .It Fl l Ar line
56: Specify the line to use.
57: Either of the forms like
1.9 nicm 58: .Pa cua00
1.1 nicm 59: or
1.9 nicm 60: .Pa /dev/cua00
1.1 nicm 61: are permitted.
62: The default is
63: .Pa /dev/cua00 .
1.9 nicm 64: See
1.1 nicm 65: .Xr cua 4
1.9 nicm 66: for information on terminal devices.
1.1 nicm 67: Users in group
68: .Dq dialer
69: are permitted to use
70: .Xr cua 4
1.9 nicm 71: devices by default.
1.13 ! bentley 72: .It Fl s Ar speed | Fl Ar speed
1.1 nicm 73: Set the speed of the connection.
74: The default is 9600.
75: .El
76: .Pp
1.10 nicm 77: If
78: .Ar host
79: is given,
80: .Nm
81: uses the
82: .Xr remote 5
1.11 nicm 83: database to retrieve the
1.10 nicm 84: .Sy dv Pq device
85: and
86: .Sy br Pq baud rate
87: capabilities for that host.
88: The
89: .Nm
90: utility ignores other capabilities found in that database.
91: .Pp
1.1 nicm 92: Typed characters are normally transmitted directly to the remote
93: machine (which does the echoing as well).
94: A tilde
95: .Pq Ql ~
96: appearing as the first character of a line is an escape signal; the
97: following are recognized:
98: .Bl -tag -offset indent -width Fl
99: .It Ic ~^D No or Ic ~.
100: Drop the connection and exit.
101: Only the connection is dropped \(en the login session is not terminated.
102: .It Ic ~\*(Gt
103: Copy file from local to remote.
104: .Nm
105: prompts for the name of a local file to transmit.
106: .It Ic ~$
107: Pipe the output from a local
108: .Ux
109: process to the remote host.
110: The command string sent to the local
111: .Ux
112: system is processed by the shell.
113: .It Ic ~#
114: Send a
115: .Dv BREAK
116: to the remote system.
117: .It Ic ~^Z
118: Stop
119: .Nm
120: (only available with job control).
1.3 nicm 121: .It Ic ~C
122: Fork a child process on the local system to perform special protocols
123: such as XMODEM.
124: The child program will be run with the following arrangement of
125: file descriptors:
126: .Bd -literal -offset indent
127: 0 \*(Lt-\*(Gt remote tty in
128: 1 \*(Lt-\*(Gt remote tty out
129: 2 \*(Lt-\*(Gt local tty stderr
130: .Ed
1.7 nicm 131: .It Ic ~D
132: Deassert the data terminal ready (DTR) line briefly.
1.5 nicm 133: .It Ic ~R
134: Record all output from the remote system to a file.
135: If the given file already exists, it is appended to.
136: If no file is specified, any existing recording is stopped.
1.2 nicm 137: .It Ic ~S
138: Change the speed of the connection.
1.4 nicm 139: .It Ic ~X
1.6 nicm 140: Send a file with the XMODEM protocol.
1.1 nicm 141: .It Ic ~?
142: Get a summary of the tilde escapes.
143: .El
144: .Pp
145: When
146: .Nm
147: prompts for an argument, for example during setup of a file transfer,
148: the line typed may be edited with the standard erase and kill characters.
149: A null line in response to a prompt, or an interrupt, will abort the
150: dialogue and return the user to the remote machine.
151: .Pp
152: .Nm
153: guards against multiple users connecting to a remote system by opening
154: modems and terminal lines with exclusive access.
1.10 nicm 155: .Sh ENVIRONMENT
1.11 nicm 156: .Bl -tag -width REMOTEXXX
157: .It Ev HOST
158: The default value for
159: .Ar host
160: if none is specified via the command line.
161: .It Ev REMOTE
162: A system description, or an absolute path to a
1.10 nicm 163: .Xr remote 5
1.11 nicm 164: system description database.
165: .El
1.10 nicm 166: .Sh FILES
167: .Bl -tag -width /etc/remote
168: .It Pa /etc/remote
169: host description file
170: .El
1.11 nicm 171: .Sh EXIT STATUS
172: .Ex -std cu
173: .Sh SEE ALSO
174: .Xr remote 5
1.1 nicm 175: .Sh HISTORY
176: The
177: .Nm
178: command appeared in
179: .Bx 4.2 .
180: This version was written for
1.8 nicm 181: .Ox 5.4
1.1 nicm 182: by Nicholas Marriott.
![[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