freebsd-nq/share/man/man4/nmdm.4

.\" 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 11, 2020
.Dt NMDM 4
.Os
.Sh NAME
.Nm nmdm
.Nd nullmodem terminal driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following line in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device nmdm"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
nmdm_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides two
.Xr tty 4
devices connected
by a virtual
.Dq "null modem"
cable.
.Pp
If either of the two tty devices have the
.Dv CDSR_OFLOW
bit
.Pq Dq Li "stty dsrflow"
set in their line discipline, the
.Nm
device will emulate the speed configured in the
.Xr termios 4
settings.
The speed emulation works independently in the two directions,
controlled by the slower end's termios settings
.Va ( c_ispeed , c_ospeed ,
.Dv CS5 ... CS8 , CSTOPB
and
.Dv PARENB ) .
.Sh FILES
.Bl -tag -width ".Pa /dev/nmdm Ns Ar N Ns Op Pa AB" -compact
.It Pa /dev/nmdm Ns Ar N Ns Op Pa AB
nullmodem device nodes.
Where the
.Pa A
node has a matching
.Pa B
node.
.El
.Pp
The
.Nm
driver implements
.Dq "on-demand device creation"
so simply accessing a given instance in
.Pa /dev
will create it.
.Sh DIAGNOSTICS
None.
.Sh SEE ALSO
.Xr stty 1 ,
.Xr termios 4 ,
.Xr tty 4 ,
.Xr ttys 5
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 4.4 .
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.\" Copyright (c) 2001`
mdoc(7) police: fixed markup. 2001-07-11 08:59:10 +00:00			`.\" The FreeBSD Project`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.\"`
			`.\" 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$`
			`.\"`
Add cross references betwen ttys(5) and related drivers nmdm(4), ucom(4), and uart(4) PR: 247638 Submitted by: Pau Amma <pauamma@gundo.com> Reported by: 0mp MFC after: 4 weeks Sponsored by: Klara Inc. Event: July 2020 Bugathon 2020-07-11 20:56:57 +00:00			`.Dd July 11, 2020`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Dt NMDM 4`
mdoc(7) police: fixed markup. 2001-07-11 08:59:10 +00:00			`.Os`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Sh NAME`
			`.Nm nmdm`
			`.Nd nullmodem terminal driver`
			`.Sh SYNOPSIS`
Document how to load nmdm(4) from a kernel module. Submitted by: kevlo MFC after: 2 weeks 2018-01-23 03:36:49 +00:00			`To compile this driver into the kernel,`
			`place the following line in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Cd "device nmdm"`
Document how to load nmdm(4) from a kernel module. Submitted by: kevlo MFC after: 2 weeks 2018-01-23 03:36:49 +00:00			`.Ed`
			`.Pp`
			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`nmdm_load="YES"`
			`.Ed`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Polish the formatting. 2005-01-27 10:30:53 +00:00			`driver provides two`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Xr tty 4`
Update the information, (and likely break all formatting rules). 2005-01-27 09:29:52 +00:00			`devices connected`
Polish the formatting. 2005-01-27 10:30:53 +00:00			`by a virtual`
			`.Dq "null modem"`
			`cable.`
Update the information, (and likely break all formatting rules). 2005-01-27 09:29:52 +00:00			`.Pp`
Polish the formatting. 2005-01-27 10:30:53 +00:00			`If either of the two tty devices have the`
			`.Dv CDSR_OFLOW`
			`bit`
			`.Pq Dq Li "stty dsrflow"`
			`set in their line discipline, the`
mdoc(7) police: fixed markup. 2001-07-11 08:59:10 +00:00			`.Nm`
Update the information, (and likely break all formatting rules). 2005-01-27 09:29:52 +00:00			`device will emulate the speed configured in the`
			`.Xr termios 4`
			`settings.`
			`The speed emulation works independently in the two directions,`
Polish the formatting. 2005-01-27 10:30:53 +00:00			`controlled by the slower end's termios settings`
			`.Va ( c_ispeed , c_ospeed ,`
			`.Dv CS5 ... CS8 , CSTOPB`
			`and`
			`.Dv PARENB ) .`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Sh FILES`
Polish the formatting. 2005-01-27 10:30:53 +00:00			`.Bl -tag -width ".Pa /dev/nmdm Ns Ar N Ns Op Pa AB" -compact`
mdoc(7) police: fixed markup. 2001-07-11 08:59:10 +00:00			`.It Pa /dev/nmdm Ns Ar N Ns Op Pa AB`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`nullmodem device nodes.`
mdoc(7) police: fixed markup. 2001-07-11 08:59:10 +00:00			`Where the`
			`.Pa A`
			`node has a matching`
			`.Pa B`
			`node.`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.El`
Update the information, (and likely break all formatting rules). 2005-01-27 09:29:52 +00:00			`.Pp`
			`The`
			`.Nm`
Polish the formatting. 2005-01-27 10:30:53 +00:00			`driver implements`
			`.Dq "on-demand device creation"`
			`so simply accessing a given instance in`
			`.Pa /dev`
			`will create it.`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Sh DIAGNOSTICS`
			`None.`
			`.Sh SEE ALSO`
Update the information, (and likely break all formatting rules). 2005-01-27 09:29:52 +00:00			`.Xr stty 1 ,`
			`.Xr termios 4 ,`
Add cross references betwen ttys(5) and related drivers nmdm(4), ucom(4), and uart(4) PR: 247638 Submitted by: Pau Amma <pauamma@gundo.com> Reported by: 0mp MFC after: 4 weeks Sponsored by: Klara Inc. Event: July 2020 Bugathon 2020-07-11 20:56:57 +00:00			`.Xr tty 4 ,`
			`.Xr ttys 5`
Add a brief manpage (cribbed form pty.4) about the null-modem driver (nmdm(4)). 2001-07-08 04:35:21 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
For consistency with other man pages, fix first appearance. 2001-08-11 00:59:40 +00:00			`driver first appeared in`
			`.Fx 4.4 .`