1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
|
<sect2 id="gkbapplet">
<title>GNOME KeyBoard Applet</title>
<!-- reviewed by András-->
<para>
<application>GNOME KeyBoard Applet</application>, shown with its
default configuration in <xref linkend="gkbapplet-fig">, allows
you to easily and quickly change
the keyboard map to those used in various different countries. To
add this applet to a
<interface>Panel</interface>,
right-click on the <interface>Panel</interface> and choose
<menuchoice>
<guimenu>Panel</guimenu>
<guisubmenu>Add to panel</guisubmenu>
<guisubmenu>Applet</guisubmenu>
<guisubmenu>Utility</guisubmenu>
<guimenuitem>GKB KeyBoard Switcher</guimenuitem>
</menuchoice>.
</para>
<figure id="gkbapplet-fig">
<title>GNOME KeyBoard Applet</title>
<screenshot>
<screeninfo>GNOME KeyBoard Applet</screeninfo>
<graphic format="png" fileref="figures/gkb_applet"
srccredit="emese">
</graphic>
</screenshot>
</figure>
<!-- ============= Usage ================================ -->
<sect3 id="gkbapplet-usage">
<title>Usage</title>
<para>
Once configured, the <application>GNOME Keyboard</application>
applet allows you to switch the keyboard mapping between any number of
keyboard layout. Just left-click on the applet or press
<keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo>
to switch the keyboard
mapping.
</para>
<para>
Right-clicking on the applet brings up a menu containing the
following items:
<itemizedlist>
<listitem>
<para>
<guimenuitem>Properties…</guimenuitem> —
opens the <link linkend="gkbapplet-prefs">
<guilabel>Properties</guilabel></link> dialog.
</para>
</listitem>
<listitem>
<para>
<guimenuitem>Help</guimenuitem> —
displays this document.
</para>
</listitem>
<listitem>
<para>
<guimenuitem>About…</guimenuitem> —
shows basic information about <application>GNOME KeyBoard
Applet</application>, including the applet's version and the
author's name.
</para>
</listitem>
</itemizedlist>
</para>
</sect3>
<!-- ============= Customization ============================= -->
<sect3 id="gkbapplet-prefs">
<title>Customization</title>
<para>
You can customize <application>GNOME KeyBoard</application>
applet by right-clicking on it and choosing
<guimenuitem>Properties…</guimenuitem>. This will open the
<interface>Properties</interface> dialog (shown in <xref
linkend="gkbapplet-settings-fig">), which allows you to
add, modify, and remove keymaps, as well as to <link linkend="gkbapplet-options">configure
the applet's appearance</link>.
</para>
<figure id="gkbapplet-settings-fig">
<title>Properties dialog</title>
<screenshot>
<screeninfo>Properties dialog</screeninfo>
<graphic format="png" fileref="figures/gkb_applet_settings"
srccredit="emese">
</graphic>
</screenshot>
</figure>
<para>The <interface>Properties</interface> dialog box has two tabs:
<guilabel>Keymaps</guilabel> and <guilabel>Options</guilabel>.
On the <guilabel>Keymaps</guilabel> tab, you can Add, Edit, Delete
or change the order of keyboard layouts. On the
<guilabel>Options</guilabel> tab you can set the appearance of the
applet (flag, label or flag+label) and its size (Normal or Big), as
well as the key sequence to use to get GKB to switch between
keyboard layouts (see <xref linkend="bugs"> section.)
</para>
<sect4 id="gkb-prefs-add">
<title>Setting keyboard layouts for you language</title>
<para>
Setting up keymaps can consist in one or more of the following steps:
<itemizedlist>
<listitem>
<para>
Adding a required keyboard layout — On the
<guilabel>Keymaps</guilabel> tab, click on the
<guibutton>Add</guibutton> button. The
<interface>tree</interface> shown in
<xref linkend="gkbapplet-add-keymap-fig"> allows you to choose
the keymap best suited for you, based on the language and the
country involved.
</para>
<figure id="gkbapplet-add-keymap-fig">
<title>Select Layout dialog</title>
<screenshot>
<screeninfo>Select layout dialog</screeninfo>
<graphic format="png" fileref="figures/gkb_add_list"
srccredit="emese"></graphic>
</screenshot>
</figure>
<para>To add a keymap, click on the <guibutton>+</guibutton>
sign preceeding the languge you want to set. A list of coutries
where the given language is used appears. Again, click on the
<guibutton>+</guibutton> preceeding the country chosen, and a
list of keymaps shows up. Select the keymap you would like to
use and click <guibutton>Add</guibutton>. Your keymap gets added to
the list on the <interface>GKB Properties</interface> window. You
may add another keymap or click
<guibutton>Close</guibutton> to close the
<interface>Select Layout</interface> dialog.
</para>
</listitem>
<listitem>
<para>
Editing an existing keyboard layout — Selecting a keymap
and pressing the <guibutton>Edit</guibutton> brings up the
<interface>Edit keymap</interface> window (see
<xref linkend="gkbapplet-prefs-edit">).
</para>
<figure id="gkbapplet-prefs-edit">
<title>Edit keymap dialog</title>
<screenshot>
<screeninfo>Edit keymap dialog</screeninfo>
<graphic format="png" fileref="figures/gkb_edit_keymap"
srccredit="emese"></graphic>
</screenshot>
</figure>
<para>
On this dialog, you can modify different properties of the keymap. These
properties are:
<itemizedlist>
<listitem>
<para>
<guilabel>Name</guilabel>: The name of the keymap, as shown in the
<interface>GKB Properties</interface> window and in the hint appearing
when you move your mouse over the applet.
</para>
</listitem>
<listitem>
<para>
<guilabel>Label</guilabel>: This is the label that appears when you set
"Label" or "Flag+Label" modes. See <xref linkend="gkbapplet-options"> for more
details.
</para>
</listitem>
<listitem>
<para>
<guilabel>Language</guilabel>: This option will be used in Gnome 2.0.
It has no effect right now.
</para>
</listitem>
<listitem>
<para>
<guilabel>Country</guilabel>: This option will be used in Gnome 2.0. It
has no effect right now.
</para>
</listitem>
<listitem>
<para>
<guilabel>Flag</guilabel>: This is the place where you can set the flag
to be displayed with the given keyboard layout.
</para>
</listitem>
<listitem>
<para>
<guilabel>Architecture</guilabel>:This option will be used in Gnome 2.0.
It has no effect right now.
</para>
</listitem>
<listitem>
<para>
<guilabel>Type</guilabel>: This option will be used in Gnome 2.0. It has no
effect right now.
</para>
</listitem>
<listitem>
<para>
<guilabel>Code page</guilabel>: This option will be used in Gnome 2.0. It
has no effect right now.
</para>
</listitem>
<listitem>
<para>
<guilabel>Command</guilabel>: This is the command which
<application>GNOME KeyBoard</application> will use to change
the keymap. The default is to use the
<command>gkb_xmmap <replaceable>xmodmap-file-extension</replaceable>
</command> command, where <replaceable>xmodmap-file-extension</replaceable>
should be replaced by the extension of the xmodmap file you want to use.
</para>
<tip>
<title>Finding keyboard layouts availble on your system</title>
<para>On a typical Linux system, xmodmap files can be found under the
directory <filename class="directory">/usr/share/xmodmap</filename>.
</para>
</tip>
<para>
To set the keymap to a US 101 key keyboard, for example, you would
use <command>gkb_xmmap us-101</command>.
</para>
<para>
If this doesn't work, you may also try setting the
keyboard using command <command>setxkbmap
<replaceable>LC</replaceable></command> where
<replaceable>LC</replaceable> is the two letter country
code of your locale. (for example,
<command>setxkbmap fr</command> to use a French
keyboard). Finally, if you have your own keyboard layout
(xmodmap) file, set the command to <command>xmodmap
<replaceable>xmodmap-filename</replaceable></command> (for
example, <command>xmodmap
~/xrus/yawerty.koi8.xmm</command> to use keyboard layout
for Cyrillic letters in koi8 encoding). Please see
<xref linkend="gkbappplet-technical"> for more information.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
Removing a keyboard layout that is no longer needed —
To remove a keyboard, select it (click on it in the
<interface>GKB Properties</interface> window) and click the
<guibutton>Delete</guibutton> button.
</para>
</listitem>
<listitem>
<para>
Reordering keyboard layouts — The order in which the
keyboard layouts become active as you click on the applet or
press the hot key depends on the order they appear in the list in
the <interface>Properties</interface> window. The layout that is
displayed at the top of
the list will become the default layout when you close the
<interface>Properties</interface> window. To change the order in
the list, select the keymap to be moved, and click
<guibutton>Up</guibutton> or <guibutton>Down</guibutton> as
appropriate.
</para>
</listitem>
</itemizedlist>
</para>
<para>
After you have made all the changes you want, click on
<guibutton>Apply</guibutton> to apply the changes or on
<guibutton>OK</guibutton> to apply the changes and close the
<interface>Properties</interface> dialog. To cancel the changes
and return to previous values, click the <guibutton>Close</guibutton>
button. The <guibutton>Help</guibutton> button brings up this chapter
of the on-line help.
</para>
</sect4>
<sect4 id="gkbapplet-options">
<title>Miscellaneous options</title>
<para>
Different options allow you to customize the look of your applet.
As a new feature, you can select between three different display modes:
<itemizedlist>
<listitem>
<para>
Flag mode — The flag associated to the keymap is
displayed on the <interface>Panel</interface>.
</para>
</listitem>
<listitem>
<para>
Label mode — No flag is displayed, only the label
associated with the keymap.
</para>
</listitem>
<listitem>
<para>
Flag and label mode — Both flag and label
associated with the keymap are displayed.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Many users have reported, that the applet takes too much room on
the panel. You can now set the applets size from the
<guilabel>Applet size</guilabel> pull down list. Set the size to
<guibutton>Normal</guibutton> if you want a smaller applet.
If you have plenty of space or like nice big flags on you panel,
set the option to <guibutton>Big</guibutton>.
</para>
<para>
An often formulated user wish was to implement the keymap switching using
hotkeys. The developers proudly announce, that keyboard initiated switching now works. The hotkey combination that allows to change keymaps is set to
<keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo> (<keycap>Alt</keycap> being the left <keycap>Alt</keycap> key). You can customize this hotkey sequence from the <interface>GKB Properties</interface> window's
<guilabel>Options</guilabel> tab. Click on the <guibutton>Grab hotkey</guibutton> button and press the keys you want to set. The key combination is displayed in the <interface>input box</interface> near the button (you may see something like: <keysym>Control-Shift_R</keysym>). Finally, click on <guibutton>Apply</guibutton> or <guibutton>OK</guibutton> to finalize the new settings.
</para>
</sect4>
</sect3>
<sect3 id="gkbappplet-technical">
<title>Technical information</title>
<para>
Normally you do not need these details - but if something is not
working, or you are just curious, read on.
</para>
<para>
<application>GNOME Keyboard</application> switches the keyboard
map by issuing a command to X Window
System. X Window System has two mechanisms for setting keyboard
mapping: older one called "xmodmap" and a newer one, based on the
so-called "Xkb extension". If you have Xkb enabled, you should use
it and switch keyboard layouts by issuing a command
<command>setxkbmap <replaceable>LC</replaceable></command>. It
comes with a number of various keyboard layout files, usually in
directory <filename>/usr/X11R6/lib/X11/xkb/symbols</filename>.
</para>
<para> If you do not have Xkb extension enabled, or if it just
does not cover the language you need, you should use the older
<command>xmodmap</command> mechanism. In this case, you need to
have a file which describes keyboard layout in a special format
(see manual page for <command>xmodmap</command> for details), and
the command should be <command>xmodmap
<replaceable>filename</replaceable> </command>. <application>GNOME
Keyboard</application> includes a
number of keyboard layout files, which are installed in the
directory <filename>/usr/share/xmodmap</filename>; these files
have names like <filename>xmodmap.de</filename>. To use one of
these files, you can use the command <command>gkb_xmmap
<replaceable>LC</replaceable></command>
which is equivalent to <command>xmodmap
/usr/share/xmodmap/xmodmap.<replaceable>LC</replaceable></command>:
for example,
<command>gkb_xmmap hu</command> is the same as <command>xmodmap
/usr/share/xmodmap/xmodmap.hu</command>.
</para>
</sect3>
<!-- ============= Bugs ================================== -->
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of -->
<sect3 id="gkb-bugs">
<title>Known Bugs and Limitations</title>
<para>
<itemizedlist>
<listitem>
<para>
Languages and countries showing up in the
<interface>Select layout</interface> dialog are not sorted in
alphabetical order.
</para>
</listitem>
<listitem>
<para>
The program has very few error handling routines implemented. If you try to feed it something unusual, it may crash.
</para>
</listitem>
<listitem>
<para>
If it does not crash, it returns the error: "The keymap switching
returned an error". If the <interface>Edit</interface> window is open
when this error appears and
you press the <guibutton>OK</guibutton> button on this window, it is
likely that nothing will happen. Try closing the
<interface>Edit</interface> window first and
then the error window.
</para>
</listitem>
</itemizedlist>
</para>
</sect3>
<!-- ============= Authors ================================ -->
<sect3 id="gkb-authors">
<title>Authors</title>
<para>
<application>GNOME KeyBoard</application> was written by Szabolcs Ban
(<email>shooby@gnome.hu</email>). Please send all comments,
suggestions, and bug
reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>). You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
Menu</guimenu>, for submitting bug reports.
</para>
<para>
This manual was originally written by Szabolcs (Shooby) Ban
(<email>shooby@gnome.hu</email>) and Dan Mueth
(<email>d-mueth@uchicago.edu</email>). It has been rewritten
(strongly based on the original) by Emese Kovacs
(<email>emese@gnome.hu</email>) to reflect changes from v1.2 to v1.4.
The <link linkend="gkbappplet-technical">Technical Information</link>
section has been added by
Alexander Kirillov (<email>kirillov@math.sunysb.edu</email>).
Please send all comments
and suggestions regarding this manual to the <ulink type="http"
url="http://developer.gnome.org/projects/gdp/">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also submit comments online
by using the <ulink type="http"
url="http://developer.gnome.org/projects/gdp/doctable/">GNOME
Documentation Status Table</ulink>.
</para>
<!-- For translations: uncomment this:
<para>
Latin translation was done by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
suggestions regarding this translation to SOMEWHERE.
</para>
-->
</sect3>
<!-- ============= Application License ============================= -->
<!--
<sect3 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
modify it under the terms of the <citetitle>GNU General Public
License</citetitle> as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later
version.
</para>
<para>
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<citetitle>GNU General Public License</citetitle> for more details.
</para>
<para>
A copy of the <citetitle>GNU General Public License</citetitle> is
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
Software Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
<country>USA</country>
</address>
</para>
</sect3>
-->
</sect2>
|