Mercurial > hg > batmud > ggrtf
changeset 1425:429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Mon, 08 Aug 2011 10:14:36 +0300 |
parents | 6a0876dfc9d4 |
children | d39ecd0e850e |
files | docs/manual.sgml |
diffstat | 1 files changed, 5 insertions(+), 196 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/manual.sgml Mon Aug 08 10:14:10 2011 +0300 +++ b/docs/manual.sgml Mon Aug 08 10:14:36 2011 +0300 @@ -891,202 +891,11 @@ <section id="usage-general-commands"> §macros_1; </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"> - <thead> - <row> - <entry>Command</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>/opts</entry> - <entry>Lists all the run-time changeable settings of GgrTF, -with short descriptions and current values. -</entry> - </row> - <row> - <entry>/stats</entry> - <entry>Display miscellaneous statistics about skills, spells, etc.</entry> - </row> - <row> - <entry>/move <type></entry> - <entry>Change the meaning of - <link linkend="usage-general-prmove">keyboard movement hooks</link>. - </entry> - </row> - <row> - <entry>/ripaction <action></entry> - <entry> -Set the action performed at opponent RIP. Possible additional settings -may be provided by other 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, see /ripcommand) - </entry> - </row> - <row> - <entry>/ripcommand <commands></entry> - <entry> -Sets the MUD command(s) to be executed if /ripaction is -set to "cmd". This string is sent to the MUD at opponent R.I.P, -if /ripaction is "cmd". -</entry> - </row> - <row> - <entry>/round <commands></entry> - <entry> -Sets the BatMUD command(s) to be executed on each battle round. -The string of commands is sent to the MUD when battle round flag -is received. -</entry> - </row> - <row> - <entry>/locaction <action></entry> - <entry> -Sets action taken after a Lord of Chaos performs "blood corpse". -This is useful for automating corpse handling, if you are a LoC -yourself, or are partying with one. -</entry> - </row> - <row> - <entry>/lichaction <action></entry> - <entry> -Sets action taken after a Lich performs "soul sucking". -</entry> - </row> - <row> - <entry>/prots</entry> - <entry> -Show any currently active prots on you. The output is only echoed -locally, use BatMUD 'tweak me' emote to list prots to party -report-channel. -</entry> - </row> - <row> - <entry>/cprots</entry> - <entry> -This command clears all prots on you. It is meant for those cases -where GgrTF is either bugging and does not notice a prot dropping, -or any other reason when you need to remove all prots at your -discretion. -</entry> - </row> - <row> - <entry>/shape</entry> - <entry> -Reports the last catched shape of a opponent (monster) in battle. -This does not work too well if you were fighting more than one opponents. -</entry> - </row> - <row> - <entry>/gver</entry> - <entry> -Prints (or returns, if called as function) a short version string of GgrTF. -</entry> - </row> - <row> - <entry>/gversion</entry> - <entry> -Prints (or returns, if called as function) a long version string of -GgrTF with copyright- and TinyFugue version information. -</entry> - </row> - <row> - <entry>/autopss</entry> - <entry> -Toggle autopss-functionality on/off. If enabled, /pss macro is executed -on each battle round flag. By default, /pss is 'party short status', but -some modules (like <link linkend="usage-pssmangle">PSS-mangler</link>) override this to -provide additional functionality. -</entry> - </row> - <row> - <entry>/binds</entry> - <entry> -List all currently defined GgrTF command bindings. Refer to -<link linkend="usage-general-binds">bindings</link> section for -more information and example output. -</entry> - </row> - <row> - <entry>/gsave</entry> - <entry> -Save all GgrTF settings. Refer to <link linkend="usage-general-saves"> -state saving</link> section for more information. -</entry> - </row> - <row> - <entry>/gload</entry> - <entry> -Load GgrTF settings. Refer to <link linkend="usage-general-saves"> -state saving</link> section for more information. -</entry> - </row> - <row> - <entry>/greset</entry> - <entry> -Reset all skill/spell counters and statistics. Notice that issuing -this command also requires executing of "/gsave" if you want to save -the zeroed statistics, otherwise the old saved statistics will be -loaded on next /gload. -</entry> - </row> - <row> - <entry>/rmisc</entry> - <entry> - Toggle miscellaneous reporting features. - </entry> - </row> - - <row> - <entry>use consider at <monster></entry> - <entry> - Whatever method you employ to use 'consider' skill, - the output will be caught by consider-reporting trigger. - </entry> - </row> - - <row> - <entry>/rcda</entry> - <entry> - Toggle reporting of Combat Damage Analysis. If set 'off', - CDA reports are only displayed locally to you, if set 'on', - reporting is done to party report channel. - </entry> - </row> - - <row> - <entry>/ceremony</entry> - <entry> - Perform skill 'ceremony', but only if ceremony is not already "active". - </entry> - </row> - - <row> - <entry>/gprompt [prompt string]</entry> - <entry>Set or change GgrTF's displayed prompt. The setting can contain - any TinyFugue expressions, such as variable substitutions. Refer to - <link linkend="usage-general-prompt">prompt settings section</link> for details.</entry> - </row> -<!-- - <row> - <entry></entry> - <entry></entry> - </row> ---> -§macros_end; + +<!-- @commands --> +<!-- @binds --> + +</section> </section>