diff options
-rw-r--r-- | share/man/man4/Makefile | 2 | ||||
-rw-r--r-- | share/man/man4/man4.i386/Makefile | 5 | ||||
-rw-r--r-- | share/man/man4/man4.i386/sysmouse.4 | 142 | ||||
-rw-r--r-- | share/man/man4/sysmouse.4 | 142 |
4 files changed, 288 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 5bbb69b6c17a..de7e346fa572 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -4,7 +4,7 @@ MAN4= bpf.4 ccd.4 cd.4 ch.4 ddb.4 divert.4 drum.4 fd.4 fpa.4 \ icmp.4 ifmib.4 inet.4 intro.4 ip.4 ipfirewall.4 \ lkm.4 lo.4 netintro.4 \ null.4 ppp.4 pt.4 pty.4 route.4 \ - scsi.4 sd.4 sl.4 snp.4 st.4 su.4 sysmouse.4 tcp.4 \ + scsi.4 sd.4 sl.4 snp.4 st.4 su.4 tcp.4 \ ttcp.4 termios.4 tty.4 udp.4 uk.4 update.4 unix.4 vn.4 worm.4 yp.4 \ zero.4 diff --git a/share/man/man4/man4.i386/Makefile b/share/man/man4/man4.i386/Makefile index 9d78b7786b04..b4da9dbabe91 100644 --- a/share/man/man4/man4.i386/Makefile +++ b/share/man/man4/man4.i386/Makefile @@ -1,11 +1,11 @@ -# $Id$ +# $Id: Makefile,v 1.60 1997/02/22 13:25:07 peter Exp $ MAN4= aha.4 ahb.4 ahc.4 aic.4 apm.4 ar.4 asc.4 bt.4 cx.4 cy.4 de.4 dgb.4 \ ed.4 eg.4 el.4 ep.4 ex.4 gsc.4 fdc.4 fe.4 fxp.4 ie.4 io.4 ix.4 \ joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 mem.4 \ meteor.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 pcvt.4 perfmon.4 psm.4 \ qcam.4 scd.4 screen.4 sea.4 si.4 sio.4 \ - spkr.4 sr.4 tw.4 uha.4 vx.4 wd.4 wt.4 ze.4 zp.4 + spkr.4 sr.4 sysmouse.4 tw.4 uha.4 vx.4 wd.4 wt.4 ze.4 zp.4 MLINKS= aha.4 ../aha.4 MLINKS+= ahb.4 ../ahb.4 @@ -58,6 +58,7 @@ MLINKS+= si.4 ../si.4 MLINKS+= sio.4 ../sio.4 MLINKS+= spkr.4 ../spkr.4 spkr.4 speaker.4 spkr.4 ../speaker.4 MLINKS+= sr.4 ../sr.4 +MLINKS+= sysmouse.4 ../sysmouse.4 MLINKS+= tw.4 ../tw.4 MLINKS+= uha.4 ../uha.4 MLINKS+= wd.4 ../wd.4 diff --git a/share/man/man4/man4.i386/sysmouse.4 b/share/man/man4/man4.i386/sysmouse.4 new file mode 100644 index 000000000000..e2e33a41bb41 --- /dev/null +++ b/share/man/man4/man4.i386/sysmouse.4 @@ -0,0 +1,142 @@ +.\" Copyright (c) 1997 +.\" John-Mark Gurney. 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 author nor the names of any co-contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney 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 AUTHOR 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. +.\" +.\" +.Dd February 14, 1997 +.Dt SYSMOUSE 4 +.Os +.Sh NAME +.Nm sysmouse +.Nd supplies mouse data from syscons for other applications +.Sh SYNOPSIS +.Fd #include <machine/console.h> +.Fd #include <sys/ioctl.h> +.Ft int +.Fn ioctl cfd CONS_MOUSECTL struct\ *mouse_info +.Sh DESCRIPTION +The +.Dv CONS_MOUSECTL +.Fn ioctl +call provides syscons with mouse information, which includes mouse movement +and button presses. The +.Fn ioctl +also provides a method for a process to receive a +.Xr signal 3 +when a button is pressed. +.Pp +.Xr moused 8 +uses this +.Fn ioctl +to inform the console of mouse actions. Applications +.Pq such as Tn X\ Windows +can use +.Pa /dev/sysmouse , +allowing syscons and the application to share the mouse. +.Pp +.Bd -literal -offset indent +struct mouse_info { + int operation; + union { + struct mouse_data data; + struct mouse_mode mode; + }u; +}; +.Ed +.Bl -tag -width operation +.It Dv operation +This can be one of +.Bl -tag -width MOUSE_MOVEABS +.It Dv MOUSE_SHOW +Enables and displays mouse cursor. +.It Dv MOUSE_HIDE +Disables and hides mouse cursor. +.It Dv MOUSE_MOVEABS +Moves mouse cursor to position supplied in +.Dv u.data . +.It Dv MOUSE_MOVEREL +Add position supplied in +.Dv u.data +to current position. +.It Dv MOUSE_GETINFO +Returns current mouse position and button status in +.Dv u.data . +.It Dv MOUSE_MODE +This sets the +.Xr signal 3 +to be delivered to the current process when a button is pressed. +The signal to be delivered is set in +.Dv u.mode . +.It Dv MOUSE_ACTION +This takes the information in +.Dv u.data +and acts upon it. It includes processing button presses if the current vty +is a text interface, and sending +.Tn Mouse System +protocol data to +.Pa /dev/sysmouse +if it is open. +.El +.It Dv u +This union is one of +.Bl -tag -width data +.It Dv data +.Bd -literal -offset indent +struct mouse_data { + int x; + int y; + int buttons; +}; +.Ed +.It Dv mode +.Bd -literal -offset indent +struct mouse_mode { + int mode; + int signal; +}; +.Ed +.El +.El +.Sh FILES +.Bl -tag -width /dev/consolectl -compact +.It Pa /dev/consolectl +device to control the console +.It Pa /dev/sysmouse +mouse action output +.El +.Sh SEE ALSO +.Xr vidcontrol 1 , +.Xr signal 3 , +.Xr moused 8 +.Sh HISTORY +The +.Nm +manual page example first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by John-Mark Gurney +.Aq gurney_j@efn.org . diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4 new file mode 100644 index 000000000000..e2e33a41bb41 --- /dev/null +++ b/share/man/man4/sysmouse.4 @@ -0,0 +1,142 @@ +.\" Copyright (c) 1997 +.\" John-Mark Gurney. 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 author nor the names of any co-contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney 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 AUTHOR 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. +.\" +.\" +.Dd February 14, 1997 +.Dt SYSMOUSE 4 +.Os +.Sh NAME +.Nm sysmouse +.Nd supplies mouse data from syscons for other applications +.Sh SYNOPSIS +.Fd #include <machine/console.h> +.Fd #include <sys/ioctl.h> +.Ft int +.Fn ioctl cfd CONS_MOUSECTL struct\ *mouse_info +.Sh DESCRIPTION +The +.Dv CONS_MOUSECTL +.Fn ioctl +call provides syscons with mouse information, which includes mouse movement +and button presses. The +.Fn ioctl +also provides a method for a process to receive a +.Xr signal 3 +when a button is pressed. +.Pp +.Xr moused 8 +uses this +.Fn ioctl +to inform the console of mouse actions. Applications +.Pq such as Tn X\ Windows +can use +.Pa /dev/sysmouse , +allowing syscons and the application to share the mouse. +.Pp +.Bd -literal -offset indent +struct mouse_info { + int operation; + union { + struct mouse_data data; + struct mouse_mode mode; + }u; +}; +.Ed +.Bl -tag -width operation +.It Dv operation +This can be one of +.Bl -tag -width MOUSE_MOVEABS +.It Dv MOUSE_SHOW +Enables and displays mouse cursor. +.It Dv MOUSE_HIDE +Disables and hides mouse cursor. +.It Dv MOUSE_MOVEABS +Moves mouse cursor to position supplied in +.Dv u.data . +.It Dv MOUSE_MOVEREL +Add position supplied in +.Dv u.data +to current position. +.It Dv MOUSE_GETINFO +Returns current mouse position and button status in +.Dv u.data . +.It Dv MOUSE_MODE +This sets the +.Xr signal 3 +to be delivered to the current process when a button is pressed. +The signal to be delivered is set in +.Dv u.mode . +.It Dv MOUSE_ACTION +This takes the information in +.Dv u.data +and acts upon it. It includes processing button presses if the current vty +is a text interface, and sending +.Tn Mouse System +protocol data to +.Pa /dev/sysmouse +if it is open. +.El +.It Dv u +This union is one of +.Bl -tag -width data +.It Dv data +.Bd -literal -offset indent +struct mouse_data { + int x; + int y; + int buttons; +}; +.Ed +.It Dv mode +.Bd -literal -offset indent +struct mouse_mode { + int mode; + int signal; +}; +.Ed +.El +.El +.Sh FILES +.Bl -tag -width /dev/consolectl -compact +.It Pa /dev/consolectl +device to control the console +.It Pa /dev/sysmouse +mouse action output +.El +.Sh SEE ALSO +.Xr vidcontrol 1 , +.Xr signal 3 , +.Xr moused 8 +.Sh HISTORY +The +.Nm +manual page example first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by John-Mark Gurney +.Aq gurney_j@efn.org . |