home *** CD-ROM | disk | FTP | other *** search
/ HomeWare 14 / HOMEWARE14.bin / os2 / tt2_099.arj / HELP.TXT < prev    next >
Text File  |  1994-02-08  |  20KB  |  673 lines
  1.  
  2. Help available on the following:
  3.  
  4. alias                 action             all
  5. antisubstitute        bell               boss
  6. char                  echo               end
  7. help                  highlight          history
  8. if                    ignore             log
  9. loop                  map                mark
  10. math                  message            nop
  11. path                  presub             return
  12. read                  savepath           showme
  13. snoop                 speedwalk          stat
  14. substitute            gag                system
  15. tick                  tickoff            tickset
  16. ticksize              togglesubs         unaction
  17. unalias               unantisubstitute   ungag
  18. unhighlight           unpath             unsplit
  19. unsubstitute          unvariable         verbatim
  20. version               wizlist            write
  21. writesession          zap
  22.  
  23. Any problems with this beta release should be reported to
  24. coneil@symantec.com.
  25.  
  26. ~ALIAS
  27.  
  28. format:     #alias [{word}] [{command(s)}]
  29.             #alias [word] [command]
  30.  
  31. the [] signify optional arguments.
  32.  
  33. Define a word that actually means a longer string.  Useful for commands 
  34. repeated often, or commands that are very lengthy.  You can have multiple
  35. commands aliased to a single word, if you enclose the alias in {}.
  36.  
  37. If the command(s) include variables %0-9, these are substituted as part
  38. of the parsing.  %0 is set to all text after the word was input, %1 is set
  39. to the first word following the aliased word, and %2 is the second, and so on.
  40.  
  41. If the #alias command is typed without any arguments, all aliases defined will
  42. be listed.
  43.  
  44. If the #alias command is typed with only 1 argument, occurrences matching the
  45. input string are shown.  The * character is valid in this word to act as a
  46. 'wildcard'.
  47.  
  48. examples:
  49. #alias gb get bread bag
  50. typing gb at the prompt would be sent as 'get bread bag'.
  51. #alias ws {wake;stand}
  52. since ws aliases a multiple command, you must use the braces.
  53. #alias heal cast 'heal' %1
  54. typing 'heal valgar' at the prompt would be sent as 'cast 'heal' valgar' since
  55. it will put the word valgar into %1
  56. #alias
  57. list all aliases
  58. #alias he*
  59. list all aliases that start with the letters 'he'
  60.  
  61. ~ACTION
  62.  
  63. format:     #action [{string}] [{command(s)}]
  64.  
  65. The [] signify optional arguments.
  66.  
  67. Have the client search for a certain string of text from the mud, if the 
  68. client receives that string, it will execute the command(s).  Variables
  69. %0-9 are substituted from the input string, and can be used in the command(s)
  70. side of the command.
  71.  
  72. if the string to be searched for starts with a ^, only the beginning of the 
  73. line will be searched.
  74.  
  75. If #action is type with no arguments, all actions defined are listed.
  76.  
  77. If #action is typed with only one argument, actions defined that match that
  78. argument are displayed.  The * character is valid in this case to use
  79. as a 'wildcard'.
  80.  
  81. examples:
  82. #action {Grimmy has arrived} {smile grimmy}
  83. If Grimmy enters the room, you will automatically smile at her.
  84. #action {^TICKCOUNTER: 5 seconds} {sleep}
  85. Since this string is 'anchored', it will only be triggered if it starts at
  86. the beginning of a line.  If your mud has a tickcounter set up like this, 
  87. this action will make you sleep at 5 seconds to tick.
  88. #action 
  89. list all actions
  90. #action *tell*
  91. list all actions with the word 'tell' in them.
  92.  
  93. ~ALL
  94.  
  95. format:      #all {string}
  96.              #all string
  97.  
  98. Send a command to all active sessions.
  99.  
  100. example:
  101. #all {shout I'm multicharing!}
  102.  
  103. ~ANTISUBSTITUTE
  104.  
  105. format:      #antisubstitute {string}
  106.              #antisubstitute string
  107.  
  108. Will cause any line that contains the string specified to not be checked for
  109. substitutes and gags.  The ^ char starting a string will tell the client to
  110. only antisubstitute lines that START with the string specified.
  111.  
  112. examples:
  113. #antisub {^You}
  114. any line starting with 'You' will not be checked for subs.
  115. #antisub {^You%0hit.}
  116. lines that start with 'You', and also contain 'hit.' will not be subbed.
  117. #antisub {annihilate}
  118. any line that contains the word 'annihilate' will not be subbed.
  119.  
  120. ~BELL
  121.  
  122. format:       #bell
  123.  
  124. sends a beep to your terminal.
  125.  
  126. example:
  127. #action {tells you} {#bell}
  128. will chime any time anyone tells you anything.
  129.  
  130. ~BOSS
  131.  
  132. format:       #boss
  133.  
  134. puts some fake text on your screen so nobody knows you're mudding.
  135.  
  136. ~CHAR
  137.  
  138. format:       #char character
  139.  
  140. lets you redefine your tintin_character, the character that starts all commands.
  141.  
  142. example:
  143. #char /
  144. all commands must then start with a /, instead of a #.  
  145.  
  146. The default tintin char can be set in tintin.h, and if you load a coms file, the
  147. first character it sees is set to your tintin char.
  148.  
  149. ~ECHO
  150.  
  151. format:       #echo
  152.  
  153. Echo is used to output text the local screen and also turn off input from the
  154. mud side of the connection.  Echo works in the following manner
  155.  
  156.   #echo                #Echo is now ON      /* reports status */
  157.   #echo on             #Echo is now ON
  158.   #echo off            #Echo is now OFF
  159.   #echo on silent                           /* turns on the echo, no output */
  160.   #echo off silent
  161.   #echo This is a test This is a test
  162.  
  163. This means that repetive actions like #10 {buy bread;put bread bag} can
  164. become #echo off silent;#10 {buy bread;put bread bag}; #echo on silent.
  165. Unfortunately, the #echo command is currently assuming silent.  Bad #echo,
  166. bad!
  167.  
  168. ~END
  169.  
  170. format:       #end
  171.  
  172. terminate tintin++ and return to unix.  On most systems, ctrl-C has the same 
  173. effect.
  174.  
  175. ~HELP
  176.  
  177. format:       #help [command]
  178.  
  179. Get a listing of commands, or get help and a specific command.
  180.  
  181. ~HIGHLIGHT
  182.  
  183. format:       #highlight [{type}] [{string}]
  184.               #highlight [type] [{string}]
  185.  
  186. The [] signify optional arguments.
  187.  
  188. The higlight command is used to allow you to highlight strings of text from
  189. the mud.  The possible types are bold, reverse, faint, italic, blink, or
  190. a number between 1 and 8.  The numbers correspond to colors 1 through 8
  191. of your color pallette.
  192.  
  193. The %0-9 variables can be used as 'wildcards' that will match with any text.
  194. They are useful for highlighting a complete line.
  195. You may start the string to highlight with a ^ to only highlight text
  196. if it begins the line.
  197.  
  198. Note: This command is only compatible with ANSI/VT100 terminals or emulators.
  199.  
  200. examples:
  201. #high {reverse} {Valgar}
  202. print every occurrence of 'Valgar' in reverse video
  203. #high {6} {%0tells you%1}
  204. print every complete line that contains 'tells you' in color 6
  205. #high bold {^You}
  206. boldface any 'You' that starts a line
  207.  
  208. ~HISTORY
  209.  
  210. format:        #history
  211.  
  212. The history command will display a listing of the most recent keyboard
  213. input.
  214.  
  215. ~IF
  216.  
  217. format:        #if {conditional} {command(s)}
  218.  
  219. The if command is one of the most powerful commands added since TINTINv3.
  220. It works similar to an if statement in other languages, and is loosely based
  221. on the way C handles its conditional statements.  When an if command
  222. is encountered, the conditional statement is evaluated, and if TRUE
  223. (any non-zero result) the command(s) are executed.  The if statement is
  224. only evaluated if it is read, so you must nest the if statement inside 
  225. another statement (most likely an action command).  The conditional is 
  226. evaluated exactly the same as in the math command, only instead of storing
  227. the result, the result is used to determine whether to execute the
  228. command(s).  '#help math' for more information.
  229.  
  230. examples:
  231. #action {%0 gives you %1 gold coins} {#if {%%1>5000} {thank %%0}}
  232. if someone gives you more than 5000 coins, thank them.
  233. the %%1 and %%0 belong to the action, and not to the if, and that is why
  234. the double % are needed.
  235. #action {^<hp:%0 } {#if {%%0<100} {flee}}
  236. If your status prompt is of the form <hp:100 ma:50 mo:100>, this action
  237. will get your hit points, compare them to 100, if less than 100, flee
  238.  
  239. ~IGNORE
  240.  
  241. format:        #ignore 
  242.  
  243. Toggle actions on and off. If off, no actions will be checked for.
  244.  
  245. ~LOG
  246.  
  247. format:        #log {filename}
  248.  
  249. Log session to a file.
  250.  
  251. ~LOOP
  252.  
  253. format:        #loop {start,finish} {command(s)}
  254.  
  255. Like a for-next loop, will loop from start to finish incrementing or
  256. decrementing by 1 each time through.  The value of the loop variable is 
  257. places in %0, and can be used in the command(s).  If start>finish, it will 
  258. loop backwards.
  259.  
  260. examples:
  261. #loop {1,3} {get all %0.corpse} 
  262. equivalent to the following:
  263.   get all 1.corpse;get all 2.corpse;get all 3.corpse
  264. #loop {3,1} {drop %0.key}
  265. equivalent to
  266.   drop 3.key;drop 2.key;drop 1.key
  267.  
  268. ~MAP
  269.  
  270. format:        #map {direction}
  271.  
  272. Will add a direction to the end of the current path.  Useful for mapping
  273. while following someone.
  274.  
  275. example:
  276.  
  277. #action {$leader leaves %0.} {#map {%%0}}
  278. if the person stored in $leader leaves the room, the direction is added
  279. to the end of the path.
  280.  
  281. ~MARK
  282.  
  283. format:        #mark
  284.  
  285. Clear the path list and start the new path at your current location.
  286.  
  287. ~MATH
  288.  
  289. format:        #math {variable} {expression}
  290.  
  291. Performs math functions and stored the result in a variable.  The math 
  292. follows a C-like precedence, as follows, with the top of the list having 
  293. the highest priority.
  294.  
  295. Operators                    Function
  296. ------------------------------------------------
  297. !                            logical not
  298. *                            integer multiply
  299. /                            integer divide
  300. +                            integer addition
  301. -                            integer subtraction
  302. >                            greater than (result is non-zero or zero)
  303. >=                           greater than or equal (result is non-zero or zero) 
  304. <                            less than (result is non-zero or zero)
  305. <=                           less than or equal (result is non-zero or zero)
  306. = or ==                      equals (result is non-zero or zero)
  307. !=                           not equal (result is non-zero or zero)
  308. & or &&                      logical and (result is non-zero or zero)
  309. | or ||                      logical or (result is non-zero or zero)
  310.  
  311. True is any non-zero number, and False is zero.  In the expression, you may
  312. use T and F as true and false.  Parentheses () have highest precedence, 
  313. so inside the parentheses is always evaluated first.
  314.  
  315. examples:
  316. #math {heals} {$mana/40}
  317. Assuming there is a variable $mana, divide its value by 40 and store the 
  318. result in $heals.
  319. #action {^You receive %0 experience} {updatexp %0}
  320. #alias updatexp {#math {xpneed} {$xpneed-%%0}
  321. Let's say you have a variable which stores xp needed for your next 
  322. level.  The above will modify that variable after every kill, showing
  323. the amount still needed.
  324.  
  325. ~MESSAGE
  326.  
  327. format:        #message {type}
  328.  
  329. This will toggle off and on the messages dealing with a certain type of
  330. command.  The possible message types are alias, action, antisub, sub
  331. variable, and highlight.  This is very helpful if you are using 
  332. #math and #if, and setting a lot of variables, so you don't keep getting
  333. the Variable Set messages.
  334.  
  335. example:
  336. #message {variable}
  337. toggles whether messages dealing with variables will be shown.
  338.  
  339. ~NOP
  340.  
  341. format:        #nop [string]
  342.  
  343. A null operation, is ignored by the client.  It is useful for commenting
  344. in your coms file, any text after the nop and before a semicolon or 
  345. end of line is ignored.
  346.  
  347. example:
  348. #nop This is the start of my autoactions
  349.  
  350. ~PATH
  351.  
  352. format:        #path
  353.  
  354. Show your current path.
  355.  
  356. ~PRESUB
  357.  
  358. format:        #presub
  359.  
  360. Toggle whether actions are processed before substitutes, or after.  With
  361. presub on, actions are performed on the substituted buffer, and if 
  362. you are gagging heavily, it will increase the speed of execution.  
  363. There are also many times you don't want to check for actions on 
  364. lines you have gagged, and this will allow that.
  365.  
  366. ~RETURN
  367.  
  368. format:        #return
  369.  
  370. Pop the last move off the top of the path, and move the opposite direction.
  371.  
  372. ~READ
  373.  
  374. format:        #read {filename}
  375.             or #read filename
  376.  
  377. Reads a coms file into memory.  The coms file is merged in with the
  378. currently loaded commands.  Duplicate commands are overwritten.
  379.  
  380. ~SAVEPATH
  381.  
  382. format:        #savepath {alias name}
  383.  
  384. Save the current path to an alias, which can then be saved to a coms file.
  385. The alias name provided will be the new name of the alias to represent
  386. that path.  Useful for after mapping to be able to get back to the place 
  387. again.
  388.  
  389. ~SHOWME
  390.  
  391. format:        #showme {string}
  392.  
  393. Display the string to the terminal, do not send to the mud.  Useful for
  394. status, warnings, etc.  
  395.  
  396. example:
  397. #action {%0 ultraslays you} {#showme {###### argh! we were ultraslayed ######}}
  398.  
  399. ~SNOOP
  400.  
  401. format:        #snoop {session name}
  402.  
  403. If there are multiple sessions active, this command allows you to see what
  404. is going on the the sessions that are not currently active.  The lines
  405. of text from other sessions will be prefixed by 'session name%'.
  406.  
  407. ~SPEEDWALK
  408.  
  409. format:        #speedwalk
  410.  
  411. Toggle speedwalking on and off.  Speedwalking allows you to type multiple
  412. directions not seperated by semicolons, and now it lets you prefix a 
  413. direction with a number, to signify how many times to go that direction.
  414.  
  415. example:
  416. without speedwalk:
  417. s;s;w;w;w;w;w;s;s;s;w;w;w;n;n;w
  418. with speedwalk:
  419. 2s5w3s3w2nw
  420.  
  421. ~STAT
  422.  
  423. format:        #stat text
  424.  
  425. Will display text on the status line.  Useful for displaying the current
  426. time, hitpoints, etc.  This may or may not work correctly if the session
  427. is not the active, but
  428.  
  429. ~SUBSTITUTE
  430.  
  431. format:        #substitute [{text}] [{new text}]
  432.  
  433. The [] signify optional arguments.
  434.  
  435. Allows you to replace original text from the mud with different text, or 
  436. delete it altogether.  This is helpful for if you have a slow modem, or 
  437. there is a lot of text sent during battles, and the like.  the %0-9
  438. variables can be used to capture text and use it as part of the new output, 
  439. and the ^ char is valid to only check the beginning of the line for the 
  440. text specified.
  441.  
  442. If a . is the only character in the new text argument, if the line is
  443. matched, it will be deleted.
  444.  
  445. If only one argument is given, all subs that match the string are displayed.
  446. The * char is valid in this instance.
  447.  
  448. If no argument is given, all subs are displayed.
  449.  
  450. examples:
  451. #sub {leaves} {.} 
  452. gag any line that has the word 'leaves' in it.
  453. #sub {^Zoe%0} {ZOE%0}
  454. any line that starts with the name Zoe will be replaced by a line that
  455. starts with 'ZOE'
  456. #sub {%0massacres%1} {%0MASSACRES%1}
  457. replace all occurrences of 'massacres' with 'MASSACRES'
  458.  
  459. ~GAG
  460.  
  461. format:        #gag {string}
  462.  
  463. Just like substitute, but the . is added for you.  Removes any line that 
  464. contains the string.
  465.  
  466. ~SYSTEM
  467.  
  468. format:        #system {command}
  469.  
  470. Executes the command specified as a shell command.  The name of the system
  471. command can be changed in tintin.h for your security.  
  472.  
  473. ~TICK
  474.  
  475. format:        #tick
  476.  
  477. Show seconds until next tick.
  478. This command is not functional in the 0.99 release of tintin++ for OS/2
  479.  
  480. ~TICKOFF
  481.  
  482. format:        #tickoff
  483.  
  484. Turn off the tintin++ built in tick counter.
  485. This command is not functional in the 0.99 release of tintin++ for OS/2
  486.  
  487. ~TICKSET
  488.  
  489. format:        #tickset
  490.  
  491. Turn on the tintin++ tickcounter, and set time until next tick equal 
  492. to tick size.
  493. This command is not functional in the 0.99 release of tintin++ for OS/2
  494.  
  495. ~TICKSIZE
  496.  
  497. format:        #ticksize number
  498.  
  499. Set a new time, in seconds,  between ticks for the tintin++ tickcounter.
  500. This command is not functional in the 0.99 release of tintin++ for OS/2
  501.  
  502. ~TOGGLESUBS
  503.  
  504. format:        #togglesubs
  505.  
  506. Toggle whether substitutes should be ignored.  If subs are ignored, 
  507. text will not be checked for subs, but highlights will still be 
  508. checked for.
  509.  
  510. ~UNACTION
  511.  
  512. format:        #unaction {string}
  513.                #unaction string
  514.  
  515. Remove action(s) from the action list which match {string}.  The
  516. '*' character will act as a wildcard and will match any text.
  517.  
  518. examples:
  519. #unaction {%0tells you%1}
  520. remove the action that is triggered by '%0tells you%1'
  521. #unaction *
  522. remove all actions
  523. #unaction {*massacre*}
  524. remove all actions that contain the word 'massacre'
  525.  
  526. ~UNALIAS
  527.  
  528. format:        #unalias {word}
  529.                #unalias word
  530.  
  531. Remove alias(es) from the alias list which match {word}.  The
  532. '*' character will act as a wildcard and will match any text.
  533.  
  534. examples:
  535. #unalias {bbb}
  536. remove the alias 'bbb'
  537. #unalias *
  538. remove all aliases
  539. #unalias {*go*}
  540. remove all aliases that contain the fragment 'go'
  541.  
  542. ~UNANTISUBSTITUTE
  543.  
  544. format:        #unantisubstitute {string}
  545.                #unantisubstitute string
  546.  
  547. Remove antisub(s) from the antisub list which match {string}.  The
  548. '*' character will act as a wildcard and will match any text.
  549.  
  550. examples:
  551. #unantisub {%0tells you%1}
  552. remove the antisub for '%0tells you%1'
  553. #unantisub *
  554. remove all antisubs
  555. #unantisub {^You*}
  556. remove all antisubs that start with '^You'
  557.  
  558. ~UNGAG
  559.  
  560. format:        #ungag {string}
  561.                #ungag string
  562.  
  563. Exactly the same as #unsubstitute, '#help unsubstitute' for info.
  564.  
  565. ~UNSUBSTITUTE
  566.  
  567. format:        #unsubstitute {string}
  568.                #unsubstitute string
  569.  
  570. Remove substitute(s) from the substitute list which match {string}.  The
  571. '*' character will act as a wildcard and will match any text.
  572.  
  573. examples:
  574. #unsub {%0tells you%1}
  575. remove the sub for '%0tells you%1'
  576. #unsub *
  577. remove all subs
  578. #unsub {^You*}
  579. remove all subs that start with '^You'
  580.  
  581. ~UNHIGHLIGHT
  582.  
  583. format:        #unhighlight {string}
  584.                #unhighlight string
  585.  
  586. Remove highlight(s) from the highlight list which match {string}.  The
  587. '*' character will act as a wildcard and will match any text.
  588.  
  589. examples:
  590. #unsub {%0tells you%1}
  591. remove the highlight for '%0tells you%1'
  592. #unsub *
  593. remove all highlights
  594. #unsub {^You*}
  595. remove all highlights that start with '^You'
  596.  
  597. ~UNPATH
  598.  
  599. format:        #unpath
  600.  
  601. Remove the most recent move from the current path.
  602.  
  603. ~UNSPLIT
  604.  
  605. format:        #unsplit
  606.  
  607. Exit split mode, and set the screen back to its default terminal settings.
  608.  
  609. ~UNVARIABLE
  610.  
  611. format:        #unvariable {variable name}
  612.                #unalias variable name
  613.  
  614. Remove variable(s) from the variable list which match {variable name}.  The
  615. '*' character will act as a wildcard and will match any text.
  616.  
  617. examples:
  618. #unvar {hp}
  619. remove the variable $hp
  620. #unvar *
  621. remove all variables
  622. #unvariable {xx*}
  623. remove all variables that start with 'xx'
  624.  
  625. ~VERBATIM
  626.  
  627. format:        #verbatim
  628.  
  629. Toggle verbatim mode on and off.  When in verbatim mode, text will not be
  630. parsed, and will be sent 'as is' to the mud.  Tab completion and history
  631. scrolling are still available in verbatim mode.  It is helpful for writing
  632. messages, doing online creation, and the like.
  633.  
  634. ~VERSION
  635.  
  636. format:        #version
  637.  
  638. Show the version number of tintin++ that you are currently running.
  639.  
  640. ~WIZLIST
  641.  
  642. format:        #wizlist
  643.  
  644. Lists the names of people who helped with with mudding, and with the client.
  645. If you feel your name should be here, let me know, so many people have
  646. contributed, and it's hard to name everyone.
  647.  
  648. ~WRITE
  649.  
  650. format:        #write {filename}
  651.                #write filename
  652.  
  653. Writes all current actions, aliases, subs, antisubs, highlights, and
  654. variables to a coms file, specified by filename.  
  655.  
  656. ~WRITESESSION
  657.  
  658. format:        #writesession {filename}
  659.                #writesession filename
  660.  
  661. Write all current actions, aliases, subs, antisubs, highlights, and
  662. variables that are specific to your current session to a file.  This 
  663. means actions that were not defined when there was no session active.
  664.  
  665. ~ZAP
  666.  
  667. format:        #zap
  668.  
  669. Kill your current session.  If there is no current session, it will cause
  670. the program to terminate.
  671.  
  672. ~*EOF* 
  673.