summaryrefslogtreecommitdiff
path: root/usr.bin/cu/cu.1
diff options
context:
space:
mode:
authorNicholas Marriott <nicm@cvs.openbsd.org>2012-07-10 08:02:28 +0000
committerNicholas Marriott <nicm@cvs.openbsd.org>2012-07-10 08:02:28 +0000
commit987bf588ac046de0e2a20e1f62985ac0fc03876a (patch)
treecae0b348a408da66e3bb65d95d8fd206fb4deff4 /usr.bin/cu/cu.1
parentbdb94ced1204fae7a8c01ecb5200a0425ae10526 (diff)
Add first cut of replacement for tip/cu. Not linked to the build.
Currently supports only -l and -s (no parity), no variables and ~., ~>, ~$, ~#, ~^Z, ~?. More to come. Tested by naddy, otto. ok miod deraadt
Diffstat (limited to 'usr.bin/cu/cu.1')
-rw-r--r--usr.bin/cu/cu.1137
1 files changed, 137 insertions, 0 deletions
diff --git a/usr.bin/cu/cu.1 b/usr.bin/cu/cu.1
new file mode 100644
index 00000000000..b5568259e63
--- /dev/null
+++ b/usr.bin/cu/cu.1
@@ -0,0 +1,137 @@
+.\" $OpenBSD: cu.1,v 1.1 2012/07/10 08:02:27 nicm Exp $
+.\"
+.\" Copyright (c) 1980, 1990, 1993
+.\" The Regents of the University of California. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. Neither the name of the University nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" @(#)tip.1 8.4 (Berkeley) 4/18/94
+.\"
+.Dd $Mdocdate: July 10 2012 $
+.Dt CU 1
+.Os
+.Sh NAME
+.Nm cu
+.Nd serial terminal emulator
+.Sh SYNOPSIS
+.Nm
+.Op Fl l Ar line
+.Op Fl s Ar speed \*(Ba Fl Ar speed
+.Sh DESCRIPTION
+.Nm
+is used to connect to another system over a serial link.
+In the era before modern networks, it was typically used to
+connect to a modem in order to dial in to a remote host.
+It is now frequently used for tasks such as attaching to the
+serial console of another machine for administrative or
+debugging purposes.
+.Pp
+The options are as follows:
+.Bl -tag -width 4n
+.It Fl l Ar line
+Specify the line to use.
+Either of the forms like
+.Pa tty00
+or
+.Pa /dev/tty00
+are permitted.
+The default is
+.Pa /dev/cua00 .
+.Pp
+For reasons outlined in
+.Xr tty 4 ,
+.Xr cua 4
+devices should be used on architectures which have them.
+For those which do not,
+.Xr tty 4
+devices can be used.
+Users in group
+.Dq dialer
+are permitted to use
+.Xr cua 4
+devices by default;
+permissions on
+.Pa /dev/tty00
+or
+.Pa /dev/ttya
+can be changed,
+but they will revert to their defaults
+after an upgrade or (re)install.
+.It Fl s Ar speed \*(Ba Fl Ar speed
+Set the speed of the connection.
+The default is 9600.
+.El
+.Pp
+Typed characters are normally transmitted directly to the remote
+machine (which does the echoing as well).
+A tilde
+.Pq Ql ~
+appearing as the first character of a line is an escape signal; the
+following are recognized:
+.Bl -tag -offset indent -width Fl
+.It Ic ~^D No or Ic ~.
+Drop the connection and exit.
+Only the connection is dropped \(en the login session is not terminated.
+.It Ic ~\*(Gt
+Copy file from local to remote.
+.Nm
+prompts for the name of a local file to transmit.
+.It Ic ~$
+Pipe the output from a local
+.Ux
+process to the remote host.
+The command string sent to the local
+.Ux
+system is processed by the shell.
+.It Ic ~#
+Send a
+.Dv BREAK
+to the remote system.
+.It Ic ~^Z
+Stop
+.Nm
+(only available with job control).
+.It Ic ~?
+Get a summary of the tilde escapes.
+.El
+.Pp
+When
+.Nm
+prompts for an argument, for example during setup of a file transfer,
+the line typed may be edited with the standard erase and kill characters.
+A null line in response to a prompt, or an interrupt, will abort the
+dialogue and return the user to the remote machine.
+.Pp
+.Nm
+guards against multiple users connecting to a remote system by opening
+modems and terminal lines with exclusive access.
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.2 .
+This version was written for
+.Ox 5.2
+by Nicholas Marriott.