From 15a91e974c11132e827495a9eee543c2c233c101 Mon Sep 17 00:00:00 2001
From: taradiddles <taradiddles@users.noreply.github.com>
Date: Fri, 6 Apr 2018 10:56:16 +0300
Subject: [PATCH] add doc / how to use multiple keyb layouts

---
 docs/README.md                                |  3 ++
 .../localization/keyboard-multiple-layouts.md | 50 +++++++++++++++++++
 2 files changed, 53 insertions(+)
 create mode 100644 docs/localization/keyboard-multiple-layouts.md

diff --git a/docs/README.md b/docs/README.md
index 44bac1e..537f42f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -13,5 +13,8 @@
 `hardware`
 - [tips on choosing the right hardware](hardware/hardware-selection.md)
 
+`localization`
+- [how to use multiple keyboard layouts](localization/keyboard-multiple-layouts.md)
+
 `misc`
 - Qubes cheat sheet (3.2) : https://github.com/Jeeppler/qubes-cheatsheet
diff --git a/docs/localization/keyboard-multiple-layouts.md b/docs/localization/keyboard-multiple-layouts.md
new file mode 100644
index 0000000..36b39b5
--- /dev/null
+++ b/docs/localization/keyboard-multiple-layouts.md
@@ -0,0 +1,50 @@
+Using multiple keyboard layouts
+===============================
+
+The [official Qubes OS docs](https://www.qubes-os.org/faq/#my-keyboard-layout-settings-are-not-behaving-correctly-what-should-i-do) only cover how to change the layout *globally* - ie. both for dom0 and VMs, with a *single* layout.
+
+
+This document depicts several ways of using *multiple* keyboard layouts and being able to *quickly* switch between them.
+
+Recommended setup
+-----------------
+
+Run `setxkbmap` in *each* VM (dom0 will be configured with only one layout, since running `setxkbmap...` in dom0 would probably interfere with the VMs).
+
+For instance the following command would alternate between the US English and the Bulgarian phonetic layout when pressing both shift keys:
+
+~~~
+setxkbmap -layout "us,bg(phonetic)" -option "grp:shifts_toggle"
+~~~
+
+To automatically run the `setxkbmap` command when the VM starts, add a `/etc/xdg/autostart/setxkbmap.desktop` file in the VM's *template* with the following content:
+
+~~~
+[Desktop Entry]
+Name=Configure multiple keyboard layouts
+Exec=setxkbmap -layout "us,bg(phonetic)" -option "grp:shifts_toggle"
+Terminal=false
+Type=Application
+~~~
+
+If you prefer to have per-VM rather than per-template `setxkbmap` commands create a `/rw/config/setxkbmap.desktop` with the same content as above and add the following line to `/rw/config/rc.local`:
+
+~~~
+cp /rw/config/setxkbmap.desktop /etc/xdg/autostart
+~~~
+
+Note: the reason we can't put the `setxkbmap` command in the `rc.local` script is because the X server isn't running when `rc.local` is executed.
+
+Alternatively, you could add the `setxkbmap` command to your profile's `.bashrc` file if you use terminals to start applications.
+
+
+Alternative setups
+------------------
+
+- Configuring a keyboard shortcut in dom0 that would issue `qvm-run vname 'setxkbmap...'` to the VM whose window is under the mouse pointer (using `xprop -id $(xdotool getactivewindow`) ). This is a bit convoluted and `qvm-run` is sometimes slow when the system is under heavy I/O usage, so the layout switch doesn't happen immediately which is annoying.
+- Change the layout in dom0 with `setxkbmap ...`. This isn't optimal because:
+    - there's no way to know which layout is used when typing the screensaver's password
+    - sometimes the keyboard layout would not be propagated to one of the VMs, requiring a reboot of the VM. 
+- Once Qubes OS gains support for keyboard layout propagation from dom0 to VMs (see [this official issue](https://github.com/QubesOS/qubes-issues/issues/1396)) one could use the desktop environment's keyboard layout switcher (eg. Xfce Keyboard Layout switcher). It is not clear however if this solution won't exhibit the issues as above when running `setxkbmap ...` in dom0.
+- Change the layout in dom0 with localectl: it's a no-go as it requires a reboot
+