help.html 281 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv='content-type' content='text/html; charset=utf-8'>
  5. <meta name='viewport' content='width=device-width, initial-scale=1.0'>
  6. <style type='text/css'>
  7. body {font-family:Consolas;font-size:12pt}
  8. a {text-decoration:none}
  9. a:link {color:#06b}
  10. a:visited {color:#6b0}
  11. a:hover {text-decoration:underline}
  12. a:active {color:#b06}
  13. </style>
  14. <body bgcolor='#000000'>
  15. </head>
  16. <pre>
  17. <span style='background-color:#000'><span style='color:#FFF'>
  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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <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. <a href='#SUBSTITUTIONS'> SUBSTITUTIONS</a> <a href='#SUSPEND'> SUSPEND</a> <a href='#SWITCH'> SWITCH</a> <a href='#SYSTEM'> SYSTEM</a> <a href='#TAB'> TAB</a>
  37. <a href='#TEXTIN'> TEXTIN</a> <a href='#TICKER'> TICKER</a> <a href='#TIME'> TIME</a> <a href='#VARIABLE'> VARIABLE</a> <a href='#WHILE'> WHILE</a>
  38. <a href='#WRITE'> WRITE</a> <a href='#ZAP'> ZAP</a>
  39. <a name='ACTION'></a>
  40. </span><span style='color:#5F5'> ACTION
  41. </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'>
  42. The #action command can be used to respond with one or several
  43. commands to a specific message send by the server. The %1-%99
  44. variables are substituted from the message and can be used in the
  45. command part of the action.
  46. If the message starts with a ~ color codes must be matched. You can
  47. enable #config {convert meta} on to display meta characters.
  48. For more information on pattern matching see the section on PCRE.
  49. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {%1 tells you '%2'} {tell %1 I'm afk.}
  50. Actions can be triggered by the #show command. If you don't want a
  51. #show to get triggered use: #line ignore #show {text}
  52. Actions are ordered alphabetically and only one action can trigger at
  53. a time. To change the order you can assign a priority, which defaults
  54. to 5, with a lower number indicating a higher priority. The priority
  55. can be a floating point number and should be between 1 and 9.
  56. To remove an action with %* as the message, use #unaction {%%*} or
  57. #unaction {&bsol;%*}. Alternatively you could wrap the action inside a
  58. class, and kill that class when you no longer need the action.
  59. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove an action with the #unaction command.
  60. </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>.
  61. <a name='ALIAS'></a>
  62. </span><span style='color:#5F5'> ALIAS
  63. </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'>
  64. The #alias command can be used to shorten up long or oftenly used
  65. commands. The %1-99 variables are substituted from the arguments when
  66. using an alias and represent the 1st till 99th word which can be used
  67. in the commands part of the alias. If %0 is used it will contain all
  68. arguments. The priority part is optional and determines the priority
  69. of the alias, it defaults to 5.
  70. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {k} {kill %1;kick}
  71. Typing 'k orc' would result in attacking the orc followed by a kick.
  72. You can create multi-word aliases by using variables in the name
  73. section.
  74. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {k %1 with %2} {draw %2;attack %1;slash %1 with %2;
  75. kick at %2;strike %1 with %2}
  76. Using the above alias you could type k blue smurf with battle axe
  77. To have an alias that matches all user input, use %* as the name.
  78. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {%*} {#show You wrote: %0}
  79. Aliases are ordered alphabetically and only one alias can trigger at
  80. a time. To change the order you can assign a priority, which defaults
  81. to 5, with a lower number indicating a higher priority. The priority
  82. can be a floating point number.
  83. To remove an alias with %* as the name, use #unalias {%%*} or #unalias
  84. {&bsol;%*}. Alternatively you can wrap the alias inside a class, and kill
  85. that class when you no longer need the alias.
  86. For more information on pattern matching see the section on PCRE.
  87. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove an alias with the #unalias command.
  88. </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>.
  89. <a name='ALL'></a>
  90. </span><span style='color:#5F5'> ALL
  91. </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'>
  92. If you have multiple sessions in one terminal you can use #all to
  93. execute the command with all sessions, excluding the startup session.
  94. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #all quit
  95. Sends 'quit' to all sessions.
  96. </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>.
  97. <a name='BELL'></a>
  98. </span><span style='color:#5F5'> BELL
  99. </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'>
  100. The #bell command without an argument will ring the terminal bell.
  101. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {Bubba tells you} {#bell}
  102. If you aren't watching the screen this could be useful if you don't
  103. want to miss out on a conversation with Bubba. Alternatively you can
  104. use #system to play a sound file.
  105. Some terminals will allow you to use VT100 Operating System Commands
  106. to change the terminal's bell behavior which can be used to flash the
  107. taskbar icon and or focus the window on receival of a bell.
  108. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {Bubba tells you} {#screen save title;#screen set title Tell!;
  109. #bell ring;#delay 10 #screen load title}
  110. The above example will save your window title, change the title to
  111. 'Tell!', ring the bell, next reset the window title after 10 seconds.
  112. It's possible to set the terminal to pop to the foreground upon
  113. ringing of the alarm bell.
  114. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #bell focus on;#bell ring;#bell focus off
  115. It's possible to adjust the alarm bell volume on some terminals.
  116. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop {1} {8} {cnt} {#line substitute variables
  117. #delay {&dollar;cnt} {#show Volume &dollar;cnt: #bell volume &dollar;cnt;#bell}
  118. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#SCREEN'>screen</a>
  119. <a name='BREAK'></a>
  120. </span><span style='color:#5F5'> BREAK
  121. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #break
  122. The break command can be used inside the #else, #elseif, #if, #foreach,
  123. #loop, #parse, #switch, and #while statements. When #break is found,
  124. tintin will stop executing the statement it is currently in and move on
  125. to the next.
  126. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #while {1} {#math cnt &dollar;cnt + 1;#if {&dollar;cnt == 20} {#break}}
  127. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#STATEMENTS'>statements</a>
  128. <a name='BUFFER'></a>
  129. </span><span style='color:#5F5'> BUFFER
  130. </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'>
  131. The buffer command has various options to manipulate your scrollback
  132. buffer.
  133. The size of the scrollback buffer can be configured using #config
  134. buffer_size &lt;size&gt;. The size must be either 100, 1000, 10000, 100000
  135. or 1000000 lines.
  136. While scrolling through the scrollback buffer incoming text is not
  137. displayed, this can be disabled using #config scroll_lock off. The
  138. scroll lock is automatically disabled when manual input is received,
  139. subsequently #buffer up and down only work properly when used in a
  140. macro or mouse event.
  141. </span><span style='color:#FFF'>#buffer {clear} {[lower bound]} {[upper bound]}
  142. </span><span style='color:#AAA'>
  143. Without an argument this will clear the entire scrollback buffer.
  144. Otherwise it will clear the given range.
  145. Positive numbers are measured from the start of the scrollback buffer,
  146. negative numbers from the end.
  147. </span><span style='color:#FFF'>#buffer {down} [lines]
  148. </span><span style='color:#AAA'>
  149. Moves your scrollback buffer down one page and displays the page. If
  150. a line number is provided it will scroll down the given number of
  151. lines.
  152. </span><span style='color:#FFF'>#buffer {end}
  153. </span><span style='color:#AAA'>
  154. Moves you to the end of your scrollback buffer and displays the page.
  155. Disables scroll lock mode. Most useful when used in a #macro.
  156. </span><span style='color:#FFF'>#buffer {find} {[number]} {&lt;string&gt;} {[variable]}
  157. </span><span style='color:#AAA'>
  158. Moves the buffer to the given string which can contain a regular
  159. expression. Optionally you can provide the number of matches to skip,
  160. allowing you to jump further back in the buffer.
  161. A positive number searches from the start of the buffer, a negative
  162. number from the end. If you provide a variable the location will be
  163. stored and no jump takes place.
  164. </span><span style='color:#FFF'>#buffer {get} {&lt;variable&gt;} {&lt;lower bound&gt;} {[upper bound]}
  165. </span><span style='color:#AAA'>
  166. Allows you to store one or several lines from your scrollback buffer
  167. (including color codes) into a variable. The lower and upper bound
  168. must be between 1 and the size of the buffer. If the upper bound is
  169. omitted the given line is stored as a standard variable. If an upper
  170. bound is given the lines between the two bounds are stored as a list.
  171. Positive numbers are measured from the start of the scrollback buffer,
  172. negative numbers from the end.
  173. </span><span style='color:#FFF'>#buffer {home}
  174. </span><span style='color:#AAA'>
  175. Moves you to the top of your scrollback buffer and displays the page.
  176. Enables scroll lock mode. Most useful when used in a #macro.
  177. </span><span style='color:#FFF'>#buffer {info} {[save]} {[variable]}
  178. </span><span style='color:#AAA'>
  179. Display buffer info, optionally save the data to a variable.
  180. </span><span style='color:#FFF'>#buffer {jump} {&lt;location&gt;}
  181. </span><span style='color:#AAA'>
  182. Moves the buffer to the given location. A positive number jumps from
  183. the start of the buffer, a negative number from the end.
  184. </span><span style='color:#FFF'>#buffer {lock} {on|off}
  185. </span><span style='color:#AAA'>
  186. Toggles the lock on the scrollback buffer. When locked, newly incoming
  187. text won't be displayed, any command will disable the lock, though
  188. several buffer commands will re-enable the lock. When unlocking it'll
  189. move you to the end of your scrollback buffer and display the page.
  190. </span><span style='color:#FFF'>#buffer {refresh}
  191. </span><span style='color:#AAA'>
  192. Marks the buffer as needing to be refreshed, only useful while in
  193. vertical split mode.
  194. </span><span style='color:#FFF'>#buffer {up} [lines]
  195. </span><span style='color:#AAA'>
  196. Moves your scrollback buffer up one page and displays the page.
  197. Enables scroll lock mode. Most useful when used in a #macro. You
  198. can use #buffer {up} {1} to move the scrollback buffer up 1 line.
  199. </span><span style='color:#FFF'>#buffer {write} {&lt;filename&gt;}
  200. </span><span style='color:#AAA'>
  201. Writes the scrollback buffer to the given file.
  202. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {&bsol;e[F} {#buffer end}
  203. </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>.
  204. <a name='BUTTON'></a>
  205. </span><span style='color:#5F5'> BUTTON
  206. </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'>
  207. The #button command can be used to respond with one or several
  208. commands to a mouse click received within the specified square.
  209. The click coordinates are stored in %0-%3 and can be used in the
  210. command part of the button.
  211. The square part should exists of two coordinates defining the
  212. upper left and bottom right corner using row, col, row, col syntax.
  213. The square arguments should be separated by spaces, semi-colons or
  214. braces.
  215. By default the button is set to respond to a mouse button press, to
  216. respond to other button presses you must add a 5th argument to the
  217. square that defines the button press type. You can enable #info
  218. button on to see button events and their type as they happen.
  219. The priority part is optional and determines the priority of the
  220. button, it defaults to 5.
  221. You must enable #config {mouse tracking} on for buttons to work.
  222. This command draws no visible button, you'll have to do so separately
  223. if needed.
  224. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #button {1;1;2;2} {#show You clicked the upper left corner.}
  225. Buttons are ordered alphabetically and only one button can trigger at
  226. a time. To change the order you can assign a priority, which defaults
  227. to 5, with a lower number indicating a higher priority. The priority
  228. can be a floating point number.
  229. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: To see button clicks trigger use #info button on.
  230. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a button with the #unbutton command.
  231. </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>.
  232. <a name='CASE'></a>
  233. </span><span style='color:#5F5'> CASE
  234. </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'>
  235. The case command must be used within the #switch command. When the
  236. conditional argument of the case command matches the conditional
  237. argument of the switch command the body of the case is executed.
  238. When comparing strings both the switch and case arguments must be
  239. surrounded in quotes.
  240. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>:
  241. #function {reverse_direction}
  242. {
  243. #switch {&quot;%1&quot;}
  244. {
  245. #case {&quot;north&quot;} {#return south};
  246. #case {&quot;east&quot;} {#return west};
  247. #case {&quot;south&quot;} {#return north};
  248. #case {&quot;west&quot;} {#return east};
  249. #case {&quot;up&quot;} {#return down};
  250. #case {&quot;down&quot;} {#return up}
  251. }
  252. }
  253. This function returns the reverse direction. @reverse_direction{north}
  254. would return south.
  255. </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>.
  256. <a name='CAT'></a>
  257. </span><span style='color:#5F5'> CAT
  258. </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'>
  259. The cat command will concatinate the argument to the given variable.
  260. </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>.
  261. <a name='CHARACTERS'></a>
  262. </span><span style='color:#5F5'> CHARACTERS
  263. </span><span style='color:#AAA'>
  264. The following special characters are defined:
  265. # The hashtag is the default character for starting a command and is
  266. subsequently known as the command character or tintin character.
  267. When loading a command file the command character is set to the
  268. first character in the file. The character can also be redefined
  269. using #config.
  270. ; The semi-colon is used as the command separator and can be used to
  271. separate two commands. Multiple commands can be strung together as
  272. well. Trailing semi-colons are ignored when reading a script file
  273. as this is a common error.
  274. { } Curly brackets aka braces are used for separating multi word command
  275. arguments, nesting commands, and nesting variables. Braces cannot
  276. easily be escaped and must always be used in pairs.
  277. &quot; &quot; Quote characters are used for strings in the #math, #if, #switch,
  278. and #case commands. It is however suggested to use a set of braces
  279. { } to define strings instead, particularly when checking strings
  280. that may contain quotes.
  281. ! The exclamation sign is used to repeat commands, see #help history.
  282. The character can be redefined using #config.
  283. &bsol; An input line starting with a backslash is send verbatim if you are
  284. connected to a server. This character can be configured with
  285. #config, and is itself send verbatim when the verbatim config mode
  286. is enabled.
  287. </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>.
  288. <a name='CHAT'></a>
  289. </span><span style='color:#5F5'> CHAT
  290. </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'>}
  291. </span><span style='color:#AAA'>
  292. The #chat command is used to create peer to peer connections to other
  293. clients, typically for the purpose of chatting and sending files.
  294. This is a decentralized chat system, meaning you have to exchange ip
  295. addresses and port numbers with other users in order to connect to
  296. them.
  297. </span><span style='color:#FFF'>#chat {init} {port}
  298. </span><span style='color:#AAA'> #chat initialize launches your chat server. The port number is
  299. optional, and by default 4050 is used as your port. After using
  300. this command other people can connect to your chat server using
  301. your ip address and port number, and in turn you can connect to
  302. other people.
  303. </span><span style='color:#FFF'>#chat {name} {name}
  304. </span><span style='color:#AAA'> By default your name is set to TinTin, but most servers will
  305. reject you if there is already someone with the name TinTin
  306. connected, so one of the first things you'd want to do is
  307. change your chat name. Your name can include color codes. Some
  308. names aren't accepted by tt++ chat servers, like the name 'all'
  309. and names longer than 20 characters.
  310. </span><span style='color:#FFF'>#chat {message} {buddy|all} {text}
  311. </span><span style='color:#AAA'> This is the main command used for communication. If you use
  312. #chat message all, the message is marked as public and send to
  313. everyone you are connected to.
  314. </span><span style='color:#FFF'>#chat {accept} {buddy} {boost}
  315. </span><span style='color:#AAA'> Accept a file transfer from a buddy. The boost is optional and
  316. must be a value between 1 and 1000.
  317. </span><span style='color:#FFF'>#chat {call} {address} {port}
  318. </span><span style='color:#AAA'> #chat call is used to connect to another chat server. If you
  319. omit the port argument the default port (4050) is used.
  320. </span><span style='color:#FFF'>#chat {cancel} {buddy} Cancel a file transfer
  321. #chat {color} {color names} Set the default color
  322. #chat {decline} {buddy} Decline a file transfer
  323. #chat {dnd} Decline new connections
  324. #chat {download} {directory} Set your download directory
  325. #chat {emote} {buddy|all} {text} Send an emote message
  326. #chat {forward} {buddy} Forward all chat messages
  327. #chat {forwardall} {buddy} Forward all session output
  328. #chat {filestat} {buddy} Show file transfer data
  329. #chat {group} {buddy} {name} Assign a chat group
  330. #chat {ignore} {buddy} Ignores someone
  331. #chat {info} Displays your info
  332. #chat {ip} {address} Changes your IP address
  333. #chat {paste} {buddy|all} {text} Pastes a block of text
  334. #chat {peek} {buddy} Show one's public connections
  335. #chat {ping} {buddy} Display response time
  336. #chat {private} {buddy|all} Make a connection private
  337. #chat {public} {buddy|all} Make a connection public
  338. #chat {reply} {text} Reply to last private message
  339. #chat {request} {buddy} Request one's public connections
  340. #chat {send} {buddy|all} {text} Sends a raw data string
  341. #chat {sendfile} {buddy} {filename} Start a file transfer
  342. #chat {serve} {buddy} Forward all public chat messages
  343. #chat {uninitialize} Uninitialize the chat port.
  344. #chat {who} Show all connections
  345. </span><span style='color:#AAA'> #chat who shows all people you are connected to. The first
  346. column shows a reference number for the connection, which can be
  347. used instead of the connection's name when sending someone a message
  348. The second column shows the connection's name. The third column
  349. shows flags set for the connection, (P)rivate, (I)gnore, (S)erve,
  350. (F)orward to user, and (f)orward from user. The next columns show
  351. ip, port, and client name.
  352. </span><span style='color:#FFF'>#chat {zap} {buddy} Close a connection
  353. Related</span><span style='color:#AAA'>: <a href='#PORT'>port</a>
  354. <a name='CLASS'></a>
  355. </span><span style='color:#5F5'> CLASS
  356. </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'>
  357. </span><span style='color:#FFF'>#class {&lt;name&gt;} {assign} {&lt;argument&gt;}
  358. </span><span style='color:#AAA'> Will execute argument with the given class opened.
  359. </span><span style='color:#FFF'>#class {&lt;name&gt;} {clear}
  360. </span><span style='color:#AAA'> Will delete all triggers associated with the given class.
  361. </span><span style='color:#FFF'>#class {&lt;name&gt;} {close}
  362. </span><span style='color:#AAA'> Close the given class, opening the last open class, if any.
  363. </span><span style='color:#FFF'>#class {&lt;name&gt;} {kill}
  364. </span><span style='color:#AAA'> Will clear, close, and remove the class.
  365. </span><span style='color:#FFF'>#class {&lt;name&gt;} {list}
  366. </span><span style='color:#AAA'> List all triggers associated with the given class.
  367. </span><span style='color:#FFF'>#class {&lt;name&gt;} {load}
  368. </span><span style='color:#AAA'> Will load the saved copy of the class from memory.
  369. </span><span style='color:#FFF'>#class {&lt;name&gt;} {open}
  370. </span><span style='color:#AAA'> Open a class, closing a previously opened class. All triggers
  371. added afterwards are assigned to this class.
  372. </span><span style='color:#FFF'>#class {&lt;name&gt;} {read} {&lt;filename&gt;
  373. </span><span style='color:#AAA'> Will open the class, read the file, and close afterwards.
  374. </span><span style='color:#FFF'>#class {&lt;name&gt;} {save}
  375. </span><span style='color:#AAA'> Will save all triggers of the given class to memory.
  376. </span><span style='color:#FFF'>#class {&lt;name&gt;} {size} {&lt;variable&gt;}
  377. </span><span style='color:#AAA'> Will store the size of the class in a variable.
  378. </span><span style='color:#FFF'>#class {&lt;name&gt;} {write} {&lt;filename&gt;}
  379. </span><span style='color:#AAA'> Will write all triggers of the given class to file.
  380. Keep in mind that the kill and read option are very fast allowing
  381. them to be used to enable and disable classes.
  382. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #class extra kill;#class extra read extra.tin
  383. Deletes all triggers of 'extra' class if any. Read 'extra.tin' file,
  384. all triggers loaded will be assigned to the fresh new 'extra' class.
  385. </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>.
  386. <a name='COLORS'></a>
  387. </span><span style='color:#5F5'> COLORS
  388. </span><span style='color:#FFF'>Syntax</span><span style='color:#AAA'>: &lt;xyz&gt; with x, y, z being parameters
  389. Parameter 'x': VT100 code
  390. 0 - Reset all colors and codes to default
  391. 1 - Bold
  392. 2 - Dim
  393. 3 - Italic
  394. 4 - Underscore
  395. 5 - Blink
  396. 7 - Reverse
  397. 8 - Skip (use previous code)
  398. Parameter 'y': Foreground color
  399. Parameter 'z': Background color
  400. 0 - Black 5 - Magenta
  401. 1 - Red 6 - Cyan
  402. 2 - Green 7 - White
  403. 3 - Yellow 8 - Skip
  404. 4 - Blue 9 - Default
  405. For xterm 256 colors support use &lt;aaa&gt; to &lt;fff&gt; for RGB foreground
  406. colors and &lt;AAA&gt; to &lt;FFF&gt; for RGB background colors. For the grayscale
  407. foreground colors use &lt;g00&gt; to &lt;g23&gt;, for grayscale background colors
  408. use &lt;G00&gt; to &lt;G23&gt;.
  409. The tertiary colors are as follows:
  410. &lt;acf&gt; - Azure &lt;afc&gt; - Jade
  411. &lt;caf&gt; - Violet &lt;cfa&gt; - Lime
  412. &lt;fac&gt; - Pink &lt;fca&gt; - Orange
  413. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show &lt;acf&gt;Azure &lt;afc&gt;Jade &lt;caf&gt;Violet
  414. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show &lt;cfa&gt;Lime &lt;fac&gt;Pink &lt;fca&gt;Orange
  415. For 12 bit truecolor use &lt;F000&gt; to &lt;FFFF&gt; for foreground colors and
  416. &lt;B000&gt; to &lt;BFFF&gt; for background colors.
  417. For 24 bit truecolor use &lt;F000000&gt; to &lt;FFFFFFF&gt; for foreground
  418. colors and &lt;B000000&gt; to &lt;BFFFFFF&gt; for background colors.
  419. If the color code exceeds your configured color mode it will be
  420. downgraded to the closest match.
  421. </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>.
  422. <a name='COMMANDS'></a>
  423. </span><span style='color:#5F5'> COMMANDS
  424. </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'>}
  425. </span><span style='color:#AAA'>
  426. Shows all commands or all commands matching the given search
  427. string.
  428. </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>.
  429. <a name='COORDINATES'></a>
  430. </span><span style='color:#5F5'> COORDINATES
  431. </span><span style='color:#AAA'>
  432. When the 0,0 coordinate is in the upper left corner TinTin++ uses
  433. a y,x / row,col notation, starting at 1,1. Subsequently -1,-1
  434. will indicate the bottom right corner. This type of argument is
  435. used by the #showme command.
  436. When the 0,0 coordinate is in the bottom left corner tintin uses
  437. a standard x,y notation. This type of argument is used by the
  438. #map jump command.
  439. The vast majority of tintin commands use y,x / row,col notation,
  440. primarily because that is the notation used by the VT100 standard
  441. used for terminal emulation.
  442. </span><span style='color:#5F5'>Squares
  443. </span><span style='color:#AAA'>
  444. A square argument takes 2 coordinates. The first coordinate defines
  445. the upper left corner, the last coordinate defines the bottom
  446. right corner. The upper left corner of the terminal is defined as
  447. 1,1 and the bottom right corner as -1,-1. This type of argument is
  448. used by #draw, #button and #map offset.
  449. </span><span style='color:#5F5'>Panes
  450. </span><span style='color:#AAA'>
  451. A pane argument takes 4 size values, which are: top pane, bottom
  452. pane, left pane, right pane. When a negative value is provided the
  453. size is the maximum size, minus the value. This type of argument
  454. is used by the #split command.
  455. </span><span style='color:#5F5'>Ranges
  456. </span><span style='color:#AAA'>
  457. A range argument takes 2 values known as the upper bound and lower
  458. bound. The upper bound (first value) defines the start of the
  459. range, the lower bound (second value) the end. The first index of
  460. a range is defined as 1. When a negative value is provides the last
  461. index is defined as -1. This type of argument is used by #buffer
  462. and #variable.
  463. </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>.
  464. <a name='CONFIG'></a>
  465. </span><span style='color:#5F5'> CONFIG
  466. </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'>
  467. This allows you to configure various settings, the settings can be
  468. written to file with the #write command.
  469. If you configure the global session (the one you see as you start up
  470. tintin) all sessions started will inherite these settings.
  471. It's advised to make a configuration file to read on startup if you
  472. do not like the default settings.
  473. Use #config without an argument to see your current configuration as
  474. well as a brief explanation of each config option.
  475. The following config options are not listed by default:
  476. #CONFIG {CHILD LOCK} {ON|OFF} Enable or disable command input.
  477. #CONFIG {CONVERT META} {ON|OFF} Shows color codes and key bindings.
  478. #CONFIG {DEBUG TELNET} {ON|OFF} Shows telnet negotiations y/n.
  479. #CONFIG {LOG LEVEL} {LOW|HIGH} LOW logs server output before triggers.
  480. #CONFIG {INHERITANCE} {ON|OFF} Session trigger inheritance y/n.
  481. #CONFIG {MCCP} {ON|OFF} Enable or disable MCCP support.
  482. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a> and <a href='#LINE'>line</a>.
  483. <a name='CONTINUE'></a>
  484. </span><span style='color:#5F5'> CONTINUE
  485. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #continue
  486. The continue command can be used inside the #FOREACH, #LOOP, #PARSE,
  487. #WHILE and #SWITCH commands. When #CONTINUE is found, tintin will go
  488. to the end of the command and proceed as normal, which may be to
  489. reiterate the command.
  490. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop 1 10 cnt {#if {&dollar;cnt % 2 == 0} {#continue} {say &dollar;cnt}}
  491. </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>.
  492. <a name='CR'></a>
  493. </span><span style='color:#5F5'> CR
  494. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #cr
  495. Sends a carriage return to the session. Useful for aliases that need
  496. extra carriage returns.
  497. This command is obsolete as you can accomplish the same using #send
  498. without an argument or #send {}.
  499. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#FORALL'>forall</a>
  500. <a name='CURSOR'></a>
  501. </span><span style='color:#5F5'> CURSOR
  502. </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'>
  503. Typing #cursor without an option will show all available cursor
  504. options, their default binding, and an explanation of their function.
  505. The cursor command's primarly goal is adding customizable input editing
  506. with macros. Subsequently many cursor commands only work properly when
  507. used within a macro or event.
  508. </span><span style='color:#FFF'>#cursor flag
  509. </span><span style='color:#AAA'>EOL end of line character(s)
  510. ECHO local echo
  511. OVERTYPE overtype mode
  512. </span><span style='color:#FFF'>#cursor macro
  513. </span><span style='color:#AAA'>PRESERVE do not erase the macro from the macro input buffer
  514. RESET erase the macro input buffer
  515. </span><span style='color:#FFF'>#cursor tab
  516. </span><span style='color:#AAA'>CASELESS makes tab completion caseless
  517. COMPLETE makes tab completion work while editing
  518. DICTIONARY performs tab completion on the dictionary
  519. LIST performs tab completion on the tab completion list
  520. SCROLLBACK performs tab completion on the scrollback buffer
  521. BACKWARD specifies tab completion to go backward
  522. FORWARD specifies tab completion to go forward
  523. Multiple options can/must be specified at once.
  524. </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>.
  525. <a name='DAEMON'></a>
  526. </span><span style='color:#5F5'> DAEMON
  527. </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'>]
  528. </span><span style='color:#AAA'>#daemon provides functionality similar to that of the screen and tmux
  529. utilities.
  530. </span><span style='color:#FFF'>#daemon attach [name]
  531. </span><span style='color:#AAA'> The attach option will try to find a daemonized tintin instance and
  532. take over control. The name argument is optional.
  533. </span><span style='color:#FFF'>#daemon detach [name]
  534. </span><span style='color:#AAA'> The detach option will daemonize tintin, turning it into a background
  535. process. The name argument is optional and is useful if you have
  536. several daemonized tt++ instances running so you can keep them apart.
  537. </span><span style='color:#FFF'>#daemon kill [name]
  538. </span><span style='color:#AAA'> Kills all daemons or daemons with matching name.
  539. </span><span style='color:#FFF'>#daemon list [name]
  540. </span><span style='color:#AAA'> List all daemons or daemons with matching name.
  541. You can launch tintin and attach the first daemonized instance using
  542. tt++ -R. To attach a named instance use tt++ -R&lt;name&gt;.
  543. </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>.
  544. <a name='DEBUG'></a>
  545. </span><span style='color:#5F5'> DEBUG
  546. </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'>
  547. Toggles a list on or off. With no argument it shows your current
  548. settings, as well as the list names that you can debug.
  549. If you for example set ACTIONS to ON you will get debug information
  550. whenever an action is triggered.
  551. #debug {listname} {log} will silently write debugging information to
  552. the log file, you must be logging in order for this to work.
  553. Not every list has debug support yet.
  554. </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>.
  555. <a name='DEFAULT'></a>
  556. </span><span style='color:#5F5'> DEFAULT
  557. </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'>
  558. The default command can only be used within the switch command. When
  559. the conditional argument of non of the case commands matches the switch
  560. command's conditional statement the default command is executed.
  561. </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>.
  562. <a name='DELAY'></a>
  563. </span><span style='color:#5F5'> DELAY
  564. </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'>
  565. </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'>
  566. Delay allows you to have tintin wait the given amount of seconds
  567. before executing the given command.
  568. Nanosecond floating point precision is allowed. Delays will fire in
  569. 0.01 second intervals.
  570. Named delays are treated as one-shot tickers, see #help tick.
  571. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #delay {1} {#show last};#show first
  572. This will print 'first', and 'last' around one second later.
  573. </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
  574. a name as the first argument, be aware this changes the syntax. If
  575. the name is a number keep in mind that delays with the same numeric
  576. name will not be overwritten
  577. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#EVENT'>event</a> and <a href='#TICKER'>ticker</a>.
  578. <a name='DRAW'></a>
  579. </span><span style='color:#5F5'> DRAW
  580. </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'>}
  581. </span><span style='color:#AAA'>
  582. The draw commands allows you to draw various types of lines and shapes
  583. on the screen. The types with a brief description are provided when you
  584. type #draw without an argument.
  585. The &lt;square&gt; arguments should exists of two coordinates defining the
  586. upper left and bottom right corner using row, col, row, col syntax.
  587. The square arguments can be negative, in which case the coordinates
  588. are calculated from the opposite side of the screen. In the case the
  589. screen is 80 columns wide using #draw box 1 60 10 70 will be the
  590. equivalent of #draw box 1 -21 10 -11, but with different screen
  591. widths the boxes would be drawn in different places.
  592. You can prefix the option with a color code or color name to color the
  593. lines and shapes.
  594. You can further prefix the option as following:
  595. ASCII will draw in ASCII mode.
  596. BALIGN will bottom align text.
  597. BLANKED will blank the lines and corners.
  598. BOTTOM will draw on the bottom side if possible.
  599. BOXED will draw a box along the square.
  600. BUMPED will precede the draw with an enter.
  601. CALIGN will center text.
  602. CIRCLED will circle the corners.
  603. CONVERT will draw text with meta conversion.
  604. CROSSED will cross the corners.
  605. CURSIVE will draw text with cursive letters.
  606. FAT will draw text with fat letters.
  607. FILLED will fill circles and jewels.
  608. FOREGROUND will draw even if session is not active.
  609. GRID will draw TABLE as a grid.
  610. HORIZONTAL will draw horizontal if possible.
  611. HUGE will draw text in huge letters.
  612. JEWELED will diamond the corners.
  613. JOINTED will draw corners.
  614. LALIGN will left align text.
  615. LEFT will draw on the left side if possible.
  616. NUMBERED will draw numbers instead of lines.
  617. PRUNED will prune the corners.
  618. RALIGN will right align text.
  619. RIGHT will draw on the right side if possible.
  620. ROUNDED will round the corners.
  621. SANSSERIF will draw text with sansserif letters.
  622. SCALED will fit the square to the text size.
  623. SCROLL will draw in the scrolling region.
  624. SHADOWED will shadow HUGE text.
  625. TALIGN will top align text too large to fit.
  626. TEED will tee the corners.
  627. TOP will draw on the top side if possible.
  628. TRACED will trace HUGE text.
  629. TUBED will draw tubes instead of lines.
  630. UALIGN will unwrap and rewrap text.
  631. UNICODE will draw in unicode mode.
  632. VERTICAL will draw vertical if possible.
  633. The following types are available.
  634. [HORIZONTAL] </span><span style='color:#FFF'>BAR</span><span style='color:#AAA'> {&lt;MIN&gt;;&lt;MAX&gt;;[COLOR]}
  635. will draw a bar, use two 256 color codes for a color gradient.
  636. [ASCII|UNICODE|HUGE] </span><span style='color:#FFF'>BOX</span><span style='color:#AAA'> {[TEXT1]} {[TEXT2]}
  637. will draw a box.
  638. [BOXED|FOREGROUND] </span><span style='color:#FFF'>BUFFER
  639. </span><span style='color:#AAA'> will draw the scrollback buffer.
  640. [BLANKED|CIRCLED|CROSSED|JEWELED|ROUNDED|TEED|PRUNED] </span><span style='color:#FFF'>CORNER
  641. </span><span style='color:#AAA'> will draw a corner.
  642. [BLANKED|HORIZONTAL|NUMBERED|TUBED|VERTICAL] </span><span style='color:#FFF'>LINE</span><span style='color:#AAA'> {[TEXT]}
  643. will draw a line.
  644. [BOXED] </span><span style='color:#FFF'>MAP
  645. </span><span style='color:#AAA'> will draw the map
  646. </span><span style='color:#FFF'>RAIN</span><span style='color:#AAA'> {&lt;VARIABLE&gt;} {[SPAWN]} {[FADE]} {[LEGEND]}
  647. will draw digital rain.
  648. [JOINTED|TOP|LEFT|BOTTOM|RIGHT] </span><span style='color:#FFF'>SIDE
  649. </span><span style='color:#AAA'> will draw one or more sides of a box.
  650. [GRID] </span><span style='color:#FFF'>TABLE</span><span style='color:#AAA'> {[LIST1]} {[LIST2]}
  651. will draw a table.
  652. [CURSIVE|FAT|HUGE|SANSSERIF] </span><span style='color:#FFF'>TILE</span><span style='color:#AAA'> {[TEXT1]} {[TEXT2]}
  653. will draw a tile
  654. All draw types take an optional text argument as long as a valid
  655. square with enough space has been defined. Text is automatically
  656. word wrapped and text formatting can be customized with the
  657. CALIGN, LALIGN, RALIGN, and UALIGN options.
  658. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #draw Blue box 1 1 3 20 {Hello world!}
  659. </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>.
  660. <a name='ECHO'></a>
  661. </span><span style='color:#5F5'> ECHO
  662. </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'>
  663. Echo command displays text on the screen with formatting options. See
  664. the help file for the format command for more information.
  665. The echo command does not trigger actions.
  666. As with the #show command you can split the {format} argument up into
  667. two braced arguments, in which case the 2nd argument is the row number.
  668. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #echo {The current date is %t.} {%Y-%m-%d %H:%M:%S}
  669. #echo {[%38s][%-38s]} {Hello World} {Hello World}
  670. #echo {{this is %s on the top row} {1}} {printed}
  671. </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>.
  672. <a name='EDIT'></a>
  673. </span><span style='color:#5F5'> EDIT
  674. #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'>
  675. The edit command can be used to turn the default line editor into a
  676. text editor.
  677. </span><span style='color:#FFF'>#edit create &lt;arguments&gt;</span><span style='color:#AAA'>
  678. Create an editor, initialize using the provided arguments.
  679. </span><span style='color:#FFF'>#edit load &lt;variable&gt;</span><span style='color:#AAA'>
  680. Create an editor, initialize using the provided list variable.
  681. </span><span style='color:#FFF'>#edit read &lt;filename&gt;</span><span style='color:#AAA'>
  682. Create an editor, initialize using the provided file.
  683. </span><span style='color:#FFF'>#edit resume</span><span style='color:#AAA'>
  684. Resume editing after a suspension.
  685. </span><span style='color:#FFF'>#edit save &lt;variable&gt;</span><span style='color:#AAA'>
  686. Save the editor to the provided variable.
  687. </span><span style='color:#FFF'>#edit suspend</span><span style='color:#AAA'>
  688. Suspend editing, similar to pressing enter except that no
  689. events are triggered.
  690. </span><span style='color:#FFF'>#edit write &lt;filename</span><span style='color:#AAA'>
  691. Write the editor content to file.
  692. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #edit create {bli}{bla}{blo}
  693. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CURSOR'>cursor</a> and <a href='#MACRO'>macro</a>.
  694. <a name='EDITING'></a>
  695. </span><span style='color:#5F5'> EDITING
  696. </span><span style='color:#AAA'>
  697. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  698. </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'>
  699. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  700. </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'>
  701. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  702. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  703. </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'>
  704. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  705. </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'>
  706. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  707. </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'>
  708. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  709. </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'>
  710. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  711. </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'>
  712. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  713. </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'>
  714. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  715. </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'>
  716. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  717. </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'>
  718. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  719. </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'>
  720. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  721. </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'>
  722. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  723. </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'>
  724. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  725. </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'>
  726. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  727. </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'>
  728. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  729. </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'>
  730. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  731. </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'>
  732. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  733. </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'>
  734. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  735. </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'>
  736. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  737. </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'>
  738. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  739. </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'>
  740. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  741. </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'>
  742. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  743. </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'>
  744. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  745. </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'>
  746. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  747. </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'>
  748. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  749. </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'>
  750. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  751. </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'>
  752. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  753. </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'>
  754. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  755. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  756. </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'>
  757. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  758. </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'>
  759. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  760. </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'>
  761. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  762. </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'>
  763. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  764. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  765. </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'>
  766. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  767. </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'>
  768. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  769. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  770. </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'>
  771. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  772. </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'>
  773. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  774. </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'>
  775. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  776. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  777. </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'>
  778. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  779. </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'>
  780. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  781. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  782. </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'>
  783. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  784. </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'>
  785. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  786. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  787. </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'>
  788. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  789. </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'>
  790. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  791. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  792. </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'>
  793. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  794. </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'>
  795. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  796. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  797. </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'>
  798. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  799. </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'>
  800. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  801. </span><span style='color:#0AA'>┌─────────────────────────┐┌────────────────────────────────────────────┐</span><span style='color:#AAA'>
  802. </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'>
  803. </span><span style='color:#0AA'>├─────────────────────────┤├────────────────────────────────────────────┤</span><span style='color:#AAA'>
  804. </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'>
  805. </span><span style='color:#0AA'>└─────────────────────────┘└────────────────────────────────────────────┘</span><span style='color:#AAA'>
  806. </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>.
  807. <a name='ELSE'></a>
  808. </span><span style='color:#5F5'> ELSE
  809. </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'>
  810. The else statement should follow an #IF or #ELSEIF statement and is
  811. only called if the proceeding #IF or #ELSEIF is false.
  812. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #if {1d2 == 1} {smile};#else {grin}
  813. </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>.
  814. <a name='ELSEIF'></a>
  815. </span><span style='color:#5F5'> ELSEIF
  816. </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'>
  817. The elseif statement should follow an #IF or #ELSEIF statement and is
  818. only called when the statement is true and the proceeding #IF and
  819. #ELSEIF statements are false.
  820. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #if {1d3 == 1} {smirk};#elseif {1d2 == 1} {snicker}
  821. </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>.
  822. <a name='END'></a>
  823. </span><span style='color:#5F5'> END
  824. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #end {&lt;message&gt;}
  825. Terminates tintin and return to unix. On most systems, ctrl-c has
  826. the same result.
  827. The message is optional and is printed before tintin exits. When
  828. using #end {&bsol;} tintin will terminate silently.
  829. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#ZAP'>zap</a>
  830. <a name='ESCAPE CODES'></a>
  831. </span><span style='color:#5F5'> ESCAPE CODES
  832. </span><span style='color:#AAA'> You may use the escape character &bsol; for various special characters.
  833. &bsol;a beep the terminal.
  834. &bsol;c send a control character, &bsol;ca for ctrl-a.
  835. &bsol;e start an escape sequence.
  836. &bsol;f send a form feed.
  837. &bsol;n send a line feed.
  838. &bsol;r send a carriage return.
  839. &bsol;t send a horizontal tab.
  840. &bsol;x print an 8 bit character using hexadecimal, &bsol;xFF for example.
  841. &bsol;x7B send the '{' character.
  842. &bsol;x7D send the '}' character.
  843. &bsol;u print a 16 bit unicode character, &bsol;uFFFD for example.
  844. &bsol;u{} print a 8-21 bit unicode character, &bsol;u{2AF21} for example.
  845. &bsol;U print a 21 bit unicode character, &bsol;U02AF21 for example.
  846. &bsol;v send a vertical tab
  847. Ending a line with &bsol; will stop tintin from appending a line feed.
  848. To escape arguments in an alias or action use %%0 %%1 %%2 etc.
  849. </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>.
  850. <a name='EVENT'></a>
  851. </span><span style='color:#5F5'> EVENT
  852. </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'>
  853. Events allow you to create triggers for predetermined client events.
  854. Use #event without an argument to see a list of possible events with
  855. a brief description. Use #event %* to see the current list of defined
  856. events. Use #info {events} {on} to see events get thrown.
  857. Events, like triggers in general, are case sensitive and event names
  858. must be defined using all upper case letters. Only one event can be
  859. defined for each event type.
  860. To enable mouse events use #config mouse_tracking on, to see mouse
  861. events use #config mouse_tracking info.
  862. </span><span style='color:#5F5'>CATCH EVENTS
  863. </span><span style='color:#FFF'>CATCH &lt;EVENT&gt;
  864. </span><span style='color:#AAA'> Some events can be prefixed with CATCH to interrupt default
  865. behavior.
  866. </span><span style='color:#5F5'>CLASS EVENTS
  867. </span><span style='color:#FFF'>CLASS ACTIVATED [CLASS], CLASS_CLEAR [CLASS], CLASS CREATED [CLASS],
  868. CLASS DEACTIVATED [CLASS], CLASS DESTROYED [CLASS],
  869. CLASS_LOAD [CLASS]
  870. </span><span style='color:#AAA'> %0 class name
  871. </span><span style='color:#5F5'>GAG EVENTS
  872. </span><span style='color:#FFF'>GAG &lt;EVENT&gt;
  873. </span><span style='color:#AAA'> Some events can be prefixed with GAG to gag default system
  874. messages.
  875. </span><span style='color:#5F5'>INPUT EVENTS</span><span style='color:#AAA'>
  876. </span><span style='color:#FFF'>EDIT STARTED, EDIT FINISHED
  877. </span><span style='color:#AAA'> %0 name %1 lines %2 size %3 data
  878. </span><span style='color:#FFF'>RECEIVED KEYPRESS, PROCESSED KEYPRESS
  879. </span><span style='color:#AAA'> %0 character %1 unicode index %2 edit row %3 edit column
  880. </span><span style='color:#FFF'>RECEIVED INPUT [NAME]
  881. </span><span style='color:#AAA'> %0 raw text
  882. </span><span style='color:#FFF'>RECEIVED INPUT CHARACTER
  883. </span><span style='color:#AAA'> %0 character %1 unicode index %2 size %3 width
  884. SEND OUTPUT %0 raw text %1 size
  885. SENT OUTPUT %0 raw text %1 size
  886. </span><span style='color:#5F5'>MAP EVENTS
  887. </span><span style='color:#FFF'>END OF PATH, END OF RUN, MAP UPDATED VTMAP
  888. </span><span style='color:#AAA'> These events have no additional arguments.
  889. </span><span style='color:#FFF'>MAP CREATE EXIT, MAP DELETE EXIT
  890. </span><span style='color:#AAA'> %0 vnum %1 exit name %2 exit cmd %3 exit vnum
  891. </span><span style='color:#FFF'>MAP CREATE ROOM, MAP DELETE ROOM
  892. </span><span style='color:#AAA'> %0 vnum %1 name
  893. </span><span style='color:#FFF'>MAP ENTER MAP, MAP EXIT MAP
  894. </span><span style='color:#AAA'> %0 vnum
  895. </span><span style='color:#FFF'>MAP ENTER ROOM [VNUM]
  896. </span><span style='color:#AAA'> %0 new vnum %1 old vnum %2 direction
  897. </span><span style='color:#FFF'>MAP EXIT ROOM [VNUM]
  898. </span><span style='color:#AAA'> %0 old vnum %1 new vnum %2 direction
  899. </span><span style='color:#FFF'>MAP FOLLOW MAP
  900. </span><span style='color:#AAA'> %0 old vnum %1 new vnum %2 exit name
  901. </span><span style='color:#FFF'>MAP REGION &lt;MOUSE&gt;, MAP ROOM &lt;MOUSE&gt;
  902. </span><span style='color:#AAA'> %0 row %1 col %2 -row %3 -col %5 vnum %6 info
  903. </span><span style='color:#5F5'>MOUSE EVENTS</span><span style='color:#AAA'>
  904. DOUBLE-CLICKED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  905. LONG-CLICKED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  906. MOVED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  907. PRESSED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  908. SHORT-CLICKED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  909. RELEASED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  910. SCROLLED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  911. TRIPLE-CLICKED &lt;MOUSE&gt; %0 row %1 col %2 -row %3 -col %4 word %5 line
  912. </span><span style='color:#FFF'>MAP &lt;MOUSE EVENT&gt;
  913. </span><span style='color:#AAA'> Mouse events can be prefixed with MAP to only trigger when the mouse
  914. event occurs inside the VT100 map region.
  915. </span><span style='color:#FFF'>SWIPED [DIR]
  916. </span><span style='color:#AAA'> %0 dir %1 button %2 row %3 col %4 -row %5 -col
  917. %6 row %7 col %8 -row %9 -col %10 rows %11 cols
  918. </span><span style='color:#5F5'>OUTPUT EVENTS
  919. </span><span style='color:#FFF'>BUFFER UPDATE, DISPLAY UPDATE
  920. </span><span style='color:#AAA'> These events have no additional arguments.
  921. RECEIVED LINE %0 raw text %1 plain text
  922. RECEIVED OUTPUT %0 raw text
  923. RECEIVED PROMPT %0 raw text %1 plain text
  924. </span><span style='color:#5F5'>PORT EVENTS
  925. </span><span style='color:#FFF'>CHAT MESSAGE, PORT MESSAGE
  926. </span><span style='color:#AAA'> %0 raw text %1 plain text
  927. </span><span style='color:#FFF'>PORT CONNECTION </span><span style='color:#AAA'>%0 name %1 ip %2 port
  928. </span><span style='color:#FFF'>PORT DISCONNECTION </span><span style='color:#AAA'>%0 name %1 ip %2 port
  929. </span><span style='color:#FFF'>PORT LOG MESSAGE </span><span style='color:#AAA'>%0 name %1 ip %2 port %3 data %4 plain data
  930. </span><span style='color:#FFF'>PORT RECEIVED MESSAGE </span><span style='color:#AAA'>%0 name %1 ip %2 port %3 data %4 plain data
  931. </span><span style='color:#5F5'>SCAN EVENTS</span><span style='color:#AAA'>
  932. SCAN CSV HEADER %0 all args %1 arg1 %2 arg2 .. %99 arg99
  933. SCAN CSV LINE %0 all args %1 arg1 %2 arg3 .. %99 arg99
  934. SCAN TSV HEADER %0 all args %1 arg1 %2 arg3 .. %99 arg99
  935. SCAN TSV LINE %0 all args %1 arg1 %2 arg3 .. %99 arg99
  936. </span><span style='color:#5F5'>SCREEN EVENTS</span><span style='color:#AAA'>
  937. </span><span style='color:#FFF'>SCREEN FOCUS
  938. </span><span style='color:#AAA'> %0 focus (0 or 1)
  939. SCREEN LOCATION %0 rows %1 cols %2 height %3 width
  940. </span><span style='color:#FFF'>SCREEN MOUSE LOCATION
  941. </span><span style='color:#AAA'> %0 row %1 col %2 -row %3 -col %4 pix row %5 pix col
  942. %6 -pix row %7 -pix col %8 location
  943. SCREEN RESIZE %0 rows %1 cols %2 height %3 width
  944. SCREEN SPLIT %0 top row %1 top col %2 bot row %3 bot col
  945. SCREEN UNSPLIT %0 top row %1 top col %2 bot row %3 bot col
  946. </span><span style='color:#5F5'>SESSION EVENTS</span><span style='color:#AAA'>
  947. SESSION ACTIVATED %0 name
  948. SESSION CONNECTED %0 name %1 host %2 ip %3 port %4 file
  949. SESSION CREATED %0 name %1 host %2 ip %3 port %4 file
  950. SESSION DEACTIVATED %0 name
  951. SESSION DISCONNECTED %0 name %1 host %2 ip %3 port
  952. SESSION TIMED OUT %0 name %1 host %2 ip %3 port
  953. </span><span style='color:#5F5'>SYSTEM EVENTS</span><span style='color:#AAA'>
  954. DAEMON ATTACHED %0 file %1 pid
  955. DAEMON DETACHED %0 file %1 pid
  956. PROGRAM START %0 startup arguments
  957. PROGRAM TERMINATION %0 goodbye message
  958. READ ERROR %0 filename %1 error message
  959. READ FILE %0 filename
  960. WRITE ERROR %0 filename %1 error message
  961. WRITE FILE %0 filename
  962. SYSTEM CRASH %0 message
  963. SYSTEM ERROR %0 name %1 system msg %2 error %3 error msg
  964. UNKNOWN COMMAND %0 raw text
  965. SIGUSR %0 signal
  966. </span><span style='color:#5F5'>TELNET EVENTS
  967. </span><span style='color:#FFF'>IAC &lt;EVENT&gt;
  968. </span><span style='color:#AAA'> IAC TELNET events are made visable using #config telnet info.
  969. </span><span style='color:#FFF'>IAC SB GMCP [MODULE] %0 module %1 data %2 plain data
  970. IAC SB MSSP %0 variable %1 data
  971. IAC SB MSDP %0 variable %1 data %2 plain data
  972. IAC SB MSDP [VAR] %0 variable %1 data %2 plain data
  973. IAC SB NEW-ENVIRON %0 variable %1 data %2 plain data
  974. IAC SB ZMP &lt;VAR&gt; %0 variable %1 data
  975. IAC SB &lt;VAR&gt; %0 variable %1 raw data %2 plain data
  976. </span><span style='color:#5F5'>TIME EVENTS
  977. </span><span style='color:#FFF'>DATE &lt;MONTH-DAY OF MONTH&gt; [HOUR:MINUTE], DAY [DAY OF MONTH],
  978. HOUR [HOUR], MONTH [DAY OF MONTH], TIME &lt;HOUR:MINUTE&gt;[:SECOND],
  979. WEEK [DAY OF WEEK], YEAR [YEAR]
  980. </span><span style='color:#AAA'> %0 year %1 month %2 day of week %3 day of month %4 hour
  981. %5 minute %6 second
  982. </span><span style='color:#5F5'>VARIABLE EVENTS</span><span style='color:#AAA'>
  983. VARIABLE UPDATE &lt;VAR&gt; %0 name %1 new value %2 path
  984. VARIABLE UPDATED &lt;VAR&gt; %0 name %1 new value %2 path
  985. </span><span style='color:#5F5'>VT100 EVENTS</span><span style='color:#AAA'>
  986. VT100 SCROLL REGION %0 top row %1 bot row %2 rows %3 cols %4 wrap
  987. To see all events trigger use #event info on. Since this can get
  988. rather spammy it's possible to gag event info messages.
  989. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {SESSION CONNECTED} {#read mychar.tin}
  990. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove an event with the #unevent command.
  991. </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>.
  992. <a name='FOREACH'></a>
  993. </span><span style='color:#5F5'> FOREACH
  994. </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'>
  995. For each item in the provided list the foreach statement will update
  996. the given variable and execute the command part of the statement. List
  997. elements must be separated by braces or semicolons.
  998. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #foreach {bob;tim;kim} {name} {tell &dollar;name Hello}
  999. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #foreach {{bob}{tim}{kim}} {name} {tell &dollar;name Hello}
  1000. </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>.
  1001. <a name='FORMAT'></a>
  1002. </span><span style='color:#5F5'> FORMAT
  1003. </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'>
  1004. Allows you to store a string into a variable in the exact same way
  1005. C's sprintf works with a few enhancements and limitations like a
  1006. maximum of 30 arguments.
  1007. If you use #format inside an alias or action you must escape %1s as
  1008. %+1s or %%1s or %&bsol;1s so the %1 isn't substituted by the trigger.
  1009. #format {test} {%+9s} {string} pad string with up to 9 spaces
  1010. #format {test} {%-9s} {string} post pad string with up to 9 spaces
  1011. #format {test} {%.8s} {string} copy at most 8 characters
  1012. #format {test} {%a} {number} print corresponding charset character
  1013. #format {test} {%c} {string} use a highlight color name
  1014. #format {test} {%d} {number} print a number with integer formatting
  1015. #format {test} {%f} {string} perform floating point math
  1016. #format {test} {%g} {number} perform thousand grouping on {number}
  1017. #format {test} {%h} {string} turn text into a header line
  1018. #format {test} {%l} {string} lowercase text
  1019. #format {test} {%m} {string} perform mathematical calculation
  1020. #format {test} {%n} {name} capitalize the first letter
  1021. #format {test} {%p} {string} strip leading and trailing spaces
  1022. #format {test} {%r} {string} reverse text, hiya = ayih
  1023. #format {test} {%s} {string} print given string
  1024. #format {test} {%t} {format} display time with strftime format
  1025. optional {{format}{time}} syntax
  1026. #format {test} {%u} {string} uppercase text
  1027. #format {list} {%w} {string} store word wrapped text in {list}
  1028. optional {{string}{width}} syntax
  1029. #format {test} {%x} {hex} print corresponding charset character
  1030. #format {test} {%A} {char} store corresponding character value
  1031. #format {test} {%D} {hex} convert hex to decimal in {test}
  1032. #format {hash} {%H} {string} store a 64 bit string hash in {hash}
  1033. #format {test} {%L} {string} store the string length in {test}
  1034. #format {test} {%M} {number} convert number to metric in {test}
  1035. #format {test} {%S} {string} store the number of spelling errors
  1036. #format {time} {%T} {} store the epoch time in {time}
  1037. #format {time} {%U} {} store the micro epoch time in {time}
  1038. #format {test} {%X} {dec} convert dec to hexadecimal in {test}
  1039. #format {test} {%%} a literal % character
  1040. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See #help TIME for help on the %t argument.
  1041. </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>.
  1042. <a name='FUNCTION'></a>
  1043. </span><span style='color:#5F5'> FUNCTION
  1044. </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'>
  1045. Functions allow you to execute a script within a line of text, and
  1046. replace the function call with the line of text generated by the
  1047. function.
  1048. Be aware that each function should use the #return command at the
  1049. end of the function with the result, or set the {result} variable.
  1050. To use a function use the @ character before the function name.
  1051. The function arguments should be placed between braces behind the
  1052. function name with argument separated by semicolons.
  1053. Functions can be escaped by adding additional @ signs.
  1054. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function test #return 42;#showme @@test{}
  1055. The function itself can use the provided arguments which are stored
  1056. in %1 to %99, with %0 holding all arguments.
  1057. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function {rnd} {#math {result} {1 d (%2 - %1 + 1) + %1 - 1}}
  1058. #show A random number between 100 and 200: @rnd{100;200}
  1059. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function gettime {#format result %t %H:%M}
  1060. #show The current time is @gettime{}
  1061. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a function with the #unfunction command.
  1062. </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>.
  1063. <a name='GAG'></a>
  1064. </span><span style='color:#5F5'> GAG
  1065. </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'>
  1066. Removes any line that contains the string.
  1067. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help action', for more information about triggers.
  1068. There are a system messages that can be gagged using gag events.
  1069. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a gag with the #ungag command.
  1070. </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>.
  1071. <a name='GREETING'></a>
  1072. </span><span style='color:#5F5'> GREETING
  1073. </span><span style='color:#0AA'> ####################################################################
  1074. #</span><span style='color:#AAA'> </span><span style='color:#0AA'>#
  1075. #</span><span style='color:#AAA'> T I N T I N + + 2.02.13b </span><span style='color:#0AA'>#
  1076. #</span><span style='color:#AAA'> </span><span style='color:#0AA'>#
  1077. #</span><span style='color:#AAA'> Code by Peter Unold, Bill Reis, and Igor van den Hoven </span><span style='color:#0AA'>#
  1078. #</span><span style='color:#AAA'> </span><span style='color:#0AA'>#
  1079. ####################################################################
  1080. <a name='GREP'></a>
  1081. </span><span style='color:#5F5'> GREP
  1082. </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'>
  1083. This command allows you to search for matching lines in your scroll
  1084. back buffer. The amount of matches shown equals your screen size. If
  1085. you want to search back further use the optional page number. You can
  1086. use wildcards for better search results. Be aware the search string
  1087. is case sensitive, which can be disabled by using %i.
  1088. By default grep searches from the end of the scrollback buffer to the
  1089. beginning, this can be reversed by using a negative page number.
  1090. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #grep Bubba tells you
  1091. This will show all occasions where bubba tells you something.
  1092. </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>.
  1093. <a name='HELP'></a>
  1094. </span><span style='color:#5F5'> HELP
  1095. </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'>
  1096. Without an argument #help will list all available help subjects.
  1097. Using #help %* will display all help entries.
  1098. </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>.
  1099. <a name='HIGHLIGHT'></a>
  1100. </span><span style='color:#5F5'> HIGHLIGHT
  1101. </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'>
  1102. The highlight command is used to allow you to highlight strings of text.
  1103. Available color options are:
  1104. reset - resets the color state to default
  1105. light - turns the color light in 16 color mode.
  1106. dark - turns the color dark in 16 color mode.
  1107. underscore - underscores the text.
  1108. blink - makes the text blink.
  1109. reverse - reverse foreground and background color.
  1110. b - makes next color the background color.
  1111. Available color names are:
  1112. &lt;F06B&gt; - azure &lt;F08F&gt; - Azure
  1113. &lt;F00B&gt; - blue &lt;F00F&gt; - Blue
  1114. &lt;F0BB&gt; - cyan &lt;F0FF&gt; - Cyan
  1115. &lt;F000&gt; - ebony &lt;F666&gt; - Ebony
  1116. &lt;F0B0&gt; - green &lt;F0F0&gt; - Green
  1117. &lt;F0B6&gt; - jade &lt;F0F8&gt; - Jade
  1118. &lt;F6B0&gt; - lime &lt;F8F0&gt; - Lime
  1119. &lt;FB0B&gt; - magenta &lt;FF0F&gt; - Magenta
  1120. &lt;FB60&gt; - orange &lt;FF80&gt; - Orange
  1121. &lt;FB06&gt; - pink &lt;FF08&gt; - Pink
  1122. &lt;FB00&gt; - red &lt;FF00&gt; - Red
  1123. &lt;F888&gt; - silver &lt;FDDD&gt; - Silver
  1124. &lt;F860&gt; - tan &lt;FDB0&gt; - Tan
  1125. &lt;F60B&gt; - violet &lt;F80F&gt; - Violet
  1126. &lt;FBBB&gt; - white &lt;FFFF&gt; - White
  1127. &lt;FBB0&gt; - yellow &lt;FFF0&gt; - Yellow
  1128. The %1-99 variables can be used as 'wildcards' that will match with any
  1129. text. They are useful for highlighting a complete line. The %0 variable
  1130. should never be used in highlights.
  1131. You may start the string to highlight with a ^ to only highlight text
  1132. if it begins the line.
  1133. Besides color names also &lt;abc&gt; color codes can be used.
  1134. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high {Valgar} {reverse blink}
  1135. Prints every occurrence of 'Valgar' in blinking reverse video.
  1136. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high {^You %1} {bold cyan}
  1137. Boldfaces any line that starts with 'You' in cyan.
  1138. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #high {Bubba} {red underscore b green}
  1139. Highlights the name Bubba as red underscored text on green background.
  1140. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help action', for more information about triggers.
  1141. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help substitute', for more advanced color substitution.
  1142. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: This command only works with ANSI/VT100 terminals or emulators.
  1143. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a highlight with the #unhighlight command.
  1144. </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>.
  1145. <a name='HISTORY'></a>
  1146. </span><span style='color:#5F5'> HISTORY
  1147. </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.
  1148. #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.
  1149. #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.
  1150. #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.
  1151. #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.
  1152. Without an argument all available options are shown.
  1153. By default all commands are saved to the history list and the history
  1154. list is saved between sessions in the ~/.tintin/history.txt file.
  1155. You can set the character to repeat a command in the history with the
  1156. #config {REPEAT CHAR} {&lt;character&gt;} configuration option, by default
  1157. this is set to the exclamation mark.
  1158. You can use ! by itself to repeat the last command, or !&lt;text&gt; to
  1159. repeat the last command starting with the given text.
  1160. You can use #config {REPEAT ENTER} {ON} to repeat the last command
  1161. when you press enter on an empty line.
  1162. You can press ctrl-r to enter an interactive regex enabled history
  1163. search mode, or by issuing #cursor {history search}.
  1164. TinTin++ tries to bind the arrow up and down keys to scroll through
  1165. the history list by default. You can bind these with a macro yourself
  1166. using #cursor {history next} and #cursor {history prev}. Many #cursor
  1167. commands only work properly when bound with a macro.
  1168. </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>.
  1169. <a name='IF'></a>
  1170. </span><span style='color:#5F5'> IF
  1171. </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'>
  1172. The #if command is one of the most powerful commands added since
  1173. TINTIN III. It works similar to an if statement in other languages,
  1174. and is based on the way C handles its conditional statements.
  1175. When an #if command is encountered, the conditional statement is
  1176. evaluated, and if TRUE (any non-zero result) the commands are executed.
  1177. The if statement is only evaluated if it is read, so you must nest
  1178. the if statement inside another statement (most likely an #action
  1179. command). The conditional is evaluated exactly the same as in the
  1180. #math command, only instead of storing the result, the result is used
  1181. to determine whether to execute the commands.
  1182. To handle the case where an if statement is false it can be followed
  1183. by the #else command.
  1184. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {%0 gives you %1 gold coins.} {#if {%1 &gt; 5000} {thank %0}}
  1185. If someone gives you more than 5000 coins, thank them.
  1186. </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}}
  1187. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help math', for more information.
  1188. </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>.
  1189. <a name='IGNORE'></a>
  1190. </span><span style='color:#5F5'> IGNORE
  1191. </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'>
  1192. Toggles a list on or off. With no arguments it shows your current
  1193. settings, as well as the list names that you can ignore.
  1194. If you for example set ACTIONS to OFF actions will no longer trigger.
  1195. Not every list can be ignored.
  1196. </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>.
  1197. <a name='INDEX'></a>
  1198. </span><span style='color:#5F5'> INDEX
  1199. </span><span style='color:#AAA'> On this page you'll find an introduction to using TinTin++. Additional
  1200. information can be found in the individual help sections.
  1201. </span><span style='color:#5F5'>
  1202. Starting and Ending
  1203. </span><span style='color:#AAA'>
  1204. The syntax for starting TinTin++ is: ./tt++ [command file]
  1205. Read more about the command file in the files section below. Remember
  1206. one thing though. All actions, aliases, substitutions, etc, defined
  1207. when starting up TinTin++ are inherited by all sessions.
  1208. If you want to exit TinTin++ type '#end' or press ctrl-d on an empty
  1209. line.
  1210. For the WinTin++ users, if you want to paste text use shift-insert,
  1211. text is automatically copied upon selection. This is typical Linux
  1212. behavior, but it can take some getting used to.
  1213. </span><span style='color:#5F5'>
  1214. Basic features
  1215. </span><span style='color:#AAA'>
  1216. I'll start by explaining some of the very basic and important features:
  1217. All TinTin++ commands starts with a '#'.
  1218. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #help -- #help is a client command, and isn't send to the server.
  1219. All TinTin++ commands can be abbreviated when typed.
  1220. #he -- Typing #he is the same as typing #help though it's suggested to
  1221. use at least 3 letter abbreviations just in case another command is
  1222. added that starts with 'he'.
  1223. All commands can be separated with a ';'.
  1224. n;l dragon;s;say Dan Dare is back! -- do these 4 commands
  1225. There are 3 ways ';'s can be overruled.
  1226. &bsol;say Hello ;) -- Lines starting with a '&bsol;' aren't parsed by TinTin++.
  1227. say Hello &bsol;;) -- The escape character can escape 1 letter.
  1228. #config verbatim on -- Everything is send as is except '#' commands.
  1229. </span><span style='color:#5F5'>
  1230. Connecting to a server
  1231. </span><span style='color:#FFF'>
  1232. 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'>
  1233. Example: #session someone tintin.sourceforge.net 4321
  1234. You can have more than one session, in which case you can switch
  1235. between sessions typing #&lt;session name&gt;.
  1236. You can get a list of all sessions by typing: #session. The current
  1237. active session is marked with (active). Snooped sessions with
  1238. (snooped). MCCP sessions (compression) with (mccp 2) and (mccp 3).
  1239. </span><span style='color:#5F5'>
  1240. Split
  1241. </span><span style='color:#FFF'>
  1242. Command</span><span style='color:#AAA'>: #split
  1243. The split command will create a separated input and output area.
  1244. Using the #prompt command you can capture the prompt and place it on
  1245. the split line. To get rid of the split interface you can use #unsplit
  1246. which will restore the terminal settings to default.
  1247. </span><span style='color:#5F5'>
  1248. Alias
  1249. </span><span style='color:#FFF'>
  1250. 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'>
  1251. The syntax of the #alias command is almost like alias in csh.
  1252. Use this command to define aliases. The variables %0, %1.. %9 contain
  1253. the arguments to the aliased command as follows:
  1254. the %0 variable contains ALL the arguments.
  1255. the %1 variable contains the 1st argument
  1256. ....
  1257. the %9 variable contains the 9th argument
  1258. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias greet say Greetings, most honorable %1
  1259. If you want an alias to execute more commands, you must use braces.
  1260. </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'>
  1261. To delete an alias use the #unalias command.
  1262. WARNING! TinTin++ doesn't baby sit, and hence does not check for
  1263. recursive aliases! You can avoid recursion by escaping the entire
  1264. line.
  1265. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias put &bsol;put %1 in %2
  1266. Or by using the send command.
  1267. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias put #send put %1 in %2
  1268. </span><span style='color:#5F5'> Action
  1269. </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'>
  1270. Use this command to define an action to take place when a particular
  1271. text appears on your screen. There are 99 variables you can use as
  1272. wildcards in the action-text.
  1273. These variables are %1, %2, %3 .... %9, %10, %11 ... %97, %98, %99.
  1274. </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'>
  1275. </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.
  1276. </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'>}
  1277. {</span><span style='color:#AAA'>tell bob %1 told me '%2'</span><span style='color:#FFF'>}</span><span style='color:#AAA'> -- forward tells.
  1278. </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.
  1279. You can have TinTin++ ignore actions if you type '#ignore actions on'.
  1280. You can see what commands TinTin++ executes when an action triggers
  1281. by typing '#debug actions on'.
  1282. You can remove actions with the #unaction command.
  1283. </span><span style='color:#5F5'>
  1284. Highlight
  1285. </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'>
  1286. This command works a bit like #action. The purpose of this command is
  1287. to substitute text from the server with color you provide. This command
  1288. is a simplified version of the #substitute command.
  1289. </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'>
  1290. </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'>
  1291. Use #unhigh to delete highlights.
  1292. Speedwalk
  1293. If you type a command consisting ONLY of letters and numbers n, e, s,
  1294. w, u, d - then this command can be interpreted as a serie of movement
  1295. commands.
  1296. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: ssw2n -- go south, south, west, north, north
  1297. If you have problems with typing some commands that actually ONLY
  1298. consists of these letters, then type them in CAPS. For example when
  1299. checking the NEWS or when asked to enter NEW as your name.
  1300. You must enable speedwalking with: #config speedwalk on/off.
  1301. </span><span style='color:#5F5'>
  1302. Ticker
  1303. </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'>
  1304. The name can be whatever you want it to be, and is only required for
  1305. the unticker command. The commands will be executed every x amount of
  1306. seconds, which is specified in the interval part.
  1307. </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'>
  1308. 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!!!,
  1309. as well as print a warning when the next tick will occure.
  1310. You can remove tickers with #untick
  1311. </span><span style='color:#5F5'>
  1312. Command files
  1313. </span><span style='color:#AAA'>
  1314. When you order TinTin++ to read a command file, it parses all the text
  1315. in the file. You can use command files to keep aliases/actions in,
  1316. login to a server (name, password etc..) and basically all kinds of
  1317. commands.
  1318. You can make the command files with either a text editor (suggested),
  1319. or use the #write command to write out a file.
  1320. Commands for files:
  1321. #read filename -- read and execute the file.
  1322. #write filename -- write all actions/aliases/substitutes/etc known for
  1323. the current session to a file.
  1324. </span><span style='color:#5F5'>
  1325. Repeating Commands
  1326. </span><span style='color:#AAA'>
  1327. You can repeat a command, the syntax is: #number command
  1328. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #5 cackle -- if you just killed bob the wizard.
  1329. </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.
  1330. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #100 ooc w00t w00t!!!!! -- nochannel yourself.
  1331. </span><span style='color:#5F5'>
  1332. History
  1333. </span><span style='color:#AAA'>
  1334. TinTin++ has a limited subset of the csh history features.
  1335. ! -- repeat the last command
  1336. !cast -- repeat the last command starting with cast
  1337. ctrl-r -- enter the reverse history search mode.
  1338. </span><span style='color:#5F5'>
  1339. Map commands
  1340. </span><span style='color:#AAA'>
  1341. TinTin++ has a powerful highly configurable automapper. Whenever
  1342. you type n/ne/e/se/s/sw/w/nw/n/u/d tt++ tries to keep track of your
  1343. movement.
  1344. Commands for map:
  1345. #map create -- create a map.
  1346. #map goto 1 -- go to the first room in the map, created by default.
  1347. #map map -- display the map.
  1348. #map undo -- undo your last map alteration.
  1349. #map write &lt;filename&gt; -- save the map to file.
  1350. #map read &lt;filename&gt; -- load a map from file.
  1351. There are many other map options and it's beyond the scope of this
  1352. help section to explain everything there is to know, but I'll give
  1353. a set of commands that will get most people started.
  1354. #map create
  1355. #split 12 1
  1356. #map flag unicode on
  1357. #map flag vt on
  1358. #map goto 1
  1359. These commands will create a 12 row vt100 split section at the top of
  1360. your screen where a map drawn using unicode characters is displayed.
  1361. </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'>
  1362. The map will be automatically created as you move around.
  1363. </span><span style='color:#5F5'>
  1364. Help
  1365. </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'>
  1366. The help command is your friend and contains the same helpfiles
  1367. inside TinTin++ as are available on the website. If you type #help
  1368. without an argument you will see the various available help subjects
  1369. which try to explain the TinTin++ commands and features in greater
  1370. detail.
  1371. </span><span style='color:#5F5'>
  1372. Enjoy</span><span style='color:#AAA'>
  1373. </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>.
  1374. <a name='INFO'></a>
  1375. </span><span style='color:#5F5'> INFO
  1376. </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'>
  1377. Without an argument info displays the settings of every tintin list.
  1378. By providing the name of a list and the LIST option it shows all
  1379. triggers/variables associated with that list. With the SAVE option
  1380. this data is written to the info variable.
  1381. #info arguments will show matched trigger arguments.
  1382. #info big5toutf will show the big5 to utf8 translation table.
  1383. #info cpu will show information about tintin's cpu usage.
  1384. #info environ will show the environment variables.
  1385. #info input will show information about the input line.
  1386. #info matches will show matched command arguments.
  1387. #info mccp will show information about data compression.
  1388. #info memory will show information about the memory stack.
  1389. #info stack will show the low level debugging stack.
  1390. #info session will show information on the session.
  1391. #info sessions will show information on all sessions.
  1392. #info system will show some system information.
  1393. #info tokenizer will show information about the script stack.
  1394. #info unicode will show information on the provided character.
  1395. </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>.
  1396. <a name='KEYPAD'></a>
  1397. </span><span style='color:#5F5'> KEYPAD
  1398. </span><span style='color:#AAA'>When TinTin++ starts up it sends &bsol;e= to the terminal to enable the terminal's
  1399. application keypad mode, which can be disabled using #show {&bsol;e&gt;}
  1400. </span><span style='color:#FFF'> Configuration A Configuration B Configuration C</span><span style='color:#0AA'>
  1401. ╭─────┬─────┬─────┬─────╮ ╭─────┬─────┬─────┬─────╮ ╭─────┬─────┬─────┬─────╮
  1402. │</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'> │
  1403. ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤
  1404. │</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'> │
  1405. ├─────┼─────┼─────┤ │ ├─────┼─────┼─────┤ │ ├─────┼─────┼─────┤ │
  1406. │</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'> │ │
  1407. ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┤
  1408. │</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'>│
  1409. ├─────┴─────┼─────┤ │ ├─────┴─────┼─────┤ │ ├─────┴─────┼─────┤ │
  1410. │</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'> │ │
  1411. ╰───────────┴─────┴─────╯ ╰───────────┴─────┴─────╯ ╰───────────┴─────┴─────╯
  1412. </span><span style='color:#AAA'>
  1413. With keypad mode disabled numlock on will give you configuration A, and numlock
  1414. off will give you configuration B. With keypad mode enabled you'll get
  1415. configuration C.
  1416. </span><span style='color:#FFF'>Terminals that support keypad mode
  1417. </span><span style='color:#AAA'>Linux Console, PuTTY, Eterm, aterm.
  1418. </span><span style='color:#FFF'>Terminals that do not support keypad mode
  1419. </span><span style='color:#AAA'>RXVT on Cygwin, Windows Console, Gnome Terminal, Konsole.
  1420. </span><span style='color:#FFF'>Peculiar Terminals
  1421. </span><span style='color:#AAA'>RXVT requires turning off numlock to enable configuration C.
  1422. Xterm may require disabling Alt/NumLock Modifiers (num-lock) in the ctrl-left
  1423. click menu. Or edit ~/.Xresources and add XTerm*VT100.numLock:false
  1424. Mac OS X Terminal requires enabling 'strict vt100 keypad behavior' in
  1425. Terminal -&gt; Window Settings -&gt; Emulation.
  1426. </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>.
  1427. <a name='KILL'></a>
  1428. </span><span style='color:#5F5'> KILL
  1429. </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'>
  1430. Without an argument, the kill command clears all lists. Useful if
  1431. you don't want to exit tintin to reload your command files.
  1432. With one argument a specific list can be cleared.
  1433. With two arguments the triggers in the chosen list that match the
  1434. given pattern will be removed.
  1435. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #kill alias %*test*
  1436. </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>.
  1437. <a name='LINE'></a>
  1438. </span><span style='color:#5F5'> LINE
  1439. </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'>
  1440. </span><span style='color:#5F5'>Line options that alter the argument.
  1441. </span><span style='color:#FFF'>#line strip &lt;argument&gt;
  1442. </span><span style='color:#AAA'> Argument is executed with all color codes stripped.
  1443. </span><span style='color:#FFF'>#line substitute &lt;options&gt; &lt;argument&gt;
  1444. </span><span style='color:#AAA'> Argument is executed using the provided substitutions, available
  1445. options are: arguments, braces, colors, escapes, functions, secure,
  1446. and variables.
  1447. </span><span style='color:#5F5'>Line options that alter how the line is executed.
  1448. </span><span style='color:#FFF'>#line background &lt;argument&gt;
  1449. </span><span style='color:#AAA'> Prevent new session activation.
  1450. </span><span style='color:#FFF'>#line capture &lt;variable&gt; &lt;argument.
  1451. </span><span style='color:#AAA'> Argument is executed and output stored in &lt;variable&gt;.
  1452. </span><span style='color:#FFF'>#line convert &lt;argument&gt;
  1453. </span><span style='color:#AAA'> Argument is executed with escaped meta characters.
  1454. </span><span style='color:#FFF'>#line debug &lt;argument&gt;
  1455. </span><span style='color:#AAA'> Argument is executed in debug mode.
  1456. </span><span style='color:#FFF'>#line gag
  1457. </span><span style='color:#AAA'> Gag the next line.
  1458. </span><span style='color:#FFF'>#line ignore {argument}
  1459. </span><span style='color:#AAA'> Argument is executed without any triggers being checked.
  1460. </span><span style='color:#FFF'>#line local {argument}
  1461. </span><span style='color:#AAA'> Argument is executed with all newly and indirectly
  1462. created variables being local.
  1463. </span><span style='color:#FFF'>#line log &lt;filename&gt; [text]
  1464. </span><span style='color:#AAA'> Log the next line to file unless the [text] argument is
  1465. provided.
  1466. </span><span style='color:#FFF'>#line logmode &lt;option&gt; &lt;argument&gt;
  1467. </span><span style='color:#AAA'> Argument is executed using the provided logmode, available
  1468. modes are: html, plain, and raw.
  1469. </span><span style='color:#FFF'>#line msdp &lt;argument&gt;
  1470. </span><span style='color:#AAA'> Turn the argument into an msdp telnet sequence, starting at the
  1471. first opening brace. Will turn tintin tables into msdp tables,
  1472. with semicolons being used to create msdp arrays.
  1473. </span><span style='color:#FFF'>#line multishot &lt;number&gt; &lt;argument&gt;
  1474. </span><span style='color:#AAA'> Argument is executed in multishot mode, all triggers created
  1475. will only fire the given number of times.
  1476. </span><span style='color:#FFF'>#line oneshot &lt;argument&gt;
  1477. </span><span style='color:#AAA'> Argument is executed in oneshot mode, all triggers created will
  1478. only fire once.
  1479. </span><span style='color:#FFF'>#line quiet &lt;argument&gt;
  1480. </span><span style='color:#AAA'> Argument is executed with suppression of most system messages.
  1481. </span><span style='color:#FFF'>#line verbatim &lt;argument&gt;
  1482. </span><span style='color:#AAA'> Argument is executed verbatim, prohibiting variable and function
  1483. substitutions.
  1484. </span><span style='color:#FFF'>#line verbose &lt;argument&gt;
  1485. </span><span style='color:#AAA'> Argument is executed with most system messages enabled.
  1486. When using #line log and logging in html format use &bsol;c&lt; &bsol;c&gt; &bsol;c&amp; &bsol;c&quot; to
  1487. log a literal &lt; &gt; &amp; and &quot;.
  1488. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CLASS'>class</a> and <a href='#CONFIG'>config</a>.
  1489. <a name='LIST'></a>
  1490. </span><span style='color:#5F5'> LIST
  1491. </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'>
  1492. #list {var} {add} {item} Add {item} to the list
  1493. #list {var} {clear} Empty the given list
  1494. #list {var} {collapse} {separator} Turn list into a variable
  1495. #list {var} {create} {items} Create a list using {items}
  1496. #list {var} {delete} {index} {amount} Delete the item at {index},
  1497. the {amount} is optional.
  1498. #list {var} {explode} {separator} Turn variable into a list
  1499. #list {var} {indexate} Index a list table for sorting
  1500. #list {var} {insert} {index} {string} Insert {string} at given index
  1501. #list {var} {filter} {keep} {remove} Filter with keep / remove regex
  1502. #list {var} {find} {regex} {variable} Return the found index
  1503. #list {var} {get} {index} {variable} Copy an item to {variable}
  1504. #list {var} {numerate} Turn a table into a list
  1505. #list {var} {order} {string} Insert item in numerical order
  1506. #list {var} {shuffle} Shuffle the list
  1507. #list {var} {set} {index} {string} Change the item at {index}
  1508. #list {var} {simplify} {string} Turn list into a simple list
  1509. #list {var} {size} {variable} Copy list size to {variable}
  1510. #list {var} {sort} {string} Insert item in alphabetic order
  1511. #list {var} {tokenize} {string} Create a character list
  1512. The index should be between +1 and the list's size. You can also give
  1513. a negative value, in which case -1 equals the last item in the list, -2
  1514. the second last, etc.
  1515. When inserting an item a positive index will prepend the item at the
  1516. given index, while a negative index will append the item.
  1517. The add and create options allow using multiple items, as well
  1518. as semicolon separated items.
  1519. A size of 0 is returned for an empty or non-existent list. You can
  1520. directly access the size of a list using &amp;var[].
  1521. You can directly access elements in a list variable using &dollar;var[+1],
  1522. &dollar;var[+2], &dollar;var[-1], etc.
  1523. </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>.
  1524. <a name='LISTS'></a>
  1525. </span><span style='color:#5F5'> LISTS
  1526. </span><span style='color:#AAA'> There are several different types of lists in tintin which behave in a
  1527. fairly universal manner. To properly explain lists it's easiest to
  1528. explain the most basic variable type first before discussing more
  1529. complex types.
  1530. - Basic variable: The standard key = value variable.
  1531. - Simple list: A string that contains semicolon delimited fields.
  1532. {a;b;c}. Can be saved as a variable.
  1533. - Brace list: A string in which fields are delimited with braces.
  1534. {a}{b}{c}. Brace lists cannot be stored as a variable because tables
  1535. use braces as well, they must be stored as a simple list instead.
  1536. - Table: Think of this as variables nested within another variable. Or
  1537. as variables contained within another variable.
  1538. - List: A table that uses integers for its indexes. Also known as an
  1539. array. The #list command is a utility command for using tables as
  1540. arrays.
  1541. </span><span style='color:#5F5'>
  1542. Simple Variables
  1543. </span><span style='color:#AAA'>
  1544. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
  1545. #variable {simple} {Hello World!}
  1546. #show &dollar;simple
  1547. To see if the 'simple' variable exists you can use &amp;simple which will
  1548. display 0 if the variable does not exist, or the variable's index if
  1549. it exists.
  1550. If you have multiple variables they are sorted alphabetically and
  1551. numerically. While it's not all that relevant for simple variables,
  1552. the first variable has index 1, the second variable index 2, and so
  1553. on.
  1554. Variable names need to start with a letter and only exist of letters,
  1555. numbers, and underscores. If you need to use a non standard variable
  1556. name this is possible using braces.
  1557. </span><span style='color:#FFF'>Example: </span><span style='color:#AAA'>#variable {:)} {Happy Happy!};#show &dollar;{:)}
  1558. Variables can be accessed using their index. While primarily useful
  1559. for tables it is possible to do this for simple variables. Use +1 for
  1560. the first variable, +2 for the second variable, etc. Use -1 for the
  1561. last variable, -2 for the second last variable, etc.
  1562. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #show The first variable is: &dollar;{+1}
  1563. </span><span style='color:#5F5'>
  1564. Removing Variables
  1565. </span><span style='color:#AAA'>
  1566. To remove a variable, use #unvariable or #unvar (every command can be
  1567. abbreviated). It's possible to remove multiple variables at once
  1568. using #unvar {var 1} {var 2} {etc}
  1569. Variables are unique to each session, so if you have multiple
  1570. sessions, removing a variable from one session won't remove it from
  1571. other sessions.
  1572. If you remove a table variable, all variables contained within that
  1573. table variable are removed as well.
  1574. </span><span style='color:#5F5'>
  1575. Simple Lists
  1576. </span><span style='color:#AAA'>
  1577. A simple list is a string that contains semicolon delimited fields.
  1578. Commands can be entered as simple lists, for example:
  1579. #show {a};#show {b} will execute a single line as two commands.
  1580. Several commands take a simple list as their input, these are:
  1581. #foreach, #line substitute, #path load, #list create, and #highlight.
  1582. </span><span style='color:#5F5'>
  1583. Brace Lists
  1584. </span><span style='color:#AAA'>
  1585. A brace list is a string in which fields are delimited with braces.
  1586. Most commands take a brace list for their arguments, for example:
  1587. #session {x} {mud.com} {1234} {mud.tin}. The session command takes
  1588. 4 arguments, the 4th argument (command file) is optional.
  1589. Commands that take a simple list as their input will also accept a
  1590. brace list, keep in mind you'll have to embed the brace list in an
  1591. extra set of braces, for example: #path load {{n}{s}{w}{w}}, which is
  1592. identical to: #path load {n;s;w;w}.
  1593. Brace lists cannot be stored as variables because TinTin++ will
  1594. confuse them with tables. You can convert a brace list to a table
  1595. variable using: #list {bracelist} {create} {{a}{b}{c}} this will look
  1596. internally as: {{1}{a}{2}{b}{3}{c}}. You can then convert this table
  1597. to a simple list using: #list {bracelist} {simplify} {simplelist}
  1598. which will store {a;b;c} in the &dollar;simplelist variable.
  1599. Braces cannot easily be escaped in TinTin++. Using &bsol;{ or &bsol;} will not
  1600. work. The reason for this is due to several factors, but primarily
  1601. backward compatibility. To escape braces you must define them using
  1602. hexadecimal notation using &bsol;x7B and &bsol;x7D. See #help escape for a list
  1603. of escape options, and the help file will also remind you of how to
  1604. escape braces.
  1605. </span><span style='color:#5F5'>
  1606. Tables
  1607. </span><span style='color:#AAA'>
  1608. Tables are key/value pairs stored within a variable. Tables are also
  1609. known as associative arrays, dictionaries, maps, nested variables,
  1610. structures, and probably a couple of other names. There are several
  1611. ways to create and access tables.
  1612. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #variable {friendlist} {{bob}{bob@mail.com} {bubba}{sunset@gmail.com}}
  1613. This will create a friendlist with two entries, the key is the name of
  1614. the friend, the value is the email address of the friend. You can see
  1615. the email address of bob using: #show {&dollar;friendlist[bob]}. You can
  1616. also define this table as following:
  1617. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
  1618. #variable {friendlist[bob]} {bob@mail.com}
  1619. #variable {friendlist[bubba]} {sunset@gmail.com}
  1620. This would create the exact same table as the single line declaration
  1621. used previously. To see the first key in the table use:
  1622. *friendlist[+1], to see the first value in the table use:
  1623. &dollar;friendlist[+1]. To see the size of the table use &amp;friendlist[]. To
  1624. print a bracelist of all friends use *friendlist[%*], to print a
  1625. bracelist of all friends whose name starts with the letter 'a' you
  1626. would use: *friendlist[a%*]. Similarly to see the number of friends
  1627. you have whose name ends with the letter 'b' you would use:
  1628. &amp;friendlist[%*b].
  1629. See #help regexp for a brief overview of regular expression options.
  1630. While TinTin++ supports PCRE (perl-compatible regular expressions), it
  1631. embeds them within its own regular expression syntax that is simpler
  1632. and less invasive, while still allowing the full power of PCRE for
  1633. those who need it.
  1634. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #unvariable {friendlist[bubba]}
  1635. This would remove {bubba} from the friendlist. To remove the entire
  1636. friendlist you would use: #unvariable {friendlist}.
  1637. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #variable {friendlist} {{bob} {{email}{bob@ma.il} {phone}{123456789}}}
  1638. There is no limit to the number of nests, simply add more braces. To
  1639. see Bob's email in this example you would use:
  1640. #show {&dollar;friendlist[bob][email]}.
  1641. Lists
  1642. Tables are sorted alphabetically with the exception of numbers which
  1643. are sorted numerically. If you want to determine the sorting order
  1644. yourself you can use use the #list command which helps you to use
  1645. tables as arrays.
  1646. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #action {%1 chats %2} {#list chats add {%0}}
  1647. Each time a chat is received it's added to the end of the 'chats' list
  1648. variable. If you type #variable chats this might look like:
  1649. </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'>}
  1650. {
  1651. {</span><span style='color:#FFF'>1</span><span style='color:#A0A'>} {</span><span style='color:#FFF'>Bubba chats Hi</span><span style='color:#A0A'>}
  1652. {</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'>}
  1653. {</span><span style='color:#FFF'>3</span><span style='color:#A0A'>} {</span><span style='color:#FFF'>Bubba chats Bye</span><span style='color:#A0A'>}
  1654. {</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'>}
  1655. }
  1656. </span><span style='color:#5F5'>
  1657. Parsing
  1658. </span><span style='color:#AAA'>
  1659. There are various ways to parse lists and tables, using either #loop,
  1660. #foreach, #while, or #&lt;number&gt;.
  1661. #loop takes two numeric arguments, incrementing or decrementing the
  1662. first number until it matches the second number. The value of the loop
  1663. counter is stored in the provided variable.
  1664. #foreach takes either a simple list or a brace list as its first
  1665. argument. Foreach will go through each item in the list and store the
  1666. value in the provided variable.
  1667. #while will perform an if check on the first argument, if the result
  1668. is true it will execute the commands in the second argument. Then it
  1669. performs an if check on the first argument again. It will continue to
  1670. repeat until the if check returns 0 or the loop is interrupted with a
  1671. control flow command. It takes special care to avoid infinite loops.
  1672. #&lt;number&gt; will execute the provided argument 'number' times. For
  1673. example: #4 {#show beep! &bsol;a}
  1674. Here are some examples.
  1675. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #list friends create {bob;bubba;zorro}
  1676. Internally this looks like {{1}{bob}{2}{bubba}{3}{zorro}} and the
  1677. list can be parsed in various ways.
  1678. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #foreach {&dollar;friends[%*]} {name} {#show &dollar;name}
  1679. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #foreach {*friends[%*]} {i} {#show &dollar;friends[&dollar;i]}
  1680. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #loop {1} {&amp;friends[]} {i} {#show &dollar;friends[+&dollar;i]}
  1681. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'> #math i 1;#while {&amp;friends[+&dollar;i]} {#show &dollar;friends[+&dollar;i];
  1682. #math i &dollar;i + 1}
  1683. </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}
  1684. Each of the five examples above performs the same task; printing the
  1685. three names in the friends list.
  1686. If you want to get a better look at what goes on behind the scenes
  1687. while executing scripts you can use '#debug all on'. To stop seeing
  1688. debug information use '#debug all off'.
  1689. </span><span style='color:#5F5'>
  1690. List Tables
  1691. </span><span style='color:#AAA'>
  1692. List tables are also known as databases and the #list command has
  1693. several options to manipulate them.
  1694. For these options to work properly all tables need to have identical
  1695. keys. Here is an example list table.
  1696. #var {friendlist}
  1697. {
  1698. {1}{{name}{bob} {age}{54}}
  1699. {2}{{name}{bubba} {age}{21}}
  1700. {3}{{name}{pamela} {age}{36}}
  1701. }
  1702. To sort the list table by age you would use:
  1703. #list friendlist indexate age
  1704. #list friendlist order
  1705. To remove everyone whose name starts with a 'b' you would use:
  1706. #list friendlist indexate name
  1707. #list friendlist filter {} {b%*}
  1708. The filter option only supports regular expressions. To filter
  1709. using mathematics you would loop through the list backwards:
  1710. #loop &amp;friendlist[] 1 index
  1711. {
  1712. #if {&dollar;friendlist[+&dollar;index][age] &lt; 30}
  1713. {
  1714. #list friendlist delete &dollar;index
  1715. }
  1716. }
  1717. To add an item to a list table there are two options:
  1718. #list friendlist add {{{name}{hobo} {age}{42}}}
  1719. #list friendlist insert -1 {{name}{hobo} {age}{42}}
  1720. </span><span style='color:#5F5'>
  1721. Optimization
  1722. </span><span style='color:#AAA'>
  1723. TinTin++ tables are exceptionally fast while they remain under 100
  1724. items. Once a table grows beyond 10000 items there can be performance
  1725. issues when inserting and removing items in the beginning or middle of
  1726. the table.
  1727. The plan is to eventually implement an indexable and flexible data
  1728. structure for large tables.
  1729. If you load a large table from file it's important to make sure it's
  1730. sorted, when using #write to save a table it's automatically sorted.
  1731. If you notice performance issues on large tables it's relatively easy
  1732. to create a hash table.
  1733. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
  1734. #alias {sethash}
  1735. {
  1736. #format hash %H %1;
  1737. #math hash1 &dollar;hash % 100;
  1738. #math hash2 &dollar;hash / 100 % 100;
  1739. #var hashtable[&dollar;hash1][&dollar;hash2][%1] %2
  1740. }
  1741. #function {gethash}
  1742. {
  1743. #format hash %H %1;
  1744. #math hash1 &dollar;hash % 100;
  1745. #math hash2 &dollar;hash / 100 % 100;
  1746. #return &dollar;hashtable[&dollar;hash1][&dollar;hash2][%1]
  1747. }
  1748. #alias {test}
  1749. {
  1750. sethash bli hey;
  1751. sethash bla hi;
  1752. sethash blo hello;
  1753. #show The value of bla is: @gethash{bla}
  1754. }
  1755. The above script will rapidly store and retrieve over 1 million items.
  1756. Looping through a hash table is relatively easy as well.
  1757. </span><span style='color:#FFF'>Example:</span><span style='color:#AAA'>
  1758. #alias {showhash}
  1759. {
  1760. #foreach {*hashtable[%*]} {hash1}
  1761. {
  1762. #foreach {*hashtable[&dollar;hash1][%*]} {hash2}
  1763. {
  1764. #echo {%-20s = %s}
  1765. {hashtable[&dollar;hash1][&dollar;hash2]}
  1766. {&dollar;hashtable[&dollar;hash1][&dollar;hash2]}
  1767. }
  1768. }
  1769. }
  1770. </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>.
  1771. <a name='LOCAL'></a>
  1772. </span><span style='color:#5F5'> LOCAL
  1773. </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'>
  1774. The local command sets a local variable. Unlike a regular variable
  1775. a local variable will only stay in memory for the duration of the
  1776. event that created it. They are accessed in the same way as a
  1777. regular variable.
  1778. Commands that store information to a variable will use a local variable
  1779. if it exists.
  1780. Avoid setting the result variable as local in a function.
  1781. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {swap} {#local x %0;#replace x {e} {u};#show &dollar;x}
  1782. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a local variable with the #unlocal command.
  1783. </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>.
  1784. <a name='LOG'></a>
  1785. </span><span style='color:#5F5'> LOG
  1786. </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'>
  1787. The log command allows logging session output to file. You can set the
  1788. data type to either plain, raw, or html with the config command.
  1789. </span><span style='color:#FFF'>#log append &lt;filename&gt;
  1790. </span><span style='color:#AAA'> Start logging to the given file, if the file already exists it won't
  1791. be overwritten and data will be appended to the end.
  1792. </span><span style='color:#FFF'>#log move &lt;filename_1&gt; &lt;filename_2&gt;
  1793. </span><span style='color:#AAA'> Move filename_1 to filename_2. This can be any file and doesn't need
  1794. to be a log file.
  1795. </span><span style='color:#FFF'>#log overwrite &lt;filename&gt;
  1796. </span><span style='color:#AAA'> Start logging to the given file, if the file already exists it will
  1797. be overwritten.
  1798. </span><span style='color:#FFF'>#log off
  1799. </span><span style='color:#AAA'> Stop logging.
  1800. </span><span style='color:#FFF'>#log remove &lt;filename&gt;
  1801. </span><span style='color:#AAA'> Remove the file. This can be any file and doesn't need to be a log
  1802. file.
  1803. </span><span style='color:#FFF'>#log timestamp &lt;format&gt;
  1804. </span><span style='color:#AAA'> When set the timestamp will be prepended to each line logged to file.
  1805. The format will be formatted as a date using the strftime format
  1806. specifiers as described in #help time.
  1807. </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>.
  1808. <a name='LOOP'></a>
  1809. </span><span style='color:#5F5'> LOOP
  1810. </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'>
  1811. Like a for statement, loop will loop from start to finish incrementing
  1812. or decrementing by 1 each time through. The value of the loop counter
  1813. is stored in the provided variable, which you can use in the commands.
  1814. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop 1 3 loop {get all &dollar;loop.corpse}
  1815. This equals 'get all 1.corpse;get all 2.corpse;get all 3.corpse'.
  1816. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #loop 3 1 cnt {drop &dollar;cnt&bsol;.key}
  1817. This equals 'drop 3.key;drop 2.key;drop 1.key'.
  1818. </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>.
  1819. <a name='MACRO'></a>
  1820. </span><span style='color:#5F5'> MACRO
  1821. </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'>
  1822. Macros allow you to make tintin respond to function keys.
  1823. The key sequence send to the terminal when pressing a function key
  1824. differs for every OS and terminal. To find out what sequence is send
  1825. you can enable the CONVERT META config option.
  1826. Another option is pressing ctrl-v, which will enable CONVERT META for
  1827. the next key pressed.
  1828. If you only want a key sequence to trigger at the start of an input
  1829. line prefix the key sequence with ^.
  1830. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {(press ctrl-v)(press F1)} {#show &bsol;e[2J;#buffer lock}
  1831. Clear the screen and lock the window when you press F1, useful when the
  1832. boss is near.
  1833. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {&bsol;eOM} {#cursor enter}
  1834. Makes the keypad's enter key work as an enter in keypad mode.
  1835. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #macro {^nn} {n}
  1836. Makes pressing n twice on an empty line execute north.
  1837. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: Not all terminals properly initialize the keypad key sequences.
  1838. If this is the case you can still use the keypad, but instead of the
  1839. arrow keys use ctrl b, f, p, and n.
  1840. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a macro with the #unmacro command.
  1841. </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>.
  1842. <a name='MAP'></a>
  1843. </span><span style='color:#5F5'> MAP
  1844. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #map
  1845. The map command is the backbone of the auto mapping feature.
  1846. </span><span style='color:#FFF'>#map at &lt;exit|vnum&gt; &lt;command&gt;
  1847. </span><span style='color:#AAA'> Execute the command at the given exit or vnum.
  1848. </span><span style='color:#FFF'>#map center &lt;x&gt; &lt;y&gt; &lt;z&gt;
  1849. </span><span style='color:#AAA'> Sets displaying center of the map viewer, default is 0 0 0.
  1850. </span><span style='color:#FFF'>#map color &lt;field&gt; [value]
  1851. </span><span style='color:#AAA'> Sets the map color for the given color field. Use #map color reset
  1852. to restore colors to default.
  1853. </span><span style='color:#FFF'>#map create &lt;size&gt;
  1854. </span><span style='color:#AAA'> Creates a new map and room 1. The default size is 50000 rooms.
  1855. </span><span style='color:#FFF'>#map destroy {area|world} &lt;name&gt;
  1856. </span><span style='color:#AAA'> Deletes the map or given area.
  1857. </span><span style='color:#FFF'>#map delete &lt;exit|vnum&gt;
  1858. </span><span style='color:#AAA'> Deletes the room for the given exit or vnum.
  1859. </span><span style='color:#FFF'>#map dig &lt;exit|vnum&gt; [new|&lt;vnum&gt;]
  1860. </span><span style='color:#AAA'> Creates an exit for the given exit name. If no valid exit name
  1861. is given or no existing room is found a new room is created.
  1862. Useful for portal links and other alternative forms of
  1863. transportation. If the 'new' argument is provided all existing
  1864. rooms are ignored and a new room is created. If a room vnum is
  1865. given as the second argument an exit will be created leading
  1866. to the given room vnum. If the room vnum doesn't exist a new
  1867. room is created.
  1868. </span><span style='color:#FFF'>#map entrance &lt;exit&gt; [option] [arg]
  1869. </span><span style='color:#AAA'> Set the entrance data for the given exit. You must specify a
  1870. valid two-way exit for this to work.
  1871. </span><span style='color:#FFF'>#map exit &lt;exit&gt; &lt;option&gt; &lt;arg&gt;
  1872. </span><span style='color:#AAA'> Set the exit data. Useful with a closed door where you can
  1873. set the exit command: '#map exit e command {open east;e}'.
  1874. Use #map exit &lt;exit&gt; for a list of available options.
  1875. Use #map exit &lt;eixt&gt; save to save the exit data.
  1876. </span><span style='color:#FFF'>#map exitflag &lt;exit&gt; &lt;AVOID|BLOCK|HIDE|INVIS&gt; [on|off]
  1877. </span><span style='color:#AAA'> Set exit flags. See #map roomflag for more info.
  1878. </span><span style='color:#FFF'>#map explore &lt;exit&gt;
  1879. </span><span style='color:#AAA'> Explores the given exit until a dead end or an
  1880. intersection is found. The route is stored in #path and can
  1881. subsequently be used with #walk. Useful for long roads.
  1882. </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;
  1883. </span><span style='color:#AAA'> searches for the given room name. If found the shortest path
  1884. from your current location to the destination is calculated.
  1885. The route is stored in #path and can subsequently be used with
  1886. the various #path commands. If #map flag nofollow is set it
  1887. will store the exit commands instead of the exit names.
  1888. If &lt;exits&gt; is provided all exits must be matched, if
  1889. &lt;roomdesc&gt;, &lt;roomarea&gt; or &lt;roomnote&gt; or &lt;roomterrain&gt; or
  1890. &lt;roomflag&gt; is provided these are matched as well against the
  1891. room to be found.
  1892. These search options are also available for the at, delete,
  1893. goto, link, list and run commands.
  1894. </span><span style='color:#FFF'>#map flag asciigraphics
  1895. </span><span style='color:#AAA'> Takes up more space but draws a more detailed
  1896. map that displays the ne se sw nw exits and room symbols.
  1897. </span><span style='color:#FFF'>#map flag asciivnums
  1898. </span><span style='color:#AAA'> Display room vnums if asciigraphics is enabled.
  1899. </span><span style='color:#FFF'>#map flag nofollow
  1900. </span><span style='color:#AAA'> When you enter movement commands the map will no longer
  1901. automatically follow along. Useful for MSDP and GMCP
  1902. automapping scripts. When you use #map find in nofollow
  1903. mode it will store the exit command instead of the exit
  1904. name into the path.
  1905. </span><span style='color:#FFF'>#map flag static
  1906. </span><span style='color:#AAA'> Will make the map static so new rooms are no longer
  1907. created when walking into an unmapped direction. Useful when
  1908. you're done mapping and regularly bump into walls accidentally
  1909. creating a new room. #map dig etc will still work.
  1910. </span><span style='color:#FFF'>#map flag vtgraphics
  1911. </span><span style='color:#AAA'> Enables vt line drawing on some terminals
  1912. </span><span style='color:#FFF'>#map flag vtmap
  1913. </span><span style='color:#AAA'> Will enable the vtmap which is shown in the top split
  1914. screen if you have one. You can create a 16 rows high top
  1915. screen by using '#split 16 1'.
  1916. </span><span style='color:#FFF'>#map get &lt;option&gt; &lt;variable&gt; [vnum]
  1917. </span><span style='color:#AAA'> Store a map value into a variable, if no vnum is given the
  1918. current room is used. Use 'all' as the option to store all
  1919. values as a table.
  1920. </span><span style='color:#FFF'>#map get roomexits &lt;variable&gt;
  1921. </span><span style='color:#AAA'> Store all room exits into variable.
  1922. </span><span style='color:#FFF'>#map global &lt;room vnum&gt;
  1923. </span><span style='color:#AAA'> Set the vnum of a room that contains global
  1924. exits, for example an exit named 'recall' that leads to the
  1925. recall location. The room can contain multiple exits, in case
  1926. there are multiple commands that are similar to recall.
  1927. </span><span style='color:#FFF'>#map goto &lt;room vnum&gt; [dig]
  1928. </span><span style='color:#AAA'> Takes you to the given room vnum, with the
  1929. dig argument a new room will be created if none exists.
  1930. </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;
  1931. </span><span style='color:#AAA'> Takes you to the given room name, if you provide exits those
  1932. must match.
  1933. </span><span style='color:#FFF'>#map info [save]
  1934. </span><span style='color:#AAA'> Gives information about the map and room you are in. If the save
  1935. argument is given the map data is saved to the info[map] variable.
  1936. </span><span style='color:#FFF'>#map insert &lt;direction&gt; [roomflag]
  1937. </span><span style='color:#AAA'> Insert a room in the given direction. Most useful for inserting
  1938. void rooms.
  1939. </span><span style='color:#FFF'>#map jump &lt;x&gt; &lt;y&gt; &lt;z&gt;
  1940. </span><span style='color:#AAA'> Jump to the given coordinate, which is relative
  1941. to your current room.
  1942. </span><span style='color:#FFF'>#map landmark &lt;name&gt; &lt;vnum&gt; [description] [size]
  1943. </span><span style='color:#AAA'> Creates an alias to target the provided room vnum. The
  1944. description is optional and should be brief. The size
  1945. determines from how many rooms away the landmark can be
  1946. seen.
  1947. </span><span style='color:#FFF'>#map leave
  1948. </span><span style='color:#AAA'> Makes you leave the map. Useful when entering a maze. You
  1949. can return to your last known room using #map return.
  1950. </span><span style='color:#FFF'>#map legend &lt;legend&gt; [symbols|reset]
  1951. #map legend &lt;legend&gt; &lt;index&gt; [symbol]
  1952. </span><span style='color:#AAA'> There are several legends and sub-legends available for
  1953. drawing maps to suit personal preference and character sets.
  1954. Use #map legend all to see the legend as currently defined.
  1955. Use #map legend &lt;legend&gt; &lt;reset&gt; to set the default legend.
  1956. Use #map legend &lt;legend&gt; &lt;character list&gt; to create a custom
  1957. legend. Custom legends are automatically saved and loaded by
  1958. using #map read and #map write.
  1959. </span><span style='color:#FFF'>#map link &lt;direction&gt; &lt;room name&gt; [both]
  1960. </span><span style='color:#AAA'> Links two rooms. If the both
  1961. argument and a valid direction is given the link is two ways.
  1962. </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;
  1963. </span><span style='color:#AAA'> Lists all matching rooms and their distance. The following
  1964. search keywords are supported.
  1965. {distance} &lt;arg&gt; will list rooms within given distance.
  1966. {roomarea} &lt;arg&gt; will list rooms with matching area name.
  1967. {roomdesc} &lt;arg&gt; will list rooms with matching room desc.
  1968. {roomexits} &lt;arg&gt; will list rooms with identical room exits.
  1969. Use * as an exit to ignore non pathdir exits.
  1970. {roomflag} &lt;arg&gt; will list rooms with matching room flags.
  1971. {roomid} &lt;arg&gt; will list rooms with identical id name.
  1972. {roomname} &lt;arg&gt; will list rooms with matching room name.
  1973. {roomnote} &lt;arg&gt; will list rooms with matching room note.
  1974. {roomterrain} &lt;arg&gt; will list rooms with matching room terrain.
  1975. {variable} &lt;arg&gt; will save the output to given variable.
  1976. </span><span style='color:#FFF'>#map map &lt;rows&gt; &lt;cols&gt; &lt;append|overwrite|list|variable&gt; &lt;name&gt;
  1977. </span><span style='color:#AAA'> Display a drawing of the map of the given height and width.
  1978. All arguments are optional. If {rows} or {cols} are set to {}
  1979. or {0} they will use the scrolling window size as the default.
  1980. If {rows} or {cols} are a negative number this number is
  1981. subtracted from the scrolling window size.
  1982. </span><span style='color:#FFF'>#map map &lt;rows&gt; &lt;cols&gt; draw &lt;square&gt;
  1983. </span><span style='color:#AAA'> Display a drawing of the map of the given height and width.
  1984. The square argument exists of 4 numbers formulating the top
  1985. left corner and bottom right corner of a square.
  1986. If you use {append|overwrite} the map is written to the specified
  1987. file name which must be given as the 4th argument.
  1988. If you use {list|variable} the map is saved to the specified
  1989. variable name.
  1990. </span><span style='color:#FFF'>#map move &lt;direction&gt;
  1991. </span><span style='color:#AAA'> This does the same as an actual movement command, updating your
  1992. location on the map and creating new rooms. Useful when you are
  1993. following someone and want the map to follow along. You will need
  1994. to create actions using '#map move', for this to work.
  1995. </span><span style='color:#FFF'>#map offset &lt;row&gt; &lt;col&gt; &lt;row&gt; &lt;col&gt;
  1996. </span><span style='color:#AAA'> Define the offset of the vtmap as a square. Without an argument
  1997. it defaults to the entire top split region.
  1998. </span><span style='color:#FFF'>#map read &lt;filename&gt;
  1999. </span><span style='color:#AAA'> Will load the given map file.
  2000. </span><span style='color:#FFF'>#map resize &lt;size&gt;
  2001. </span><span style='color:#AAA'> Resize the map, setting the maximum number of rooms.
  2002. </span><span style='color:#FFF'>#map return
  2003. </span><span style='color:#AAA'> Returns you to your last known room after leaving the map
  2004. or loading a map.
  2005. </span><span style='color:#FFF'>#map roomflag &lt;flags&gt; &lt;get|on|off&gt;
  2006. </span><span style='color:#AAA'>
  2007. </span><span style='color:#FFF'>#map roomflag avoid
  2008. </span><span style='color:#AAA'> When set, '#map find' will avoid a route leading
  2009. through that room. Useful for locked doors, etc.
  2010. </span><span style='color:#FFF'>#map roomflag block
  2011. </span><span style='color:#AAA'> When set the automapper will prevent movement into or through
  2012. the room. Useful for death traps.
  2013. </span><span style='color:#FFF'>#map roomflag hide
  2014. </span><span style='color:#AAA'> When set, '#map' will not display the map beyond
  2015. this room. When mapping overlapping areas or areas that aren't
  2016. build consistently you need this flag as well to stop
  2017. auto-linking, unless you use void rooms.
  2018. </span><span style='color:#FFF'>#map roomflag invis
  2019. </span><span style='color:#AAA'> When set the room will be colored with the INVIS color.
  2020. </span><span style='color:#FFF'>#map roomflag leave
  2021. </span><span style='color:#AAA'> When entering a room with this flag, you will
  2022. automatically leave the map. Useful when set at the entrance
  2023. of an unmappable maze.
  2024. </span><span style='color:#FFF'>#map roomflag noglobal
  2025. </span><span style='color:#AAA'> This marks a room as not allowing global
  2026. transportation, like norecall rooms that block recall.
  2027. </span><span style='color:#FFF'>#map roomflag void
  2028. </span><span style='color:#AAA'> When set the room becomes a spacing room that can
  2029. be used to connect otherwise overlapping areas. A void room
  2030. should only have two exits. When entering a void room you are
  2031. moved to the connecting room until you enter a non void room.
  2032. </span><span style='color:#FFF'>#map roomflag static
  2033. </span><span style='color:#AAA'> When set the room will no longer be autolinked
  2034. when walking around. Useful for mapping mazes.
  2035. </span><span style='color:#FFF'>#map run &lt;room name&gt; [delay]
  2036. </span><span style='color:#AAA'> Calculates the shortest path to the destination and walks you
  2037. there. The delay is optional and requires using braces. Besides
  2038. the room name a list of exits can be provided for more precise
  2039. matching.
  2040. </span><span style='color:#FFF'>#map set &lt;option&gt; &lt;value&gt; [vnum]
  2041. </span><span style='color:#AAA'> Set a map value for your current room, or given room if a room
  2042. vnum is provided.
  2043. </span><span style='color:#FFF'>#map sync &lt;filename&gt;
  2044. </span><span style='color:#AAA'> Similar to #map read except the current map won't be unloaded
  2045. or overwritten.
  2046. </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [flag]
  2047. </span><span style='color:#AAA'> Set the terrain symbol and flag.
  2048. </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [DENSE|SPARSE|SCANT]
  2049. </span><span style='color:#AAA'> Determine symbol density, omit for the default.
  2050. </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [NARROW|WIDE|VAST]
  2051. </span><span style='color:#AAA'> Determine symbol spread range, omit for the default.
  2052. </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [FADEIN|FADEOUT]
  2053. </span><span style='color:#AAA'> Determine symbol spread density, omit for the default.
  2054. </span><span style='color:#FFF'>#map terrain &lt;name&gt; &lt;symbol&gt; [DOUBLE]
  2055. </span><span style='color:#AAA'> You're using two characters for the symbol.
  2056. </span><span style='color:#FFF'>#map travel &lt;direction&gt; &lt;delay&gt;
  2057. </span><span style='color:#AAA'> Follows the direction until a dead end or an intersection is
  2058. found. Use braces around the direction if you use the delay,
  2059. which will add the given delay between movements.
  2060. Use #path stop to stop a delayed run.
  2061. </span><span style='color:#FFF'>#map undo
  2062. </span><span style='color:#AAA'> Will undo your last move. If this created a room or a link
  2063. they will be deleted, otherwise you'll simply move back a
  2064. room. Useful if you walked into a non-existent direction.
  2065. </span><span style='color:#FFF'>#map uninsert &lt;direction&gt;
  2066. </span><span style='color:#AAA'> Exact opposite of the insert command.
  2067. </span><span style='color:#FFF'>#map unlandmark &lt;name&gt;
  2068. </span><span style='color:#AAA'> Removes a landmark.
  2069. </span><span style='color:#FFF'>#map unlink &lt;direction&gt; [both]
  2070. </span><span style='color:#AAA'> Will remove the exit, this isn't two way so you can have the
  2071. properly display no exit rooms and mazes.
  2072. If you use the both argument the exit is removed two-ways.
  2073. </span><span style='color:#FFF'>#map unterrain &lt;name&gt;
  2074. </span><span style='color:#AAA'> Removes a terrain.
  2075. </span><span style='color:#FFF'>#map update [now]
  2076. </span><span style='color:#AAA'> Sets the vtmap to update within the next 0.1 seconds, or
  2077. instantly with the now argument.
  2078. </span><span style='color:#FFF'>#map vnum &lt;low&gt; [high]
  2079. </span><span style='color:#AAA'> Change the room vnum to the given number, if a range is
  2080. provided the first available room in that range is selected.
  2081. </span><span style='color:#FFF'>#map write &lt;filename&gt; [force]
  2082. </span><span style='color:#AAA'> Will save the map, if you want to save a map to a .tin file
  2083. you must provide the {force} argument.
  2084. </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>.
  2085. <a name='MAPPING'></a>
  2086. </span><span style='color:#5F5'> MAPPING
  2087. </span><span style='color:#AAA'>
  2088. TinTin++ has a powerful automapper that uses a room system similar to
  2089. Diku MUDs which means that odd map layouts and weird exit
  2090. configurations aren't a problem. The mapper provides tools to improve
  2091. the visual map display. For basic path tracking see #help PATH.
  2092. </span><span style='color:#FFF'> #map create [size]
  2093. </span><span style='color:#AAA'>
  2094. This command creates the initial map. The size is 50,000 by default
  2095. and can be changed at any time with the #map resize command. If you
  2096. play a MUD that uses MSDP or GMCP to provide room numbers you'll have
  2097. to increase it to the highest reported room number. Increasing the
  2098. size of the map doesn't decrease performance.
  2099. </span><span style='color:#FFF'> #map goto &lt;location&gt;
  2100. </span><span style='color:#AAA'>
  2101. When you create the map you are not automatically inside the map. By
  2102. default room number (vnum) 1 is created, so you can go to it using
  2103. #map goto 1. Once you are inside the map new rooms are automatically
  2104. created as you move around. Movement commands are defined with the
  2105. pathdir command. By default n, ne, e, se, s, sw, w, nw, u, d are
  2106. defined.
  2107. </span><span style='color:#FFF'>
  2108. #map map &lt;rows&gt; &lt;cols&gt; &lt;append|overwrite|list|variable&gt; &lt;name&gt;
  2109. </span><span style='color:#AAA'>
  2110. To see the map you can use #map map. It's annoying to have to
  2111. constantly type #map map however. Instead it's possible to use #split
  2112. to display a vt100 map. To do so execute:
  2113. </span><span style='color:#FFF'>#split 16 1
  2114. #map flag vtmap on</span><span style='color:#AAA'>
  2115. The first command sets the top split lines to 16 and the bottom split
  2116. line to 1. If you want a smaller or larger map display you can use a
  2117. different value than 16.
  2118. If you don't need to display diagonal exits and prefer a more compact
  2119. look you can use #map flag AsciiGraphics off. This will enable the
  2120. standard display which uses UTF-8 box drawing characters, results may
  2121. vary depending on the font used.
  2122. If your terminal supports UTF-8 you can also give #Map flag unicode on
  2123. a try.
  2124. If you want to display the map in a different location of the screen
  2125. use something like:
  2126. </span><span style='color:#FFF'>#split 0 1 0 -80
  2127. #map offset 1 81 -4 -1</span><span style='color:#AAA'>
  2128. This will display the map on the right side of the screen, if the
  2129. width of the screen is wide enough.
  2130. </span><span style='color:#FFF'>
  2131. #map undo
  2132. </span><span style='color:#AAA'>
  2133. If you accidentally walk into the wall on your MUD the mapper will
  2134. still create a new room. You can easily fix this mistake by using
  2135. #map undo. If you want to move around on the map without moving around
  2136. on the MUD you can use: #map move {direction}. To delete a room
  2137. manually you can use: #map delete {direction}. To create a room
  2138. manually you can use: #map dig {direction}.
  2139. </span><span style='color:#FFF'>
  2140. #map write &lt;filename&gt;
  2141. </span><span style='color:#AAA'>
  2142. You can save your map using #map write, to load a map you can use
  2143. #map read &lt;filename&gt;.
  2144. </span><span style='color:#FFF'>
  2145. #map set &lt;option&gt; &lt;value&gt;
  2146. </span><span style='color:#AAA'>
  2147. You can set the room name using #map set roomname &lt;name&gt;. You either
  2148. have to do this manually or create triggers to set the room name
  2149. automatically. Once the room name is set you can use #map goto with
  2150. the room name to visit it. If there are two rooms with the same name
  2151. #map goto will go to the most nearby room. If you want to always go
  2152. to the same room you should memorize the room number. You can further
  2153. narrow down the matches by providing additional arguments, for example:
  2154. </span><span style='color:#FFF'>
  2155. #map goto {dark alley} {roomexits} {n;e} {roomarea} {Haddock Ville}
  2156. </span><span style='color:#AAA'>
  2157. You can set the room weight using #map set roomweight {value}. The
  2158. weight by default is set to 1.0 and it represents the difficulty of
  2159. traversing the room. If you have a lake as an alternative route, and
  2160. traversing water rooms is 4 times slower than regular rooms, then you
  2161. could set the weight of the lake rooms to 4.0. If the lake is 3 rooms
  2162. wide the total weight is 12. If walking around the lake has a weight
  2163. less than 12 the mapper will go around the lake, if the weight is
  2164. greater than 12 the mapper will take a route through the lake.
  2165. You can set the room symbol using #map set roomsymbol {value}. The
  2166. symbol should be one, two, or three characters, which can be
  2167. colorized. You can for example mark shops with an 'S' and colorize the
  2168. 'S' depending on what type of shop it is.
  2169. </span><span style='color:#FFF'>
  2170. #map run &lt;location&gt; &lt;delay&gt;
  2171. </span><span style='color:#AAA'>
  2172. The run command will have tintin find the shortest path to the given
  2173. location and execute the movement commands to get there. You can
  2174. provide a delay in seconds with floating point precision, for example:
  2175. </span><span style='color:#FFF'>#map run {dark alley} {0.5}</span><span style='color:#AAA'>
  2176. </span><span style='color:#FFF'>
  2177. #map insert {direction} {flag}
  2178. </span><span style='color:#AAA'>
  2179. The insert command is useful for adding spacer rooms called void rooms.
  2180. Often rooms overlap, and by adding void rooms you can stretch out
  2181. exits. For example: #map insert north void. You cannot enter void rooms
  2182. once they've been created, so you'll have to use #map info in an
  2183. adjacent room to find the room vnum, then use #map goto {vnum} to
  2184. visit.
  2185. It's also possible to align rooms using void rooms. This is easily
  2186. done using #map insert north void.
  2187. </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>.
  2188. <a name='MATH'></a>
  2189. </span><span style='color:#5F5'> MATH
  2190. </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'>
  2191. Performs math operations and stores the result in a variable. The math
  2192. follows a C-like precedence, as follows, with the top of the list
  2193. having the highest priority.
  2194. Operators Priority Function
  2195. ------------------------------------------------
  2196. ! 0 logical not
  2197. ~ 0 bitwise not
  2198. d 1 integer random dice
  2199. * 2 integer multiply
  2200. ** 2 integer power
  2201. / 2 integer divide
  2202. // 2 integer sqrt // 2 or cbrt // 3
  2203. % 2 integer modulo
  2204. + 3 integer addition
  2205. - 3 integer subtraction
  2206. &lt;&lt; 4 bitwise shift
  2207. &gt;&gt; 4 bitwise shift
  2208. .. 4 integer range
  2209. &gt; 5 logical greater than
  2210. &gt;= 5 logical greater than or equal
  2211. &lt; 5 logical less than
  2212. &lt;= 5 logical less than or equal
  2213. == 6 logical equal (can use regex)
  2214. === 6 logical equal (never regex)
  2215. != 6 logical not equal (can use regex)
  2216. !== 6 logical not equal (never regex)
  2217. &amp; 7 bitwise and
  2218. ^ 8 bitwise xor
  2219. | 9 bitwise or
  2220. &amp;&amp; 10 logical and
  2221. ^^ 11 logical xor
  2222. || 12 logical or
  2223. ? 13 logical ternary if (unfinished code)
  2224. : 14 logical ternary else
  2225. True is any non-zero number, and False is zero. Parentheses () have
  2226. highest precedence, so inside the () is always evaluated first.
  2227. Strings must be enclosed in { } and use regex with == and !=,
  2228. in the case of &lt;= and &gt;= the alphabetic order is compared.
  2229. The #if and #switch commands use #math. Several commands accepting
  2230. integer input allow math operations as well.
  2231. Floating point precision is added by using the decimal . operator.
  2232. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #math {heals} {&dollar;mana / 40}
  2233. Assuming there is a variable &dollar;mana, divides its value by 40 and stores
  2234. the result in &dollar;heals.
  2235. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {^You receive %0 experience} {updatexp %0}
  2236. #alias updatexp {#math {xpneed} {&dollar;xpneed - %0}
  2237. Let's say you have a variable which stores xp needed for your next
  2238. level. The above will modify that variable after every kill, showing
  2239. the amount still needed.
  2240. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #action {%0 tells %1}
  2241. {#if {{%0} == {Bubba} &amp;&amp; &dollar;afk} {reply I'm away, my friend.}}
  2242. When you are away from keyboard, it will only reply to your friend.
  2243. </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>.
  2244. <a name='MATHEMATICS'></a>
  2245. </span><span style='color:#5F5'> MATHEMATICS
  2246. </span><span style='color:#FFF'>Number operations
  2247. </span><span style='color:#AAA'> Operators Priority Function
  2248. ------------------------------------------------
  2249. ! 0 logical not
  2250. ~ 0 bitwise not
  2251. * 1 integer multiply
  2252. ** 1 integer power
  2253. / 1 integer divide
  2254. // 1 integer sqrt // 2 or cbrt // 3
  2255. % 1 integer modulo
  2256. d 1 integer random dice roll
  2257. + 2 integer addition
  2258. - 2 integer subtraction
  2259. &lt;&lt; 3 bitwise shift
  2260. &gt;&gt; 3 bitwise shift
  2261. &gt; 4 logical greater than
  2262. &gt;= 4 logical greater than or equal
  2263. &lt; 4 logical less than
  2264. &lt;= 4 logical less than or equal
  2265. == 5 logical equal
  2266. != 5 logical not equal
  2267. &amp; 6 bitwise and
  2268. ^ 7 bitwise xor
  2269. | 8 bitwise or
  2270. &amp;&amp; 9 logical and
  2271. ^^ 10 logical xor
  2272. || 11 logical or
  2273. Operator priority can be ignored by using parentheses, for example (1 + 1) * 2
  2274. equals 4, while 1 + 1 * 2 equals 3.
  2275. </span><span style='color:#FFF'>String operations</span><span style='color:#AAA'>
  2276. Operators Priority Function
  2277. ------------------------------------------------
  2278. &gt; 4 alphabetical greater than
  2279. &gt;= 4 alphabetical greater than or equal
  2280. &lt; 4 alphabetical less than
  2281. &lt;= 4 alphabetical less than or equal
  2282. == 5 alphabetical equal using regex
  2283. != 5 alphabetical not equal using regex
  2284. === 5 alphabetical equal
  2285. !== 5 alphabetical not equal
  2286. Strings must be encased in double quotes or braces. The &gt; &gt;= &lt; &lt;= operators
  2287. perform basic string comparisons. The == != operators perform regular
  2288. expressions, with the argument on the left being the string, and the argument
  2289. on the right being the regex. For example {bla} == {%*a} would evaluate as 1.
  2290. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MATH'>math</a> and <a href='#REGEXP'>regexp</a>.
  2291. <a name='MESSAGE'></a>
  2292. </span><span style='color:#5F5'> MESSAGE
  2293. </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'>
  2294. This will show the message status of all your lists if typed without an
  2295. argument. If you set for example VARIABLES to OFF you will no longer be
  2296. spammed when correctly using the #VARIABLE and #UNVARIABLE commands.
  2297. </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>.
  2298. <a name='METRIC SYSTEM'></a>
  2299. </span><span style='color:#5F5'> METRIC SYSTEM
  2300. </span><span style='color:#AAA'>
  2301. Name Symbol Factor
  2302. --------------------------------------------------
  2303. Mega M 1 000 000
  2304. Kilo K 1 000
  2305. milli m 0.001
  2306. micro u 0.000 001
  2307. </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>.
  2308. <a name='MOUSE'></a>
  2309. </span><span style='color:#5F5'> MOUSE
  2310. </span><span style='color:#AAA'>
  2311. To enable xterm mouse tracking use #CONFIG MOUSE ON.
  2312. To see mouse events as they happen use #CONFIG MOUSE INFO. This
  2313. information can then be used to create mouse events with the #event
  2314. command and buttons with the #button command.
  2315. Visual buttons and pop-ups can be drawn on the screen with the #draw
  2316. command.
  2317. The input field can be changed and renamed using #screen inputregion,
  2318. which allows creating named events for enter handling.
  2319. Links can be created using the MSLP protocol which will generate link
  2320. specific events when clicked.
  2321. </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>.
  2322. <a name='MSDP'></a>
  2323. </span><span style='color:#5F5'> MSDP
  2324. </span><span style='color:#AAA'>
  2325. MSDP (Mud Server Data Protocol) is part of the #port functionality.
  2326. See #help event for additional documentation as all MSDP events are
  2327. available as regular events.
  2328. Available MSDP events can be queried using the MSDP protocol
  2329. as described in the specification.
  2330. </span><span style='color:#FFF'>
  2331. https://tintin.sourceforge.io/protocols/msdp
  2332. Related</span><span style='color:#AAA'>: <a href='#EVENT'>event</a> and <a href='#PORT'>port</a>.
  2333. <a name='MSLP'></a>
  2334. </span><span style='color:#5F5'> MSLP
  2335. </span><span style='color:#AAA'>
  2336. MSLP (Mud Server Link Protocol) requires enabling #config mouse on,
  2337. and creating the appropriate LINK events.
  2338. The simplest link can be created by surrounding a keyword with the
  2339. &bsol;e[4m and &bsol;e[24m tags.
  2340. </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}
  2341. This would display 'Exits: n, e, w.' as 'Exits: n, e, w.'.
  2342. When clicked this would trigger the PRESSED LINK MOUSE BUTTON ONE
  2343. event of which %4 will hold the link command and %6 holds the
  2344. link name, which in the case of a simple link will be empty.
  2345. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {PRESSED LINK MOUSE BUTTON ONE} {#send {%4}}
  2346. Keep in mind that if you change PRESSED to DOUBLE-CLICKED the link
  2347. will only work if the text does not scroll in between clicks.
  2348. If you want to create a complex link use an OSC code.
  2349. </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}
  2350. If you have the LINK event of the previous example set, the %4
  2351. argument will contain 'say I hate smurfs!'.
  2352. </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}
  2353. Notice the previous instance of ;; has been replaced with ;SEND;
  2354. which will name the link. This will generate a named event.
  2355. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {PRESSED LINK SEND MOUSE BUTTON ONE} {#send {%4}}
  2356. By naming links you can organize things a little bit better instead
  2357. of tunneling everything through the same event.
  2358. Keep in mind that the server is allowed to use &bsol;e]68;1;&bsol;a as well,
  2359. subsequently various security measures are in place.
  2360. To create secure links, which are filtered out when send by a server,
  2361. you need to use &bsol;e]68;2;&bsol;a, and they instead trigger the SECURE LINK
  2362. event.
  2363. </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}
  2364. </span><span style='color:#FFF'> </span><span style='color:#AAA'> #event {PRESSED SECURE LINK EXEC MOUSE BUTTON ONE} {%4}
  2365. This would make you start a reply when clicking on a tell.
  2366. </span><span style='color:#FFF'>Website</span><span style='color:#AAA'>: https://tintin.mudhalla.net/protocols/mslp
  2367. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#EVENT'>event</a> and <a href='#PORT'>port</a>.
  2368. <a name='NOP'></a>
  2369. </span><span style='color:#5F5'> NOP
  2370. </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'>
  2371. Short for 'no operation', and is ignored by the client. It is useful
  2372. for commenting in your coms file, any text after the nop and before a
  2373. semicolon or end of line is ignored. You shouldn't put braces { } in it
  2374. though, unless you close them properly.
  2375. </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
  2376. file.
  2377. For commenting out an entire trigger and especially large sections of
  2378. triggers you would want to use /* text */
  2379. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #nop This is the start of my script file.
  2380. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#READ'>read</a>
  2381. <a name='PARSE'></a>
  2382. </span><span style='color:#5F5'> PARSE
  2383. </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'>
  2384. Like the loop statement, parse will loop from start to finish through
  2385. the given string. The value of the current character is stored in the
  2386. provided variable.
  2387. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #parse {hello world} {char} {#show &dollar;char}
  2388. </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>.
  2389. <a name='PATH'></a>
  2390. </span><span style='color:#5F5'> PATH
  2391. </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'>
  2392. create Will clear the path and start path mapping.
  2393. delete Will delete the last move of the path.
  2394. describe Describe the path and current position.
  2395. destroy Will clear the path and stop path mapping.
  2396. get Will get either the length or position.
  2397. goto Go the the start, end, or given position index.
  2398. insert Add the given argument to the path.
  2399. load Load the given variable as the new path.
  2400. map Display the map and the current position.
  2401. move Move the position forward or backward. If a number is given
  2402. the position is changed by the given number of steps.
  2403. run Execute the current path, with an optional floating point
  2404. delay in seconds as the second argument.
  2405. save Save the path to a variable. You must specify whether you
  2406. want to save the path 'forward' or 'backward'.
  2407. swap Switch the forward and backward path.
  2408. unzip Load the given speedwalk as the new path.
  2409. walk Take one step forward or backward.
  2410. zip Turn the path into a speedwalk.
  2411. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #path ins {unlock n;open n} {unlock s;open s}
  2412. </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>.
  2413. <a name='PATHDIR'></a>
  2414. </span><span style='color:#5F5'> PATHDIR
  2415. </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'>
  2416. By default tintin sets the most commonly used movement commands
  2417. meaning you generally don't really have to bother with pathdirs.
  2418. Pathdirs are used by the #path and #map commands.
  2419. The first argument is a direction, the second argument is the reversed
  2420. direction. The reverse direction of north is south, etc.
  2421. The third argument is a spatial coordinate which is a power of two.
  2422. 'n' is 1, 'e' is 2, 's' is 4, 'w' is '8', 'u' is 16, 'd' is 32. The
  2423. exception is for compound directions, whose value should be the sum
  2424. of the values of each cardinal direction it is composed of. For
  2425. example, 'nw' is the sum of 'n' and 'w' which is 1 + 8, so 'nw'
  2426. needs to be given the value of 9. This value is required for the
  2427. #map functionality to work properly.
  2428. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #pathdir {ue} {dw} {18}
  2429. #pathdir {dw} {ue} {40}
  2430. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a pathdir with the #unpathdir command.
  2431. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MAP'>map</a> and <a href='#PATH'>path</a>.
  2432. <a name='PCRE'></a>
  2433. </span><span style='color:#5F5'> PCRE
  2434. </span><span style='color:#AAA'>
  2435. A regular expression, regex or regexp is a sequence of characters that
  2436. defines a search pattern. Since the 1980s, different syntaxes for
  2437. writing regular expressions exist, the two most widely used ones being
  2438. the POSIX syntax and the similar but more advanced Perl standard.
  2439. TinTin++ supports the Perl standard known as PCRE (Perl Compatible
  2440. Regular Expressions).
  2441. Regular expressions are an integral part of TinTin++, but keep in mind
  2442. that tintin doesn't allow you to use regular expressions directly,
  2443. instead it uses a simpler intermediate syntax that still allows more
  2444. complex expressions when needed.
  2445. Commands that utilize regular expressions are: action, alias, elseif,
  2446. gag, grep, highlight, if, kill, local, math, prompt, regexp, replace,
  2447. substitute, switch, variable and while. Several other commands use
  2448. regular expressions in minor ways. Fortunately the basics are very
  2449. easy to learn.
  2450. </span><span style='color:#FFF'> TinTin++ Regular Expression</span><span style='color:#AAA'>
  2451. The following support is available for regular expressions.
  2452. ^ match start of line.
  2453. &dollar; match of end of line.
  2454. &bsol; escape one character.
  2455. %1-%99 match of any text, stored in the corresponding index.
  2456. %0 should be avoided in the regex, contains all matched text.
  2457. { } embed a perl compatible regular expression, matches are stored.
  2458. %!{ } embed a perc compatible regular expression, matches are not stored.
  2459. [ ] . + | ( ) ? * are treated as normal text unless used within braces. Keep in
  2460. mind that { } is replaced with ( ) automatically unless %!{ } is used.
  2461. </span><span style='color:#FFF'>
  2462. TinTin++ Description POSIX</span><span style='color:#AAA'>
  2463. %d Match zero to any number of digits ([0-9]*?)
  2464. %D Match zero to any number of non-digits ([^0-9]*?)
  2465. %i Matches become case insensitive (?i)
  2466. %I Matches become case sensitive (default) (?-i)
  2467. %s Match zero to any number of spaces ([&bsol;r&bsol;n&bsol;t ]*?)
  2468. %w Match zero to any number of word characters ([A-Za-z0-9_]*?)
  2469. %W Match zero to any number of non-word characters ([^A-Za-z0-9_]*?)
  2470. %? Match zero or one character (.??)
  2471. %. Match one character (.)
  2472. %+ Match one to any number of characters (.+?)
  2473. %* Match zero to any number of characters (.*?)
  2474. </span><span style='color:#FFF'>
  2475. Variables</span><span style='color:#AAA'>
  2476. If you use %1 in an action to perform a match the matched string is
  2477. stored in the %1 variable which can be used in the action body.
  2478. Example: #act {%1 says 'Tickle me'} {tickle %1}
  2479. If you use %2 the match is stored in %2, etc. If you use an unnumbered
  2480. match like %* or %S the match is stored at the last used index
  2481. incremented by one.
  2482. Example: #act {%3 says '%*'} {#if {&quot;%4&quot; == &quot;Tickle me&quot;} {tickle %3}}
  2483. The maximum variable index is 99. If you begin an action with %* the
  2484. match is stored in %1. You should never use %0 in the trigger part of
  2485. an action, when used in the body of an action %0 contains all the parts
  2486. of the string that were matched.
  2487. To prevent a match from being stored use %!*, %!w, etc.
  2488. </span><span style='color:#FFF'>
  2489. Perl Compatible Regular Expressions</span><span style='color:#AAA'>
  2490. You can embed a PCRE (Perl Compatible Regular Expression) using curley
  2491. braces { }, these braces are replaced with parentheses ( ) unless you
  2492. use %!{ }.
  2493. </span><span style='color:#FFF'>
  2494. Or</span><span style='color:#AAA'>
  2495. You can separate alternatives within a PCRE using the | character.
  2496. Example: #act {%* raises {his|her|its} eyebrows.} {say 42..}
  2497. </span><span style='color:#FFF'>
  2498. Brackets</span><span style='color:#AAA'>
  2499. You can group alternatives and ranges within a PCRE using brackets.
  2500. Example: #act {%* says 'Who is number {[1-9]}?} {say &dollar;number[%2] is number %2}
  2501. The example only triggers if someone provides a number between 1 and
  2502. 9. Any other character will cause the action to not trigger.
  2503. Example: #act {%* says 'Set password to {[^0-9]*}&dollar;} {say The password must
  2504. contain at least one number, not for security reasons, but just to
  2505. annoy you.} {4}
  2506. When the ^ character is used within brackets it creates an inverse
  2507. search, [^0-9] matches every character except for a number between 0
  2508. and 9.
  2509. </span><span style='color:#FFF'>
  2510. Quantification</span><span style='color:#AAA'>
  2511. A quantifier placed after a match specifies how often the match is
  2512. allowed to occur.
  2513. ? repeat zero or one time.
  2514. * repeat zero or multiple times.
  2515. + repeat once or multiple times.
  2516. {n} repeat exactly n times, n must be a number.
  2517. {n,} repeat at least n times, n must be a number.
  2518. {n,o} repeat between n and o times, n and o must be a number.
  2519. Example: #act {%* says 'Who is number {[1-9][0-9]{0,2}}?} {Say &dollar;number[%2] is
  2520. number %2}
  2521. The example only triggers if someone provides a number between 1 and
  2522. 999.
  2523. </span><span style='color:#FFF'>Parantheses</span><span style='color:#AAA'>
  2524. TinTin Regular Expressions automatically add parenthesis, for example
  2525. %* translates to (.*?) in PCRE unless the %* is found at the start or
  2526. end of the line, in which cases it translates to (.*). Paranthesis in
  2527. PCRE causes a change in execution priority similar to mathematical
  2528. expressions, but parentheses also causes the match to be stored to a
  2529. variable.
  2530. When nesting multiple sets of parentheses each nest is assigned its
  2531. numerical variable in order of appearance.
  2532. Example: #act {%* chats '{Mu(ha)+}'} {chat %2ha!}
  2533. If someone chats Muha you will chat Muhaha! If someone chats Muhaha
  2534. you will chat Muhahaha!
  2535. </span><span style='color:#FFF'>Lazy vs Greedy</span><span style='color:#AAA'>
  2536. By default regex matches are greedy, meaning {.*} will capture as much
  2537. text as possible.
  2538. Example: #regex {bli bla blo} {^{.*} {.*}&dollar;} {#show Arg1=(&amp;1) Arg2=(&amp;2)}
  2539. This will display: Arg1=(bli bla) Arg2=(blo)
  2540. By appending a ? behind a regex it becomes lazy, meaning {.*?} will
  2541. capture as little text as possible.
  2542. Example: #regex {bli bla blo} {^{.*?} {.*?}&dollar;} {#show Arg1=(&amp;1) Arg2=(&amp;2)}
  2543. This will display: Arg1=(bli) Arg2=(bla blo).
  2544. </span><span style='color:#FFF'>Escape Codes</span><span style='color:#AAA'>
  2545. PCRE support the following escape codes.
  2546. </span><span style='color:#FFF'>
  2547. PCRE Description POSIX</span><span style='color:#AAA'>
  2548. &bsol;A Match start of string ^
  2549. &bsol;b Match word boundaries (^|&bsol;r|&bsol;n|&bsol;t| |&dollar;)
  2550. &bsol;B Match non-word boundaries [^&bsol;r&bsol;n&bsol;t ]
  2551. &bsol;c Insert control character &bsol;c
  2552. &bsol;d Match digits [0-9]
  2553. &bsol;D Match non-digits [^0-9]
  2554. &bsol;e Insert escape character &bsol;e
  2555. &bsol;f Insert form feed character &bsol;f
  2556. &bsol;n Insert line feed character &bsol;n
  2557. &bsol;r Insert carriage return character &bsol;r
  2558. &bsol;s Match spaces [&bsol;r&bsol;n&bsol;t ]
  2559. &bsol;S Match non-spaces [^&bsol;r&bsol;n&bsol;t ]
  2560. &bsol;t Insert tab character &bsol;t
  2561. &bsol;w Match letters, numbers, and underscores [A-Za-z0-9_]
  2562. &bsol;W Match non-letters, numbers, and underscores [^A-Za-z0-9_]
  2563. &bsol;x Insert hex character &bsol;x
  2564. &bsol;Z Match end of string &dollar;
  2565. &bsol;s matches one space, &bsol;s+ matches one or multiple spaces.
  2566. </span><span style='color:#FFF'>Color triggers</span><span style='color:#AAA'>
  2567. To make matching easier text triggers (Actions, Gags, Highlights,
  2568. Prompts, and Substitutes) have their color codes stripped. If you
  2569. want to create a color trigger you must start the triggers with a ~
  2570. (tilde). To make escape codes visible use #config {convert meta} on.
  2571. Example: #action {~&bsol;e[1;37m%1} {#var roomname %1}
  2572. If the room name is the only line on the server in bright white
  2573. white color trigger will save the roomname.
  2574. This covers the basics. PCRE has more options, most of which are
  2575. somewhat obscure, so you'll have to read a PCRE manual for additional
  2576. information.
  2577. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#MAP'>map</a> and <a href='#PATH'>path</a>.
  2578. <a name='PORT'></a>
  2579. </span><span style='color:#5F5'> PORT
  2580. </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'>
  2581. </span><span style='color:#FFF'>#port {init} {name} {port} {file}
  2582. </span><span style='color:#AAA'> Initilize a port session.
  2583. </span><span style='color:#FFF'>#port {call} {address} {port}
  2584. </span><span style='color:#AAA'> Connect to a remote socket.
  2585. </span><span style='color:#FFF'>#port {color} {color names}
  2586. </span><span style='color:#AAA'> Set the default color of port messages.
  2587. </span><span style='color:#FFF'>#port {dnd}
  2588. </span><span style='color:#AAA'> Do Not Disturb. Decline new connections
  2589. </span><span style='color:#FFF'>#port {group} {name} {group}
  2590. </span><span style='color:#AAA'> Assign a socket group.
  2591. </span><span style='color:#FFF'>#port {ignore} {name}
  2592. </span><span style='color:#AAA'> Ignore a socket
  2593. </span><span style='color:#FFF'>#port {info}
  2594. </span><span style='color:#AAA'> Display information about the port session.
  2595. </span><span style='color:#FFF'>#port {name} {name}
  2596. </span><span style='color:#AAA'> Change socket name.
  2597. </span><span style='color:#FFF'>#port {prefix} {text}
  2598. </span><span style='color:#AAA'> Set prefix before each message.
  2599. </span><span style='color:#FFF'>#port {send} {name|all} {text}
  2600. </span><span style='color:#AAA'> Send data to socket
  2601. </span><span style='color:#FFF'>#port {uninitialize}
  2602. </span><span style='color:#AAA'> Uninitialize the port session.
  2603. </span><span style='color:#FFF'>#port {who}
  2604. </span><span style='color:#AAA'> Show all connections
  2605. </span><span style='color:#FFF'>#port {zap} {name}
  2606. </span><span style='color:#AAA'> Close a connection
  2607. The port command is very similar to chat except that it creates a
  2608. new session dedicated to receiving socket connections at the given
  2609. port number without built-in support for a communication protocol.
  2610. You can init with 0 as the port number to create a dummy session.
  2611. </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>.
  2612. <a name='PROMPT'></a>
  2613. </span><span style='color:#5F5'> PROMPT
  2614. </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'>
  2615. Prompt is a feature for split window mode, which will capture a line
  2616. received from the server and display it on the status bar of your
  2617. split screen terminal. You would define &lt;text&gt; and &lt;new text&gt; the
  2618. same way as you would with #substitute.
  2619. The row number is optional and useful if you use a non standard split
  2620. mode. A positive row number draws #row lines from the top while a
  2621. negative number draws #row lines from the bottom. Without an argument
  2622. #prompt will write to the default split line, which is one row above
  2623. the input line, typically at row -2.
  2624. The col number is optional and can be used to set the column index.
  2625. A positive col number draws the given number of columns from the left,
  2626. while a negative col number draws from the right. If you leave the
  2627. col number empty tintin will clear the row before printing at the
  2628. start of the row.
  2629. The #show command takes a row and col argument as well so it's also
  2630. possible to place text on your split lines using #show.
  2631. </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.
  2632. </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
  2633. substitutions.
  2634. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a prompt with the #unprompt command.
  2635. </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>.
  2636. <a name='READ'></a>
  2637. </span><span style='color:#5F5'> READ
  2638. </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'>
  2639. Reads a commands file into memory. The coms file is merged in with
  2640. the currently loaded commands. Duplicate commands are overwritten.
  2641. If you uses braces, { and } you can use several lines for 1 commands.
  2642. This however means you must always match every { with a } for the read
  2643. command to work.
  2644. You can comment out triggers using /* text */
  2645. </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>.
  2646. <a name='REGEXP'></a>
  2647. </span><span style='color:#5F5'> REGEXP
  2648. </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'>
  2649. Compares the string to the given regular expression.
  2650. The expression can contain escapes, and if you want to match a literal
  2651. &bsol; character you'll have to use &bsol;&bsol; to match a single backslash.
  2652. Variables are stored in &amp;1 to &amp;99 with &amp;0 holding the matched
  2653. substring.
  2654. ^ force match of start of line.
  2655. &dollar; force match of end of line.
  2656. &bsol; escape one character.
  2657. %1-%99 lazy match of any text, available at %1-%99.
  2658. %0 should be avoided in triggers, and if left alone lists all matches.
  2659. { } embed a raw regular expression, matches are stored to %1-%99.
  2660. %!{ } embed a raw regular expression, matches are not stored.
  2661. [ ] . + | ( ) ? * are treated as normal text unlessed used within
  2662. braces. Keep in mind that { } is replaced with ( ) automatically
  2663. unless %!{ } is used.
  2664. Of the following the (lazy) match is available at %1-%99 + 1
  2665. %d match zero to any number of digits.
  2666. %D match zero to any number of non digits.
  2667. %s match zero to any number of spaces.
  2668. %S match zero to any number of non spaces.
  2669. %w match zero to any number of word characters.
  2670. %W match zero to any number of non word characters.
  2671. Experimental (subject to change) matches are:
  2672. %a match zero to any number of characters including newlines.
  2673. %A match zero to any number of newlines.
  2674. %p match zero to any number of printable characters.
  2675. %P match zero to any number of non printable characters.
  2676. %u match zero to any number of unicode characters.
  2677. %U match zero to any number of non unicode characters.
  2678. If you want to match 1 digit use %+1d, if you want to match between 3
  2679. and 5 spaces use %+3..5s, if you want to match 0 or more word
  2680. characters use %+0..w, etc.
  2681. %+ match one to any number of characters.
  2682. %? match zero or one character.
  2683. %. match one character.
  2684. %* match zero to any number of characters.
  2685. %i matching becomes case insensitive.
  2686. %I matching becomes case sensitive (default).
  2687. The match is automatically stored to a value between %1 and %99
  2688. starting at %1 and incrementing by 1 for every regex. If you use
  2689. %15 as a regular expression, the next unnumbered regular expression
  2690. would be %16. To prevent a match from being stored use %!*, %!w, etc.
  2691. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #regexp {bli bla blo} {bli {.*} blo} {#show &amp;1}
  2692. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: Like an alias or function #regex has its own scope.
  2693. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#PCRE'>pcre</a> and <a href='#REPLACE'>replace</a>.
  2694. <a name='REPEAT'></a>
  2695. </span><span style='color:#5F5'> REPEAT
  2696. </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'>
  2697. Sometimes you want to repeat the same command multiple times. This is the
  2698. easiest way to accomplish that.
  2699. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #10 {buy bread}
  2700. </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>.
  2701. <a name='REPLACE'></a>
  2702. </span><span style='color:#5F5'> REPLACE
  2703. </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'>
  2704. Searches the given variable, replacing each occurrence of 'oldtext'
  2705. with 'newtext'. The 'oldtext' argument is a regular expression.
  2706. Variables are stored in &amp;1 to &amp;99 with &amp;0 holding the entire matched
  2707. substring.
  2708. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #function rnd #math result 1d9;#replace test {%.} {@rnd{}}
  2709. </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>.
  2710. <a name='RETURN'></a>
  2711. </span><span style='color:#5F5'> RETURN
  2712. </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'>
  2713. This command can be used to break out of a command string being
  2714. executed.
  2715. If used inside a #function you can use #return with an argument to both
  2716. break out of the function and set the result variable.
  2717. </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>.
  2718. <a name='RUN'></a>
  2719. </span><span style='color:#5F5'> RUN
  2720. </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'>
  2721. The run command works much like the system command except that it
  2722. runs the command in a pseudo terminal. The run command also creates
  2723. a session that treats the given shell command as a server. This
  2724. allows you to run ssh, as well as any other shell application, with
  2725. full tintin scripting capabilities. If a file name is given the file
  2726. is loaded prior to execution.
  2727. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #run {somewhere} {ssh someone@somewhere.com}
  2728. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #run {something} {tail -f chats.log}
  2729. </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>.
  2730. <a name='SCAN'></a>
  2731. </span><span style='color:#5F5'> SCAN
  2732. </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'>
  2733. The scan command is a file reading utility.
  2734. </span><span style='color:#FFF'>#scan {abort}
  2735. </span><span style='color:#AAA'> This command must be called from with a SCAN event and will
  2736. abort the scan if one is in progress.
  2737. </span><span style='color:#FFF'>#scan {csv} &lt;filename&gt;
  2738. </span><span style='color:#AAA'> The scan csv command reads in a comma separated value file
  2739. without printing the content to the screen. Instead it triggers one
  2740. of two events.
  2741. The SCAN CSV HEADER event is triggered on the first line of the csv
  2742. file. The SCAN CSV LINE event is triggered on the second and each
  2743. subsequent line of the csv file. The %0 argument contains the entire
  2744. line, with %1 containing the first value, %2 the second value, etc,
  2745. all the way up to %99.
  2746. Values containing spaces must be surrounded with quotes, keep in mind
  2747. newlines within quotes are not supported. Use two quotes to print one
  2748. literal quote character.
  2749. </span><span style='color:#FFF'> #scan {dir} &lt;filename&gt; &lt;variable&gt;
  2750. </span><span style='color:#AAA'>
  2751. The scan dir command will read the given filename or directory and
  2752. store any gathered information into the provided variable.
  2753. </span><span style='color:#FFF'>#scan {tsv} &lt;filename&gt;
  2754. </span><span style='color:#AAA'> The scan tsv &lt;filename&gt; command reads in a tab separated value file
  2755. without printing the content to the screen. Instead it triggers the
  2756. SCAN TSV HEADER event for the first line and SCAN TSV LINE for all
  2757. subsequent lines.
  2758. </span><span style='color:#FFF'>#scan {file} &lt;filename&gt; {commands}
  2759. </span><span style='color:#AAA'> The scan file command reads the given files and executes the
  2760. commands argument. &amp;0 contains the raw content of the file and
  2761. &amp;1 contains the plain content. &amp;2 contains the raw byte size of the
  2762. file and &amp;3 the plain byte size. &amp;5 contains the line count.
  2763. </span><span style='color:#FFF'>#scan {txt} &lt;filename&gt;
  2764. </span><span style='color:#AAA'> The scan txt &lt;filename&gt; command reads in a file and sends its content
  2765. to the screen as if it was send by a server. After using scan you can
  2766. use page-up and down to view the file.
  2767. This command is useful to convert ansi color files to html or viewing
  2768. raw log files.
  2769. Actions, highlights, and substitutions will trigger as normal, and it
  2770. is possible to create an action to execute #scan abort to prematurely
  2771. stop the scan.
  2772. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#READ'>read</a> and <a href='#TEXTIN'>textin</a>.
  2773. <a name='SCREEN'></a>
  2774. </span><span style='color:#5F5'> SCREEN
  2775. </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'>}
  2776. </span><span style='color:#AAA'>The screen command offers a variety of screen manipulation
  2777. commands and utilities.
  2778. </span><span style='color:#FFF'>#screen blur
  2779. </span><span style='color:#AAA'> Move the terminal to the back of the stack.
  2780. </span><span style='color:#FFF'>#screen clear [all|scroll region|square] &lt;args&gt;
  2781. </span><span style='color:#AAA'> Provide 4 arguments defining the top left and bottom right corner
  2782. when erasing a square.
  2783. </span><span style='color:#FFF'>#screen focus
  2784. </span><span style='color:#AAA'> Move the terminal to the front of the stack.
  2785. </span><span style='color:#FFF'>#screen fullscreen [on|off]
  2786. </span><span style='color:#AAA'> Toggles fullscreen mode when used without an argument.
  2787. </span><span style='color:#FFF'>#screen get &lt;option&gt; &lt;var&gt;
  2788. </span><span style='color:#AAA'> Get various screen options and save them to &lt;var&gt;. Use #screen
  2789. get without an argument to see all available options.
  2790. </span><span style='color:#FFF'>#screen info
  2791. </span><span style='color:#AAA'> Debugging information.
  2792. </span><span style='color:#FFF'>#screen inputregion &lt;square&gt; [name]
  2793. </span><span style='color:#AAA'> Set the input region. The name argument is optional and can be
  2794. used to create named RECEIVED INPUT [NAME] events.
  2795. </span><span style='color:#FFF'>#screen load &lt;both|label|title&gt;
  2796. </span><span style='color:#AAA'> Reload the saved title, label, or both.
  2797. </span><span style='color:#FFF'>#screen minimize &lt;on|off&gt;
  2798. </span><span style='color:#AAA'> Minimize with on, restore with off.
  2799. </span><span style='color:#FFF'>#screen maximize [on|off]
  2800. </span><span style='color:#AAA'> Maximize with on, restore with off.
  2801. </span><span style='color:#FFF'>#screen move &lt;height&gt; &lt;width&gt;
  2802. </span><span style='color:#AAA'> Move the upper left corner of the terminal to pixel coordinate.
  2803. </span><span style='color:#FFF'>#screen raise &lt;event&gt;
  2804. </span><span style='color:#AAA'> This will raise several screen events with %1 and %2 arguments.
  2805. </span><span style='color:#FFF'>#screen refresh
  2806. </span><span style='color:#AAA'> Terminal dependant, may do nothing.
  2807. </span><span style='color:#FFF'>#screen rescale &lt;height&gt; &lt;width&gt;
  2808. </span><span style='color:#AAA'> Resize the screen to the given height and width in pixels.
  2809. </span><span style='color:#FFF'>#screen resize &lt;rows&gt; &lt;cols&gt;
  2810. </span><span style='color:#AAA'> Resize the screen to the given height and width in characters.
  2811. </span><span style='color:#FFF'>#screen save &lt;both|label|title&gt;
  2812. </span><span style='color:#AAA'> Save the title, label, or both.
  2813. </span><span style='color:#FFF'>#screen scroll &lt;square&gt;
  2814. </span><span style='color:#AAA'> Set the scrolling region, changes the split setting.
  2815. </span><span style='color:#FFF'>#screen set &lt;both|label|title&gt;
  2816. </span><span style='color:#AAA'> Set the title, label, or both. Only title works on Windows.
  2817. </span><span style='color:#FFF'>#screen swap
  2818. </span><span style='color:#AAA'> Swap the input and scroll region.
  2819. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#BELL'>bell</a>
  2820. <a name='SCREEN READER'></a>
  2821. </span><span style='color:#5F5'> SCREEN READER
  2822. </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'>
  2823. Screen reader mode is enabled by using #config screen on. The main
  2824. purpose of the screen reader mode is to report to servers that a
  2825. screen reader is being used by utilizing the MTTS standard. The MTTS
  2826. specification is available at:
  2827. http://tintin.sourceforge.net/protocols/mtts
  2828. With the screen reader mode enabled TinTin++ will try to remove visual
  2829. elements where possible.
  2830. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CONFIG'>config</a>
  2831. <a name='SCRIPT'></a>
  2832. </span><span style='color:#5F5'> SCRIPT
  2833. </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'>
  2834. The script command works much like the system command except that it
  2835. treats the generated echos as commands if no variable is provided.
  2836. This is useful for running php, perl, ruby, and python scripts. You
  2837. can run these scripts either from file or from within tintin if the
  2838. scripting language allows this.
  2839. If you provide a variable the output of the script is stored as a list.
  2840. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {ruby -e 'print &quot;#show hello world&quot;'}
  2841. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {python -c 'print &quot;#show hello world&quot;'}
  2842. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {php -r 'echo &quot;#show hello world&quot;'}
  2843. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #script {path} {pwd};#show The path is &dollar;path[1].
  2844. </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>.
  2845. <a name='SEND'></a>
  2846. </span><span style='color:#5F5'> SEND
  2847. </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'>
  2848. Sends the text directly to the server, useful if you want to start
  2849. with an escape code.
  2850. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#TEXTIN'>textin</a>
  2851. <a name='SESSION'></a>
  2852. </span><span style='color:#5F5'> SESSION
  2853. </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'>
  2854. Starts a telnet session with the given name, host, port, and optional
  2855. file name. The name can be anything you want, except the name of an
  2856. already existing session, a number, or the keywords '+' and '-'.
  2857. If a file name is given the file is only read if the session
  2858. succesfully connects.
  2859. Without an argument #session shows the currently defined sessions.
  2860. If you have more than one session, you can use the following commands:
  2861. #session {-} Switch to the previous session.
  2862. #session {+} Switch to the next session.
  2863. #session {&lt;number&gt;} Switch to the given session. Session 0 is the
  2864. startup session, +1 the first, +2 the second, and
  2865. -1 is the last session. Sessions are (currently)
  2866. sorted in order of creation.
  2867. #gts Switch to the startup session. The name gts stands
  2868. for global tintin session.
  2869. #ats Switch to the active session. The name ats stands
  2870. for active tintin session.
  2871. not necessarily the calling session.
  2872. #{name} Activates to the session with the given name.
  2873. #{name} {command}: Executes a command with the given session without
  2874. changing the active session.
  2875. @&lt;name&gt;{text}: Parse text in the given session, substituting the
  2876. variables and functions, and print the result in
  2877. the current active session.
  2878. The startup session is named 'gts' and can be used for relog scripts.
  2879. Do keep in mind that tickers do not work in the startup session.
  2880. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #event {SESSION DISCONNECTED} {#gts #delay 10 #ses %0 tintin.net 4321}
  2881. </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>.
  2882. <a name='SESSIONNAME'></a>
  2883. </span><span style='color:#5F5'> SESSIONNAME
  2884. </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'>
  2885. You can create multiple sessions with the #session command. By default only one
  2886. session is active, meaning commands you input are executed in the active
  2887. session. While all sessions receive output, only output sent to the active
  2888. session is displayed.
  2889. When you create a session with the #session command you must specify a session
  2890. name, the session name, prepended with a hashtag, can be used to activate the
  2891. session when used without an argument. If an argument is given it will be
  2892. executed by that session as a command, the session will not be activated.
  2893. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #ses one tintin.net 23;#ses two tintin.net 23;#one;#two grin
  2894. This will create two sessions, the session that was created last (two in this
  2895. case) will be automatically activated upon creation. Using #one, session one is
  2896. activated. Using #two grin, the grin social will be executed by session two,
  2897. session one will remain the active session.
  2898. </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>.
  2899. <a name='SHOWME'></a>
  2900. </span><span style='color:#5F5'> SHOWME
  2901. </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'>
  2902. Display the string to the terminal, do not send to the server. Useful
  2903. for status, warnings, etc. The {row} and col number are optional and
  2904. work the same way as the row number of the #prompt trigger.
  2905. Actions can be triggered by the show command. If you want to avoid
  2906. this from happening use: #line ignore #show {&lt;string&gt;}.
  2907. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #tick {TICK} {#delay 50 #show 10 SECONDS TO TICK!!!} {60}
  2908. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: The #prompt helpfile contains more information on using the
  2909. option {row} and {col} arguments.
  2910. </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>.
  2911. <a name='SNOOP'></a>
  2912. </span><span style='color:#5F5'> SNOOP
  2913. </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'>
  2914. If there are multiple sessions active, this command allows you to
  2915. monitor what is going on in the sessions that are not currently active.
  2916. The line of text from other sessions will be prefixed by the session's
  2917. name.
  2918. You can toggle off snoop mode by executing #snoop a second time.
  2919. By using the scroll argument you will snoop the session's scroll
  2920. region which will overwrite the display of whichever session is active.
  2921. You can change the size and location of a session's scroll region by
  2922. using the #split and #screen scrollregion commands.
  2923. </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>.
  2924. <a name='SPEEDWALK'></a>
  2925. </span><span style='color:#5F5'> SPEEDWALK
  2926. SPEEDWALK V1
  2927. </span><span style='color:#AAA'>
  2928. Speedwalking allows you to enter multiple directions without using
  2929. semicolons. Directions should be prefixed with a number and will be
  2930. executed the given number of times.
  2931. You can enable speedwalking with #CONFIG {SPEEDWALK} {ON}.
  2932. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: Without speedwalk, you have to type:
  2933. </span><span style='color:#FFF'>s;s;w;w;w;w;w;s;s;s;w;w;w;n;n;w
  2934. </span><span style='color:#AAA'>With speedwalk, you only have to type:
  2935. </span><span style='color:#FFF'>2s5w3s3w2nw
  2936. </span><span style='color:#5F5'>SPEEDWALK V2
  2937. </span><span style='color:#AAA'>
  2938. Modern MUDs have increasingly adopted the use of diagonal exits, like
  2939. ne, nw, sw, and se. To make accomodations for this the #map and #path
  2940. command no longer interpret nesw as a speedwalk and require this to
  2941. be written as 1n1e1s1w, which then allows 2ne2e to execute ne;ne;e;e.
  2942. Speedwalks entered on the input line continue to use the v1 system.
  2943. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #path unzip 3n1e2nw
  2944. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #map move 3ne1d
  2945. </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>.
  2946. <a name='SPLIT'></a>
  2947. </span><span style='color:#5F5'> SPLIT
  2948. </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'>}
  2949. </span><span style='color:#AAA'>
  2950. This option requires for your terminal to support VT100 emulation.
  2951. #split allows the creation of a top status bar, a left and right status
  2952. bar, a scrolling region, a bottom status bar, and an input line.
  2953. </span><span style='color:#0AA'>╭────────────────────────────────╮
  2954. │</span><span style='color:#FFF'> top bar </span><span style='color:#0AA'> │
  2955. ├──────┬──────────────────┬──────┤
  2956. │</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'>│
  2957. │</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'>│
  2958. ├──────┴──────────────────┴──────┤
  2959. │</span><span style='color:#FFF'> bottom bar </span><span style='color:#0AA'> │
  2960. ├────────────────────────────────┤
  2961. │</span><span style='color:#FFF'> input bar </span><span style='color:#0AA'> │
  2962. ╰────────────────────────────────╯
  2963. </span><span style='color:#AAA'>
  2964. By default the bottom status bar is filled with dashes --- and
  2965. subsequently it is also known as the split line. The scrolling
  2966. region is also known as the main screen and this is where all
  2967. incoming text is displayed by default.
  2968. If you use #split without an argument it will set the height of the
  2969. top status bar to 0 lines and the bottom status bar to 1 line.
  2970. If you use #split with one argument it will set the height of the top
  2971. status bar to the given number of lines and the bottom status bar will
  2972. be set to 1 line.
  2973. If you use two arguments the first argument is the height of the top
  2974. status bar and the second argument the height of the bottom status bar.
  2975. The third and fourth argument are optional and default to 0.
  2976. The fifth argument is optional and sets the size of the input bar, it
  2977. defaults to 1.
  2978. It is possible to use negative arguments in which case the bar width
  2979. defines the minimum width of the scrolling region.
  2980. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #split 0 0
  2981. This will create a split screen with just a scrolling region and an
  2982. input line. Great for the minimalist.
  2983. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #split 1 1 0 -80
  2984. This will create a split screen with a single line top and bottom
  2985. bar. The left bar has a width of 0 while the right bar will be of
  2986. variable width. If for example the screen is 100 columns wide, 80
  2987. columns will be used for the scrolling region, leaving a right bar
  2988. with a width of 20 columns.
  2989. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can display text on the split line(s) with the #prompt and
  2990. #show {line} {row} commands.
  2991. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove split mode with the #unsplit command.
  2992. </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>.
  2993. <a name='SSL'></a>
  2994. </span><span style='color:#5F5'> SSL
  2995. </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'>}
  2996. Starts a secure socket telnet session with the given name, host, port,
  2997. and optional file name.
  2998. 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>.
  2999. <a name='STATEMENTS'></a>
  3000. </span><span style='color:#5F5'> STATEMENTS
  3001. </span><span style='color:#AAA'>
  3002. TinTin++ knows the following statements.
  3003. #break
  3004. #case {value} {true}
  3005. #continue
  3006. #default {commands}
  3007. #else {commands}
  3008. #elseif {expression} {true}
  3009. #foreach {list} {variable} {commands}
  3010. #if {expression} {true}
  3011. #loop {min} {max} {variable} {commands}
  3012. #parse {string} {variable} {commands}
  3013. #return {value}
  3014. #switch {expression} {commands}
  3015. #while {expression} {commands}
  3016. </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>.
  3017. <a name='SUBSTITUTE'></a>
  3018. </span><span style='color:#5F5'> SUBSTITUTE
  3019. </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'>
  3020. Allows you to replace text from the server with the new text.
  3021. The %1-%99 variables can be used to capture text and use it as part of
  3022. the new output.
  3023. Color codes can be used to color the new text, to restore the color to
  3024. that of the original line the &lt;900&gt; color code can be used.
  3025. If only one argument is given, all active substitutions that match the
  3026. argument are displayed. Wildcards can be used, see '#help regex' for
  3027. additional information on that subject.
  3028. If no argument is given, all subs are displayed.
  3029. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {Zoe} {ZOE}
  3030. Any instance of Zoe will be replaced with ZOE.
  3031. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #sub {~&bsol;e[0;34m} {&bsol;e[1;34m}
  3032. Replace generic dark blue color codes with bright blue ones.
  3033. </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}
  3034. Replaces all occurrences of 'massacres' with 'MASSACRES' in red.
  3035. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help action', for more information about triggers.
  3036. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help colors', for more information.
  3037. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a substitution with the #unsubstitute command.
  3038. </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>.
  3039. <a name='SUBSTITUTIONS'></a>
  3040. </span><span style='color:#5F5'> SUBSTITUTIONS
  3041. </span><span style='color:#AAA'> TinTin++ will perform various types of substitions as detailed below.
  3042. </span><span style='color:#5F5'> Variables
  3043. </span><span style='color:#FFF'>&dollar; &amp; * @</span><span style='color:#AAA'> All variable and function names must begin with an alphabetic
  3044. character, followed by any combination of alphanumeric characters and
  3045. underscores.
  3046. </span><span style='color:#FFF'>&dollar;</span><span style='color:#AAA'> The dollar sign is used to retrieve the value of a variable.
  3047. </span><span style='color:#FFF'>&amp;</span><span style='color:#AAA'> The ampersand sign is used to retrieve the index of a variable.
  3048. </span><span style='color:#FFF'>*</span><span style='color:#AAA'> The astrix sign is used to retrieve the name of a variable.
  3049. </span><span style='color:#FFF'>@</span><span style='color:#AAA'> The at sign is used for functions.
  3050. </span><span style='color:#FFF'>[ ]</span><span style='color:#AAA'> Brackets are used for nested variables which function as an
  3051. associative array. Associative arrays are also known as tables and
  3052. maps. Regex can be used within brackets to match multiple variables.
  3053. </span><span style='color:#FFF'>+ -</span><span style='color:#AAA'> The plus and minus signs are used to access variables by their index,
  3054. with the first variable having index +1, and the last variable
  3055. having index -1. Variables are ordered alphanumerically.
  3056. All variables and functions can be escaped by doubling the sign,
  3057. like &dollar;&dollar;variable_name or @@function_name. To escape a variable
  3058. twice use &dollar;&dollar;&dollar;var_name. One escape is removed each time tintin
  3059. needs to substitute a variable or function.
  3060. </span><span style='color:#5F5'> Arguments
  3061. </span><span style='color:#FFF'>%0 - %99</span><span style='color:#AAA'> The percent sign followed by a number is used for arguments by the
  3062. following triggers:
  3063. alias, action, button, event, function, prompt, and substitute.
  3064. </span><span style='color:#FFF'>&amp;0 - &amp;99</span><span style='color:#AAA'> The ampersand sign followed by a number is used for arguments in the
  3065. regex and replace commands.
  3066. All trigger and command arguments can be escaped by doubling the
  3067. sign like %%1 or &amp;&amp;1. One escape is removed each time tintin
  3068. substitutes trigger or command arguments. To escape three times
  3069. triple the sign like %%%1, etc.
  3070. </span><span style='color:#5F5'> Colors
  3071. </span><span style='color:#FFF'>&lt;000&gt;</span><span style='color:#AAA'> Three alphanumeric characters encapsulated by the less- and greater-
  3072. than signs are used for 4 and 8 bit color codes.
  3073. </span><span style='color:#FFF'>&lt;0000&gt;</span><span style='color:#AAA'> Either a B (background) or F (foreground) followed by three
  3074. hexadecimal characters encapsulated by &lt; &gt; signs are used for 12
  3075. bit color codes. Requires truecolor capable terminal.
  3076. </span><span style='color:#FFF'>&lt;0000000&gt;</span><span style='color:#AAA'> Either a B (background) or F (foreground) followed by six
  3077. hexadecimal characters encapsulated by &lt; &gt; signs are used for 24
  3078. bit color codes. Requires truecolor capable terminal.
  3079. More information is available at #help color.
  3080. </span><span style='color:#5F5'> Escapes
  3081. </span><span style='color:#FFF'>&bsol; </span><span style='color:#AAA'> The back slash is used to escape a character. All available options
  3082. are listed at #help escape. Escapes are typically escaped when text
  3083. leaves the client, by being send to a server, the shell, being
  3084. displayed on the screen, or being processed as part of a regex.
  3085. Escapes try to mimic escapes in PCRE when possible.
  3086. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#CHARACTERS'>characters</a>, <a href='#COLORS'>colors</a>, <a href='#ESCAPES'>escapes</a>, <a href='#INFO'>info</a> and <a href='#PCRE'>pcre</a>.
  3087. <a name='SUSPEND'></a>
  3088. </span><span style='color:#5F5'> SUSPEND
  3089. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #cursor suspend
  3090. Temporarily suspends tintin and returns you to your shell. To
  3091. return to tintin, type 'fg' at the shell prompt.
  3092. While suspended your tintin sessions will freeze. To keep a
  3093. suspended session running use the #detach command.
  3094. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#END'>end</a>
  3095. <a name='SWITCH'></a>
  3096. </span><span style='color:#5F5'> SWITCH
  3097. </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'>
  3098. The switch command works similar to the switch statement in other
  3099. languages. When the 'switch' command is encountered its body is parsed
  3100. and each 'case' command found will be compared to the conditional
  3101. argument of the switch and executed if there is a match.
  3102. When comparing strings both the switch and case arguments must be
  3103. enclosed in quote characters.
  3104. If the 'default' command is found and no 'case' statement has been
  3105. matched the default command's argument is executed.
  3106. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #switch {1d4} {#case 1 cackle;#case 2 smile;#default giggle}
  3107. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#STATEMENTS'>statements</a>
  3108. <a name='SYSTEM'></a>
  3109. </span><span style='color:#5F5'> SYSTEM
  3110. </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'>
  3111. Executes the command specified as a shell command.
  3112. </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>.
  3113. <a name='TAB'></a>
  3114. </span><span style='color:#5F5'> TAB
  3115. </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'>
  3116. Adds a word to the tab completion list, alphabetically sorted.
  3117. If no tabs are defined tintin will use the scrollback buffer for auto
  3118. tab completion.
  3119. Tabbing behavior can be modified with the #cursor tab command which
  3120. by default is bound to the tab key.
  3121. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a tab with the #untab command.
  3122. </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>.
  3123. <a name='TEXTIN'></a>
  3124. </span><span style='color:#5F5'> TEXTIN
  3125. </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'>
  3126. Textin allows the user to read in a file, and send its contents
  3127. directly to the server. Useful for doing online creation, or message
  3128. writing.
  3129. The delay is in seconds and takes a floating point number which is
  3130. cumulatively applied to each outgoing line.
  3131. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#SCAN'>scan</a> and <a href='#SEND'>send</a>.
  3132. <a name='TICKER'></a>
  3133. </span><span style='color:#5F5'> TICKER
  3134. </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'>
  3135. Executes given command every # of seconds. Floating point precision
  3136. for the interval is allowed. A ticker cannot fire more often than
  3137. 10 times per second.
  3138. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: Tickers don't work in the startup session.
  3139. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a ticker with the #unticker command.
  3140. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#DELAY'>delay</a> and <a href='#EVENT'>event</a>.
  3141. <a name='TIME'></a>
  3142. </span><span style='color:#5F5'> TIME
  3143. </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'>
  3144. The %t format specifier of the #format command allows printing dates
  3145. using the strftime() format specifiers. By default the time stamp used
  3146. is the current time, if you want to print a past or future date use:
  3147. </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'>
  3148. The current epoch time value is obtained using #format {time} {%T}.
  3149. When using %t the argument should contain strftime format specifiers.
  3150. The output may differ depending on your locale.
  3151. %a Abbreviated name of the day of the week (mon ... sun).
  3152. %A Full name of the day of the week. (Monday ... Sunday)
  3153. %b Abbreviated name of the month (Jan ... Dec)
  3154. %B Full name of the month. (January ... December)
  3155. %C 2 digit numeric century. (19 ... 20)
  3156. %d 2 digit numeric day of the month (01 ... 31)
  3157. %H 2 digit numeric 24-hour clock hour. (00 ... 23)
  3158. %I 2 digit numeric 12-hour clock hour. (01 ... 12)
  3159. %j 3 digit numeric day of the year (001 ... 366)
  3160. %m 2 digit numeric month of the year (01 ... 12)
  3161. %M 2 digit numeric minute of the hour (00 ... 59)
  3162. %p Abbreviated 12 hour clock period (AM ... PM)
  3163. %P Abbreviated 12 hour clock period (am ... pm)
  3164. %S 2 digit numeric second of the minute (00 ...59
  3165. %u 1 digit numeric day of the week (1 ... 7)
  3166. %U 2 digit numeric Sunday week of the year (00 ... 53
  3167. %w 1 digit numeric day of the week (0 ... 6)
  3168. %W 2 digit numeric Monday week of the year (00 ... 53
  3169. %y 2 digit numeric year. (70 ... 38)
  3170. %Y 4 digit numeric year. (1970 ... 2038)
  3171. %z 5 digit timezone offset. (-1200 ... +1400)
  3172. %Z Abbreviated name of the time zone.
  3173. </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>.
  3174. <a name='VARIABLE'></a>
  3175. </span><span style='color:#5F5'> VARIABLE
  3176. </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'>
  3177. Variables differ from the %0-99 arguments in the fact that you can
  3178. specify a full word as a variable, and they stay in memory for the
  3179. full session unless they are changed. They can be saved in the
  3180. coms file, and can be set to different values if you have two or
  3181. more sessions running at the same time. Variables are global for
  3182. each session and can be accessed by adding a &dollar; before the variable
  3183. name.
  3184. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #alias {target} {#var target %0}
  3185. #alias {x} {kick &dollar;target}
  3186. The name of a variable must exist of only letters, numbers and
  3187. underscores in order to be substituted. If you do not meet these
  3188. requirements do not panic, simply encapsulate the variable in braces:
  3189. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #variable {cool website} {http://tintin.sourceforge.net}
  3190. #chat I was on &dollar;{cool website} yesterday!.
  3191. Variables can be escaped by adding additional &dollar; signs.
  3192. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #var test 42;#showme &dollar;&dollar;test
  3193. Variables can be nested using brackets:
  3194. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #var hp[self] 34;#var hp[target] 46
  3195. You can see the first nest of a variable using &dollar;variable[+1] and the
  3196. last nest using &dollar;variable[-1]. Using &dollar;variable[-2] will report the
  3197. second last variable, and so on. To show all indices use *variable[].
  3198. To show all values use &dollar;variable[]. To show all values from index 2
  3199. through 4 use &dollar;variable[+2..4].
  3200. Nested variables are also known as tables, table generally being used
  3201. to refer to several variables nested within one specific variable.
  3202. It's possible to use regular expressions.
  3203. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show {Targets starting with the letter A: &dollar;targets[A%*]
  3204. To see the internal index of a variable use &amp;&lt;variable name&gt;. To see
  3205. the size of a table you would use: &amp;targets[] or &amp;targets[%*]. A non
  3206. existent nested variable will report itself as 0.
  3207. </span><span style='color:#FFF'>Example</span><span style='color:#AAA'>: #show {Number of targets starting with A: &amp;targets[A%*]
  3208. In some scripts you need to know the name of a nested variable. This
  3209. is also known as the key, and you can get it using *variable. For
  3210. example *target[+1]. To get the first variable's name use *{+1}.
  3211. It's also possible to declare a table using brace notation. Using
  3212. #var hp[self] 34 is the equivalent of #var {hp} {{self}{34}}. This
  3213. also allows merging tables. #var hp[self] 34;#var hp[target] 46 is
  3214. the equivalent of #var {hp} {{self}{34} {target}{46}} as well as
  3215. #var {hp} {{self}{34}} {{target}{46}} or if you want to get creative
  3216. the equivalent of #var hp[self] 34;#var {hp} {&dollar;hp} {{target}{46}}.
  3217. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: You can remove a variable with the #unvariable command.
  3218. </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>.
  3219. <a name='WHILE'></a>
  3220. </span><span style='color:#5F5'> WHILE
  3221. </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'>
  3222. This command works similar to a 'while' statement in other languages.
  3223. When a 'while' command is encourated, the conditional is evaluated,
  3224. and if TRUE (any non-zero result) the commands are executed. The
  3225. 'while' loop will be repeated indefinitely until the conditional is
  3226. FALSE or the #BREAK or #RETURN commands are found.
  3227. The 'while' statement is only evaluated if it is read, so you must
  3228. nest it inside a trigger, like an alias or action.
  3229. The conditional is evaluated exactly the same as in the 'math' command.
  3230. </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}
  3231. </span><span style='color:#FFF'>Comment</span><span style='color:#AAA'>: See '#help math', for more information.
  3232. </span><span style='color:#FFF'>Related</span><span style='color:#AAA'>: <a href='#STATEMENTS'>statements</a>
  3233. <a name='WRITE'></a>
  3234. </span><span style='color:#5F5'> WRITE
  3235. </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'>
  3236. Writes all current actions, aliases, subs, highlights, and variables
  3237. to a command file, specified by filename.
  3238. By default you cannot write to .map files to prevent accidentally
  3239. overwriting a map file. Use the FORCE argument to ignore this
  3240. protection.
  3241. </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>.
  3242. <a name='ZAP'></a>
  3243. </span><span style='color:#5F5'> ZAP
  3244. </span><span style='color:#FFF'>Command</span><span style='color:#AAA'>: #zap {[session]}
  3245. Kill your current session. If there is no current session, it will
  3246. cause the program to terminate. If you provide an argument it'll zap
  3247. the given session instead.
  3248. </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>.