Home Explore Help
Sign In
mudclient
/
tintin
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: b0fa43339e
Branches Tags
tintin
/
docs
/
help.html

help.html 272 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234 
  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta http-equiv='content-type' content='text/html; charset=utf-8'>
    5. 

  5. <meta name='viewport' content='width=device-width, initial-scale=1.0'>
    6. 

  6. <style type='text/css'>
    7. 

  7. body {font-family:Consolas;font-size:12pt}
    8. 

  8. a {text-decoration:none}
    9. 

  9. a:link {color:#06b}
    10. 

  10. a:visited {color:#6b0}
    11. 

  11. a:hover {text-decoration:underline}
    12. 

  12. a:active {color:#b06}
    13. 

  13. </style>
    14. 

  14. <body bgcolor='#000000'>
    15. 

  15. </head>
    16. 

  16. <pre>
    17. 

  17. <span style='background-color:#000'><span style='color:#FFF'>
    18. 

  18.  <a href='#ACTION'>         ACTION</a> <a href='#ALIAS'>          ALIAS</a> <a href='#ALL'>            ALL</a> <a href='#BELL'>           BELL</a> <a href='#BREAK'>          BREAK</a>
    19. 

  19.  <a href='#BUFFER'>         BUFFER</a> <a href='#BUTTON'>         BUTTON</a> <a href='#CASE'>           CASE</a> <a href='#CAT'>            CAT</a> <a href='#CHARACTERS'>     CHARACTERS</a>
    20. 

  20.  <a href='#CHAT'>           CHAT</a> <a href='#CLASS'>          CLASS</a> <a href='#COLORS'>         COLORS</a> <a href='#COMMANDS'>       COMMANDS</a> <a href='#COORDINATES'>    COORDINATES</a>
    21. 

  21.  <a href='#CONFIG'>         CONFIG</a> <a href='#CONTINUE'>       CONTINUE</a> <a href='#CR'>             CR</a> <a href='#CURSOR'>         CURSOR</a> <a href='#DAEMON'>         DAEMON</a>
    22. 

  22.  <a href='#DEBUG'>          DEBUG</a> <a href='#DEFAULT'>        DEFAULT</a> <a href='#DELAY'>          DELAY</a> <a href='#DRAW'>           DRAW</a> <a href='#ECHO'>           ECHO</a>
    23. 

  23.  <a href='#EDIT'>           EDIT</a> <a href='#EDITING'>        EDITING</a> <a href='#ELSE'>           ELSE</a> <a href='#ELSEIF'>         ELSEIF</a> <a href='#END'>            END</a>
    24. 

  24.  <a href='#ESCAPE CODES'>   ESCAPE CODES</a> <a href='#EVENT'>          EVENT</a> <a href='#FOREACH'>        FOREACH</a> <a href='#FORMAT'>         FORMAT</a> <a href='#FUNCTION'>       FUNCTION</a>
    25. 

  25.  <a href='#GAG'>            GAG</a> <a href='#GREETING'>       GREETING</a> <a href='#GREP'>           GREP</a> <a href='#HELP'>           HELP</a> <a href='#HIGHLIGHT'>      HIGHLIGHT</a>
    26. 

  26.  <a href='#HISTORY'>        HISTORY</a> <a href='#IF'>             IF</a> <a href='#IGNORE'>         IGNORE</a> <a href='#INDEX'>          INDEX</a> <a href='#INFO'>           INFO</a>
    27. 

  27.  <a href='#KEYPAD'>         KEYPAD</a> <a href='#KILL'>           KILL</a> <a href='#LINE'>           LINE</a> <a href='#LIST'>           LIST</a> <a href='#LISTS'>          LISTS</a>
    28. 

  28.  <a href='#LOCAL'>          LOCAL</a> <a href='#LOG'>            LOG</a> <a href='#LOOP'>           LOOP</a> <a href='#MACRO'>          MACRO</a> <a href='#MAP'>            MAP</a>
    29. 

  29.  <a href='#MAPPING'>        MAPPING</a> <a href='#MATH'>           MATH</a> <a href='#MATHEMATICS'>    MATHEMATICS</a> <a href='#MESSAGE'>        MESSAGE</a> <a href='#METRIC SYSTEM'>  METRIC SYSTEM</a>
    30. 

  30.  <a href='#MOUSE'>          MOUSE</a> <a href='#MSDP'>           MSDP</a> <a href='#MSLP'>           MSLP</a> <a href='#NOP'>            NOP</a> <a href='#PARSE'>          PARSE</a>
    31. 

  31.  <a href='#PATH'>           PATH</a> <a href='#PATHDIR'>        PATHDIR</a> <a href='#PCRE'>           PCRE</a> <a href='#PORT'>           PORT</a> <a href='#PROMPT'>         PROMPT</a>
    32. 

  32.  <a href='#READ'>           READ</a> <a href='#REGEXP'>         REGEXP</a> <a href='#REPEAT'>         REPEAT</a> <a href='#REPLACE'>        REPLACE</a> <a href='#RETURN'>         RETURN</a>
    33. 

  33.  <a href='#RUN'>            RUN</a> <a href='#SCAN'>           SCAN</a> <a href='#SCREEN'>         SCREEN</a> <a href='#SCREEN READER'>  SCREEN READER</a> <a href='#SCRIPT'>         SCRIPT</a>
    34. 

  34.  <a href='#SEND'>           SEND</a> <a href='#SESSION'>        SESSION</a> <a href='#SESSIONNAME'>    SESSIONNAME</a> <a href='#SHOWME'>         SHOWME</a> <a href='#SNOOP'>          SNOOP</a>
    35. 

  35.  <a href='#SPEEDWALK'>      SPEEDWALK</a> <a href='#SPLIT'>          SPLIT</a> <a href='#SSL'>            SSL</a> <a href='#STATEMENTS'>     STATEMENTS</a> <a href='#SUBSTITUTE'>     SUBSTITUTE</a>
    36. 

  36.  <a href='#SUSPEND'>        SUSPEND</a> <a href='#SWITCH'>         SWITCH</a> <a href='#SYSTEM'>         SYSTEM</a> <a href='#TAB'>            TAB</a> <a href='#TEXTIN'>         TEXTIN</a>
    37. 

  37.  <a href='#TICKER'>         TICKER</a> <a href='#TIME'>           TIME</a> <a href='#VARIABLE'>       VARIABLE</a> <a href='#WHILE'>          WHILE</a> <a href='#WRITE'>          WRITE</a>
    38. 

  38.  <a href='#ZAP'>            ZAP</a>
    39. 

  39. 

  40. 

  41. <a name='ACTION'></a>
    42. 

  42. 

  43. </span><span style='color:#5F5'>         ACTION
    44. 

  44. 

  45. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>message</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>priority</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    46. 

  46. 

  47.          The #action command can be used to respond with one or several
    48. 

  48.          commands to a specific message send by the server. The %1-%99
    49. 

  49.          variables are substituted from the message and can be used in the
    50. 

  50.          command part of the action.
    51. 

  51. 

  52.          The priority part is optional and determines the priority of the
    53. 

  53.          action, it defaults to 5.
    54. 

  54. 

  55.          If the message starts with a ~ color codes must be matched. You can
    56. 

  56.          enable #config {convert meta} on to display meta characters.
    57. 

  57. 

  58.          For more information on pattern matching see the section on PCRE.
    59. 

  59. 

  60. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {%1 tells you '%2'} {tell %1 I'm afk.}
    61. 

  61. 

  62.          Actions can be triggered by the show command and certain system
    63. 

  63.          messages.
    64. 

  64. 

  65.          Actions can be triggered by the #show command. If you don't want a
    66. 

  66.          #show to get triggered use: #line ignore #show {text}
    67. 

  67. 

  68.          Actions are ordered alphabetically and only one action can trigger at
    69. 

  69.          a time. To change the order you can assign a priority, which defaults
    70. 

  70.          to 5, with a lower number indicating a higher priority. The priority
    71. 

  71.          can be a floating point number.
    72. 

  72. 

  73.          To remove action with %* as the message, use #unaction {%%*} or
    74. 

  74.          #unaction {%*}. Alternatively you could wrap the action inside a
    75. 

  75.          class, and kill that class when you no longer need the action.
    76. 

  76. 

  77. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove an action with the #unaction command.
    78. 

  78. 

  79. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#PCRE'>pcre</a>, <a href='#GAG'>gag</a>, <a href='#HIGHLIGHT'>highlight</a>, <a href='#PROMPT'>prompt</a> and <a href='#SUBSTITUTE'>substitute</a>.
    80. 

  80. <a name='ALIAS'></a>
    81. 

  81. 

  82. </span><span style='color:#5F5'>         ALIAS
    83. 

  83. 

  84. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #alias </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>priority</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    85. 

  85. 

  86.          The #alias command can be used to shorten up long or oftenly used
    87. 

  87.          commands. The %1-99 variables are substituted from the arguments when
    88. 

  88.          using an alias and represent the 1st till 99th word which can be used
    89. 

  89.          in the commands part of the alias. If %0 is used it will contain all
    90. 

  90.          arguments. The priority part is optional and determines the priority
    91. 

  91.          of the alias, it defaults to 5.
    92. 

  92. 

  93. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {k} {kill %1;kick}
    94. 

  94. 

  95.          Typing 'k orc' would result in attacking the orc followed by a kick.
    96. 

  96. 

  97.          You can create multi-word aliases by using variables in the name
    98. 

  98.          section.
    99. 

  99. 

  100. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {k %1 with %2} {draw %2;attack %1;slash %1 with %2;
    101. 

  101.            kick at %2;strike %1 with %2}
    102. 

  102. 

  103.          Using the above alias you could type k blue smurf with battle axe
    104. 

  104. 

  105.          To have an alias that matches all user input, use %* as the name.
    106. 

  106. 

  107. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {%*} {#show You wrote: %0}
    108. 

  108. 

  109.          Aliases are ordered alphabetically and only one alias can trigger at
    110. 

  110.          a time. To change the order you can assign a priority, which defaults
    111. 

  111.          to 5, with a lower number indicating a higher priority. The priority
    112. 

  112.          can be a floating point number.
    113. 

  113. 

  114.          To remove an alias with %* as the name, use #unalias {%%*} or #unalias
    115. 

  115.          {%*}. Alternatively you can wrap the alias inside a class, and kill
    116. 

  116.          that class when you no longer need the alias.
    117. 

  117. 

  118.          For more information on pattern matching see the section on PCRE.
    119. 

  119. 

  120. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove an alias with the #unalias command.
    121. 

  121. 

  122. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CURSOR'>cursor</a>, <a href='#HISTORY'>history</a>, <a href='#KEYPAD'>keypad</a>, <a href='#MACRO'>macro</a>, <a href='#SPEEDWALK'>speedwalk</a> and <a href='#TAB'>tab</a>.
    123. 

  123. <a name='ALL'></a>
    124. 

  124. 

  125. </span><span style='color:#5F5'>         ALL
    126. 

  126. 

  127. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #all </span><span style='color:#FFF'>{</span><span style='color:#AAA'>string</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    128. 

  128. 

  129.          If you have multiple sessions in one terminal you can use #all to
    130. 

  130.          execute the command with all sessions, excluding the startup session.
    131. 

  131. 

  132. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #all quit
    133. 

  133. 

  134.          Sends 'quit' to all sessions.
    135. 

  135. 

  136. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#PORT'>port</a>, <a href='#RUN'>run</a>, <a href='#SESSION'>session</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SNOOP'>snoop</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    137. 

  137. <a name='BELL'></a>
    138. 

  138. 

  139. </span><span style='color:#5F5'>         BELL
    140. 

  140. 

  141. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #bell </span><span style='color:#FFF'>{</span><span style='color:#AAA'>flash</span><span style='color:#FFF'>|</span><span style='color:#AAA'>focus</span><span style='color:#FFF'>|</span><span style='color:#AAA'>margin</span><span style='color:#FFF'>|</span><span style='color:#AAA'>ring</span><span style='color:#FFF'>|</span><span style='color:#AAA'>volume</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    142. 

  142. 

  143.          The #bell command without an argument will ring the terminal bell.
    144. 

  144. 

  145. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {Bubba tells you} {#bell}
    146. 

  146. 

  147.          If you aren't watching the screen this could be useful if you don't
    148. 

  148.          want to miss out on a conversation with Bubba. Alternatively you can
    149. 

  149.          use #system to play a sound file.
    150. 

  150. 

  151.          Some terminals will allow you to use VT100 Operating System Commands
    152. 

  152.          to change the terminal's bell behavior which can be used to flash the
    153. 

  153.          taskbar icon and or focus the window on receival of a bell.
    154. 

  154. 

  155. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {Bubba tells you} {#screen save title;#screen set title Tell!;
    156. 

  156.            #bell ring;#delay 10 #screen load title}
    157. 

  157. 

  158.          The above example will save your window title, change the title to
    159. 

  159.          'Tell!', ring the bell, next reset the window title after 10 seconds.
    160. 

  160. 

  161.          It's possible to set the terminal to pop to the foreground upon
    162. 

  162.          ringing of the alarm bell.
    163. 

  163. 

  164. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #bell focus on;#bell ring;#bell focus off
    165. 

  165. 

  166.          It's possible to adjust the alarm bell volume on some terminals.
    167. 

  167. 

  168. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop {1} {8} {cnt} {#line substitute variables
    169. 

  169.            #delay {&dollar;cnt} {#show Volume &dollar;cnt: #bell volume &dollar;cnt;#bell}
    170. 

  170. 

  171. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#SCREEN'>screen</a>
    172. 

  172. <a name='BREAK'></a>
    173. 

  173. 

  174. </span><span style='color:#5F5'>         BREAK
    175. 

  175. 

  176. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #break
    177. 

  177. 

  178.          The break command can be used inside the #else, #elseif, #if, #foreach,
    179. 

  179.          #loop, #parse, #switch, and #while statements. When #break is found,
    180. 

  180.          tintin will stop executing the statement it is currently in and move on
    181. 

  181.          to the next.
    182. 

  182. 

  183. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #while {1} {#math cnt &dollar;cnt + 1;#if {&dollar;cnt == 20} {#break}}
    184. 

  184. 

  185. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#STATEMENTS'>statements</a>
    186. 

  186. <a name='BUFFER'></a>
    187. 

  187. 

  188. </span><span style='color:#5F5'>         BUFFER
    189. 

  189. 

  190. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #buffer </span><span style='color:#FFF'>{</span><span style='color:#AAA'>home</span><span style='color:#FFF'>|</span><span style='color:#AAA'>up</span><span style='color:#FFF'>|</span><span style='color:#AAA'>down</span><span style='color:#FFF'>|</span><span style='color:#AAA'>end</span><span style='color:#FFF'>|</span><span style='color:#AAA'>lock</span><span style='color:#FFF'>|</span><span style='color:#AAA'>find</span><span style='color:#FFF'>|</span><span style='color:#AAA'>get</span><span style='color:#FFF'>|</span><span style='color:#AAA'>clear</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    191. 

  191. 

  192.          The buffer command has various options to manipulate your scrollback
    193. 

  193.          buffer.
    194. 

  194. 

  195.          </span><span style='color:#FFF'>#buffer {home}
    196. 

  196. </span><span style='color:#AAA'>
    197. 

  197.          Moves you to the top of your scrollback buffer and displays the page.
    198. 

  198.          Enables scroll lock mode. Most useful when used in a #macro.
    199. 

  199. 

  200.          </span><span style='color:#FFF'>#buffer {up} [lines]
    201. 

  201. </span><span style='color:#AAA'>
    202. 

  202.          Moves your scrollback buffer up one page and displays the page.
    203. 

  203.          Enables scroll lock mode. Most useful when used in a #macro. You
    204. 

  204.          can use #buffer {up} {1} to move the scrollback buffer up 1 line.
    205. 

  205. 

  206.          </span><span style='color:#FFF'>#buffer {down} [lines]
    207. 

  207. </span><span style='color:#AAA'>
    208. 

  208.          Moves your scrollback buffer down one page and displays the page.
    209. 

  209.          Enables scroll lock mode unless at the end. Most useful when used in
    210. 

  210.          a #macro.
    211. 

  211. 

  212.          </span><span style='color:#FFF'>#buffer {end}
    213. 

  213. </span><span style='color:#AAA'>
    214. 

  214.          Moves you to the end of your scrollback buffer and displays the page.
    215. 

  215.          Disables scroll lock mode. Most useful when used in a #macro.
    216. 

  216. 

  217.          </span><span style='color:#FFF'>#buffer {find} {[number]} {&lt;string&gt;}
    218. 

  218. </span><span style='color:#AAA'>
    219. 

  219.          Moves the buffer to the given string which can contain a regular
    220. 

  220.          expression. Optionally you can provide the number of matches to skip,
    221. 

  221.          allowing you to jump further back in the buffer.
    222. 

  222. 

  223.          </span><span style='color:#FFF'>#buffer {get} {&lt;variable&gt;} {&lt;lower bound&gt;} {[upper bound]}
    224. 

  224. </span><span style='color:#AAA'>
    225. 

  225.          Allows you to store one or several lines from your scrollback buffer
    226. 

  226.          (including color codes) into a variable. The lower and upper bound
    227. 

  227.          must be between 1 and the size of the buffer. If the upper bound is
    228. 

  228.          omitted the given line is stored as a standard variable. If an upper
    229. 

  229.          bound is given the lines between the two bounds are stored as a list.
    230. 

  230. 

  231.          </span><span style='color:#FFF'>#buffer {info} {[save]} {[variable]}
    232. 

  232. </span><span style='color:#AAA'>
    233. 

  233.          Display buffer info, optionally save the data to a variable.
    234. 

  234. 

  235.          </span><span style='color:#FFF'>#buffer {lock} {on|off}
    236. 

  236. </span><span style='color:#AAA'>
    237. 

  237.          Toggles the lock on the scrollback buffer. When locked, newly incoming
    238. 

  238.          text won't be displayed, any command will disable the lock, though
    239. 

  239.          several buffer commands will re-enable the lock. When unlocking it'll
    240. 

  240.          move you to the end of your scrollback buffer and display the page.
    241. 

  241. 

  242.          </span><span style='color:#FFF'>#buffer {write} {&lt;filename&gt;}
    243. 

  243. </span><span style='color:#AAA'>
    244. 

  244.          Writes the scrollback buffer to the given file.
    245. 

  245. 

  246. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {&bsol;e[F} {#buffer end}
    247. 

  247. 

  248. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ECHO'>echo</a>, <a href='#GREP'>grep</a>, <a href='#MACRO'>macro</a>, <a href='#SHOWME'>showme</a> and <a href='#SCREEN'>screen</a>.
    249. 

  249. <a name='BUTTON'></a>
    250. 

  250. 

  251. </span><span style='color:#5F5'>         BUTTON
    252. 

  252. 

  253. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #button </span><span style='color:#FFF'>{</span><span style='color:#AAA'>square</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>priority</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    254. 

  254. 

  255.          The #button command can be used to respond with one or several
    256. 

  256.          commands to a mouse click received within the specified square.
    257. 

  257.          The click coordinates are stored in %0-%3 and can be used in the
    258. 

  258.          command part of the button.
    259. 

  259. 

  260.          The square part should exists of two coordinates defining the
    261. 

  261.          upper left and bottom right corner using row, col, row, col syntax.
    262. 

  262.          The square arguments should be separated by spaces, semi-colons or
    263. 

  263.          braces.
    264. 

  264. 

  265.          By default the button is set to respond to a mouse button press, to
    266. 

  266.          respond to other button presses you must add a 5th argument to the
    267. 

  267.          square that defines the button press type. You can enable #info
    268. 

  268.          button on to see button events and their type as they happen.
    269. 

  269. 

  270.          The priority part is optional and determines the priority of the
    271. 

  271.          button, it defaults to 5.
    272. 

  272. 

  273.          You must enable #config {mouse tracking} on for buttons to work.
    274. 

  274. 

  275.          This command draws no visible button, you'll have to do so separately
    276. 

  276.          if needed.
    277. 

  277. 

  278. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #button {1;1;2;2} {#show You clicked the upper left corner.}
    279. 

  279. 

  280.          Buttons are ordered alphabetically and only one button can trigger at
    281. 

  281.          a time. To change the order you can assign a priority, which defaults
    282. 

  282.          to 5, with a lower number indicating a higher priority. The priority
    283. 

  283.          can be a floating point number.
    284. 

  284. 

  285. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: To see button clicks trigger use #info button on.
    286. 

  286. 

  287. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a button with the #unbutton command.
    288. 

  288. 

  289. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#DELAY'>delay</a>, <a href='#EVENT'>event</a> and <a href='#TICKER'>ticker</a>.
    290. 

  290. <a name='CASE'></a>
    291. 

  291. 

  292. </span><span style='color:#5F5'>         CASE
    293. 

  293. 

  294. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #case </span><span style='color:#FFF'>{</span><span style='color:#AAA'>conditional</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>arguments</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    295. 

  295. 

  296.          The case command must be used within the #switch command. When the
    297. 

  297.          conditional argument of the case command matches the conditional
    298. 

  298.          argument of the switch command the body of the case is executed.
    299. 

  299. 

  300.          When comparing strings both the switch and case arguments must be
    301. 

  301.          surrounded in quotes.
    302. 

  302. 

  303. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>:
    304. 

  304. 

  305.          #function {reverse_direction}
    306. 

  306.          {
    307. 

  307.              #switch {&quot;%1&quot;}
    308. 

  308.              {
    309. 

  309.                  #case {&quot;north&quot;} {#return south};
    310. 

  310.                  #case {&quot;east&quot;}  {#return west};
    311. 

  311.                  #case {&quot;south&quot;} {#return north};
    312. 

  312.                  #case {&quot;west&quot;}  {#return east};
    313. 

  313.                  #case {&quot;up&quot;}    {#return down};
    314. 

  314.                  #case {&quot;down&quot;}  {#return up}
    315. 

  315.              }
    316. 

  316.          }
    317. 

  317. 

  318.          This function returns the reverse direction. @reverse_direction{north}
    319. 

  319.          would return south.
    320. 

  320. 

  321. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#DEFAULT'>default</a>, <a href='#STATEMENTS'>statements</a> and <a href='#SWITCH'>switch</a>.
    322. 

  322. <a name='CAT'></a>
    323. 

  323. 

  324. </span><span style='color:#5F5'>         CAT
    325. 

  325. 

  326. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #cat </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    327. 

  327. 

  328.          The cat command will concatinate the argument to the given variable.
    329. 

  329. 

  330. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#FORMAT'>format</a>, <a href='#FUNCTION'>function</a>, <a href='#LOCAL'>local</a>, <a href='#MATH'>math</a>, <a href='#REPLACE'>replace</a>, <a href='#SCRIPT'>script</a> and <a href='#VARIABLE'>variable</a>.
    331. 

  331. <a name='CHARACTERS'></a>
    332. 

  332. 

  333. </span><span style='color:#5F5'>         CHARACTERS
    334. 

  334. 

  335. </span><span style='color:#AAA'>
    336. 

  336.          The following special characters are defined:
    337. 

  337. 

  338. #        The hashtag is the default character for starting a command and is
    339. 

  339.          subsequently known as the command character or tintin character.
    340. 

  340.          When loading a command file the command character is set to the
    341. 

  341.          first character in the file. The character can also be redefined
    342. 

  342.          using #config.
    343. 

  343. 

  344. ;        The semi-colon is used as the command separator and can be used to
    345. 

  345.          separate two commands. Multiple commands can be strung together as
    346. 

  346.          well. Trailing semi-colons are ignored when reading a script file
    347. 

  347.          as this is a common error.
    348. 

  348. 

  349. { }      Curly brackets aka braces are used for separating multi word command
    350. 

  350.          arguments, nesting commands, and nesting variables. Braces cannot
    351. 

  351.          easily be escaped and must always be used in pairs.
    352. 

  352. 

  353. &quot; &quot;      Quote characters are used for strings in the #math, #if, #switch,
    354. 

  354.          and #case commands. It is however suggested to use a set of braces
    355. 

  355.          { } to define strings instead, particularly when checking strings
    356. 

  356.          that may contain quotes.
    357. 

  357. 

  358. !        The exclamation sign is used to repeat commands, see #help history.
    359. 

  359.          The character can be redefined using #config.
    360. 

  360. 

  361. &bsol;        An input line starting with a backslash is send verbatim if you are
    362. 

  362.          connected to a server. This character can be configured with
    363. 

  363.          #config, and is itself send verbatim when the verbatim config mode
    364. 

  364.          is enabled.
    365. 

  365. 

  366. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#COLORS'>colors</a>, <a href='#ESCAPE'>escape</a>, <a href='#FUNCTION'>function</a>, <a href='#MATHEMATICS'>mathematics</a>, <a href='#PCRE'>pcre</a> and <a href='#VARIABLE'>variable</a>.
    367. 

  367. <a name='CHAT'></a>
    368. 

  368. 

  369. </span><span style='color:#5F5'>         CHAT
    370. 

  370. 

  371. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #chat </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}
    372. 

  372. </span><span style='color:#AAA'>
    373. 

  373.          The #chat command is used to create peer to peer connections to other
    374. 

  374.          clients, typically for the purpose of chatting and sending files.
    375. 

  375.          This is a decentralized chat system, meaning you have to exchange ip
    376. 

  376.          addresses and port numbers with other users in order to connect to
    377. 

  377.          them.
    378. 

  378. 

  379.          </span><span style='color:#FFF'>#chat {init} {port}
    380. 

  380.          </span><span style='color:#AAA'>  #chat initialize launches your chat server. The port number is
    381. 

  381.            optional, and by default 4050 is used as your port. After using
    382. 

  382.            this command other people can connect to your chat server using
    383. 

  383.            your ip address and port number, and in turn you can connect to
    384. 

  384.            other people.
    385. 

  385.          </span><span style='color:#FFF'>#chat {name} {name}
    386. 

  386.          </span><span style='color:#AAA'>  By default your name is set to TinTin, but most servers will
    387. 

  387.            reject you if there is already someone with the name TinTin
    388. 

  388.            connected, so one of the first things you'd want to do is
    389. 

  389.            change your chat name. Your name can include color codes. Some
    390. 

  390.            names aren't accepted by tt++ chat servers, like the name 'all'
    391. 

  391.            and names longer than 20 characters.
    392. 

  392.          </span><span style='color:#FFF'>#chat {message} {buddy|all} {text}
    393. 

  393.          </span><span style='color:#AAA'>  This is the main command used for communication. If you use
    394. 

  394.            #chat message all, the message is marked as public and send to
    395. 

  395.            everyone you are connected to.
    396. 

  396.          </span><span style='color:#FFF'>#chat {accept} {buddy} {boost}
    397. 

  397.          </span><span style='color:#AAA'>  Accept a file transfer from a buddy. The boost is optional and
    398. 

  398.            must be a value between 1 and 1000.
    399. 

  399.          </span><span style='color:#FFF'>#chat {call}       {address} {port}
    400. 

  400.          </span><span style='color:#AAA'>  #chat call is used to connect to another chat server. If you
    401. 

  401.            omit the port argument the default port (4050) is used.
    402. 

  402.          </span><span style='color:#FFF'>#chat {cancel}     {buddy}            Cancel a file transfer
    403. 

  403.          #chat {color}      {color names}      Set the default color
    404. 

  404.          #chat {decline}    {buddy}            Decline a file transfer
    405. 

  405.          #chat {dnd}                           Decline new connections
    406. 

  406.          #chat {download}   {directory}        Set your download directory
    407. 

  407.          #chat {emote}      {buddy|all} {text} Send an emote message
    408. 

  408.          #chat {forward}    {buddy}            Forward all chat messages
    409. 

  409.          #chat {forwardall} {buddy}            Forward all session output
    410. 

  410.          #chat {filestat}   {buddy}            Show file transfer data
    411. 

  411.          #chat {group}      {buddy} {name}     Assign a chat group
    412. 

  412.          #chat {ignore}     {buddy}            Ignores someone
    413. 

  413.          #chat {info}                          Displays your info
    414. 

  414.          #chat {ip}         {address}          Changes your IP address
    415. 

  415.          #chat {paste}      {buddy|all} {text} Pastes a block of text
    416. 

  416.          #chat {peek}       {buddy}            Show one's public connections
    417. 

  417.          #chat {ping}       {buddy}            Display response time
    418. 

  418.          #chat {private}    {buddy|all}        Make a connection private
    419. 

  419.          #chat {public}     {buddy|all}        Make a connection public
    420. 

  420.          #chat {reply}      {text}             Reply to last private message
    421. 

  421.          #chat {request}    {buddy}            Request one's public connections
    422. 

  422.          #chat {send}       {buddy|all} {text} Sends a raw data string
    423. 

  423.          #chat {sendfile}   {buddy} {filename} Start a file transfer
    424. 

  424.          #chat {serve}      {buddy}            Forward all public chat messages
    425. 

  425.          #chat {uninitialize}                  Uninitialize the chat port.
    426. 

  426.          #chat {who}                           Show all connections
    427. 

  427.          </span><span style='color:#AAA'>  #chat who shows all people you are connected to. The first
    428. 

  428.            column shows a reference number for the connection, which can be
    429. 

  429.            used instead of the connection's name when sending someone a message
    430. 

  430.            The second column shows the connection's name. The third column
    431. 

  431.            shows flags set for the connection, (P)rivate, (I)gnore, (S)erve,
    432. 

  432.            (F)orward to user, and (f)orward from user. The next columns show
    433. 

  433.            ip, port, and client name.
    434. 

  434.          </span><span style='color:#FFF'>#chat {zap}        {buddy}            Close a connection
    435. 

  435. 

  436. Related</span><span style='color:#AAA'>: <a href='#PORT'>port</a>
    437. 

  437. <a name='CLASS'></a>
    438. 

  438. 

  439. </span><span style='color:#5F5'>         CLASS
    440. 

  440. 

  441. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #class </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>optionkill</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>arg</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    442. 

  442. 

  443.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {assign} {&lt;argument&gt;}
    444. 

  444.          </span><span style='color:#AAA'>  Will execute argument with the given class opened.
    445. 

  445.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {clear}
    446. 

  446.          </span><span style='color:#AAA'>  Will delete all triggers associated with the given class.
    447. 

  447.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {close}
    448. 

  448.          </span><span style='color:#AAA'>  Close the given class, opening the last open class, if any.
    449. 

  449.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {kill}
    450. 

  450.          </span><span style='color:#AAA'>  Will clear, close, and remove the class.
    451. 

  451.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {list}
    452. 

  452.          </span><span style='color:#AAA'>  List all triggers associated with the given class.
    453. 

  453.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {load}
    454. 

  454.          </span><span style='color:#AAA'>  Will load the saved copy of the class from memory.
    455. 

  455.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {open}
    456. 

  456.          </span><span style='color:#AAA'>  Open a class, closing a previously opened class. All triggers
    457. 

  457.            added afterwards are assigned to this class.
    458. 

  458.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {read} {&lt;filename&gt;
    459. 

  459.          </span><span style='color:#AAA'>  Will open the class, read the file, and close afterwards.
    460. 

  460.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {save}
    461. 

  461.          </span><span style='color:#AAA'>  Will save all triggers of the given class to memory.
    462. 

  462.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {size} {&lt;variable&gt;}
    463. 

  463.          </span><span style='color:#AAA'>  Will store the size of the class in a variable.
    464. 

  464.          </span><span style='color:#FFF'>#class {&lt;name&gt;} {write} {&lt;filename&gt;}
    465. 

  465.          </span><span style='color:#AAA'>  Will write all triggers of the given class to file.
    466. 

  466.          The {kill} option will delete all triggers of the given class.
    467. 

  467. 

  468.          Keep in mind that the kill and read option are very fast allowing
    469. 

  469.          them to be used to enable and disable classes.
    470. 

  470. 

  471. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #class extra kill;#class extra read extra.tin
    472. 

  472.          Deletes all triggers of 'extra' class if any. Read 'extra.tin' file,
    473. 

  473.          all triggers loaded will be assigned to the fresh new 'extra' class.
    474. 

  474. 

  475. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CONFIG'>config</a>, <a href='#DEBUG'>debug</a>, <a href='#IGNORE'>ignore</a>, <a href='#INFO'>info</a>, <a href='#KILL'>kill</a>, <a href='#LINE'>line</a> and <a href='#MESSAGE'>message</a>.
    476. 

  476. <a name='COLORS'></a>
    477. 

  477. 

  478. </span><span style='color:#5F5'>         COLORS
    479. 

  479. 

  480. </span><span style='color:#FFF'>Syntax</span><span style='color:#AAA'>:  &lt;xyz&gt;  with x, y, z being parameters
    481. 

  481. 

  482.          Parameter 'x': VT100 code
    483. 

  483. 

  484.          0 - Reset all colors and codes to default
    485. 

  485.          1 - Bold
    486. 

  486.          2 - Dim
    487. 

  487.          3 - Italic
    488. 

  488.          4 - Underscore
    489. 

  489.          5 - Blink
    490. 

  490.          7 - Reverse
    491. 

  491.          8 - Skip (use previous code)
    492. 

  492. 

  493.          Parameter 'y':  Foreground color
    494. 

  494.          Parameter 'z':  Background color
    495. 

  495. 

  496.          0 - Black                5 - Magenta
    497. 

  497.          1 - Red                  6 - Cyan
    498. 

  498.          2 - Green                7 - White
    499. 

  499.          3 - Yellow               8 - Skip
    500. 

  500.          4 - Blue                 9 - Default
    501. 

  501. 

  502.          For xterm 256 colors support use &lt;aaa&gt; to &lt;fff&gt; for RGB foreground
    503. 

  503.          colors and &lt;AAA&gt; to &lt;FFF&gt; for RGB background colors. For the grayscale
    504. 

  504.          foreground colors use &lt;g00&gt; to &lt;g23&gt;, for grayscale background colors
    505. 

  505.          use &lt;G00&gt; to &lt;G23&gt;.
    506. 

  506. 

  507.          The tertiary colors are as follows:
    508. 

  508. 

  509.          &lt;acf&gt; - Azure            &lt;afc&gt; - Jade
    510. 

  510.          &lt;caf&gt; - Violet           &lt;cfa&gt; - Lime
    511. 

  511.          &lt;fac&gt; - Pink             &lt;fca&gt; - Orange
    512. 

  512. 

  513. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show &lt;acf&gt;Azure    &lt;afc&gt;Jade     &lt;caf&gt;Violet
    514. 

  514. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show &lt;cfa&gt;Lime     &lt;fac&gt;Pink     &lt;fca&gt;Orange
    515. 

  515. 

  516.          For 12 bit truecolor use &lt;F000&gt; to &lt;FFFF&gt; for foreground colors and
    517. 

  517.          &lt;B000&gt; to &lt;BFFF&gt; for background colors.
    518. 

  518. 

  519.          For 24 bit truecolor use &lt;F000000&gt; to &lt;FFFFFFF&gt; for foreground
    520. 

  520.          colors and &lt;B000000&gt; to &lt;BFFFFFF&gt; for background colors.
    521. 

  521. 

  522.          If the color code exceeds your configured color mode it will be
    523. 

  523.          downgraded to the closest match.
    524. 

  524. 

  525. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CHARACTERS'>characters</a>, <a href='#COORDINATES'>coordinates</a>, <a href='#ESCAPE'>escape</a>, <a href='#MATHEMATICS'>mathematics</a> and <a href='#PCRE'>pcre</a>.
    526. 

  526. <a name='COMMANDS'></a>
    527. 

  527. 

  528. </span><span style='color:#5F5'>         COMMANDS
    529. 

  529. 

  530. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #commands </span><span style='color:#FFF'>{</span><span style='color:#AAA'>regex</span><span style='color:#FFF'>}
    531. 

  531. </span><span style='color:#AAA'>
    532. 

  532.          Shows all commands or all commands matching the given search
    533. 

  533.          string.
    534. 

  534. 

  535. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#HELP'>help</a>, <a href='#INFO'>info</a> and <a href='#STATEMENTS'>statements</a>.
    536. 

  536. <a name='COORDINATES'></a>
    537. 

  537. 

  538. </span><span style='color:#5F5'>         COORDINATES
    539. 

  539. 

  540. </span><span style='color:#AAA'>
    541. 

  541.          When the 0,0 coordinate is in the upper left corner TinTin++ uses
    542. 

  542.          a y,x / rows,cols notation. When the 0,0 coordinate is in the
    543. 

  543.          bottom left corner tintin uses a x,y / cols/rows notation.
    544. 

  544. 

  545.          When a square is defined this is done by specifying the upper left
    546. 

  546.          and bottom right corner of the square using four coordinates.
    547. 

  547. 

  548.          The vast majority of tintin commands use row,col notation.
    549. 

  549. 

  550. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CHARACTERS'>characters</a>, <a href='#COLORS'>colors</a>, <a href='#ESCAPE'>escape</a>, <a href='#MATHEMATICS'>mathematics</a> and <a href='#PCRE'>pcre</a>.
    551. 

  551. <a name='CONFIG'></a>
    552. 

  552. 

  553. </span><span style='color:#5F5'>         CONFIG
    554. 

  554. 

  555. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #config </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    556. 

  556. 

  557.          This allows you to configure various settings, the settings can be
    558. 

  558.          written to file with the #write command.
    559. 

  559. 

  560.          If you configure the global session (the one you see as you start up
    561. 

  561.          tintin) all sessions started will inherite these settings.
    562. 

  562. 

  563.          It's advised to make a configuration file to read on startup if you
    564. 

  564.          do not like the default settings.
    565. 

  565. 

  566.          Use #config without an argument to see your current configuration as
    567. 

  567.          well as a brief explanation of each config option.
    568. 

  568. 

  569.          The following config options are not listed by default:
    570. 

  570. 

  571.          #CONFIG {CHILD LOCK}   {ON|OFF} Enable or disable command input.
    572. 

  572.          #CONFIG {CONVERT META} {ON|OFF} Shows color codes and key bindings.
    573. 

  573.          #CONFIG {DEBUG TELNET} {ON|OFF} Shows telnet negotiations y/n.
    574. 

  574.          #CONFIG {LOG LEVEL}  {LOW|HIGH} LOW logs server output before triggers.
    575. 

  575.          #CONFIG {INHERITANCE}  {ON|OFF} Session trigger inheritance y/n.
    576. 

  576.          #CONFIG {MCCP}         {ON|OFF} Enable or disable MCCP support.
    577. 

  577. 

  578. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a> and <a href='#LINE'>line</a>.
    579. 

  579. <a name='CONTINUE'></a>
    580. 

  580. 

  581. </span><span style='color:#5F5'>         CONTINUE
    582. 

  582. 

  583. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #continue
    584. 

  584. 

  585.          The continue command can be used inside the #FOREACH, #LOOP, #PARSE,
    586. 

  586.          #WHILE and #SWITCH commands. When #CONTINUE is found, tintin will go
    587. 

  587.          to the end of the command and proceed as normal, which may be to
    588. 

  588.          reiterate the command.
    589. 

  589. 

  590. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop 1 10 cnt {#if {&dollar;cnt % 2 == 0} {#continue} {say &dollar;cnt}}
    591. 

  591. 

  592. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#FOREACH'>foreach</a>, <a href='#LIST'>list</a>, <a href='#LOOP'>loop</a>, <a href='#PARSE'>parse</a>, <a href='#REPEAT'>repeat</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    593. 

  593. <a name='CR'></a>
    594. 

  594. 

  595. </span><span style='color:#5F5'>         CR
    596. 

  596. 

  597. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #cr
    598. 

  598. 

  599.          Sends a carriage return to the session.  Useful for aliases that need
    600. 

  600.          extra carriage returns.
    601. 

  601. 

  602.          This command is obsolete as you can accomplish the same using #send
    603. 

  603.          without an argument or #send {}.
    604. 

  604. 

  605. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#FORALL'>forall</a>
    606. 

  606. <a name='CURSOR'></a>
    607. 

  607. 

  608. </span><span style='color:#5F5'>         CURSOR
    609. 

  609. 

  610. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #cursor </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    611. 

  611. 

  612.          Typing #cursor without an option will show all available cursor
    613. 

  613.          options, their default binding, and an explanation of their function.
    614. 

  614. 

  615.          The cursor command's primarly goal is adding customizable input editing
    616. 

  616.          with macros. Subsequently many cursor commands only work properly when
    617. 

  617.          used within a macro or event.
    618. 

  618. 

  619.          </span><span style='color:#FFF'>#cursor flag
    620. 

  620. 

  621.          </span><span style='color:#AAA'>EOL         end of line character(s)
    622. 

  622.          ECHO        local echo
    623. 

  623.          OVERTYPE    overtype mode
    624. 

  624. 

  625.          </span><span style='color:#FFF'>#cursor macro
    626. 

  626. 

  627.          </span><span style='color:#AAA'>PRESERVE    do not erase the macro from the macro input buffer
    628. 

  628.          RESET       erase the macro input buffer
    629. 

  629. 

  630.          </span><span style='color:#FFF'>#cursor tab
    631. 

  631. 

  632.          </span><span style='color:#AAA'>CASELESS    makes tab completion caseless
    633. 

  633.          COMPLETE    makes tab completion work while editing
    634. 

  634. 

  635.          DICTIONARY  performs tab completion on the dictionary
    636. 

  636.          LIST        performs tab completion on the tab completion list
    637. 

  637.          SCROLLBACK  performs tab completion on the scrollback buffer
    638. 

  638. 

  639.          BACKWARD    specifies tab completion to go backward
    640. 

  640.          FORWARD     specifies tab completion to go forward
    641. 

  641. 

  642.          Multiple options can/must be specified at once.
    643. 

  643. 

  644. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALIAS'>alias</a>, <a href='#HISTORY'>history</a>, <a href='#KEYPAD'>keypad</a>, <a href='#MACRO'>macro</a>, <a href='#SPEEDWALK'>speedwalk</a> and <a href='#TAB'>tab</a>.
    645. 

  645. <a name='DAEMON'></a>
    646. 

  646. 

  647. </span><span style='color:#5F5'>         DAEMON
    648. 

  648. 

  649. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #daemon </span><span style='color:#FFF'>{</span><span style='color:#AAA'>attach</span><span style='color:#FFF'>|</span><span style='color:#AAA'>detach</span><span style='color:#FFF'>|</span><span style='color:#AAA'>kill</span><span style='color:#FFF'>|</span><span style='color:#AAA'>list</span><span style='color:#FFF'>} [</span><span style='color:#AAA'>name</span><span style='color:#FFF'>]
    650. 

  650. 

  651.          </span><span style='color:#AAA'>#daemon provides functionality similar to that of the screen and tmux
    652. 

  652.          utilities.
    653. 

  653. 

  654.          </span><span style='color:#FFF'>#daemon attach [name]
    655. 

  655.          </span><span style='color:#AAA'>  The attach option will try to find a daemonized tintin instance and
    656. 

  656.            take over control. The name argument is optional.
    657. 

  657. 

  658.          </span><span style='color:#FFF'>#daemon detach [name]
    659. 

  659.          </span><span style='color:#AAA'>  The detach option will daemonize tintin, turning it into a background
    660. 

  660.            process. The name argument is optional and is useful if you have
    661. 

  661.            several daemonized tt++ instances running so you can keep them apart.
    662. 

  662. 

  663.          </span><span style='color:#FFF'>#daemon kill [name]
    664. 

  664.          </span><span style='color:#AAA'>  Kills all daemons or daemons with matching name.
    665. 

  665. 

  666.          </span><span style='color:#FFF'>#daemon list [name]
    667. 

  667.          </span><span style='color:#AAA'>  List all daemons or daemons with matching name.
    668. 

  668. 

  669. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#SCRIPT'>script</a>, <a href='#SYSTEM'>system</a> and <a href='#RUN'>run</a>.
    670. 

  670. <a name='DEBUG'></a>
    671. 

  671. 

  672. </span><span style='color:#5F5'>         DEBUG
    673. 

  673. 

  674. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #debug </span><span style='color:#FFF'>{</span><span style='color:#AAA'>listname</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>on</span><span style='color:#FFF'>|</span><span style='color:#AAA'>off</span><span style='color:#FFF'>|</span><span style='color:#AAA'>log</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    675. 

  675. 

  676.          Toggles a list on or off. With no argument it shows your current
    677. 

  677.          settings, as well as the list names that you can debug.
    678. 

  678. 

  679.          If you for example set ACTIONS to ON you will get debug information
    680. 

  680.          whenever an action is triggered.
    681. 

  681. 

  682.          #debug {listname} {log} will silently write debugging information to
    683. 

  683.          the log file, you must be logging in order for this to work.
    684. 

  684. 

  685.          Not every list has debug support yet.
    686. 

  686. 

  687. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a>, <a href='#IGNORE'>ignore</a>, <a href='#INFO'>info</a>, <a href='#KILL'>kill</a> and <a href='#MESSAGE'>message</a>.
    688. 

  688. <a name='DEFAULT'></a>
    689. 

  689. 

  690. </span><span style='color:#5F5'>         DEFAULT
    691. 

  691. 

  692. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #default </span><span style='color:#FFF'>{</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    693. 

  693. 

  694.          The default command can only be used within the switch command. When
    695. 

  695.          the conditional argument of non of the case commands matches the switch
    696. 

  696.          command's conditional statement the default command is executed.
    697. 

  697. 

  698. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CASE'>case</a>, <a href='#DEFAULT'>default</a>, <a href='#ELSE'>else</a>, <a href='#ELSEIF'>elseif</a>, <a href='#IF'>if</a>, <a href='#SWITCH'>switch</a> and <a href='#REGEXP'>regexp</a>.
    699. 

  699. <a name='DELAY'></a>
    700. 

  700. 

  701. </span><span style='color:#5F5'>         DELAY
    702. 

  702. 

  703. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #delay </span><span style='color:#FFF'>{</span><span style='color:#AAA'>seconds</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>command</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    704. 

  704. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #delay </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>command</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>seconds</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    705. 

  705. 

  706.          Delay allows you to have tintin wait the given amount of seconds
    707. 

  707.          before executing the given command.
    708. 

  708. 

  709.          Nanosecond floating point precision is allowed. Delays will fire in
    710. 

  710.          0.01 second intervals.
    711. 

  711. 

  712.          Named delays are treated as one-shot tickers, see #help tick.
    713. 

  713. 

  714. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #delay {1} {#show last};#show first
    715. 

  715.          This will print 'first', and 'last' around one second later.
    716. 

  716. 

  717. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: If you want to remove a delay with the #undelay command you can add
    718. 

  718.          a name as the first argument, be aware this changes the syntax. If
    719. 

  719.          the name is a number keep in mind that delays with the same numeric
    720. 

  720.          name will not be overwritten
    721. 

  721. 

  722. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#EVENT'>event</a> and <a href='#TICKER'>ticker</a>.
    723. 

  723. <a name='DRAW'></a>
    724. 

  724. 

  725. </span><span style='color:#5F5'>         DRAW
    726. 

  726. 

  727. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #draw </span><span style='color:#FFF'>[</span><span style='color:#AAA'>line color</span><span style='color:#FFF'>] [</span><span style='color:#AAA'>options</span><span style='color:#FFF'>] &lt;</span><span style='color:#AAA'>type</span><span style='color:#FFF'>&gt; &lt;</span><span style='color:#AAA'>square</span><span style='color:#FFF'>&gt; {</span><span style='color:#AAA'>text</span><span style='color:#FFF'>}
    728. 

  728. </span><span style='color:#AAA'>
    729. 

  729.          The draw commands allows you to draw various types of lines and shapes
    730. 

  730.          on the screen. The types with a brief description are provided when you
    731. 

  731.          type #draw without an argument.
    732. 

  732. 

  733.          The &lt;square&gt; arguments should exists of two coordinates defining the
    734. 

  734.          upper left and bottom right corner using row, col, row, col syntax.
    735. 

  735. 

  736.          The square arguments can be negative, in which case the coordinates
    737. 

  737.          are calculated from the opposite side of the screen. In the case the
    738. 

  738.          screen is 80 columns wide using #draw box 1 60 10 70 will be the
    739. 

  739.          equivalent of #draw box 1 -21 10 -11, but with different screen
    740. 

  740.          widths the boxes would be drawn in different places.
    741. 

  741. 

  742.          You can prefix the option with a color code or color name to color the
    743. 

  743.          lines and shapes.
    744. 

  744. 

  745.          You can further prefix the option as following:
    746. 

  746. 

  747.          ASCII      will draw in ASCII mode.
    748. 

  748.          BALIGN     will bottom align text.
    749. 

  749.          BLANKED    will blank the lines and corners.
    750. 

  750.          BOTTOM     will draw on the bottom side if possible.
    751. 

  751.          BOXED      will draw a box along the square.
    752. 

  752.          BUMPED     will precede the draw with an enter.
    753. 

  753.          CALIGN     will center text.
    754. 

  754.          CIRCLED    will circle the corners.
    755. 

  755.          CONVERT    will draw text with meta conversion.
    756. 

  756.          CROSSED    will cross the corners.
    757. 

  757.          CURSIVE    will draw text with cursive letters.
    758. 

  758.          FAT        will draw text with fat letters.
    759. 

  759.          FILLED     will fill circles and jewels.
    760. 

  760.          FOREGROUND will draw even if session is not active.
    761. 

  761.          GRID       will draw TABLE as a grid.
    762. 

  762.          HORIZONTAL will draw horizontal if possible.
    763. 

  763.          HUGE       will draw text in huge letters.
    764. 

  764.          JEWELED    will diamond the corners.
    765. 

  765.          JOINTED    will draw corners.
    766. 

  766.          LALIGN     will left align text.
    767. 

  767.          LEFT       will draw on the left side if possible.
    768. 

  768.          NUMBERED   will draw numbers instead of lines.
    769. 

  769.          PRUNED     will prune the corners.
    770. 

  770.          RALIGN     will right align text.
    771. 

  771.          RIGHT      will draw on the right side if possible.
    772. 

  772.          ROUNDED    will round the corners.
    773. 

  773.          SANSSERIF  will draw text with sansserif letters.
    774. 

  774.          SCALED     will fit the square to the text size.
    775. 

  775.          SCROLL     will draw in the scrolling region.
    776. 

  776.          SHADOWED   will shadow HUGE text.
    777. 

  777.          TALIGN     will top align text too large to fit.
    778. 

  778.          TEED       will tee the corners.
    779. 

  779.          TOP        will draw on the top side if possible.
    780. 

  780.          TRACED     will trace HUGE text.
    781. 

  781.          TUBED      will draw tubes instead of lines.
    782. 

  782.          UALIGN     will unwrap and rewrap text.
    783. 

  783.          UNICODE    will draw in unicode mode.
    784. 

  784.          VERTICAL   will draw vertical if possible.
    785. 

  785. 

  786.          The following types are available.
    787. 

  787. 

  788.          [HORIZONTAL] </span><span style='color:#FFF'>BAR</span><span style='color:#AAA'> {&lt;MIN&gt;;&lt;MAX&gt;;[COLOR]}
    789. 

  789.           will draw a bar, use two 256 color codes for a color gradient.
    790. 

  790.          [ASCII|UNICODE|HUGE] </span><span style='color:#FFF'>BOX</span><span style='color:#AAA'> {[TEXT1]} {[TEXT2]}
    791. 

  791.            will draw a box.
    792. 

  792.          [BOXED|FOREGROUND] </span><span style='color:#FFF'>BUFFER
    793. 

  793.          </span><span style='color:#AAA'>  will draw the scrollback buffer.
    794. 

  794.          [BLANKED|CIRCLED|CROSSED|JEWELED|ROUNDED|TEED|PRUNED] </span><span style='color:#FFF'>CORNER
    795. 

  795.          </span><span style='color:#AAA'>  will draw a corner.
    796. 

  796.          [BLANKED|HORIZONTAL|NUMBERED|TUBED|VERTICAL] </span><span style='color:#FFF'>LINE</span><span style='color:#AAA'> {[TEXT]}
    797. 

  797.            will draw a line.
    798. 

  798.          [BOXED] </span><span style='color:#FFF'>MAP
    799. 

  799.          </span><span style='color:#AAA'>  will draw the map
    800. 

  800.          </span><span style='color:#FFF'>RAIN</span><span style='color:#AAA'> {&lt;VARIABLE&gt;} {[SPAWN]} {[FADE]} {[LEGEND]}
    801. 

  801.            will draw digital rain.
    802. 

  802.          [JOINTED|TOP|LEFT|BOTTOM|RIGHT] </span><span style='color:#FFF'>SIDE
    803. 

  803.          </span><span style='color:#AAA'>  will draw one or more sides of a box.
    804. 

  804.          [GRID] </span><span style='color:#FFF'>TABLE</span><span style='color:#AAA'> {[LIST1]} {[LIST2]}
    805. 

  805.           will draw a table.
    806. 

  806.          [CURSIVE|FAT|HUGE|SANSSERIF] </span><span style='color:#FFF'>TILE</span><span style='color:#AAA'> {[TEXT1]} {[TEXT2]}
    807. 

  807.            will draw a tile
    808. 

  808. 

  809.          All draw types take an optional text argument as long as a valid
    810. 

  810.          square with enough space has been defined. Text is automatically
    811. 

  811.          word wrapped and text formatting can be customized with the
    812. 

  812.          CALIGN, LALIGN, RALIGN, and UALIGN options.
    813. 

  813. 

  814. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #draw Blue box 1 1 3 20 {Hello world!}
    815. 

  815. 

  816. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BUFFER'>buffer</a>, <a href='#ECHO'>echo</a>, <a href='#GREP'>grep</a> and <a href='#SHOWME'>showme</a>.
    817. 

  817. <a name='ECHO'></a>
    818. 

  818. 

  819. </span><span style='color:#5F5'>         ECHO
    820. 

  820. 

  821. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #echo </span><span style='color:#FFF'>{</span><span style='color:#AAA'>format</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument1</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument2</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>etc</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    822. 

  822. 

  823.          Echo command displays text on the screen with formatting options. See
    824. 

  824.          the help file for the format command for more information.
    825. 

  825. 

  826.          The echo command does not trigger actions.
    827. 

  827. 

  828.          As with the #show command you can split the {format} argument up into
    829. 

  829.          two braced arguments, in which case the 2nd argument is the row number.
    830. 

  830. 

  831. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #echo {The current date is %t.} {%Y-%m-%d %H:%M:%S}
    832. 

  832.          #echo {[%38s][%-38s]} {Hello World} {Hello World}
    833. 

  833.          #echo {{this is %s on the top row} {1}} {printed}
    834. 

  834. 

  835. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BUFFER'>buffer</a>, <a href='#FORMAT'>format</a>, <a href='#GREP'>grep</a> and <a href='#SHOWME'>showme</a>.
    836. 

  836. <a name='EDIT'></a>
    837. 

  837. 

  838. </span><span style='color:#5F5'>         EDIT
    839. 

  839. 

  840. #edit </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} [</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>]</span><span style='color:#AAA'>
    841. 

  841. 

  842.          The edit command can be used to turn the default line editor into a
    843. 

  843.          text editor.
    844. 

  844. 

  845.          </span><span style='color:#FFF'>#edit create &lt;arguments&gt;</span><span style='color:#AAA'>
    846. 

  846.            Create an editor, initialize using the provided arguments.
    847. 

  847. 

  848.          </span><span style='color:#FFF'>#edit load &lt;variable&gt;</span><span style='color:#AAA'>
    849. 

  849.            Create an editor, initialize using the provided list variable.
    850. 

  850. 

  851.          </span><span style='color:#FFF'>#edit read &lt;filename&gt;</span><span style='color:#AAA'>
    852. 

  852.            Create an editor, initialize using the provided file.
    853. 

  853. 

  854.          </span><span style='color:#FFF'>#edit resume</span><span style='color:#AAA'>
    855. 

  855.            Resume editing after a suspension.
    856. 

  856. 

  857.          </span><span style='color:#FFF'>#edit save &lt;variable&gt;</span><span style='color:#AAA'>
    858. 

  858.            Save the editor to the provided variable.
    859. 

  859. 

  860.          </span><span style='color:#FFF'>#edit suspend</span><span style='color:#AAA'>
    861. 

  861.            Suspend editing, similar to pressing enter except that no
    862. 

  862.            events are triggered.
    863. 

  863. 

  864.          </span><span style='color:#FFF'>#edit write &lt;filename</span><span style='color:#AAA'>
    865. 

  865.            Write the editor content to file.
    866. 

  866. 

  867. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #edit create {bli}{bla}{blo}
    868. 

  868. 

  869. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CURSOR'>cursor</a> and <a href='#MACRO'>macro</a>.
    870. 

  870. <a name='EDITING'></a>
    871. 

  871. 

  872. </span><span style='color:#5F5'>         EDITING
    873. 

  873. 

  874. </span><span style='color:#AAA'>
    875. 

  875. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    876. 

  876. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>alt b                    </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor backward word                        </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    877. 

  877. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    878. 

  878. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>alt f                    </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor forward word                         </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    879. 

  879. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    880. 

  880. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    881. 

  881. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl a                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor home                                 </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    882. 

  882. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    883. 

  883. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl b                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor backward                             </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    884. 

  884. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    885. 

  885. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl c                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>clear line                                  </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    886. 

  886. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    887. 

  887. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl d                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>delete or exit                              </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    888. 

  888. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    889. 

  889. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl e                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor end                                  </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    890. 

  890. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    891. 

  891. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl f                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor forward                              </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    892. 

  892. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    893. 

  893. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl g                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>                                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    894. 

  894. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    895. 

  895. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl h                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>backspace                                   </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    896. 

  896. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    897. 

  897. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl i                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>tab                                         </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    898. 

  898. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    899. 

  899. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl j                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>enter                                       </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    900. 

  900. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    901. 

  901. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl k                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>clear line right                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    902. 

  902. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    903. 

  903. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl l                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>redraw input                                </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    904. 

  904. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    905. 

  905. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl m                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>enter                                       </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    906. 

  906. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    907. 

  907. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl n                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>input history next                          </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    908. 

  908. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    909. 

  909. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl o                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>                                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    910. 

  910. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    911. 

  911. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl p                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>input history prev                          </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    912. 

  912. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    913. 

  913. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl q                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>                                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    914. 

  914. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    915. 

  915. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl r                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>input history search                        </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    916. 

  916. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    917. 

  917. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl s                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>                                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    918. 

  918. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    919. 

  919. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl t                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>scroll buffer lock                          </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    920. 

  920. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    921. 

  921. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl u                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>clear line left                             </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    922. 

  922. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    923. 

  923. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl v                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>convert meta characters                     </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    924. 

  924. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    925. 

  925. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl w                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>delete word left                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    926. 

  926. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    927. 

  927. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl x                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>                                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    928. 

  928. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    929. 

  929. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl y                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>paste                                       </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    930. 

  930. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    931. 

  931. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl z                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>suspend                                     </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    932. 

  932. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    933. 

  933. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    934. 

  934. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>arrow left               </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor left                                 </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    935. 

  935. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    936. 

  936. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>arrow right              </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor right                                </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    937. 

  937. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    938. 

  938. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>arrow up                 </span><span style='color:#0AA'>││</span><span style='color:#FFF'>previous input line                         </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    939. 

  939. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    940. 

  940. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>arrow down               </span><span style='color:#0AA'>││</span><span style='color:#FFF'>next input line                             </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    941. 

  941. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    942. 

  942. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    943. 

  943. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl arrow left          </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor left word                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    944. 

  944. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    945. 

  945. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl arrow right         </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor right word                           </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    946. 

  946. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    947. 

  947. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    948. 

  948. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>backspace                </span><span style='color:#0AA'>││</span><span style='color:#FFF'>backspace                                   </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    949. 

  949. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    950. 

  950. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>alt backspace            </span><span style='color:#0AA'>││</span><span style='color:#FFF'>clear line left                             </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    951. 

  951. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    952. 

  952. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl backspace           </span><span style='color:#0AA'>││</span><span style='color:#FFF'>clear line                                  </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    953. 

  953. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    954. 

  954. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    955. 

  955. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>delete                   </span><span style='color:#0AA'>││</span><span style='color:#FFF'>delete                                      </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    956. 

  956. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    957. 

  957. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl delete              </span><span style='color:#0AA'>││</span><span style='color:#FFF'>delete word right                           </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    958. 

  958. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    959. 

  959. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    960. 

  960. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>end                      </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor end                                  </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    961. 

  961. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    962. 

  962. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl end                 </span><span style='color:#0AA'>││</span><span style='color:#FFF'>scroll buffer end                           </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    963. 

  963. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    964. 

  964. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    965. 

  965. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>enter                    </span><span style='color:#0AA'>││</span><span style='color:#FFF'>enter                                       </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    966. 

  966. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    967. 

  967. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>shift-enter              </span><span style='color:#0AA'>││</span><span style='color:#FFF'>soft enter                                  </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    968. 

  968. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    969. 

  969. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    970. 

  970. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>home                     </span><span style='color:#0AA'>││</span><span style='color:#FFF'>cursor home                                 </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    971. 

  971. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    972. 

  972. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>ctrl home                </span><span style='color:#0AA'>││</span><span style='color:#FFF'>scroll buffer home                          </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    973. 

  973. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    974. 

  974. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    975. 

  975. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>page up                  </span><span style='color:#0AA'>││</span><span style='color:#FFF'>scroll buffer up                            </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    976. 

  976. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    977. 

  977. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>page down                </span><span style='color:#0AA'>││</span><span style='color:#FFF'>scroll buffer down                          </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    978. 

  978. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    979. 

  979. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
    980. 

  980. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>tab                      </span><span style='color:#0AA'>││</span><span style='color:#FFF'>complete word forward                       </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    981. 

  981. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
    982. 

  982. </span><span style='color:#0AA'>│</span><span style='color:#FFF'>shift-tab                </span><span style='color:#0AA'>││</span><span style='color:#FFF'>complete word backward                      </span><span style='color:#0AA'>│</span><span style='color:#AAA'>
    983. 

  983. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
    984. 

  984. 

  985. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CURSOR'>cursor</a>, <a href='#EDIT'>edit</a> and <a href='#MACRO'>macro</a>.
    986. 

  986. <a name='ELSE'></a>
    987. 

  987. 

  988. </span><span style='color:#5F5'>         ELSE
    989. 

  989. 

  990. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #else </span><span style='color:#FFF'>{</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    991. 

  991. 

  992.          The else statement should follow an #IF or #ELSEIF statement and is
    993. 

  993.          only called if the proceeding #IF or #ELSEIF is false.
    994. 

  994. 

  995. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #if {1d2 == 1} {smile};#else {grin}
    996. 

  996. 

  997. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CASE'>case</a>, <a href='#DEFAULT'>default</a>, <a href='#ELSEIF'>elseif</a>, <a href='#IF'>if</a>, <a href='#SWITCH'>switch</a> and <a href='#REGEXP'>regexp</a>.
    998. 

  998. <a name='ELSEIF'></a>
    999. 

  999. 

  1000. </span><span style='color:#5F5'>         ELSEIF
    1001. 

  1001. 

  1002. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #elseif </span><span style='color:#FFF'>{</span><span style='color:#AAA'>conditional</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1003. 

  1003. 

  1004.          The elseif statement should follow an #IF or #ELSEIF statement and is
    1005. 

  1005.          only called when the statement is true and the proceeding #IF and
    1006. 

  1006.          #ELSEIF statements are false.
    1007. 

  1007. 

  1008. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #if {1d3 == 1} {smirk};#elseif {1d2 == 1} {snicker}
    1009. 

  1009. 

  1010. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CASE'>case</a>, <a href='#DEFAULT'>default</a>, <a href='#ELSE'>else</a>, <a href='#IF'>if</a>, <a href='#SWITCH'>switch</a> and <a href='#REGEXP'>regexp</a>.
    1011. 

  1011. <a name='END'></a>
    1012. 

  1012. 

  1013. </span><span style='color:#5F5'>         END
    1014. 

  1014. 

  1015. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #end {&lt;message&gt;}
    1016. 

  1016. 

  1017.          Terminates tintin and return to unix.  On most systems, ctrl-c has
    1018. 

  1018.          the same result.
    1019. 

  1019. 

  1020.          The message is optional and is printed before tintin exits. When
    1021. 

  1021.          using #end {&bsol;} tintin will terminate silently.
    1022. 

  1022. 

  1023. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ZAP'>zap</a>
    1024. 

  1024. <a name='ESCAPE CODES'></a>
    1025. 

  1025. 

  1026. </span><span style='color:#5F5'>         ESCAPE CODES
    1027. 

  1027. 

  1028. </span><span style='color:#AAA'>         You may use the escape character &bsol; for various special characters.
    1029. 

  1029. 

  1030.          &bsol;a    beep the terminal.
    1031. 

  1031.          &bsol;c    send a control character, &bsol;ca for ctrl-a.
    1032. 

  1032.          &bsol;e    start an escape sequence.
    1033. 

  1033.          &bsol;f    send a form feed.
    1034. 

  1034.          &bsol;n    send a line feed.
    1035. 

  1035.          &bsol;r    send a carriage return.
    1036. 

  1036.          &bsol;t    send a horizontal tab.
    1037. 

  1037.          &bsol;x    print an 8 bit character using hexadecimal, &bsol;xFF for example.
    1038. 

  1038.          &bsol;x7B  send the '{' character.
    1039. 

  1039.          &bsol;x7D  send the '}' character.
    1040. 

  1040.          &bsol;u    print a 16 bit unicode character, &bsol;uFFFD for example.
    1041. 

  1041.          &bsol;u{}  print a 8-21 bit unicode character, &bsol;u{2AF21} for example.
    1042. 

  1042.          &bsol;U    print a 21 bit unicode character, &bsol;U02AF21 for example.
    1043. 

  1043.          &bsol;v    send a vertical tab
    1044. 

  1044. 

  1045.          Ending a line with &bsol; will stop tintin from appending a line feed.
    1046. 

  1046.          To escape arguments in an alias or action use %%0 %%1 %%2 etc.
    1047. 

  1047. 

  1048. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CHARACTERS'>characters</a>, <a href='#COLORS'>colors</a>, <a href='#COORDINATES'>coordinates</a>, <a href='#MATHEMATICS'>mathematics</a> and <a href='#PCRE'>pcre</a>.
    1049. 

  1049. <a name='EVENT'></a>
    1050. 

  1050. 

  1051. </span><span style='color:#5F5'>         EVENT
    1052. 

  1052. 

  1053. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #event </span><span style='color:#FFF'>{</span><span style='color:#AAA'>event type</span><span style='color:#FFF'>}</span><span style='color:#AAA'> </span><span style='color:#FFF'>{</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1054. 

  1054. 

  1055.          Events allow you to create triggers for predetermined client events.
    1056. 

  1056. 

  1057.          Use #event without an argument to see a list of possible events with
    1058. 

  1058.          a brief description. Use #event %* to see the current list of defined
    1059. 

  1059.          events. Use #info {events} {on} to see events get thrown.
    1060. 

  1060. 

  1061.          Events, like triggers in general, are case sensitive and event names
    1062. 

  1062.          must be defined using all upper case letters. Only one event can be
    1063. 

  1063.          defined for each event type.
    1064. 

  1064. 

  1065.          To enable mouse events use #config mouse_tracking on, to see mouse
    1066. 

  1066.          events use #config mouse_tracking info.
    1067. 

  1067. 

  1068.          </span><span style='color:#5F5'>CATCH EVENTS
    1069. 

  1069. 

  1070.          </span><span style='color:#FFF'>CATCH &lt;EVENT&gt;
    1071. 

  1071.          </span><span style='color:#AAA'>  Some events can be prefixed with CATCH to interrupt default
    1072. 

  1072.            behavior.
    1073. 

  1073. 

  1074.          </span><span style='color:#5F5'>CLASS EVENTS
    1075. 

  1075. 

  1076.          </span><span style='color:#FFF'>CLASS ACTIVATED [CLASS],  CLASS_CLEAR [CLASS],  CLASS CREATED [CLASS],
    1077. 

  1077.          CLASS DEACTIVATED [CLASS],  CLASS DESTROYED [CLASS],
    1078. 

  1078.          CLASS_LOAD [CLASS]
    1079. 

  1079.          </span><span style='color:#AAA'>  %0 class name
    1080. 

  1080. 

  1081.          </span><span style='color:#5F5'>GAG EVENTS
    1082. 

  1082. 

  1083.          </span><span style='color:#FFF'>GAG &lt;EVENT&gt;
    1084. 

  1084.          </span><span style='color:#AAA'>  Some events can be prefixed with GAG to gag default system
    1085. 

  1085.            messages.
    1086. 

  1086. 

  1087.          </span><span style='color:#5F5'>INPUT EVENTS</span><span style='color:#AAA'>
    1088. 

  1088. 

  1089.          </span><span style='color:#FFF'>EDIT STARTED, EDIT FINISHED
    1090. 

  1090.          </span><span style='color:#AAA'>  %0 name  %1 lines %2 size %3 data
    1091. 

  1091. 

  1092.          </span><span style='color:#FFF'>RECEIVED KEYPRESS, PROCESSED KEYPRESS
    1093. 

  1093.          </span><span style='color:#AAA'>  %0 character  %1 unicode index  %2 edit row  %3 edit column
    1094. 

  1094. 

  1095.          </span><span style='color:#FFF'>RECEIVED INPUT [NAME]
    1096. 

  1096.          </span><span style='color:#AAA'>  %0 raw text
    1097. 

  1097. 

  1098.          </span><span style='color:#FFF'>RECEIVED INPUT CHARACTER
    1099. 

  1099.          </span><span style='color:#AAA'>  %0 character  %1 unicode index  %2 size  %3 width
    1100. 

  1100. 

  1101.          SEND OUTPUT            %0 raw text %1 size
    1102. 

  1102.          SENT OUTPUT            %0 raw text %1 size
    1103. 

  1103. 

  1104.          </span><span style='color:#5F5'>MAP EVENTS
    1105. 

  1105. 

  1106.          </span><span style='color:#FFF'>END OF PATH,  END OF RUN, MAP UPDATED VTMAP
    1107. 

  1107.          </span><span style='color:#AAA'>  These events have no additional arguments.
    1108. 

  1108. 

  1109.          </span><span style='color:#FFF'>MAP CREATE EXIT, MAP DELETE EXIT
    1110. 

  1110.          </span><span style='color:#AAA'>  %0 vnum  %1 exit name  %2 exit cmd  %3 exit vnum
    1111. 

  1111. 

  1112.          </span><span style='color:#FFF'>MAP CREATE ROOM, MAP DELETE ROOM
    1113. 

  1113.          </span><span style='color:#AAA'>  %0 vnum  %1 name
    1114. 

  1114. 

  1115.          </span><span style='color:#FFF'>MAP ENTER MAP, MAP EXIT MAP
    1116. 

  1116.          </span><span style='color:#AAA'>  %0 vnum
    1117. 

  1117. 

  1118.          </span><span style='color:#FFF'>MAP ENTER ROOM [VNUM]
    1119. 

  1119.          </span><span style='color:#AAA'>  %0 new vnum  %1 old vnum %2 direction
    1120. 

  1120. 

  1121.          </span><span style='color:#FFF'>MAP EXIT ROOM [VNUM]
    1122. 

  1122.          </span><span style='color:#AAA'>  %0 old vnum  %1 new vnum %2 direction
    1123. 

  1123. 

  1124.          </span><span style='color:#FFF'>MAP FOLLOW MAP
    1125. 

  1125.          </span><span style='color:#AAA'>  %0 old vnum  %1 new vnum  %2 exit name
    1126. 

  1126. 

  1127.          </span><span style='color:#FFF'>MAP REGION &lt;MOUSE&gt;, MAP ROOM &lt;MOUSE&gt;
    1128. 

  1128.          </span><span style='color:#AAA'>  %0 row  %1 col  %2 -row  %3 -col  %5 vnum  %6 info
    1129. 

  1129. 

  1130.          </span><span style='color:#5F5'>MOUSE EVENTS</span><span style='color:#AAA'>
    1131. 

  1131. 

  1132.          DOUBLE-CLICKED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
    1133. 

  1133.          LONG-CLICKED &lt;MOUSE&gt;   %0 row %1 col %2 -row %3 -col %4 word %5 line
    1134. 

  1134.          MOVED &lt;MOUSE&gt;          %0 row %1 col %2 -row %3 -col %4 word %5 line
    1135. 

  1135.          PRESSED &lt;MOUSE&gt;        %0 row %1 col %2 -row %3 -col %4 word %5 line
    1136. 

  1136.          SHORT-CLICKED &lt;MOUSE&gt;  %0 row %1 col %2 -row %3 -col %4 word %5 line
    1137. 

  1137.          RELEASED &lt;MOUSE&gt;       %0 row %1 col %2 -row %3 -col %4 word %5 line
    1138. 

  1138.          SCROLLED &lt;MOUSE&gt;       %0 row %1 col %2 -row %3 -col %4 word %5 line
    1139. 

  1139.          TRIPLE-CLICKED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
    1140. 

  1140. 

  1141.          </span><span style='color:#FFF'>MAP &lt;MOUSE EVENT&gt;
    1142. 

  1142.          </span><span style='color:#AAA'>  Mouse events can be prefixed with MAP to only trigger when the mouse
    1143. 

  1143.            event occurs inside the VT100 map region.
    1144. 

  1144. 

  1145. 

  1146.          </span><span style='color:#FFF'>SWIPED [DIR]
    1147. 

  1147.          </span><span style='color:#AAA'>  %0 dir  %1 button  %2 row  %3 col  %4 -row  %5 -col
    1148. 

  1148.                               %6 row  %7 col  %8 -row  %9 -col %10 rows %11 cols
    1149. 

  1149. 

  1150.          </span><span style='color:#5F5'>OUTPUT EVENTS
    1151. 

  1151. 

  1152.          </span><span style='color:#FFF'>BUFFER UPDATE,  DISPLAY UPDATE
    1153. 

  1153.          </span><span style='color:#AAA'>  These events have no additional arguments.
    1154. 

  1154. 

  1155.          RECEIVED LINE          %0 raw text %1 plain text
    1156. 

  1156.          RECEIVED OUTPUT        %0 raw text
    1157. 

  1157.          RECEIVED PROMPT        %0 raw text %1 plain text
    1158. 

  1158. 

  1159.          </span><span style='color:#5F5'>PORT EVENTS
    1160. 

  1160. 

  1161.          </span><span style='color:#FFF'>CHAT MESSAGE,  PORT MESSAGE
    1162. 

  1162.          </span><span style='color:#AAA'>  %0 raw text  %1 plain text
    1163. 

  1163. 

  1164.          </span><span style='color:#FFF'>PORT CONNECTION        </span><span style='color:#AAA'>%0 name %1 ip %2 port
    1165. 

  1165.          </span><span style='color:#FFF'>PORT DISCONNECTION     </span><span style='color:#AAA'>%0 name %1 ip %2 port
    1166. 

  1166.          </span><span style='color:#FFF'>PORT LOG MESSAGE       </span><span style='color:#AAA'>%0 name %1 ip %2 port %3 data %4 plain data
    1167. 

  1167.          </span><span style='color:#FFF'>PORT RECEIVED MESSAGE  </span><span style='color:#AAA'>%0 name %1 ip %2 port %3 data %4 plain data
    1168. 

  1168. 

  1169.          </span><span style='color:#5F5'>SCAN EVENTS</span><span style='color:#AAA'>
    1170. 

  1170. 

  1171.          SCAN CSV HEADER        %0 all args %1 arg1 %2 arg2 .. %99 arg99
    1172. 

  1172.          SCAN CSV LINE          %0 all args %1 arg1 %2 arg3 .. %99 arg99
    1173. 

  1173.          SCAN TSV HEADER        %0 all args %1 arg1 %2 arg3 .. %99 arg99
    1174. 

  1174.          SCAN TSV LINE          %0 all args %1 arg1 %2 arg3 .. %99 arg99
    1175. 

  1175. 

  1176.          </span><span style='color:#5F5'>SCREEN EVENTS</span><span style='color:#AAA'>
    1177. 

  1177. 

  1178.          </span><span style='color:#FFF'>SCREEN FOCUS
    1179. 

  1179.          </span><span style='color:#AAA'>  %0 focus (0 or 1)
    1180. 

  1180. 

  1181.          SCREEN LOCATION        %0 rows %1 cols  %2 height %3 width
    1182. 

  1182. 

  1183.          </span><span style='color:#FFF'>SCREEN MOUSE LOCATION
    1184. 

  1184.          </span><span style='color:#AAA'>  %0 row  %1 col  %2 -row  %3 -col  %4 pix row  %5 pix col
    1185. 

  1185.            %6 -pix row  %7 -pix col  %8 location
    1186. 

  1186. 

  1187.          SCREEN RESIZE          %0 rows %1 cols %2 height %3 width
    1188. 

  1188.          SCREEN SPLIT           %0 top row %1 top col %2 bot row %3 bot col
    1189. 

  1189.          SCREEN UNSPLIT         %0 top row %1 top col %2 bot row %3 bot col
    1190. 

  1190. 

  1191.          </span><span style='color:#5F5'>SESSION EVENTS</span><span style='color:#AAA'>
    1192. 

  1192. 

  1193.          SESSION ACTIVATED      %0 name
    1194. 

  1194.          SESSION CONNECTED      %0 name %1 host %2 ip %3 port
    1195. 

  1195.          SESSION CREATED        %0 name %1 host %2 ip %3 port
    1196. 

  1196.          SESSION DEACTIVATED    %0 name
    1197. 

  1197.          SESSION DISCONNECTED   %0 name %1 host %2 ip %3 port
    1198. 

  1198.          SESSION TIMED OUT      %0 name %1 host %2 ip %3 port
    1199. 

  1199. 

  1200. 

  1201.          </span><span style='color:#5F5'>SYSTEM EVENTS</span><span style='color:#AAA'>
    1202. 

  1202. 

  1203.          DAEMON ATTACHED        %0 file %1 pid
    1204. 

  1204.          DAEMON DETACHED        %0 file %1 pid
    1205. 

  1205.          PROGRAM START          %0 startup arguments
    1206. 

  1206.          PROGRAM TERMINATION    %0 goodbye message
    1207. 

  1207. 

  1208.          READ ERROR             %0 filename %1 error message
    1209. 

  1209.          READ FILE              %0 filename
    1210. 

  1210.          WRITE ERROR            %0 filename %1 error message
    1211. 

  1211.          WRITE FILE             %0 filename
    1212. 

  1212. 

  1213.          SYSTEM CRASH           %0 message
    1214. 

  1214.          SYSTEM ERROR           %0 name %1 system msg %2 error %3 error msg
    1215. 

  1215.          UNKNOWN COMMAND        %0 raw text
    1216. 

  1216.          SIGUSR                 %0 signal
    1217. 

  1217. 

  1218.          </span><span style='color:#5F5'>TELNET EVENTS
    1219. 

  1219. 

  1220.          </span><span style='color:#FFF'>IAC &lt;EVENT&gt;
    1221. 

  1221.          </span><span style='color:#AAA'>  IAC TELNET events are made visable using #config telnet info.
    1222. 

  1222. 

  1223.          </span><span style='color:#FFF'>IAC SB GMCP [MODULE]   %0 module    %1 data  %2 plain data
    1224. 

  1224.          IAC SB MSSP            %0 variable  %1 data
    1225. 

  1225.          IAC SB MSDP            %0 variable  %1 data  %2 plain data
    1226. 

  1226.          IAC SB MSDP [VAR]      %0 variable  %1 data  %2 plain data
    1227. 

  1227.          IAC SB NEW-ENVIRON     %0 variable  %1 data  %2 plain data
    1228. 

  1228.          IAC SB ZMP &lt;VAR&gt;       %0 variable  %1 data
    1229. 

  1229.          IAC SB &lt;VAR&gt;           %0 variable  %1 raw data  %2 plain data
    1230. 

  1230. 

  1231.          </span><span style='color:#5F5'>TIME EVENTS
    1232. 

  1232. 

  1233.          </span><span style='color:#FFF'>DATE &lt;MONTH-DAY OF MONTH&gt; [HOUR:MINUTE], DAY [DAY OF MONTH],
    1234. 

  1234.          HOUR [HOUR], MONTH [DAY OF MONTH], TIME &lt;HOUR:MINUTE&gt;[:SECOND],
    1235. 

  1235.          WEEK [DAY OF WEEK], YEAR [YEAR]
    1236. 

  1236.          </span><span style='color:#AAA'>  %0 year  %1 month  %2 day of week  %3 day of month  %4 hour
    1237. 

  1237.            %5 minute  %6 second
    1238. 

  1238. 

  1239.          </span><span style='color:#5F5'>VARIABLE EVENTS</span><span style='color:#AAA'>
    1240. 

  1240. 

  1241.          VARIABLE UPDATE &lt;VAR&gt;  %0 name %1 new value %2 path
    1242. 

  1242.          VARIABLE UPDATED &lt;VAR&gt; %0 name %1 new value %2 path
    1243. 

  1243. 

  1244.          </span><span style='color:#5F5'>VT100 EVENTS</span><span style='color:#AAA'>
    1245. 

  1245. 

  1246.          VT100 SCROLL REGION    %0 top row %1 bot row %2 rows %3 cols %4 wrap
    1247. 

  1247. 

  1248.          To see all events trigger use #event info on. Since this can get
    1249. 

  1249.          rather spammy it's possible to gag event info messages.
    1250. 

  1250. 

  1251. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {SESSION CONNECTED} {#read mychar.tin}
    1252. 

  1252. 

  1253. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove an event with the #unevent command.
    1254. 

  1254. 

  1255. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BUTTON'>button</a>, <a href='#DELAY'>delay</a> and <a href='#TICKER'>ticker</a>.
    1256. 

  1256. <a name='FOREACH'></a>
    1257. 

  1257. 

  1258. </span><span style='color:#5F5'>         FOREACH
    1259. 

  1259. 

  1260. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #foreach </span><span style='color:#FFF'>{</span><span style='color:#AAA'>list</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1261. 

  1261. 

  1262.          For each item in the provided list the foreach statement will update
    1263. 

  1263.          the given variable and execute the command part of the statement. List
    1264. 

  1264.          elements must be separated by braces or semicolons.
    1265. 

  1265. 

  1266. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #foreach {bob;tim;kim} {name} {tell &dollar;name Hello}
    1267. 

  1267. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #foreach {{bob}{tim}{kim}} {name} {tell &dollar;name Hello}
    1268. 

  1268. 

  1269. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#LIST'>list</a>, <a href='#LOOP'>loop</a>, <a href='#PARSE'>parse</a>, <a href='#REPEAT'>repeat</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    1270. 

  1270. <a name='FORMAT'></a>
    1271. 

  1271. 

  1272. </span><span style='color:#5F5'>         FORMAT
    1273. 

  1273. 

  1274. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #format </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>format</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument1</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument2</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>etc</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1275. 

  1275. 

  1276.          Allows you to store a string into a variable in the exact same way
    1277. 

  1277.          C's sprintf works with a few enhancements and limitations like a
    1278. 

  1278.          maximum of 30 arguments.
    1279. 

  1279. 

  1280.          If you use #format inside an alias or action you must escape %1s as
    1281. 

  1281.          %+1s or %%1s or %&bsol;1s so the %1 isn't substituted by the trigger.
    1282. 

  1282. 

  1283.          #format {test} {%+9s} {string}  pad string with up to 9 spaces
    1284. 

  1284.          #format {test} {%-9s} {string}  post pad string with up to 9 spaces
    1285. 

  1285.          #format {test} {%.8s} {string}  copy at most 8 characters
    1286. 

  1286.          #format {test} {%a}   {number}  print corresponding charset character
    1287. 

  1287.          #format {test} {%c}   {string}  use a highlight color name
    1288. 

  1288.          #format {test} {%d}   {number}  print a number with integer formatting
    1289. 

  1289.          #format {test} {%f}   {string}  perform floating point math
    1290. 

  1290.          #format {test} {%g}   {number}  perform thousand grouping on {number}
    1291. 

  1291.          #format {test} {%h}   {string}  turn text into a header line
    1292. 

  1292.          #format {test} {%l}   {string}  lowercase text
    1293. 

  1293.          #format {test} {%m}   {string}  perform mathematical calculation
    1294. 

  1294.          #format {test} {%n}     {name}  capitalize the first letter
    1295. 

  1295.          #format {test} {%p}   {string}  strip leading and trailing spaces
    1296. 

  1296.          #format {test} {%r}   {string}  reverse text, hiya = ayih
    1297. 

  1297.          #format {test} {%s}   {string}  print given string
    1298. 

  1298.          #format {test} {%t}   {format}  display time with strftime format
    1299. 

  1299.                                          optional {{format}{time}} syntax
    1300. 

  1300.          #format {test} {%u}   {string}  uppercase text
    1301. 

  1301.          #format {list} {%w}   {string}  store word wrapped text in {list}
    1302. 

  1302.                                          optional {{string}{width}} syntax
    1303. 

  1303.          #format {test} {%x}      {hex}  print corresponding charset character
    1304. 

  1304.          #format {test} {%A}     {char}  store corresponding character value
    1305. 

  1305.          #format {test} {%D}      {hex}  convert hex to decimal in {test}
    1306. 

  1306.          #format {hash} {%H}   {string}  store a 64 bit string hash in {hash}
    1307. 

  1307.          #format {test} {%L}   {string}  store the string length in {test}
    1308. 

  1308.          #format {test} {%M}   {number}  convert number to metric in {test}
    1309. 

  1309.          #format {test} {%S}   {string}  store the number of spelling errors
    1310. 

  1310.          #format {time} {%T}         {}  store the epoch time in {time}
    1311. 

  1311.          #format {time} {%U}         {}  store the micro epoch time in {time}
    1312. 

  1312.          #format {test} {%X}      {dec}  convert dec to hexadecimal in {test}
    1313. 

  1313. 

  1314.          #format {test} {%%}             a literal % character
    1315. 

  1315. 

  1316. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See #help TIME for help on the %t argument.
    1317. 

  1317. 

  1318. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CAT'>cat</a>, <a href='#ECHO'>echo</a>, <a href='#FUNCTION'>function</a>, <a href='#LOCAL'>local</a>, <a href='#MATH'>math</a>, <a href='#REPLACE'>replace</a>, <a href='#SCRIPT'>script</a>, <a href='#TIME'>time</a> and <a href='#VARIABLE'>variable</a>.
    1319. 

  1319. <a name='FUNCTION'></a>
    1320. 

  1320. 

  1321. </span><span style='color:#5F5'>         FUNCTION
    1322. 

  1322. 

  1323. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #function </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>operation</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1324. 

  1324. 

  1325.          Functions allow you to execute a script within a line of text, and
    1326. 

  1326.          replace the function call with the line of text generated by the
    1327. 

  1327.          function.
    1328. 

  1328. 

  1329.          Be aware that each function should use the #return command at the
    1330. 

  1330.          end of the function with the result, or set the {result} variable.
    1331. 

  1331. 

  1332.          To use a function use the @ character before the function name.
    1333. 

  1333.          The function arguments should be placed between braces behind the
    1334. 

  1334.          function name with argument separated by semicolons.
    1335. 

  1335. 

  1336.          Functions can be escaped by adding additional @ signs.
    1337. 

  1337. 

  1338. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function test #return 42;#showme @@test{}
    1339. 

  1339. 

  1340.          The function itself can use the provided arguments which are stored
    1341. 

  1341.          in %1 to %99, with %0 holding all arguments.
    1342. 

  1342. 

  1343. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function {rnd} {#math {result} {1 d (%2 - %1 + 1) + %1 - 1}}
    1344. 

  1344.          #show A random number between 100 and 200: @rnd{100;200}
    1345. 

  1345. 

  1346. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function gettime {#format result %t %H:%M}
    1347. 

  1347.          #show The current time is @gettime{}
    1348. 

  1348. 

  1349. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a function with the #unfunction command.
    1350. 

  1350. 

  1351. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#FORMAT'>format</a>, <a href='#LOCAL'>local</a>, <a href='#MATH'>math</a>, <a href='#REPLACE'>replace</a>, <a href='#SCRIPT'>script</a> and <a href='#VARIABLE'>variable</a>.
    1352. 

  1352. <a name='GAG'></a>
    1353. 

  1353. 

  1354. </span><span style='color:#5F5'>         GAG
    1355. 

  1355. 

  1356. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #gag </span><span style='color:#FFF'>{</span><span style='color:#AAA'>string</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1357. 

  1357. 

  1358.          Removes any line that contains the string.
    1359. 

  1359. 

  1360. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help action', for more information about triggers.
    1361. 

  1361. 

  1362.          There are a system messages that can be gagged using gag events.
    1363. 

  1363. 

  1364. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a gag with the #ungag command.
    1365. 

  1365. 

  1366. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ACTION'>action</a>, <a href='#HIGHLIGHT'>highlight</a>, <a href='#PROMPT'>prompt</a> and <a href='#SUBSTITUTE'>substitute</a>.
    1367. 

  1367. <a name='GREETING'></a>
    1368. 

  1368. 

  1369. </span><span style='color:#5F5'>         GREETING
    1370. 

  1370. 

  1371. </span><span style='color:#0AA'>      ####################################################################
    1372. 

  1372.       #</span><span style='color:#AAA'>                                                                  </span><span style='color:#0AA'>#
    1373. 

  1373.       #</span><span style='color:#AAA'>                    T I N T I N + +   2.02.12                     </span><span style='color:#0AA'>#
    1374. 

  1374.       #</span><span style='color:#AAA'>                                                                  </span><span style='color:#0AA'>#
    1375. 

  1375.       #</span><span style='color:#AAA'>      Code by Peter Unold, Bill Reis, and Igor van den Hoven      </span><span style='color:#0AA'>#
    1376. 

  1376.       #</span><span style='color:#AAA'>                                                                  </span><span style='color:#0AA'>#
    1377. 

  1377.       ####################################################################
    1378. 

  1378. 

  1379. <a name='GREP'></a>
    1380. 

  1380. 

  1381. </span><span style='color:#5F5'>         GREP
    1382. 

  1382. 

  1383. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #grep </span><span style='color:#FFF'>[</span><span style='color:#AAA'>page</span><span style='color:#FFF'>] {</span><span style='color:#AAA'>search string</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1384. 

  1384. 

  1385.          This command allows you to search for matching lines in your scroll
    1386. 

  1386.          back buffer. The amount of matches shown equals your screen size. If
    1387. 

  1387.          you want to search back further use the optional page number. You can
    1388. 

  1388.          use wildcards for better search results. Be aware the search string
    1389. 

  1389.          is case sensitive, which can be disabled by using %i.
    1390. 

  1390. 

  1391.          By default grep searches from the end of the scrollback buffer to the
    1392. 

  1392.          beginning, this can be reversed by using a negative page number.
    1393. 

  1393. 

  1394. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #grep Bubba tells you
    1395. 

  1395.          This will show all occasions where bubba tells you something.
    1396. 

  1396. 

  1397. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BUFFER'>buffer</a>, <a href='#ECHO'>echo</a> and <a href='#SHOWME'>showme</a>.
    1398. 

  1398. <a name='HELP'></a>
    1399. 

  1399. 

  1400. </span><span style='color:#5F5'>         HELP
    1401. 

  1401. 

  1402. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #help </span><span style='color:#FFF'>{</span><span style='color:#AAA'>subject</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1403. 

  1403. 

  1404.          Without an argument #help will list all available help subjects.
    1405. 

  1405. 

  1406.          Using #help %* will display all help entries.
    1407. 

  1407. 

  1408. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#COMMANDS'>commands</a>, <a href='#DEBUG'>debug</a>, <a href='#IGNORE'>ignore</a>, <a href='#INFO'>info</a>, <a href='#MESSAGE'>message</a> and <a href='#STATEMENTS'>statements</a>.
    1409. 

  1409. <a name='HIGHLIGHT'></a>
    1410. 

  1410. 

  1411. </span><span style='color:#5F5'>         HIGHLIGHT
    1412. 

  1412. 

  1413. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #highlight </span><span style='color:#FFF'>{</span><span style='color:#AAA'>string</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>color names</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>priority</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1414. 

  1414. 

  1415.          The highlight command is used to allow you to highlight strings of text.
    1416. 

  1416. 

  1417.          Available color options are:
    1418. 

  1418. 

  1419.          reset      - resets the color state to default
    1420. 

  1420.          light      - turns the color light in 16 color mode.
    1421. 

  1421.          dark       - turns the color dark in 16 color mode.
    1422. 

  1422.          underscore - underscores the text.
    1423. 

  1423.          blink      - makes the text blink.
    1424. 

  1424.          reverse    - reverse foreground and background color.
    1425. 

  1425.          b          - makes next color the background color.
    1426. 

  1426. 

  1427.          Available color names are:
    1428. 

  1428. 

  1429.          &lt;F06B&gt; - azure                 &lt;F08F&gt; - Azure
    1430. 

  1430.          &lt;F00B&gt; - blue                  &lt;F00F&gt; - Blue
    1431. 

  1431.          &lt;F0BB&gt; - cyan                  &lt;F0FF&gt; - Cyan
    1432. 

  1432.          &lt;F000&gt; - ebony                 &lt;F666&gt; - Ebony
    1433. 

  1433.          &lt;F0B0&gt; - green                 &lt;F0F0&gt; - Green
    1434. 

  1434.          &lt;F0B6&gt; - jade                  &lt;F0F8&gt; - Jade
    1435. 

  1435.          &lt;F6B0&gt; - lime                  &lt;F8F0&gt; - Lime
    1436. 

  1436.          &lt;FB0B&gt; - magenta               &lt;FF0F&gt; - Magenta
    1437. 

  1437.          &lt;FB60&gt; - orange                &lt;FF80&gt; - Orange
    1438. 

  1438.          &lt;FB06&gt; - pink                  &lt;FF08&gt; - Pink
    1439. 

  1439.          &lt;FB00&gt; - red                   &lt;FF00&gt; - Red
    1440. 

  1440.          &lt;F888&gt; - silver                &lt;FDDD&gt; - Silver
    1441. 

  1441.          &lt;F860&gt; - tan                   &lt;FDB0&gt; - Tan
    1442. 

  1442.          &lt;F60B&gt; - violet                &lt;F80F&gt; - Violet
    1443. 

  1443.          &lt;FBBB&gt; - white                 &lt;FFFF&gt; - White
    1444. 

  1444.          &lt;FBB0&gt; - yellow                &lt;FFF0&gt; - Yellow
    1445. 

  1445. 

  1446.          The %1-99 variables can be used as 'wildcards' that will match with any
    1447. 

  1447.          text. They are useful for highlighting a complete line. The %0 variable
    1448. 

  1448.          should never be used in highlights.
    1449. 

  1449. 

  1450.          You may start the string to highlight with a ^ to only highlight text
    1451. 

  1451.          if it begins the line.
    1452. 

  1452. 

  1453.          Besides color names also &lt;abc&gt; color codes can be used.
    1454. 

  1454. 

  1455. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high {Valgar} {reverse blink}
    1456. 

  1456.          Prints every occurrence of 'Valgar' in blinking reverse video.
    1457. 

  1457. 

  1458. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high {^You %1} {bold cyan}
    1459. 

  1459.          Boldfaces any line that starts with 'You' in cyan.
    1460. 

  1460. 

  1461. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high {Bubba} {red underscore b green}
    1462. 

  1462.          Highlights the name Bubba as red underscored text on green background.
    1463. 

  1463. 

  1464. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help action', for more information about triggers.
    1465. 

  1465. 

  1466. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help substitute', for more advanced color substitution.
    1467. 

  1467. 

  1468. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: This command only works with ANSI/VT100 terminals or emulators.
    1469. 

  1469. 

  1470. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a highlight with the #unhighlight command.
    1471. 

  1471. 

  1472. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ACTION'>action</a>, <a href='#GAG'>gag</a>, <a href='#PROMPT'>prompt</a> and <a href='#SUBSTITUTE'>substitute</a>.
    1473. 

  1473. <a name='HISTORY'></a>
    1474. 

  1474. 

  1475. </span><span style='color:#5F5'>         HISTORY
    1476. 

  1476. 

  1477. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #history </span><span style='color:#FFF'>{</span><span style='color:#AAA'>delete</span><span style='color:#FFF'>}</span><span style='color:#AAA'>                 Delete the last command.
    1478. 

  1478.          #history </span><span style='color:#FFF'>{</span><span style='color:#AAA'>insert</span><span style='color:#FFF'>}    {</span><span style='color:#AAA'>command</span><span style='color:#FFF'>}</span><span style='color:#AAA'>    Insert a command.
    1479. 

  1479.          #history </span><span style='color:#FFF'>{</span><span style='color:#AAA'>list</span><span style='color:#FFF'>}</span><span style='color:#AAA'>                   Display the entire command history.
    1480. 

  1480.          #history </span><span style='color:#FFF'>{</span><span style='color:#AAA'>read</span><span style='color:#FFF'>}      {</span><span style='color:#AAA'>filename</span><span style='color:#FFF'>}</span><span style='color:#AAA'>   Read a command history from file.
    1481. 

  1481.          #history </span><span style='color:#FFF'>{</span><span style='color:#AAA'>write</span><span style='color:#FFF'>}     {</span><span style='color:#AAA'>filename</span><span style='color:#FFF'>}</span><span style='color:#AAA'>   Write a command history to file.
    1482. 

  1482. 

  1483.          Without an argument all available options are shown.
    1484. 

  1484. 

  1485.          By default all commands are saved to the history list and the history
    1486. 

  1486.          list is saved between sessions in the ~/.tintin/history.txt file.
    1487. 

  1487. 

  1488.          You can set the character to repeat a command in the history with the
    1489. 

  1489.          #config {REPEAT CHAR} {&lt;character&gt;} configuration option, by default
    1490. 

  1490.          this is set to the exclamation mark.
    1491. 

  1491. 

  1492.          You can use ! by itself to repeat the last command, or !&lt;text&gt; to
    1493. 

  1493.          repeat the last command starting with the given text.
    1494. 

  1494. 

  1495.          You can use #config {REPEAT ENTER} {ON} to repeat the last command
    1496. 

  1496.          when you press enter on an empty line.
    1497. 

  1497. 

  1498.          You can press ctrl-r to enter an interactive regex enabled history
    1499. 

  1499.          search mode, or by issuing #cursor {history search}.
    1500. 

  1500. 

  1501.          TinTin++ tries to bind the arrow up and down keys to scroll through
    1502. 

  1502.          the history list by default. You can bind these with a macro yourself
    1503. 

  1503.          using #cursor {history next} and #cursor {history prev}. Many #cursor
    1504. 

  1504.          commands only work properly when bound with a macro.
    1505. 

  1505. 

  1506. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALIAS'>alias</a>, <a href='#CURSOR'>cursor</a>, <a href='#KEYPAD'>keypad</a>, <a href='#MACRO'>macro</a>, <a href='#SPEEDWALK'>speedwalk</a> and <a href='#TAB'>tab</a>.
    1507. 

  1507. <a name='IF'></a>
    1508. 

  1508. 

  1509. </span><span style='color:#5F5'>         IF
    1510. 

  1510. 

  1511. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #if </span><span style='color:#FFF'>{</span><span style='color:#AAA'>conditional</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands if true</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1512. 

  1512. 

  1513.          The #if command is one of the most powerful commands added since
    1514. 

  1514.          TINTIN III. It works similar to an if statement in other languages,
    1515. 

  1515.          and is based on the way C handles its conditional statements.
    1516. 

  1516.          When an #if command is encountered, the conditional statement is
    1517. 

  1517.          evaluated, and if TRUE (any non-zero result) the commands are executed.
    1518. 

  1518. 

  1519.          The if statement is only evaluated if it is read, so you must nest
    1520. 

  1520.          the if statement inside another statement (most likely an #action
    1521. 

  1521.          command). The conditional is evaluated exactly the same as in the
    1522. 

  1522.          #math command, only instead of storing the result, the result is used
    1523. 

  1523.          to determine whether to execute the commands.
    1524. 

  1524. 

  1525.          To handle the case where an if statement is false it can be followed
    1526. 

  1526.          by the #else command.
    1527. 

  1527. 

  1528. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {%0 gives you %1 gold coins.} {#if {%1 &gt; 5000} {thank %0}}
    1529. 

  1529.          If someone gives you more than 5000 coins, thank them.
    1530. 

  1530. 

  1531. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {k} {#if {&quot;%0&quot; == &quot;&quot;} {kill &dollar;target};#else {kill %0}}
    1532. 

  1532. 

  1533. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help math', for more information.
    1534. 

  1534. 

  1535. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CASE'>case</a>, <a href='#DEFAULT'>default</a>, <a href='#ELSE'>else</a>, <a href='#ELSEIF'>elseif</a>, <a href='#SWITCH'>switch</a> and <a href='#REGEXP'>regexp</a>.
    1536. 

  1536. <a name='IGNORE'></a>
    1537. 

  1537. 

  1538. </span><span style='color:#5F5'>         IGNORE
    1539. 

  1539. 

  1540. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #ignore </span><span style='color:#FFF'>{</span><span style='color:#AAA'>listname</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>on</span><span style='color:#FFF'>|</span><span style='color:#AAA'>off</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1541. 

  1541. 

  1542.          Toggles a list on or off. With no arguments it shows your current
    1543. 

  1543.          settings, as well as the list names that you can ignore.
    1544. 

  1544. 

  1545.          If you for example set ACTIONS to OFF actions will no longer trigger.
    1546. 

  1546.          Not every list can be ignored.
    1547. 

  1547. 

  1548. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a>, <a href='#DEBUG'>debug</a>, <a href='#INFO'>info</a>, <a href='#KILL'>kill</a> and <a href='#MESSAGE'>message</a>.
    1549. 

  1549. <a name='INDEX'></a>
    1550. 

  1550. 

  1551. </span><span style='color:#5F5'>         INDEX
    1552. 

  1552. 

  1553. </span><span style='color:#AAA'>         On this page you'll find an introduction to using TinTin++. Additional
    1554. 

  1554.          information can be found in the individual help sections.
    1555. 

  1555. </span><span style='color:#5F5'>
    1556. 

  1556.          Starting and Ending
    1557. 

  1557. </span><span style='color:#AAA'>
    1558. 

  1558.          The syntax for starting TinTin++ is: ./tt++ [command file]
    1559. 

  1559. 

  1560.          Read more about the command file in the files section below. Remember
    1561. 

  1561.          one thing though. All actions, aliases, substitutions, etc, defined
    1562. 

  1562.          when starting up TinTin++ are inherited by all sessions.
    1563. 

  1563. 

  1564.          If you want to exit TinTin++ type '#end' or press ctrl-d on an empty
    1565. 

  1565.          line.
    1566. 

  1566. 

  1567.          For the WinTin++ users, if you want to paste text use shift-insert,
    1568. 

  1568.          text is automatically copied upon selection. This is typical Linux
    1569. 

  1569.          behavior, but it can take some getting used to.
    1570. 

  1570. 

  1571. </span><span style='color:#5F5'>
    1572. 

  1572.          Basic features
    1573. 

  1573. </span><span style='color:#AAA'>
    1574. 

  1574.          I'll start by explaining some of the very basic and important features:
    1575. 

  1575. 

  1576.          All TinTin++ commands starts with a '#'.
    1577. 

  1577. 

  1578. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #help -- #help is a client command, and isn't send to the server.
    1579. 

  1579. 

  1580.          All TinTin++ commands can be abbreviated when typed.
    1581. 

  1581. 

  1582.          #he -- Typing #he is the same as typing #help though it's suggested to
    1583. 

  1583.          use at least 3 letter abbreviations just in case another command is
    1584. 

  1584.          added that starts with 'he'.
    1585. 

  1585. 

  1586.          All commands can be separated with a ';'.
    1587. 

  1587. 

  1588.          n;l green;s;say Dan Dare is back! -- do these 4 commands
    1589. 

  1589.          There are 3 ways ';'s can be overruled.
    1590. 

  1590. 

  1591.          &bsol;say Hello ;) -- Lines starting with a '&bsol;' aren't parsed by TinTin++.
    1592. 

  1592.          say Hello &bsol;;) -- The escape character can escape 1 letter.
    1593. 

  1593.          #config verbatim on -- Everything is send as is except '#' commands.
    1594. 

  1594. </span><span style='color:#5F5'>
    1595. 

  1595.          Connecting to a server
    1596. 

  1596. </span><span style='color:#FFF'>
    1597. 

  1597. Command</span><span style='color:#AAA'>: #session </span><span style='color:#FFF'>{</span><span style='color:#AAA'>session name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>server address</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>port</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1598. 

  1598. 

  1599.          Example: #session someone tintin.sourceforge.net 4321
    1600. 

  1600. 

  1601.          You can have more than one session, in which case you can switch
    1602. 

  1602.          between sessions typing #&lt;session name&gt;.
    1603. 

  1603. 

  1604.          You can get a list of all sessions by typing: #session. The current
    1605. 

  1605.          active session is marked with (active). Snooped sessions with
    1606. 

  1606.          (snooped). MCCP sessions (compression) with (mccp 2) and (mccp 3).
    1607. 

  1607. 

  1608. </span><span style='color:#5F5'>
    1609. 

  1609.          Split
    1610. 

  1610. </span><span style='color:#FFF'>
    1611. 

  1611. Command</span><span style='color:#AAA'>: #split
    1612. 

  1612. 

  1613.          The split command will create a separated input and output area.
    1614. 

  1614. 

  1615.          Using the #prompt command you can capture the prompt and place it on
    1616. 

  1616.          the split line. To get rid of the split interface you can use #unsplit
    1617. 

  1617.          which will restore the terminal settings to default.
    1618. 

  1618. 

  1619. </span><span style='color:#5F5'>
    1620. 

  1620.          Alias
    1621. 

  1621. </span><span style='color:#FFF'>
    1622. 

  1622. Command</span><span style='color:#AAA'>: #alias </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1623. 

  1623. 

  1624.          The syntax of the #alias command is almost like alias in csh.
    1625. 

  1625.          Use this command to define aliases. The variables %0, %1.. %9 contain
    1626. 

  1626.          the arguments to the aliased command as follows:
    1627. 

  1627.          the %0 variable contains ALL the arguments.
    1628. 

  1628.          the %1 variable contains the 1st argument
    1629. 

  1629.          ....
    1630. 

  1630.          the %9 variable contains the 9th argument
    1631. 

  1631. 

  1632. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias greet say Greetings, most honorable %1
    1633. 

  1633. 

  1634.          If there are no variables on the right-side of the alias definition,
    1635. 

  1635.          any arguments following the aliases-command will be appended to the
    1636. 

  1636.          command string.
    1637. 

  1637. 

  1638. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias ff cast 'fireball' -- 'ff bob' equals: cast 'fireball' bob
    1639. 

  1639. 

  1640.          If you want an alias to execute more commands, you must use braces.
    1641. 

  1641. 

  1642. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias ws </span><span style='color:#FFF'>{</span><span style='color:#AAA'>wake;stand</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1643. 

  1643. 

  1644.          To delete an alias use the #unalias command.
    1645. 

  1645. 

  1646.          WARNING! TinTin++ doesn't baby sit, and hence does not check for
    1647. 

  1647.          recursive aliases! You can avoid recursion by escaping the entire
    1648. 

  1648.          line.
    1649. 

  1649. 

  1650. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias put &bsol;put %1 in %2
    1651. 

  1651. 

  1652.          Or by using the send command.
    1653. 

  1653. 

  1654. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #send put %1 in %2
    1655. 

  1655. 

  1656. 

  1657. </span><span style='color:#5F5'>         Action
    1658. 

  1658. 

  1659. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>action-text</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1660. 

  1660. 

  1661.          Use this command to define an action to take place when a particular
    1662. 

  1662.          text appears on your screen. There are 99 variables you can use as
    1663. 

  1663.          wildcards in the action-text.
    1664. 

  1664. 

  1665.          These variables are %1, %2, %3 .... %9, %10, %11 ... %97, %98, %99.
    1666. 

  1666. 

  1667. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>You are hungry</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>get bread bag;eat bread</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1668. 

  1668. 

  1669. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>%1 has arrived.</span><span style='color:#FFF'>}</span><span style='color:#AAA'> shake %1 -- shake hands with people arriving.
    1670. 

  1670. 

  1671. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>%1 tells you '%2'</span><span style='color:#FFF'>}
    1672. 

  1672.                    {</span><span style='color:#AAA'>tell bob %1 told me '%2'</span><span style='color:#FFF'>}</span><span style='color:#AAA'> -- forward tells.
    1673. 

  1673. 

  1674. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>tells you</span><span style='color:#FFF'>}</span><span style='color:#AAA'> #bell -- beep on tell.
    1675. 

  1675. 

  1676.          You can have TinTin++ ignore actions if you type '#ignore actions on'.
    1677. 

  1677. 

  1678.          You can see what commands TinTin++ executes when an action triggers
    1679. 

  1679.          by typing '#debug actions on'.
    1680. 

  1680. 

  1681.          You can remove actions with the #unaction command.
    1682. 

  1682. 

  1683. </span><span style='color:#5F5'>
    1684. 

  1684.          Highlight
    1685. 

  1685. 

  1686. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #highlight </span><span style='color:#FFF'>{</span><span style='color:#AAA'>text</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>color</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1687. 

  1687. 

  1688.          This command works a bit like #action. The purpose of this command is
    1689. 

  1689.          to substitute text from the server with color you provide. This command
    1690. 

  1690.          is a simplified version of the #substitute command.
    1691. 

  1691. 

  1692. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high </span><span style='color:#FFF'>{</span><span style='color:#AAA'>Snowy</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>light yellow</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1693. 

  1693. 

  1694. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high </span><span style='color:#FFF'>{</span><span style='color:#AAA'>%*Snowy%*</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>light yellow</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1695. 

  1695. 

  1696.          Use #unhigh to delete highlights.
    1697. 

  1697. 

  1698. 

  1699.          Speedwalk
    1700. 

  1700. 

  1701.          If you type a command consisting ONLY of letters and numbers n, e, s,
    1702. 

  1702.          w, u, d - then this command can be interpreted as a serie of movement
    1703. 

  1703.          commands.
    1704. 

  1704. 

  1705. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: ssw2n -- go south, south, west, north, north
    1706. 

  1706. 

  1707.          If you have problems with typing some commands that actually ONLY
    1708. 

  1708.          consists of these letters, then type them in CAPS. For example when
    1709. 

  1709.          checking the NEWS or when asked to enter NEW as your name.
    1710. 

  1710. 

  1711.          You must enable speedwalking with: #config speedwalk on/off.
    1712. 

  1712. 

  1713. </span><span style='color:#5F5'>
    1714. 

  1714.          Ticker
    1715. 

  1715. 

  1716. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #ticker </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>seconds</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1717. 

  1717. 

  1718.          The name can be whatever you want it to be, and is only required for
    1719. 

  1719.          the unticker command. The commands will be executed every x amount of
    1720. 

  1720.          seconds, which is specified in the interval part.
    1721. 

  1721. 

  1722. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #tick </span><span style='color:#FFF'>{</span><span style='color:#AAA'>tick</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>#delay 50 #show 10 SECONDS TO TICK!;#show TICK!!!</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>60</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1723. 

  1723. 

  1724.          This creates a ticker with the name </span><span style='color:#FFF'>{</span><span style='color:#AAA'>tick</span><span style='color:#FFF'>}</span><span style='color:#AAA'> which will print TICK!!!,
    1725. 

  1725.          as well as print a warning when the next tick will occure.
    1726. 

  1726. 

  1727.          You can remove tickers with #untick
    1728. 

  1728. 

  1729. </span><span style='color:#5F5'>
    1730. 

  1730.          Command files
    1731. 

  1731. </span><span style='color:#AAA'>
    1732. 

  1732.          When you order TinTin++ to read a command file, it parses all the text
    1733. 

  1733.          in the file. You can use command files to keep aliases/actions in,
    1734. 

  1734.          login to a server (name, password etc..) and basically all kinds of
    1735. 

  1735.          commands.
    1736. 

  1736. 

  1737.          You can make the command files with either a text editor (suggested),
    1738. 

  1738.          or use the #write command to write out a file.
    1739. 

  1739. 

  1740.          Commands for files:
    1741. 

  1741. 

  1742.          #read filename -- read and execute the file.
    1743. 

  1743. 

  1744.          #write filename -- write all actions/aliases/substitutes/etc known for
    1745. 

  1745.          the current session to a file.
    1746. 

  1746. 

  1747. </span><span style='color:#5F5'>
    1748. 

  1748.          Repeating Commands
    1749. 

  1749. </span><span style='color:#AAA'>
    1750. 

  1750.          You can repeat a command, the syntax is: #number command
    1751. 

  1751. 

  1752. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #5 cackle -- if you just killed bob the wizard.
    1753. 

  1753. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #10 </span><span style='color:#FFF'>{</span><span style='color:#AAA'>buy bread;put bread bag</span><span style='color:#FFF'>}</span><span style='color:#AAA'> -- repeat these 2 commands 10 times.
    1754. 

  1754. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #100 ooc w00t w00t!!!!! -- nochannel yourself.
    1755. 

  1755. 

  1756. </span><span style='color:#5F5'>
    1757. 

  1757.          History
    1758. 

  1758. </span><span style='color:#AAA'>
    1759. 

  1759.          TinTin++ has a limited subset of the csh history features.
    1760. 

  1760. 

  1761.          ! -- repeat the last command
    1762. 

  1762.          !cast -- repeat the last command starting with cast
    1763. 

  1763.          ctrl-r -- enter the reverse history search mode.
    1764. 

  1764. 

  1765. </span><span style='color:#5F5'>
    1766. 

  1766.          Map commands
    1767. 

  1767. </span><span style='color:#AAA'>
    1768. 

  1768.          TinTin++ has a powerful highly configurable automapper. Whenever
    1769. 

  1769.          you type n/ne/e/se/s/sw/w/nw/n/u/d tt++ tries to keep track of your
    1770. 

  1770.          movement.
    1771. 

  1771. 

  1772.          Commands for map:
    1773. 

  1773. 

  1774.          #map create -- create a map.
    1775. 

  1775.          #map goto 1 -- go to the first room in the map, created by default.
    1776. 

  1776.          #map map -- display the map.
    1777. 

  1777.          #map undo -- undo your last map alteration.
    1778. 

  1778.          #map write &lt;filename&gt; -- save the map to file.
    1779. 

  1779.          #map read &lt;filename&gt; -- load a map from file.
    1780. 

  1780. 

  1781.          There are many other map options and it's beyond the scope of this
    1782. 

  1782.          help section to explain everything there is to know, but I'll give
    1783. 

  1783.          a set of commands that will get most people started.
    1784. 

  1784. 

  1785.          #map create
    1786. 

  1786.          #split 12 1
    1787. 

  1787.          #map flag unicode on
    1788. 

  1788.          #map flag vt on
    1789. 

  1789.          #map goto 1
    1790. 

  1790. 

  1791.          These commands will create a 12 row vt100 split section at the top of
    1792. 

  1792.          your screen where a map drawn using unicode characters is displayed.
    1793. 

  1793. 

  1794. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action </span><span style='color:#FFF'>{</span><span style='color:#AAA'>There is no exit in that direction.</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>#map undo</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1795. 

  1795. 

  1796.          The map will be automatically created as you move around.
    1797. 

  1797. 

  1798. </span><span style='color:#5F5'>
    1799. 

  1799.          Help
    1800. 

  1800. 

  1801. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #help </span><span style='color:#FFF'>{</span><span style='color:#AAA'>subject</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1802. 

  1802. 

  1803.          The help command is your friend and contains the same helpfiles
    1804. 

  1804.          inside TinTin++ as are available on the website. If you type #help
    1805. 

  1805.          without an argument you will see the various available help subjects
    1806. 

  1806.          which try to explain the TinTin++ commands and features in greater
    1807. 

  1807.          detail.
    1808. 

  1808. 

  1809. </span><span style='color:#5F5'>
    1810. 

  1810.          Enjoy</span><span style='color:#AAA'>
    1811. 

  1811. 

  1812. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CHARACTERS'>characters</a>, <a href='#COLORS'>colors</a>, <a href='#COORDINATES'>coordinates</a>, <a href='#EDITING'>editing</a>, <a href='#ESCAPE_CODES'>escape_codes</a>, <a href='#GREETING'>greeting</a>, <a href='#KEYPAD'>keypad</a>, <a href='#LISTS'>lists</a>, <a href='#MAPPING'>mapping</a>, <a href='#MATHEMATICS'>mathematics</a>, <a href='#SCREEN_READER'>screen_reader</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SPEEDWALK'>speedwalk</a>, <a href='#STATEMENTS'>statements</a>, <a href='#SUSPEND'>suspend</a> and <a href='#TIME'>time</a>.
    1813. 

  1813. <a name='INFO'></a>
    1814. 

  1814. 

  1815. </span><span style='color:#5F5'>         INFO
    1816. 

  1816. 

  1817. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #info </span><span style='color:#FFF'>{</span><span style='color:#AAA'>listname</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>LIST</span><span style='color:#FFF'>|</span><span style='color:#AAA'>ON</span><span style='color:#FFF'>|</span><span style='color:#AAA'>OFF</span><span style='color:#FFF'>|</span><span style='color:#AAA'>SAVE</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1818. 

  1818. 

  1819.          Without an argument info displays the settings of every tintin list.
    1820. 

  1820. 

  1821.          By providing the name of a list and the LIST option it shows all
    1822. 

  1822.          triggers/variables associated with that list. With the SAVE option
    1823. 

  1823.          this data is written to the info variable.
    1824. 

  1824. 

  1825.          #info cpu will show information about tintin's cpu usage.
    1826. 

  1826.          #info environ will show the environment variables.
    1827. 

  1827.          #info input will show information about the input line.
    1828. 

  1828.          #info mccp will show information about data compression.
    1829. 

  1829.          #info memory will show information about the memory stack.
    1830. 

  1830.          #info stack will show the low level debugging stack.
    1831. 

  1831.          #info session will show information on the session.
    1832. 

  1832.          #info sessions will show information on all sessions.
    1833. 

  1833.          #info system will show some system information.
    1834. 

  1834.          #info tokenizer will show information about the script stack.
    1835. 

  1835.          #info unicode will show information on the provided character.
    1836. 

  1836. 

  1837. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a>, <a href='#DEBUG'>debug</a>, <a href='#IGNORE'>ignore</a>, <a href='#KILL'>kill</a> and <a href='#MESSAGE'>message</a>.
    1838. 

  1838. <a name='KEYPAD'></a>
    1839. 

  1839. 

  1840. </span><span style='color:#5F5'>         KEYPAD
    1841. 

  1841. 

  1842. </span><span style='color:#AAA'>When TinTin++ starts up it sends &bsol;e= to the terminal to enable the terminal's
    1843. 

  1843. application keypad mode, which can be disabled using #show {&bsol;e&gt;}
    1844. 

  1844. 

  1845. </span><span style='color:#FFF'>      Configuration A           Configuration B           Configuration C</span><span style='color:#0AA'>
    1846. 

  1846.  ╭─────┬─────┬─────┬─────╮ ╭─────┬─────┬─────┬─────╮ ╭─────┬─────┬─────┬─────╮
    1847. 

  1847.  │</span><span style='color:#FFF'>num</span><span style='color:#0AA'>  │</span><span style='color:#FFF'>/</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>*</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>-</span><span style='color:#0AA'>    │ │</span><span style='color:#FFF'>num</span><span style='color:#0AA'>  │</span><span style='color:#FFF'>/</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>*</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>-</span><span style='color:#0AA'>    │ │</span><span style='color:#FFF'>Num</span><span style='color:#0AA'>  │</span><span style='color:#FFF'>nkp/</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp*</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp-</span><span style='color:#0AA'> │
    1848. 

  1848.  ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤
    1849. 

  1849.  │</span><span style='color:#FFF'>7</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>8</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>9</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>+</span><span style='color:#0AA'>    │ │</span><span style='color:#FFF'>Home</span><span style='color:#0AA'> │</span><span style='color:#FFF'>Up</span><span style='color:#0AA'>   │</span><span style='color:#FFF'>PgUp</span><span style='color:#0AA'> │</span><span style='color:#FFF'>+</span><span style='color:#0AA'>    │ │</span><span style='color:#FFF'>nkp7</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp8</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp9</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp+</span><span style='color:#0AA'> │
    1850. 

  1850.  ├─────┼─────┼─────┤     │ ├─────┼─────┼─────┤     │ ├─────┼─────┼─────┤     │
    1851. 

  1851.  │</span><span style='color:#FFF'>4</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>5</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>6</span><span style='color:#0AA'>    │     │ │</span><span style='color:#FFF'>Left</span><span style='color:#0AA'> │</span><span style='color:#FFF'>Cntr</span><span style='color:#0AA'> │</span><span style='color:#FFF'>Right</span><span style='color:#0AA'>│     │ │</span><span style='color:#FFF'>nkp4</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp5</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp6</span><span style='color:#0AA'> │     │
    1852. 

  1852.  ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤
    1853. 

  1853.  │</span><span style='color:#FFF'>1</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>2</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>3</span><span style='color:#0AA'>    │</span><span style='color:#FFF'>Enter</span><span style='color:#0AA'>│ │</span><span style='color:#FFF'>End</span><span style='color:#0AA'>  │</span><span style='color:#FFF'>Down</span><span style='color:#0AA'> │</span><span style='color:#FFF'>PgDn</span><span style='color:#0AA'> │</span><span style='color:#FFF'>Enter</span><span style='color:#0AA'>│ │</span><span style='color:#FFF'>nkp1</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp2</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkp3</span><span style='color:#0AA'> │</span><span style='color:#FFF'>nkpEn</span><span style='color:#0AA'>│
    1854. 

  1854.  ├─────┴─────┼─────┤     │ ├─────┴─────┼─────┤     │ ├─────┴─────┼─────┤     │
    1855. 

  1855.  │</span><span style='color:#FFF'>0</span><span style='color:#0AA'>          │</span><span style='color:#FFF'>.</span><span style='color:#0AA'>    │     │ │</span><span style='color:#FFF'>Ins</span><span style='color:#0AA'>        │</span><span style='color:#FFF'>Del</span><span style='color:#0AA'>  │     │ │</span><span style='color:#FFF'>nkp0</span><span style='color:#0AA'>       │</span><span style='color:#FFF'>nkp.</span><span style='color:#0AA'> │     │
    1856. 

  1856.  ╰───────────┴─────┴─────╯ ╰───────────┴─────┴─────╯ ╰───────────┴─────┴─────╯
    1857. 

  1857. </span><span style='color:#AAA'>
    1858. 

  1858. With keypad mode disabled numlock on will give you configuration A, and numlock
    1859. 

  1859. off will give you configuration B. With keypad mode enabled you'll get
    1860. 

  1860. configuration C.
    1861. 

  1861. 

  1862. </span><span style='color:#FFF'>Terminals that support keypad mode
    1863. 

  1863. </span><span style='color:#AAA'>Linux Console, PuTTY, Eterm, aterm.
    1864. 

  1864. 

  1865. </span><span style='color:#FFF'>Terminals that do not support keypad mode
    1866. 

  1866. 

  1867. </span><span style='color:#AAA'>RXVT on Cygwin, Windows Console, Gnome Terminal, Konsole.
    1868. 

  1868. 

  1869. </span><span style='color:#FFF'>Peculiar Terminals
    1870. 

  1870. 

  1871. </span><span style='color:#AAA'>RXVT requires turning off numlock to enable configuration C.
    1872. 

  1872. 

  1873. Xterm may require disabling Alt/NumLock Modifiers (num-lock) in the ctrl-left
    1874. 

  1874. click menu. Or edit ~/.Xresources and add XTerm*VT100.numLock:false
    1875. 

  1875. 

  1876. Mac OS X Terminal requires enabling 'strict vt100 keypad behavior' in
    1877. 

  1877. Terminal -&gt; Window Settings -&gt; Emulation.
    1878. 

  1878. 

  1879. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#COLORS'>colors</a>, <a href='#COORDINATES'>coordinates</a>, <a href='#ESCAPE'>escape</a>, <a href='#MATHEMATICS'>mathematics</a> and <a href='#PCRE'>pcre</a>.
    1880. 

  1880. <a name='KILL'></a>
    1881. 

  1881. 

  1882. </span><span style='color:#5F5'>         KILL
    1883. 

  1883. 

  1884. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #kill </span><span style='color:#FFF'>{</span><span style='color:#AAA'>list</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>pattern</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1885. 

  1885. 

  1886.          Without an argument, the kill command clears all lists.  Useful if
    1887. 

  1887.          you don't want to exit tintin to reload your command files.
    1888. 

  1888. 

  1889.          With one argument a specific list can be cleared.
    1890. 

  1890. 

  1891.          With two arguments the triggers in the chosen list that match the
    1892. 

  1892.          given pattern will be removed.
    1893. 

  1893. 

  1894. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #kill alias %*test*
    1895. 

  1895. 

  1896. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a>, <a href='#DEBUG'>debug</a>, <a href='#IGNORE'>ignore</a>, <a href='#INFO'>info</a> and <a href='#MESSAGE'>message</a>.
    1897. 

  1897. <a name='LINE'></a>
    1898. 

  1898. 

  1899. </span><span style='color:#5F5'>         LINE
    1900. 

  1900. 

  1901. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #line </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1902. 

  1902. 

  1903.          </span><span style='color:#5F5'>Line options that alter the argument.
    1904. 

  1904. 

  1905.          </span><span style='color:#FFF'>#line strip &lt;argument&gt;
    1906. 

  1906.          </span><span style='color:#AAA'>  Argument is executed with all color codes stripped.
    1907. 

  1907. 

  1908.          </span><span style='color:#FFF'>#line substitute &lt;options&gt; &lt;argument&gt;
    1909. 

  1909.          </span><span style='color:#AAA'>  Argument is executed using the provided substitutions, available
    1910. 

  1910.            options are: arguments, braces, colors, escapes, functions, secure,
    1911. 

  1911.            and variables.
    1912. 

  1912. 

  1913.          </span><span style='color:#5F5'>Line options that alter how the line is executed.
    1914. 

  1914. 

  1915.          </span><span style='color:#FFF'>#line background &lt;argument&gt;
    1916. 

  1916.          </span><span style='color:#AAA'>  Prevent new session activation.
    1917. 

  1917. 

  1918.          </span><span style='color:#FFF'>#line capture &lt;variable&gt; &lt;argument.
    1919. 

  1919.          </span><span style='color:#AAA'>  Argument is executed and output stored in &lt;variable&gt;.
    1920. 

  1920. 

  1921.          </span><span style='color:#FFF'>#line convert &lt;argument&gt;
    1922. 

  1922.          </span><span style='color:#AAA'>  Argument is executed with escaped meta characters.
    1923. 

  1923. 

  1924.          </span><span style='color:#FFF'>#line debug &lt;argument&gt;
    1925. 

  1925.          </span><span style='color:#AAA'>  Argument is executed in debug mode.
    1926. 

  1926. 

  1927.          </span><span style='color:#FFF'>#line gag
    1928. 

  1928.          </span><span style='color:#AAA'>  Gag the next line.
    1929. 

  1929. 

  1930.          </span><span style='color:#FFF'>#line ignore {argument}
    1931. 

  1931.          </span><span style='color:#AAA'>  Argument is executed without any triggers being checked.
    1932. 

  1932. 

  1933.          </span><span style='color:#FFF'>#line local {argument}
    1934. 

  1934.          </span><span style='color:#AAA'>  Argument is executed with all newly and indirectly
    1935. 

  1935.            created variables being local.
    1936. 

  1936. 

  1937.          </span><span style='color:#FFF'>#line log &lt;filename&gt; [text]
    1938. 

  1938.          </span><span style='color:#AAA'>  Log the next line to file unless the [text] argument is
    1939. 

  1939.            provided.
    1940. 

  1940. 

  1941.          </span><span style='color:#FFF'>#line logmode &lt;option&gt; &lt;argument&gt;
    1942. 

  1942.          </span><span style='color:#AAA'>  Argument is executed using the provided logmode, available
    1943. 

  1943.            modes are: html, plain, and raw.
    1944. 

  1944. 

  1945.          </span><span style='color:#FFF'>#line msdp &lt;argument&gt;
    1946. 

  1946.          </span><span style='color:#AAA'>  Turn the argument into an msdp telnet sequence, starting at the
    1947. 

  1947.            first opening brace. Will turn tintin tables into msdp tables,
    1948. 

  1948.            with semicolons being used to create msdp arrays.
    1949. 

  1949. 

  1950.          </span><span style='color:#FFF'>#line multishot &lt;number&gt; &lt;argument&gt;
    1951. 

  1951.          </span><span style='color:#AAA'>  Argument is executed in multishot mode, all triggers created
    1952. 

  1952.            will only fire the given number of times.
    1953. 

  1953. 

  1954.          </span><span style='color:#FFF'>#line oneshot &lt;argument&gt;
    1955. 

  1955.          </span><span style='color:#AAA'>  Argument is executed in oneshot mode, all triggers created will
    1956. 

  1956.            only fire once.
    1957. 

  1957. 

  1958.          </span><span style='color:#FFF'>#line quiet &lt;argument&gt;
    1959. 

  1959.          </span><span style='color:#AAA'>  Argument is executed with suppression of most system messages.
    1960. 

  1960. 

  1961.          </span><span style='color:#FFF'>#line verbatim &lt;argument&gt;
    1962. 

  1962.          </span><span style='color:#AAA'>  Argument is executed verbatim, prohibiting variable and function
    1963. 

  1963.            substitutions.
    1964. 

  1964. 

  1965.          </span><span style='color:#FFF'>#line verbose &lt;argument&gt;
    1966. 

  1966.          </span><span style='color:#AAA'>  Argument is executed with most system messages enabled.
    1967. 

  1967. 

  1968.          When using #line log and logging in html format use &bsol;c&lt; &bsol;c&gt; &bsol;c&amp; &bsol;c&quot; to
    1969. 

  1969.          log a literal &lt; &gt; &amp; and &quot;.
    1970. 

  1970. 

  1971. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a> and <a href='#CONFIG'>config</a>.
    1972. 

  1972. <a name='LIST'></a>
    1973. 

  1973. 

  1974. </span><span style='color:#5F5'>         LIST
    1975. 

  1975. 

  1976. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #list </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    1977. 

  1977. 

  1978.          #list {var} {add} {item}               Add {item} to the list
    1979. 

  1979.          #list {var} {clear}                    Empty the given list
    1980. 

  1980.          #list {var} {collapse}                 Turn list into a variable
    1981. 

  1981.          #list {var} {create} {item}            Create a list using {items}
    1982. 

  1982.          #list {var} {delete} {index} {number}  Delete the item at {index},
    1983. 

  1983.                                                 the {number} is optional.
    1984. 

  1984.          #list {var} {explode}                  Turn list into a character list
    1985. 

  1985.          #list {var} {indexate}                 Index a list table for sorting
    1986. 

  1986.          #list {var} {insert} {index} {string}  Insert {string} at given index
    1987. 

  1987.          #list {var} {filter} {keep} {remove}   Filter with keep / remove regex
    1988. 

  1988.          #list {var} {find} {regex} {variable}  Return the found index
    1989. 

  1989.          #list {var} {get} {index} {variable}   Copy an item to {variable}
    1990. 

  1990.          #list {var} {order} {string}           Insert item in numerical order
    1991. 

  1991.          #list {var} {shuffle}                  Shuffle the list
    1992. 

  1992.          #list {var} {set} {index} {string}     Change the item at {index}
    1993. 

  1993.          #list {var} {simplify} {string}        Turn list into a simple list
    1994. 

  1994.          #list {var} {size} {variable}          Copy list size to {variable}
    1995. 

  1995.          #list {var} {sort} {string}            Insert item in alphabetic order
    1996. 

  1996.          #list {var} {tokenize} {string}        Create a character list
    1997. 

  1997. 

  1998.          The index should be between 1 and the list's length. You can also give
    1999. 

  1999.          a negative value, in which case -1 equals the last item in the list, -2
    2000. 

  2000.          the second last, etc.
    2001. 

  2001. 

  2002.          When inserting an item a positive index will prepend the item at the
    2003. 

  2003.          given index, while a negative index will append the item.
    2004. 

  2004. 

  2005.          The add and create options allow using multiple items, as well
    2006. 

  2006.          as semicolon separated items.
    2007. 

  2007. 

  2008.          A length of 0 is returned for an empty or non existant list.
    2009. 

  2009. 

  2010.          You can directly access elements in a list variable using &dollar;var[1],
    2011. 

  2011.          &dollar;var[2], &dollar;var[-1], etc.
    2012. 

  2012. 

  2013. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#FOREACH'>foreach</a>, <a href='#LOOP'>loop</a>, <a href='#PARSE'>parse</a>, <a href='#REPEAT'>repeat</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    2014. 

  2014. <a name='LISTS'></a>
    2015. 

  2015. 

  2016. </span><span style='color:#5F5'>         LISTS
    2017. 

  2017. 

  2018. </span><span style='color:#AAA'>         There are several different types of lists in tintin which behave in a
    2019. 

  2019.          fairly universal manner. To properly explain lists it's easiest to
    2020. 

  2020.          explain the most basic variable type first before discussing more
    2021. 

  2021.          complex types.
    2022. 

  2022. 

  2023.        - Basic variable: The standard key = value variable.
    2024. 

  2024. 

  2025.        - Simple list: A string that contains semicolon delimited fields.
    2026. 

  2026.          {a;b;c}. Can be saved as a variable.
    2027. 

  2027. 

  2028.        - Brace list: A string in which fields are delimited with braces.
    2029. 

  2029.          {a}{b}{c}. Brace lists cannot be stored as a variable because tables
    2030. 

  2030.          use braces as well, they must be stored as a simple list instead.
    2031. 

  2031. 

  2032.        - Table: Think of this as variables nested within another variable. Or
    2033. 

  2033.           as variables contained within another variable.
    2034. 

  2034. 

  2035.        - List: A table that uses integers for its indexes. Also known as an
    2036. 

  2036.          array. The #list command is a utility command for using tables as
    2037. 

  2037.          arrays.
    2038. 

  2038. </span><span style='color:#5F5'>
    2039. 

  2039.          Simple Variables
    2040. 

  2040. </span><span style='color:#AAA'>
    2041. 

  2041. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
    2042. 

  2042.          #variable {simple} {Hello World!}
    2043. 

  2043.          #show &dollar;simple
    2044. 

  2044. 

  2045.          To see if the 'simple' variable exists you can use &amp;simple which will
    2046. 

  2046.          display 0 if the variable does not exist, or the variable's index if
    2047. 

  2047.          it exists.
    2048. 

  2048. 

  2049.          If you have multiple variables they are sorted alphabetically and
    2050. 

  2050.          numerically. While it's not all that relevant for simple variables,
    2051. 

  2051.          the first variable has index 1, the second variable index 2, and so
    2052. 

  2052.          on.
    2053. 

  2053. 

  2054.          Variable names need to start with a letter and only exist of letters,
    2055. 

  2055.          numbers, and underscores. If you need to use a non standard variable
    2056. 

  2056.          name this is possible using braces.
    2057. 

  2057. 

  2058. </span><span style='color:#FFF'>Example: </span><span style='color:#AAA'>#variable {:)} {Happy Happy!};#show &dollar;{:)}
    2059. 

  2059. 

  2060.          Variables can be accessed using their index. While primarily useful
    2061. 

  2061.          for tables it is possible to do this for simple variables. Use +1 for
    2062. 

  2062.          the first variable, +2 for the second variable, etc. Use -1 for the
    2063. 

  2063.          last variable, -2 for the second last variable, etc.
    2064. 

  2064. 

  2065. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #show The first variable is: &dollar;{+1}
    2066. 

  2066. </span><span style='color:#5F5'>
    2067. 

  2067.          Removing Variables
    2068. 

  2068. </span><span style='color:#AAA'>
    2069. 

  2069.          To remove a variable, use #unvariable or #unvar (every command can be
    2070. 

  2070.          abbreviated). It's possible to remove multiple variables at once
    2071. 

  2071.          using #unvar {var 1} {var 2} {etc}
    2072. 

  2072. 

  2073.          Variables are unique to each session, so if you have multiple
    2074. 

  2074.          sessions, removing a variable from one session won't remove it from
    2075. 

  2075.          other sessions.
    2076. 

  2076. 

  2077.          If you remove a table variable, all variables contained within that
    2078. 

  2078.          table variable are removed as well.
    2079. 

  2079. </span><span style='color:#5F5'>
    2080. 

  2080.          Simple Lists
    2081. 

  2081. </span><span style='color:#AAA'>
    2082. 

  2082.          A simple list is a string that contains semicolon delimited fields.
    2083. 

  2083.          Commands can be entered as simple lists, for example:
    2084. 

  2084.          #show {a};#show {b} will execute a single line as two commands.
    2085. 

  2085. 

  2086.          Several commands take a simple list as their input, these are:
    2087. 

  2087.          #foreach, #line substitute, #path load, #list create, and #highlight.
    2088. 

  2088. </span><span style='color:#5F5'>
    2089. 

  2089.          Brace Lists
    2090. 

  2090. </span><span style='color:#AAA'>
    2091. 

  2091.          A brace list is a string in which fields are delimited with braces.
    2092. 

  2092.          Most commands take a brace list for their arguments, for example:
    2093. 

  2093.          #session {x} {mud.com} {1234} {mud.tin}. The session command takes
    2094. 

  2094.          4 arguments, the 4th argument (command file) is optional.
    2095. 

  2095. 

  2096.          Commands that take a simple list as their input will also accept a
    2097. 

  2097.          brace list, keep in mind you'll have to embed the brace list in an
    2098. 

  2098.          extra set of braces, for example: #path load {{n}{s}{w}{w}}, which is
    2099. 

  2099.          identical to: #path load {n;s;w;w}.
    2100. 

  2100. 

  2101.          Brace lists cannot be stored as variables because TinTin++ will
    2102. 

  2102.          confuse them with tables. You can convert a brace list to a table
    2103. 

  2103.          variable using: #list {bracelist} {create} {{a}{b}{c}} this will look
    2104. 

  2104.          internally as: {{1}{a}{2}{b}{3}{c}}. You can then convert this table
    2105. 

  2105.          to a simple list using: #list {bracelist} {simplify} {simplelist}
    2106. 

  2106.          which will store {a;b;c} in the &dollar;simplelist variable.
    2107. 

  2107. 

  2108.          Braces cannot easily be escaped in TinTin++. Using &bsol;{ or &bsol;} will not
    2109. 

  2109.          work. The reason for this is due to several factors, but primarily
    2110. 

  2110.          backward compatibility. To escape braces you must define them using
    2111. 

  2111.          hexadecimal notation using &bsol;x7B and &bsol;x7D. See #help escape for a list
    2112. 

  2112.          of escape options, and the help file will also remind you of how to
    2113. 

  2113.          escape braces.
    2114. 

  2114. </span><span style='color:#5F5'>
    2115. 

  2115.          Tables
    2116. 

  2116. </span><span style='color:#AAA'>
    2117. 

  2117.          Tables are key/value pairs stored within a variable. Tables are also
    2118. 

  2118.          known as associative arrays, dictionaries, maps, nested variables,
    2119. 

  2119.          structures, and probably a couple of other names. There are several
    2120. 

  2120.          ways to create and access tables.
    2121. 

  2121. 

  2122. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #variable {friendlist} {{bob}{bob@mail.com} {bubba}{sunset@gmail.com}}
    2123. 

  2123. 

  2124.          This will create a friendlist with two entries, the key is the name of
    2125. 

  2125.          the friend, the value is the email address of the friend. You can see
    2126. 

  2126.          the email address of bob using: #show {&dollar;friendlist[bob]}. You can
    2127. 

  2127.          also define this table as following:
    2128. 

  2128. 

  2129. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
    2130. 

  2130.          #variable {friendlist[bob]} {bob@mail.com}
    2131. 

  2131.          #variable {friendlist[bubba]} {sunset@gmail.com}
    2132. 

  2132. 

  2133.          This would create the exact same table as the single line declaration
    2134. 

  2134.          used previously. To see the first key in the table use:
    2135. 

  2135.          *friendlist[+1], to see the first value in the table use:
    2136. 

  2136.          &dollar;friendlist[+1]. To see the size of the table use &amp;friendlist[]. To
    2137. 

  2137.          print a bracelist of all friends use *friendlist[%*], to print a
    2138. 

  2138.          bracelist of all friends whose name starts with the letter 'a' you
    2139. 

  2139.          would use: *friendlist[a%*]. Similarly to see the number of friends
    2140. 

  2140.          you have whose name ends with the letter 'b' you would use:
    2141. 

  2141.          &amp;friendlist[%*b].
    2142. 

  2142. 

  2143.          See #help regexp for a brief overview of regular expression options.
    2144. 

  2144.          While TinTin++ supports PCRE (perl-compatible regular expressions), it
    2145. 

  2145.          embeds them within its own regular expression syntax that is simpler
    2146. 

  2146.          and less invasive, while still allowing the full power of PCRE for
    2147. 

  2147.          those who need it.
    2148. 

  2148. 

  2149. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #unvariable {friendlist[bubba]}
    2150. 

  2150. 

  2151.          This would remove {bubba} from the friendlist. To remove the entire
    2152. 

  2152.          friendlist you would use: #unvariable {friendlist}.
    2153. 

  2153. 

  2154. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #variable {friendlist} {{bob} {{email}{bob@ma.il} {phone}{123456789}}}
    2155. 

  2155. 

  2156.          There is no limit to the number of nests, simply add more braces. To
    2157. 

  2157.          see Bob's email in this example you would use:
    2158. 

  2158.          #show {&dollar;friendlist[bob][email]}.
    2159. 

  2159. 

  2160.          Lists
    2161. 

  2161. 

  2162.          Tables are sorted alphabetically with the exception of numbers which
    2163. 

  2163.          are sorted numerically. If you want to determine the sorting order
    2164. 

  2164.          yourself you can use use the #list command which helps you to use
    2165. 

  2165.          tables as arrays.
    2166. 

  2166. 

  2167. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #action {%1 chats %2} {#list chats add {%0}}
    2168. 

  2168. 

  2169.          Each time a chat is received it's added to the end of the 'chats' list
    2170. 

  2170.          variable. If you type #variable chats this might look like:
    2171. 

  2171. 

  2172.          </span><span style='color:#FF5'>#</span><span style='color:#5FF'>VARIABLE </span><span style='color:#A0A'>{</span><span style='color:#FFF'>chats</span><span style='color:#A0A'>}
    2173. 

  2173.          {
    2174. 

  2174.                  {</span><span style='color:#FFF'>1</span><span style='color:#A0A'>} {</span><span style='color:#FFF'>Bubba chats Hi</span><span style='color:#A0A'>}
    2175. 

  2175.                  {</span><span style='color:#FFF'>2</span><span style='color:#A0A'>} {</span><span style='color:#FFF'>Bob chats Hi bub</span><span style='color:#A0A'>}
    2176. 

  2176.                  {</span><span style='color:#FFF'>3</span><span style='color:#A0A'>} {</span><span style='color:#FFF'>Bubba chats Bye</span><span style='color:#A0A'>}
    2177. 

  2177.                  {</span><span style='color:#FFF'>4</span><span style='color:#A0A'>} {</span><span style='color:#FFF'>Bob chats bub bye</span><span style='color:#A0A'>}
    2178. 

  2178.          }
    2179. 

  2179. </span><span style='color:#5F5'>
    2180. 

  2180.          Parsing
    2181. 

  2181. </span><span style='color:#AAA'>
    2182. 

  2182.          There are various ways to parse lists and tables, using either #loop,
    2183. 

  2183.          #foreach, #while, or #&lt;number&gt;.
    2184. 

  2184. 

  2185.          #loop takes two numeric arguments, incrementing or decrementing the
    2186. 

  2186.          first number until it matches the second number. The value of the loop
    2187. 

  2187.          counter is stored in the provided variable.
    2188. 

  2188. 

  2189.          #foreach takes either a simple list or a brace list as its first
    2190. 

  2190.          argument. Foreach will go through each item in the list and store the
    2191. 

  2191.          value in the provided variable.
    2192. 

  2192. 

  2193.          #while will perform an if check on the first argument, if the result
    2194. 

  2194.          is true it will execute the commands in the second argument. Then it
    2195. 

  2195.          performs an if check on the first argument again. It will continue to
    2196. 

  2196.          repeat until the if check returns 0 or the loop is interrupted with a
    2197. 

  2197.          control flow command. It takes special care to avoid infinite loops.
    2198. 

  2198. 

  2199.          #&lt;number&gt; will execute the provided argument 'number' times. For
    2200. 

  2200.          example: #4 {#show beep! &bsol;a}
    2201. 

  2201. 

  2202.          Here are some examples.
    2203. 

  2203. 

  2204. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #list friends create {bob;bubba;zorro}
    2205. 

  2205. 

  2206.          Internally this looks like {{1}{bob}{2}{bubba}{3}{zorro}} and the
    2207. 

  2207.          list can be parsed in various ways.
    2208. 

  2208. 

  2209. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #foreach {&dollar;friends[%*]} {name} {#show &dollar;name}
    2210. 

  2210. 

  2211. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #foreach {*friends[%*]} {i} {#show &dollar;friends[&dollar;i]}
    2212. 

  2212. 

  2213. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #loop {1} {&amp;friends[]} {i} {#show &dollar;friends[+&dollar;i]}
    2214. 

  2214. 

  2215. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #math i 1;#while {&amp;friends[+&dollar;i]} {#show &dollar;friends[+&dollar;i];
    2216. 

  2216.          #math i &dollar;i + 1}
    2217. 

  2217. 

  2218. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #math i 1;#&amp;friends[] {#show &dollar;friends[+&dollar;i];#math i &dollar;i + 1}
    2219. 

  2219. 

  2220.          Each of the five examples above performs the same task; printing the
    2221. 

  2221.          three names in the friends list.
    2222. 

  2222. 

  2223.          If you want to get a better look at what goes on behind the scenes
    2224. 

  2224.          while executing scripts you can use '#debug all on'. To stop seeing
    2225. 

  2225.          debug information use '#debug all off'.
    2226. 

  2226. </span><span style='color:#5F5'>
    2227. 

  2227.          Optimization
    2228. 

  2228. </span><span style='color:#AAA'>
    2229. 

  2229.          TinTin++ tables are exceptionally fast while they remain under 100
    2230. 

  2230.          items. Once a table grows beyond 10000 items there can be performance
    2231. 

  2231.          issues when inserting and removing items in the beginning or middle of
    2232. 

  2232.          the table.
    2233. 

  2233. 

  2234.          The plan is to eventually implement an indexable and flexible data
    2235. 

  2235.          structure for large tables.
    2236. 

  2236. 

  2237.          If you load a large table from file it's important to make sure it's
    2238. 

  2238.          sorted, when using #write to save a table it's automatically sorted.
    2239. 

  2239. 

  2240.          If you notice performance issues on large tables it's relatively easy
    2241. 

  2241.          to create a hash table.
    2242. 

  2242. 

  2243. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
    2244. 

  2244. 

  2245.          #alias {sethash}
    2246. 

  2246.          {
    2247. 

  2247.          	#format hash %H %1;
    2248. 

  2248.          	#math hash1 &dollar;hash % 100;
    2249. 

  2249.          	#math hash2 &dollar;hash / 100 % 100;
    2250. 

  2250.          	#var hashtable[&dollar;hash1][&dollar;hash2][%1] %2
    2251. 

  2251.          }
    2252. 

  2252. 

  2253.          #function {gethash}
    2254. 

  2254.          {
    2255. 

  2255.          	#format hash %H %1;
    2256. 

  2256.          	#math hash1 &dollar;hash % 100;
    2257. 

  2257.          	#math hash2 &dollar;hash / 100 % 100;
    2258. 

  2258.          	#return &dollar;hashtable[&dollar;hash1][&dollar;hash2][%1]
    2259. 

  2259.          }
    2260. 

  2260. 

  2261.          #alias {test}
    2262. 

  2262.          {
    2263. 

  2263.          	sethash bli hey;
    2264. 

  2264.          	sethash bla hi;
    2265. 

  2265.          	sethash blo hello;
    2266. 

  2266.          	#show The value of bla is: @gethash{bla}
    2267. 

  2267.          }
    2268. 

  2268. 

  2269.          The above script will rapidly store and retrieve over 1 million items.
    2270. 

  2270.          Looping through a hash table is relatively easy as well.
    2271. 

  2271. 

  2272. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
    2273. 

  2273. 

  2274.          #alias {showhash}
    2275. 

  2275.          {
    2276. 

  2276.          	#foreach {*hashtable[%*]} {hash1}
    2277. 

  2277.          	{
    2278. 

  2278.          		#foreach {*hashtable[&dollar;hash1][%*]} {hash2}
    2279. 

  2279.          		{
    2280. 

  2280.          			#echo {%-20s = %s}
    2281. 

  2281.                                         {hashtable[&dollar;hash1][&dollar;hash2]}
    2282. 

  2282.                                         {&dollar;hashtable[&dollar;hash1][&dollar;hash2]}
    2283. 

  2283.          		}
    2284. 

  2284.          	}
    2285. 

  2285.         }
    2286. 

  2286. 

  2287. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#FOREACH'>foreach</a>, <a href='#LOOP'>loop</a>, <a href='#PARSE'>parse</a>, <a href='#REPEAT'>repeat</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    2288. 

  2288. <a name='LOCAL'></a>
    2289. 

  2289. 

  2290. </span><span style='color:#5F5'>         LOCAL
    2291. 

  2291. 

  2292. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #local </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>text to fill variable</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    2293. 

  2293. 

  2294.          The local command sets a local variable. Unlike a regular variable
    2295. 

  2295.          a local variable will only stay in memory for the duration of the
    2296. 

  2296.          event that created it. They are accessed in the same way as a
    2297. 

  2297.          regular variable.
    2298. 

  2298. 

  2299.          Commands that store information to a variable will use a local variable
    2300. 

  2300.          if it exists.
    2301. 

  2301. 

  2302.          Avoid setting the result variable as local in a function.
    2303. 

  2303. 

  2304. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {swap} {#local x %0;#replace x {e} {u};#show &dollar;x}
    2305. 

  2305. 

  2306. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a local variable with the #unlocal command.
    2307. 

  2307. 

  2308. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#FORMAT'>format</a>, <a href='#FUNCTION'>function</a>, <a href='#MATH'>math</a>, <a href='#REPLACE'>replace</a>, <a href='#SCRIPT'>script</a> and <a href='#VARIABLE'>variable</a>.
    2309. 

  2309. <a name='LOG'></a>
    2310. 

  2310. 

  2311. </span><span style='color:#5F5'>         LOG
    2312. 

  2312. 

  2313. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #log </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    2314. 

  2314. 

  2315.          The log command allows logging session output to file. You can set the
    2316. 

  2316.          data type to either plain, raw, or html with the config command.
    2317. 

  2317. 

  2318.          </span><span style='color:#FFF'>#log append &lt;filename&gt;
    2319. 

  2319.          </span><span style='color:#AAA'>  Start logging to the given file, if the file already exists it won't
    2320. 

  2320.            be overwritten and data will be appended to the end.
    2321. 

  2321. 

  2322.          </span><span style='color:#FFF'>#log move &lt;filename_1&gt; &lt;filename_2&gt;
    2323. 

  2323.          </span><span style='color:#AAA'>  Move filename_1 to filename_2. This can be any file and doesn't need
    2324. 

  2324.            to be a log file.
    2325. 

  2325. 

  2326.          </span><span style='color:#FFF'>#log overwrite &lt;filename&gt;
    2327. 

  2327.          </span><span style='color:#AAA'>  Start logging to the given file, if the file already exists it will
    2328. 

  2328.            be overwritten.
    2329. 

  2329. 

  2330.          </span><span style='color:#FFF'>#log off
    2331. 

  2331.          </span><span style='color:#AAA'>  Stop logging.
    2332. 

  2332. 

  2333.          </span><span style='color:#FFF'>#log remove &lt;filename&gt;
    2334. 

  2334.          </span><span style='color:#AAA'>  Remove the file. This can be any file and doesn't need to be a log
    2335. 

  2335.            file.
    2336. 

  2336. 

  2337.          </span><span style='color:#FFF'>#log timestamp &lt;format&gt;
    2338. 

  2338.          </span><span style='color:#AAA'>  When set the timestamp will be prepended to each line logged to file.
    2339. 

  2339.            The format will be formatted as a date using the strftime format
    2340. 

  2340.            specifiers as described in #help time.
    2341. 

  2341. 

  2342. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#READ'>read</a>, <a href='#SCAN'>scan</a>, <a href='#TEXTIN'>textin</a>, <a href='#TIME'>time</a> and <a href='#WRITE'>write</a>.
    2343. 

  2343. <a name='LOOP'></a>
    2344. 

  2344. 

  2345. </span><span style='color:#5F5'>         LOOP
    2346. 

  2346. 

  2347. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #loop </span><span style='color:#FFF'>{</span><span style='color:#AAA'>&lt;start&gt;</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>&lt;finish&gt;</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>&lt;variable&gt;</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    2348. 

  2348. 

  2349.          Like a for statement, loop will loop from start to finish incrementing
    2350. 

  2350.          or decrementing by 1 each time through.  The value of the loop counter
    2351. 

  2351.          is stored in the provided variable, which you can use in the commands.
    2352. 

  2352. 

  2353. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop 1 3 loop {get all &dollar;loop.corpse}
    2354. 

  2354.          This equals 'get all 1.corpse;get all 2.corpse;get all 3.corpse'.
    2355. 

  2355. 

  2356. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop 3 1 cnt {drop &dollar;cnt&bsol;.key}
    2357. 

  2357.          This equals 'drop 3.key;drop 2.key;drop 1.key'.
    2358. 

  2358. 

  2359. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#FOREACH'>foreach</a>, <a href='#LIST'>list</a>, <a href='#PARSE'>parse</a>, <a href='#REPEAT'>repeat</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    2360. 

  2360. <a name='MACRO'></a>
    2361. 

  2361. 

  2362. </span><span style='color:#5F5'>         MACRO
    2363. 

  2363. 

  2364. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #macro </span><span style='color:#FFF'>{</span><span style='color:#AAA'>key sequence</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    2365. 

  2365. 

  2366.          Macros allow you to make tintin respond to function keys.
    2367. 

  2367. 

  2368.          The key sequence send to the terminal when pressing a function key
    2369. 

  2369.          differs for every OS and terminal. To find out what sequence is send
    2370. 

  2370.          you can enable the CONVERT META config option.
    2371. 

  2371. 

  2372.          Another option is pressing ctrl-v, which will enable CONVERT META for
    2373. 

  2373.          the next key pressed.
    2374. 

  2374. 

  2375.          If you only want a key sequence to trigger at the start of an input
    2376. 

  2376.          line prefix the key sequence with ^.
    2377. 

  2377. 

  2378. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {(press ctrl-v)(press F1)} {#show &bsol;e[2J;#buffer lock}
    2379. 

  2379.          Clear the screen and lock the window when you press F1, useful when the
    2380. 

  2380.          boss is near.
    2381. 

  2381. 

  2382. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {&bsol;eOM} {#cursor enter}
    2383. 

  2383.          Makes the keypad's enter key work as an enter in keypad mode.
    2384. 

  2384. 

  2385. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {^nn} {n}
    2386. 

  2386.          Makes pressing n twice on an empty line execute north.
    2387. 

  2387. 

  2388. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: Not all terminals properly initialize the keypad key sequences.
    2389. 

  2389.          If this is the case you can still use the keypad, but instead of the
    2390. 

  2390.          arrow keys use ctrl b, f, p, and n.
    2391. 

  2391. 

  2392. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a macro with the #unmacro command.
    2393. 

  2393. 

  2394. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALIAS'>alias</a>, <a href='#CURSOR'>cursor</a>, <a href='#HISTORY'>history</a>, <a href='#KEYPAD'>keypad</a>, <a href='#SPEEDWALK'>speedwalk</a> and <a href='#TAB'>tab</a>.
    2395. 

  2395. <a name='MAP'></a>
    2396. 

  2396. 

  2397. </span><span style='color:#5F5'>         MAP
    2398. 

  2398. 

  2399. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #map
    2400. 

  2400. 

  2401.          The map command is the backbone of the auto mapping feature.
    2402. 

  2402. 

  2403.          </span><span style='color:#FFF'>#map at &lt;exit|vnum&gt; &lt;command&gt;
    2404. 

  2404.          </span><span style='color:#AAA'>  Execute the command at the given exit or vnum.
    2405. 

  2405. 

  2406.          </span><span style='color:#FFF'>#map center &lt;x&gt; &lt;y&gt; &lt;z&gt;
    2407. 

  2407.          </span><span style='color:#AAA'>  Sets displaying center of the map viewer, default is 0 0 0.
    2408. 

  2408. 

  2409.          </span><span style='color:#FFF'>#map color &lt;field&gt; [value]
    2410. 

  2410.          </span><span style='color:#AAA'>  Sets the map color for the given color field. Use #map color reset
    2411. 

  2411.            to restore colors to default.
    2412. 

  2412. 

  2413.          </span><span style='color:#FFF'>#map create &lt;size&gt;
    2414. 

  2414.          </span><span style='color:#AAA'>  Creates a new map and room 1. The default size is 50000 rooms.
    2415. 

  2415. 

  2416.          </span><span style='color:#FFF'>#map destroy {area|world} &lt;name&gt;
    2417. 

  2417.          </span><span style='color:#AAA'>  Deletes the map or given area.
    2418. 

  2418. 

  2419.          </span><span style='color:#FFF'>#map delete &lt;exit|vnum&gt;
    2420. 

  2420.          </span><span style='color:#AAA'>  Deletes the room for the given exit or vnum.
    2421. 

  2421. 

  2422.          </span><span style='color:#FFF'>#map dig &lt;exit|vnum&gt; [new|&lt;vnum&gt;]
    2423. 

  2423.          </span><span style='color:#AAA'>  Creates an exit for the given exit name. If no valid exit name
    2424. 

  2424.            is given or no existing room is found a new room is created.
    2425. 

  2425.            Useful for portal links and other alternative forms of
    2426. 

  2426.            transportation. If the 'new' argument is provided all existing
    2427. 

  2427.            rooms are ignored and a new room is created. If a room vnum is
    2428. 

  2428.            given as the second argument an exit will be created leading
    2429. 

  2429.            to the given room vnum. If the room vnum doesn't exist a new
    2430. 

  2430.            room is created.
    2431. 

  2431. 

  2432.          </span><span style='color:#FFF'>#map entrance &lt;exit&gt; [option] [arg]
    2433. 

  2433.          </span><span style='color:#AAA'>  Set the entrance data for the given exit. You must specify a
    2434. 

  2434.            valid two-way exit for this to work.
    2435. 

  2435. 

  2436.          </span><span style='color:#FFF'>#map exit &lt;exit&gt; &lt;option&gt; &lt;arg&gt;
    2437. 

  2437.          </span><span style='color:#AAA'>  Set the exit data. Useful with a closed door where you can
    2438. 

  2438.            set the exit command: '#map exit e command {open east;e}'.
    2439. 

  2439.            Use #map exit &lt;exit&gt; for a list of available options.
    2440. 

  2440.            Use #map exit &lt;eixt&gt; save to save the exit data.
    2441. 

  2441. 

  2442.          </span><span style='color:#FFF'>#map exitflag &lt;exit&gt; &lt;AVOID|BLOCK|HIDE|INVIS&gt; [on|off]
    2443. 

  2443.          </span><span style='color:#AAA'>  Set exit flags. See #map roomflag for more info.
    2444. 

  2444. 

  2445.          </span><span style='color:#FFF'>#map explore &lt;exit&gt;
    2446. 

  2446.          </span><span style='color:#AAA'>  Explores the given exit until a dead end or an
    2447. 

  2447.            intersection is found. The route is stored in #path and can
    2448. 

  2448.            subsequently be used with #walk. Useful for long roads.
    2449. 

  2449. 

  2450.          </span><span style='color:#FFF'>#map find &lt;name&gt; &lt;exits&gt; &lt;desc&gt; &lt;area&gt; &lt;note&gt; &lt;terrain&gt; &lt;flag&gt;
    2451. 

  2451.          </span><span style='color:#AAA'>  searches for the given room name. If found the shortest path
    2452. 

  2452.            from your current location to the destination is calculated.
    2453. 

  2453.            The route is stored in #path and can subsequently be used with
    2454. 

  2454.            the various #path commands. If &lt;exits&gt; is provided all exits
    2455. 

  2455.            must be matched, if &lt;roomdesc&gt;, &lt;roomarea&gt; or &lt;roomnote&gt; or
    2456. 

  2456.            &lt;roomterrain&gt; or &lt;roomflag&gt; is provided these are matched as
    2457. 

  2457.            well against the room to be found.
    2458. 

  2458.            These options are also available to the at, delete, goto
    2459. 

  2459.            link, list and run commands.
    2460. 

  2460. 

  2461.          </span><span style='color:#FFF'>#map flag asciigraphics
    2462. 

  2462.          </span><span style='color:#AAA'>  Takes up more space but draws a more detailed
    2463. 

  2463.            map that displays the ne se sw nw exits and room symbols.
    2464. 

  2464. 

  2465.          </span><span style='color:#FFF'>#map flag asciivnums
    2466. 

  2466.          </span><span style='color:#AAA'>  Display room vnums if asciigraphics is enabled.
    2467. 

  2467. 

  2468.          </span><span style='color:#FFF'>#map flag nofollow
    2469. 

  2469.          </span><span style='color:#AAA'>  When you enter movement commands the map will no longer
    2470. 

  2470.            automatically follow along. Useful for MSDP and GMCP
    2471. 

  2471.            automapping scripts.
    2472. 

  2472. 

  2473.          </span><span style='color:#FFF'>#map flag static
    2474. 

  2474.          </span><span style='color:#AAA'>  Will make the map static so new rooms are no longer
    2475. 

  2475.            created when walking into an unmapped direction. Useful when
    2476. 

  2476.            you're done mapping and regularly bump into walls accidentally
    2477. 

  2477.            creating a new room. #map dig etc will still work.
    2478. 

  2478. 

  2479.          </span><span style='color:#FFF'>#map flag vtgraphics
    2480. 

  2480.          </span><span style='color:#AAA'>  Enables vt line drawing on some terminals
    2481. 

  2481. 

  2482.          </span><span style='color:#FFF'>#map flag vtmap
    2483. 

  2483.          </span><span style='color:#AAA'>  Will enable the vtmap which is shown in the top split
    2484. 

  2484.            screen if you have one. You can create a 16 rows high top
    2485. 

  2485.            screen by using '#split 16 1'.
    2486. 

  2486. 

  2487.          </span><span style='color:#FFF'>#map get &lt;option&gt; &lt;variable&gt; [vnum]
    2488. 

  2488.          </span><span style='color:#AAA'>  Store a map value into a variable, if no vnum is given the
    2489. 

  2489.            current room is used. Use 'all' as the option to store all
    2490. 

  2490.            values as a table.
    2491. 

  2491. 

  2492.          </span><span style='color:#FFF'>#map get roomexits &lt;variable&gt;
    2493. 

  2493.          </span><span style='color:#AAA'>  Store all room exits into variable.
    2494. 

  2494. 

  2495.          </span><span style='color:#FFF'>#map global &lt;room vnum&gt;
    2496. 

  2496.          </span><span style='color:#AAA'>  Set the vnum of a room that contains global
    2497. 

  2497.            exits, for example an exit named 'recall' that leads to the
    2498. 

  2498.            recall location. The room can contain multiple exits, in case
    2499. 

  2499.            there are multiple commands that are similar to recall.
    2500. 

  2500. 

  2501.          </span><span style='color:#FFF'>#map goto &lt;room vnum&gt; [dig]
    2502. 

  2502.          </span><span style='color:#AAA'>  Takes you to the given room vnum, with the
    2503. 

  2503.            dig argument a new room will be created if none exists.
    2504. 

  2504. 

  2505.          </span><span style='color:#FFF'>#map goto &lt;name&gt; &lt;exits&gt; &lt;desc&gt; &lt;area&gt; &lt;note&gt; &lt;terrain&gt;
    2506. 

  2506.          </span><span style='color:#AAA'>  Takes you to the given room name, if you provide exits those
    2507. 

  2507.            must match.
    2508. 

  2508. 

  2509.          </span><span style='color:#FFF'>#map info
    2510. 

  2510.          </span><span style='color:#AAA'>  Gives information about the map and room you are in.
    2511. 

  2511. 

  2512.          </span><span style='color:#FFF'>#map insert &lt;direction&gt; [roomflag]
    2513. 

  2513.          </span><span style='color:#AAA'>  Insert a room in the given direction. Most useful for inserting
    2514. 

  2514.            void rooms.
    2515. 

  2515. 

  2516.          </span><span style='color:#FFF'>#map jump &lt;x&gt; &lt;y&gt; &lt;z&gt;
    2517. 

  2517.          </span><span style='color:#AAA'>  Jump to the given coordinate, which is relative
    2518. 

  2518.            to your current room.
    2519. 

  2519. 

  2520.          </span><span style='color:#FFF'>#map landmark &lt;name&gt; &lt;vnum&gt; [description] [size]
    2521. 

  2521.          </span><span style='color:#AAA'>  Creates an alias to target the provided room vnum. The
    2522. 

  2522.            description is optional and should be brief. The size
    2523. 

  2523.            determines from how many rooms away the landmark can be
    2524. 

  2524.            seen.
    2525. 

  2525. 

  2526.          </span><span style='color:#FFF'>#map leave
    2527. 

  2527.          </span><span style='color:#AAA'>  Makes you leave the map. Useful when entering a maze. You
    2528. 

  2528.            can return to your last known room using #map return.
    2529. 

  2529. 

  2530.          </span><span style='color:#FFF'>#map legend &lt;legend&gt; [symbols|reset]
    2531. 

  2531.          #map legend &lt;legend&gt; &lt;index&gt; [symbol]
    2532. 

  2532.          </span><span style='color:#AAA'>  There are several legends and sub-legends available for
    2533. 

  2533.            drawing maps to suit personal preference and character sets.
    2534. 

  2534.            Use #map legend all to see the legend as currently defined.
    2535. 

  2535.            Use #map legend &lt;legend&gt; &lt;reset&gt; to set the default legend.
    2536. 

  2536.            Use #map legend &lt;legend&gt; &lt;character list&gt; to create a custom
    2537. 

  2537.            legend. Custom legends are automatically saved and loaded by
    2538. 

  2538.            using #map read and #map write.
    2539. 

  2539. 

  2540.          </span><span style='color:#FFF'>#map link &lt;direction&gt; &lt;room name&gt; [both]
    2541. 

  2541.          </span><span style='color:#AAA'>  Links two rooms. If the both
    2542. 

  2542.            argument and a valid direction is given the link is two ways.
    2543. 

  2543. 

  2544.          </span><span style='color:#FFF'>#map list &lt;name&gt; &lt;exits&gt; &lt;desc&gt; &lt;area&gt; &lt;note&gt; &lt;terrain&gt;
    2545. 

  2545.          </span><span style='color:#AAA'>  Lists all matching rooms and their distance. The following
    2546. 

  2546.            search keywords are supported.
    2547. 

  2547. 

  2548.            {distance}    &lt;arg&gt; will list rooms within given distance.
    2549. 

  2549.            {roomarea}    &lt;arg&gt; will list rooms with matching area name.
    2550. 

  2550.            {roomdesc}    &lt;arg&gt; will list rooms with matching room desc.
    2551. 

  2551.            {roomexits}   &lt;arg&gt; will list rooms with identical room exits.
    2552. 

  2552.                                Use * as an exit to ignore non pathdir exits.
    2553. 

  2553.            {roomflag}    &lt;arg&gt; will list rooms with matching room flags.
    2554. 

  2554.            {roomid}      &lt;arg&gt; will list rooms with identical id name.
    2555. 

  2555.            {roomname}    &lt;arg&gt; will list rooms with matching room name.
    2556. 

  2556.            {roomnote}    &lt;arg&gt; will list rooms with matching room note.
    2557. 

  2557.            {roomterrain} &lt;arg&gt; will list rooms with matching room terrain.
    2558. 

  2558.            {variable}    &lt;arg&gt; will save the output to given variable.
    2559. 

  2559. 

  2560.          </span><span style='color:#FFF'>#map map &lt;rows&gt; &lt;cols&gt; &lt;append|overwrite|list|variable&gt; &lt;name&gt;
    2561. 

  2561.          </span><span style='color:#AAA'>  Display a drawing of the map of the given height and width.
    2562. 

  2562.            All arguments are optional. If {rows} or {cols} are set to {}
    2563. 

  2563.            or {0} they will use the scrolling window size as the default.
    2564. 

  2564.            If {rows} or {cols} are a negative number this number is
    2565. 

  2565.            subtracted from the scrolling window size.
    2566. 

  2566. 

  2567.          </span><span style='color:#FFF'>#map map &lt;rows&gt; &lt;cols&gt; draw &lt;square&gt;
    2568. 

  2568.          </span><span style='color:#AAA'>  Display a drawing of the map of the given height and width.
    2569. 

  2569.            The square argument exists of 4 numbers formulating the top
    2570. 

  2570.            left corner and bottom right corner of a square.
    2571. 

  2571. 

  2572.            If you use {append|overwrite} the map is written to the specified
    2573. 

  2573.            file name which must be given as the 4th argument.
    2574. 

  2574.            If you use {list|variable} the map is saved to the specified
    2575. 

  2575.            variable name.
    2576. 

  2576. 

  2577.          </span><span style='color:#FFF'>#map move &lt;direction&gt;
    2578. 

  2578.          </span><span style='color:#AAA'>  This does the same as an actual movement command, updating your
    2579. 

  2579.            location on the map and creating new rooms. Useful when you are
    2580. 

  2580.            following someone and want the map to follow along. You will need
    2581. 

  2581.            to create actions using '#map move', for this to work.
    2582. 

  2582. 

  2583.          </span><span style='color:#FFF'>#map offset &lt;row&gt; &lt;col&gt; &lt;row&gt; &lt;col&gt;
    2584. 

  2584.          </span><span style='color:#AAA'>  Define the offset of the vtmap as a square. Without an argument
    2585. 

  2585.            it defaults to the entire top split region.
    2586. 

  2586. 

  2587.          </span><span style='color:#FFF'>#map read &lt;filename&gt;
    2588. 

  2588.          </span><span style='color:#AAA'>  Will load the given map file.
    2589. 

  2589. 

  2590.          </span><span style='color:#FFF'>#map resize &lt;size&gt;
    2591. 

  2591.          </span><span style='color:#AAA'>  Resize the map, setting the maximum number of rooms.
    2592. 

  2592. 

  2593.          </span><span style='color:#FFF'>#map return
    2594. 

  2594.          </span><span style='color:#AAA'>  Returns you to your last known room after leaving the map
    2595. 

  2595.            or loading a map.
    2596. 

  2596. 

  2597.          </span><span style='color:#FFF'>#map roomflag &lt;flags&gt; &lt;get|on|off&gt;
    2598. 

  2598.          </span><span style='color:#AAA'>
    2599. 

  2599.          </span><span style='color:#FFF'>#map roomflag avoid
    2600. 

  2600.          </span><span style='color:#AAA'>  When set, '#map find' will avoid a route leading
    2601. 

  2601.            through that room. Useful for locked doors, etc.
    2602. 

  2602.          </span><span style='color:#FFF'>#map roomflag block
    2603. 

  2603.          </span><span style='color:#AAA'>  When set the automapper will prevent movement into or through
    2604. 

  2604.            the room. Useful for death traps.
    2605. 

  2605.          </span><span style='color:#FFF'>#map roomflag hide
    2606. 

  2606.          </span><span style='color:#AAA'>  When set, '#map' will not display the map beyond
    2607. 

  2607.            this room. When mapping overlapping areas or areas that aren't
    2608. 

  2608.            build consistently you need this flag as well to stop
    2609. 

  2609.            auto-linking, unless you use void rooms.
    2610. 

  2610.          </span><span style='color:#FFF'>#map roomflag invis
    2611. 

  2611.          </span><span style='color:#AAA'>  When set the room will be colored with the INVIS color.
    2612. 

  2612.          </span><span style='color:#FFF'>#map roomflag leave
    2613. 

  2613.          </span><span style='color:#AAA'>  When entering a room with this flag, you will
    2614. 

  2614.            automatically leave the map. Useful when set at the entrance
    2615. 

  2615.            of an unmappable maze.
    2616. 

  2616.          </span><span style='color:#FFF'>#map roomflag noglobal
    2617. 

  2617.          </span><span style='color:#AAA'>  This marks a room as not allowing global
    2618. 

  2618.            transportation, like norecall rooms that block recall.
    2619. 

  2619.          </span><span style='color:#FFF'>#map roomflag void
    2620. 

  2620.          </span><span style='color:#AAA'>  When set the room becomes a spacing room that can
    2621. 

  2621.            be used to connect otherwise overlapping areas. A void room
    2622. 

  2622.            should only have two exits. When entering a void room you are
    2623. 

  2623.            moved to the connecting room until you enter a non void room.
    2624. 

  2624.          </span><span style='color:#FFF'>#map roomflag static
    2625. 

  2625.          </span><span style='color:#AAA'>  When set the room will no longer be autolinked
    2626. 

  2626.            when walking around. Useful for mapping mazes.
    2627. 

  2627. 

  2628.          </span><span style='color:#FFF'>#map run &lt;room name&gt; [delay]
    2629. 

  2629.          </span><span style='color:#AAA'>  Calculates the shortest path to the destination and walks you
    2630. 

  2630.            there. The delay is optional and requires using braces. Besides
    2631. 

  2631.            the room name a list of exits can be provided for more precise
    2632. 

  2632.            matching.
    2633. 

  2633. 

  2634.          </span><span style='color:#FFF'>#map set &lt;option&gt; &lt;value&gt; [vnum]
    2635. 

  2635.          </span><span style='color:#AAA'>  Set a map value for your current room, or given room if a room
    2636. 

  2636.            vnum is provided.
    2637. 

  2637. 

  2638.          </span><span style='color:#FFF'>#map sync &lt;filename&gt;
    2639. 

  2639.          </span><span style='color:#AAA'>  Similar to #map read except the current map won't be unloaded
    2640. 

  2640.            or overwritten.
    2641. 

  2641. 

  2642.          </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [flag]
    2643. 

  2643.          </span><span style='color:#AAA'>  Set the terrain symbol and flag.
    2644. 

  2644. 

  2645.          </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [DENSE|SPARSE|SCANT]
    2646. 

  2646.          </span><span style='color:#AAA'>  Determine symbol density, omit for the default.
    2647. 

  2647. 

  2648.          </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [NARROW|WIDE|VAST]
    2649. 

  2649.          </span><span style='color:#AAA'>  Determine symbol spread range, omit for the default.
    2650. 

  2650. 

  2651.          </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [FADEIN|FADEOUT]
    2652. 

  2652.          </span><span style='color:#AAA'>  Determine symbol spread density, omit for the default.
    2653. 

  2653. 

  2654.          </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [DOUBLE]
    2655. 

  2655.          </span><span style='color:#AAA'>  You're using two characters for the symbol.
    2656. 

  2656. 

  2657.          </span><span style='color:#FFF'>#map travel &lt;direction&gt; &lt;delay&gt;
    2658. 

  2658.          </span><span style='color:#AAA'>  Follows the direction until a dead end or an intersection is
    2659. 

  2659.            found. Use braces around the direction if you use the delay,
    2660. 

  2660.            which will add the given delay between movements.
    2661. 

  2661.            Use #path stop to stop a delayed run.
    2662. 

  2662. 

  2663.          </span><span style='color:#FFF'>#map undo
    2664. 

  2664.          </span><span style='color:#AAA'>  Will undo your last move. If this created a room or a link
    2665. 

  2665.            they will be deleted, otherwise you'll simply move back a
    2666. 

  2666.            room. Useful if you walked into a non existant direction.
    2667. 

  2667. 

  2668.          </span><span style='color:#FFF'>#map uninsert &lt;direction&gt;
    2669. 

  2669.          </span><span style='color:#AAA'>  Exact opposite of the insert command.
    2670. 

  2670. 

  2671.          </span><span style='color:#FFF'>#map unlandmark &lt;name&gt;
    2672. 

  2672.          </span><span style='color:#AAA'>  Removes a landmark.
    2673. 

  2673. 

  2674.          </span><span style='color:#FFF'>#map unlink &lt;direction&gt; [both]
    2675. 

  2675.          </span><span style='color:#AAA'>  Will remove the exit, this isn't two way so you can have the
    2676. 

  2676.            properly display no exit rooms and mazes.
    2677. 

  2677.            If you use the both argument the exit is removed two-ways.
    2678. 

  2678. 

  2679.          </span><span style='color:#FFF'>#map unterrain &lt;name&gt;
    2680. 

  2680.          </span><span style='color:#AAA'>  Removes a terrain.
    2681. 

  2681. 

  2682.          </span><span style='color:#FFF'>#map update [now]
    2683. 

  2683.          </span><span style='color:#AAA'>  Sets the vtmap to update within the next 0.1 seconds, or
    2684. 

  2684.            instantly with the now argument.
    2685. 

  2685. 

  2686.          </span><span style='color:#FFF'>#map vnum &lt;low&gt; [high]
    2687. 

  2687.          </span><span style='color:#AAA'>  Change the room vnum to the given number, if a range is
    2688. 

  2688.            provided the first available room in that range is selected.
    2689. 

  2689. 

  2690.          </span><span style='color:#FFF'>#map write &lt;filename&gt; [force]
    2691. 

  2691.          </span><span style='color:#AAA'>  Will save the map, if you want to save a map to a .tin file
    2692. 

  2692.            you must provide the {force} argument.
    2693. 

  2693. 

  2694. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#PATH'>path</a>, <a href='#PATHDIR'>pathdir</a> and <a href='#SPEEDWALK'>speedwalk</a>.
    2695. 

  2695. <a name='MAPPING'></a>
    2696. 

  2696. 

  2697. </span><span style='color:#5F5'>         MAPPING
    2698. 

  2698. 

  2699. </span><span style='color:#AAA'>
    2700. 

  2700.          TinTin++ has a powerful automapper that uses a room system similar to
    2701. 

  2701.          Diku MUDs which means that odd map layouts and weird exit
    2702. 

  2702.          configurations aren't a problem. The mapper provides tools to improve
    2703. 

  2703.          the visual map display. For basic path tracking see #help PATH.
    2704. 

  2704. 

  2705. </span><span style='color:#FFF'>         #map create [size]
    2706. 

  2706. </span><span style='color:#AAA'>
    2707. 

  2707.          This command creates the initial map. The size is 50,000 by default
    2708. 

  2708.          and can be changed at any time with the #map resize command. If you
    2709. 

  2709.          play a MUD that uses MSDP or GMCP to provide room numbers you'll have
    2710. 

  2710.          to increase it to the highest reported room number. Increasing the
    2711. 

  2711.          size of the map doesn't decrease performance.
    2712. 

  2712. 

  2713. </span><span style='color:#FFF'>         #map goto &lt;location&gt;
    2714. 

  2714. </span><span style='color:#AAA'>
    2715. 

  2715.          When you create the map you are not automatically inside the map. By
    2716. 

  2716.          default room number (vnum) 1 is created, so you can go to it using
    2717. 

  2717.          #map goto 1. Once you are inside the map new rooms are automatically
    2718. 

  2718.          created as you move around. Movement commands are defined with the
    2719. 

  2719.          pathdir command. By default n, ne, e, se, s, sw, w, nw, u, d are
    2720. 

  2720.          defined.
    2721. 

  2721. </span><span style='color:#FFF'>
    2722. 

  2722.          #map map &lt;rows&gt; &lt;cols&gt; &lt;append|overwrite|list|variable&gt; &lt;name&gt;
    2723. 

  2723. </span><span style='color:#AAA'>
    2724. 

  2724.          To see the map you can use #map map. It's annoying to have to
    2725. 

  2725.          constantly type #map map however. Instead it's possible to use #split
    2726. 

  2726.          to display a vt100 map. To do so execute:
    2727. 

  2727.          </span><span style='color:#FFF'>#split 16 1
    2728. 

  2728.          #map flag vtmap on</span><span style='color:#AAA'>
    2729. 

  2729.          The first command sets the top split lines to 16 and the bottom split
    2730. 

  2730.          line to 1. If you want a smaller or larger map display you can use a
    2731. 

  2731.          different value than 16.
    2732. 

  2732. 

  2733.          If you don't need to display diagonal exits and prefer a more compact
    2734. 

  2734.          look you can use #map flag AsciiGraphics off. This will enable the
    2735. 

  2735.          standard display which uses UTF-8 box drawing characters, results may
    2736. 

  2736.          vary depending on the font used.
    2737. 

  2737. 

  2738.          If your terminal supports UTF-8 you can also give #Map flag unicode on
    2739. 

  2739.          a try.
    2740. 

  2740. 

  2741.          If you want to display the map in a different location of the screen
    2742. 

  2742.          use something like:
    2743. 

  2743.          </span><span style='color:#FFF'>#split 0 1 0 -80
    2744. 

  2744.          #map offset 1 81 -4 -1</span><span style='color:#AAA'>
    2745. 

  2745.          This will display the map on the right side of the screen, if the
    2746. 

  2746.          width of the screen is wide enough.
    2747. 

  2747. </span><span style='color:#FFF'>
    2748. 

  2748.          #map undo
    2749. 

  2749. </span><span style='color:#AAA'>
    2750. 

  2750.          If you accidentally walk into the wall on your MUD the mapper will
    2751. 

  2751.          still create a new room. You can easily fix this mistake by using
    2752. 

  2752.          #map undo. If you want to move around on the map without moving around
    2753. 

  2753.          on the MUD you can use: #map move {direction}. To delete a room
    2754. 

  2754.          manually you can use: #map delete {direction}. To create a room
    2755. 

  2755.          manually you can use: #map dig {direction}.
    2756. 

  2756. </span><span style='color:#FFF'>
    2757. 

  2757.          #map write &lt;filename&gt;
    2758. 

  2758. </span><span style='color:#AAA'>
    2759. 

  2759.          You can save your map using #map write, to load a map you can use
    2760. 

  2760.          #map read &lt;filename&gt;.
    2761. 

  2761. </span><span style='color:#FFF'>
    2762. 

  2762.          #map set &lt;option&gt; &lt;value&gt;
    2763. 

  2763. </span><span style='color:#AAA'>
    2764. 

  2764.          You can set the room name using #map set roomname &lt;name&gt;. You either
    2765. 

  2765.          have to do this manually or create triggers to set the room name
    2766. 

  2766.          automatically. Once the room name is set you can use #map goto with
    2767. 

  2767.          the room name to visit it. If there are two rooms with the same name
    2768. 

  2768.          #map goto will go to the most nearby room. If you want to always go
    2769. 

  2769.          to the same room you should memorize the room number. You can further
    2770. 

  2770.          narrow down the matches by providing additional arguments, for example:
    2771. 

  2771. </span><span style='color:#FFF'>
    2772. 

  2772.          #map goto {dark alley} {roomexits} {n;e} {roomarea} {Haddock Ville}
    2773. 

  2773. </span><span style='color:#AAA'>
    2774. 

  2774.          You can set the room weight using #map set roomweight {value}. The
    2775. 

  2775.          weight by default is set to 1.0 and it represents the difficulty of
    2776. 

  2776.          traversing the room. If you have a lake as an alternative route, and
    2777. 

  2777.          traversing water rooms is 4 times slower than regular rooms, then you
    2778. 

  2778.          could set the weight of the lake rooms to 4.0. If the lake is 3 rooms
    2779. 

  2779.          wide the total weight is 12. If walking around the lake has a weight
    2780. 

  2780.          less than 12 the mapper will go around the lake, if the weight is
    2781. 

  2781.          greater than 12 the mapper will take a route through the lake.
    2782. 

  2782. 

  2783.          You can set the room symbol using #map set roomsymbol {value}. The
    2784. 

  2784.          symbol should be one, two, or three characters, which can be
    2785. 

  2785.          colorized. You can for example mark shops with an 'S' and colorize the
    2786. 

  2786.          'S' depending on what type of shop it is.
    2787. 

  2787. </span><span style='color:#FFF'>
    2788. 

  2788.          #map run &lt;location&gt; &lt;delay&gt;
    2789. 

  2789. </span><span style='color:#AAA'>
    2790. 

  2790.          The run command will have tintin find the shortest path to the given
    2791. 

  2791.          location and execute the movement commands to get there. You can
    2792. 

  2792.          provide a delay in seconds with floating point precision, for example:
    2793. 

  2793.          </span><span style='color:#FFF'>#map run {dark alley} {0.5}</span><span style='color:#AAA'>
    2794. 

  2794. </span><span style='color:#FFF'>
    2795. 

  2795.          #map insert {direction} {flag}
    2796. 

  2796. </span><span style='color:#AAA'>
    2797. 

  2797.          The insert command is useful for adding spacer rooms called void rooms.
    2798. 

  2798.          Often rooms overlap, and by adding void rooms you can stretch out
    2799. 

  2799.          exits. For example: #map insert north void. You cannot enter void rooms
    2800. 

  2800.          once they've been created, so you'll have to use #map info in an
    2801. 

  2801.          adjacent room to find the room vnum, then use #map goto {vnum} to
    2802. 

  2802.          visit.
    2803. 

  2803. 

  2804.          It's also possible to align rooms using void rooms. This is easily
    2805. 

  2805.          done using #map insert north void.
    2806. 

  2806. 

  2807. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MAP'>map</a>, <a href='#PATH'>path</a> and <a href='#PATHDIR'>pathdir</a>.
    2808. 

  2808. <a name='MATH'></a>
    2809. 

  2809. 

  2810. </span><span style='color:#5F5'>         MATH
    2811. 

  2811. 

  2812. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #math </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>expression</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    2813. 

  2813. 

  2814.          Performs math operations and stores the result in a variable.  The math
    2815. 

  2815.          follows a C-like precedence, as follows, with the top of the list
    2816. 

  2816.          having the highest priority.
    2817. 

  2817. 

  2818.          Operators       Priority     Function
    2819. 

  2819.          ------------------------------------------------
    2820. 

  2820.          !               0            logical not
    2821. 

  2821.          ~               0            bitwise not
    2822. 

  2822.          d               1            integer random dice
    2823. 

  2823.          *               2            integer multiply
    2824. 

  2824.          **              2            integer power
    2825. 

  2825.          /               2            integer divide
    2826. 

  2826.          //              2            integer sqrt // 2 or cbrt // 3
    2827. 

  2827.          %               2            integer modulo
    2828. 

  2828.          +               3            integer addition
    2829. 

  2829.          -               3            integer subtraction
    2830. 

  2830.          &lt;&lt;              4            bitwise shift
    2831. 

  2831.          &gt;&gt;              4            bitwise shift
    2832. 

  2832.          ..              4            bitwise ellipsis
    2833. 

  2833.          &gt;               5            logical greater than
    2834. 

  2834.          &gt;=              5            logical greater than or equal
    2835. 

  2835.          &lt;               5            logical less than
    2836. 

  2836.          &lt;=              5            logical less than or equal
    2837. 

  2837.          ==              6            logical equal (can use regex)
    2838. 

  2838.          ===             6            logical equal (never regex)
    2839. 

  2839.          !=              6            logical not equal (can use regex)
    2840. 

  2840.          !==             6            logical not equal (never regex)
    2841. 

  2841.           &amp;              7            bitwise and
    2842. 

  2842.           ^              8            bitwise xor
    2843. 

  2843.           |              9            bitwise or
    2844. 

  2844.          &amp;&amp;             10            logical and
    2845. 

  2845.          ^^             11            logical xor
    2846. 

  2846.          ||             12            logical or
    2847. 

  2847.          ?              13            logical ternary if (unfinished code)
    2848. 

  2848.          :              14            logical ternary else 
    2849. 

  2849. 

  2850.          True is any non-zero number, and False is zero.  Parentheses () have
    2851. 

  2851.          highest precedence, so inside the () is always evaluated first.
    2852. 

  2852.          Strings must be enclosed in { } and use regex with == and !=,
    2853. 

  2853.          in the case of &lt;= and &gt;= the alphabetic order is compared.
    2854. 

  2854. 

  2855.          The #if and #switch commands use #math. Several commands accepting
    2856. 

  2856.          integer input allow math operations as well.
    2857. 

  2857. 

  2858.          Floating point precision is added by using the decimal . operator.
    2859. 

  2859. 

  2860. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #math {heals} {&dollar;mana / 40}
    2861. 

  2861.          Assuming there is a variable &dollar;mana, divides its value by 40 and stores
    2862. 

  2862.          the result in &dollar;heals.
    2863. 

  2863. 

  2864. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {^You receive %0 experience} {updatexp %0}
    2865. 

  2865.          #alias updatexp {#math {xpneed} {&dollar;xpneed - %0}
    2866. 

  2866.          Let's say you have a variable which stores xp needed for your next
    2867. 

  2867.          level.  The above will modify that variable after every kill, showing
    2868. 

  2868.          the amount still needed.
    2869. 

  2869. 

  2870. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {%0 tells %1}
    2871. 

  2871.            {#if {{%0} == {Bubba} &amp;&amp; &dollar;afk} {reply I'm away, my friend.}}
    2872. 

  2872.          When you are away from keyboard, it will only reply to your friend.
    2873. 

  2873. 

  2874. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CAT'>cat</a>, <a href='#FORMAT'>format</a>, <a href='#FUNCTION'>function</a>, <a href='#LOCAL'>local</a>, <a href='#MATHEMATICS'>mathematics</a>, <a href='#REPLACE'>replace</a>, <a href='#SCRIPT'>script</a> and <a href='#VARIABLE'>variable</a>.
    2875. 

  2875. <a name='MATHEMATICS'></a>
    2876. 

  2876. 

  2877. </span><span style='color:#5F5'>         MATHEMATICS
    2878. 

  2878. 

  2879. </span><span style='color:#FFF'>Number operations
    2880. 

  2880. </span><span style='color:#AAA'>         Operators       Priority     Function
    2881. 

  2881.          ------------------------------------------------
    2882. 

  2882.          !               0            logical not
    2883. 

  2883.          ~               0            bitwise not
    2884. 

  2884.          *               1            integer multiply
    2885. 

  2885.          **              1            integer power
    2886. 

  2886.          /               1            integer divide
    2887. 

  2887.          //              1            integer sqrt // 2 or cbrt // 3
    2888. 

  2888.          %               1            integer modulo
    2889. 

  2889.          d               1            integer random dice roll
    2890. 

  2890.          +               2            integer addition
    2891. 

  2891.          -               2            integer subtraction
    2892. 

  2892.          &lt;&lt;              3            bitwise shift
    2893. 

  2893.          &gt;&gt;              3            bitwise shift
    2894. 

  2894.          &gt;               4            logical greater than
    2895. 

  2895.          &gt;=              4            logical greater than or equal
    2896. 

  2896.          &lt;               4            logical less than
    2897. 

  2897.          &lt;=              4            logical less than or equal
    2898. 

  2898.          ==              5            logical equal
    2899. 

  2899.          !=              5            logical not equal
    2900. 

  2900.           &amp;              6            bitwise and
    2901. 

  2901.           ^              7            bitwise xor
    2902. 

  2902.           |              8            bitwise or
    2903. 

  2903.          &amp;&amp;              9            logical and
    2904. 

  2904.          ^^             10            logical xor
    2905. 

  2905.          ||             11            logical or
    2906. 

  2906. 

  2907. Operator priority can be ignored by using parentheses, for example (1 + 1) * 2
    2908. 

  2908. equals 4, while 1 + 1 * 2 equals 3.
    2909. 

  2909. 

  2910. </span><span style='color:#FFF'>String operations</span><span style='color:#AAA'>
    2911. 

  2911.          Operators       Priority     Function
    2912. 

  2912.          ------------------------------------------------
    2913. 

  2913.          &gt;               4            alphabetical greater than
    2914. 

  2914.          &gt;=              4            alphabetical greater than or equal
    2915. 

  2915.          &lt;               4            alphabetical less than
    2916. 

  2916.          &lt;=              4            alphabetical less than or equal
    2917. 

  2917.          ==              5            alphabetical equal using regex
    2918. 

  2918.          !=              5            alphabetical not equal using regex
    2919. 

  2919.          ===             5            alphabetical equal
    2920. 

  2920.          !==             5            alphabetical not equal
    2921. 

  2921. 

  2922. Strings must be encased in double quotes or braces. The &gt; &gt;= &lt; &lt;= operators
    2923. 

  2923. perform basic string comparisons. The == != operators perform regular
    2924. 

  2924. expressions, with the argument on the left being the string, and the argument
    2925. 

  2925. on the right being the regex. For example {bla} == {%*a} would evaluate as 1.
    2926. 

  2926. 

  2927. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MATH'>math</a> and <a href='#REGEXP'>regexp</a>.
    2928. 

  2928. <a name='MESSAGE'></a>
    2929. 

  2929. 

  2930. </span><span style='color:#5F5'>         MESSAGE
    2931. 

  2931. 

  2932. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #message </span><span style='color:#FFF'>{</span><span style='color:#AAA'>listname</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>on</span><span style='color:#FFF'>|</span><span style='color:#AAA'>off</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    2933. 

  2933. 

  2934.          This will show the message status of all your lists if typed without an
    2935. 

  2935.          argument. If you set for example VARIABLES to OFF you will no longer be
    2936. 

  2936.          spammed when correctly using the #VARIABLE and #UNVARIABLE commands.
    2937. 

  2937. 

  2938. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a>, <a href='#DEBUG'>debug</a>, <a href='#IGNORE'>ignore</a>, <a href='#INFO'>info</a> and <a href='#KILL'>kill</a>.
    2939. 

  2939. <a name='METRIC SYSTEM'></a>
    2940. 

  2940. 

  2941. </span><span style='color:#5F5'>         METRIC SYSTEM
    2942. 

  2942. 

  2943. </span><span style='color:#AAA'>
    2944. 

  2944.              Name  Symbol                              Factor
    2945. 

  2945.            --------------------------------------------------
    2946. 

  2946.              Mega       M                           1 000 000
    2947. 

  2947.              Kilo       K                               1 000
    2948. 

  2948. 

  2949.             milli       m                               0.001
    2950. 

  2950.             micro       u                           0.000 001
    2951. 

  2951. 

  2952. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ECHO'>echo</a>, <a href='#FORMAT'>format</a> and <a href='#MATH'>math</a>.
    2953. 

  2953. <a name='MOUSE'></a>
    2954. 

  2954. 

  2955. </span><span style='color:#5F5'>         MOUSE
    2956. 

  2956. 

  2957. </span><span style='color:#AAA'>
    2958. 

  2958.          To enable xterm mouse tracking use #CONFIG MOUSE ON.
    2959. 

  2959. 

  2960.          To see mouse events as they happen use #CONFIG MOUSE INFO. This
    2961. 

  2961.          information can then be used to create mouse events with the #event
    2962. 

  2962.          command and buttons with the #button command.
    2963. 

  2963. 

  2964.          Visual buttons and pop-ups can be drawn on the screen with the #draw
    2965. 

  2965.          command.
    2966. 

  2966. 

  2967.          The input field can be changed and renamed using #screen inputregion,
    2968. 

  2968.          which allows creating named events for enter handling.
    2969. 

  2969. 

  2970.          Links can be created using the MSLP protocol which will generate link
    2971. 

  2971.          specific events when clicked.
    2972. 

  2972. 

  2973. 

  2974. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BUTTON'>button</a>, <a href='#DRAW'>draw</a>, <a href='#EVENT'>event</a> and <a href='#MSLP'>MSLP</a>.
    2975. 

  2975. <a name='MSDP'></a>
    2976. 

  2976. 

  2977. </span><span style='color:#5F5'>         MSDP
    2978. 

  2978. 

  2979. </span><span style='color:#AAA'>
    2980. 

  2980.          MSDP (Mud Server Data Protocol) is part of the #port functionality.
    2981. 

  2981.          See #help event for additional documentation as all MSDP events are
    2982. 

  2982.          available as regular events.
    2983. 

  2983. 

  2984.          Available MSDP events can be queried using the MSDP protocol
    2985. 

  2985.          as described in the specification.
    2986. 

  2986. </span><span style='color:#FFF'>
    2987. 

  2987.          https://tintin.sourceforge.io/protocols/msdp
    2988. 

  2988. 

  2989. Related</span><span style='color:#AAA'>: <a href='#EVENT'>event</a> and <a href='#PORT'>port</a>.
    2990. 

  2990. <a name='MSLP'></a>
    2991. 

  2991. 

  2992. </span><span style='color:#5F5'>         MSLP
    2993. 

  2993. 

  2994. </span><span style='color:#AAA'>
    2995. 

  2995.          MSLP (Mud Server Link Protocol) requires enabling #config mouse on,
    2996. 

  2996.          and creating the appropriate LINK events.
    2997. 

  2997. 

  2998.          The simplest link can be created by surrounding a keyword with the
    2999. 

  2999.          &bsol;e[4m and &bsol;e[24m tags.
    3000. 

  3000. 

  3001. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #substitute {&bsol;b{n|e|s|w|u|d}&bsol;b} {&bsol;e[4m%1&bsol;[24m}
    3002. 

  3002. 

  3003.          This would display 'Exits: n, e, w.' as 'Exits: n, e, w.'.
    3004. 

  3004. 

  3005.          When clicked this would trigger the PRESSED LINK MOUSE BUTTON ONE
    3006. 

  3006.          event of which %4 will hold the link command and %6 holds the
    3007. 

  3007.          link name, which in the case of a simple link will be empty.
    3008. 

  3008. 

  3009. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {PRESSED LINK MOUSE BUTTON ONE} {#send {%4}}
    3010. 

  3010. 

  3011.          Keep in mind that if you change PRESSED to DOUBLE-CLICKED the link
    3012. 

  3012.          will only work if the text does not scroll in between clicks.
    3013. 

  3013. 

  3014.          If you want to create a complex link use an OSC code.
    3015. 

  3015. 

  3016. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {&bsol;bsmurf&bsol;b} {&bsol;e]68;1;;say I hate smurfs!&bsol;a&bsol;e[4m%0&bsol;e[24m}
    3017. 

  3017. 

  3018.          If you have the LINK event of the previous example set, the %4
    3019. 

  3019.          argument will contain 'say I hate smurfs!'.
    3020. 

  3020. 

  3021. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {&bsol;bgoblin&bsol;b} {&bsol;e]68;1;SEND;kill goblin&bsol;a&bsol;e[4m%0&bsol;e[24m}
    3022. 

  3022. 

  3023.          Notice the previous instance of ;; has been replaced with ;SEND;
    3024. 

  3024.          which will name the link. This will generate a named event.
    3025. 

  3025. 

  3026. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {PRESSED LINK SEND MOUSE BUTTON ONE} {#send {%4}}
    3027. 

  3027. 

  3028.          By naming links you can organize things a little bit better instead
    3029. 

  3029.          of tunneling everything through the same event.
    3030. 

  3030. 

  3031.          Keep in mind that the server is allowed to use &bsol;e]68;1;&bsol;a as well,
    3032. 

  3032.          subsequently various security measures are in place.
    3033. 

  3033. 

  3034.          To create secure links, which are filtered out when send by a server,
    3035. 

  3035.          you need to use &bsol;e]68;2;&bsol;a, and they instead trigger the SECURE LINK
    3036. 

  3036.          event.
    3037. 

  3037. 

  3038. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {%* tells %*} {&bsol;e]68;2;EXEC;#cursor set tell %1 &bsol;a&bsol;e[4m%0&bsol;e[24m}
    3039. 

  3039. </span><span style='color:#FFF'>       </span><span style='color:#AAA'>  #event {PRESSED SECURE LINK EXEC MOUSE BUTTON ONE} {%4}
    3040. 

  3040. 

  3041.          This would make you start a reply when clicking on a tell.
    3042. 

  3042. 

  3043. </span><span style='color:#FFF'>Website</span><span style='color:#AAA'>: https://tintin.mudhalla.net/protocols/mslp
    3044. 

  3044. 

  3045. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#EVENT'>event</a> and <a href='#PORT'>port</a>.
    3046. 

  3046. <a name='NOP'></a>
    3047. 

  3047. 

  3048. </span><span style='color:#5F5'>         NOP
    3049. 

  3049. 

  3050. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #nop </span><span style='color:#FFF'>{</span><span style='color:#AAA'>whatever</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3051. 

  3051. 

  3052.          Short for 'no operation', and is ignored by the client.  It is useful
    3053. 

  3053.          for commenting in your coms file, any text after the nop and before a
    3054. 

  3054.          semicolon or end of line is ignored. You shouldn't put braces { } in it
    3055. 

  3055.          though, unless you close them properly.
    3056. 

  3056. 

  3057. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: By using braces you can comment out multiple lines of code in a script
    3058. 

  3058.          file.
    3059. 

  3059. 

  3060.          For commenting out an entire trigger and especially large sections of
    3061. 

  3061.          triggers you would want to use /* text */
    3062. 

  3062. 

  3063. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #nop This is the start of my script file.
    3064. 

  3064. 

  3065. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#READ'>read</a>
    3066. 

  3066. <a name='PARSE'></a>
    3067. 

  3067. 

  3068. </span><span style='color:#5F5'>         PARSE
    3069. 

  3069. 

  3070. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #parse </span><span style='color:#FFF'>{</span><span style='color:#AAA'>string</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3071. 

  3071. 

  3072.          Like the loop statement, parse will loop from start to finish through
    3073. 

  3073.          the given string.  The value of the current character is stored in the
    3074. 

  3074.          provided variable.
    3075. 

  3075. 

  3076. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #parse {hello world} {char} {#show &dollar;char}
    3077. 

  3077. 

  3078. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#FOREACH'>foreach</a>, <a href='#LIST'>list</a>, <a href='#LOOP'>loop</a>, <a href='#REPEAT'>repeat</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    3079. 

  3079. <a name='PATH'></a>
    3080. 

  3080. 

  3081. </span><span style='color:#5F5'>         PATH
    3082. 

  3082. 

  3083. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #path </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3084. 

  3084. 

  3085.          create   Will clear the path and start path mapping.
    3086. 

  3086.          delete   Will delete the last move of the path.
    3087. 

  3087.          describe Describe the path and current position.
    3088. 

  3088.          destroy  Will clear the path and stop path mapping.
    3089. 

  3089.          get      Will get either the length or position.
    3090. 

  3090.          goto     Go the the start, end, or given position index.
    3091. 

  3091.          insert   Add the given argument to the path.
    3092. 

  3092.          load     Load the given variable as the new path.
    3093. 

  3093.          map      Display the map and the current position.
    3094. 

  3094.          move     Move the position forward or backward. If a number is given
    3095. 

  3095.                   the position is changed by the given number of steps.
    3096. 

  3096.          run      Execute the current path, with an optional floating point
    3097. 

  3097.                   delay in seconds as the second argument.
    3098. 

  3098.          save     Save the path to a variable. You must specify whether you
    3099. 

  3099.                   want to save the path 'forward' or 'backward'.
    3100. 

  3100.          swap     Switch the forward and backward path.
    3101. 

  3101.          unzip    Load the given speedwalk as the new path.
    3102. 

  3102.          walk     Take one step forward or backward.
    3103. 

  3103.          zip      Turn the path into a speedwalk.
    3104. 

  3104. 

  3105. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #path ins {unlock n;open n} {unlock s;open s}
    3106. 

  3106. 

  3107. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MAP'>map</a>, <a href='#PATHDIR'>pathdir</a> and <a href='#SPEEDWALK'>speedwalk</a>.
    3108. 

  3108. <a name='PATHDIR'></a>
    3109. 

  3109. 

  3110. </span><span style='color:#5F5'>         PATHDIR
    3111. 

  3111. 

  3112. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #pathdir </span><span style='color:#FFF'>{</span><span style='color:#AAA'>dir</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>reversed dir</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>coord</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3113. 

  3113. 

  3114.          By default tintin sets the most commonly used movement commands
    3115. 

  3115.          meaning you generally don't really have to bother with pathdirs.
    3116. 

  3116.          Pathdirs are used by the #path and #map commands.
    3117. 

  3117. 

  3118.          The first argument is a direction, the second argument is the reversed
    3119. 

  3119.          direction.  The reverse direction of north is south, etc.
    3120. 

  3120. 

  3121.          The third argument is a spatial coordinate which is a power of two.
    3122. 

  3122.          'n' is 1, 'e' is 2, 's' is 4, 'w' is '8', 'u' is 16, 'd' is 32. The
    3123. 

  3123.          exception is for compound directions, whose value should be the sum
    3124. 

  3124.          of the values of each cardinal direction it is composed of. For
    3125. 

  3125.          example, 'nw' is the sum of 'n' and 'w' which is 1 + 8, so 'nw'
    3126. 

  3126.          needs to be given the value of 9. This value is required for the
    3127. 

  3127.          #map functionality to work properly.
    3128. 

  3128. 

  3129. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #pathdir {ue} {dw} {18}
    3130. 

  3130.          #pathdir {dw} {ue} {40}
    3131. 

  3131. 

  3132. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a pathdir with the #unpathdir command.
    3133. 

  3133. 

  3134. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MAP'>map</a> and <a href='#PATH'>path</a>.
    3135. 

  3135. <a name='PCRE'></a>
    3136. 

  3136. 

  3137. </span><span style='color:#5F5'>         PCRE
    3138. 

  3138. 

  3139. </span><span style='color:#AAA'>
    3140. 

  3140.          A regular expression, regex or regexp is a sequence of characters that
    3141. 

  3141.          defines a search pattern. Since the 1980s, different syntaxes for
    3142. 

  3142.          writing regular expressions exist, the two most widely used ones being
    3143. 

  3143.          the POSIX syntax and the similar but more advanced Perl standard.
    3144. 

  3144.          TinTin++ supports the Perl standard known as PCRE (Perl Compatible
    3145. 

  3145.          Regular Expressions).
    3146. 

  3146. 

  3147.          Regular expressions are an integral part of TinTin++, but keep in mind
    3148. 

  3148.          that tintin doesn't allow you to use regular expressions directly,
    3149. 

  3149.          instead it uses a simpler intermediate syntax that still allows more
    3150. 

  3150.          complex expressions when needed.
    3151. 

  3151. 

  3152.          Commands that utilize regular expressions are: action, alias, elseif,
    3153. 

  3153.          gag, grep, highlight, if, kill, local, math, prompt, regexp, replace,
    3154. 

  3154.          substitute, switch, variable and while. Several other commands use
    3155. 

  3155.          regular expressions in minor ways. Fortunately the basics are very
    3156. 

  3156.          easy to learn.
    3157. 

  3157. 

  3158. </span><span style='color:#FFF'>         TinTin++ Regular Expression</span><span style='color:#AAA'>
    3159. 

  3159. 

  3160.          The following support is available for regular expressions.
    3161. 

  3161. 

  3162.        ^ match start of line.
    3163. 

  3163.        &dollar; match of end of line.
    3164. 

  3164.        &bsol; escape one character.
    3165. 

  3165. 

  3166.   %1-%99 match of any text, stored in the corresponding index.
    3167. 

  3167.       %0 should be avoided in the regex, contains all matched text.
    3168. 

  3168.      { } embed a perl compatible regular expression, matches are stored.
    3169. 

  3169.    %!{ } embed a perc compatible regular expression, matches are not stored.
    3170. 

  3170. 

  3171. [ ] . + | ( ) ? * are treated as normal text unless used within braces. Keep in
    3172. 

  3172. mind that { } is replaced with ( ) automatically unless %!{ } is used.
    3173. 

  3173. </span><span style='color:#FFF'>
    3174. 

  3174.          TinTin++  Description                            POSIX</span><span style='color:#AAA'>
    3175. 

  3175.       %d Match zero to any number of digits               ([0-9]*?)
    3176. 

  3176.       %D Match zero to any number of non-digits           ([^0-9]*?)
    3177. 

  3177.       %i Matches become case insensitive                  (?i)
    3178. 

  3178.       %I Matches become case sensitive (default)          (?-i)
    3179. 

  3179.       %s Match zero to any number of spaces               ([&bsol;r&bsol;n&bsol;t ]*?)
    3180. 

  3180.       %w Match zero to any number of word characters      ([A-Za-z0-9_]*?)
    3181. 

  3181.       %W Match zero to any number of non-word characters  ([^A-Za-z0-9_]*?)
    3182. 

  3182.       %? Match zero or one character                      (.??)
    3183. 

  3183.       %. Match one character                              (.)
    3184. 

  3184.       %+ Match one to any number of characters            (.+?)
    3185. 

  3185.       %* Match zero to any number of characters           (.*?)
    3186. 

  3186. </span><span style='color:#FFF'>
    3187. 

  3187.          Variables</span><span style='color:#AAA'>
    3188. 

  3188. 

  3189.          If you use %1 in an action to perform a match the matched string is
    3190. 

  3190.          stored in the %1 variable which can be used in the action body.
    3191. 

  3191. 

  3192. Example: %1 says 'Tickle me'} {tickle %1}
    3193. 

  3193. 

  3194.          If you use %2 the match is stored in %2, etc. If you use an unnumbered
    3195. 

  3195.          match like %* or %S the match is stored at the last used index
    3196. 

  3196.          incremented by one.
    3197. 

  3197. 

  3198. Example: %3 says '%*'} {#if {&quot;%4&quot; == &quot;Tickle me&quot;} {tickle %3}}
    3199. 

  3199. 

  3200.          The maximum variable index is 99. If you begin an action with %* the
    3201. 

  3201.          match is stored in %1. You should never use %0 in the trigger part of
    3202. 

  3202.          an action, when used in the body of an action %0 contains all the parts
    3203. 

  3203.          of the string that were matched.
    3204. 

  3204. 

  3205.          To prevent a match from being stored use %!*, %!w, etc.
    3206. 

  3206. </span><span style='color:#FFF'>
    3207. 

  3207.          Perl Compatible Regular Expressions</span><span style='color:#AAA'>
    3208. 

  3208. 

  3209.          You can embed a PCRE (Perl Compatible Regular Expression) using curley
    3210. 

  3210.          braces { }, these braces are replaced with parentheses ( ) unless you
    3211. 

  3211.          use %!{ }.
    3212. 

  3212. </span><span style='color:#FFF'>
    3213. 

  3213.          Or</span><span style='color:#AAA'>
    3214. 

  3214. 

  3215.          You can separate alternatives within a PCRE using the | character.
    3216. 

  3216. 

  3217. Example: #act {%* raises {his|her|its} eyebrows.} {say 42..}
    3218. 

  3218. </span><span style='color:#FFF'>
    3219. 

  3219.          Brackets</span><span style='color:#AAA'>
    3220. 

  3220. 

  3221.          You can group alternatives and ranges within a PCRE using brackets.
    3222. 

  3222. 

  3223. Example: #act {%* says 'Who is number {[1-9]}} {say &dollar;number[%2] is number %2}
    3224. 

  3224. 

  3225.          The example only triggers if someone provides a number between 1 and
    3226. 

  3226.          9. Any other character will cause the action to not trigger.
    3227. 

  3227. 

  3228. Example: #act {%* says 'Set password to {[^0-9]*}&dollar;} {say The password must
    3229. 

  3229.            contain at least one number, not for security reasons, but just to
    3230. 

  3230.            annoy you.} {4}
    3231. 

  3231. 

  3232.          When the ^ character is used within brackets it creates an inverse
    3233. 

  3233.          search, [^0-9] matches every character except for a number between 0
    3234. 

  3234.          and 9.
    3235. 

  3235. </span><span style='color:#FFF'>
    3236. 

  3236.          Quantification</span><span style='color:#AAA'>
    3237. 

  3237. 

  3238.          A quantifier placed after a match specifies how often the match is
    3239. 

  3239.          allowed to occur.
    3240. 

  3240. 

  3241.        ? repeat zero or one time.
    3242. 

  3242.        * repeat zero or multiple times.
    3243. 

  3243.        + repeat once or multiple times.
    3244. 

  3244.      {n} repeat exactly n times, n must be a number.
    3245. 

  3245.     {n,} repeat at least n times, n must be a number.
    3246. 

  3246.    {n,o} repeat between n and o times, n and o must be a number.
    3247. 

  3247. 

  3248. Example: #act {%* says 'Who is number {[1-9][0-9]{0,2}} {Say &dollar;number[%2] is
    3249. 

  3249.            number %2}
    3250. 

  3250. 

  3251.          The example only triggers if someone provides a number between 1 and
    3252. 

  3252.          999.
    3253. 

  3253. 

  3254.          </span><span style='color:#FFF'>Parantheses</span><span style='color:#AAA'>
    3255. 

  3255. 

  3256.          TinTin Regular Expressions automatically add parenthesis, for example
    3257. 

  3257.          %* translates to (.*?) in PCRE unless the %* is found at the start or
    3258. 

  3258.          end of the line, in which cases it translates to (.*). Paranthesis in
    3259. 

  3259.          PCRE causes a change in execution priority similar to mathematical
    3260. 

  3260.          expressions, but parentheses also causes the match to be stored to a
    3261. 

  3261.          variable.
    3262. 

  3262. 

  3263.          When nesting multiple sets of parentheses each nest is assigned its
    3264. 

  3264.          numerical variable in order of appearance.
    3265. 

  3265. 

  3266. Example: #act {%* chats '{Mu(ha)+}'} {chat %2ha!}
    3267. 

  3267. 

  3268.          If someone chats Muha you will chat Muhaha! If someone chats Muhaha
    3269. 

  3269.          you will chat Muhahaha!
    3270. 

  3270. 

  3271.          </span><span style='color:#FFF'>Lazy vs Greedy</span><span style='color:#AAA'>
    3272. 

  3272. 

  3273.          By default regex matches are greedy, meaning {.*} will capture as much
    3274. 

  3274.          text as possible.
    3275. 

  3275. 

  3276. Example: #regex {bli bla blo} {^{.*} {.*}&dollar;} {#show Arg1=(&amp;1) Arg2=(&amp;2)}
    3277. 

  3277. 

  3278.          This will display: Arg1=(bli bla) Arg2=(blo)
    3279. 

  3279. 

  3280.          By appending a ? behind a regex it becomes lazy, meaning {.*?} will
    3281. 

  3281.          capture as little text as possible.
    3282. 

  3282. 

  3283. Example: #regex {bli bla blo} {^{.*?} {.*?}&dollar;} {#show Arg1=(&amp;1) Arg2=(&amp;2)}
    3284. 

  3284. 

  3285.          This will display: Arg1=(bli) Arg2=(bla blo).
    3286. 

  3286. 

  3287.          </span><span style='color:#FFF'>Escape Codes</span><span style='color:#AAA'>
    3288. 

  3288. 

  3289.          PCRE support the following escape codes.
    3290. 

  3290. </span><span style='color:#FFF'>
    3291. 

  3291.     PCRE Description                                    POSIX</span><span style='color:#AAA'>
    3292. 

  3292.       &bsol;A Match start of string                          ^
    3293. 

  3293.       &bsol;b Match word boundaries                          (^|&bsol;r|&bsol;n|&bsol;t| |&dollar;)
    3294. 

  3294.       &bsol;B Match non-word boundaries                      [^&bsol;r&bsol;n&bsol;t ]
    3295. 

  3295.       &bsol;c Insert control character                       &bsol;c
    3296. 

  3296.       &bsol;d Match digits                                   [0-9]
    3297. 

  3297.       &bsol;D Match non-digits                               [^0-9]
    3298. 

  3298.       &bsol;e Insert escape character                        &bsol;e
    3299. 

  3299.       &bsol;f Insert form feed character                     &bsol;f
    3300. 

  3300.       &bsol;n Insert line feed character                     &bsol;n
    3301. 

  3301.       &bsol;r Insert carriage return character               &bsol;r
    3302. 

  3302.       &bsol;s Match spaces                                   [&bsol;r&bsol;n&bsol;t ]
    3303. 

  3303.       &bsol;S Match non-spaces                               [^&bsol;r&bsol;n&bsol;t ]
    3304. 

  3304.       &bsol;t Insert tab character                           &bsol;t
    3305. 

  3305.       &bsol;w Match letters, numbers, and underscores        [A-Za-z0-9_]
    3306. 

  3306.       &bsol;W Match non-letters, numbers, and underscores    [^A-Za-z0-9_]
    3307. 

  3307.       &bsol;x Insert hex character                           &bsol;x
    3308. 

  3308.       &bsol;Z Match end of string                            &dollar;
    3309. 

  3309. 

  3310.          &bsol;s matches one space, &bsol;s+ matches one or multiple spaces.
    3311. 

  3311. 

  3312.          </span><span style='color:#FFF'>Color triggers</span><span style='color:#AAA'>
    3313. 

  3313. 

  3314.          To make matching easier text triggers (Actions, Gags, Highlights,
    3315. 

  3315.          Prompts, and Substitutes) have their color codes stripped. If you
    3316. 

  3316.          want to create a color trigger you must start the triggers with a ~
    3317. 

  3317.          (tilde). To make escape codes visible use #config {convert meta} on.
    3318. 

  3318. 

  3319. Example: #action {~&bsol;e[1;37m%1} {#var roomname %1}
    3320. 

  3320. 

  3321.          If the room name is the only line on the server in bright white
    3322. 

  3322.          white color trigger will save the roomname.
    3323. 

  3323. 

  3324. 

  3325.          This covers the basics. PCRE has more options, most of which are
    3326. 

  3326.          somewhat obscure, so you'll have to read a PCRE manual for additional
    3327. 

  3327.          information.
    3328. 

  3328. 

  3329. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MAP'>map</a> and <a href='#PATH'>path</a>.
    3330. 

  3330. <a name='PORT'></a>
    3331. 

  3331. 

  3332. </span><span style='color:#5F5'>         PORT
    3333. 

  3333. 

  3334. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #port </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3335. 

  3335. 

  3336.          </span><span style='color:#FFF'>#port {init} {name} {port} {file}
    3337. 

  3337.          </span><span style='color:#AAA'>  Initilize a port session.
    3338. 

  3338. 

  3339.          </span><span style='color:#FFF'>#port {call} {address} {port}
    3340. 

  3340.          </span><span style='color:#AAA'>  Connect to a remote socket.
    3341. 

  3341. 

  3342.          </span><span style='color:#FFF'>#port {color} {color names}
    3343. 

  3343.          </span><span style='color:#AAA'>  Set the default color of port messages.
    3344. 

  3344. 

  3345.          </span><span style='color:#FFF'>#port {dnd}
    3346. 

  3346.          </span><span style='color:#AAA'>  Do Not Disturb. Decline new connections
    3347. 

  3347. 

  3348.          </span><span style='color:#FFF'>#port {group} {name} {group}
    3349. 

  3349.          </span><span style='color:#AAA'>  Assign a socket group.
    3350. 

  3350. 

  3351.          </span><span style='color:#FFF'>#port {ignore} {name}
    3352. 

  3352.          </span><span style='color:#AAA'>  Ignore a socket
    3353. 

  3353. 

  3354.          </span><span style='color:#FFF'>#port {info}
    3355. 

  3355.          </span><span style='color:#AAA'>  Display information about the port session.
    3356. 

  3356. 

  3357.          </span><span style='color:#FFF'>#port {name} {name}
    3358. 

  3358.          </span><span style='color:#AAA'>  Change socket name.
    3359. 

  3359. 

  3360.          </span><span style='color:#FFF'>#port {prefix} {text}
    3361. 

  3361.          </span><span style='color:#AAA'>  Set prefix before each message.
    3362. 

  3362. 

  3363.          </span><span style='color:#FFF'>#port {send} {name|all} {text}
    3364. 

  3364.          </span><span style='color:#AAA'>  Send data to socket
    3365. 

  3365. 

  3366.          </span><span style='color:#FFF'>#port {uninitialize}
    3367. 

  3367.          </span><span style='color:#AAA'>  Uninitialize the port session.
    3368. 

  3368. 

  3369.          </span><span style='color:#FFF'>#port {who}
    3370. 

  3370.          </span><span style='color:#AAA'>  Show all connections
    3371. 

  3371. 

  3372.          </span><span style='color:#FFF'>#port {zap} {name}
    3373. 

  3373.          </span><span style='color:#AAA'>  Close a connection
    3374. 

  3374. 

  3375.          The port command is very similar to chat except that it creates a
    3376. 

  3376.          new session dedicated to receiving socket connections at the given
    3377. 

  3377.          port number without built-in support for a communication protocol.
    3378. 

  3378. 

  3379.          You can init with 0 as the port number to create a dummy session.
    3380. 

  3380. 

  3381. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#CHAT'>chat</a>, <a href='#RUN'>run</a>, <a href='#SESSION'>session</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SNOOP'>snoop</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    3382. 

  3382. <a name='PROMPT'></a>
    3383. 

  3383. 

  3384. </span><span style='color:#5F5'>         PROMPT
    3385. 

  3385. 

  3386. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #prompt </span><span style='color:#FFF'>{</span><span style='color:#AAA'>text</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>new text</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>row #</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>col #</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3387. 

  3387. 

  3388.          Prompt is a feature for split window mode, which will capture a line
    3389. 

  3389.          received from the server and display it on the status bar of your
    3390. 

  3390.          split screen terminal. You would define &lt;text&gt; and &lt;new text&gt; the
    3391. 

  3391.          same way as you would with #substitute.
    3392. 

  3392. 

  3393.          The row number is optional and useful if you use a non standard split
    3394. 

  3394.          mode. A positive row number draws #row lines from the top while a
    3395. 

  3395.          negative number draws #row lines from the bottom. Without an argument
    3396. 

  3396.          #prompt will write to the default split line, which is one row above
    3397. 

  3397.          the input line, typically at row -2.
    3398. 

  3398. 

  3399.          The col number is optional and can be used to set the column index.
    3400. 

  3400.          A positive col number draws the given number of columns from the left,
    3401. 

  3401.          while a negative col number draws from the right. If you leave the
    3402. 

  3402.          col number empty tintin will clear the row before printing at the
    3403. 

  3403.          start of the row.
    3404. 

  3404. 

  3405.          The #show command takes a row and col argument as well so it's also
    3406. 

  3406.          possible to place text on your split lines using #show.
    3407. 

  3407. 

  3408. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See </span><span style='color:#FFF'>#help split</span><span style='color:#AAA'> for more information on split mode.
    3409. 

  3409. 

  3410. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See </span><span style='color:#FFF'>#help substitute</span><span style='color:#AAA'> for more information on text
    3411. 

  3411.          substitutions.
    3412. 

  3412. 

  3413. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a prompt with the #unprompt command.
    3414. 

  3414. 

  3415. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ACTION'>action</a>, <a href='#GAG'>gag</a>, <a href='#HIGHLIGHT'>highlight</a> and <a href='#SUBSTITUTE'>substitute</a>.
    3416. 

  3416. <a name='READ'></a>
    3417. 

  3417. 

  3418. </span><span style='color:#5F5'>         READ
    3419. 

  3419. 

  3420. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #read </span><span style='color:#FFF'>{</span><span style='color:#AAA'>filename</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3421. 

  3421. 

  3422.          Reads a commands file into memory.  The coms file is merged in with
    3423. 

  3423.          the currently loaded commands.  Duplicate commands are overwritten.
    3424. 

  3424. 

  3425.          If you uses braces, { and } you can use several lines for 1 commands.
    3426. 

  3426.          This however means you must always match every { with a } for the read
    3427. 

  3427.          command to work.
    3428. 

  3428. 

  3429.          You can comment out triggers using /* text */
    3430. 

  3430. 

  3431. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#LOG'>log</a>, <a href='#SCAN'>scan</a>, <a href='#TEXTIN'>textin</a> and <a href='#WRITE'>write</a>.
    3432. 

  3432. <a name='REGEXP'></a>
    3433. 

  3433. 

  3434. </span><span style='color:#5F5'>         REGEXP
    3435. 

  3435. 

  3436. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #regexp </span><span style='color:#FFF'>{</span><span style='color:#AAA'>string</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>expression</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>true</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>false</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3437. 

  3437. 

  3438.          Compares the string to the given regular expression.
    3439. 

  3439. 

  3440.          The expression can contain escapes, and if you want to match a literal
    3441. 

  3441.          &bsol; character you'll have to use &bsol;&bsol; to match a single backslash.
    3442. 

  3442. 

  3443.          Variables are stored in &amp;1 to &amp;99 with &amp;0 holding the matched
    3444. 

  3444.          substring.
    3445. 

  3445. 

  3446.        ^ force match of start of line.
    3447. 

  3447.        &dollar; force match of end of line.
    3448. 

  3448.        &bsol; escape one character.
    3449. 

  3449.   %1-%99 lazy match of any text, available at %1-%99.
    3450. 

  3450.       %0 should be avoided in triggers, and if left alone lists all matches.
    3451. 

  3451.      { } embed a raw regular expression, matches are stored to %1-%99.
    3452. 

  3452.    %!{ } embed a raw regular expression, matches are not stored.
    3453. 

  3453.          [ ] . + | ( ) ? * are treated as normal text unlessed used within
    3454. 

  3454.          braces. Keep in mind that { } is replaced with ( ) automatically
    3455. 

  3455.          unless %!{ } is used.
    3456. 

  3456. 

  3457.          Of the following the (lazy) match is available at %1-%99 + 1
    3458. 

  3458. 

  3459.       %d match zero to any number of digits.
    3460. 

  3460.       %D match zero to any number of non digits.
    3461. 

  3461.       %s match zero to any number of spaces.
    3462. 

  3462.       %S match zero to any number of non spaces.
    3463. 

  3463.       %w match zero to any number of word characters.
    3464. 

  3464.       %W match zero to any number of non word characters.
    3465. 

  3465. 

  3466.       Experimental (subject to change) matches are:
    3467. 

  3467. 

  3468.       %a match zero to any number of characters including newlines.
    3469. 

  3469.       %A match zero to any number of newlines.
    3470. 

  3470.       %p match zero to any number of printable characters.
    3471. 

  3471.       %P match zero to any number of non printable characters.
    3472. 

  3472.       %u match zero to any number of unicode characters.
    3473. 

  3473.       %U match zero to any number of non unicode characters.
    3474. 

  3474. 

  3475.       If you want to match 1 digit use %+1d, if you want to match between 3
    3476. 

  3476.       and 5 spaces use %+3..5s, if you want to match 0 or more word
    3477. 

  3477.       characters use %+0..w, etc.
    3478. 

  3478. 

  3479.       %+ match one to any number of characters.
    3480. 

  3480.       %? match zero or one character.
    3481. 

  3481.       %. match one character.
    3482. 

  3482.       %* match zero to any number of characters.
    3483. 

  3483. 

  3484.       %i matching becomes case insensitive.
    3485. 

  3485.       %I matching becomes case sensitive (default).
    3486. 

  3486. 

  3487.          The match is automatically stored to a value between %1 and %99
    3488. 

  3488.          starting at %1 and incrementing by 1 for every regex. If you use
    3489. 

  3489.          %15 as a regular expression, the next unnumbered regular expression
    3490. 

  3490.          would be %16. To prevent a match from being stored use %!*, %!w, etc.
    3491. 

  3491. 

  3492. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #regexp {bli bla blo} {bli {.*} blo} {#show &amp;1}
    3493. 

  3493. 

  3494. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: Like an alias or function #regex has its own scope.
    3495. 

  3495. 

  3496. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#PCRE'>pcre</a> and <a href='#REPLACE'>replace</a>.
    3497. 

  3497. <a name='REPEAT'></a>
    3498. 

  3498. 

  3499. </span><span style='color:#5F5'>         REPEAT
    3500. 

  3500. 

  3501. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #</span><span style='color:#FFF'>[</span><span style='color:#AAA'>number</span><span style='color:#FFF'>] {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3502. 

  3502. 

  3503. Sometimes you want to repeat the same command multiple times. This is the
    3504. 

  3504. easiest way to accomplish that.
    3505. 

  3505. 

  3506. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #10 {buy bread}
    3507. 

  3507. 

  3508. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#FOREACH'>foreach</a>, <a href='#LIST'>list</a>, <a href='#LOOP'>loop</a>, <a href='#PARSE'>parse</a>, <a href='#RETURN'>return</a> and <a href='#WHILE'>while</a>.
    3509. 

  3509. <a name='REPLACE'></a>
    3510. 

  3510. 

  3511. </span><span style='color:#5F5'>         REPLACE
    3512. 

  3512. 

  3513. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #replace </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>oldtext</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>newtext</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3514. 

  3514. 

  3515.          Searches the given variable, replacing each occurrence of 'oldtext'
    3516. 

  3516.          with 'newtext'. The 'oldtext' argument is a regular expression.
    3517. 

  3517. 

  3518.          Variables are stored in &amp;1 to &amp;99 with &amp;0 holding the entire matched
    3519. 

  3519.          substring.
    3520. 

  3520. 

  3521. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function rnd #math result 1d9;#replace test {%.} {@rnd{}}
    3522. 

  3522. 

  3523. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CAT'>cat</a>, <a href='#FORMAT'>format</a>, <a href='#FUNCTION'>function</a>, <a href='#LOCAL'>local</a>, <a href='#MATH'>math</a>, <a href='#SCRIPT'>script</a> and <a href='#VARIABLE'>variable</a>.
    3524. 

  3524. <a name='RETURN'></a>
    3525. 

  3525. 

  3526. </span><span style='color:#5F5'>         RETURN
    3527. 

  3527. 

  3528. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #return </span><span style='color:#FFF'>{</span><span style='color:#AAA'>text</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3529. 

  3529. 

  3530.          This command can be used to break out of a command string being
    3531. 

  3531.          executed.
    3532. 

  3532. 

  3533.          If used inside a #function you can use #return with an argument to both
    3534. 

  3534.          break out of the function and set the result variable.
    3535. 

  3535. 

  3536. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BREAK'>break</a>, <a href='#CONTINUE'>continue</a>, <a href='#FOREACH'>foreach</a>, <a href='#LIST'>list</a>, <a href='#LOOP'>loop</a>, <a href='#PARSE'>parse</a>, <a href='#REPEAT'>repeat</a> and <a href='#WHILE'>while</a>.
    3537. 

  3537. <a name='RUN'></a>
    3538. 

  3538. 

  3539. </span><span style='color:#5F5'>         RUN
    3540. 

  3540. 

  3541. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #run </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>shell command</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>file</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3542. 

  3542. 

  3543.          The run command works much like the system command except that it
    3544. 

  3544.          runs the command in a pseudo terminal. The run command also creates
    3545. 

  3545.          a session that treats the given shell command as a server. This
    3546. 

  3546.          allows you to run ssh, as well as any other shell application, with
    3547. 

  3547.          full tintin scripting capabilities. If a file name is given the file
    3548. 

  3548.          is loaded prior to execution.
    3549. 

  3549. 

  3550. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #run {somewhere} {ssh someone@somewhere.com}
    3551. 

  3551. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #run {something} {tail -f chats.log}
    3552. 

  3552. 

  3553. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#PORT'>port</a>, <a href='#SESSION'>session</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SNOOP'>snoop</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    3554. 

  3554. <a name='SCAN'></a>
    3555. 

  3555. 

  3556. </span><span style='color:#5F5'>         SCAN
    3557. 

  3557. 

  3558. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #scan </span><span style='color:#FFF'>{</span><span style='color:#AAA'>abort</span><span style='color:#FFF'>|</span><span style='color:#AAA'>csv</span><span style='color:#FFF'>|</span><span style='color:#AAA'>tsv</span><span style='color:#FFF'>|</span><span style='color:#AAA'>txt</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>filename</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3559. 

  3559. 

  3560.          The scan command is a file reading utility.
    3561. 

  3561. 

  3562.          </span><span style='color:#FFF'>#scan {abort}
    3563. 

  3563.          </span><span style='color:#AAA'>  This command must be called from with a SCAN event and will
    3564. 

  3564.            abort the scan if one is in progress.
    3565. 

  3565. 

  3566.          </span><span style='color:#FFF'>#scan {csv} &lt;filename&gt;
    3567. 

  3567.          </span><span style='color:#AAA'>  The scan csv command reads in a comma separated value file
    3568. 

  3568.            without printing the content to the screen. Instead it triggers one
    3569. 

  3569.            of two events.
    3570. 

  3570. 

  3571.            The SCAN CSV HEADER event is triggered on the first line of the csv
    3572. 

  3572.            file. The SCAN CSV LINE event is triggered on the second and each
    3573. 

  3573.            subsequent line of the csv file. The %0 argument contains the entire
    3574. 

  3574.            line, with  %1 containing the first value, %2 the second value, etc,
    3575. 

  3575.            all the way up to %99.
    3576. 

  3576. 

  3577.            Values containing spaces must be surrounded with quotes, keep in mind
    3578. 

  3578.            newlines within quotes are not supported. Use two quotes to print one
    3579. 

  3579.            literal quote character.
    3580. 

  3580. 

  3581. </span><span style='color:#FFF'>         #scan {dir} &lt;filename&gt; &lt;variable&gt;
    3582. 

  3582. </span><span style='color:#AAA'>
    3583. 

  3583.           The scan dir command will read the given filename or directory and
    3584. 

  3584.           store any gathered information into the provided variable.
    3585. 

  3585. 

  3586.          </span><span style='color:#FFF'>#scan {tsv} &lt;filename&gt;
    3587. 

  3587. 

  3588.          </span><span style='color:#AAA'>  The scan tsv &lt;filename&gt; command reads in a tab separated value file
    3589. 

  3589.            without printing the content to the screen. Instead it triggers the
    3590. 

  3590.            SCAN TSV HEADER event for the first line and SCAN TSV LINE for all
    3591. 

  3591.            subsequent lines.
    3592. 

  3592. 

  3593.          </span><span style='color:#FFF'>#scan {file} &lt;filename&gt; {commands}
    3594. 

  3594. 

  3595.          </span><span style='color:#AAA'>  The scan file command reads the given files and executes the
    3596. 

  3596.             commands argument. &amp;0 contains the raw content of the file and
    3597. 

  3597.             &amp;1 contains the plain content. &amp;2 contains the raw byte size of the
    3598. 

  3598.             file and &amp;3 the plain byte size. &amp;5 contains the line count.
    3599. 

  3599. 

  3600.          </span><span style='color:#FFF'>#scan {txt} &lt;filename&gt;
    3601. 

  3601. 

  3602.          </span><span style='color:#AAA'>  The scan txt &lt;filename&gt; command reads in a file and sends its content
    3603. 

  3603.            to the screen as if it was send by a server. After using scan you can
    3604. 

  3604.            use page-up and down to view the file.
    3605. 

  3605. 

  3606.            This command is useful to convert ansi color files to html or viewing
    3607. 

  3607.            raw log files.
    3608. 

  3608. 

  3609.            Actions, highlights, and substitutions will trigger as normal, and it
    3610. 

  3610.            is possible to create an action to execute #scan abort to prematurely
    3611. 

  3611.            stop the scan.
    3612. 

  3612. 

  3613. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#READ'>read</a> and <a href='#TEXTIN'>textin</a>.
    3614. 

  3614. <a name='SCREEN'></a>
    3615. 

  3615. 

  3616. </span><span style='color:#5F5'>         SCREEN
    3617. 

  3617. 

  3618. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #screen </span><span style='color:#FFF'>{</span><span style='color:#AAA'>option</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}
    3619. 

  3619. 

  3620.          </span><span style='color:#AAA'>The screen command offers a variety of screen manipulation
    3621. 

  3621.          commands and utilities.
    3622. 

  3622. 

  3623.          </span><span style='color:#FFF'>#screen blur
    3624. 

  3624.          </span><span style='color:#AAA'>  Move the terminal to the back of the stack.
    3625. 

  3625. 

  3626.          </span><span style='color:#FFF'>#screen clear [all|scroll region|square] &lt;args&gt;
    3627. 

  3627.          </span><span style='color:#AAA'>  Provide 4 arguments defining the top left and bottom right corner
    3628. 

  3628.            when erasing a square.
    3629. 

  3629. 

  3630.          </span><span style='color:#FFF'>#screen focus
    3631. 

  3631.          </span><span style='color:#AAA'>  Move the terminal to the front of the stack.
    3632. 

  3632. 

  3633.          </span><span style='color:#FFF'>#screen fullscreen [on|off]
    3634. 

  3634.          </span><span style='color:#AAA'>  Toggles fullscreen mode when used without an argument.
    3635. 

  3635. 

  3636.          </span><span style='color:#FFF'>#screen get &lt;option&gt; &lt;var&gt;
    3637. 

  3637.          </span><span style='color:#AAA'>  Get various screen options and save them to &lt;var&gt;. Use #screen
    3638. 

  3638.            get without an argument to see all available options.
    3639. 

  3639. 

  3640.          </span><span style='color:#FFF'>#screen info
    3641. 

  3641.          </span><span style='color:#AAA'>  Debugging information.
    3642. 

  3642. 

  3643.          </span><span style='color:#FFF'>#screen inputregion &lt;square&gt; [name]
    3644. 

  3644.          </span><span style='color:#AAA'>  Set the input region. The name argument is optional and can be
    3645. 

  3645.            used to create named RECEIVED INPUT [NAME] events.
    3646. 

  3646. 

  3647.          </span><span style='color:#FFF'>#screen load &lt;both|label|title&gt;
    3648. 

  3648.          </span><span style='color:#AAA'>  Reload the saved title, label, or both.
    3649. 

  3649. 

  3650.          </span><span style='color:#FFF'>#screen minimize &lt;on|off&gt;
    3651. 

  3651.          </span><span style='color:#AAA'>  Minimize with on, restore with off.
    3652. 

  3652. 

  3653.          </span><span style='color:#FFF'>#screen maximize [on|off]
    3654. 

  3654.          </span><span style='color:#AAA'>  Maximize with on, restore with off.
    3655. 

  3655. 

  3656.          </span><span style='color:#FFF'>#screen move &lt;height&gt; &lt;width&gt;
    3657. 

  3657.          </span><span style='color:#AAA'>  Move the upper left corner of the terminal to pixel coordinate.
    3658. 

  3658. 

  3659.          </span><span style='color:#FFF'>#screen raise &lt;event&gt;
    3660. 

  3660.          </span><span style='color:#AAA'>  This will raise several screen events with %1 and %2 arguments.
    3661. 

  3661. 

  3662.          </span><span style='color:#FFF'>#screen refresh
    3663. 

  3663.          </span><span style='color:#AAA'>  Terminal dependant, may do nothing.
    3664. 

  3664. 

  3665.          </span><span style='color:#FFF'>#screen rescale &lt;height&gt; &lt;width&gt;
    3666. 

  3666.          </span><span style='color:#AAA'>  Resize the screen to the given height and width in pixels.
    3667. 

  3667. 

  3668.          </span><span style='color:#FFF'>#screen resize &lt;rows&gt; &lt;cols&gt;
    3669. 

  3669.          </span><span style='color:#AAA'>  Resize the screen to the given height and width in characters.
    3670. 

  3670. 

  3671.          </span><span style='color:#FFF'>#screen save &lt;both|label|title&gt;
    3672. 

  3672.          </span><span style='color:#AAA'>  Save the title, label, or both.
    3673. 

  3673. 

  3674.          </span><span style='color:#FFF'>#screen scroll &lt;square&gt;
    3675. 

  3675.          </span><span style='color:#AAA'>  Set the scrolling region, changes the split setting.
    3676. 

  3676. 

  3677.          </span><span style='color:#FFF'>#screen set &lt;both|label|title&gt;
    3678. 

  3678.          </span><span style='color:#AAA'>  Set the title, label, or both. Only title works on Windows.
    3679. 

  3679. 

  3680.          </span><span style='color:#FFF'>#screen swap
    3681. 

  3681.          </span><span style='color:#AAA'>  Swap the input and scroll region.
    3682. 

  3682. 

  3683. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BELL'>bell</a>
    3684. 

  3684. <a name='SCREEN READER'></a>
    3685. 

  3685. 

  3686. </span><span style='color:#5F5'>         SCREEN READER
    3687. 

  3687. 

  3688. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #config </span><span style='color:#FFF'>{</span><span style='color:#AAA'>SCREEN READER</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>ON|OFF</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3689. 

  3689. 

  3690.          Screen reader mode is enabled by using #config screen on.  The main
    3691. 

  3691.          purpose of the screen reader mode is to report to servers that a
    3692. 

  3692.          screen reader is being used by utilizing the MTTS standard.  The MTTS
    3693. 

  3693.          specification is available at:
    3694. 

  3694. 

  3695.          http://tintin.sourceforge.net/protocols/mtts
    3696. 

  3696. 

  3697.          With the screen reader mode enabled TinTin++ will try to remove visual
    3698. 

  3698.          elements where possible.
    3699. 

  3699. 

  3700. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CONFIG'>config</a>
    3701. 

  3701. <a name='SCRIPT'></a>
    3702. 

  3702. 

  3703. </span><span style='color:#5F5'>         SCRIPT
    3704. 

  3704. 

  3705. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #script </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>shell command</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3706. 

  3706. 

  3707.          The script command works much like the system command except that it
    3708. 

  3708.          treats the generated echos as commands if no variable is provided.
    3709. 

  3709. 

  3710.          This is useful for running php, perl, ruby, and python scripts. You
    3711. 

  3711.          can run these scripts either from file or from within tintin if the
    3712. 

  3712.          scripting language allows this.
    3713. 

  3713. 

  3714.          If you provide a variable the output of the script is stored as a list.
    3715. 

  3715. 

  3716. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {ruby -e 'print &quot;#show hello world&quot;'}
    3717. 

  3717. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {python -c 'print &quot;#show hello world&quot;'}
    3718. 

  3718. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {php -r 'echo &quot;#show hello world&quot;'}
    3719. 

  3719. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {path} {pwd};#show The path is &dollar;path[1].
    3720. 

  3720. 

  3721. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#FORMAT'>format</a>, <a href='#FUNCTION'>function</a>, <a href='#LOCAL'>local</a>, <a href='#MATH'>math</a>, <a href='#REPLACE'>replace</a> and <a href='#VARIABLE'>variable</a>.
    3722. 

  3722. <a name='SEND'></a>
    3723. 

  3723. 

  3724. </span><span style='color:#5F5'>         SEND
    3725. 

  3725. 

  3726. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #send </span><span style='color:#FFF'>{</span><span style='color:#AAA'>text</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3727. 

  3727. 

  3728.          Sends the text directly to the server, useful if you want to start
    3729. 

  3729.          with an escape code.
    3730. 

  3730. 

  3731. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#TEXTIN'>textin</a>
    3732. 

  3732. <a name='SESSION'></a>
    3733. 

  3733. 

  3734. </span><span style='color:#5F5'>         SESSION
    3735. 

  3735. 

  3736. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #session </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>host</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>port</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>file</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3737. 

  3737. 

  3738.          Starts a telnet session with the given name, host, port, and optional
    3739. 

  3739.          file name. The name can be anything you want, except the name of an
    3740. 

  3740.          already existant session, a number, or the keywords '+' and '-'.
    3741. 

  3741. 

  3742.          If a file name is given the file is only read if the session succesfully
    3743. 

  3743.          connects.
    3744. 

  3744. 

  3745.          Without an argument #session shows the currently defined sessions.
    3746. 

  3746. 

  3747.          If you have more than one session, you can use the following commands:
    3748. 

  3748. 

  3749.          #session {-}        Switch to the previous session.
    3750. 

  3750.          #session {+}        Switch to the next session.
    3751. 

  3751.          #session {&lt;number&gt;} Switch to the given session. Session 0 is the
    3752. 

  3752.                              startup session, +1 the first, +2 the second, and
    3753. 

  3753.                              -1 is the last session. Sessions are (currently)
    3754. 

  3754.                              sorted in order of creation.
    3755. 

  3755.          #gts                Switch to the startup session. The name gts stands
    3756. 

  3756.                              for global tintin session.
    3757. 

  3757.          #ats                Switch to the active session. The name ats stands
    3758. 

  3758.                              for active tintin session.
    3759. 

  3759.                              not necessarily the calling session.
    3760. 

  3760.          #{name}             Activates to the session with the given name.
    3761. 

  3761.          #{name} {command}:  Executes a command with the given session without
    3762. 

  3762.                              changing the active session.
    3763. 

  3763.          @&lt;name&gt;{text}:      Parse text in the given session, substituting the
    3764. 

  3764.                              variables and functions, and print the result in
    3765. 

  3765.                              the current active session.
    3766. 

  3766. 

  3767.          The startup session is named 'gts' and can be used for relog scripts.
    3768. 

  3768.          Do keep in mind that tickers do not work in the startup session.
    3769. 

  3769. 

  3770. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {SESSION DISCONNECTED} {#gts #delay 10 #ses %0 tintin.net 4321}
    3771. 

  3771. 

  3772. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#PORT'>port</a>, <a href='#RUN'>run</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SNOOP'>snoop</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    3773. 

  3773. <a name='SESSIONNAME'></a>
    3774. 

  3774. 

  3775. </span><span style='color:#5F5'>         SESSIONNAME
    3776. 

  3776. 

  3777. </span><span style='color:#FFF'>Syntax</span><span style='color:#AAA'>: #[sessionname] </span><span style='color:#FFF'>{</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3778. 

  3778. 

  3779. You can create multiple sessions with the #session command. By default only one
    3780. 

  3780. session is active, meaning commands you input are executed in the active
    3781. 

  3781. session. While all sessions receive output, only output sent to the active
    3782. 

  3782. session is displayed.
    3783. 

  3783. 

  3784. When you create a session with the #session command you must specify a session
    3785. 

  3785. name, the session name, prepended with a hashtag, can be used to activate the
    3786. 

  3786. session when used without an argument. If an argument is given it will be
    3787. 

  3787. executed by that session as a command, the session will not be activated.
    3788. 

  3788. 

  3789. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #ses one tintin.net 23;#ses two tintin.net 23;#one;#two grin
    3790. 

  3790. 

  3791. This will create two sessions, the session that was created last (two in this
    3792. 

  3792. case) will be automatically activated upon creation. Using #one, session one is
    3793. 

  3793. activated. Using #two grin, the grin social will be executed by session two,
    3794. 

  3794. session one will remain the active session.
    3795. 

  3795. 

  3796. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#PORT'>port</a>, <a href='#RUN'>run</a>, <a href='#SESSION'>session</a>, <a href='#SNOOP'>snoop</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    3797. 

  3797. <a name='SHOWME'></a>
    3798. 

  3798. 

  3799. </span><span style='color:#5F5'>         SHOWME
    3800. 

  3800. 

  3801. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #show </span><span style='color:#FFF'>{</span><span style='color:#AAA'>string</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>row</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>col</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3802. 

  3802. 

  3803.          Display the string to the terminal, do not send to the server.  Useful
    3804. 

  3804.          for status, warnings, etc.  The {row} and col number are optional and
    3805. 

  3805.          work the same way as the row number of the #prompt trigger.
    3806. 

  3806. 

  3807.          Actions can be triggered by the show command. If you want to avoid
    3808. 

  3808.          this from happening use: #line ignore #show {&lt;string&gt;}.
    3809. 

  3809. 

  3810. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #tick {TICK} {#delay 50 #show 10 SECONDS TO TICK!!!} {60}
    3811. 

  3811. 

  3812. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: The #prompt helpfile contains more information on using the
    3813. 

  3813.          option {row} and {col} arguments.
    3814. 

  3814. 

  3815. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BUFFER'>buffer</a>, <a href='#DRAW'>draw</a>, <a href='#ECHO'>echo</a>, <a href='#GREP'>grep</a> and <a href='#PROMPT'>prompt</a>.
    3816. 

  3816. <a name='SNOOP'></a>
    3817. 

  3817. 

  3818. </span><span style='color:#5F5'>         SNOOP
    3819. 

  3819. 

  3820. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #snoop </span><span style='color:#FFF'>{</span><span style='color:#AAA'>session name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>on</span><span style='color:#FFF'>|</span><span style='color:#AAA'>off</span><span style='color:#FFF'>|</span><span style='color:#AAA'>scroll</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3821. 

  3821. 

  3822.          If there are multiple sessions active, this command allows you to
    3823. 

  3823.          monitor what is going on in the sessions that are not currently active.
    3824. 

  3824.          The line of text from other sessions will be prefixed by the session's
    3825. 

  3825.          name.
    3826. 

  3826. 

  3827.          You can toggle off snoop mode by executing #snoop a second time.
    3828. 

  3828. 

  3829.          By using the scroll argument you will snoop the session's scroll
    3830. 

  3830.          region which will overwrite the display of whichever session is active.
    3831. 

  3831.          You can change the size and location of a session's scroll region by
    3832. 

  3832.          using the #split and #screen scrollregion commands.
    3833. 

  3833. 

  3834. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#PORT'>port</a>, <a href='#RUN'>run</a>, <a href='#SESSION'>session</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    3835. 

  3835. <a name='SPEEDWALK'></a>
    3836. 

  3836. 

  3837. </span><span style='color:#5F5'>         SPEEDWALK
    3838. 

  3838. 

  3839.          SPEEDWALK V1
    3840. 

  3840. </span><span style='color:#AAA'>
    3841. 

  3841.          Speedwalking allows you to enter multiple directions without using
    3842. 

  3842.          semicolons. Directions should be prefixed with a number and will be
    3843. 

  3843.          executed the given number of times.
    3844. 

  3844. 

  3845.          You can enable speedwalking with #CONFIG {SPEEDWALK} {ON}.
    3846. 

  3846. 

  3847. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: Without speedwalk, you have to type:
    3848. 

  3848.          </span><span style='color:#FFF'>s;s;w;w;w;w;w;s;s;s;w;w;w;n;n;w
    3849. 

  3849.          </span><span style='color:#AAA'>With speedwalk, you only have to type:
    3850. 

  3850.          </span><span style='color:#FFF'>2s5w3s3w2nw
    3851. 

  3851. 

  3852.          </span><span style='color:#5F5'>SPEEDWALK V2
    3853. 

  3853. </span><span style='color:#AAA'>
    3854. 

  3854.          Modern MUDs have increasingly adopted the use of diagonal exits, like
    3855. 

  3855.          ne, nw, sw, and se. To make accomodations for this the #map and #path
    3856. 

  3856.          command no longer interpret nesw as a speedwalk and require this to
    3857. 

  3857.          be written as 1n1e1s1w, which then allows 2ne2e to execute ne;ne;e;e.
    3858. 

  3858. 

  3859.          Speedwalks entered on the input line continue to use the v1 system.
    3860. 

  3860. 

  3861. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #path unzip 3n1e2nw
    3862. 

  3862. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #map move 3ne1d
    3863. 

  3863. 

  3864. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALIAS'>alias</a>, <a href='#CURSOR'>cursor</a>, <a href='#HISTORY'>history</a>, <a href='#KEYPAD'>keypad</a>, <a href='#MACRO'>macro</a> and <a href='#TAB'>tab</a>.
    3865. 

  3865. <a name='SPLIT'></a>
    3866. 

  3866. 

  3867. </span><span style='color:#5F5'>         SPLIT
    3868. 

  3868. 

  3869. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #split </span><span style='color:#FFF'>{</span><span style='color:#AAA'>top bar</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>bottom bar</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>left bar</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>right bar</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>input bar</span><span style='color:#FFF'>}
    3870. 

  3870. </span><span style='color:#AAA'>
    3871. 

  3871.          This option requires for your terminal to support VT100 emulation.
    3872. 

  3872. 

  3873.          #split allows the creation of a top status bar, a left and right status
    3874. 

  3874.          bar, a scrolling region, a bottom status bar, and an input line.
    3875. 

  3875. 

  3876.          </span><span style='color:#0AA'>╭────────────────────────────────╮
    3877. 

  3877.          │</span><span style='color:#FFF'>            top bar      </span><span style='color:#0AA'>       │
    3878. 

  3878.          ├──────┬──────────────────┬──────┤
    3879. 

  3879.          │</span><span style='color:#FFF'> left </span><span style='color:#0AA'>│</span><span style='color:#FFF'>    scrolling     </span><span style='color:#0AA'>│</span><span style='color:#FFF'> right</span><span style='color:#0AA'>│
    3880. 

  3880.          │</span><span style='color:#FFF'> bar  </span><span style='color:#0AA'>│</span><span style='color:#FFF'>     region       </span><span style='color:#0AA'>│</span><span style='color:#FFF'>  bar </span><span style='color:#0AA'>│
    3881. 

  3881.          ├──────┴──────────────────┴──────┤
    3882. 

  3882.          │</span><span style='color:#FFF'>           bottom bar    </span><span style='color:#0AA'>       │
    3883. 

  3883.          ├────────────────────────────────┤
    3884. 

  3884.          │</span><span style='color:#FFF'>           input bar     </span><span style='color:#0AA'>       │
    3885. 

  3885.          ╰────────────────────────────────╯
    3886. 

  3886. </span><span style='color:#AAA'>
    3887. 

  3887.          By default the bottom status bar is filled with dashes --- and
    3888. 

  3888.          subsequently it is also known as the split line. The scrolling
    3889. 

  3889.          region is also known as the main screen and this is where all
    3890. 

  3890.          incoming text is displayed by default.
    3891. 

  3891. 

  3892.          If you use #split without an argument it will set the height of the
    3893. 

  3893.          top status bar to 0 lines and the bottom status bar to 1 line.
    3894. 

  3894. 

  3895.          If you use #split with one argument it will set the height of the top
    3896. 

  3896.          status bar to the given number of lines and the bottom status bar will
    3897. 

  3897.          be set to 1 line.
    3898. 

  3898. 

  3899.          If you use two arguments the first argument is the height of the top
    3900. 

  3900.          status bar and the second argument the height of the bottom status bar.
    3901. 

  3901. 

  3902.          The third and fourth argument are optional and default to 0.
    3903. 

  3903. 

  3904.          The fifth argument is optional and sets the size of the input bar, it
    3905. 

  3905.          defaults to 1.
    3906. 

  3906. 

  3907.          It is possible to use negative arguments in which case the bar width
    3908. 

  3908.          defines the minimum width of the scrolling region.
    3909. 

  3909. 

  3910. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #split 0 0
    3911. 

  3911.          This will create a split screen with just a scrolling region and an
    3912. 

  3912.          input line. Great for the minimalist.
    3913. 

  3913. 

  3914. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #split 1 1 0 -80
    3915. 

  3915.          This will create a split screen with a single line top and bottom
    3916. 

  3916.          bar. The left bar has a width of 0 while the right bar will be of
    3917. 

  3917.          variable width. If for example the screen is 100 columns wide, 80
    3918. 

  3918.          columns will be used for the scrolling region, leaving a right bar
    3919. 

  3919.          with a width of 20 columns.
    3920. 

  3920. 

  3921. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can display text on the split line(s) with the #prompt and
    3922. 

  3922.          #show {line} {row} commands.
    3923. 

  3923. 

  3924. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove split mode with the #unsplit command.
    3925. 

  3925. 

  3926. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ECHO'>echo</a>, <a href='#PROMPT'>prompt</a> and <a href='#SHOWME'>showme</a>.
    3927. 

  3927. <a name='SSL'></a>
    3928. 

  3928. 

  3929. </span><span style='color:#5F5'>         SSL
    3930. 

  3930. 

  3931. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #ssl </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>host</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>port</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>file</span><span style='color:#FFF'>}
    3932. 

  3932. 

  3933.          Starts a secure socket telnet session with the given name, host, port,
    3934. 

  3934.          and optional file name.
    3935. 

  3935. 

  3936. Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#PORT'>port</a>, <a href='#RUN'>run</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SNOOP'>snoop</a>, <a href='#SSL'>ssl</a> and <a href='#ZAP'>zap</a>.
    3937. 

  3937. <a name='STATEMENTS'></a>
    3938. 

  3938. 

  3939. </span><span style='color:#5F5'>         STATEMENTS
    3940. 

  3940. 

  3941. </span><span style='color:#AAA'>
    3942. 

  3942.          TinTin++ knows the following statements.
    3943. 

  3943. 

  3944.          #break
    3945. 

  3945.          #case {value} {true}
    3946. 

  3946.          #continue
    3947. 

  3947.          #default {commands}
    3948. 

  3948.          #else {commands}
    3949. 

  3949.          #elseif {expression} {true}
    3950. 

  3950.          #foreach {list} {variable} {commands}
    3951. 

  3951.          #if {expression} {true}
    3952. 

  3952.          #loop {min} {max} {variable} {commands}
    3953. 

  3953.          #parse {string} {variable} {commands}
    3954. 

  3954.          #return {value}
    3955. 

  3955.          #switch {expression} {commands}
    3956. 

  3956.          #while {expression} {commands}
    3957. 

  3957. 

  3958. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#COMMANDS'>commands</a>, <a href='#HELP'>help</a> and <a href='#INFO'>info</a>.
    3959. 

  3959. <a name='SUBSTITUTE'></a>
    3960. 

  3960. 

  3961. </span><span style='color:#5F5'>         SUBSTITUTE
    3962. 

  3962. 

  3963. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #substitute </span><span style='color:#FFF'>{</span><span style='color:#AAA'>text</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>new text</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>priority</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    3964. 

  3964. 

  3965.          Allows you to replace text from the server with the new text.
    3966. 

  3966. 

  3967.          The %1-%99 variables can be used to capture text and use it as part of
    3968. 

  3968.          the new output.
    3969. 

  3969. 

  3970.          Color codes can be used to color the new text, to restore the color to
    3971. 

  3971.          that of the original line the &lt;900&gt; color code can be used.
    3972. 

  3972. 

  3973.          If only one argument is given, all active substitutions that match the
    3974. 

  3974.          argument are displayed.  Wildcards can be used, see '#help regex' for
    3975. 

  3975.          additional information on that subject.
    3976. 

  3976. 

  3977.          If no argument is given, all subs are displayed.
    3978. 

  3978. 

  3979. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {Zoe} {ZOE}
    3980. 

  3980.          Any instance of Zoe will be replaced with ZOE.
    3981. 

  3981. 

  3982. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {~&bsol;e[0;34m} {&bsol;e[1;34m}
    3983. 

  3983.          Replace generic dark blue color codes with bright blue ones.
    3984. 

  3984. 

  3985. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {%1massacres%2} {&lt;018&gt;%1&lt;118&gt;MASSACRES&lt;018&gt;%2}
    3986. 

  3986.          Replaces all occurrences of 'massacres' with 'MASSACRES' in red.
    3987. 

  3987. 

  3988. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help action', for more information about triggers.
    3989. 

  3989. 

  3990. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help colors', for more information.
    3991. 

  3991. 

  3992. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a substitution with the #unsubstitute command.
    3993. 

  3993. 

  3994. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ACTION'>action</a>, <a href='#GAG'>gag</a>, <a href='#HIGHLIGHT'>highlight</a> and <a href='#PROMPT'>prompt</a>.
    3995. 

  3995. <a name='SUSPEND'></a>
    3996. 

  3996. 

  3997. </span><span style='color:#5F5'>         SUSPEND
    3998. 

  3998. 

  3999. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #cursor suspend
    4000. 

  4000. 

  4001.          Temporarily suspends tintin and returns you to your shell.  To
    4002. 

  4002.          return to tintin, type 'fg' at the shell prompt.
    4003. 

  4003. 

  4004.          While suspended your tintin sessions will freeze. To keep a
    4005. 

  4005.          suspended session running use the #detach command.
    4006. 

  4006. 

  4007. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#END'>end</a>
    4008. 

  4008. <a name='SWITCH'></a>
    4009. 

  4009. 

  4010. </span><span style='color:#5F5'>         SWITCH
    4011. 

  4011. 

  4012. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #switch </span><span style='color:#FFF'>{</span><span style='color:#AAA'>conditional</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>arguments</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4013. 

  4013. 

  4014.          The switch command works similar to the switch statement in other
    4015. 

  4015.          languages. When the 'switch' command is encountered its body is parsed
    4016. 

  4016.          and each 'case' command found will be compared to the conditional
    4017. 

  4017.          argument of the switch and executed if there is a match.
    4018. 

  4018. 

  4019.          When comparing strings both the switch and case arguments must be
    4020. 

  4020.          enclosed in quote characters.
    4021. 

  4021. 

  4022.          If the 'default' command is found and no 'case' statement has been
    4023. 

  4023.          matched the default command's argument is executed.
    4024. 

  4024. 

  4025. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #switch {1d4} {#case 1 cackle;#case 2 smile;#default giggle}
    4026. 

  4026. 

  4027. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#STATEMENTS'>statements</a>
    4028. 

  4028. <a name='SYSTEM'></a>
    4029. 

  4029. 

  4030. </span><span style='color:#5F5'>         SYSTEM
    4031. 

  4031. 

  4032. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #system </span><span style='color:#FFF'>{</span><span style='color:#AAA'>command</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4033. 

  4033. 

  4034.          Executes the command specified as a shell command.
    4035. 

  4035. 

  4036. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#DETACH'>detach</a>, <a href='#SCRIPT'>script</a> and <a href='#RUN'>run</a>.
    4037. 

  4037. <a name='TAB'></a>
    4038. 

  4038. 

  4039. </span><span style='color:#5F5'>         TAB
    4040. 

  4040. 

  4041. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #tab </span><span style='color:#FFF'>{</span><span style='color:#AAA'>word</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4042. 

  4042. 

  4043.          Adds a word to the tab completion list, alphabetically sorted.
    4044. 

  4044. 

  4045.          If no tabs are defined tintin will use the scrollback buffer for auto
    4046. 

  4046.          tab completion.
    4047. 

  4047. 

  4048.          Tabbing behavior can be modified with the #cursor tab command which
    4049. 

  4049.          by default is bound to the tab key.
    4050. 

  4050. 

  4051. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a tab with the #untab command.
    4052. 

  4052. 

  4053. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALIAS'>alias</a>, <a href='#CURSOR'>cursor</a>, <a href='#HISTORY'>history</a>, <a href='#KEYPAD'>keypad</a>, <a href='#MACRO'>macro</a> and <a href='#SPEEDWALK'>speedwalk</a>.
    4054. 

  4054. <a name='TEXTIN'></a>
    4055. 

  4055. 

  4056. </span><span style='color:#5F5'>         TEXTIN
    4057. 

  4057. 

  4058. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #textin </span><span style='color:#FFF'>{</span><span style='color:#AAA'>filename</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>delay</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4059. 

  4059. 

  4060.          Textin allows the user to read in a file, and send its contents
    4061. 

  4061.          directly to the server.  Useful for doing online creation, or message
    4062. 

  4062.          writing.
    4063. 

  4063. 

  4064.          The delay is in seconds and takes a floating point number which is
    4065. 

  4065.          cumulatively applied to each outgoing line.
    4066. 

  4066. 

  4067. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#SCAN'>scan</a> and <a href='#SEND'>send</a>.
    4068. 

  4068. <a name='TICKER'></a>
    4069. 

  4069. 

  4070. </span><span style='color:#5F5'>         TICKER
    4071. 

  4071. 

  4072. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #ticker </span><span style='color:#FFF'>{</span><span style='color:#AAA'>name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>interval in seconds</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4073. 

  4073. 

  4074.          Executes given command every # of seconds. Floating point precision
    4075. 

  4075.          for the interval is allowed. A ticker cannot fire more often than
    4076. 

  4076.          10 times per second.
    4077. 

  4077. 

  4078. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: Tickers don't work in the startup session.
    4079. 

  4079. 

  4080. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a ticker with the #unticker command.
    4081. 

  4081. 

  4082. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#DELAY'>delay</a> and <a href='#EVENT'>event</a>.
    4083. 

  4083. <a name='TIME'></a>
    4084. 

  4084. 

  4085. </span><span style='color:#5F5'>         TIME
    4086. 

  4086. 

  4087. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #format </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>%t</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4088. 

  4088. 

  4089.          The %t format specifier of the #format command allows printing dates
    4090. 

  4090.          using the strftime() format specifiers. By default the time stamp used
    4091. 

  4091.          is the current time, if you want to print a past or future date use:
    4092. 

  4092. 

  4093. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #format </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>%t</span><span style='color:#FFF'>} {{</span><span style='color:#AAA'>argument</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>epoch time</span><span style='color:#FFF'>}}</span><span style='color:#AAA'>
    4094. 

  4094. 

  4095.          The current epoch time value is obtained using #format {time} {%T}.
    4096. 

  4096. 

  4097.          When using %t the argument should contain strftime format specifiers.
    4098. 

  4098.          The output may differ depending on your locale.
    4099. 

  4099. 

  4100.          %a  Abbreviated name of the day of the week (mon ... sun).
    4101. 

  4101.          %A  Full name of the day of the week. (Monday ... Sunday)
    4102. 

  4102.          %b  Abbreviated name of the month (Jan ... Dec)
    4103. 

  4103.          %B  Full name of the month. (January ... December)
    4104. 

  4104.          %C  2 digit numeric century. (19 ... 20)
    4105. 

  4105.          %d  2 digit numeric day of the month (01 ... 31)
    4106. 

  4106.          %H  2 digit numeric 24-hour clock hour. (00 ... 23)
    4107. 

  4107.          %I  2 digit numeric 12-hour clock hour. (01 ... 12)
    4108. 

  4108.          %j  3 digit numeric day of the year (001 ... 366)
    4109. 

  4109.          %m  2 digit numeric month of the year (01 ... 12)
    4110. 

  4110.          %M  2 digit numeric minute of the hour (00 ... 59)
    4111. 

  4111.          %p  Abbreviated 12 hour clock period (AM ... PM)
    4112. 

  4112.          %P  Abbreviated 12 hour clock period (am ... pm)
    4113. 

  4113.          %S  2 digit numeric second of the minute (00 ...59
    4114. 

  4114.          %u  1 digit numeric day of the week (1 ... 7)
    4115. 

  4115.          %U  2 digit numeric Sunday week of the year (00 ... 53
    4116. 

  4116.          %w  1 digit numeric day of the week (0 ... 6)
    4117. 

  4117.          %W  2 digit numeric Monday week of the year (00 ... 53
    4118. 

  4118.          %y  2 digit numeric year. (70 ... 38)
    4119. 

  4119.          %Y  4 digit numeric year. (1970 ... 2038)
    4120. 

  4120.          %z  5 digit timezone offset. (-1200 ... +1400)
    4121. 

  4121.          %Z  Abbreviated name of the time zone.
    4122. 

  4122. 

  4123. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ECHO'>echo</a>, <a href='#EVENT'>event</a> and <a href='#FORMAT'>format</a>.
    4124. 

  4124. <a name='VARIABLE'></a>
    4125. 

  4125. 

  4126. </span><span style='color:#5F5'>         VARIABLE
    4127. 

  4127. 

  4128. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #variable </span><span style='color:#FFF'>{</span><span style='color:#AAA'>variable name</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>text to fill variable</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4129. 

  4129. 

  4130.          Variables differ from the %0-99 arguments in the fact that you can
    4131. 

  4131.          specify a full word as a variable, and they stay in memory for the
    4132. 

  4132.          full session unless they are changed.  They can be saved in the
    4133. 

  4133.          coms file, and can be set to different values if you have two or
    4134. 

  4134.          more sessions running at the same time.  Variables are global for
    4135. 

  4135.          each session and can be accessed by adding a &dollar; before the variable
    4136. 

  4136.          name.
    4137. 

  4137. 

  4138. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {target} {#var target %0}
    4139. 

  4139.          #alias {x}      {kick &dollar;target}
    4140. 

  4140. 

  4141.          The name of a variable must exist of only letters, numbers and
    4142. 

  4142.          underscores in order to be substituted.  If you do not meet these
    4143. 

  4143.          requirements do not panic, simply encapsulate the variable in braces:
    4144. 

  4144. 

  4145. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #variable {cool website} {http://tintin.sourceforge.net}
    4146. 

  4146.          #chat I was on &dollar;{cool website} yesterday!.
    4147. 

  4147. 

  4148.          Variables can be escaped by adding additional &dollar; signs.
    4149. 

  4149. 

  4150. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #var test 42;#showme &dollar;&dollar;test
    4151. 

  4151. 

  4152.          Variables can be nested using brackets:
    4153. 

  4153. 

  4154. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #var hp[self] 34;#var hp[target] 46
    4155. 

  4155. 

  4156.          You can see the first nest of a variable using &dollar;variable[+1] and the
    4157. 

  4157.          last nest using &dollar;variable[-1]. Using &dollar;variable[-2] will report the
    4158. 

  4158.          second last variable, and so on. To show all indices use *variable[].
    4159. 

  4159.          To show all values use &dollar;variable[%*] or a less generic regex. To show
    4160. 

  4160.          all values from index 2 through 4 use &dollar;variable[+2..4].
    4161. 

  4161. 

  4162.          Nested variables are also known as tables, table generally being used
    4163. 

  4163.          to refer to several variables nested within one specific variable.
    4164. 

  4164. 

  4165. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show {Targets starting with the letter A: &dollar;targets[A%*]
    4166. 

  4166. 

  4167.          To see the internal index of a variable use &amp;&lt;variable name&gt;. To see
    4168. 

  4168.          the size of a table you would use: &amp;targets[] or &amp;targets[%*]. A non
    4169. 

  4169.          existent nested variable will report itself as 0.
    4170. 

  4170. 

  4171. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show {Number of targets starting with A: &amp;targets[A%*]
    4172. 

  4172. 

  4173.          In some scripts you need to know the name of a nested variable. This
    4174. 

  4174.          is also known as the key, and you can get it using *variable. For
    4175. 

  4175.          example *target[+1]. To get the first variable's name use *{+1}.
    4176. 

  4176. 

  4177.          It's also possible to declare a table using brace notation. Using
    4178. 

  4178.          #var hp[self] 34 is the equivalent of #var {hp} {{self}{34}}. This
    4179. 

  4179.          also allows merging tables. #var hp[self] 34;#var hp[target] 46 is
    4180. 

  4180.          the equivalent of #var {hp} {{self}{34} {target}{46}} as well as
    4181. 

  4181.          #var {hp} {{self}{34}} {{target}{46}} or if you want to get creative
    4182. 

  4182.          the equivalent of #var hp[self] 34;#var {hp} {&dollar;hp} {{target}{46}}.
    4183. 

  4183. 

  4184. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a variable with the #unvariable command.
    4185. 

  4185. 

  4186. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CAT'>cat</a>, <a href='#FORMAT'>format</a>, <a href='#FUNCTION'>function</a>, <a href='#LOCAL'>local</a>, <a href='#MATH'>math</a>, <a href='#REPLACE'>replace</a> and <a href='#SCRIPT'>script</a>.
    4187. 

  4187. <a name='WHILE'></a>
    4188. 

  4188. 

  4189. </span><span style='color:#5F5'>         WHILE
    4190. 

  4190. 

  4191. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #while </span><span style='color:#FFF'>{</span><span style='color:#AAA'>conditional</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>commands</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4192. 

  4192. 

  4193.          This command works similar to a 'while' statement in other languages.
    4194. 

  4194. 

  4195.          When a 'while' command is encourated, the conditional is evaluated,
    4196. 

  4196.          and if TRUE (any non-zero result) the commands are executed. The
    4197. 

  4197.          'while' loop will be repeated indefinitely until the conditional is
    4198. 

  4198.          FALSE or the #BREAK or #RETURN commands are found.
    4199. 

  4199. 

  4200.          The 'while' statement is only evaluated if it is read, so you must
    4201. 

  4201.          nest it inside a trigger, like an alias or action.
    4202. 

  4202. 

  4203.          The conditional is evaluated exactly the same as in the 'math' command.
    4204. 

  4204. 

  4205. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #math cnt 0;#while {&dollar;cnt &lt; 20} {#math cnt &dollar;cnt + 1;say &dollar;cnt}
    4206. 

  4206. 

  4207. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help math', for more information.
    4208. 

  4208. 

  4209. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#STATEMENTS'>statements</a>
    4210. 

  4210. <a name='WRITE'></a>
    4211. 

  4211. 

  4212. </span><span style='color:#5F5'>         WRITE
    4213. 

  4213. 

  4214. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #write </span><span style='color:#FFF'>{</span><span style='color:#AAA'>&lt;filename&gt;</span><span style='color:#FFF'>} {</span><span style='color:#AAA'>[FORCE]</span><span style='color:#FFF'>}</span><span style='color:#AAA'>
    4215. 

  4215. 

  4216.          Writes all current actions, aliases, subs, highlights, and variables
    4217. 

  4217.          to a command file, specified by filename.
    4218. 

  4218. 

  4219.          By default you cannot write to .map files to prevent accidentally
    4220. 

  4220.          overwriting a map file. Use the FORCE argument to ignore this
    4221. 

  4221.          protection.
    4222. 

  4222. 

  4223. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#LOG'>log</a>, <a href='#READ'>read</a>, <a href='#SCAN'>scan</a> and <a href='#TEXTIN'>textin</a>.
    4224. 

  4224. <a name='ZAP'></a>
    4225. 

  4225. 

  4226. </span><span style='color:#5F5'>         ZAP
    4227. 

  4227. 

  4228. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #zap {[session]}
    4229. 

  4229. 

  4230.          Kill your current session.  If there is no current session, it will
    4231. 

  4231.          cause the program to terminate. If you provide an argument it'll zap
    4232. 

  4232.          the given session instead.
    4233. 

  4233. 

  4234. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ALL'>all</a>, <a href='#PORT'>port</a>, <a href='#RUN'>run</a>, <a href='#SESSION'>session</a>, <a href='#SESSIONNAME'>sessionname</a>, <a href='#SNOOP'>snoop</a> and <a href='#SSL'>ssl</a>.
    4235.