Edited README file: added Troubleshooting section.

git-svn-id: https://logkeys.googlecode.com/svn/trunk@46 c501e62c-e7d1-11de-a198-37193048d1ed

README

@@ -6,7 +6,8 @@
   1. Description
   2. Installation
   3. Usage how-to
-  4. Further information
+  4. Troubleshooting
+  5. Further information
 
 ===============================================================================
 
@@ -64,12 +65,12 @@ package:
  bin/llk  , which is intended to start the logkeys daemon, and
  bin/llkk , which is intended to kill it.
  
-bin/llk runs etc/logkeys-start.sh, and bin/llkk rund etc/logkeys-kill.sh.
+bin/llk runs etc/logkeys-start.sh, and bin/llkk runs etc/logkeys-kill.sh.
 
-You can use these two setuid root programs for starting and stopping the 
-keylogger quickly and covertly. You can modify the .sh scripts as you like.
-As the programs are installed setuid, the root password need not be provided 
-at runtime.
+You can use these two setuid root programs (llk and llkk) for starting and
+stopping the keylogger quickly and covertly. You can modify the .sh scripts as
+you like. As the programs are installed setuid, the root password need not be
+provided at runtime.
 
 Default log file is /var/log/logkeys.log and is not readable by others.
 
@@ -97,24 +98,9 @@ or alternatively, you need en_US.UTF-8 locale available on your system
  en_US.UTF-8
  ...
 
-otherwise you will only see odd characters (like ꑶ) when pressing character
+otherwise you may only see odd characters (like ꑶ etc.) when pressing character
 keys.
 
-It is very likely that you will see only some characters recognized, without
-any hope for Shift and AltGr working even slightly correct, especially when
-starting logkeys in X. In that case it is better to switch to virtual terminal, 
-e.g. tty4 (Ctrl+Alt+F4), and there execute:
-
- $ logkeys --export-keymap my_lang.keymap
-
-Then open my_lang.keymap in UTF-8 enabled text editor and manually repair any
-missing or incorrectly determined mappings. From then on, execute logkeys by
-
- $ logkeys --start --keymap my_lang.keymap
-
-Again, see if it now works correctly (character keys appear correct when you
-are viewing the log file in editor), and opt to modify bin/llk starter script.
-
 logkeys acts as a daemon, and you stop the running logger process with
 
  $ logkeys --kill
@@ -128,17 +114,63 @@ command line arguments, read the application manual,
 
 or see the wiki at project website: http://code.google.com/p/logkeys/
 
+Abuse the output of this software wisely.
+
+
++------------------------------------------------
+ 4. Troubleshooting
+===============================================================================
+
+4.1 no output in the log file
+-------------------------------------------------
+After you run logkeys successfully, if you open the log file and see only the
+'Logging started...' and 'Logging stopped...' tag without any keypress
+"contents," it is very likely that logkeys got your device id wrong.
+
+The solution is to determine the correct event device id, and the run 
+logkeys with --device (-d) switch, specifying that device manually.
+
+The procedure for manually learning the device id to use is as follows:
+
+As root, for each device eventX in /dev/input/, where X is a number between 0
+and 31 inclusively, write:
+
+ $ cat /dev/input/eventX
+
+then type some arbitrary characters. If you see any output, that is the device
+to be used. If you don't see any output, press Ctrl+C and continue with the
+next device.
+
+If this happened to be your issue, *please* submit a bug report, attaching
+your /proc/bus/input/devices file, and specifying which was the correct id.
+
+
+4.2 logkeys outputs wrong characters:
+-------------------------------------------------
+It is very likely that you will see only some characters recognized, without
+any hope for Shift and AltGr working even slightly correct, especially when
+starting logkeys in X. In that case it is better to switch to virtual 
+terminal, e.g. tty4 (Ctrl+Alt+F4), and there execute:
+
+ $ logkeys --export-keymap my_lang.keymap
+
+Then open my_lang.keymap in UTF-8 enabled text editor and manually repair any
+missing or incorrectly determined mappings. From then on, execute logkeys by
+
+ $ logkeys --start --keymap my_lang.keymap
+
+Again, see if it now works correctly (character keys appear correct when you
+are viewing the log file in editor), and opt to modify bin/llk starter script.
+
 If you create full and completely valid keymap for your particular language,
 please upload it to website or send it to me by e-mail. Thanks.
 
-Abuse the output of this software wisely.
-
 
 +------------------------------------------------
- 4. Further information
+ 5. Further information
 ===============================================================================
 
-Read the man page.
+Read the man page. Please read the whole man page. Thanks. :-)
 
 Refer to troubleshooting and FAQ sections on the project website,