added example, notes and files to man page
[powermate.git] / powermate.1
1 .TH powermate 1 "MARCH 2012" Linux "User Manual"
2 .SH NAME
3 powermate \- control alsa/mpd/pianobar with a griffin powermate
4 .SH SYNOPSIS
5 powermate uses the haskell-powermate bindings to control Alsa, MPD and Pianobar with a Griffin PowerMate, supporting long presses and twist motions.
6 .SH DESCRIPTION
7 Controls volume and LED brightness with a left or right turn (down, up respectively).
8 Skips to next MPD/Pianobar track with a press and twist (turn right immediately after pressing).
9 Mutes with a long press (> 1 second).
10 .SH NOTES
11 This program needs read and write access to /dev/input/event*. It acquires this with a udev rule matching all /dev/input/event* files and assigning them to group input with 660 permissions. To use the program you must be a member of group input. Use `sudo gpasswd -a $(whoami) input` to add yourself to this group, and cycle your login for this to take affect.
12 .SH EXAMPLE
13 This program can be easily called with `powermate`, and is recommended to be launched with your login or X start.
14 .SH FILES
15 .I /usr/bin/powermate
16 .RS
17 This executable file controls your powermate.
18 .RE
19
20 .I /lib/udev/rules.d/99-powermate.rules
21 .RS
22 This udev rule sets all /dev/input/event* files to group input and 660 permissions.
23 .RE
24
25 .I /usr/share/man/man1/powermate.1.gz
26 .RS
27 This man page.
28 .RE
29
30 .SH AUTHOR
31 Dylan Lloyd <dylan@dylansserver.com>