changeset 275:3e167dd18d60

Updates.
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 16 Feb 2006 22:02:22 +0000
parents b32bdb9db447
children a1acf2b3de87
files docs/manual.sgml
diffstat 1 files changed, 132 insertions(+), 38 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Thu Feb 16 22:02:18 2006 +0000
+++ b/docs/manual.sgml	Thu Feb 16 22:02:22 2006 +0000
@@ -13,15 +13,20 @@
 -->
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 <!-- Define some entities -->
-<!ENTITY ggrtf_ver "v0.5.9.x/v0.6.0">
+<!ENTITY ggrtfver "v0.5.9.x/v0.6.0">
 
-<!ENTITY tfugue "<ulink url='http://tf.tcp.com/'>TinyFugue</ulink>">
+<!ENTITY jeskko "<ulink url='http://jeskko.pupunen.net/'>Jarkko Vääräniemi</ulink> (<ulink url='http://www.bat.org/help/finger.php?str=jeskko'>Jeskko</ulink>)">
+<!ENTITY ggr "<ulink url='http://ccr.tnsp.org/'>Matti Hämäläinen</ulink> (<ulink url='http://www.bat.org/help/finger.php?str=ggr'>Ggr</ulink>)">
+
+<!ENTITY tfurl "<ulink url='http://tf.tcp.com/'>TinyFugue</ulink>">
 <!ENTITY homeurl "<ulink url='http://ccr.tnsp.org/ggrtf/'>http://ccr.tnsp.org/ggrtf/</ulink>">
 <!ENTITY svnrepo "<ulink url='http://svn.pupunen.net/public/ggrtf/trunk/'>Subversion-repository</ulink>">
 <!ENTITY svnurl "<ulink url='http://subversion.tigris.org/'>Subversion</ulink>">
-<!ENTITY batmud "<ulink url='http://www.bat.org/'>BatMUD</ulink>">
+<!ENTITY batmudurl "<ulink url='http://www.bat.org/'>BatMUD</ulink>">
+<!ENTITY pupuneturl "<ulink url='http://www.pupunen.net/'>Pupunen.net</ulink>">
+<!ENTITY gnupgurl "<ulink url='http://www.gnupg.org/'>GnuPG</ulink>">
+
 <!ENTITY exampletfrc "<section><title>Example configuration</title>">
-
 <!ENTITY validval "Valid values:">
 <!ENTITY validonoff "<emphasis>on</emphasis>, <emphasis>off</emphasis>">
 
@@ -108,8 +113,8 @@
 
 <para>
 It would be hard to completely describe what GgrTF is as a whole, but I
-like to think about it as a framework for triggers/macros for &tfugue;
-MUD-client to ease playing of &batmud;. What differentiates GgrTF from
+like to think about it as a framework for triggers/macros for &tfurl;
+MUD-client to ease playing of &batmudurl;. What differentiates GgrTF from
 most other publicly available triggersets, is how it is laid
 out reasonably well for is modularity and has been designed from
 ground-up as framework for easy extending. Many other publicly available
@@ -121,7 +126,7 @@
 <para>
 It must be admitted that GgrTF is a somewhat programmer-oriented, it is
 not all that well documented (although we are trying remedy that) and
-most likely requires knowledge of how &tfugue; and its macro language
+most likely requires knowledge of how &tfurl; and its macro language
 works. As such GgrTF is not a ready out-of-the-box experience and
 never will be. Some other scripts may offer more in the automation
 and pre-made hook department, GgrTF's aims are different, however.
@@ -130,11 +135,11 @@
 <para>
 That being said, I do know some people who have no TF-scripting experience
 to begin with, but are using GgrTF anyway. If you know how to install
-and setup &tfugue; properly, GgrTF should not be too hard to set up either.
+and setup &tfurl; properly, GgrTF should not be too hard to set up either.
 </para>
  
 <para>
-The current version (as of &ggrtf_ver; release) has modules
+The current version (as of &ggrtfver; release) has modules
 for following character classes:
 </para>
 <itemizedlist>
@@ -185,13 +190,13 @@
 "you do not instantly get a headache from just looking at the code."</para></listitem>
    <listitem><para>Modularity, easily extendable for most part.</para></listitem>
    <listitem><para>Updated regularly, most bugs get fixed in upstream.</para></listitem>
-   <listitem><para>Some user-level documentation exists.</para></listitem>
+   <listitem><para>User-level documentation exists.</para></listitem>
   </itemizedlist>
  </listitem>
 
  <listitem><para>Cons:</para>
   <itemizedlist>
-   <listitem><para>Only small number of &batmud;'s guilds are specifically supported.</para></listitem>
+   <listitem><para>Only small number of &batmudurl;'s guilds are specifically supported.</para></listitem>
 <!--
    <listitem><para></para></listitem>
    <listitem><para></para></listitem>
@@ -210,7 +215,7 @@
 
 <para>
 About two years ago, in march of 2004, I made one of the worst
-mistakes in my life - I created a character in &batmud;.
+mistakes in my life - I created a character in &batmudurl;.
 I never thought of myself to be much of a gamer, I've always
 been more interested in more technical things, programming
 and a little bit of hardware (not analog, though), so
@@ -222,7 +227,7 @@
 
 <para>
 Started off playing with plain telnet for the first month
-or so, then installed &tfugue;, because it seemed to be
+or so, then installed &tfurl;, because it seemed to be
 the most popular of the clients available for UNIXish platforms.
 First I didn't use any triggers at all, TF was just there
 to work as better terminal and separating the input from
@@ -244,7 +249,7 @@
 developing my own piece of turf, starting out very simple,
 expanding and improving when needed. That continued for about
 a year or a bit over, then the situation got out of hand -
-I started "releasing" GgrTF periodically on my &batmud; related
+I started "releasing" GgrTF periodically on my &batmudurl; related
 web-page.
 </para>
 
@@ -289,36 +294,56 @@
 
 <chapter id="installation"><title>Installation</title>
 <para>
-This chapter assumes that you have already succesfully installed &tfugue;
-in your system and you know how to use it (basic commands, loading macros, etc.)
-It is also assumed that you know how to use your operating system of choice,
-be it some flavour of UNIX or Windows, although some parts of the instructions
-are given in step-by-step manner. This is in case of OS or TF-related problems,
-which you will most probably have to solve yourself.
+This chapter assumes that you have already succesfully installed &tfurl;
+in your system and you know how to use it (basic commands, loading of
+macros, etc.) It is also assumed that you know how to use your operating
+system of choice, be it some flavour of UNIX or Windows, although some
+parts of the instructions are given in step-by-step manner.
 </para>
 
 <!-- ================================================ -->
 
 <section id="inst-getting"><title>Getting GgrTF</title>
 
-<section id="inst-releases"><title>Releases</title>
 <para>
-Releases are considered as stable snapshots, which should be
-relatively bug-free, though that may not mean much at this
-phase of development.
+There are basically two ways how to get GgrTF, release packages and the
+Subversion-repository. Releases are considered as stable snapshots,
+which should be relatively bug-free, but releases are done somewhat
+infrequently and at least at this phase we don't backport bugfixes
+to release versions.
 </para>
 
 <para>
+Another way to get GgrTF is to go to the very source, the
+development source repository. This repository contains the latest
+bleeding edge features, but is also a fast moving target. Changes
+are directly "pushed" (committed) by developers almost in real time,
+sometimes what you download may be severely broken.
+Also the documentation will not be updated for every little change,
+so you may have to figure out and work around possible backward
+incompatibilities yourself.
+</para>
+
+<para>
+New features and new bugfixes may sometimes be worth taking the risk
+of using the Subversion-repository. On the other hand, it is all up
+to what you want and whether you can manage to handle the possibly
+arising problems.
+</para>
+
+
+<section id="inst-releases"><title>Releases</title>
+<para>
 Stable releases are available from downloads-section of 
 <ulink url="http://ccr.tnsp.org/ggrtf/">GgrTF's homepage</ulink>,
 either as tar.gz or zip-packages. Both files also have equivalent
-PGP/GnuPG signature files (*.asc), which can be used to cryptographically
+PGP/&gnupgurl; signature files (*.asc), which can be used to cryptographically
 verify the authenticity of content, in case you want to be sure that you
 are getting unmodified files directly from the author.
 </para>
 
 <para>
-To verify the signatures with GnuPG, you can use following commands:
+To verify the signatures with &gnupgurl;, you can use following commands:
 </para>
 
 <itemizedlist>
@@ -336,25 +361,88 @@
 
 <para>
 Please refer to GnuPG or PGP documentation for more information about
-their usage, PKI, cryptography and public key signing.
+their usage. A great introduction to PKI, cryptography and public key
+signing, the <ulink url="http://www.gnupg.org/gph/en/manual.html">
+GNU Privacy Handbook</ulink> is available from GnuPG project.
+(Versions in other languages and formats, including PDF, are available
+from <ulink url="http://www.gnupg.org/(en)/documentation/guides.html">
+http://www.gnupg.org/(en)/documentation/guides.html</ulink>.)
 </para>
 </section>
 
 
 <section id="inst-subversion"><title>Subversion-repository</title>
 <para>
-Another way to get GgrTF is to go to the very source, aka the development
-source repository. For managing GgrTF's version/source management we
-currently use Subversion, which is Open Source and client software is
-available for most platforms. (Previously we used CVS, which is still the
-most dominant versioning/source management software, but later decided
-to move to SVN as a compromise due to certain development reasons.)
+We utilize &svnurl; (SVN) for GgrTF's version management, an version
+control system, which is Open Source and there are clients available
+for most common platforms, including Windows, Linux and other flavours
+of UNIX.
 </para>
 
 <para>
+GgrTF's Subversion repository is graciously hosted by &jeskko;
+at &pupuneturl;, and is available from following location:
+</para>
+<itemizedlist>
+ <listitem>
+  <para>Trunk-repository, all the latest stuff goes here:</para>
+  <para><ulink url="http://svn.pupunen.net/public/ggrtf/trunk/">http://svn.pupunen.net/public/ggrtf/trunk/</ulink></para>
+ </listitem>
+ <listitem>
+  <para>You can browse the repository more easily via &pupuneturl;'s ViewCVS interface:</para>
+  <para><ulink url="http://svn.pupunen.net/viewcvs.py/ggrtf/trunk/">http://svn.pupunen.net/viewcvs.py/ggrtf/trunk/</ulink></para>
+ </listitem>
+</itemizedlist>
 
+<section><title>Checking out</title>
+<para>
+You can download ("checkout") the GgrTF repository with command line
+Subversion client with following command:
 </para>
 
+<screen>
+svn co http://svn.pupunen.net/public/ggrtf/trunk/ ggrtf
+</screen>
+
+<para>
+In which <emphasis>co</emphasis> stands for "checkout", then comes URL
+of the repository and finally path to directory which the files will
+be copied into.
+</para>
+
+<para>
+You will most probably want to download the repository to some
+specific place, personally I prefer to use $HOME/tf/ (aka "tf/"
+subdirectory under user's homedir) under UNIX.
+<!--
+If you are using TF for Windows, it is probably wisest to place
+GgrTF's files under ... ????
+-->
+</para>
+</section>
+
+<section><title>Updating</title>
+<para>
+After you have checked out your own copy of GgrTF's code repository,
+you may wish to periodically update it. This is done easily with 
+Subversion's "update" command. First go to the repository directory
+and then issue "svn update" or the shorthand "svn up", as follows:
+</para>
+
+<screen>
+cd ggrtf
+svn up
+</screen>
+
+<para>
+If you have made changes to the files, Subversion tries to merge them
+with changes that have occured in the main repository. Sometimes the
+changes may be interfering with each other and this causes a merging
+error. You must fix these problems by hand, please refer to Subversion
+documentation for more information and tips.
+</para>
+</section>
+
 </section>
 </section>
 
@@ -408,10 +496,15 @@
 
 <section id="usage-magical"><title>Magical guilds support module (ggrtf-magical.tf)</title>
 <para>
-Support for all things magical. This module is <emphasis>required</emphasis>
-for supporting spells/casting. It is not required for being the receiving
+Base module for all things magical. This module is <emphasis>required</emphasis>
+for supporting spells/casting. It is not necessary for being the receiving
 end of prots or such.
 </para>
+
+<para>
+Some other modules require ggrtf-magical.tf to be loaded in order to work.
+</para>
+
 </section>
 
 <!-- ================================================ -->
@@ -1017,9 +1110,10 @@
 
 <section id="usage-alch"><title>Guild: Alchemists (ggrtf-alch.tf)</title>
 
-<para>This is (a slightly outdated) module with some helper macros for Alchemists. The module hasn't been tested recently, 
-so there might be some problems with some of its features. Main features are can/jar contents compressor and potion mixing
-macro.
+<para>This is (a slightly outdated) module with some helper macros for
+Alchemists. The module has not been tested recently, so there may be
+some problems with some of its features. Main features are can/jar
+contents compressor and potion mixing helper macro.
 </para>
 
 <para>To use the potion mixer macro, you need to define your own can/jar names and contents in the macro sources. Other