fixed man pag typo
[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
13 This program also does not require alsa, mpd, mpc, pianobar or notify-send. This is because all events are controlled through easily editable shell scripts and can be adapted to any sound or music program that you use.
14 .SH EXAMPLE
15 This program can be easily called with `powermate`, and is recommended to be launched with your login or X start.
16 .SH FILES
17 .I /usr/bin/powermate
18 .RS
19 This executable file controls your powermate.
20 .RE
21
22 .I /usr/bin/{volume-up,volume-down,volume-toggle,back,next}
23 .RS
24 These shell scripts are called by powermate when an event occurs.
25 .RE
26
27 .I /usr/bin/pianobar-{next,toggle}
28 .RS
29 These shell scripts control pianobar through the standard ctl fifo.
30 .RE
31
32 .I /lib/udev/rules.d/99-powermate.rules
33 .RS
34 This udev rule sets all /dev/input/event* files to group input and 660 permissions.
35 .RE
36
37 .I /usr/share/man/man1/powermate.1.gz
38 .RS
39 This man page.
40 .RE
41
42 .SH AUTHOR
43 Dylan Lloyd <dylan@dylansserver.com>