READMEs vereinfacht

insbesondere klarere Trennung von Treibern und Skripten
dennoch Hinweise auf die einfache Benutzung über Skripte und NEO als Standardbelegung

git-svn-id: https://svn.neo-layout.org@1393 b9310e46-f624-0410-8ea1-cfbb3a30dc96

4 files changed, 99 insertions, 108 deletions

diff --git a/linux/README.txt b/linux/README.txt
index af74859..f720005 100644
--- a/linux/README.txt
+++ b/linux/README.txt
@@ -3,30 +3,34 @@ Für viele Linuxdistributionen sind hier Treiber zu finden.
 
 === X ===
 Dieser Treiber ersetzt die veraltete Neo Version 1.0, die bei allen
-Linuxdistributionen schon dabei ist. Zur sauberen Installation braucht man
-Administrator-Rechte (root-Rechte).
+Linuxdistributionen schon dabei ist. Zur sauberen und systemweiten Installation
+braucht man Administrator-Rechte (root-Rechte).
 
 === xmodmap ===
 Dieser Treiber nutzt das Programm xmodmap des X-Servers. Man braucht also
 keine Administrator-Rechte (root-Rechte), um diesen zu nutzen. Allerdings hat
 man hiermit bei der Anmeldung keine Neo-Tastaturbelegung (bei der
-Passworteingabe bedenken!). Jedoch hat man hiermit den Vorteil hoher
-Portabilität: Beispielsweise die Xmodmap-Datei auf einen USB-Stick kopieren
-und in den fremden Linux-Rechner einstecken, schon kann man mit Neo tippen.
+Passworteingabe bedenken!).
+Vorteile der Xmodmap sind:
+• hoher Portabilität: 
+  Beispielsweise die Xmodmap-Datei auf einen USB-Stick kopieren und in den
+  fremden Linux-Rechner einstecken, schon kann man mit Neo tippen.
+• einfache Installation:
+  für einen Benutzer kann NEO komplett und sauber durch das Skript ›installiere_neo‹
+  zum Testen und zur permanenten Benutzung eingerichtet werden.
 
 === console ===
 Dieser Ordner enthält eine keymap, um die NEO-Tastaturbelegung auch ohne X auf
-der Konsole benutzten zu können. Diese kann mithilfe einige Skripte automatisch
+der Konsole benutzten zu können. Diese kann mithilfe von Skripten automatisch
 aus der »normalen« xmodmap erstellt werden.
 
 === bin ===
 Dieses Verzeichnis enthält einige nützliche Shell-Befehle zur Ausgabe der
-Neo-Tastaturbelegung (auch einzelne Ebenen) sowie die Möglichkeit, über »uiae«
-bzw. »asdf« einfach zwischen NEO und QWERT* hin- und herzuwechseln.
+Neo-Tastaturbelegung (auch einzelne Ebenen) sowie die Möglichkeit, über ›uiae‹
+bzw. ›asdf‹ einfach zwischen NEO und QWERT* hin- und herzuwechseln.
 
 
-
-=== Verwenden von NEO (einfacher Weg) ===
+=== Verwenden von NEO ===
 Ein einfacher Weg, NEO unter dem eigenen Benutzer zu testen oder zu verwenden, ist,
 die Datei ›installiere_neo‹ herunterzuladen, ausführbar zu machen und auszuführen:
 
@@ -44,63 +48,3 @@ zum Darstellen der NEO-Belegung und zum leichten Wechel zwischen NEO und QWERTZ
 Ein weiter Aufruf von ›installiere_neo‹ bietet u.a. die Optionen, NEO gänzlich
 vom eigenen System zu entfernen, sofern NEO zuvor auch mit ›installiere_neo‹
 eingerichtet worden ist.
-
-
-
-=== Verwenden von NEO (von Hand) ===
-Vorab: zwischen den Strichzeilen (--------------------------) stehen Zeilen, die
-in Dateien stehen, dort eingegeben oder verändert werden müssen. Die
-Strichzeilen selbst sind jedoch nie mit einzugeben!
-
-Diese Anleitung beschreibt am Beispiel der xmodmap, wie man NEO problemlos
-einrichten kann:
-ⅰ) Die Verzeichnisse $HOME/neo (z.B. /home/gerhard/neo) und $HOME/neo/bin
-anlegen.
-
-ⅱ) Die Dateien ›neo_de.xmodmap‹ und ›neo.map‹ in das Verzeichnis $HOME/neo (also
-z.B. /home/gerhard/neo) legen.
-
-ⅲ) Die Skripte ›asdf‹ und ›uiae‹ in das Verzeichnis $HOME/neo/bin legen und
-ausführbar machen mit:
-  chmod u+x asdf uiae
-
-ⅳ) In der Datei ›.profile‹ (zu finden im Homeverzeichnis) folgende Zeilen
-hinzufügen:
-  --------------------------
-  # Neo:
-  PATH=$PATH:$HOME/neo/bin
-  export PATH
-  asdf xmodmap
-  --------------------------
-
-ⅴ) Schließlich ändert man in der Datei ›asdf‹ die Standardbelegung auf „xmodmap“:
-  --------------------------
-  NEO_X_VARIANTE="xmodmap"
-  --------------------------
-
-
-=== NEO in der Textkonsole ===
-Zunächst werden die gleichen Schritte wie im Abschnitt „Verwenden von NEO“
-durchgeführt!
-Insbesondere muss die Datei ›neo.map‹ unter $HOME/neo und die Dateien ›asdf‹ und
-›uiae‹ unter $HOME/neo/bin liegen! 
-
-Um zu vermeiden, dass Linux durch irgend einen Benutzer unbedienbar gemacht
-werden kann, darf nur root die Belegung der Textkonsole ändern.
-• Soll NEO nur für den eigenen Benutzer verfügbar gemacht werden, ist das
-Vorgehen identisch zum Abschnitt „Verwenden von NEO“. Es ist darauf zu achten,
-dass das Benutztername und Passwort unter qwertz eingegeben werden müssen. Nach
-dem Login wird man aufgefordert, das root-Passwort einzugeben (ebenfalls unter
-qwertz). Dadurch wird NEO automatisch aktiviert.
-• Soll NEO systemweit auf der Textkonsole zur Verfügung stehen, muss in der
-Datei ›/etc/sysconfig/keyboard‹ die Zeile (oder eine ähnlich klingende):
-  --------------------------
-  KEYTABLE="de-latin1-nodeadkeys.map.gz"
-  --------------------------
-ersetzen durch:
-  --------------------------
-  # KEYTABLE="de-latin1-nodeadkeys.map.gz"
-  KEYTABLE="/home/gerhard/neo/neo"
-  --------------------------
-Statt /home/gerhard ist das eigene Homeverzeichnis einzugeben. Dadurch wird auf
-die Datei ›neo.map‹ verwiesen, die zuvor nach $HOME/neo gelegt wurde.
diff --git a/linux/bin/README.txt b/linux/bin/README.txt
index fd5318d..72f22f4 100644
--- a/linux/bin/README.txt
+++ b/linux/bin/README.txt
@@ -1,25 +1,48 @@
+== installiere_neo ==
+Das Skript ›installiere_neo‹ erlaubt eine einfache und saubere Installation von NEO
+für einen Benutzer (keine root-Rechte erforderlich)
+
+
+== Skriptordner in .profile eintragen ==
+Der Ordner mit diesen Skripten sollte in der Variable $PATH eingetregen sein, um von überall verfügbar zu sein
+Dazu sollte in der Datei ›.profile‹, die beim Login gelesen wird, folgende Zeilen eingetragen sein:
+-------------------------------
+# NEO:
+PATH=$PATH:$(Pfad zu den Skripten)	# für NEO-Skripte wie ›asdf‹ und ›uiae‹
+export PATH				# für NEO-Skripte wie ›asdf‹ und ›uiae‹
+# asdf					# mit einem # am Zeilenanfang bleibt QWERTZ das Standardlayout, sonst ist es NEO
+-------------------------------
+
+Man beachte, dass die Skripte ausführbar sein müssen (chmod u+x ›Datei‹)
+
+
 == uiae, asdf ==
 asdf (linke Hand auf der Grundreihe abrollen) schaltet von QWERTZ zu Neo um.
 uiae ( “      “   “   “       “        “    )    “      “  Neo zu QWERTZ um.
 
 Verwendung:
-asdf [Variante] (Standard wird in der Datei definiert)
-uiae [Belegung] (Standard wird in der Datei definiert)
+asdf [Variante]
+uiae [Belegung]
+
+Nach beide Angaben (Variante, Belegung) wird in folgender Reihenfolge gesucht:
+ⅰ) direkte Angabe hinter dem Skriptnamen
+ⅱ) Definition in der neo.conf bzw. der .neorc
+ⅲ) in der Skriptdatei angegebene Standardbelegung
 
 Die Skripte ›asdf‹ und ›uiae‹ benutzten folgende Programme, die gegebenenfalls installiert werden müssen:
-– loadkeys (nur als root möglich)
-– setleds
-– xset
-– setxkbmap
-– numlockx
+• numlockx
+• setleds
+• xset
+• setxkbmap
+• loadkeys (nur als root möglich)
 
 
 == neo ==
 Gibt die Neo-Tastaturbelegung des Buchstabenfeldes aus. Beispiele:
-  »neo« – gibt die Tastaturbelegung mit allen Ebenen aus
-  »neo 1« – gibt die erste Ebene der Tastaturbelegung aus
-  »neo 3« – gibt die dritte Ebene der Tastaturbelegung aus
-  »neo 2 3 4« – gibt die zweite, dritte und vierte Ebene aus
+  »neo«		gibt die Tastaturbelegung mit allen Ebenen aus
+  »neo 1«	gibt die erste Ebene der Tastaturbelegung aus
+  »neo 3«	gibt die dritte Ebene der Tastaturbelegung aus
+  »neo 2 3 6«	gibt die zweite, dritte und sechste Ebene aus
 usw.
 
 == num ==
@@ -27,21 +50,34 @@ Gibt die Neo-Tastaturbelegung des Ziffernblocks aus. Beispiele:
   »num« – gibt die Tastaturbelegung mit allen Ebenen aus
   »num 1« – gibt die erste Ebene der Tastaturbelegung aus
   »num 3« – gibt die dritte Ebene der Tastaturbelegung aus
-  »num 2 3 4« – gibt die zweite, dritte und vierte Ebene aus
+  »num 2 3 6« – gibt die zweite, dritte und sechste Ebene aus
 usw.
 
+
 == wiemitneo ==
-Gibt an, ob und wie ein Zeichen mit NEO ermöglicht werden kann. Beispiele:
-  »wiemitneo @« ergibt:
+Gibt an, ob und wie ein Zeichen mit NEO ermöglicht werden kann.
+Beispiel:  »wiemitneo @«
 -------------------------------
+• @ gibt es direkt auf der NEO-Tastatur:
 @ erreicht man mit Mod3+y
 
-Außerdem ist @ über Compose folgendermaßen darstellbar:
+• @ ist über Compose folgendermaßen darstellbar:
 <Multi_key> + <A> + <T>
 -------------------------------
 
 == beschreibe ==
 Versucht, Zeichen anhand einer Beschreibung zu erraten und ruft »wiemitneo« auf
+Beispiel:  »beschreibe face«
+-------------------------------
+1) ☺
+2) ☹
+welches Zeichen suchen Sie: 1
+
+
+• ☺ ist über Compose folgendermaßen darstellbar:
+<Multi_key> + <colon> + <parenright>
+-------------------------------
+
 
 == neo-compose ==
 Erstellt aus der originalen Compose und den Neo-Ergänzungen eine lokale
diff --git a/linux/console/README b/linux/console/README
index 46c6760..19ad200 100644
--- a/linux/console/README
+++ b/linux/console/README
@@ -1,10 +1,26 @@
-=== Technische Hinweise ===
+=== NEO in der Textkonsole (ohne X) ===
 Die Datei neo.map enthält eine keymap, um die NEO-Tastaturbelegung auch ohne X auf der Konsole benutzten zu können.
-Dazu wird die keymap (leider als root!!) mit »loadkeys PFAD/neo.map« geladen.
+
+Dazu wird die keymap (nur als root möglich!!) mit »loadkeys PFAD/neo.map« geladen.
 Mit »loadkeys -d« wird wieder die Standardbelegung verwendet.
 
-Die neo.map kann schon beim Booten verwendet werden, indem der Pfad zur »neo.map« in der Datei »/etc/sysconfig/keyboard« in der Variable »KEYTABLE« angegeben wird. Dabei muss das ».map« allerdings weggelassen werden.
-Beispiel: KEYTABLE="/usr/share/kbd/keymaps/i386/neo/neo"
+Der einfachste Weg ist jedoch die Verwendung des Skriptes ›asdf‹ (siehe Ordner /linux/bin)
+
+
+=== Technische Hinweise ===
+Soll NEO systemweit auf der Textkonsole zur Verfügung stehen, muss in der
+Datei ›/etc/sysconfig/keyboard‹ die Zeile (oder eine ähnlich klingende):
+  --------------------------
+  KEYTABLE="de-latin1-nodeadkeys.map.gz"
+  --------------------------
+ersetzen durch:
+  --------------------------
+  # KEYTABLE="de-latin1-nodeadkeys.map.gz"
+  KEYTABLE="/home/gerhard/neo/neo"
+  --------------------------
+Statt /home/gerhard ist das eigene Homeverzeichnis einzugeben. Dadurch wird auf
+die Datei ›neo.map‹ verwiesen, die zuvor nach $HOME/neo gelegt wurde.
+
 Dennoch kann man mit »loadkeys -d« zur Standardbelegung wechseln, da diese als defkeymap.map laut manpage unter /usr/share/keymaps oder /usr/src/linux/drivers/char, bei mir aber unter /etc liegt.
 
 Falls das Keypad nicht korrekt funktioniert, dann liegt dies am falschen Status von »Num_Lock« (den es unter NEO nicht mehr gibt). Um Num_Lock dennoch nachträglich einschalten zu können, muss die Menü-Taste (in der untersten Reihe) betätigt werden.
@@ -29,3 +45,4 @@ Was (noch) nicht geht:
 • Bisher funktioniert keiner der Modifier_Lock.
 • die große Menge an Compose-Kombinationen, die unter X möglich sind, werden längst nicht alle unterstützt.
 • Auch die Compose-Erweiterungen von NEO sind noch nicht verfügbar.
+
diff --git a/linux/xmodmap/README b/linux/xmodmap/README
index 4b6a413..52b69b1 100644
--- a/linux/xmodmap/README
+++ b/linux/xmodmap/README
@@ -1,5 +1,4 @@
 == Dateien ==
-/A-REFERENZ-A/neo20.txt das Layout als ASCII-Art
 neo_de.xmodmap          	Normale Version für die meisten Benutzer
 neo_de_evdev.xmodmap    	für KDE4 mit evdev¹ (unter KDE4 funktioniert jedoch auch die normal
 				neo_de.xmodmap einwandfrei)
@@ -14,21 +13,21 @@ neo_de_alternative.xmodmap	falls neo_de.xmodmap nicht geladen werden kann (z.B.
 Zu aktivieren mit dem Kommando (im Verzeichnis, in dem sich die Datei befindet):
 	xmodmap neo_de.xmodmap
 
-Besser ist jedoch die Verwendung des Skripts „asdf“, das (mögliche) Probleme vermeidet.
+Besser ist jedoch die Verwendung des Skripts ›asdf‹, da so (mögliche) Probleme vermieden werden.
+Siehe dazu auch die README im Ordner /linux/bin.
 
-==== Automatisch aktivieren ====
-Um die NEO-Tastaturbelegung automatisch zu aktivieren, kann man die obige
-Befehlszeile in ein Startscript seines Desktop Environments (z.B.
-gnome-session-properties oder ~/GNUstep/Library/WindowMaker/autostart)
-eintragen.
 
-Oder die Befehlszeile in die ~/.Xsession (falls nicht KDE oder Gnome geladen)
+==== Automatisch aktivieren ====
+Um die NEO-Tastaturbelegung automatisch zu aktivieren, gibt es mehrere (alternative) Wege
+• die Xmodmap nach ~/.Xmodmap kopieren, wo sie automatisch geladen wird
+• die Befehlszeile in ein  Datei eingeben, die automatisch ausgeführt wird, z.B.:
+	– gnome-session-properties
+	– ~/GNUstep/Library/WindowMaker/autostart
+	– ~/.Xsession
 
-Oder die Xmodmap nach ~/.Xmodmap spielen (wo sie automatisch geladen wird) und
-die Standard Tastaturbelegung auf „lv“ festsetzen (in GNOME/KDE/XFCE/.Xsession).
+Der bessere Weg ist jedoch das Skript ›asdf‹ in der Datei ›~/.profile‹ einzutragen.
+Siehe dazu auch die README im Ordner /linux/bin.
 
-Besser ist auch hier die Verwendung des Skripts. Dazu wird in der Datei ›.profile‹, die sich im
-Homeverzeichnis befindet, der Befehl ›asdf xmodmap‹ eingetragen.
 
 ==== Automatischen Linux-NEO-USB-Stick erstellen ====
 Diese Datei auf einen USB-Stick kopieren
@@ -44,18 +43,13 @@ USB-Sticks ersetzt werden muss):
   echo -e "#!/bin/sh\nsetxkbmap lv && xmodmap neo_de.xmodmap" > \
     /media/<USBSTICK>/autorun
 
+
 === Deaktivieren ===
 Zurück zu qwertz geht es mit:
 	setxkbmap de
 
-Besser ist auch hier die Verwendung des Skripts „uiae“.
-
-=== Tipp ===
-Trägt man folgende Zeilen in die ~/.profile ein, kann man anschließend mittels Abrollen
-der linken Hand auf der Grundreihe zwischen qwertz und NEO wechseln.
+Besser ist auch hier die Verwendung des Skripts ›uiae‹.
 
-PATH=$PATH:$(Pfad zu den Skripten „asdf“ und „uiae“) 
-export PATH
 
 == FAQ ==
 Bei Problemen erst mal in die FAQ schauen, das meiste ist bekannt.