View | Details | Raw Unified | Return to bug 257964
Collapse All | Expand All

(-)b/share/man/man4/snp.4 (-16 / +35 lines)
Lines 1-7 Link Here
1
.\"
1
.\"
2
.\" $FreeBSD$
2
.\" $FreeBSD$
3
.\"
3
.\"
4
.Dd November 5, 2008
4
.Dd October 1, 2021
5
.Dt SNP 4
5
.Dt SNP 4
6
.Os
6
.Os
7
.Sh NAME
7
.Sh NAME
Lines 17-24 Link Here
17
.Fn ioctl fd FIONREAD &result
17
.Fn ioctl fd FIONREAD &result
18
.Sh DESCRIPTION
18
.Sh DESCRIPTION
19
.Pa /dev/snp
19
.Pa /dev/snp
20
is a snoop device which allows users to attach to any tty
20
is a snoop device which allows users to attach to any egress tty
21
.Pq a tty that originates from the host
21
and watch activities on it.
22
and watch activities on it.
23
22
The kernel must be compiled with
24
The kernel must be compiled with
23
.Cd "device snp" ,
25
.Cd "device snp" ,
24
or the
26
or the
Lines 52-72 the open Link Here
52
.Nm
54
.Nm
53
device.
55
device.
54
.Pp
56
.Pp
55
The
57
If the
56
.Dv FIONREAD
57
ioctl returns a positive value equal to the number of characters
58
in a read buffer.
59
Special values defined are:
60
.Bl -tag -width ".Dv SNP_TTYCLOSE"
61
.It Dv SNP_OFLOW
62
device overflow occurred, device detached.
63
.It Dv SNP_TTYCLOSE
64
tty not attached.
65
.It Dv SNP_DETACH
66
.Nm
58
.Nm
67
device has been detached by user or tty device has been closed
59
device disappears, closes, or detaches, calls to
68
and detached.
60
.Xr read 2
69
.El
61
return
62
.Dv EIO
63
and
64
.Xr write 2
65
return
66
either
67
.Dv EIO
68
or
69
.Dv ENXIO .
70
.Sh SEE ALSO
70
.Sh SEE ALSO
71
.Xr pty 4 ,
71
.Xr pty 4 ,
72
.Xr kldload 8 ,
72
.Xr kldload 8 ,
Lines 81-86 In Link Here
81
the
81
the
82
.Nm
82
.Nm
83
driver was rewritten to work with the replaced TTY subsystem.
83
driver was rewritten to work with the replaced TTY subsystem.
84
.Pp
85
For previous versions of the driver,
86
.Dv FIONREAD
87
ioctl returned a positive value equal to the number of characters
88
in a read buffer.
89
Special values defined are:
90
.Bl -tag -width ".Dv SNP_TTYCLOSE"
91
.It Dv SNP_OFLOW
92
device overflow occurred, device detached.
93
.It Dv SNP_TTYCLOSE
94
tty not attached.
95
.It Dv SNP_DETACH
96
.Nm
97
device has been detached by user or tty device has been closed
98
and detached.
99
.El
100
These values are no longer used, see BUGS.
84
.Sh AUTHORS
101
.Sh AUTHORS
85
.An -nosplit
102
.An -nosplit
86
The author of the current implementation is
103
The author of the current implementation is
Lines 97-99 does not return proper error codes when calling Link Here
97
It also does not allow
114
It also does not allow
98
.Dv SNPSTTY
115
.Dv SNPSTTY
99
to detach itself from the TTY.
116
to detach itself from the TTY.
117
.Pp
118
Flow control is not supported.

Return to bug 257964