1xvkbd(1) General Commands Manual xvkbd(1)
2
3
4
6 xvkbd - virtual keyboard for X window system
7
8
10 xvkbd is a virtual (graphical) keyboard program for X Window System
11 which provides a facility to enter characters onto other clients (soft‐
12 ware) by clicking on a keyboard displayed on the screen. This may be
13 used for systems without a hardware keyboard such as kiosk terminals or
14 handheld devices. This program also has a facility to send characters
15 specified as the command line option to another client.
16
17 The standard keyboard layout is based on the traditional US layout, but
18 some other keyboard layout (see "Screenshot") are also supported. The
19 default window size may be too large for systems with small screen, but
20 it can be configured to use smaller space (220x90 pixels, for example).
21 For details, see also "Screenshot" and "How to Customize xvkbd" below,
22 and resouce files in the distribution.
23
24 xvkbd version 2.1 and later support word completion and xvkbd version
25 4.0 and later will now learns the used words for word completion ,
26 which may make it easier to enter long words with xvkbd.
27
28 IMPORTANT NOTE: When invoking xvkbd from display managers such as XDM,
29 GDM, etc., always use xvkbd with -secure option or you will have seri‐
30 ous security risk.
31
32
34 xvkbd will work on X11R5 or X11R6. It is tested on redhat Linux and
35 Solaris, and it will work also on most UNIX-like systems.
36
37 This program uses Xaw (use of Xaw3d is recommended) and no special li‐
38 brary is required.
39
40
42 Input Keys
43 When xvkbd is started, the image of a keyboard will be displayed on the
44 screen. Clicking any key on the xvkbd window will send the character
45 to the focused window as if the key had been actually typed with the
46 hardware keyboard.
47
48 If you want to input upper-case alphabets or other characters on the
49 upper position on the keyboard, you should click the key after select‐
50 ing Shift by clicking it, or click the key with mouse button 3 (maybe
51 right button) or mouse button 4. In the similar manner, if you want to
52 input Controled characters, you should click the key after clicking
53 Control, or click the key with mouse button 2 (maybe middle button).
54 Alt and Meta can be used in the similar manner with Control, but there
55 are no shortcuts with mouse buttons.
56
57
58 ``Quick Modifiers''
59 xvkbd 2.5 and later support another way to input characters with modi‐
60 fiers such as Shift, Control, AltGr, etc., which may be useful espe‐
61 cially for machines with touch panels such as PDAs - we would call it
62 "Quick Modifiers".
63
64 Quick Modifiers can be enabled/disabled by the ``Enable "Quick Modi‐
65 fiers?'' entry on the property panel. If Quick Modifiers is enabled,
66 it will be activated by pressing a key on the xvkbd window, move the
67 pointer outside of the key, and then release the mouse button or equiv‐
68 alent.
69
70 The direction of the pointer motion will select the modifier:
71
72 up - Shift
73 right - AltGr
74 right-up - Shift AltGr
75 left - Control
76 left-up - Shift Control
77 down - Meta
78 left-down - Alt
79
80
81
82 Setting Input Focus
83 If you are using a window manager and clients where you can set input
84 focus by clicking mouse button on the window (and you don't have to
85 keep pointer in the window after that), you can simply set input focus
86 in the normal way and then click keys on the xvkbd window - the charac‐
87 ter will be sent to the selected position.
88
89 If you are using a window manager or clients where you must keep the
90 pointer in the input field to input from the keyboard, or if the input
91 focus is switched to the xvkbd window when you clicked on the key on
92 the xvkbd window, you must make xvkbd to set input focus explicitly by
93 clicking the Focus button on the xvkbd window and then click on the in‐
94 put field. This input focus can be cleared by clicking Focus button
95 with mouse button 3, or simply clicking Focus button twice.
96
97
98 Word Completion
99 Choosing ``Word Completion...'' in the main menu will popup the Word
100 Completion panel.
101
102 When you entered characters by clicked keys on the xvkbd window as
103 usual while the Word Completion panel open, words started with the
104 characters will be listed in the panel, and you can enter the remaining
105 characters of the selected word by clicking one of the words in the
106 list.
107
108 When ``Integrate Completion Panel?'' on the property panel is set on,
109 completion panel will be displayed on the main window when required.
110 .PP The dictionary (list of words) file is
111 /usr/share/xvkbd/words.english by default, but it can be changed with
112 Static Dictionary on the property panel.
113
114 In addition, xvkbd records the used words and those scores in
115 $HOME/.xvkbd.words.
116
117
118 Main Menu
119 Pressing the ``xvkbd'' logo on the main keyboard (placed near left-bot‐
120 tom corner in the default configuration) will popup the main menu.
121
122 The menu contains following items:
123
124 About...
125 Show short description of this program.
126
127 Manual...
128 Launch manual page reader.
129
130 Keypad...
131 Open the Keypad panel.
132
133 Sun Function Keys...
134 Open the Sun Function Keys panel.
135
136 Dead Keys...
137 Open the Dead Keys panel which can be used to enter Latin charac‐
138 ters with accent symbol in double stroke.
139
140 Word Completion...
141 Open the Word Completion panel.
142
143 Change Keyboard Layout...
144 Open a popup window to change the keyboard layout. In the default
145 configuration, Default (US), Belgian, Danish, French, German, Ice‐
146 landic, Italian, Japanese (JIS-X-6002), Japanese (JIS-X-6004), Ko‐
147 rean, Norwegian, Portuguese, Russian, Spanish, Swedish, Swiss/Ger‐
148 man, United Kingdom and Latin-1 are available.
149
150 Edit Function Keys...
151 Open a popup window to edit string assigned to function keys. See
152 also "Assigning Text to Function Keys".
153
154 Show Keypad?
155 Toggle show/hide of the keypad on the main window.
156
157 Show Function Keys?
158 Toggle show/hide of the function keys on the main window.
159
160 Property...
161 Popup the Property panel.
162
163 Connect to Remote Display...
164 Open a panel to specify the name of a remote display (in the mean‐
165 ing of the X Window System) to connect, so that following key
166 events will be sent to windows on the remote display.
167
168 Revert to Local Display
169 Disconnect from the remote display so that following key events
170 will be sent to windows on the local display.
171
172
173 Property Panel
174 Enable "Quick Modifiers"?
175 Toggle enable/disable of the Quick Modifiers feature.
176
177 Lock Shift?
178 Toggle locking/momentary of Shift keys.
179
180 Lock AltGr?
181 Toggle locking/momentary of AltGr key.
182
183 Lock Control, Alt and Meta?
184 Toggle locking/momentary of Control, Alt and Meta keys.
185
186 Always on Top?
187 If this entry is set ON, xvkbd attempts to keep the xvkbd window
188 always on the top of the display (i.e. not to be hidden by other
189 windows). This feature is experimental, and care should be taken
190 as this feature can cause problem in some situations.
191
192 Behave as Toolbar Window?
193 xvkbd attempts to be a toolbar window when it is used with some
194 kind of window managers such as Matchbox window manager.
195
196 Use XTEST Extension?
197 XTEST extension will be used if this entry is checked. If this en‐
198 try is set inactive, the X server does not support XTEST extension.
199
200 Jump Pointer?
201 If this entry is set ON, xvkbd will temporary jump the pointer to
202 the focused window, if XTEST extension is to be used to simulate
203 keyboard events.
204
205 Key-Click Sound
206 Set on/off and duration of key-click sound.
207
208 Automatic Click
209 Set on/off of the automatic click feature and the delay before au‐
210 tomatic click is activated. If this feature is set, xvkbd will
211 work as if left mouse button is clicked when mouse pointer is moved
212 on a button and stays long enough. You may want to set Jump
213 Pointer? to OFF to avoid auto-repeating.
214
215 Completion:
216
217 Static Dictionary
218 Set the filename to be used for word completion.
219 This setting take precedence over the `xvkbd.dictFile' resource
220 and the -dict option.
221 Default: /usr/share/xvkbd/words.english
222
223 Dynamic Dictionary Weight
224 This parameter controls "learning" of recently used words.
225 When this value is set 0, xvkbd will not learn used words.
226 With higher value setting, xvkbd will quickly
227 learn the used words and effectively ignores frequency informa‐
228 tion
229 in the Static Dictionary.
230 Default: 1.
231
232 Insert Blank after Completion?"
233 If this button is set on,
234 xvkbd will insert blank (' ') automatically after word comple‐
235 tion
236 if the next character is not blank nor punctuations.
237
238 Integrate Completion Panel?"
239 If this button is set on,
240 word completion panel will be inegrated at top of the main win‐
241 dow
242 and will be activated when required.
243
244
245 Options
246 xvkbd accept following command line options, in addition to general op‐
247 tions such as `-display'.
248
249 -version
250 Display version information and exit.
251
252 -xsendevent
253 Make xvkbd to use XSendEvent() to simulate keyboard events, as it
254 was in xvkbd version 1.0. xvkbd version 1.1 and later will try to
255 use XTEST extension instead in the default configuration. Because
256 it is not unusual applications to ignore keyboard events generated
257 with -xsendevent, you shouldn't use -xsendevent option unless it is
258 really required.
259 If XTEST extension is not supported by the X server, xvkbd will au‐
260 tomatically switch to this mode.
261 Resource `xvkbd.xtest: false' has the same function.
262
263 -no-sync
264 Normally, xvkbd attempts to synchronize with the destinating client
265 step by step. This can cause problem when the client (or the X
266 server) responded too slow. In such situation, maybe this -no-sync
267 can solve the problem.
268 Resource `xvkbd.noSync: true' has the same function.
269
270 -no-jump-pointer
271 Make xvkbd not to jump the pointer when sending events. In the de‐
272 fault, xvkbd will temporary jump the pointer to the focused window,
273 if input focus is set explicitly via Focus button, and XTEST exten‐
274 sion is to be used to simulate keyboard events.
275 Resource `xvkbd.jumpPointer: false' has the same function.
276
277 -no-back-pointer
278 Make xvkbd not to jump the pointer back to the original position
279 after events has been sent. Maybe this can be useful when using
280 xvkbd to move the pointer position.
281 Resource `xvkbd.jumpPointerBack: false' has the same function.
282
283 -modal
284 Make labels on keys in the xvkbd window to be set independently for
285 each of four shift states, not shifted, Shift, AltGr and Shift-
286 AltGr. This is useful when you want to make the xvkbd window very
287 small.
288 See also "Customizing Keyboard Layout" and resouce files in the
289 distribution.
290 Resource `xvkbd.modalKeytop: true' has the same function.
291
292 -geometry [widthxheight][+xoff+yoff]
293 Set window geometry (size and position).
294 You can use form like -geometry 400x130 to specify the window size,
295 -geometry +100+100 to specify the window position from left/top
296 edge of the screen, and -geometry 400x130+100+100 to specify both
297 the size and the position. You can specify position from
298 right/bottom edge of the screen by using - instead of +, but please
299 note that you must take account of size of the window border. (If
300 you specify `-geometry -0-0', the window will not fit in the
301 screen.)
302 This can be set by xvkbd.windowGeometry resource (note that it is
303 not xvkbd.geometry), too.
304
305 -no-resize
306 Disable resize of the xvkbd window.
307 Resource `xvkbd.resizable: false' has the same function.
308
309 -no-repeat
310 Do not auto-repeat even if key is depressed long time.
311 If auto-repeat is enabled (this is the default), time before start
312 auto-repeat can be set as `xvkbd*Repeater.initialDelay: 600', and
313 period of repeat can be set as `xvkbd*Repeater.minimumDelay: 100'
314 (unit of there parameters are milli-seconds).
315 Resource `xvkbd.autoRepeat: false' has the same function.
316
317 -no-functionkey
318 Do not display function keys.
319 Resource `xvkbd.functionkey: false' has the same function.
320
321 -no-keypad
322 Do not display keypad.
323 Resource `xvkbd.keypad: false' has the same function.
324
325 -compact
326 Do not display function keys nor keypad.
327 Resource `xvkbd.compact: true' has the same function.
328
329 -keypad
330 Display only keypad. This option will be ignored if `-no-keypad'
331 or `-compact' is specified.
332 Resource `xvkbd.keypadOnly: true' has the same function.
333
334 -text string
335 Send the string to the focused window (see also `-window' option).
336 If this option is specified, xvkbd will not open its window and
337 terminate soon after sending the string.
338 The string can contain:
339
340 - \r - Return
341
342 - \t - Tab
343
344 - \b - Backspace
345
346 - \e - Escape
347
348 - \d - Delete
349
350 - \S - Shift (modify the next character; please note that modify
351 with ``\S'' will be ignored in many cases. For example,
352 ``a\Cb\ScD\CE'' will be interpreted as a, Control-b, c, Shift-D,
353 and Control-Shift-E.)
354
355 - \C - Control (modify the next character)
356
357 - \A - Alt (modify the next character)
358
359 - \M - Meta (modify the next character)
360
361 - \W - Super (modify the next character)
362 .IP " - " 6 \[keysym] - the keysym keysym (e.g., \[Left]),
363 which will be processed in the similar matter with other general
364 characters
365
366 - \{keysym} - the keysym keysym (e.g., \{Left}), which will be pro‐
367 cessed in more primitive matter and can also be used for modofier
368 keys such as Control_L, Meta_L, etc.; also, \{+keysym} and
369 \{+keysym} will simulate press and release of the key, respec‐
370 tively
371
372 - \Ddigit - delay digit * 100 ms
373
374 - \xvalue - move mouse pointer (use "+" or "-" for relative motion)
375
376 - \yvalue - move mouse pointer (use "+" or "-" for relative motion)
377
378 - \mdigit - simulate click of the specified mouse button
379
380 -file filename
381 Send the contents of the specified file to the focused window (see
382 also `-window' option). If ``-'' was specified as the filename,
383 string to be sent will be read from the standard input (stdin).
384 If this option is specified, xvkbd will not open its window and
385 terminate soon after sending the string.
386
387 -utf16
388 When used with -file option, make xvkbd to accept UTF16 characters
389 in the file.
390
391 -delay value
392 Put value ms of delay for evey characters when sending characters
393 with -text or -file. Maybe this is useful when problem arises when
394 characters are entered too fast.
395 Resource `xvkbd.textDelay: value' has the same function.
396
397 -window window
398 Specify the ID (hexadecimal value leaded with `0x', or decimal
399 value), the name (instance name or class name) of the window, or
400 the title of the window to set input focus. It is possible to use
401 wildcard characters `*' and `?' to match the window name or the
402 window title.
403 If this is not specified, xvkbd will use input focus under control
404 of the window manager, unless focus is specified explicitly via Fo‐
405 cus button. Even if this option is specified, you can set input
406 focus to other windows using Focus button, or clear the input fo‐
407 cus.
408 If there are two or more windows which have the name specified with
409 this option, the window which was found first will be selected.
410
411 -widget widget-name
412 Specify the name of the widget to set the input focus. To use this
413 feature, the client must support Editres protocol. In general,
414 this option will be used with `-window' option.
415 If you want to set input focus to the widget foo.bar.zot, you can
416 write zot, bar.zot or foo.bar.zot as widget-name. To avoid confu‐
417 sion, the widget-name should match with a single widget of the
418 client.
419 For example,
420
421 xvkbd -window xarchie -widget searchText -text "\Ca\Ckabc\r"
422
423 will enter the string ``abc'' to the ``Search Term'' field of a
424 xarchie window.
425
426 -remote-display display
427 Specify the display (in the meaning of the X Window System) to con‐
428 nect;
429 see also Connect to Remote Display....
430
431 -true-keypad
432 If this option is specified, xvkbd will attempt to use keysyms such
433 as XK_KP_1 instead of XK_1.
434 Resource `xvkbd.keypadKeysym: true' has the same function.
435
436 -dict filename
437 Specify the default dictionary (list of words) file to be used for
438 word completion. The `Completion Dictionary' filename set on the
439 Property panel takes precedence over this.
440 Resource `xvkbd.dictFile: filename' has the same function.
441 See also ``Making your own completion dictionary''.
442
443 -minimizable
444 Make xvkbd window can be minimized (iconified) even if no window
445 manager is in use. When this feature is enabled, small triangle
446 will be displayed at left ot the xvkbd main menu, and xvkbd window
447 will be minimized when the triangle is clicked.
448 Resource `xvkbd.minimizable: true' has the same function.
449
450 -secure
451 Disable invocation of external commands, including user assigned
452 command and the online manual reader. Connection to another dis‐
453 plays would also be disabled. This option may be useful when xvkbd
454 is to be run with some kind of privileges.
455 Resource `xvkbd.secure: true' has the same function.
456
457 -nonexitable
458 Disable termination of the xvkbd program. This option may be use‐
459 ful when xvkbd is to be run automatically for systems with no key‐
460 boards and users should not terminate the xvkbd.
461 Resource `xvkbd.nonexitable: true' has the same function.
462
463 -xdm
464 Same as -secure -nonexitable. When xvkbd is to be run for login
465 screen, it would be suggested to use this option.
466
467 -modifiers modifiers
468 Normally, xvkbd will activate modifiers (control, shift, etc.)
469 only while sending characters. If modifiers were specified with
470 this option, the specified modifiers will be activated while corre‐
471 sponding key on the xvkbd window is in active. For example, you
472 can specify -modifiers shift,control,meta,alt to apply this for
473 those four modifiers. Maybe this can be useful when attempting to
474 decorate the mouse operations with the modifiers. Please note that
475 the modifiers will also be applied when attempting to click on the
476 xvkbd window and which can prevent the correct operation in some
477 situations.
478 Resource `xvkbd.positiveModifiers: modifiers...' has the same func‐
479 tion.
480
481 -debug
482 Make xvkbd to output debug information. It also disables keyboard
483 width adjustment, to help adjusting key size when making keyboard
484 layout file. It also make xvkbd to accept signals SIGINT and
485 SIGQUIT, which otherwise be ignored.
486
487 -version
488 Output version information and exit.
489
490
492 Default (US)
493 http://t-sato.in.coocan.jp/xvkbd/xvkbd-normal.gif
494
495 Belgian
496 http://t-sato.in.coocan.jp/xvkbd/xvkbd-belgian.gif
497
498 Danish
499 http://t-sato.in.coocan.jp/xvkbd/xvkbd-danish.gif
500
501 French
502 http://t-sato.in.coocan.jp/xvkbd/xvkbd-french.gif
503 http://t-sato.in.coocan.jp/xvkbd/xvkbd-french2.gif
504
505 German
506 http://t-sato.in.coocan.jp/xvkbd/xvkbd-german.gif
507
508 Icelandic
509 http://t-sato.in.coocan.jp/xvkbd/xvkbd-icelandic.gif
510
511 Italian
512 http://t-sato.in.coocan.jp/xvkbd/xvkbd-italian.gif
513
514 Japanese (JIS-X-6002)
515 http://t-sato.in.coocan.jp/xvkbd/xvkbd-jisx6002.gif
516
517 Japanese (JIS-X-6004)
518 http://t-sato.in.coocan.jp/xvkbd/xvkbd-jisx6004.gif
519
520 Norwegian
521 http://t-sato.in.coocan.jp/xvkbd/xvkbd-norwegian.gif
522
523 Portuguese
524 http://t-sato.in.coocan.jp/xvkbd/xvkbd-portuguese.gif
525
526 Spanish
527 http://t-sato.in.coocan.jp/xvkbd/xvkbd-spanish.gif
528
529 Swedish
530 http://t-sato.in.coocan.jp/xvkbd/xvkbd-swedish.gif
531
532 Swiss/German
533 http://t-sato.in.coocan.jp/xvkbd/xvkbd-swissgerman.gif
534
535 United Kingdom
536 http://t-sato.in.coocan.jp/xvkbd/xvkbd-uk.gif
537
538 Latin-1
539 http://t-sato.in.coocan.jp/xvkbd/xvkbd-latin1.gif
540
541 Small Keyboard (maybe suitable for PDAs)
542 http://t-sato.in.coocan.jp/xvkbd/xvkbd-small.gif
543
544 Hebrew
545 http://t-sato.in.coocan.jp/xvkbd/xvkbd-hebrew.gif
546
547 Greek
548 http://t-sato.in.coocan.jp/xvkbd/xvkbd-greek.gif
549
550 Turkish
551 http://t-sato.in.coocan.jp/xvkbd/xvkbd-turkish.gif
552
553 Slovene
554 http://t-sato.in.coocan.jp/xvkbd/xvkbd-slovene.gif
555
556 Korean
557 http://t-sato.in.coocan.jp/xvkbd/xvkbd-korean.gif
558
559 Russian (Cyrillic)
560 http://t-sato.in.coocan.jp/xvkbd/xvkbd-russian.gif
561
562
564 Latest Official Release
565
566 http://t-sato.in.coocan.jp/xvkbd/xvkbd-4.0.tar.gz
567 - source of version 4.0 (2019-08-31)
568
569 previous release
570 http://t-sato.in.coocan.jp/xvkbd/xvkbd-3.9.tar.gz
571 - source of version 3.9 (2018-02-25)
572 http://t-sato.in.coocan.jp/xvkbd/xvkbd-3.8.tar.gz
573 - source of version 3.8 (2017-06-06)
574 http://t-sato.in.coocan.jp/xvkbd/xvkbd-3.7.tar.gz
575 - source of version 3.7 (2015-09-12)
576
577 xvkbd is distributed under the terms of the GNU General Public License.
578
579
581 xmkmf
582 o untar the source in a directory, and move to the directory
583
584 o If you wish to use genuine Xaw instead of Xaw3d, edit Imakefile and
585 remove (or comment-out) `#define XAW3D'.
586 When you are installing xvkbd (for example) in very old systems,
587 you may also want to remove `#define XTEST' and `#define I18N' to
588 disable XTEST and internationalization facility respectively.
589
590 o Run: xmkmf; make install install.man
591
592
593 configure
594 Alternatively, maybe you can:
595
596 o untar the source in a directory, and move to the directory
597
598 o Run: ./configure; make; make install
599
600
602 How to Customize xvkbd
603 Some degree of customization of xvkbd is possible by setting resources.
604 Some resources are already described above, and resources to customiz‐
605 ing keyboard layout are described below.
606
607 To set resources, you can:
608
609 o put them in your $HOME/.Xdefaults file, or
610
611 o load them via xrdb(1), or
612
613 o set the filename to the $XENVIRONMENT environment variable, or
614
615 o put them in application default directory as `XVkbd-suffix' and set
616 resource ``xvkbd.customization: -suffix'', or
617
618 o put them in application default directory as XVkbd.
619
620 Here, application default directory can be either of:
621
622 o directories specified with $XUSERFILESEACHPATH, $XAPPLRESDIR or
623 else $HOME environment variable
624
625 o system's application default directory specified with $XFILESEACH‐
626 PATH environment variable, or else the directory specified when
627 compiling the X (e.g., /usr/lib/X11/app-defaults)
628
629 When the application default file is to be stored in the system's ap‐
630 plication default directory, the file must contain ``#include "XVkbd-
631 common"'' near top of the file.
632
633 xvkbd is distributed with some application default files, and they will
634 be installed in the system's application default directory.
635
636
637 Making Window Small
638 Size (and position) of xvkbd window can be set by `xvkbd.windowGeome‐
639 try' resource. When making window small, you may need to choose the
640 smaller font, too.
641
642 xvkbd.windowGeometry: 220x90
643 xvkbd.compact: true
644 xvkbd*Font: 6x12
645
646
647 You may also want to set:
648
649 xvkbd.modalKeytop: true
650
651 to display only the labels for the current shift state, instead of try‐
652 ing to always display all of them in the small keytop.
653
654 See also XVkbd-small.ad in the xvkbd distribution.
655
656
657 Removing Unwanted Keys
658 Keys on xvkbd window can be removed by setting their width to 1. The
659 resource name of the keys that start with a capital letter (and of the
660 space key) is the same as the key itself, the others are of the form
661 <row>,<col> (counting from zero).
662
663 To remove Compose key and make Shift key larger, you can write:
664
665 xvkbd*Multi_key.width: 1
666 xvkbd*Shift_R.width: 75
667
668
669 To remove right Alt and Meta key, you can write:
670
671 xvkbd*Alt_R.width: 1
672 xvkbd*Meta_R.width: 1
673
674
675
676 Customizing Keyboard Layout
677 Layout of keys on the xvkbd window can be customized with following re‐
678 sources:
679
680 xvkbd.NormalKeys
681 list of keys available when neighter of Shift and AltGr are se‐
682 lected
683
684 xvkbd.ShiftKeys
685 list of keys available when Shift is selected
686
687 xvkbd.AltgrKeys
688 list of keys available when AltGr is selected
689
690 xvkbd.ShiftAltgrKeys
691 list of keys available when both AltGr and Shift are selected
692
693 xvkbd.KeyLabels
694 list of labels displayed on the keys
695
696 xvkbd.NormalKeyLabels
697 list of labels displayed on the keys
698 when neither of Shift and AltGr are selected.
699
700 xvkbd.ShiftKeyLabels
701 list of labels displayed on the keys
702 when Shift is selected
703
704 xvkbd.AltgrKeyLabels
705 list of labels displayed on the keys
706 when AltGr is selected
707
708 xvkbd.ShiftAltgrKeyLabels
709 list of labels displayed on the keys
710 when both AltGr and Shift are selected
711
712 Four resources to set labels on the keys (xvkbd.NormalKeyLabels,
713 xvkbd.ShiftKeyLabels, xvkbd.AltgrKeyLabels and xvkbd.ShiftAltgrKeyLa‐
714 bels) will be used instead of xvkbd.KeyLabels when xvkbd.modalKeytop
715 resoruce is set true.
716
717 In all of those resources, each keys are separated by spaces, and rows
718 of keys are terminated with ` \n\' (note that `\n' must have space be‐
719 fore it). Please refer XVkbd-german.ad and XVkbd-latin1.ad in the
720 xvkbd distribution for more about these resources.
721
722 XVkbd-german and XVkbd-latin1 will be installed in the system's appli‐
723 cation default directory, and setting the resource ``xvkbd.customiza‐
724 tion: -german'' will make xvkbd to use the German layout. For another
725 method to activate those settings, please refer "How to Customize
726 xvkbd" above.
727
728
729 Assigning Text to Function Keys
730 Text can be assigned to each function keys (and, actually, to most
731 other keys). If text is assigned to the function key, clicking on the
732 key will send the assigned text instead of the function key itself.
733 When pointer is on a key where text is assigned, the text will be dis‐
734 played near the key.
735
736 The setting will be read from a text file which contains text for each
737 function keys as:
738
739 F1 text for F1
740 F2 text for F2
741 s:F1 text for Shift-F1
742 c:F1 text for Control-F1
743 m:F1 text for Meta-F1
744 a:F1 text for Alt-F1
745 ...
746
747
748 `s:', `c:', `m:' and `a:' before the keys name indicates four modifiers
749 (Shift, Control, Meta and Alt) respectively.
750
751 If the first character of the assigned string is `!', the string will
752 be used as command to be executed when the key is clicked. To assign
753 string starting with `!' or `\', put `\' before the string.
754
755 The file is $HOME/.xvkbd in default, and it can be changed by setting
756 the filename with xvkbd.keyFile resource.
757
758 For F1 to F12 with or without Shift modifier, it is possible to edit
759 the assigned string on a panel popped up via "Edit Function Keys..." in
760 the main menu.
761
762
764 Notes
765 o On XFree86, resolution switch with Ctrl + Alt + Keypad-Plus and
766 Ctrl + Alt + Keypad-Minus may be simulated. However, Ctrl + Alt +
767 Backspace will not be simulated.
768
769 o Shift is used to decide key to be sent and it will not used to set
770 modifier bit when sending the event. You can use xev command to
771 check what is actually sent.
772
773 o If Alt or Meta is not defined as modifier, the key can't be used as
774 modifier. You can use `xmodmap -pm' to check how modifiers are de‐
775 fined.
776
777 o Num Lock (and maybe other modifiers) on the physical keyboard may
778 not work correctly when xvkbd is in use.
779
780
781 Additional Informations
782 ChangeLog
783 http://t-sato.in.coocan.jp/xvkbd/ChangeLog
784
785 FAQ - Possible Problems and Solutions
786 http://t-sato.in.coocan.jp/xvkbd/faq.html
787
788 Hints to use xvkbd -text
789 http://t-sato.in.coocan.jp/xvkbd/xvkbd-text.html
790
791 Note about how to send key events
792 http://t-sato.in.coocan.jp/xvkbd/events.html
793
794
796 xvkbd was written by Tom Sato, and it is distributed under the terms of
797 the GNU General Public License Version 2 or any later version.
798
799 Please send any feedback (such as bug reports, requests or comments) to
800 Tom Sato <VEF00200@nifty.com>.
801
802 The latest version of this software and more information about it may
803 be available at http://t-sato.in.coocan.jp/xvkbd/.
804
805
806
807 2019-09-01 xvkbd(1)