== Overview ==

This package contains two files that can be used to alter your
keyboard layout, either in the system console or within Xorg (or
both):

  * Your physical "Alt" keys act like "Ctrl" keys.
  * Your physical "Ctrl" keys act like "Alt" keys.
  * Your physical "Caps Lock" key acts like the "Alt" key.

This makes emacs (and any readline-based application) easier to use, I
promise.

The files:

1. src/console.map

   This affects the Linux system console and virtual terminals; that
   is, the things that you switch between with Ctrl-Alt-FN, and the
   thing that you're looking at before you start Xorg. The console.map
   file is input for the "loadkeys" utility that is part of KBD
   project <http://kbd-project.org/> and is provided by sys-apps/kbd
   on Gentoo.

2. src/Xmodmap

   This affects the Xorg system, and your graphical terminals. It
   should be fed into the "xmodmap" utility that is part of Xorg
   and which is provided by x11-apps/xmodmap on Gentoo.

== Installation ==

Either of those files can be loaded manually regardless of where they
live; for example,

  $ loadkeys /path/to/console.map
  $ xmodmap /path/to/Xmodmap

The "install-console" and "install-xorg" makefile targets will install
both files to $(PREFIX)/share/emacs-keys by default. The value of the
PREFIX variable defaults to /usr/local but can be specified to make;
for example,

  $ make PREFIX=/usr install-console

For the Xmodmap file, that's about as good as it gets. To use it, you
will typically add something like the following to your ~/.xinitrc,

  emacsmodmap=/usr/share/emacs-keys/Xmodmap
  if [ -f $emacsmodmap ]; then
    # It doesn't work unless you do it twice, don't ask me why.
    xmodmap $emacsmodmap
    xmodmap $emacsmodmap
  fi

The console map on the other hand can be loaded by OpenRC, which
starts a "keymaps" service at boot time. The configuration file for
that service is usually located at /etc/conf.d/keymaps, and if you set

  extended_keymaps="/usr/share/emacs-keys/console.map"

in there, then OpenRC will load the emacs keymap on top of your
default one when the system boots.