doc/README: fix the documentation for the new build/install system.

[emacs-keys.git] / doc / README

diff --git a/doc/README b/doc/README
index e1031182c510ab86855fa033bf0ca8c21c4d18c0..d05e600b6b6d07bd710cf97cb868ed1c2b3adb8f 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -1,7 +1,7 @@
 == Overview ==
 
 This package contains two files that can be used to alter your
-keyboard layout, either in the system console or within Xorg (or
+keyboard layout, either in the system console or within X.org (or
 both):
 
   * Your physical "Alt" keys act like "Ctrl" keys.
@@ -11,23 +11,30 @@ both):
 This makes emacs (and any readline-based application) easier to use, I
 promise.
 
+The console map probably only works on i386 qwerty keyboards, because
+that's all I have.
+
 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
+   thing that you're looking at before you start X.org. 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
+   This affects the X.org system, and your graphical terminals. It
+   should be fed into the "xmodmap" utility that is part of X.org
    and which is provided by x11-apps/xmodmap on Gentoo.
 
+   You must pass "--enable-Xmodmap" to the ./configure script to
+   install this file.
+
+
 == Installation ==
 
 Either of those files can be loaded manually regardless of where they
@@ -36,12 +43,9 @@ 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
+The Makefile will install console.map to $(datadir)/emacs-keys by
+default. If you pass "--enable-Xmodmap" to the ./configure script,
+then the Makefile will install Xmodmap to the same location.
 
 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,
@@ -55,7 +59,8 @@ will typically add something like the following to your ~/.xinitrc,
 
 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
+that service is usually located at /etc/conf.d/keymaps, and if you
+set, for example,
 
   extended_keymaps="/usr/share/emacs-keys/console.map"