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    - Visual C++ Redistributable for Visual Studio 2015 (x86)\r
  15      <http://tinyurl.com/vc2015x86>\r
  16    - Visual C++ Redistributable for Visual Studio 2015 (x64)\r
  17      <http://tinyurl.com/vc2015x64>\r
  18 2. Extract the zip archive to an appropriate folder.\r
  19 \r
  20 Upgrade or Uninstall\r
  21 --------------------\r
  22 1. Disable the "Auto Run" option of XKeymacs.\r
  23 2. Reboot windows.\r
  24 \r
  25   On upgrade\r
  26 \r
  27 3. Overwrite the existing files with the files in the zip of new version.\r
  28 \r
  29 On uninstall\r
  30 \r
  31 3. Delete the directory containing XKeymacs.\r
  32 4. Run regedit and delete the following values:\r
  33 \r
  34         HKEY_CURRENT_USER\Software\oishi\XKeymacs\r
  35         HKEY_CURRENT_USER\Software\oishi\XKeymacs2\r
  36         HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\XKeymacs\r
  37 \r
  38 Usage\r
  39 -----\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 when XKeymacs is running.\r
  46 \r
  47 To exit XKeymacs, right-click the gold (or silver) key icon, and\r
  48 select Exit in the 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. The same\r
  56 configuration is shown by different formats in these tabs.  In Basic\r
  57 tab, you can configure whether or not each key combination works\r
  58 like Emacs. In Advanced tab, you can configure keys assignments for\r
  59 each command. In Lis tab, you can take a look at the configuration.\r
  60 \r
  61 ### Import and export properties\r
  62 \r
  63 Select "Import Properties...", you can import an exported file.\r
  64 Select "Export Properties...", you can export the configuration under the\r
  65 following registry key to a file. \r
  66 **These features do not currently work.**\r
  67 \r
  68     HKEY_CURRENT_USER\Software\Oishi\XKeymacs2\r
  69 \r
  70 ### Options\r
  71 \r
  72 Select "Options...", you can set whether or not:\r
  73 1. run XKeymacs when you logon Windows\r
  74 2. enable file completion on the Command Prompt\r
  75 3. display C-x-, Shift, Ctrl and Alt LED in the notification area\r
  76 \r
  77 ### Keyboard layout\r
  78 \r
  79 Select "Keyboard Layout...", you can modify the keyboard layout.\r
  80 Drag & drop a key from the base keyboard to the remapped keyboard.\r
  81 The dropped key turns red. You can cancel the remap by clicking the red key.\r
  82 **This feature does not currently work.**\r
  83 \r
  84 XKeymacs only uses the feature of remapping scan codes provided by Windows,\r
  85 so the remapping is not canceled after you disable or uninstall XKeymacs.\r
  86 If you want to cancel remmapping without XKeymacs, delete the following\r
  87 value by regedit.\r
  88 \r
  89     HKEY_CURRENT_USER\Keyboard Layout\Scancode Map\r
  90     HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Keyboard Layout\Scancode Map\r
  91 \r
  92 ### Others\r
  93 \r
  94 Select "Disable" or "Enable" in the right-click menu when you\r
  95 disable or enable XKeymacs. You can toggle with C-q, too. Select\r
  96 "Reset" when XKeymacs becomes not effective by some chance.\r
  97 \r
  98 Support\r
  99 -------\r
 100 Web site\r
 101 <http://xkeymacs.osdn.jp/>\r
 102 \r
 103 Mailing list\r
 104 <https://lists.osdn.me/mailman/listinfo/xkeymacs-users-en>\r
 105 \r
 106 Copyright\r
 107 ---------\r
 108 Oishi-san <oishi@cam.hi-ho.ne.jp> owns the copyright of the code\r
 109 derived from XKeymacs 3.48.\r
 110 The following developers have the copyrights of their contributions.\r
 111 \r
 112 * Kazuhiro Fujieda <fujieda@users.osdn.me>\r
 113 * Tomohiro Kashiwada <kikairoya@gmail.com>\r
 114 * Harold Bamford <hbamford@users.sourceforge.net>\r
 115 * co <cogood@gmail.com>\r
 116 \r
 117 License\r
 118 -------\r
 119 This program is free software; you can redistribute it and/or\r
 120 modify it under the terms of the GNU General Public License\r
 121 as published by the Free Software Foundation; either version 2\r
 122 of the License, or (at your option) any later version.\r
 123 \r
 124 This program is distributed in the hope that it will be useful,\r
 125 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 126 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 127 GNU General Public License on the followwing URL for more details.\r
 128 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>\r
 129 \r
 130 Acknowledgments\r
 131 ----------------\r
 132 We thank Noguchi-san for creating Keymacs of the origin of XKeymacs,\r
 133 Timothy-san for helping to write documentations, Hamada-san for\r
 134 writing classes to save any data in kill-ring, and XKeymacs mailing\r
 135 list members for suggesting new functions, reporting many defects,\r
 136 and creating patches.\r
 137 \r
 138 We thank Oishi-san for creating XKeymacs and continuing to develop\r
 139 it for long years.\r
 140 \r
 141 ---\r
 142 Kazuhiro Fujieda <fujieda@users.osdn.me>\r