Readme.txt

   1  XKeymacs - Keyboard Utility for Windows\r
   2 ========================================\r
   3 \r
   4 About\r
   5 -----\r
   6 XKeymacs provides key bindings like Emacs for applications running\r
   7 on Microsoft Windows. You can also configure bindings for each\r
   8 application.\r
   9 \r
  10 Install\r
  11 -------\r
  12 1. Install the following runtime libraries. The latter is necessary\r
  13    only on 64bit versions of Windows.\r
  14    - Microsoft Visual C++ 2010 Redistributable Package (x86)\r
  15      <http://tinyurl.com/vc2010x86>\r
  16    - Microsoft Visual C++ 2010 Redistributable Package (x64)\r
  17      <http://tinyurl.com/vc2010x64>\r
  18 2. Get a zip file from the following site.\r
  19    <http://sourceforge.jp/projects/xkeymacs/releases/>\r
  20 3. Extract a directory containing XKeymacs from the zip file.\r
  21 4. Move the directory in an appropriate directory.\r
  22 5. Run xkeymacs.exe in the directory.\r
  23 \r
  24 Upgrade or Uninstall\r
  25 --------------------\r
  26 1. Disable the "Auto Run" option of XKeymacs.\r
  27 2. Exit XKeymacs as mentioned below.\r
  28 3. Logoff or reboot windows.\r
  29 \r
  30    If you want to upgrade XKeymacs, you can follow the install instruction.\r
  31 \r
  32 4. Delete the directory containing XKeymacs.\r
  33 5. Run regedit and delete the following values:\r
  34 \r
  35         HKEY_CURRENT_USER\Software\oishi\XKeymacs\r
  36         HKEY_CURRENT_USER\Software\oishi\XKeymacs2\r
  37         HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\XKeymacs\r
  38 \r
  39 Usage\r
  40 -----\r
  41 ### Run and exit\r
  42 \r
  43 Run xkeymacs.exe. It automatically run xkeymacs64.exe on 64bit\r
  44 versions of Windows. The gold key icon appears in the notification\r
  45 area of the taskbar when XKeymacs is running.\r
  46 \r
  47 Right-click the gold (or silver) key icon, and select Exit from the\r
  48 pop up menu.\r
  49 \r
  50 ### Properties\r
  51 \r
  52 Right-click the gold key icon and select "Properties...", you can\r
  53 set key assigns per application.\r
  54 \r
  55 Properties dialog has three tabs: Basic, Advanced and List tab.\r
  56 The same configuration is shown by a different format in each tab.\r
  57 In Basic tab, you can configure whether or not each key combination\r
  58 works like Emacs. In Advanced tab, you can configure keys\r
  59 assignments for each command. In Lis tab, you can take a look at the\r
  60 configuration.\r
  61 \r
  62 ### Import and export properties\r
  63 \r
  64 Select "Import Properties...", you can import an exported file.\r
  65 Select "Export Properties...", you can export the configuration under the\r
  66 following registry key to a file. \r
  67 **These features do not currently work on Windows 7.**\r
  68 \r
  69     HKEY_CURRENT_USER\Software\Oishi\XKeymacs2\r
  70 \r
  71 ### Options\r
  72 \r
  73 Select "Options...", you can set whether or not:\r
  74 1. run XKeymacs when you logon Windows.\r
  75 2. enable file completion on the Command Prompt.\r
  76 3. display C-x-, Shift, Ctrl and Alt LED in the notification area.\r
  77 \r
  78 ### Keyboard layout\r
  79 \r
  80 Select "Keyboard Layout...", you can modify the keyboard layout.\r
  81 Drag & drop a key from the base keyboard to the remapped keyboard.\r
  82 The dropped key turns red. You can cancel the remap by clicking the red key.\r
  83 **This feature does not currently work on Windows 7.**\r
  84 \r
  85 XKeymacs only uses the feature of remapping scan codes provided by Windows,\r
  86 so the remapping is not canceled after you disable or uninstall XKeymacs.\r
  87 If you want to cancel remmapping without XKeymacs, delete the following\r
  88 value by regedit.\r
  89 \r
  90     HKEY_CURRENT_USER\Keyboard Layout\Scancode Map\r
  91     HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Keyboard Layout\Scancode Map\r
  92 \r
  93 Support\r
  94 -------\r
  95 Web site\r
  96 <http://xkeymacs.sourceforge.jp/>\r
  97 \r
  98 Mailing list\r
  99 <http://lists.sourceforge.jp/mailman/listinfo/xkeymacs-users-en>\r
 100 \r
 101 Copyright\r
 102 ---------\r
 103 Oishi-san <oishi@cam.hi-ho.ne.jp> owns the copyright of the code\r
 104 derived from XKeymacs 3.48.\r
 105 The following developers have the copyrights of their contributions.\r
 106 \r
 107 * Kazuhiro Fujieda <fujieda@users.sourceforge.jp>\r
 108 * Tomohiro Kashiwada <kikairoya@gmail.com>\r
 109 * Harold Bamford <hbamford@users.sourceforge.net>\r
 110 \r
 111 License\r
 112 -------\r
 113 This program is free software; you can redistribute it and/or\r
 114 modify it under the terms of the GNU General Public License\r
 115 as published by the Free Software Foundation; either version 2\r
 116 of the License, or (at your option) any later version.\r
 117 \r
 118 This program is distributed in the hope that it will be useful,\r
 119 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 120 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 121 GNU General Public License on the followwing URL for more details.\r
 122 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>\r
 123 \r
 124 Acknowledgments\r
 125 ----------------\r
 126 We thank Noguchi-san for creating Keymacs of the origin of XKeymacs,\r
 127 Timothy-san for helping to write documentations, Hamada-san for\r
 128 writing classes to save any data in kill-ring, and XKeymacs mailing\r
 129 list members for suggesting new functions, reporting many defects,\r
 130 and creating patches.\r
 131 \r
 132 We thank Oishi-san for creating XKeymacs and continuing to develop\r
 133 it for long years.\r
 134 \r
 135 ---\r
 136 Kazuhiro Fujieda <fujieda@users.sourceforge.jp>\r