help.html 286 KB

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