changeset 278:a06334daf5b0

More updates.
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 16 Feb 2006 23:52:30 +0000
parents 97573984c928
children 0c28d658f4d9
files docs/manual.sgml
diffstat 1 files changed, 45 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Thu Feb 16 22:58:08 2006 +0000
+++ b/docs/manual.sgml	Thu Feb 16 23:52:30 2006 +0000
@@ -450,10 +450,12 @@
 
 <section id="inst-setup"><title>Setup</title>
 <para>
+<!--
 - intro
 - layout of recommended configuration
 - discussion about modules
 - simple example configuration
+-->
 </para>
 </section>
 
@@ -477,8 +479,8 @@
 </para>
 
 <itemizedlist>
- <listitem><para><link linkend="usage-general-statusbar">Statusbar functionality</link></para></listitem>
- <listitem><para><link linkend="usage-general-prots">Prot management</link></para></listitem>
+ <listitem><para><link linkend="usage-general-statusbar">Statusbar</link>. Nice, realtimeish view of your character's current condition, applied prots and such.</para></listitem>
+ <listitem><para><link linkend="usage-general-prots">Prot management</link>. Keeps note of what prots have been cast at you, and provides this information in various ways.</para></listitem>
  <listitem><para>Battle round handling. Enables commands to be executed each battle round and autopss functionality.</para></listitem>
  <listitem><para>Prompt gagging and skill/spell viewing in prompt. Shows the currently ongoing skill or spell in your prompt.</para></listitem>
  <listitem><para>Spell round reporting. Enables you to optionally spam your fellow players with information how many rounds are left until your spell goes off.</para></listitem>
@@ -489,24 +491,46 @@
  <listitem><para>Keep and view statistics about skills, spells and whatnots. (/stats)</para></listitem>
 </itemizedlist>
 
+
 <section id="usage-general-statusbar"><title>Statusbar</title>
 <para>
 </para>
+<screenshot>
+ <screeninfo>An example of a typical statusbar</screeninfo>
+ <mediaobject>
+  <imageobject><imagedata fileref="statusbar.gif" format="GIF"></imageobject>
+  <imageobject><imagedata fileref="statusbar.eps" format="EPS"></imageobject>
+ </mediaobject>
+</screenshot>
 </section>
 
+
 <section id="usage-general-prots"><title>Prot management</title>
 <para>
 </para>
 </section>
 
+
 <section id="usage-general-skillspell"><title>Skill handling</title>
 <para>
 </para>
 </section>
 
+
+<section id="usage-general-prmove"><title>Keyboard numpad movement hooks</title>
+<para>
+</para>
+</section>
+
+
 <section id="usage-general-commands">
 &sectmacros;
 </para>
+<para>
+Each of these commands will print current setting/value and
+usage information if executed without arguments (or in some cases,
+with incorrect arguments).
+</para>
 
 <table><title>Macro commands</title>
  <tgroup cols="2" align="left">
@@ -522,27 +546,35 @@
     <entry>Lists all the settings of GgrTF, with short descriptions and current values.</entry>
    </row>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/stats</entry>
+    <entry>Display miscellaneous statistics about skills, spells, etc.</entry>
    </row>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/move &lt;type&gt;</entry>
+    <entry>Change the meaning of <link linkend="usage-general-prmove">keyboard movement hooks</link>.</entry>
    </row>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/ripaction &lt;action&gt;</entry>
+    <entry>Set the action performed at monster RIP. Possible valid
+settings may depend on additional loaded modules. Functions provided by
+base GgrTF are: <emphasis>off</emphasis> (no special action performed),
+<emphasis>dig</emphasis> (dig grave for corpse),
+<emphasis>eat</emphasis> (get and eat corpse),
+<emphasis>get</emphasis> (get corpse) and
+<emphasis>cmd</emphasis> (execute mud command(s) specified with
+/ripcommand setting)
+    </entry>
    </row>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/ripcommand &lt;commands&gt;</entry>
+    <entry>Sets the BatMUD command(s) to be executed if /ripaction is set to "cmd".</entry>
    </row>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/round &lt;commands&gt;</entry>
+    <entry>Sets the BatMUD command(s) to be executed on each battle round.</entry>
    </row>
    <row>
-    <entry></entry>
+    <entry>/locaction &lt;action&gt;</entry>
     <entry></entry>
    </row>
    <row>