| 1 | .\" Hey, EMACS: -*- nroff -*- |
|---|
| 2 | .\" First parameter, NAME, should be all caps |
|---|
| 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
|---|
| 4 | .\" other parameters are allowed: see man(7), man(1) |
|---|
| 5 | .TH WMINPUT 1 "janvier 18, 2007" |
|---|
| 6 | .\" Please adjust this date whenever revising the manpage. |
|---|
| 7 | .\" |
|---|
| 8 | .\" Some roff macros, for reference: |
|---|
| 9 | .\" .nh disable hyphenation |
|---|
| 10 | .\" .hy enable hyphenation |
|---|
| 11 | .\" .ad l left justify |
|---|
| 12 | .\" .ad b justify to both left and right margins |
|---|
| 13 | .\" .nf disable filling |
|---|
| 14 | .\" .fi enable filling |
|---|
| 15 | .\" .br insert line break |
|---|
| 16 | .\" .sp <n> insert n+1 empty lines |
|---|
| 17 | .\" for manpage-specific macros, see man(7) |
|---|
| 18 | .SH NAME |
|---|
| 19 | wminput \- an event driver for the wiimote |
|---|
| 20 | .SH SYNOPSIS |
|---|
| 21 | .B wminput |
|---|
| 22 | .RI [ options ] |
|---|
| 23 | .br |
|---|
| 24 | .SH DESCRIPTION |
|---|
| 25 | This manual page documents briefly the |
|---|
| 26 | .B wminput |
|---|
| 27 | command. |
|---|
| 28 | .PP |
|---|
| 29 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and |
|---|
| 30 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
|---|
| 31 | .\" respectively. |
|---|
| 32 | \fBwminput\fP is a program that provides an event driver for the wiimote, supporting all buttons (except Power) and pointer tracking, and featuring a tracking algorithm plugin architecture. |
|---|
| 33 | .PP |
|---|
| 34 | Your kernel must be configured with uinput support (INPUT_UINPUT, or Device Drivers/Input Device Support/Miscellaneous Drivers/User Level Driver Support under menuconfig). Compile into the kernel or as a module. See http://gentoo-wiki.com/HOWTO_Compile_a_Kernel_Manually for information on kernel compilation. |
|---|
| 35 | By default, some (most? all?) udev configurations set up a uinput device file readable only by root. Using wminput as a user other than root requires configuration udev to change the permissions on uinput. Place the following line in a file in /etc/udev/rules.d (see the documentation for your distro for the recommended file for local rules) to allow anyone on the system to use uinput: |
|---|
| 36 | .PP |
|---|
| 37 | KERNEL=="uinput", MODE="0666" |
|---|
| 38 | .PP |
|---|
| 39 | A more secure method uses the following line to allow anyone in <group> to use wminput, and adds only the desired users to <group>: |
|---|
| 40 | .PP |
|---|
| 41 | KERNEL=="uinput", GROUP="<group>" |
|---|
| 42 | .PP |
|---|
| 43 | A uinput group can be created specifically for this purpose, or another existing group such as wheel can be used. |
|---|
| 44 | .PP |
|---|
| 45 | See usr/share/doc/wminput/wminput.conf.sample for an example wminput configuration file. Copy this file to ~/.CWiid/wminput.conf and change as desired. |
|---|
| 46 | .PP |
|---|
| 47 | Getting X to recognize non-standard key symbols, and mapping actions to those symbols, is not automatic. An excellent tutorial at http://gentoo-wiki.com/HOWTO_Use_Multimedia_Keys can help you set this up. An overview of the process (see the HOWTO for more information): |
|---|
| 48 | .br |
|---|
| 49 | 1.Edit ~/.CWiid/wminput.conf |
|---|
| 50 | .br |
|---|
| 51 | 2.Use xev, wminput, and your wiimote to find out if the key symbols are already mapped, and find the key codes if they are not. |
|---|
| 52 | .br |
|---|
| 53 | 3.If the codes are not mapped to the appropriate symbols, edit ~/.Xmodmap, and use xmodmap to map them. (A copy of my ~/.Xmodmap is included in CWiid/doc) |
|---|
| 54 | .br |
|---|
| 55 | 4.Use xbindkeys or a window manager-specific utility to map the key symbols to specific actions. |
|---|
| 56 | .PP |
|---|
| 57 | wminput tracking plugins are, by default, installed to /usr/lib/CWiid/plugins. Plugins may also be placed in ~/.CWiid/plugins, and plugins placed here will take precedence. |
|---|
| 58 | |
|---|
| 59 | .SH OPTIONS |
|---|
| 60 | .TP |
|---|
| 61 | .B \-h |
|---|
| 62 | Show summary of options. |
|---|
| 63 | .TP |
|---|
| 64 | .B \-c config |
|---|
| 65 | Specify the configuration file to load. |
|---|
| 66 | .TP |
|---|
| 67 | .B bdaddr |
|---|
| 68 | Specify the wiimote bluetooth address. The bluetooth device address (bdaddr) of the wiimote can be specified on the command-line, or through the WIIMOTE_BDADDR environment variable, in the that order of precedence. If neither is given, the first wiimote found by hci_inquiry will be used. |
|---|
| 69 | |
|---|
| 70 | .SH SEE ALSO |
|---|
| 71 | .BR mwgui (1), |
|---|
| 72 | .br |
|---|
| 73 | .SH AUTHOR |
|---|
| 74 | wminput was written by L. Donnie Smith <wiimote@abstrakraft.org> |
|---|
| 75 | .PP |
|---|
| 76 | This manual page was written by Romain Beauxis <toots@rastageeks.org>, |
|---|
| 77 | for the Debian project (but may be used by others). |
|---|
