X-Git-Url: https://disinclined.org/git/?a=blobdiff_plain;f=powermate.1;h=7460f917a1b07c2afac11abf5220ac1dfb46e42a;hb=4c88e2ee8c65b7d061cfda8e45a3a832fd5c4d20;hp=74ef36d0b20f3510ae18d93875bace2d5b65893c;hpb=99da2e0818bc08c0a01909b01b5c49fdd2dece64;p=powermate.git

diff --git a/powermate.1 b/powermate.1
index 74ef36d..7460f91 100644
--- a/powermate.1
+++ b/powermate.1
@@ -6,10 +6,38 @@ powermate uses the haskell-powermate bindings to control Alsa, MPD and Pianobar
 .SH DESCRIPTION
 Controls volume and LED brightness with a left or right turn (down, up respectively).
 Skips to next MPD/Pianobar track with a press and twist (turn right immediately after pressing).
-Mutes with a long press ( > 1 second).
+Mutes with a long press (> 1 second).
+.SH NOTES
+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.
+
+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.
+.SH EXAMPLE
+This program can be easily called with `powermate`, and is recommended to be launched with your login or X start.
 .SH FILES
 .I /usr/bin/powermate
 .RS
-Must be executed with /dev/input/* privileges.
+This executable file controls your powermate.
+.RE
+
+.I /usr/bin/{volume-up,volume-down,volume-toggle,back,next}
+.RS
+These shell scripts are called by powermate when an event occurs.
+.RE
+
+.I /usr/bin/pianobar-{next,toggle}
+.RS
+These shell scripts control pianobar through the standard ctl fifo.
+.RE
+
+.I /lib/udev/rules.d/99-powermate.rules
+.RS
+This udev rule sets all /dev/input/event* files to group input and 660 permissions.
+.RE
+
+.I /usr/share/man/man1/powermate.1.gz
+.RS
+This man page.
+.RE
+
 .SH AUTHOR
 Dylan Lloyd <dylan@dylansserver.com>