Add the manpages for ums and ukbd (USB mouse and keyboards)

5 files changed, 492 insertions, 2 deletions

diff --git a/share/man/man4/man4.i386/Makefile b/share/man/man4/man4.i386/Makefile
index 1866fab..d8b39a0 100644
--- a/share/man/man4/man4.i386/Makefile
+++ b/share/man/man4/man4.i386/Makefile
@@ -1,4 +1,4 @@
-#	$Id: Makefile,v 1.101 1999/03/11 14:10:31 yokota Exp $
+#	$Id: Makefile,v 1.102 1999/04/07 14:42:55 wpaul Exp $
 
 MAN4=	adv.4 adw.4 aha.4 ahb.4 ahc.4 aic.4 alpm.4 apm.4 ar.4 asc.4 atkbd.4 \
 	atkbdc.4 ax.4 bktr.4 bt.4 cs.4 cx.4 cy.4 de.4 \
@@ -8,7 +8,7 @@ MAN4=	adv.4 adw.4 aha.4 ahb.4 ahc.4 aic.4 alpm.4 apm.4 ar.4 asc.4 atkbd.4 \
 	ohci.4 pcf.4 pcm.4 pcvt.4 perfmon.4 pn.4 pnp.4 ppc.4 psm.4 \
 	rdp.4 rl.4 sb.4 scd.4 screen.4 si.4 sio.4 \
 	spkr.4 splash.4 sr.4 syscons.4 sysmouse.4 ti.4 tl.4 tw.4 tx.4 uhci.4 \
-	usb.4 vga.4 vr.4 vx.4 \
+	ukbd.4 ums.4 usb.4 vga.4 vr.4 vx.4 \
 	wb.4 wd.4 wfd.4 wl.4 wt.4 xl.4 ze.4 zp.4
 
 MLINKS=		adv.4 ../adv.4
@@ -83,6 +83,8 @@ MLINKS+=	tl.4 ../tl.4
 MLINKS+=	tw.4 ../tw.4
 MLINKS+=	tx.4 ../tx.4
 MLINKS+=	uhci.4 ../uhci.4
+MLINKS+=	ukbd.4 ../ukbd.4
+MLINKS+=	ums.4 ../ums.4
 MLINKS+=	usb.4 ../usb.4
 MLINKS+=	vga.4 ../vga.4
 MLINKS+=	vr.4 ../vr.4
diff --git a/share/man/man4/man4.i386/ukbd.4 b/share/man/man4/man4.i386/ukbd.4
new file mode 100644
index 0000000..04ad5e6
--- /dev/null
+++ b/share/man/man4/man4.i386/ukbd.4
@@ -0,0 +1,160 @@
+.\" Copyright (c) 1997, 1998
+.\"	Nick Hibma <hibma@skylink.it>. 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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by Bill Paul.
+.\" 4. 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 NICK HIBMA 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 NICK HIBMA OR THE VOICES IN HIS HEAD
+.\" 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.
+.\"
+.\"	$Id: usb.4,v 1.1 1999/02/21 16:56:33 n_hibma Exp $
+.\"
+.Dd April 11, 1999
+.Dt UKBD 4 i386
+.Os FreeBSD
+.Sh NAME
+.Nm ukbd
+.Nd USB keyboard driver
+.Sh SYNOPSIS
+.Cd "device ukbd0"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for keyboards that attach to the USB port.
+.Nm atkbdc ,
+.Nm usb
+and one of
+.Nm uhci
+or
+.Nm ohci
+must be configured in the kernel as well.
+.Sh CONFIGURATION
+By default the keyboard subsystem does not create the appropriate devices yet.
+Make sure you configure compile the kernel with the following option in the
+kernel config file:
+.Bd -literal -offset indent
+options "KBD_INSTALL_CDEV"
+.Ed
+.Pp
+Go to /dev and make device nodes kbd*:
+.Bd -literal -offset indent
+sh MAKEDEV kbd0 kbd1
+.Ed
+.Pp
+If both an AT keyboard as well as USB keyboards are used at the same time, the
+AT keyboard will appear as kbd0 /dev. The USB keyboards will be kbd1, kbd2,
+etc. You can see some information about the keyboard with the following command:
+.Bd -literal -offset indent
+kbdcontrol -i < /dev/kbd1 
+.Ed
+.Pp
+or load a keymap with
+.Bd -literal -offset indent
+kbdcontrol -l /usr/share/syscons/keymaps/pt.iso.kbd < /dev/kbd1
+.Ed
+.Pp
+See
+.Nm kbcontrol
+for more possible options.
+.Pp
+You can swap console keyboards by using the command
+.Bd -literal -offset indent
+kbdcontrol -k /dev/kbd1
+.Ed
+.Pp
+From this point on onwards the first USB keyboard will be the keyboard
+to be used as the console.
+.Pp
+If you want to use a USB keyboard as your default and not use an AT keyboard at
+all, you will have to remove the
+.Nm atkbd0
+from the kernel configuration file. Because of the order of the device 
+initialisation, the USB keyboard will be detected AFTER the console driver
+initialises itself and you have to explicitly tellthe console
+driver to use the existence of the USB keyboard.  This can be done in
+one of the following two ways.
+.Pp
+Run the following command as a part of system initialization:
+.Bd -literal -offset indent
+kbdcontrol -k /dev/kbd0 < /dev/ttyv0 > /dev/null
+.Ed
+.Pp
+(Note that as the USB keyboard is the only keyboard, it is accessed as
+/dev/kbd0) or otherwise tell the console driver to periodically look for a
+keyboard by setting a flag in the kernel configuration file:
+.Bd -literal -offset indent
+device sc0 at isa? tty flags 0x100
+.Ed
+.Pp
+With the above flag, the console driver will try to detect any
+keyboard in the system if it didn't detect one while it was
+initialized at boot time.
+.Sh DRIVER CONFIGURATION
+.Bd -literal -offset indent
+options "KBD_INSTALL_CDEV"
+.Ed
+.Pp
+Make the keyboards available through a character device in /dev
+.Bd -literal -offset indent
+options "UKBD_DFLT_KEYMAP"
+makeoptions "UKBD_DFLT_KEYMAP=fr.iso"
+.Ed
+.Pp
+The above lines will put the French ISO keymap in the atkbd driver.
+You can specify any keymap in /usr/share/syscons/keymaps with this
+option.
+.Bd -literal -offset indent
+options "KBD_DISABLE_KEYMAP_LOADING"
+.Ed
+.Pp
+Don't allow the user to change the keymap.  Note that this options
+also has effect on the AT keyboard driver `atkbd'.
+.Sh FILES
+.Bl -tag -width /dev/ukbd0 -compact
+.It Pa /dev/ukbd0
+blocking device node
+.Sh EXAMPLE
+.Bd -literal -offset indent
+device ukbd0
+.Ed
+.Pp
+Add the
+.Nm ukbd
+driver to the kernel.
+.Sh SEE ALSO
+.Xr uhci 4 ,
+.Xr ohci 4 ,
+.Xr usb 4 ,
+.Xr config 8 ,
+.Xr kbdcontrol 1 ,
+.Xr sysmouse 4
+.\".Sh HISTORY
+.Sh AUTHOR
+The
+.Nm ums
+driver was written by
+.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .
+.Pp
+This manual page was written by
+.An Nick Hibma Aq hibma@skylink.it .
diff --git a/share/man/man4/man4.i386/ums.4 b/share/man/man4/man4.i386/ums.4
new file mode 100644
index 0000000..d887c4c
--- /dev/null
+++ b/share/man/man4/man4.i386/ums.4
@@ -0,0 +1,84 @@
+.\" Copyright (c) 1999
+.\"	Nick Hibma <hibma@skylink.it>. 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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by Bill Paul.
+.\" 4. 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 NICK HIBMA 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 NICK HIBMA OR THE VOICES IN HIS HEAD
+.\" 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 April 11, 1999
+.Dt UMS 4 i386
+.Os FreeBSD
+.Sh NAME
+.Nm ums
+.Nd USB mouse driver
+.Sh SYNOPSIS
+.Cd "device ums0"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for mice that attach to the USB port. Supported are
+mice with any number of buttons and mice with a wheel.
+.Nm usb
+and one of
+.Nm uhci
+or
+.Nm ohci
+must be configured in the kernel as well.
+.Pp
+The /dev/ums device presents the mouse as a
+.Nm sysmouse
+type device, and can be used through
+.Nm moused
+(see example below).
+.Sh FILES
+.Bl -tag -width /dev/ums0 -compact
+.It Pa /dev/ums0
+blocking device node
+.Sh EXAMPLE
+.Dl device ums0
+.Pp
+Add the
+.Nm ums
+driver to the kernel.
+.Sh SEE ALSO
+.Xr uhci 4 ,
+.Xr ohci 4 ,
+.Xr usb 4 ,
+.Xr moused 8 ,
+.Xr sysmouse 4
+.\".Sh HISTORY
+.Sh AUTHOR
+The
+.Nm ums
+driver was written by
+.An Lennart Augustsson Aq augustss@cs.chalmers.se
+for NetBSD and was adapted for FreeBSD by
+.An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
+.Pp
+This manual page was written by
+.An Nick Hibma Aq hibma@skylink.it .
diff --git a/share/man/man4/ukbd.4 b/share/man/man4/ukbd.4
new file mode 100644
index 0000000..04ad5e6
--- /dev/null
+++ b/share/man/man4/ukbd.4
@@ -0,0 +1,160 @@
+.\" Copyright (c) 1997, 1998
+.\"	Nick Hibma <hibma@skylink.it>. 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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by Bill Paul.
+.\" 4. 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 NICK HIBMA 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 NICK HIBMA OR THE VOICES IN HIS HEAD
+.\" 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.
+.\"
+.\"	$Id: usb.4,v 1.1 1999/02/21 16:56:33 n_hibma Exp $
+.\"
+.Dd April 11, 1999
+.Dt UKBD 4 i386
+.Os FreeBSD
+.Sh NAME
+.Nm ukbd
+.Nd USB keyboard driver
+.Sh SYNOPSIS
+.Cd "device ukbd0"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for keyboards that attach to the USB port.
+.Nm atkbdc ,
+.Nm usb
+and one of
+.Nm uhci
+or
+.Nm ohci
+must be configured in the kernel as well.
+.Sh CONFIGURATION
+By default the keyboard subsystem does not create the appropriate devices yet.
+Make sure you configure compile the kernel with the following option in the
+kernel config file:
+.Bd -literal -offset indent
+options "KBD_INSTALL_CDEV"
+.Ed
+.Pp
+Go to /dev and make device nodes kbd*:
+.Bd -literal -offset indent
+sh MAKEDEV kbd0 kbd1
+.Ed
+.Pp
+If both an AT keyboard as well as USB keyboards are used at the same time, the
+AT keyboard will appear as kbd0 /dev. The USB keyboards will be kbd1, kbd2,
+etc. You can see some information about the keyboard with the following command:
+.Bd -literal -offset indent
+kbdcontrol -i < /dev/kbd1 
+.Ed
+.Pp
+or load a keymap with
+.Bd -literal -offset indent
+kbdcontrol -l /usr/share/syscons/keymaps/pt.iso.kbd < /dev/kbd1
+.Ed
+.Pp
+See
+.Nm kbcontrol
+for more possible options.
+.Pp
+You can swap console keyboards by using the command
+.Bd -literal -offset indent
+kbdcontrol -k /dev/kbd1
+.Ed
+.Pp
+From this point on onwards the first USB keyboard will be the keyboard
+to be used as the console.
+.Pp
+If you want to use a USB keyboard as your default and not use an AT keyboard at
+all, you will have to remove the
+.Nm atkbd0
+from the kernel configuration file. Because of the order of the device 
+initialisation, the USB keyboard will be detected AFTER the console driver
+initialises itself and you have to explicitly tellthe console
+driver to use the existence of the USB keyboard.  This can be done in
+one of the following two ways.
+.Pp
+Run the following command as a part of system initialization:
+.Bd -literal -offset indent
+kbdcontrol -k /dev/kbd0 < /dev/ttyv0 > /dev/null
+.Ed
+.Pp
+(Note that as the USB keyboard is the only keyboard, it is accessed as
+/dev/kbd0) or otherwise tell the console driver to periodically look for a
+keyboard by setting a flag in the kernel configuration file:
+.Bd -literal -offset indent
+device sc0 at isa? tty flags 0x100
+.Ed
+.Pp
+With the above flag, the console driver will try to detect any
+keyboard in the system if it didn't detect one while it was
+initialized at boot time.
+.Sh DRIVER CONFIGURATION
+.Bd -literal -offset indent
+options "KBD_INSTALL_CDEV"
+.Ed
+.Pp
+Make the keyboards available through a character device in /dev
+.Bd -literal -offset indent
+options "UKBD_DFLT_KEYMAP"
+makeoptions "UKBD_DFLT_KEYMAP=fr.iso"
+.Ed
+.Pp
+The above lines will put the French ISO keymap in the atkbd driver.
+You can specify any keymap in /usr/share/syscons/keymaps with this
+option.
+.Bd -literal -offset indent
+options "KBD_DISABLE_KEYMAP_LOADING"
+.Ed
+.Pp
+Don't allow the user to change the keymap.  Note that this options
+also has effect on the AT keyboard driver `atkbd'.
+.Sh FILES
+.Bl -tag -width /dev/ukbd0 -compact
+.It Pa /dev/ukbd0
+blocking device node
+.Sh EXAMPLE
+.Bd -literal -offset indent
+device ukbd0
+.Ed
+.Pp
+Add the
+.Nm ukbd
+driver to the kernel.
+.Sh SEE ALSO
+.Xr uhci 4 ,
+.Xr ohci 4 ,
+.Xr usb 4 ,
+.Xr config 8 ,
+.Xr kbdcontrol 1 ,
+.Xr sysmouse 4
+.\".Sh HISTORY
+.Sh AUTHOR
+The
+.Nm ums
+driver was written by
+.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .
+.Pp
+This manual page was written by
+.An Nick Hibma Aq hibma@skylink.it .
diff --git a/share/man/man4/ums.4 b/share/man/man4/ums.4
new file mode 100644
index 0000000..d887c4c
--- /dev/null
+++ b/share/man/man4/ums.4
@@ -0,0 +1,84 @@
+.\" Copyright (c) 1999
+.\"	Nick Hibma <hibma@skylink.it>. 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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by Bill Paul.
+.\" 4. 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 NICK HIBMA 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 NICK HIBMA OR THE VOICES IN HIS HEAD
+.\" 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 April 11, 1999
+.Dt UMS 4 i386
+.Os FreeBSD
+.Sh NAME
+.Nm ums
+.Nd USB mouse driver
+.Sh SYNOPSIS
+.Cd "device ums0"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for mice that attach to the USB port. Supported are
+mice with any number of buttons and mice with a wheel.
+.Nm usb
+and one of
+.Nm uhci
+or
+.Nm ohci
+must be configured in the kernel as well.
+.Pp
+The /dev/ums device presents the mouse as a
+.Nm sysmouse
+type device, and can be used through
+.Nm moused
+(see example below).
+.Sh FILES
+.Bl -tag -width /dev/ums0 -compact
+.It Pa /dev/ums0
+blocking device node
+.Sh EXAMPLE
+.Dl device ums0
+.Pp
+Add the
+.Nm ums
+driver to the kernel.
+.Sh SEE ALSO
+.Xr uhci 4 ,
+.Xr ohci 4 ,
+.Xr usb 4 ,
+.Xr moused 8 ,
+.Xr sysmouse 4
+.\".Sh HISTORY
+.Sh AUTHOR
+The
+.Nm ums
+driver was written by
+.An Lennart Augustsson Aq augustss@cs.chalmers.se
+for NetBSD and was adapted for FreeBSD by
+.An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
+.Pp
+This manual page was written by
+.An Nick Hibma Aq hibma@skylink.it .