keylaunch-conf: Describe keylaunchrc format.

1 files changed, 23 insertions, 0 deletions

diff --git a/packages/keylaunch/keylaunch-conf/keylaunchrc b/packages/keylaunch/keylaunch-conf/keylaunchrc
index 0296db9dad..34b46cf55f 100644
--- a/packages/keylaunch/keylaunch-conf/keylaunchrc
+++ b/packages/keylaunch/keylaunch-conf/keylaunchrc
@@ -1,3 +1,26 @@
+# Format:
+# "key=" <ModState> [<Event>] <Keysym>+ ":" [ <Window> ":" ] <Command>
+# ModState: 
+#   "????" - any modifier (don't care)
+#   "...." - no modifer
+#   "*..." - Shift
+#   ".*.." - Control
+#   "..*." - Alt
+#   "...*" - AltGr
+#   Shift/Control/Alt/AltGr can be combined (e.g. ".**." == Control+Alt)
+# Event:
+#   <empty> - Normal keytouch (short keypress followed by release)
+#   Held - Long keytouch (pressed and held for some time)
+#   Special Events (use with care):
+#   Pressed - Key was just pressed (note: other events may match too, e.g. 
+#   normal/Held)
+#   Released - Key was just released (note: other events may match too)
+#   Combine - Several keys pressed together (note: other events may match too)
+# Keysym: One or more (for Combine only) X keysyms
+# Window: Ignored, do not use
+# Command: Command line to execute, if starts with ~, suppress X startup notification 
+#   (use for non-X apps).
+#
 key=????Pressed XF86AudioRecord:gpe-soundbite record --autogenerate-filename $HOME_VOLATILE
 key=????Pressed XF86Calendar:gpe-calendar
 key=????Pressed telephone:gpe-contacts