Mercurial > hg > batmud > ggrtf

changeset 1538:15682433fd7a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More work on the documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 18 Apr 2013 03:32:02 +0300
parents 6ca679191afd
children 78268db92315
files docs/manual.sgml
diffstat 1 files changed, 90 insertions(+), 82 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Thu Apr 18 03:09:35 2013 +0300
+++ b/docs/manual.sgml	Thu Apr 18 03:32:02 2013 +0300
@@ -378,7 +378,7 @@
 </para>
 <itemizedlist>
  <listitem>
-  <para>*.tar.gz packages are for UNIX-style systems, such as Linux, *BSD,
+  <para>*.tar.gz packages are for UNIX-like systems, such as Linux, *BSD,
  etc. Please note that the ZIP-packages are meant for Windows only and WILL
  NOT WORK under UNIX or OS X version of TinyFugue!</para>
  </listitem>
@@ -557,7 +557,7 @@
 
 <itemizedlist>
  <listitem><para>
-  UNIX- and compatibles, like Linux:
+  UNIX-like systems, like Linux:
   <emphasis>~/.tfrc</emphasis> or <emphasis>$HOME/.tfrc</emphasis>
   (aka a file named ".tfrc" in your user home directory.)
  </para></listitem>
@@ -589,6 +589,11 @@
 
 <screen>&exampletfrc;</screen>
 
+<!--
+- layout of recommended configuration
+- discussion about modules
+- bindings or not?
+-->
 
 <section id="inst-config-tf-locale"><title>Character set encoding and locales</title>
 <para>
@@ -632,45 +637,45 @@
 Below is a list of tips and pointers, which may be of some help.
 </para>
 
-<itemizedlist>
+<section id="inst-config-tf-locale-unix"><title>UNIX-likes / Linux</title>
+<para>
+ For Linux/UNIX, you need to have the ISO-8859-1 locale installed/configured.
+ How this is done depends on your OS distribution. For example in Debian,
+ you need to use <userinput>dpkg-reconfigure locales</userinput> and add
+ some ISO-8859-1 locale, for example <emphasis>en_US.iso88591</emphasis>.
+</para>
+
+<para>
+ On Ubuntu, things get a bit more complicated:
+</para>
+<orderedlist>
  <listitem>
   <para>
-   For Linux/UNIX, you need to have the ISO-8859-1 locale installed/configured.
-   How this is done depends on your OS distribution. For example in Debian,
-   you need to use <userinput>dpkg-reconfigure locales</userinput> and add
-   some ISO-8859-1 locale, for example <emphasis>en_US.iso88591</emphasis>.
-  </para>
-  <para>
-   On Ubuntu, things get a bit more complicated:
+  Edit /var/lib/locales/supported.d/local with your favorite editor,
+  and on the last line add: <emphasis>en_US.ISO-8859-1 ISO-8859-1</emphasis>.
+  It should look something like this:
   </para>
-  <itemizedlist>
-   <listitem>
-    <para>
-    Edit /var/lib/locales/supported.d/local with your favorite editor,
-    and on the last line put <userinput>en_US.ISO-8859-1 ISO-8859-1</userinput>.
-    It should look something like this:
-    </para>
-    <screen>en_US.UTF-8 UTF-8
+  <screen>en_US.UTF-8 UTF-8
 en_US.ISO-8859-1 ISO-8859-1</screen>
-   </listitem>
-   <listitem>
-    <para>
-    Then, run <userinput>sudo dpkg-reconfigure locales</userinput>
-    </para>
-   </listitem>
-  </itemizedlist>
+ </listitem>
+ <listitem>
   <para>
-   On other Linux distributions and UNIX-like platoforms the methods
-   for installing locales vary. Your best bet is to
-   <ulink url="https://www.google.com/search?q=linux+install+locale+iso-8859-1">Use the Google</ulink>.
+  Then, run <userinput>sudo dpkg-reconfigure locales</userinput>
   </para>
-  <para>
-   If your system is using some locale other than ISO-8859-1 such as UTF-8,
-   you will need to make the terminal use ISO-8859-1 despite the system-global
-   setting. How this is done depends on the terminal, but perhaps the easiest
-   way is to use the following wrapper script for starting TinyFugue.
-  </para>
-  <screen>#!/bin/sh
+ </listitem>
+</orderedlist>
+<para>
+ On other Linux distributions and UNIX-like platoforms the methods
+ for installing locales vary. Your best bet is to
+ <ulink url="https://www.google.com/search?q=linux+install+locale+iso-8859-1">Use the Google</ulink>.
+</para>
+<para>
+ If your system is using some locale other than ISO-8859-1 such as UTF-8,
+ you will need to make the terminal use ISO-8859-1 despite the system-global
+ setting. How this is done depends on the terminal, but perhaps the easiest
+ way is to use the following wrapper script for starting TinyFugue.
+</para>
+<screen>#!/bin/sh
 SAVE_LANG="$LANG"
 export LANG="en_US.ISO-8859-1"
 printf '\33]701;%s\007' $LANG
@@ -679,44 +684,60 @@
 
 export LANG="$SAVE_LANG"
 printf '\33]701;%s\007' $LANG</screen>
-  <para>
-   You will need to copy+paste the script, or download it
-   <ulink url="http://tnsp.org/~ccr/ggrtf/tf5.sh">from here</ulink>.
-   You should place the script in some directory in your $PATH. You
-   will also need to modify it to point to the correct TinyFugye executable,
-   (e.g. change "/usr/bin/tf5" if needed.) Name the script as something
-   like "mytf" or rename the real TinyFugue executable as "tf5-bin" and
-   the script as "tf5", changing the script to point to tf5-bin.
-  </para>
-  <para>
-   Remember to set the script executable by changing
-   its permissions, '<emphasis>chmod 0755 /some/where/scriptfile</emphasis>'
-   should do it.
-  </para>
-  <para>
-   The idea is that you run the script instead of TF directly. The
-   script changes your current locale and forces the terminal via
-   special terminal control code to use it, and changes it back
-   after TF exits.
+<para>
+ You will need to copy+paste the script, or download it
+ <ulink url="http://tnsp.org/~ccr/ggrtf/tf5.sh">from here</ulink>.
+ You should place the script in some directory in your $PATH. You
+ will also need to modify it to point to the correct TinyFugye executable,
+ (e.g. change "/usr/bin/tf5" if needed.) Name the script as something
+ like "mytf" or rename the real TinyFugue executable as "tf5-bin" and
+ the script as "tf5", changing the script to point to tf5-bin.
+</para>
+<para>
+ Remember to set the script executable by changing
+ its permissions, '<emphasis>chmod 0755 /some/where/scriptfile</emphasis>'
+ should do it.
+</para>
+<para>
+ The idea is that you run the script instead of TF directly. The
+ script changes your current locale and forces the terminal via
+ special terminal control code to use it, and changes it back
+ after TF exits.
+</para>
+</section> <!-- Unix-likes -->
+
+
+</section>
+
+<section id="inst-config-tf-term"><title>Terminal/keyboard issues</title>
+<para>
+You need to make sure that you have the correct keyboard module(s) loaded.
+For most Linux/UNIX terminals you want to load EITHER or BOTH 
+<emphasis>kbd-xterm.tf</emphasis> and <emphasis>kbd-tf5def.tf</emphasis>.
+For TF on Windows and Mac OSX, you may wish to use
+<emphasis>kbd-tf5def.tf</emphasis> only. You may need to experiment.
+</para>
+<para>
+Additionally, it may be necessary to enable the so-called "application mode"
+in your terminal.
+</para>
+<itemizedlist>
+ <listitem>
+  <para>In OSX terminal app, the setting can be found in <emphasis>Terminal /
+  Preferences / Setting / Advanced</emphasis> and turn on
+  "Allow VT100 application keypad mode".
   </para>
  </listitem>
-
  <listitem>
   <para>
+   In PuTTY, the application keypad mode should be enabled by default,
+   but if it is not, see the Features panel of PuTTY's configuration,
+   see <ulink url="http://the.earth.li/~sgtatham/putty/0.60/htmldoc/Chapter4.html#config-appkeypad">PuTTY documentation here</ulink>.
   </para>
  </listitem>
 </itemizedlist>
-
-</section>
-
-<!--
-- intro
-- layout of recommended configuration
-- discussion about modules
-- simple example configuration
-- bindings or not?
-- state saving
--->
+</section> <!-- Terminal -->
+
 </section>
 
 
@@ -3382,22 +3403,9 @@
        <para>The keypad/numpad functionality (movement, targetting) is not working.</para>
      </question>
      <answer>
-       <para>
-       You need to make sure that you have the correct keyboard module(s) loaded.
-       For most Linux/UNIX terminals you want to load EITHER or BOTH kbd-xterm.tf 
-       and kbd-tf5def.tf. For TF on Windows and Mac OSX, you may wish to use
-       kbd-tf5def.tf only.
-       </para>
-       <para>
-       Additionally, it may be necessary to enable the so-called "application mode"
-       in your terminal. In OSX terminal app, the setting can be found in
-       Terminal/Preferences/Setting/Advanced and turn on "Allow VT100 application keypad mode".
-       </para>
-       <para>
-       In PuTTY, the application keypad mode should be enabled by default, but if
-       it is not, see the Features panel of PuTTY's configuration, see
-       <ulink url="http://the.earth.li/~sgtatham/putty/0.60/htmldoc/Chapter4.html#config-appkeypad">PuTTY documentation here</ulink>.
-       </para>
+       Make sure you have configured your terminal correctly,
+       refer to <link linkend="inst-config-tf-term">terminal configuration</link>
+       section for more information.
      </answer>
   </qandaentry>
 <!--