Add a brief manpage (cribbed form pty.4) about the null-modem

driver (nmdm(4)).

1 files changed, 66 insertions, 0 deletions

diff --git a/share/man/man4/nmdm.4 b/share/man/man4/nmdm.4
new file mode 100644
index 0000000..1fb8d0e
--- /dev/null
+++ b/share/man/man4/nmdm.4
@@ -0,0 +1,66 @@
+.\" Copyright (c) 2001
+.\"	The FreeBSD Project 
+.\"
+.\" 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.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd July 7, 2001
+.Dt NMDM 4
+.Os FreeBSD 5.0
+.Sh NAME
+.Nm nmdm
+.Nd nullmodem terminal driver
+.Sh SYNOPSIS
+.Cd "device nmdm"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for a device-pair termed a
+.Em null modem pair .
+A null modem pair is a pair of character devices.
+Each device provides to a process an interface identical
+to that described in
+.Xr tty 4 .
+However, whereas most other devices which provide the
+interface described in
+.Xr tty 4
+have a hardware device of some sort behind them, the nmdm
+device has, instead, another process manipulating
+it through the other half of the pair.
+That is, anything written on the first device is
+given to the second device as input and anything written
+on the second device is presented as input on the first
+device.
+.Pp
+.Sh FILES
+.Bl -tag -width /dev/nmdm[N][AB] -compact
+.It Pa /dev/nmdm[N][AB]
+nullmodem device nodes.
+Where the A node has a matching B node.
+.El
+.Sh DIAGNOSTICS
+None.
+.Sh SEE ALSO
+.Xr tty 4
+.Sh HISTORY
+The
+.Nm
+driver appeared in
+.Fx 5.0 .