OSDN Git Service

Add original documents and dot.xkeymacs.
[xkeymacs/xkeymacs.git] / doc / spec.txt
1 ======================================================================\r
2  XKeymacs - Keyboard Utility for Windows\r
3 ======================================================================\r
4 \r
5 --- Specification ---\r
6 \r
7 Files\r
8 find-file [C-x C-f: Open...]\r
9         Open a file.\r
10 kill-buffer [C-x k: Close]\r
11         Close the current file.\r
12 save-buffer [C-x C-s: Save]\r
13         Save current file if modified.\r
14 write-file [C-x C-w: Save As...]\r
15         Save current buffer into file FILENAME.\r
16 \r
17 Incremental Search\r
18 isearch-backward [C-r: search backward]\r
19         Do incremental search backward.\r
20 isearch-forward [C-s: search forward]\r
21         Do incremental search forward.\r
22 query-replace [M-%: Replace...]\r
23         Replace some occurrences of FROM-STRING with TO-STRING.\r
24 query-replace-regexp [C-M-%: Replace...]\r
25         Replace some things after point matching REGEXP with TO-STRING.\r
26 \r
27 Leaving Active Window\r
28 iconify-or-deiconify-frame [C-z: Minimize]\r
29         Minimize the selected window.\r
30 Roll-up/Unroll\r
31         Shows only the title bar of the window, as if it has been "rolled up".\r
32 save-buffers-kill-emacs [C-x C-c: Exit]\r
33         Exit the application.\r
34 \r
35 Error Recovery\r
36 keyboard-quit [C-g: keyboard-quit]\r
37         Cancel the inputting command.\r
38 undo [C-x u: Undo][C-/: Undo][C-_: Undo]\r
39         Undo some previous changes.\r
40 \r
41 Motion\r
42 backward-char [C-b: Left]\r
43         Move point left N characters (right if N is negative).\r
44 backward-word [M-b: previous word]\r
45         Move backward until encountering the end of a word.\r
46 beginning-of-buffer [M-<: go to buffer beginning]\r
47         Move point to the beginning of the buffer; leave mark at previous position.\r
48 beginning-of-line [C-a: Home]\r
49         Move point to beginning of current line.\r
50 end-of-buffer [M->: go to buffer end]\r
51         Move point to the end of the buffer; leave mark at previous position.\r
52 end-of-line [C-e: End]\r
53         Move point to end of current line.\r
54 forward-char [C-f: Right]\r
55         Move point right N characters (left if N is negative).\r
56 forward-word [M-f: next word]\r
57         Move point forward ARG words (backward if ARG is negative).\r
58 next-line [C-n: Down]\r
59         Move cursor vertically down ARG lines.\r
60 previous-line [C-p: Up]\r
61         Move cursor vertically up ARG lines.\r
62 recenter [C-l: recenter]\r
63         Center point in window and redisplay frame.\r
64 scroll-down [M-v: Page Up]\r
65         Scroll text of current window down ARG lines; or near full screen if no ARG.\r
66 scroll-up [C-v: Page Down]\r
67         Scroll text of current window upward ARG lines; or near full screen if no ARG.\r
68 \r
69 Toggle Input Method Editor \r
70 Close Input Method\r
71         Close input method\r
72 Complete & Close Input Method\r
73         Set the composition string as the result string and close input method.\r
74 Complete & Toggle Input Method\r
75         Set the composition string as the result string and turn on or off a multilingual text input method for the current buffer.\r
76 Open Input Method\r
77         Open Input Method\r
78 Switch Between Input Locales\r
79         Switch Between Input Locales.\r
80 toggle-win32ime-mode [C-x C-j: SKK][C-o: Canna][C-\: Wnn][C-BACKSLASH of 106/109 keyboard: Wnn]\r
81         Turn on or off a multilingual text input method for the current buffer.\r
82 \r
83 Killing and Deleting\r
84 backward-kill-word [M-DEL]\r
85         Kill characters backward until encountering the end of a word.\r
86 delete-backward-char [C-h: Back space]\r
87         Delete the previous N characters (following if N is negative).\r
88 delete-char [C-d: Delete]\r
89         Delete the following N characters (previous if N is negative).\r
90 kill-line [C-k: kill-line]\r
91         Kill the rest of the current line; if no nonblanks there, kill thru newline.\r
92 kill-region [C-w: Cut]\r
93         Kill between point and mark.\r
94 kill-ring-save [M-w: Copy]\r
95         Save the region as if killed, but don't kill it.\r
96 kill-word [M-d: kill-word]\r
97         Kill characters forward until encountering the end of a word.\r
98 transpose-chars [C-t: transpose-chars]\r
99         Interchange characters around point, moving forward one character.\r
100 transpose-lines [C-x C-t]\r
101         Exchange current line and previous line, leaving point after both.\r
102 transpose-words [M-t]\r
103         Interchange words around point, leaving point after both words.\r
104 yank [C-y: Paste]\r
105         Reinsert the last stretch of killed text.\r
106 yank-pop [M-y: yank-pop]\r
107         Replace just-yanked stretch of killed text with a different stretch.\r
108 \r
109 One Shot Modifier\r
110 One Shot Modifier Alt\r
111 One Shot Modifier Alt with Repeat\r
112 One Shot Modifier Ctrl\r
113 One Shot Modifier Ctrl with Repeat\r
114 One Shot Modifier Shift\r
115 One Shot Modifier Shift with Repeat\r
116         A user presses any key '?' during depressing an assigned key to work as A-?/C-?/S-?.\r
117         A user releases an assigned key before pressing any key to work as original key.\r
118         With Repeat, a user keeps pressing an assigned key to work as original key.\r
119 \r
120 Other\r
121 _\r
122         _\r
123 `\r
124         `\r
125 ~\r
126         ~\r
127 C-\r
128         C-\r
129 call-last-kbd-macro [C-x e: call-last-kbd-macro]\r
130         Call the last keyboard macro that you defined with C-x (.\r
131 capitalize-word [M-c]\r
132         Capitalize the following word.\r
133 Copy\r
134         Copy\r
135 Cut\r
136         Cut\r
137 Cycle items\r
138         Cycle through items in the order they were opened.\r
139 Cycle items inversely\r
140         Cycle through items in the inverse order they were opened.\r
141 downcase-word [M-l]\r
142         Convert following word to lower case.\r
143 Enable or Disable XKeymacs [C-q: Enable/Disable XKeymacs]\r
144         Enable or disable XKeymacs\r
145 end-kbd-macro [C-x ): end-kbd-macro]\r
146         Finish defining a keyboard macro.\r
147 Esc\r
148         Esc\r
149 execute-extended-command\r
150         Invoking commands by their names.\r
151 Find\r
152         Find...\r
153 Find Next\r
154         Find Next\r
155 Ignore\r
156         Ignore\r
157 mark-page [C-x C-p: mark-page]\r
158         Put mark at end of page, point at beginning.\r
159 mark-whole-buffer [C-x h: mark-whole-buffer]\r
160         Put point at beginning and mark at end of buffer.\r
161 Maximize\r
162         Maximize the window.\r
163 Maximize Horizontally\r
164         Maximize the window horizontally.\r
165 Maximize Vertically\r
166         Maximize the window vertically.\r
167 Meta [C-[: Meta]\r
168         Prefix for typing Meta.\r
169 Meta for Alt [Left Alt: Meta][Right Alt: Meta] (Windows NT, 2000, XP)\r
170 Meta for Alt [Alt: Meta] (Windows 95, 98, Me)\r
171         Meta\r
172 Meta for Escape [ESC: Meta]\r
173         Assigned key works as not only original key but also prefix for typing Meta.\r
174 Minimize\r
175         Minimize the window.\r
176 Move\r
177         Move the window.\r
178 New\r
179         New\r
180 newline [C-m: Enter]\r
181         Enter\r
182 numeric argument [C-0...9: digit-argument]\r
183 open-line [C-o: open-line]\r
184         Insert a newline and leave point before it.\r
185 Pass Through\r
186         If the key assigned this command is depressed, XKeymacs does nothing for any input.\r
187 Paste\r
188         Paste\r
189 Print\r
190         Print...\r
191 Redo\r
192         Redo\r
193 Restore\r
194         Restore the window.\r
195 Retop\r
196         Top point in window and redisplay frame.\r
197 Select All\r
198         Select All\r
199 set-mark-command [C-Space: set-mark-command]\r
200         Set mark at where point is, or jump to mark.\r
201 shell-command [M-!: Command Prompt]\r
202         Execute string COMMAND in inferior shell; display output, if any.\r
203 Size\r
204         Change the size the window.\r
205 start-kbd-macro [C-x (: start-kbd-macro]\r
206         Record subsequent keyboard input, defining a keyboard macro.\r
207 switch-to-buffer [C-x b: switch-to-buffer]\r
208         Display next tabbed page or child window (MDI).\r
209 tab-to-tab-stop [C-i: Tab][M-i: Tab]\r
210         Insert spaces or tabs to next defined tab-stop column.\r
211 Temporarily Disable XKeymacs\r
212         XKeymacs does nothing for the next command.\r
213 universal-argument [C-u: universal-argument]\r
214         Begin a numeric argument for the following command.\r
215 upcase-word [M-u]\r
216         Convert following word to upper case.\r
217 \r
218 Original Command\r
219 Some commands which are defined in a dot.xkeymacs file.\r
220 You have to put the file in etc directory which is in the same directory of xkeymacs.exe or\r
221 %APPDATA% (C:\Documents and Settings\username\Application Data).\r
222 \r
223 Auto Run\r
224 Save the path of XKeymacs as "XKeymacs" in the next place.\r
225 HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\r
226 \r
227 Automatic completion (for Windows NT, 2000, XP)\r
228 Set "CompletionChar" in the next place 0x09.\r
229 HKEY_CURRENT_USER\Software\Microsoft\Command Processor\r
230 \r
231 Taskbar's Status Area\r
232 C-x-: LED become green after pressing ^X.\r
233 Meta: LED become green after pressing C-[ or Esc.\r
234 Shift: LED become green when the Shift key is depressed logically.\r
235 Ctrl: LED become green when the Ctrl key is depressed logically.\r
236 Alt: LED become green when the Alt key is depressed logically.\r
237 \r
238 Keyboard Layout\r
239 --- Windows NT, 2000, XP ---\r
240 Create "Scancode Map" in the next places.\r
241 For the user who is currently logged on:\r
242 HKEY_CURRENT_USER\Keyboard Layout\r
243 For any user:\r
244 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Keyboard Layout\r
245 See:\r
246 http://www.microsoft.com/HWDEV/input/W2kscan-map.htm\r
247 \r
248 --- Windows 95, 98, Me ---\r
249 XKeymacs does not support keyboard remapping for Windows 95, 98 or Me.\r
250 "Windows 95 Keyboard Remap" of "The Windows 95 Kernel PowerToys"\r
251 is required to remap keyboard on Windows 95, 98 or Me.\r
252 You can get "The Windows 95 Kernel PowerToys" from the site.\r
253 http://www.microsoft.com/windows95/downloads/contents/WUToys/W95KernelToy/Default.asp\r
254 Use "The Windows 95 Kernel PowerToys" at your own risk.\r
255 In my case, "Windows 95 Keyboard Remap" works well on Windows 98 Japanese Edition,\r
256 but the above site said:\r
257 ---\r
258 NOTE: This download is not intended for use on computers running Microsoft Windows 98.\r
259 ---\r
260 \r
261 \r
262 - ---\r
263 oishi@cam.hi-ho.ne.jp\r