Mercurial > hg > batmud > ggrtf
changeset 267:e7d531760dd9
Updates.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Wed, 15 Feb 2006 06:47:45 +0000 |
parents | 925e375757e0 |
children | 2b870ccb1b1d |
files | docs/manual.sgml |
diffstat | 1 files changed, 110 insertions(+), 43 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/manual.sgml Wed Feb 15 05:42:26 2006 +0000 +++ b/docs/manual.sgml Wed Feb 15 06:47:45 2006 +0000 @@ -260,22 +260,72 @@ <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. </para> <!-- ================================================ --> <section id="inst-getting"><title>Getting GgrTF</title> -<para> -</para> <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. +</para> + +<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 +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: +</para> + +<itemizedlist> + <listitem><para>Retrieve Matti 'ccr' Hämäläinen's public key from a keyserver:</para> +<screen> +gpg --keyserver wwwkeys.pgp.net --recv-keys 0x1374C112 +</screen> +</listitem> + <listitem><para>Verify the package signature (assuming you have downloaded both the file and signature):</para> +<screen> +gpg --verify ggrtf-0.6.0.tar.gz +</screen> +<para>(Obviously you have to substitute the filename with the correct one.)</para></listitem> +</itemizedlist> + +<para> +Please refer to GnuPG or PGP documentation for more information about +their usage, PKI, cryptography and public key signing. </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 available for many +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 for certain development reasons.) </para> + +<para> + +</para> + </section> </section> @@ -360,68 +410,95 @@ </para> <screenshot> - <screeninfo>An example image</screeninfo> + <screeninfo>An example of pss-mangler's output</screeninfo> <mediaobject> - <imageobject><imagedata fileref="pss_normal.gif" format="GIF" /></imageobject> + <imageobject><imagedata fileref="pss_normal.gif" format="GIF"></imageobject> </mediaobject> </screenshot> +<screenshot> + <mediaobject> + <imageobject><imagedata fileref="pss_stun.gif" format="GIF"></imageobject> + </mediaobject> +</screenshot> + +<screenshot> + <mediaobject> + <imageobject><imagedata fileref="pss_uncon.gif" format="GIF"></imageobject> + </mediaobject> +</screenshot> + + <section><title>HP/SP/EP colours</title> <table><title>List of possible indicator colours and their meanings</title> - <tgroup cols="3" align="left"> + <tgroup cols="2" align="left"> <thead> <row> <entry>Colour</entry> - <entry>Colour name</entry> <entry>Explanation</entry> </row> </thead> <tbody> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>White on Red background</entry> + <entry>Negative value (x < 0)</entry> + </row> + <row> + <entry>Light Red</entry> + <entry>Less than 16% of max</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Red (dark)</entry> + <entry>Less than 33% of max</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Yellow (dark)</entry> + <entry>Less than 49% of max</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Light Yellow</entry> + <entry>Less than 66% of max</entry> + </row> + <row> + <entry>Green (dark)</entry> + <entry>Less than 85% of max</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Light Green</entry> + <entry>More than 85% of max</entry> </row> + </tbody> + </tgroup> +</table> +</section> + +<section><title>Player name colours</title> + +<table><title>List of possible name colours and their meanings</title> + <tgroup cols="2" align="left"> + <thead> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Colour</entry> + <entry>State description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Light White</entry> + <entry>Normal</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>White on Red background</entry> + <entry>Unconscious (unc)</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Light Red</entry> + <entry>Stunned (stun)</entry> </row> <row> - <entry></entry> - <entry></entry> - <entry></entry> + <entry>Magenta</entry> + <entry>In form (form), member (mbr) or resting (rest)</entry> </row> </tbody> </tgroup> @@ -429,17 +506,7 @@ </section> -<screenshot> - <mediaobject> - <imageobject><imagedata fileref="pss_stun.gif" format="GIF" /></imageobject> - </mediaobject> -</screenshot> -<screenshot> - <mediaobject> - <imageobject><imagedata fileref="pss_uncon.gif" format="GIF" /></imageobject> - </mediaobject> -</screenshot> <section><title>Macro commands</title> <para>&argdesc;</para>