options.lua 323 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063
  1. --- @meta _
  2. -- THIS FILE IS GENERATED
  3. -- DO NOT EDIT
  4. error('Cannot require a meta file')
  5. ---@class vim.bo
  6. ---@field [integer] vim.bo
  7. vim.bo = vim.bo
  8. ---@class vim.wo
  9. ---@field [integer] vim.wo
  10. vim.wo = vim.wo
  11. --- Allow CTRL-_ in Insert mode. This is default off, to avoid that users
  12. --- that accidentally type CTRL-_ instead of SHIFT-_ get into reverse
  13. --- Insert mode, and don't know how to get out. See 'revins'.
  14. ---
  15. --- @type boolean
  16. vim.o.allowrevins = false
  17. vim.o.ari = vim.o.allowrevins
  18. vim.go.allowrevins = vim.o.allowrevins
  19. vim.go.ari = vim.go.allowrevins
  20. --- Tells Vim what to do with characters with East Asian Width Class
  21. --- Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
  22. --- letters, Cyrillic letters).
  23. ---
  24. --- There are currently two possible values:
  25. --- "single": Use the same width as characters in US-ASCII. This is
  26. --- expected by most users.
  27. --- "double": Use twice the width of ASCII characters.
  28. --- *E834* *E835*
  29. --- The value "double" cannot be used if 'listchars' or 'fillchars'
  30. --- contains a character that would be double width. These errors may
  31. --- also be given when calling setcellwidths().
  32. ---
  33. --- The values are overruled for characters specified with
  34. --- `setcellwidths()`.
  35. ---
  36. --- There are a number of CJK fonts for which the width of glyphs for
  37. --- those characters are solely based on how many octets they take in
  38. --- legacy/traditional CJK encodings. In those encodings, Euro,
  39. --- Registered sign, Greek/Cyrillic letters are represented by two octets,
  40. --- therefore those fonts have "wide" glyphs for them. This is also
  41. --- true of some line drawing characters used to make tables in text
  42. --- file. Therefore, when a CJK font is used for GUI Vim or
  43. --- Vim is running inside a terminal (emulators) that uses a CJK font
  44. --- (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
  45. --- this option should be set to "double" to match the width perceived
  46. --- by Vim with the width of glyphs in the font. Perhaps it also has
  47. --- to be set to "double" under CJK MS-Windows when the system locale is
  48. --- set to one of CJK locales. See Unicode Standard Annex #11
  49. --- (https://www.unicode.org/reports/tr11).
  50. ---
  51. --- @type 'single'|'double'
  52. vim.o.ambiwidth = "single"
  53. vim.o.ambw = vim.o.ambiwidth
  54. vim.go.ambiwidth = vim.o.ambiwidth
  55. vim.go.ambw = vim.go.ambiwidth
  56. --- This option can be set to start editing Arabic text.
  57. --- Setting this option will:
  58. --- - Set the 'rightleft' option, unless 'termbidi' is set.
  59. --- - Set the 'arabicshape' option, unless 'termbidi' is set.
  60. --- - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
  61. --- between typing English and Arabic key mapping.
  62. --- - Set the 'delcombine' option
  63. ---
  64. --- Resetting this option will:
  65. --- - Reset the 'rightleft' option.
  66. --- - Disable the use of 'keymap' (without changing its value).
  67. --- Note that 'arabicshape' and 'delcombine' are not reset (it is a global
  68. --- option).
  69. --- Also see `arabic.txt`.
  70. ---
  71. --- @type boolean
  72. vim.o.arabic = false
  73. vim.o.arab = vim.o.arabic
  74. vim.wo.arabic = vim.o.arabic
  75. vim.wo.arab = vim.wo.arabic
  76. --- When on and 'termbidi' is off, the required visual character
  77. --- corrections that need to take place for displaying the Arabic language
  78. --- take effect. Shaping, in essence, gets enabled; the term is a broad
  79. --- one which encompasses:
  80. --- a) the changing/morphing of characters based on their location
  81. --- within a word (initial, medial, final and stand-alone).
  82. --- b) the enabling of the ability to compose characters
  83. --- c) the enabling of the required combining of some characters
  84. --- When disabled the display shows each character's true stand-alone
  85. --- form.
  86. --- Arabic is a complex language which requires other settings, for
  87. --- further details see `arabic.txt`.
  88. ---
  89. --- @type boolean
  90. vim.o.arabicshape = true
  91. vim.o.arshape = vim.o.arabicshape
  92. vim.go.arabicshape = vim.o.arabicshape
  93. vim.go.arshape = vim.go.arabicshape
  94. --- When on, Vim will change the current working directory whenever you
  95. --- open a file, switch buffers, delete a buffer or open/close a window.
  96. --- It will change to the directory containing the file which was opened
  97. --- or selected. When a buffer has no name it also has no directory, thus
  98. --- the current directory won't change when navigating to it.
  99. --- Note: When this option is on some plugins may not work.
  100. ---
  101. --- @type boolean
  102. vim.o.autochdir = false
  103. vim.o.acd = vim.o.autochdir
  104. vim.go.autochdir = vim.o.autochdir
  105. vim.go.acd = vim.go.autochdir
  106. --- Copy indent from current line when starting a new line (typing <CR>
  107. --- in Insert mode or when using the "o" or "O" command). If you do not
  108. --- type anything on the new line except <BS> or CTRL-D and then type
  109. --- <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
  110. --- to another line has the same effect, unless the 'I' flag is included
  111. --- in 'cpoptions'.
  112. --- When autoindent is on, formatting (with the "gq" command or when you
  113. --- reach 'textwidth' in Insert mode) uses the indentation of the first
  114. --- line.
  115. --- When 'smartindent' or 'cindent' is on the indent is changed in
  116. --- a different way.
  117. ---
  118. --- @type boolean
  119. vim.o.autoindent = true
  120. vim.o.ai = vim.o.autoindent
  121. vim.bo.autoindent = vim.o.autoindent
  122. vim.bo.ai = vim.bo.autoindent
  123. --- When a file has been detected to have been changed outside of Vim and
  124. --- it has not been changed inside of Vim, automatically read it again.
  125. --- When the file has been deleted this is not done, so you have the text
  126. --- from before it was deleted. When it appears again then it is read.
  127. --- `timestamp`
  128. --- If this option has a local value, use this command to switch back to
  129. --- using the global value:
  130. ---
  131. --- ```vim
  132. --- set autoread<
  133. --- ```
  134. ---
  135. ---
  136. --- @type boolean
  137. vim.o.autoread = true
  138. vim.o.ar = vim.o.autoread
  139. vim.bo.autoread = vim.o.autoread
  140. vim.bo.ar = vim.bo.autoread
  141. vim.go.autoread = vim.o.autoread
  142. vim.go.ar = vim.go.autoread
  143. --- Write the contents of the file, if it has been modified, on each
  144. --- `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
  145. --- `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
  146. --- a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
  147. --- to another file.
  148. --- A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
  149. --- set to "hide" and `:next` is used.
  150. --- Note that for some commands the 'autowrite' option is not used, see
  151. --- 'autowriteall' for that.
  152. --- Some buffers will not be written, specifically when 'buftype' is
  153. --- "nowrite", "nofile", "terminal" or "prompt".
  154. --- USE WITH CARE: If you make temporary changes to a buffer that you
  155. --- don't want to be saved this option may cause it to be saved anyway.
  156. --- Renaming the buffer with ":file {name}" may help avoid this.
  157. ---
  158. --- @type boolean
  159. vim.o.autowrite = false
  160. vim.o.aw = vim.o.autowrite
  161. vim.go.autowrite = vim.o.autowrite
  162. vim.go.aw = vim.go.autowrite
  163. --- Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
  164. --- ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
  165. --- Setting this option also implies that Vim behaves like 'autowrite' has
  166. --- been set.
  167. ---
  168. --- @type boolean
  169. vim.o.autowriteall = false
  170. vim.o.awa = vim.o.autowriteall
  171. vim.go.autowriteall = vim.o.autowriteall
  172. vim.go.awa = vim.go.autowriteall
  173. --- When set to "dark" or "light", adjusts the default color groups for
  174. --- that background type. The `TUI` or other UI sets this on startup
  175. --- (triggering `OptionSet`) if it can detect the background color.
  176. ---
  177. --- This option does NOT change the background color, it tells Nvim what
  178. --- the "inherited" (terminal/GUI) background looks like.
  179. --- See `:hi-normal` if you want to set the background color explicitly.
  180. --- *g:colors_name*
  181. --- When a color scheme is loaded (the "g:colors_name" variable is set)
  182. --- changing 'background' will cause the color scheme to be reloaded. If
  183. --- the color scheme adjusts to the value of 'background' this will work.
  184. --- However, if the color scheme sets 'background' itself the effect may
  185. --- be undone. First delete the "g:colors_name" variable when needed.
  186. ---
  187. --- Normally this option would be set in the vimrc file. Possibly
  188. --- depending on the terminal name. Example:
  189. ---
  190. --- ```vim
  191. --- if $TERM ==# "xterm"
  192. --- set background=dark
  193. --- endif
  194. --- ```
  195. --- When this option is changed, the default settings for the highlight groups
  196. --- will change. To use other settings, place ":highlight" commands AFTER
  197. --- the setting of the 'background' option.
  198. ---
  199. --- @type 'light'|'dark'
  200. vim.o.background = "dark"
  201. vim.o.bg = vim.o.background
  202. vim.go.background = vim.o.background
  203. vim.go.bg = vim.go.background
  204. --- Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
  205. --- mode. This is a list of items, separated by commas. Each item allows
  206. --- a way to backspace over something:
  207. --- value effect ~
  208. --- indent allow backspacing over autoindent
  209. --- eol allow backspacing over line breaks (join lines)
  210. --- start allow backspacing over the start of insert; CTRL-W and CTRL-U
  211. --- stop once at the start of insert.
  212. --- nostop like start, except CTRL-W and CTRL-U do not stop at the start of
  213. --- insert.
  214. ---
  215. --- When the value is empty, Vi compatible backspacing is used, none of
  216. --- the ways mentioned for the items above are possible.
  217. ---
  218. --- @type string
  219. vim.o.backspace = "indent,eol,start"
  220. vim.o.bs = vim.o.backspace
  221. vim.go.backspace = vim.o.backspace
  222. vim.go.bs = vim.go.backspace
  223. --- Make a backup before overwriting a file. Leave it around after the
  224. --- file has been successfully written. If you do not want to keep the
  225. --- backup file, but you do want a backup while the file is being
  226. --- written, reset this option and set the 'writebackup' option (this is
  227. --- the default). If you do not want a backup file at all reset both
  228. --- options (use this if your file system is almost full). See the
  229. --- `backup-table` for more explanations.
  230. --- When the 'backupskip' pattern matches, a backup is not made anyway.
  231. --- When 'patchmode' is set, the backup may be renamed to become the
  232. --- oldest version of a file.
  233. ---
  234. --- @type boolean
  235. vim.o.backup = false
  236. vim.o.bk = vim.o.backup
  237. vim.go.backup = vim.o.backup
  238. vim.go.bk = vim.go.backup
  239. --- When writing a file and a backup is made, this option tells how it's
  240. --- done. This is a comma-separated list of words.
  241. ---
  242. --- The main values are:
  243. --- "yes" make a copy of the file and overwrite the original one
  244. --- "no" rename the file and write a new one
  245. --- "auto" one of the previous, what works best
  246. ---
  247. --- Extra values that can be combined with the ones above are:
  248. --- "breaksymlink" always break symlinks when writing
  249. --- "breakhardlink" always break hardlinks when writing
  250. ---
  251. --- Making a copy and overwriting the original file:
  252. --- - Takes extra time to copy the file.
  253. --- + When the file has special attributes, is a (hard/symbolic) link or
  254. --- has a resource fork, all this is preserved.
  255. --- - When the file is a link the backup will have the name of the link,
  256. --- not of the real file.
  257. ---
  258. --- Renaming the file and writing a new one:
  259. --- + It's fast.
  260. --- - Sometimes not all attributes of the file can be copied to the new
  261. --- file.
  262. --- - When the file is a link the new file will not be a link.
  263. ---
  264. --- The "auto" value is the middle way: When Vim sees that renaming the
  265. --- file is possible without side effects (the attributes can be passed on
  266. --- and the file is not a link) that is used. When problems are expected,
  267. --- a copy will be made.
  268. ---
  269. --- The "breaksymlink" and "breakhardlink" values can be used in
  270. --- combination with any of "yes", "no" and "auto". When included, they
  271. --- force Vim to always break either symbolic or hard links by doing
  272. --- exactly what the "no" option does, renaming the original file to
  273. --- become the backup and writing a new file in its place. This can be
  274. --- useful for example in source trees where all the files are symbolic or
  275. --- hard links and any changes should stay in the local source tree, not
  276. --- be propagated back to the original source.
  277. --- *crontab*
  278. --- One situation where "no" and "auto" will cause problems: A program
  279. --- that opens a file, invokes Vim to edit that file, and then tests if
  280. --- the open file was changed (through the file descriptor) will check the
  281. --- backup file instead of the newly created file. "crontab -e" is an
  282. --- example, as are several `file-watcher` daemons like inotify. In that
  283. --- case you probably want to switch this option.
  284. ---
  285. --- When a copy is made, the original file is truncated and then filled
  286. --- with the new text. This means that protection bits, owner and
  287. --- symbolic links of the original file are unmodified. The backup file,
  288. --- however, is a new file, owned by the user who edited the file. The
  289. --- group of the backup is set to the group of the original file. If this
  290. --- fails, the protection bits for the group are made the same as for
  291. --- others.
  292. ---
  293. --- When the file is renamed, this is the other way around: The backup has
  294. --- the same attributes of the original file, and the newly written file
  295. --- is owned by the current user. When the file was a (hard/symbolic)
  296. --- link, the new file will not! That's why the "auto" value doesn't
  297. --- rename when the file is a link. The owner and group of the newly
  298. --- written file will be set to the same ones as the original file, but
  299. --- the system may refuse to do this. In that case the "auto" value will
  300. --- again not rename the file.
  301. ---
  302. --- @type string
  303. vim.o.backupcopy = "auto"
  304. vim.o.bkc = vim.o.backupcopy
  305. vim.bo.backupcopy = vim.o.backupcopy
  306. vim.bo.bkc = vim.bo.backupcopy
  307. vim.go.backupcopy = vim.o.backupcopy
  308. vim.go.bkc = vim.go.backupcopy
  309. --- List of directories for the backup file, separated with commas.
  310. --- - The backup file will be created in the first directory in the list
  311. --- where this is possible. If none of the directories exist Nvim will
  312. --- attempt to create the last directory in the list.
  313. --- - Empty means that no backup file will be created ('patchmode' is
  314. --- impossible!). Writing may fail because of this.
  315. --- - A directory "." means to put the backup file in the same directory
  316. --- as the edited file.
  317. --- - A directory starting with "./" (or ".\" for MS-Windows) means to put
  318. --- the backup file relative to where the edited file is. The leading
  319. --- "." is replaced with the path name of the edited file.
  320. --- ("." inside a directory name has no special meaning).
  321. --- - Spaces after the comma are ignored, other spaces are considered part
  322. --- of the directory name. To have a space at the start of a directory
  323. --- name, precede it with a backslash.
  324. --- - To include a comma in a directory name precede it with a backslash.
  325. --- - A directory name may end in an '/'.
  326. --- - For Unix and Win32, if a directory ends in two path separators "//",
  327. --- the swap file name will be built from the complete path to the file
  328. --- with all path separators changed to percent '%' signs. This will
  329. --- ensure file name uniqueness in the backup directory.
  330. --- On Win32, it is also possible to end with "\\". However, When a
  331. --- separating comma is following, you must use "//", since "\\" will
  332. --- include the comma in the file name. Therefore it is recommended to
  333. --- use '//', instead of '\\'.
  334. --- - Environment variables are expanded `:set_env`.
  335. --- - Careful with '\' characters, type one before a space, type two to
  336. --- get one in the option (see `option-backslash`), for example:
  337. ---
  338. --- ```vim
  339. --- set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  340. --- ```
  341. ---
  342. --- See also 'backup' and 'writebackup' options.
  343. --- If you want to hide your backup files on Unix, consider this value:
  344. ---
  345. --- ```vim
  346. --- set backupdir=./.backup,~/.backup,.,/tmp
  347. --- ```
  348. --- You must create a ".backup" directory in each directory and in your
  349. --- home directory for this to work properly.
  350. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  351. --- directories from the list. This avoids problems when a future version
  352. --- uses another default.
  353. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  354. --- security reasons.
  355. ---
  356. --- @type string
  357. vim.o.backupdir = ".,$XDG_STATE_HOME/nvim/backup//"
  358. vim.o.bdir = vim.o.backupdir
  359. vim.go.backupdir = vim.o.backupdir
  360. vim.go.bdir = vim.go.backupdir
  361. --- String which is appended to a file name to make the name of the
  362. --- backup file. The default is quite unusual, because this avoids
  363. --- accidentally overwriting existing files with a backup file. You might
  364. --- prefer using ".bak", but make sure that you don't have files with
  365. --- ".bak" that you want to keep.
  366. --- Only normal file name characters can be used; `/\*?[|<>` are illegal.
  367. ---
  368. --- If you like to keep a lot of backups, you could use a BufWritePre
  369. --- autocommand to change 'backupext' just before writing the file to
  370. --- include a timestamp.
  371. ---
  372. --- ```vim
  373. --- au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
  374. --- ```
  375. --- Use 'backupdir' to put the backup in a different directory.
  376. ---
  377. --- @type string
  378. vim.o.backupext = "~"
  379. vim.o.bex = vim.o.backupext
  380. vim.go.backupext = vim.o.backupext
  381. vim.go.bex = vim.go.backupext
  382. --- A list of file patterns. When one of the patterns matches with the
  383. --- name of the file which is written, no backup file is created. Both
  384. --- the specified file name and the full path name of the file are used.
  385. --- The pattern is used like with `:autocmd`, see `autocmd-pattern`.
  386. --- Watch out for special characters, see `option-backslash`.
  387. --- When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
  388. --- default value. "/tmp/*" is only used for Unix.
  389. ---
  390. --- WARNING: Not having a backup file means that when Vim fails to write
  391. --- your buffer correctly and then, for whatever reason, Vim exits, you
  392. --- lose both the original file and what you were writing. Only disable
  393. --- backups if you don't care about losing the file.
  394. ---
  395. --- Note that environment variables are not expanded. If you want to use
  396. --- $HOME you must expand it explicitly, e.g.:
  397. ---
  398. --- ```vim
  399. --- let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
  400. --- ```
  401. --- Note that the default also makes sure that "crontab -e" works (when a
  402. --- backup would be made by renaming the original file crontab won't see
  403. --- the newly created file). Also see 'backupcopy' and `crontab`.
  404. ---
  405. --- @type string
  406. vim.o.backupskip = "/tmp/*"
  407. vim.o.bsk = vim.o.backupskip
  408. vim.go.backupskip = vim.o.backupskip
  409. vim.go.bsk = vim.go.backupskip
  410. --- Specifies for which events the bell will not be rung. It is a comma-
  411. --- separated list of items. For each item that is present, the bell
  412. --- will be silenced. This is most useful to specify specific events in
  413. --- insert mode to be silenced.
  414. --- You can also make it flash by using 'visualbell'.
  415. ---
  416. --- item meaning when present ~
  417. --- all All events.
  418. --- backspace When hitting <BS> or <Del> and deleting results in an
  419. --- error.
  420. --- cursor Fail to move around using the cursor keys or
  421. --- <PageUp>/<PageDown> in `Insert-mode`.
  422. --- complete Error occurred when using `i_CTRL-X_CTRL-K` or
  423. --- `i_CTRL-X_CTRL-T`.
  424. --- copy Cannot copy char from insert mode using `i_CTRL-Y` or
  425. --- `i_CTRL-E`.
  426. --- ctrlg Unknown Char after <C-G> in Insert mode.
  427. --- error Other Error occurred (e.g. try to join last line)
  428. --- (mostly used in `Normal-mode` or `Cmdline-mode`).
  429. --- esc hitting <Esc> in `Normal-mode`.
  430. --- hangul Ignored.
  431. --- lang Calling the beep module for Lua/Mzscheme/TCL.
  432. --- mess No output available for `g<`.
  433. --- showmatch Error occurred for 'showmatch' function.
  434. --- operator Empty region error `cpo-E`.
  435. --- register Unknown register after <C-R> in `Insert-mode`.
  436. --- shell Bell from shell output `:!`.
  437. --- spell Error happened on spell suggest.
  438. --- term Bell from `:terminal` output.
  439. --- wildmode More matches in `cmdline-completion` available
  440. --- (depends on the 'wildmode' setting).
  441. ---
  442. --- This is most useful to fine tune when in Insert mode the bell should
  443. --- be rung. For Normal mode and Ex commands, the bell is often rung to
  444. --- indicate that an error occurred. It can be silenced by adding the
  445. --- "error" keyword.
  446. ---
  447. --- @type string
  448. vim.o.belloff = "all"
  449. vim.o.bo = vim.o.belloff
  450. vim.go.belloff = vim.o.belloff
  451. vim.go.bo = vim.go.belloff
  452. --- This option should be set before editing a binary file. You can also
  453. --- use the `-b` Vim argument. When this option is switched on a few
  454. --- options will be changed (also when it already was on):
  455. --- 'textwidth' will be set to 0
  456. --- 'wrapmargin' will be set to 0
  457. --- 'modeline' will be off
  458. --- 'expandtab' will be off
  459. --- Also, 'fileformat' and 'fileformats' options will not be used, the
  460. --- file is read and written like 'fileformat' was "unix" (a single <NL>
  461. --- separates lines).
  462. --- The 'fileencoding' and 'fileencodings' options will not be used, the
  463. --- file is read without conversion.
  464. --- NOTE: When you start editing a(nother) file while the 'bin' option is
  465. --- on, settings from autocommands may change the settings again (e.g.,
  466. --- 'textwidth'), causing trouble when editing. You might want to set
  467. --- 'bin' again when the file has been loaded.
  468. --- The previous values of these options are remembered and restored when
  469. --- 'bin' is switched from on to off. Each buffer has its own set of
  470. --- saved option values.
  471. --- To edit a file with 'binary' set you can use the `++bin` argument.
  472. --- This avoids you have to do ":set bin", which would have effect for all
  473. --- files you edit.
  474. --- When writing a file the <EOL> for the last line is only written if
  475. --- there was one in the original file (normally Vim appends an <EOL> to
  476. --- the last line if there is none; this would make the file longer). See
  477. --- the 'endofline' option.
  478. ---
  479. --- @type boolean
  480. vim.o.binary = false
  481. vim.o.bin = vim.o.binary
  482. vim.bo.binary = vim.o.binary
  483. vim.bo.bin = vim.bo.binary
  484. --- When writing a file and the following conditions are met, a BOM (Byte
  485. --- Order Mark) is prepended to the file:
  486. --- - this option is on
  487. --- - the 'binary' option is off
  488. --- - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
  489. --- endian variants.
  490. --- Some applications use the BOM to recognize the encoding of the file.
  491. --- Often used for UCS-2 files on MS-Windows. For other applications it
  492. --- causes trouble, for example: "cat file1 file2" makes the BOM of file2
  493. --- appear halfway through the resulting file. Gcc doesn't accept a BOM.
  494. --- When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
  495. --- check for the presence of the BOM is done and 'bomb' set accordingly.
  496. --- Unless 'binary' is set, it is removed from the first line, so that you
  497. --- don't see it when editing. When you don't change the options, the BOM
  498. --- will be restored when writing the file.
  499. ---
  500. --- @type boolean
  501. vim.o.bomb = false
  502. vim.bo.bomb = vim.o.bomb
  503. --- This option lets you choose which characters might cause a line
  504. --- break if 'linebreak' is on. Only works for ASCII characters.
  505. ---
  506. --- @type string
  507. vim.o.breakat = " \t!@*-+;:,./?"
  508. vim.o.brk = vim.o.breakat
  509. vim.go.breakat = vim.o.breakat
  510. vim.go.brk = vim.go.breakat
  511. --- Every wrapped line will continue visually indented (same amount of
  512. --- space as the beginning of that line), thus preserving horizontal blocks
  513. --- of text.
  514. ---
  515. --- @type boolean
  516. vim.o.breakindent = false
  517. vim.o.bri = vim.o.breakindent
  518. vim.wo.breakindent = vim.o.breakindent
  519. vim.wo.bri = vim.wo.breakindent
  520. --- Settings for 'breakindent'. It can consist of the following optional
  521. --- items and must be separated by a comma:
  522. --- min:{n} Minimum text width that will be kept after
  523. --- applying 'breakindent', even if the resulting
  524. --- text should normally be narrower. This prevents
  525. --- text indented almost to the right window border
  526. --- occupying lots of vertical space when broken.
  527. --- (default: 20)
  528. --- shift:{n} After applying 'breakindent', the wrapped line's
  529. --- beginning will be shifted by the given number of
  530. --- characters. It permits dynamic French paragraph
  531. --- indentation (negative) or emphasizing the line
  532. --- continuation (positive).
  533. --- (default: 0)
  534. --- sbr Display the 'showbreak' value before applying the
  535. --- additional indent.
  536. --- (default: off)
  537. --- list:{n} Adds an additional indent for lines that match a
  538. --- numbered or bulleted list (using the
  539. --- 'formatlistpat' setting).
  540. --- (default: 0)
  541. --- list:-1 Uses the width of a match with 'formatlistpat' for
  542. --- indentation.
  543. --- column:{n} Indent at column {n}. Will overrule the other
  544. --- sub-options. Note: an additional indent may be
  545. --- added for the 'showbreak' setting.
  546. --- (default: off)
  547. ---
  548. --- @type string
  549. vim.o.breakindentopt = ""
  550. vim.o.briopt = vim.o.breakindentopt
  551. vim.wo.breakindentopt = vim.o.breakindentopt
  552. vim.wo.briopt = vim.wo.breakindentopt
  553. --- This option specifies what happens when a buffer is no longer
  554. --- displayed in a window:
  555. --- <empty> follow the global 'hidden' option
  556. --- hide hide the buffer (don't unload it), even if 'hidden' is
  557. --- not set
  558. --- unload unload the buffer, even if 'hidden' is set; the
  559. --- `:hide` command will also unload the buffer
  560. --- delete delete the buffer from the buffer list, even if
  561. --- 'hidden' is set; the `:hide` command will also delete
  562. --- the buffer, making it behave like `:bdelete`
  563. --- wipe wipe the buffer from the buffer list, even if
  564. --- 'hidden' is set; the `:hide` command will also wipe
  565. --- out the buffer, making it behave like `:bwipeout`
  566. ---
  567. --- CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
  568. --- are lost without a warning. Also, these values may break autocommands
  569. --- that switch between buffers temporarily.
  570. --- This option is used together with 'buftype' and 'swapfile' to specify
  571. --- special kinds of buffers. See `special-buffers`.
  572. ---
  573. --- @type ''|'hide'|'unload'|'delete'|'wipe'
  574. vim.o.bufhidden = ""
  575. vim.o.bh = vim.o.bufhidden
  576. vim.bo.bufhidden = vim.o.bufhidden
  577. vim.bo.bh = vim.bo.bufhidden
  578. --- When this option is set, the buffer shows up in the buffer list. If
  579. --- it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
  580. --- This option is reset by Vim for buffers that are only used to remember
  581. --- a file name or marks. Vim sets it when starting to edit a buffer.
  582. --- But not when moving to a buffer with ":buffer".
  583. ---
  584. --- @type boolean
  585. vim.o.buflisted = true
  586. vim.o.bl = vim.o.buflisted
  587. vim.bo.buflisted = vim.o.buflisted
  588. vim.bo.bl = vim.bo.buflisted
  589. --- The value of this option specifies the type of a buffer:
  590. --- <empty> normal buffer
  591. --- acwrite buffer will always be written with `BufWriteCmd`s
  592. --- help help buffer (do not set this manually)
  593. --- nofile buffer is not related to a file, will not be written
  594. --- nowrite buffer will not be written
  595. --- quickfix list of errors `:cwindow` or locations `:lwindow`
  596. --- terminal `terminal-emulator` buffer
  597. --- prompt buffer where only the last line can be edited, meant
  598. --- to be used by a plugin, see `prompt-buffer`
  599. ---
  600. --- This option is used together with 'bufhidden' and 'swapfile' to
  601. --- specify special kinds of buffers. See `special-buffers`.
  602. --- Also see `win_gettype()`, which returns the type of the window.
  603. ---
  604. --- Be careful with changing this option, it can have many side effects!
  605. --- One such effect is that Vim will not check the timestamp of the file,
  606. --- if the file is changed by another program this will not be noticed.
  607. ---
  608. --- A "quickfix" buffer is only used for the error list and the location
  609. --- list. This value is set by the `:cwindow` and `:lwindow` commands and
  610. --- you are not supposed to change it.
  611. ---
  612. --- "nofile" and "nowrite" buffers are similar:
  613. --- both: The buffer is not to be written to disk, ":w" doesn't
  614. --- work (":w filename" does work though).
  615. --- both: The buffer is never considered to be `'modified'`.
  616. --- There is no warning when the changes will be lost, for
  617. --- example when you quit Vim.
  618. --- both: A swap file is only created when using too much memory
  619. --- (when 'swapfile' has been reset there is never a swap
  620. --- file).
  621. --- nofile only: The buffer name is fixed, it is not handled like a
  622. --- file name. It is not modified in response to a `:cd`
  623. --- command.
  624. --- both: When using ":e bufname" and already editing "bufname"
  625. --- the buffer is made empty and autocommands are
  626. --- triggered as usual for `:edit`.
  627. --- *E676*
  628. --- "acwrite" implies that the buffer name is not related to a file, like
  629. --- "nofile", but it will be written. Thus, in contrast to "nofile" and
  630. --- "nowrite", ":w" does work and a modified buffer can't be abandoned
  631. --- without saving. For writing there must be matching `BufWriteCmd|,
  632. --- |FileWriteCmd` or `FileAppendCmd` autocommands.
  633. ---
  634. --- @type ''|'acwrite'|'help'|'nofile'|'nowrite'|'quickfix'|'terminal'|'prompt'
  635. vim.o.buftype = ""
  636. vim.o.bt = vim.o.buftype
  637. vim.bo.buftype = vim.o.buftype
  638. vim.bo.bt = vim.bo.buftype
  639. --- Specifies details about changing the case of letters. It may contain
  640. --- these words, separated by a comma:
  641. --- internal Use internal case mapping functions, the current
  642. --- locale does not change the case mapping. When
  643. --- "internal" is omitted, the towupper() and towlower()
  644. --- system library functions are used when available.
  645. --- keepascii For the ASCII characters (0x00 to 0x7f) use the US
  646. --- case mapping, the current locale is not effective.
  647. --- This probably only matters for Turkish.
  648. ---
  649. --- @type string
  650. vim.o.casemap = "internal,keepascii"
  651. vim.o.cmp = vim.o.casemap
  652. vim.go.casemap = vim.o.casemap
  653. vim.go.cmp = vim.go.casemap
  654. --- When on, `:cd`, `:tcd` and `:lcd` without an argument changes the
  655. --- current working directory to the `$HOME` directory like in Unix.
  656. --- When off, those commands just print the current directory name.
  657. --- On Unix this option has no effect.
  658. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  659. --- security reasons.
  660. ---
  661. --- @type boolean
  662. vim.o.cdhome = false
  663. vim.o.cdh = vim.o.cdhome
  664. vim.go.cdhome = vim.o.cdhome
  665. vim.go.cdh = vim.go.cdhome
  666. --- This is a list of directories which will be searched when using the
  667. --- `:cd`, `:tcd` and `:lcd` commands, provided that the directory being
  668. --- searched for has a relative path, not an absolute part starting with
  669. --- "/", "./" or "../", the 'cdpath' option is not used then.
  670. --- The 'cdpath' option's value has the same form and semantics as
  671. --- `'path'`. Also see `file-searching`.
  672. --- The default value is taken from $CDPATH, with a "," prepended to look
  673. --- in the current directory first.
  674. --- If the default value taken from $CDPATH is not what you want, include
  675. --- a modified version of the following command in your vimrc file to
  676. --- override it:
  677. ---
  678. --- ```vim
  679. --- let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
  680. --- ```
  681. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  682. --- security reasons.
  683. --- (parts of 'cdpath' can be passed to the shell to expand file names).
  684. ---
  685. --- @type string
  686. vim.o.cdpath = ",,"
  687. vim.o.cd = vim.o.cdpath
  688. vim.go.cdpath = vim.o.cdpath
  689. vim.go.cd = vim.go.cdpath
  690. --- The key used in Command-line Mode to open the command-line window.
  691. --- Only non-printable keys are allowed.
  692. --- The key can be specified as a single character, but it is difficult to
  693. --- type. The preferred way is to use `key-notation` (e.g. <Up>, <C-F>) or
  694. --- a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples:
  695. ---
  696. --- ```vim
  697. --- set cedit=^Y
  698. --- set cedit=<Esc>
  699. --- ```
  700. --- `Nvi` also has this option, but it only uses the first character.
  701. --- See `cmdwin`.
  702. ---
  703. --- @type string
  704. vim.o.cedit = "\6"
  705. vim.go.cedit = vim.o.cedit
  706. --- `channel` connected to the buffer, or 0 if no channel is connected.
  707. --- In a `:terminal` buffer this is the terminal channel.
  708. --- Read-only.
  709. ---
  710. --- @type integer
  711. vim.o.channel = 0
  712. vim.bo.channel = vim.o.channel
  713. --- An expression that is used for character encoding conversion. It is
  714. --- evaluated when a file that is to be read or has been written has a
  715. --- different encoding from what is desired.
  716. --- 'charconvert' is not used when the internal iconv() function is
  717. --- supported and is able to do the conversion. Using iconv() is
  718. --- preferred, because it is much faster.
  719. --- 'charconvert' is not used when reading stdin `--`, because there is no
  720. --- file to convert from. You will have to save the text in a file first.
  721. --- The expression must return zero, false or an empty string for success,
  722. --- non-zero or true for failure.
  723. --- See `encoding-names` for possible encoding names.
  724. --- Additionally, names given in 'fileencodings' and 'fileencoding' are
  725. --- used.
  726. --- Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
  727. --- is done internally by Vim, 'charconvert' is not used for this.
  728. --- Also used for Unicode conversion.
  729. --- Example:
  730. ---
  731. --- ```vim
  732. --- set charconvert=CharConvert()
  733. --- fun CharConvert()
  734. --- system("recode "
  735. --- \ .. v:charconvert_from .. ".." .. v:charconvert_to
  736. --- \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
  737. --- return v:shell_error
  738. --- endfun
  739. --- ```
  740. --- The related Vim variables are:
  741. --- v:charconvert_from name of the current encoding
  742. --- v:charconvert_to name of the desired encoding
  743. --- v:fname_in name of the input file
  744. --- v:fname_out name of the output file
  745. --- Note that v:fname_in and v:fname_out will never be the same.
  746. ---
  747. --- The advantage of using a function call without arguments is that it is
  748. --- faster, see `expr-option-function`.
  749. ---
  750. --- If the 'charconvert' expression starts with s: or `<SID>`, then it is
  751. --- replaced with the script ID (`local-function`). Example:
  752. ---
  753. --- ```vim
  754. --- set charconvert=s:MyConvert()
  755. --- set charconvert=<SID>SomeConvert()
  756. --- ```
  757. --- Otherwise the expression is evaluated in the context of the script
  758. --- where the option was set, thus script-local items are available.
  759. ---
  760. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  761. --- security reasons.
  762. ---
  763. --- @type string
  764. vim.o.charconvert = ""
  765. vim.o.ccv = vim.o.charconvert
  766. vim.go.charconvert = vim.o.charconvert
  767. vim.go.ccv = vim.go.charconvert
  768. --- Enables automatic C program indenting. See 'cinkeys' to set the keys
  769. --- that trigger reindenting in insert mode and 'cinoptions' to set your
  770. --- preferred indent style.
  771. --- If 'indentexpr' is not empty, it overrules 'cindent'.
  772. --- If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
  773. --- the "=" operator indents using this algorithm rather than calling an
  774. --- external program.
  775. --- See `C-indenting`.
  776. --- When you don't like the way 'cindent' works, try the 'smartindent'
  777. --- option or 'indentexpr'.
  778. ---
  779. --- @type boolean
  780. vim.o.cindent = false
  781. vim.o.cin = vim.o.cindent
  782. vim.bo.cindent = vim.o.cindent
  783. vim.bo.cin = vim.bo.cindent
  784. --- A list of keys that, when typed in Insert mode, cause reindenting of
  785. --- the current line. Only used if 'cindent' is on and 'indentexpr' is
  786. --- empty.
  787. --- For the format of this option see `cinkeys-format`.
  788. --- See `C-indenting`.
  789. ---
  790. --- @type string
  791. vim.o.cinkeys = "0{,0},0),0],:,0#,!^F,o,O,e"
  792. vim.o.cink = vim.o.cinkeys
  793. vim.bo.cinkeys = vim.o.cinkeys
  794. vim.bo.cink = vim.bo.cinkeys
  795. --- The 'cinoptions' affect the way 'cindent' reindents lines in a C
  796. --- program. See `cinoptions-values` for the values of this option, and
  797. --- `C-indenting` for info on C indenting in general.
  798. ---
  799. --- @type string
  800. vim.o.cinoptions = ""
  801. vim.o.cino = vim.o.cinoptions
  802. vim.bo.cinoptions = vim.o.cinoptions
  803. vim.bo.cino = vim.bo.cinoptions
  804. --- Keywords that are interpreted as a C++ scope declaration by `cino-g`.
  805. --- Useful e.g. for working with the Qt framework that defines additional
  806. --- scope declarations "signals", "public slots" and "private slots":
  807. ---
  808. --- ```vim
  809. --- set cinscopedecls+=signals,public\ slots,private\ slots
  810. --- ```
  811. ---
  812. ---
  813. --- @type string
  814. vim.o.cinscopedecls = "public,protected,private"
  815. vim.o.cinsd = vim.o.cinscopedecls
  816. vim.bo.cinscopedecls = vim.o.cinscopedecls
  817. vim.bo.cinsd = vim.bo.cinscopedecls
  818. --- These keywords start an extra indent in the next line when
  819. --- 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
  820. --- an appropriate place (inside {}).
  821. --- Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
  822. --- matter, include the keyword both the uppercase and lowercase:
  823. --- "if,If,IF".
  824. ---
  825. --- @type string
  826. vim.o.cinwords = "if,else,while,do,for,switch"
  827. vim.o.cinw = vim.o.cinwords
  828. vim.bo.cinwords = vim.o.cinwords
  829. vim.bo.cinw = vim.bo.cinwords
  830. --- This option is a list of comma-separated names.
  831. --- These names are recognized:
  832. ---
  833. --- *clipboard-unnamed*
  834. --- unnamed When included, Vim will use the clipboard register "*"
  835. --- for all yank, delete, change and put operations which
  836. --- would normally go to the unnamed register. When a
  837. --- register is explicitly specified, it will always be
  838. --- used regardless of whether "unnamed" is in 'clipboard'
  839. --- or not. The clipboard register can always be
  840. --- explicitly accessed using the "* notation. Also see
  841. --- `clipboard`.
  842. ---
  843. --- *clipboard-unnamedplus*
  844. --- unnamedplus A variant of the "unnamed" flag which uses the
  845. --- clipboard register "+" (`quoteplus`) instead of
  846. --- register "*" for all yank, delete, change and put
  847. --- operations which would normally go to the unnamed
  848. --- register. When "unnamed" is also included to the
  849. --- option, yank and delete operations (but not put)
  850. --- will additionally copy the text into register
  851. --- "*". See `clipboard`.
  852. ---
  853. --- @type string
  854. vim.o.clipboard = ""
  855. vim.o.cb = vim.o.clipboard
  856. vim.go.clipboard = vim.o.clipboard
  857. vim.go.cb = vim.go.clipboard
  858. --- Number of screen lines to use for the command-line. Helps avoiding
  859. --- `hit-enter` prompts.
  860. --- The value of this option is stored with the tab page, so that each tab
  861. --- page can have a different value.
  862. ---
  863. --- When 'cmdheight' is zero, there is no command-line unless it is being
  864. --- used. The command-line will cover the last line of the screen when
  865. --- shown.
  866. ---
  867. --- WARNING: `cmdheight=0` is EXPERIMENTAL. Expect some unwanted behaviour.
  868. --- Some 'shortmess' flags and similar mechanism might fail to take effect,
  869. --- causing unwanted hit-enter prompts. Some informative messages, both
  870. --- from Nvim itself and plugins, will not be displayed.
  871. ---
  872. --- @type integer
  873. vim.o.cmdheight = 1
  874. vim.o.ch = vim.o.cmdheight
  875. vim.go.cmdheight = vim.o.cmdheight
  876. vim.go.ch = vim.go.cmdheight
  877. --- Number of screen lines to use for the command-line window. `cmdwin`
  878. ---
  879. --- @type integer
  880. vim.o.cmdwinheight = 7
  881. vim.o.cwh = vim.o.cmdwinheight
  882. vim.go.cmdwinheight = vim.o.cmdwinheight
  883. vim.go.cwh = vim.go.cmdwinheight
  884. --- 'colorcolumn' is a comma-separated list of screen columns that are
  885. --- highlighted with ColorColumn `hl-ColorColumn`. Useful to align
  886. --- text. Will make screen redrawing slower.
  887. --- The screen column can be an absolute number, or a number preceded with
  888. --- '+' or '-', which is added to or subtracted from 'textwidth'.
  889. ---
  890. --- ```vim
  891. ---
  892. --- set cc=+1 " highlight column after 'textwidth'
  893. --- set cc=+1,+2,+3 " highlight three columns after 'textwidth'
  894. --- hi ColorColumn ctermbg=lightgrey guibg=lightgrey
  895. --- ```
  896. ---
  897. --- When 'textwidth' is zero then the items with '-' and '+' are not used.
  898. --- A maximum of 256 columns are highlighted.
  899. ---
  900. --- @type string
  901. vim.o.colorcolumn = ""
  902. vim.o.cc = vim.o.colorcolumn
  903. vim.wo.colorcolumn = vim.o.colorcolumn
  904. vim.wo.cc = vim.wo.colorcolumn
  905. --- Number of columns of the screen. Normally this is set by the terminal
  906. --- initialization and does not have to be set by hand.
  907. --- When Vim is running in the GUI or in a resizable window, setting this
  908. --- option will cause the window size to be changed. When you only want
  909. --- to use the size for the GUI, put the command in your `ginit.vim` file.
  910. --- When you set this option and Vim is unable to change the physical
  911. --- number of columns of the display, the display may be messed up. For
  912. --- the GUI it is always possible and Vim limits the number of columns to
  913. --- what fits on the screen. You can use this command to get the widest
  914. --- window possible:
  915. ---
  916. --- ```vim
  917. --- set columns=9999
  918. --- ```
  919. --- Minimum value is 12, maximum value is 10000.
  920. ---
  921. --- @type integer
  922. vim.o.columns = 80
  923. vim.o.co = vim.o.columns
  924. vim.go.columns = vim.o.columns
  925. vim.go.co = vim.go.columns
  926. --- A comma-separated list of strings that can start a comment line. See
  927. --- `format-comments`. See `option-backslash` about using backslashes to
  928. --- insert a space.
  929. ---
  930. --- @type string
  931. vim.o.comments = "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-,fb:•"
  932. vim.o.com = vim.o.comments
  933. vim.bo.comments = vim.o.comments
  934. vim.bo.com = vim.bo.comments
  935. --- A template for a comment. The "%s" in the value is replaced with the
  936. --- comment text, and should be padded with a space when possible.
  937. --- Used for `commenting` and to add markers for folding, see `fold-marker`.
  938. ---
  939. --- @type string
  940. vim.o.commentstring = ""
  941. vim.o.cms = vim.o.commentstring
  942. vim.bo.commentstring = vim.o.commentstring
  943. vim.bo.cms = vim.bo.commentstring
  944. --- This option specifies how keyword completion `ins-completion` works
  945. --- when CTRL-P or CTRL-N are used. It is also used for whole-line
  946. --- completion `i_CTRL-X_CTRL-L`. It indicates the type of completion
  947. --- and the places to scan. It is a comma-separated list of flags:
  948. --- . scan the current buffer ('wrapscan' is ignored)
  949. --- w scan buffers from other windows
  950. --- b scan other loaded buffers that are in the buffer list
  951. --- u scan the unloaded buffers that are in the buffer list
  952. --- U scan the buffers that are not in the buffer list
  953. --- k scan the files given with the 'dictionary' option
  954. --- kspell use the currently active spell checking `spell`
  955. --- k{dict} scan the file {dict}. Several "k" flags can be given,
  956. --- patterns are valid too. For example:
  957. ---
  958. --- ```vim
  959. --- set cpt=k/usr/dict/*,k~/spanish
  960. --- ```
  961. --- s scan the files given with the 'thesaurus' option
  962. --- s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
  963. --- are valid too.
  964. --- i scan current and included files
  965. --- d scan current and included files for defined name or macro
  966. --- `i_CTRL-X_CTRL-D`
  967. --- ] tag completion
  968. --- t same as "]"
  969. --- f scan the buffer names (as opposed to buffer contents)
  970. ---
  971. --- Unloaded buffers are not loaded, thus their autocmds `:autocmd` are
  972. --- not executed, this may lead to unexpected completions from some files
  973. --- (gzipped files for example). Unloaded buffers are not scanned for
  974. --- whole-line completion.
  975. ---
  976. --- As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
  977. --- based expansion (e.g., dictionary `i_CTRL-X_CTRL-K`, included patterns
  978. --- `i_CTRL-X_CTRL-I`, tags `i_CTRL-X_CTRL-]` and normal expansions).
  979. ---
  980. --- @type string
  981. vim.o.complete = ".,w,b,u,t"
  982. vim.o.cpt = vim.o.complete
  983. vim.bo.complete = vim.o.complete
  984. vim.bo.cpt = vim.bo.complete
  985. --- This option specifies a function to be used for Insert mode completion
  986. --- with CTRL-X CTRL-U. `i_CTRL-X_CTRL-U`
  987. --- See `complete-functions` for an explanation of how the function is
  988. --- invoked and what it should return. The value can be the name of a
  989. --- function, a `lambda` or a `Funcref`. See `option-value-function` for
  990. --- more information.
  991. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  992. --- security reasons.
  993. ---
  994. --- @type string
  995. vim.o.completefunc = ""
  996. vim.o.cfu = vim.o.completefunc
  997. vim.bo.completefunc = vim.o.completefunc
  998. vim.bo.cfu = vim.bo.completefunc
  999. --- A comma-separated list of `complete-items` that controls the alignment
  1000. --- and display order of items in the popup menu during Insert mode
  1001. --- completion. The supported values are abbr, kind, and menu. These
  1002. --- options allow to customize how the completion items are shown in the
  1003. --- popup menu. Note: must always contain those three values in any
  1004. --- order.
  1005. ---
  1006. --- @type string
  1007. vim.o.completeitemalign = "abbr,kind,menu"
  1008. vim.o.cia = vim.o.completeitemalign
  1009. vim.go.completeitemalign = vim.o.completeitemalign
  1010. vim.go.cia = vim.go.completeitemalign
  1011. --- A comma-separated list of options for Insert mode completion
  1012. --- `ins-completion`. The supported values are:
  1013. ---
  1014. --- menu Use a popup menu to show the possible completions. The
  1015. --- menu is only shown when there is more than one match and
  1016. --- sufficient colors are available. `ins-completion-menu`
  1017. ---
  1018. --- menuone Use the popup menu also when there is only one match.
  1019. --- Useful when there is additional information about the
  1020. --- match, e.g., what file it comes from.
  1021. ---
  1022. --- longest Only insert the longest common text of the matches. If
  1023. --- the menu is displayed you can use CTRL-L to add more
  1024. --- characters. Whether case is ignored depends on the kind
  1025. --- of completion. For buffer text the 'ignorecase' option is
  1026. --- used.
  1027. ---
  1028. --- preview Show extra information about the currently selected
  1029. --- completion in the preview window. Only works in
  1030. --- combination with "menu" or "menuone".
  1031. ---
  1032. --- popup Show extra information about the currently selected
  1033. --- completion in a popup window. Only works in combination
  1034. --- with "menu" or "menuone". Overrides "preview".
  1035. ---
  1036. --- noinsert Do not insert any text for a match until the user selects
  1037. --- a match from the menu. Only works in combination with
  1038. --- "menu" or "menuone". No effect if "longest" is present.
  1039. ---
  1040. --- noselect Same as "noinsert", except that no menu item is
  1041. --- pre-selected. If both "noinsert" and "noselect" are
  1042. --- present, "noselect" has precedence.
  1043. ---
  1044. --- fuzzy Enable `fuzzy-matching` for completion candidates. This
  1045. --- allows for more flexible and intuitive matching, where
  1046. --- characters can be skipped and matches can be found even
  1047. --- if the exact sequence is not typed. Only makes a
  1048. --- difference how completion candidates are reduced from the
  1049. --- list of alternatives, but not how the candidates are
  1050. --- collected (using different completion types).
  1051. ---
  1052. --- nosort Disable sorting of completion candidates based on fuzzy
  1053. --- scores when "fuzzy" is enabled. Candidates will appear
  1054. --- in their original order.
  1055. ---
  1056. --- preinsert
  1057. --- Preinsert the portion of the first candidate word that is
  1058. --- not part of the current completion leader and using the
  1059. --- `hl-ComplMatchIns` highlight group. Does not work when
  1060. --- "fuzzy" is also included.
  1061. ---
  1062. --- @type string
  1063. vim.o.completeopt = "menu,preview"
  1064. vim.o.cot = vim.o.completeopt
  1065. vim.bo.completeopt = vim.o.completeopt
  1066. vim.bo.cot = vim.bo.completeopt
  1067. vim.go.completeopt = vim.o.completeopt
  1068. vim.go.cot = vim.go.completeopt
  1069. --- only modifiable in MS-Windows
  1070. --- When this option is set it overrules 'shellslash' for completion:
  1071. --- - When this option is set to "slash", a forward slash is used for path
  1072. --- completion in insert mode. This is useful when editing HTML tag, or
  1073. --- Makefile with 'noshellslash' on MS-Windows.
  1074. --- - When this option is set to "backslash", backslash is used. This is
  1075. --- useful when editing a batch file with 'shellslash' set on MS-Windows.
  1076. --- - When this option is empty, same character is used as for
  1077. --- 'shellslash'.
  1078. --- For Insert mode completion the buffer-local value is used. For
  1079. --- command line completion the global value is used.
  1080. ---
  1081. --- @type ''|'slash'|'backslash'
  1082. vim.o.completeslash = ""
  1083. vim.o.csl = vim.o.completeslash
  1084. vim.bo.completeslash = vim.o.completeslash
  1085. vim.bo.csl = vim.bo.completeslash
  1086. --- Sets the modes in which text in the cursor line can also be concealed.
  1087. --- When the current mode is listed then concealing happens just like in
  1088. --- other lines.
  1089. --- n Normal mode
  1090. --- v Visual mode
  1091. --- i Insert mode
  1092. --- c Command line editing, for 'incsearch'
  1093. ---
  1094. --- 'v' applies to all lines in the Visual area, not only the cursor.
  1095. --- A useful value is "nc". This is used in help files. So long as you
  1096. --- are moving around text is concealed, but when starting to insert text
  1097. --- or selecting a Visual area the concealed text is displayed, so that
  1098. --- you can see what you are doing.
  1099. --- Keep in mind that the cursor position is not always where it's
  1100. --- displayed. E.g., when moving vertically it may change column.
  1101. ---
  1102. --- @type string
  1103. vim.o.concealcursor = ""
  1104. vim.o.cocu = vim.o.concealcursor
  1105. vim.wo.concealcursor = vim.o.concealcursor
  1106. vim.wo.cocu = vim.wo.concealcursor
  1107. --- Determine how text with the "conceal" syntax attribute `:syn-conceal`
  1108. --- is shown:
  1109. ---
  1110. --- Value Effect ~
  1111. --- 0 Text is shown normally
  1112. --- 1 Each block of concealed text is replaced with one
  1113. --- character. If the syntax item does not have a custom
  1114. --- replacement character defined (see `:syn-cchar`) the
  1115. --- character defined in 'listchars' is used.
  1116. --- It is highlighted with the "Conceal" highlight group.
  1117. --- 2 Concealed text is completely hidden unless it has a
  1118. --- custom replacement character defined (see
  1119. --- `:syn-cchar`).
  1120. --- 3 Concealed text is completely hidden.
  1121. ---
  1122. --- Note: in the cursor line concealed text is not hidden, so that you can
  1123. --- edit and copy the text. This can be changed with the 'concealcursor'
  1124. --- option.
  1125. ---
  1126. --- @type integer
  1127. vim.o.conceallevel = 0
  1128. vim.o.cole = vim.o.conceallevel
  1129. vim.wo.conceallevel = vim.o.conceallevel
  1130. vim.wo.cole = vim.wo.conceallevel
  1131. --- When 'confirm' is on, certain operations that would normally
  1132. --- fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
  1133. --- instead raise a dialog asking if you wish to save the current
  1134. --- file(s). You can still use a ! to unconditionally `abandon` a buffer.
  1135. --- If 'confirm' is off you can still activate confirmation for one
  1136. --- command only (this is most useful in mappings) with the `:confirm`
  1137. --- command.
  1138. --- Also see the `confirm()` function and the 'v' flag in 'guioptions'.
  1139. ---
  1140. --- @type boolean
  1141. vim.o.confirm = false
  1142. vim.o.cf = vim.o.confirm
  1143. vim.go.confirm = vim.o.confirm
  1144. vim.go.cf = vim.go.confirm
  1145. --- Copy the structure of the existing lines indent when autoindenting a
  1146. --- new line. Normally the new indent is reconstructed by a series of
  1147. --- tabs followed by spaces as required (unless `'expandtab'` is enabled,
  1148. --- in which case only spaces are used). Enabling this option makes the
  1149. --- new line copy whatever characters were used for indenting on the
  1150. --- existing line. 'expandtab' has no effect on these characters, a Tab
  1151. --- remains a Tab. If the new indent is greater than on the existing
  1152. --- line, the remaining space is filled in the normal manner.
  1153. --- See 'preserveindent'.
  1154. ---
  1155. --- @type boolean
  1156. vim.o.copyindent = false
  1157. vim.o.ci = vim.o.copyindent
  1158. vim.bo.copyindent = vim.o.copyindent
  1159. vim.bo.ci = vim.bo.copyindent
  1160. --- A sequence of single character flags. When a character is present
  1161. --- this indicates Vi-compatible behavior. This is used for things where
  1162. --- not being Vi-compatible is mostly or sometimes preferred.
  1163. --- 'cpoptions' stands for "compatible-options".
  1164. --- Commas can be added for readability.
  1165. --- To avoid problems with flags that are added in the future, use the
  1166. --- "+=" and "-=" feature of ":set" `add-option-flags`.
  1167. ---
  1168. --- contains behavior ~
  1169. --- *cpo-a*
  1170. --- a When included, a ":read" command with a file name
  1171. --- argument will set the alternate file name for the
  1172. --- current window.
  1173. --- *cpo-A*
  1174. --- A When included, a ":write" command with a file name
  1175. --- argument will set the alternate file name for the
  1176. --- current window.
  1177. --- *cpo-b*
  1178. --- b "\|" in a ":map" command is recognized as the end of
  1179. --- the map command. The '\' is included in the mapping,
  1180. --- the text after the '|' is interpreted as the next
  1181. --- command. Use a CTRL-V instead of a backslash to
  1182. --- include the '|' in the mapping. Applies to all
  1183. --- mapping, abbreviation, menu and autocmd commands.
  1184. --- See also `map_bar`.
  1185. --- *cpo-B*
  1186. --- B A backslash has no special meaning in mappings,
  1187. --- abbreviations, user commands and the "to" part of the
  1188. --- menu commands. Remove this flag to be able to use a
  1189. --- backslash like a CTRL-V. For example, the command
  1190. --- ":map X \\<Esc>" results in X being mapped to:
  1191. --- 'B' included: "\^[" (^[ is a real <Esc>)
  1192. --- 'B' excluded: "<Esc>" (5 characters)
  1193. --- *cpo-c*
  1194. --- c Searching continues at the end of any match at the
  1195. --- cursor position, but not further than the start of the
  1196. --- next line. When not present searching continues
  1197. --- one character from the cursor position. With 'c'
  1198. --- "abababababab" only gets three matches when repeating
  1199. --- "/abab", without 'c' there are five matches.
  1200. --- *cpo-C*
  1201. --- C Do not concatenate sourced lines that start with a
  1202. --- backslash. See `line-continuation`.
  1203. --- *cpo-d*
  1204. --- d Using "./" in the 'tags' option doesn't mean to use
  1205. --- the tags file relative to the current file, but the
  1206. --- tags file in the current directory.
  1207. --- *cpo-D*
  1208. --- D Can't use CTRL-K to enter a digraph after Normal mode
  1209. --- commands with a character argument, like `r`, `f` and
  1210. --- `t`.
  1211. --- *cpo-e*
  1212. --- e When executing a register with ":@r", always add a
  1213. --- <CR> to the last line, also when the register is not
  1214. --- linewise. If this flag is not present, the register
  1215. --- is not linewise and the last line does not end in a
  1216. --- <CR>, then the last line is put on the command-line
  1217. --- and can be edited before hitting <CR>.
  1218. --- *cpo-E*
  1219. --- E It is an error when using "y", "d", "c", "g~", "gu" or
  1220. --- "gU" on an Empty region. The operators only work when
  1221. --- at least one character is to be operated on. Example:
  1222. --- This makes "y0" fail in the first column.
  1223. --- *cpo-f*
  1224. --- f When included, a ":read" command with a file name
  1225. --- argument will set the file name for the current buffer,
  1226. --- if the current buffer doesn't have a file name yet.
  1227. --- *cpo-F*
  1228. --- F When included, a ":write" command with a file name
  1229. --- argument will set the file name for the current
  1230. --- buffer, if the current buffer doesn't have a file name
  1231. --- yet. Also see `cpo-P`.
  1232. --- *cpo-i*
  1233. --- i When included, interrupting the reading of a file will
  1234. --- leave it modified.
  1235. --- *cpo-I*
  1236. --- I When moving the cursor up or down just after inserting
  1237. --- indent for 'autoindent', do not delete the indent.
  1238. --- *cpo-J*
  1239. --- J A `sentence` has to be followed by two spaces after
  1240. --- the '.', '!' or '?'. A <Tab> is not recognized as
  1241. --- white space.
  1242. --- *cpo-K*
  1243. --- K Don't wait for a key code to complete when it is
  1244. --- halfway through a mapping. This breaks mapping
  1245. --- <F1><F1> when only part of the second <F1> has been
  1246. --- read. It enables cancelling the mapping by typing
  1247. --- <F1><Esc>.
  1248. --- *cpo-l*
  1249. --- l Backslash in a [] range in a search pattern is taken
  1250. --- literally, only "\]", "\^", "\-" and "\\" are special.
  1251. --- See `/[]`
  1252. --- 'l' included: "/[ \t]" finds <Space>, '\' and 't'
  1253. --- 'l' excluded: "/[ \t]" finds <Space> and <Tab>
  1254. --- *cpo-L*
  1255. --- L When the 'list' option is set, 'wrapmargin',
  1256. --- 'textwidth', 'softtabstop' and Virtual Replace mode
  1257. --- (see `gR`) count a <Tab> as two characters, instead of
  1258. --- the normal behavior of a <Tab>.
  1259. --- *cpo-m*
  1260. --- m When included, a showmatch will always wait half a
  1261. --- second. When not included, a showmatch will wait half
  1262. --- a second or until a character is typed. `'showmatch'`
  1263. --- *cpo-M*
  1264. --- M When excluded, "%" matching will take backslashes into
  1265. --- account. Thus in "( \( )" and "\( ( \)" the outer
  1266. --- parenthesis match. When included "%" ignores
  1267. --- backslashes, which is Vi compatible.
  1268. --- *cpo-n*
  1269. --- n When included, the column used for 'number' and
  1270. --- 'relativenumber' will also be used for text of wrapped
  1271. --- lines.
  1272. --- *cpo-o*
  1273. --- o Line offset to search command is not remembered for
  1274. --- next search.
  1275. --- *cpo-O*
  1276. --- O Don't complain if a file is being overwritten, even
  1277. --- when it didn't exist when editing it. This is a
  1278. --- protection against a file unexpectedly created by
  1279. --- someone else. Vi didn't complain about this.
  1280. --- *cpo-P*
  1281. --- P When included, a ":write" command that appends to a
  1282. --- file will set the file name for the current buffer, if
  1283. --- the current buffer doesn't have a file name yet and
  1284. --- the 'F' flag is also included `cpo-F`.
  1285. --- *cpo-q*
  1286. --- q When joining multiple lines leave the cursor at the
  1287. --- position where it would be when joining two lines.
  1288. --- *cpo-r*
  1289. --- r Redo ("." command) uses "/" to repeat a search
  1290. --- command, instead of the actually used search string.
  1291. --- *cpo-R*
  1292. --- R Remove marks from filtered lines. Without this flag
  1293. --- marks are kept like `:keepmarks` was used.
  1294. --- *cpo-s*
  1295. --- s Set buffer options when entering the buffer for the
  1296. --- first time. This is like it is in Vim version 3.0.
  1297. --- And it is the default. If not present the options are
  1298. --- set when the buffer is created.
  1299. --- *cpo-S*
  1300. --- S Set buffer options always when entering a buffer
  1301. --- (except 'readonly', 'fileformat', 'filetype' and
  1302. --- 'syntax'). This is the (most) Vi compatible setting.
  1303. --- The options are set to the values in the current
  1304. --- buffer. When you change an option and go to another
  1305. --- buffer, the value is copied. Effectively makes the
  1306. --- buffer options global to all buffers.
  1307. ---
  1308. --- 's' 'S' copy buffer options
  1309. --- no no when buffer created
  1310. --- yes no when buffer first entered (default)
  1311. --- X yes each time when buffer entered (vi comp.)
  1312. --- *cpo-t*
  1313. --- t Search pattern for the tag command is remembered for
  1314. --- "n" command. Otherwise Vim only puts the pattern in
  1315. --- the history for search pattern, but doesn't change the
  1316. --- last used search pattern.
  1317. --- *cpo-u*
  1318. --- u Undo is Vi compatible. See `undo-two-ways`.
  1319. --- *cpo-v*
  1320. --- v Backspaced characters remain visible on the screen in
  1321. --- Insert mode. Without this flag the characters are
  1322. --- erased from the screen right away. With this flag the
  1323. --- screen newly typed text overwrites backspaced
  1324. --- characters.
  1325. --- *cpo-W*
  1326. --- W Don't overwrite a readonly file. When omitted, ":w!"
  1327. --- overwrites a readonly file, if possible.
  1328. --- *cpo-x*
  1329. --- x <Esc> on the command-line executes the command-line.
  1330. --- The default in Vim is to abandon the command-line,
  1331. --- because <Esc> normally aborts a command. `c_<Esc>`
  1332. --- *cpo-X*
  1333. --- X When using a count with "R" the replaced text is
  1334. --- deleted only once. Also when repeating "R" with "."
  1335. --- and a count.
  1336. --- *cpo-y*
  1337. --- y A yank command can be redone with ".". Think twice if
  1338. --- you really want to use this, it may break some
  1339. --- plugins, since most people expect "." to only repeat a
  1340. --- change.
  1341. --- *cpo-Z*
  1342. --- Z When using "w!" while the 'readonly' option is set,
  1343. --- don't reset 'readonly'.
  1344. --- *cpo-!*
  1345. --- ! When redoing a filter command, use the last used
  1346. --- external command, whatever it was. Otherwise the last
  1347. --- used -filter- command is used.
  1348. --- *cpo-$*
  1349. --- $ When making a change to one line, don't redisplay the
  1350. --- line, but put a '$' at the end of the changed text.
  1351. --- The changed text will be overwritten when you type the
  1352. --- new text. The line is redisplayed if you type any
  1353. --- command that moves the cursor from the insertion
  1354. --- point.
  1355. --- *cpo-%*
  1356. --- % Vi-compatible matching is done for the "%" command.
  1357. --- Does not recognize "#if", "#endif", etc.
  1358. --- Does not recognize "/*" and "*/".
  1359. --- Parens inside single and double quotes are also
  1360. --- counted, causing a string that contains a paren to
  1361. --- disturb the matching. For example, in a line like
  1362. --- "if (strcmp("foo(", s))" the first paren does not
  1363. --- match the last one. When this flag is not included,
  1364. --- parens inside single and double quotes are treated
  1365. --- specially. When matching a paren outside of quotes,
  1366. --- everything inside quotes is ignored. When matching a
  1367. --- paren inside quotes, it will find the matching one (if
  1368. --- there is one). This works very well for C programs.
  1369. --- This flag is also used for other features, such as
  1370. --- C-indenting.
  1371. --- *cpo-+*
  1372. --- + When included, a ":write file" command will reset the
  1373. --- 'modified' flag of the buffer, even though the buffer
  1374. --- itself may still be different from its file.
  1375. --- *cpo->*
  1376. --- > When appending to a register, put a line break before
  1377. --- the appended text.
  1378. --- *cpo-;*
  1379. --- ; When using `,` or `;` to repeat the last `t` search
  1380. --- and the cursor is right in front of the searched
  1381. --- character, the cursor won't move. When not included,
  1382. --- the cursor would skip over it and jump to the
  1383. --- following occurrence.
  1384. --- *cpo-_*
  1385. --- _ When using `cw` on a word, do not include the
  1386. --- whitespace following the word in the motion.
  1387. ---
  1388. --- @type string
  1389. vim.o.cpoptions = "aABceFs_"
  1390. vim.o.cpo = vim.o.cpoptions
  1391. vim.go.cpoptions = vim.o.cpoptions
  1392. vim.go.cpo = vim.go.cpoptions
  1393. --- When this option is set, as the cursor in the current
  1394. --- window moves other cursorbound windows (windows that also have
  1395. --- this option set) move their cursors to the corresponding line and
  1396. --- column. This option is useful for viewing the
  1397. --- differences between two versions of a file (see 'diff'); in diff mode,
  1398. --- inserted and deleted lines (though not characters within a line) are
  1399. --- taken into account.
  1400. ---
  1401. --- @type boolean
  1402. vim.o.cursorbind = false
  1403. vim.o.crb = vim.o.cursorbind
  1404. vim.wo.cursorbind = vim.o.cursorbind
  1405. vim.wo.crb = vim.wo.cursorbind
  1406. --- Highlight the screen column of the cursor with CursorColumn
  1407. --- `hl-CursorColumn`. Useful to align text. Will make screen redrawing
  1408. --- slower.
  1409. --- If you only want the highlighting in the current window you can use
  1410. --- these autocommands:
  1411. ---
  1412. --- ```vim
  1413. --- au WinLeave * set nocursorline nocursorcolumn
  1414. --- au WinEnter * set cursorline cursorcolumn
  1415. --- ```
  1416. ---
  1417. ---
  1418. --- @type boolean
  1419. vim.o.cursorcolumn = false
  1420. vim.o.cuc = vim.o.cursorcolumn
  1421. vim.wo.cursorcolumn = vim.o.cursorcolumn
  1422. vim.wo.cuc = vim.wo.cursorcolumn
  1423. --- Highlight the text line of the cursor with CursorLine `hl-CursorLine`.
  1424. --- Useful to easily spot the cursor. Will make screen redrawing slower.
  1425. --- When Visual mode is active the highlighting isn't used to make it
  1426. --- easier to see the selected text.
  1427. ---
  1428. --- @type boolean
  1429. vim.o.cursorline = false
  1430. vim.o.cul = vim.o.cursorline
  1431. vim.wo.cursorline = vim.o.cursorline
  1432. vim.wo.cul = vim.wo.cursorline
  1433. --- Comma-separated list of settings for how 'cursorline' is displayed.
  1434. --- Valid values:
  1435. --- "line" Highlight the text line of the cursor with
  1436. --- CursorLine `hl-CursorLine`.
  1437. --- "screenline" Highlight only the screen line of the cursor with
  1438. --- CursorLine `hl-CursorLine`.
  1439. --- "number" Highlight the line number of the cursor with
  1440. --- CursorLineNr `hl-CursorLineNr`.
  1441. ---
  1442. --- Special value:
  1443. --- "both" Alias for the values "line,number".
  1444. ---
  1445. --- "line" and "screenline" cannot be used together.
  1446. ---
  1447. --- @type string
  1448. vim.o.cursorlineopt = "both"
  1449. vim.o.culopt = vim.o.cursorlineopt
  1450. vim.wo.cursorlineopt = vim.o.cursorlineopt
  1451. vim.wo.culopt = vim.wo.cursorlineopt
  1452. --- These values can be used:
  1453. --- msg Error messages that would otherwise be omitted will be given
  1454. --- anyway.
  1455. --- throw Error messages that would otherwise be omitted will be given
  1456. --- anyway and also throw an exception and set `v:errmsg`.
  1457. --- beep A message will be given when otherwise only a beep would be
  1458. --- produced.
  1459. --- The values can be combined, separated by a comma.
  1460. --- "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
  1461. --- 'indentexpr'.
  1462. ---
  1463. --- @type string
  1464. vim.o.debug = ""
  1465. vim.go.debug = vim.o.debug
  1466. --- Pattern to be used to find a macro definition. It is a search
  1467. --- pattern, just like for the "/" command. This option is used for the
  1468. --- commands like "[i" and "[d" `include-search`. The 'isident' option is
  1469. --- used to recognize the defined name after the match:
  1470. --- ```
  1471. --- {match with 'define'}{non-ID chars}{defined name}{non-ID char}
  1472. --- ```
  1473. --- See `option-backslash` about inserting backslashes to include a space
  1474. --- or backslash.
  1475. --- For C++ this value would be useful, to include const type declarations:
  1476. --- ```
  1477. --- ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
  1478. --- ```
  1479. --- You can also use "\ze" just before the name and continue the pattern
  1480. --- to check what is following. E.g. for Javascript, if a function is
  1481. --- defined with `func_name = function(args)`:
  1482. --- ```
  1483. --- ^\s*\ze\i\+\s*=\s*function(
  1484. --- ```
  1485. --- If the function is defined with `func_name : function() {...`:
  1486. --- ```
  1487. --- ^\s*\ze\i\+\s*[:]\s*(*function\s*(
  1488. --- ```
  1489. --- When using the ":set" command, you need to double the backslashes!
  1490. --- To avoid that use `:let` with a single quote string:
  1491. ---
  1492. --- ```vim
  1493. --- let &l:define = '^\s*\ze\k\+\s*=\s*function('
  1494. --- ```
  1495. ---
  1496. ---
  1497. --- @type string
  1498. vim.o.define = ""
  1499. vim.o.def = vim.o.define
  1500. vim.bo.define = vim.o.define
  1501. vim.bo.def = vim.bo.define
  1502. vim.go.define = vim.o.define
  1503. vim.go.def = vim.go.define
  1504. --- If editing Unicode and this option is set, backspace and Normal mode
  1505. --- "x" delete each combining character on its own. When it is off (the
  1506. --- default) the character along with its combining characters are
  1507. --- deleted.
  1508. --- Note: When 'delcombine' is set "xx" may work differently from "2x"!
  1509. ---
  1510. --- This is useful for Arabic, Hebrew and many other languages where one
  1511. --- may have combining characters overtop of base characters, and want
  1512. --- to remove only the combining ones.
  1513. ---
  1514. --- @type boolean
  1515. vim.o.delcombine = false
  1516. vim.o.deco = vim.o.delcombine
  1517. vim.go.delcombine = vim.o.delcombine
  1518. vim.go.deco = vim.go.delcombine
  1519. --- List of file names, separated by commas, that are used to lookup words
  1520. --- for keyword completion commands `i_CTRL-X_CTRL-K`. Each file should
  1521. --- contain a list of words. This can be one word per line, or several
  1522. --- words per line, separated by non-keyword characters (white space is
  1523. --- preferred). Maximum line length is 510 bytes.
  1524. ---
  1525. --- When this option is empty or an entry "spell" is present, and spell
  1526. --- checking is enabled, words in the word lists for the currently active
  1527. --- 'spelllang' are used. See `spell`.
  1528. ---
  1529. --- To include a comma in a file name precede it with a backslash. Spaces
  1530. --- after a comma are ignored, otherwise spaces are included in the file
  1531. --- name. See `option-backslash` about using backslashes.
  1532. --- This has nothing to do with the `Dictionary` variable type.
  1533. --- Where to find a list of words?
  1534. --- - BSD/macOS include the "/usr/share/dict/words" file.
  1535. --- - Try "apt install spell" to get the "/usr/share/dict/words" file on
  1536. --- apt-managed systems (Debian/Ubuntu).
  1537. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  1538. --- directories from the list. This avoids problems when a future version
  1539. --- uses another default.
  1540. --- Backticks cannot be used in this option for security reasons.
  1541. ---
  1542. --- @type string
  1543. vim.o.dictionary = ""
  1544. vim.o.dict = vim.o.dictionary
  1545. vim.bo.dictionary = vim.o.dictionary
  1546. vim.bo.dict = vim.bo.dictionary
  1547. vim.go.dictionary = vim.o.dictionary
  1548. vim.go.dict = vim.go.dictionary
  1549. --- Join the current window in the group of windows that shows differences
  1550. --- between files. See `diff-mode`.
  1551. ---
  1552. --- @type boolean
  1553. vim.o.diff = false
  1554. vim.wo.diff = vim.o.diff
  1555. --- Expression which is evaluated to obtain a diff file (either ed-style
  1556. --- or unified-style) from two versions of a file. See `diff-diffexpr`.
  1557. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1558. --- security reasons.
  1559. ---
  1560. --- @type string
  1561. vim.o.diffexpr = ""
  1562. vim.o.dex = vim.o.diffexpr
  1563. vim.go.diffexpr = vim.o.diffexpr
  1564. vim.go.dex = vim.go.diffexpr
  1565. --- Option settings for diff mode. It can consist of the following items.
  1566. --- All are optional. Items must be separated by a comma.
  1567. ---
  1568. --- algorithm:{text} Use the specified diff algorithm with the
  1569. --- internal diff engine. Currently supported
  1570. --- algorithms are:
  1571. --- myers the default algorithm
  1572. --- minimal spend extra time to generate the
  1573. --- smallest possible diff
  1574. --- patience patience diff algorithm
  1575. --- histogram histogram diff algorithm
  1576. ---
  1577. --- closeoff When a window is closed where 'diff' is set
  1578. --- and there is only one window remaining in the
  1579. --- same tab page with 'diff' set, execute
  1580. --- `:diffoff` in that window. This undoes a
  1581. --- `:diffsplit` command.
  1582. ---
  1583. --- context:{n} Use a context of {n} lines between a change
  1584. --- and a fold that contains unchanged lines.
  1585. --- When omitted a context of six lines is used.
  1586. --- When using zero the context is actually one,
  1587. --- since folds require a line in between, also
  1588. --- for a deleted line. Set it to a very large
  1589. --- value (999999) to disable folding completely.
  1590. --- See `fold-diff`.
  1591. ---
  1592. --- filler Show filler lines, to keep the text
  1593. --- synchronized with a window that has inserted
  1594. --- lines at the same position. Mostly useful
  1595. --- when windows are side-by-side and 'scrollbind'
  1596. --- is set.
  1597. ---
  1598. --- foldcolumn:{n} Set the 'foldcolumn' option to {n} when
  1599. --- starting diff mode. Without this 2 is used.
  1600. ---
  1601. --- followwrap Follow the 'wrap' option and leave as it is.
  1602. ---
  1603. --- horizontal Start diff mode with horizontal splits (unless
  1604. --- explicitly specified otherwise).
  1605. ---
  1606. --- hiddenoff Do not use diff mode for a buffer when it
  1607. --- becomes hidden.
  1608. ---
  1609. --- iblank Ignore changes where lines are all blank. Adds
  1610. --- the "-B" flag to the "diff" command if
  1611. --- 'diffexpr' is empty. Check the documentation
  1612. --- of the "diff" command for what this does
  1613. --- exactly.
  1614. --- NOTE: the diff windows will get out of sync,
  1615. --- because no differences between blank lines are
  1616. --- taken into account.
  1617. ---
  1618. --- icase Ignore changes in case of text. "a" and "A"
  1619. --- are considered the same. Adds the "-i" flag
  1620. --- to the "diff" command if 'diffexpr' is empty.
  1621. ---
  1622. --- indent-heuristic
  1623. --- Use the indent heuristic for the internal
  1624. --- diff library.
  1625. ---
  1626. --- internal Use the internal diff library. This is
  1627. --- ignored when 'diffexpr' is set. *E960*
  1628. --- When running out of memory when writing a
  1629. --- buffer this item will be ignored for diffs
  1630. --- involving that buffer. Set the 'verbose'
  1631. --- option to see when this happens.
  1632. ---
  1633. --- iwhite Ignore changes in amount of white space. Adds
  1634. --- the "-b" flag to the "diff" command if
  1635. --- 'diffexpr' is empty. Check the documentation
  1636. --- of the "diff" command for what this does
  1637. --- exactly. It should ignore adding trailing
  1638. --- white space, but not leading white space.
  1639. ---
  1640. --- iwhiteall Ignore all white space changes. Adds
  1641. --- the "-w" flag to the "diff" command if
  1642. --- 'diffexpr' is empty. Check the documentation
  1643. --- of the "diff" command for what this does
  1644. --- exactly.
  1645. ---
  1646. --- iwhiteeol Ignore white space changes at end of line.
  1647. --- Adds the "-Z" flag to the "diff" command if
  1648. --- 'diffexpr' is empty. Check the documentation
  1649. --- of the "diff" command for what this does
  1650. --- exactly.
  1651. ---
  1652. --- linematch:{n} Align and mark changes between the most
  1653. --- similar lines between the buffers. When the
  1654. --- total number of lines in the diff hunk exceeds
  1655. --- {n}, the lines will not be aligned because for
  1656. --- very large diff hunks there will be a
  1657. --- noticeable lag. A reasonable setting is
  1658. --- "linematch:60", as this will enable alignment
  1659. --- for a 2 buffer diff hunk of 30 lines each,
  1660. --- or a 3 buffer diff hunk of 20 lines each.
  1661. ---
  1662. --- vertical Start diff mode with vertical splits (unless
  1663. --- explicitly specified otherwise).
  1664. ---
  1665. --- Examples:
  1666. ---
  1667. --- ```vim
  1668. --- set diffopt=internal,filler,context:4
  1669. --- set diffopt=
  1670. --- set diffopt=internal,filler,foldcolumn:3
  1671. --- set diffopt-=internal " do NOT use the internal diff parser
  1672. --- ```
  1673. ---
  1674. ---
  1675. --- @type string
  1676. vim.o.diffopt = "internal,filler,closeoff,linematch:40"
  1677. vim.o.dip = vim.o.diffopt
  1678. vim.go.diffopt = vim.o.diffopt
  1679. vim.go.dip = vim.go.diffopt
  1680. --- Enable the entering of digraphs in Insert mode with {char1} <BS>
  1681. --- {char2}. See `digraphs`.
  1682. ---
  1683. --- @type boolean
  1684. vim.o.digraph = false
  1685. vim.o.dg = vim.o.digraph
  1686. vim.go.digraph = vim.o.digraph
  1687. vim.go.dg = vim.go.digraph
  1688. --- List of directory names for the swap file, separated with commas.
  1689. ---
  1690. --- Possible items:
  1691. --- - The swap file will be created in the first directory where this is
  1692. --- possible. If it is not possible in any directory, but last
  1693. --- directory listed in the option does not exist, it is created.
  1694. --- - Empty means that no swap file will be used (recovery is
  1695. --- impossible!) and no `E303` error will be given.
  1696. --- - A directory "." means to put the swap file in the same directory as
  1697. --- the edited file. On Unix, a dot is prepended to the file name, so
  1698. --- it doesn't show in a directory listing. On MS-Windows the "hidden"
  1699. --- attribute is set and a dot prepended if possible.
  1700. --- - A directory starting with "./" (or ".\" for MS-Windows) means to put
  1701. --- the swap file relative to where the edited file is. The leading "."
  1702. --- is replaced with the path name of the edited file.
  1703. --- - For Unix and Win32, if a directory ends in two path separators "//",
  1704. --- the swap file name will be built from the complete path to the file
  1705. --- with all path separators replaced by percent '%' signs (including
  1706. --- the colon following the drive letter on Win32). This will ensure
  1707. --- file name uniqueness in the preserve directory.
  1708. --- On Win32, it is also possible to end with "\\". However, When a
  1709. --- separating comma is following, you must use "//", since "\\" will
  1710. --- include the comma in the file name. Therefore it is recommended to
  1711. --- use '//', instead of '\\'.
  1712. --- - Spaces after the comma are ignored, other spaces are considered part
  1713. --- of the directory name. To have a space at the start of a directory
  1714. --- name, precede it with a backslash.
  1715. --- - To include a comma in a directory name precede it with a backslash.
  1716. --- - A directory name may end in an ':' or '/'.
  1717. --- - Environment variables are expanded `:set_env`.
  1718. --- - Careful with '\' characters, type one before a space, type two to
  1719. --- get one in the option (see `option-backslash`), for example:
  1720. ---
  1721. --- ```vim
  1722. --- set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  1723. --- ```
  1724. ---
  1725. --- Editing the same file twice will result in a warning. Using "/tmp" on
  1726. --- is discouraged: if the system crashes you lose the swap file. And
  1727. --- others on the computer may be able to see the files.
  1728. --- Use `:set+=` and `:set-=` when adding or removing directories from the
  1729. --- list, this avoids problems if the Nvim default is changed.
  1730. ---
  1731. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1732. --- security reasons.
  1733. ---
  1734. --- @type string
  1735. vim.o.directory = "$XDG_STATE_HOME/nvim/swap//"
  1736. vim.o.dir = vim.o.directory
  1737. vim.go.directory = vim.o.directory
  1738. vim.go.dir = vim.go.directory
  1739. --- Change the way text is displayed. This is a comma-separated list of
  1740. --- flags:
  1741. --- lastline When included, as much as possible of the last line
  1742. --- in a window will be displayed. "@@@" is put in the
  1743. --- last columns of the last screen line to indicate the
  1744. --- rest of the line is not displayed.
  1745. --- truncate Like "lastline", but "@@@" is displayed in the first
  1746. --- column of the last screen line. Overrules "lastline".
  1747. --- uhex Show unprintable characters hexadecimal as <xx>
  1748. --- instead of using ^C and ~C.
  1749. --- msgsep Obsolete flag. Allowed but takes no effect. `msgsep`
  1750. ---
  1751. --- When neither "lastline" nor "truncate" is included, a last line that
  1752. --- doesn't fit is replaced with "@" lines.
  1753. ---
  1754. --- The "@" character can be changed by setting the "lastline" item in
  1755. --- 'fillchars'. The character is highlighted with `hl-NonText`.
  1756. ---
  1757. --- @type string
  1758. vim.o.display = "lastline"
  1759. vim.o.dy = vim.o.display
  1760. vim.go.display = vim.o.display
  1761. vim.go.dy = vim.go.display
  1762. --- Tells when the 'equalalways' option applies:
  1763. --- ver vertically, width of windows is not affected
  1764. --- hor horizontally, height of windows is not affected
  1765. --- both width and height of windows is affected
  1766. ---
  1767. --- @type 'both'|'ver'|'hor'
  1768. vim.o.eadirection = "both"
  1769. vim.o.ead = vim.o.eadirection
  1770. vim.go.eadirection = vim.o.eadirection
  1771. vim.go.ead = vim.go.eadirection
  1772. --- When on all Unicode emoji characters are considered to be full width.
  1773. --- This excludes "text emoji" characters, which are normally displayed as
  1774. --- single width. However, such "text emoji" are treated as full-width
  1775. --- emoji if they are followed by the U+FE0F variant selector.
  1776. ---
  1777. --- Unfortunately there is no good specification for this and it has been
  1778. --- determined on trial-and-error basis. Use the `setcellwidths()`
  1779. --- function to change the behavior.
  1780. ---
  1781. --- @type boolean
  1782. vim.o.emoji = true
  1783. vim.o.emo = vim.o.emoji
  1784. vim.go.emoji = vim.o.emoji
  1785. vim.go.emo = vim.go.emoji
  1786. --- String-encoding used internally and for `RPC` communication.
  1787. --- Always UTF-8.
  1788. ---
  1789. --- See 'fileencoding' to control file-content encoding.
  1790. ---
  1791. --- @type string
  1792. vim.o.encoding = "utf-8"
  1793. vim.o.enc = vim.o.encoding
  1794. vim.go.encoding = vim.o.encoding
  1795. vim.go.enc = vim.go.encoding
  1796. --- Indicates that a CTRL-Z character was found at the end of the file
  1797. --- when reading it. Normally only happens when 'fileformat' is "dos".
  1798. --- When writing a file and this option is off and the 'binary' option
  1799. --- is on, or 'fixeol' option is off, no CTRL-Z will be written at the
  1800. --- end of the file.
  1801. --- See `eol-and-eof` for example settings.
  1802. ---
  1803. --- @type boolean
  1804. vim.o.endoffile = false
  1805. vim.o.eof = vim.o.endoffile
  1806. vim.bo.endoffile = vim.o.endoffile
  1807. vim.bo.eof = vim.bo.endoffile
  1808. --- When writing a file and this option is off and the 'binary' option
  1809. --- is on, or 'fixeol' option is off, no <EOL> will be written for the
  1810. --- last line in the file. This option is automatically set or reset when
  1811. --- starting to edit a new file, depending on whether file has an <EOL>
  1812. --- for the last line in the file. Normally you don't have to set or
  1813. --- reset this option.
  1814. --- When 'binary' is off and 'fixeol' is on the value is not used when
  1815. --- writing the file. When 'binary' is on or 'fixeol' is off it is used
  1816. --- to remember the presence of a <EOL> for the last line in the file, so
  1817. --- that when you write the file the situation from the original file can
  1818. --- be kept. But you can change it if you want to.
  1819. --- See `eol-and-eof` for example settings.
  1820. ---
  1821. --- @type boolean
  1822. vim.o.endofline = true
  1823. vim.o.eol = vim.o.endofline
  1824. vim.bo.endofline = vim.o.endofline
  1825. vim.bo.eol = vim.bo.endofline
  1826. --- When on, all the windows are automatically made the same size after
  1827. --- splitting or closing a window. This also happens the moment the
  1828. --- option is switched on. When off, splitting a window will reduce the
  1829. --- size of the current window and leave the other windows the same. When
  1830. --- closing a window the extra lines are given to the window next to it
  1831. --- (depending on 'splitbelow' and 'splitright').
  1832. --- When mixing vertically and horizontally split windows, a minimal size
  1833. --- is computed and some windows may be larger if there is room. The
  1834. --- 'eadirection' option tells in which direction the size is affected.
  1835. --- Changing the height and width of a window can be avoided by setting
  1836. --- 'winfixheight' and 'winfixwidth', respectively.
  1837. --- If a window size is specified when creating a new window sizes are
  1838. --- currently not equalized (it's complicated, but may be implemented in
  1839. --- the future).
  1840. ---
  1841. --- @type boolean
  1842. vim.o.equalalways = true
  1843. vim.o.ea = vim.o.equalalways
  1844. vim.go.equalalways = vim.o.equalalways
  1845. vim.go.ea = vim.go.equalalways
  1846. --- External program to use for "=" command. When this option is empty
  1847. --- the internal formatting functions are used; either 'lisp', 'cindent'
  1848. --- or 'indentexpr'.
  1849. --- Environment variables are expanded `:set_env`. See `option-backslash`
  1850. --- about including spaces and backslashes.
  1851. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1852. --- security reasons.
  1853. ---
  1854. --- @type string
  1855. vim.o.equalprg = ""
  1856. vim.o.ep = vim.o.equalprg
  1857. vim.bo.equalprg = vim.o.equalprg
  1858. vim.bo.ep = vim.bo.equalprg
  1859. vim.go.equalprg = vim.o.equalprg
  1860. vim.go.ep = vim.go.equalprg
  1861. --- Ring the bell (beep or screen flash) for error messages. This only
  1862. --- makes a difference for error messages, the bell will be used always
  1863. --- for a lot of errors without a message (e.g., hitting <Esc> in Normal
  1864. --- mode). See 'visualbell' to make the bell behave like a screen flash
  1865. --- or do nothing. See 'belloff' to finetune when to ring the bell.
  1866. ---
  1867. --- @type boolean
  1868. vim.o.errorbells = false
  1869. vim.o.eb = vim.o.errorbells
  1870. vim.go.errorbells = vim.o.errorbells
  1871. vim.go.eb = vim.go.errorbells
  1872. --- Name of the errorfile for the QuickFix mode (see `:cf`).
  1873. --- When the "-q" command-line argument is used, 'errorfile' is set to the
  1874. --- following argument. See `-q`.
  1875. --- NOT used for the ":make" command. See 'makeef' for that.
  1876. --- Environment variables are expanded `:set_env`.
  1877. --- See `option-backslash` about including spaces and backslashes.
  1878. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1879. --- security reasons.
  1880. ---
  1881. --- @type string
  1882. vim.o.errorfile = "errors.err"
  1883. vim.o.ef = vim.o.errorfile
  1884. vim.go.errorfile = vim.o.errorfile
  1885. vim.go.ef = vim.go.errorfile
  1886. --- Scanf-like description of the format for the lines in the error file
  1887. --- (see `errorformat`).
  1888. ---
  1889. --- @type string
  1890. vim.o.errorformat = "%*[^\"]\"%f\"%*\\D%l: %m,\"%f\"%*\\D%l: %m,%-Gg%\\?make[%*\\d]: *** [%f:%l:%m,%-Gg%\\?make: *** [%f:%l:%m,%-G%f:%l: (Each undeclared identifier is reported only once,%-G%f:%l: for each function it appears in.),%-GIn file included from %f:%l:%c:,%-GIn file included from %f:%l:%c\\,,%-GIn file included from %f:%l:%c,%-GIn file included from %f:%l,%-G%*[ ]from %f:%l:%c,%-G%*[ ]from %f:%l:,%-G%*[ ]from %f:%l\\,,%-G%*[ ]from %f:%l,%f:%l:%c:%m,%f(%l):%m,%f:%l:%m,\"%f\"\\, line %l%*\\D%c%*[^ ] %m,%D%*\\a[%*\\d]: Entering directory %*[`']%f',%X%*\\a[%*\\d]: Leaving directory %*[`']%f',%D%*\\a: Entering directory %*[`']%f',%X%*\\a: Leaving directory %*[`']%f',%DMaking %*\\a in %f,%f|%l| %m"
  1891. vim.o.efm = vim.o.errorformat
  1892. vim.bo.errorformat = vim.o.errorformat
  1893. vim.bo.efm = vim.bo.errorformat
  1894. vim.go.errorformat = vim.o.errorformat
  1895. vim.go.efm = vim.go.errorformat
  1896. --- A list of autocommand event names, which are to be ignored.
  1897. --- When set to "all" or when "all" is one of the items, all autocommand
  1898. --- events are ignored, autocommands will not be executed.
  1899. --- Otherwise this is a comma-separated list of event names. Example:
  1900. ---
  1901. --- ```vim
  1902. --- set ei=WinEnter,WinLeave
  1903. --- ```
  1904. ---
  1905. ---
  1906. --- @type string
  1907. vim.o.eventignore = ""
  1908. vim.o.ei = vim.o.eventignore
  1909. vim.go.eventignore = vim.o.eventignore
  1910. vim.go.ei = vim.go.eventignore
  1911. --- Similar to 'eventignore' but applies to a particular window and its
  1912. --- buffers, for which window and buffer related autocommands can be
  1913. --- ignored indefinitely without affecting the global 'eventignore'.
  1914. ---
  1915. --- @type string
  1916. vim.o.eventignorewin = ""
  1917. vim.o.eiw = vim.o.eventignorewin
  1918. vim.wo.eventignorewin = vim.o.eventignorewin
  1919. vim.wo.eiw = vim.wo.eventignorewin
  1920. --- In Insert mode: Use the appropriate number of spaces to insert a
  1921. --- <Tab>. Spaces are used in indents with the '>' and '<' commands and
  1922. --- when 'autoindent' is on. To insert a real tab when 'expandtab' is
  1923. --- on, use CTRL-V<Tab>. See also `:retab` and `ins-expandtab`.
  1924. ---
  1925. --- @type boolean
  1926. vim.o.expandtab = false
  1927. vim.o.et = vim.o.expandtab
  1928. vim.bo.expandtab = vim.o.expandtab
  1929. vim.bo.et = vim.bo.expandtab
  1930. --- Automatically execute .nvim.lua, .nvimrc, and .exrc files in the
  1931. --- current directory, if the file is in the `trust` list. Use `:trust` to
  1932. --- manage trusted files. See also `vim.secure.read()`.
  1933. ---
  1934. --- Compare 'exrc' to `editorconfig`:
  1935. --- - 'exrc' can execute any code; editorconfig only specifies settings.
  1936. --- - 'exrc' is Nvim-specific; editorconfig works in other editors.
  1937. ---
  1938. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1939. --- security reasons.
  1940. ---
  1941. --- @type boolean
  1942. vim.o.exrc = false
  1943. vim.o.ex = vim.o.exrc
  1944. vim.go.exrc = vim.o.exrc
  1945. vim.go.ex = vim.go.exrc
  1946. --- File-content encoding for the current buffer. Conversion is done with
  1947. --- iconv() or as specified with 'charconvert'.
  1948. ---
  1949. --- When 'fileencoding' is not UTF-8, conversion will be done when
  1950. --- writing the file. For reading see below.
  1951. --- When 'fileencoding' is empty, the file will be saved with UTF-8
  1952. --- encoding (no conversion when reading or writing a file).
  1953. ---
  1954. --- WARNING: Conversion to a non-Unicode encoding can cause loss of
  1955. --- information!
  1956. ---
  1957. --- See `encoding-names` for the possible values. Additionally, values may be
  1958. --- specified that can be handled by the converter, see
  1959. --- `mbyte-conversion`.
  1960. ---
  1961. --- When reading a file 'fileencoding' will be set from 'fileencodings'.
  1962. --- To read a file in a certain encoding it won't work by setting
  1963. --- 'fileencoding', use the `++enc` argument. One exception: when
  1964. --- 'fileencodings' is empty the value of 'fileencoding' is used.
  1965. --- For a new file the global value of 'fileencoding' is used.
  1966. ---
  1967. --- Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
  1968. --- When the option is set, the value is converted to lowercase. Thus
  1969. --- you can set it with uppercase values too. '_' characters are
  1970. --- replaced with '-'. If a name is recognized from the list at
  1971. --- `encoding-names`, it is replaced by the standard name. For example
  1972. --- "ISO8859-2" becomes "iso-8859-2".
  1973. ---
  1974. --- When this option is set, after starting to edit a file, the 'modified'
  1975. --- option is set, because the file would be different when written.
  1976. ---
  1977. --- Keep in mind that changing 'fenc' from a modeline happens
  1978. --- AFTER the text has been read, thus it applies to when the file will be
  1979. --- written. If you do set 'fenc' in a modeline, you might want to set
  1980. --- 'nomodified' to avoid not being able to ":q".
  1981. ---
  1982. --- This option cannot be changed when 'modifiable' is off.
  1983. ---
  1984. --- @type string
  1985. vim.o.fileencoding = ""
  1986. vim.o.fenc = vim.o.fileencoding
  1987. vim.bo.fileencoding = vim.o.fileencoding
  1988. vim.bo.fenc = vim.bo.fileencoding
  1989. --- This is a list of character encodings considered when starting to edit
  1990. --- an existing file. When a file is read, Vim tries to use the first
  1991. --- mentioned character encoding. If an error is detected, the next one
  1992. --- in the list is tried. When an encoding is found that works,
  1993. --- 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
  1994. --- an empty string, which means that UTF-8 is used.
  1995. --- WARNING: Conversion can cause loss of information! You can use
  1996. --- the `++bad` argument to specify what is done with characters
  1997. --- that can't be converted.
  1998. --- For an empty file or a file with only ASCII characters most encodings
  1999. --- will work and the first entry of 'fileencodings' will be used (except
  2000. --- "ucs-bom", which requires the BOM to be present). If you prefer
  2001. --- another encoding use an BufReadPost autocommand event to test if your
  2002. --- preferred encoding is to be used. Example:
  2003. ---
  2004. --- ```vim
  2005. --- au BufReadPost * if search('\S', 'w') == 0 |
  2006. --- \ set fenc=iso-2022-jp | endif
  2007. --- ```
  2008. --- This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
  2009. --- non-blank characters.
  2010. --- When the `++enc` argument is used then the value of 'fileencodings' is
  2011. --- not used.
  2012. --- Note that 'fileencodings' is not used for a new file, the global value
  2013. --- of 'fileencoding' is used instead. You can set it with:
  2014. ---
  2015. --- ```vim
  2016. --- setglobal fenc=iso-8859-2
  2017. --- ```
  2018. --- This means that a non-existing file may get a different encoding than
  2019. --- an empty file.
  2020. --- The special value "ucs-bom" can be used to check for a Unicode BOM
  2021. --- (Byte Order Mark) at the start of the file. It must not be preceded
  2022. --- by "utf-8" or another Unicode encoding for this to work properly.
  2023. --- An entry for an 8-bit encoding (e.g., "latin1") should be the last,
  2024. --- because Vim cannot detect an error, thus the encoding is always
  2025. --- accepted.
  2026. --- The special value "default" can be used for the encoding from the
  2027. --- environment. It is useful when your environment uses a non-latin1
  2028. --- encoding, such as Russian.
  2029. --- When a file contains an illegal UTF-8 byte sequence it won't be
  2030. --- recognized as "utf-8". You can use the `8g8` command to find the
  2031. --- illegal byte sequence.
  2032. --- WRONG VALUES: WHAT'S WRONG:
  2033. --- latin1,utf-8 "latin1" will always be used
  2034. --- utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
  2035. --- file
  2036. --- cp1250,latin1 "cp1250" will always be used
  2037. --- If 'fileencodings' is empty, 'fileencoding' is not modified.
  2038. --- See 'fileencoding' for the possible values.
  2039. --- Setting this option does not have an effect until the next time a file
  2040. --- is read.
  2041. ---
  2042. --- @type string
  2043. vim.o.fileencodings = "ucs-bom,utf-8,default,latin1"
  2044. vim.o.fencs = vim.o.fileencodings
  2045. vim.go.fileencodings = vim.o.fileencodings
  2046. vim.go.fencs = vim.go.fileencodings
  2047. --- This gives the <EOL> of the current buffer, which is used for
  2048. --- reading/writing the buffer from/to a file:
  2049. --- dos <CR><NL>
  2050. --- unix <NL>
  2051. --- mac <CR>
  2052. --- When "dos" is used, CTRL-Z at the end of a file is ignored.
  2053. --- See `file-formats` and `file-read`.
  2054. --- For the character encoding of the file see 'fileencoding'.
  2055. --- When 'binary' is set, the value of 'fileformat' is ignored, file I/O
  2056. --- works like it was set to "unix".
  2057. --- This option is set automatically when starting to edit a file and
  2058. --- 'fileformats' is not empty and 'binary' is off.
  2059. --- When this option is set, after starting to edit a file, the 'modified'
  2060. --- option is set, because the file would be different when written.
  2061. --- This option cannot be changed when 'modifiable' is off.
  2062. ---
  2063. --- @type 'unix'|'dos'|'mac'
  2064. vim.o.fileformat = "unix"
  2065. vim.o.ff = vim.o.fileformat
  2066. vim.bo.fileformat = vim.o.fileformat
  2067. vim.bo.ff = vim.bo.fileformat
  2068. --- This gives the end-of-line (<EOL>) formats that will be tried when
  2069. --- starting to edit a new buffer and when reading a file into an existing
  2070. --- buffer:
  2071. --- - When empty, the format defined with 'fileformat' will be used
  2072. --- always. It is not set automatically.
  2073. --- - When set to one name, that format will be used whenever a new buffer
  2074. --- is opened. 'fileformat' is set accordingly for that buffer. The
  2075. --- 'fileformats' name will be used when a file is read into an existing
  2076. --- buffer, no matter what 'fileformat' for that buffer is set to.
  2077. --- - When more than one name is present, separated by commas, automatic
  2078. --- <EOL> detection will be done when reading a file. When starting to
  2079. --- edit a file, a check is done for the <EOL>:
  2080. --- 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
  2081. --- 'fileformat' is set to "dos".
  2082. --- 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
  2083. --- is set to "unix". Note that when a <NL> is found without a
  2084. --- preceding <CR>, "unix" is preferred over "dos".
  2085. --- 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
  2086. --- if 'fileformats' includes "mac", 'fileformat' is set to "mac".
  2087. --- This means that "mac" is only chosen when:
  2088. --- "unix" is not present or no <NL> is found in the file, and
  2089. --- "dos" is not present or no <CR><NL> is found in the file.
  2090. --- Except: if "unix" was chosen, but there is a <CR> before
  2091. --- the first <NL>, and there appear to be more <CR>s than <NL>s in
  2092. --- the first few lines, "mac" is used.
  2093. --- 4. If 'fileformat' is still not set, the first name from
  2094. --- 'fileformats' is used.
  2095. --- When reading a file into an existing buffer, the same is done, but
  2096. --- this happens like 'fileformat' has been set appropriately for that
  2097. --- file only, the option is not changed.
  2098. --- When 'binary' is set, the value of 'fileformats' is not used.
  2099. ---
  2100. --- When Vim starts up with an empty buffer the first item is used. You
  2101. --- can overrule this by setting 'fileformat' in your .vimrc.
  2102. ---
  2103. --- For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
  2104. --- are ":source"ed and for vimrc files, automatic <EOL> detection may be
  2105. --- done:
  2106. --- - When 'fileformats' is empty, there is no automatic detection. Dos
  2107. --- format will be used.
  2108. --- - When 'fileformats' is set to one or more names, automatic detection
  2109. --- is done. This is based on the first <NL> in the file: If there is a
  2110. --- <CR> in front of it, Dos format is used, otherwise Unix format is
  2111. --- used.
  2112. --- Also see `file-formats`.
  2113. ---
  2114. --- @type string
  2115. vim.o.fileformats = "unix,dos"
  2116. vim.o.ffs = vim.o.fileformats
  2117. vim.go.fileformats = vim.o.fileformats
  2118. vim.go.ffs = vim.go.fileformats
  2119. --- When set case is ignored when using file names and directories.
  2120. --- See 'wildignorecase' for only ignoring case when doing completion.
  2121. ---
  2122. --- @type boolean
  2123. vim.o.fileignorecase = false
  2124. vim.o.fic = vim.o.fileignorecase
  2125. vim.go.fileignorecase = vim.o.fileignorecase
  2126. vim.go.fic = vim.go.fileignorecase
  2127. --- When this option is set, the FileType autocommand event is triggered.
  2128. --- All autocommands that match with the value of this option will be
  2129. --- executed. Thus the value of 'filetype' is used in place of the file
  2130. --- name.
  2131. --- Otherwise this option does not always reflect the current file type.
  2132. --- This option is normally set when the file type is detected. To enable
  2133. --- this use the ":filetype on" command. `:filetype`
  2134. --- Setting this option to a different value is most useful in a modeline,
  2135. --- for a file for which the file type is not automatically recognized.
  2136. --- Example, for in an IDL file: >c
  2137. --- /* vim: set filetype=idl : */
  2138. --- ```
  2139. --- `FileType` `filetypes`
  2140. --- When a dot appears in the value then this separates two filetype
  2141. --- names, it should therefore not be used for a filetype. Example: >c
  2142. --- /* vim: set filetype=c.doxygen : */
  2143. --- ```
  2144. --- This will use the "c" filetype first, then the "doxygen" filetype.
  2145. --- This works both for filetype plugins and for syntax files. More than
  2146. --- one dot may appear.
  2147. --- This option is not copied to another buffer, independent of the 's' or
  2148. --- 'S' flag in 'cpoptions'.
  2149. --- Only alphanumeric characters, '-' and '_' can be used.
  2150. ---
  2151. --- @type string
  2152. vim.o.filetype = ""
  2153. vim.o.ft = vim.o.filetype
  2154. vim.bo.filetype = vim.o.filetype
  2155. vim.bo.ft = vim.bo.filetype
  2156. --- Characters to fill the statuslines, vertical separators and special
  2157. --- lines in the window.
  2158. --- It is a comma-separated list of items. Each item has a name, a colon
  2159. --- and the value of that item: `E1511`
  2160. ---
  2161. --- item default Used for ~
  2162. --- stl ' ' statusline of the current window
  2163. --- stlnc ' ' statusline of the non-current windows
  2164. --- wbr ' ' window bar
  2165. --- horiz '─' or '-' horizontal separators `:split`
  2166. --- horizup '┴' or '-' upwards facing horizontal separator
  2167. --- horizdown '┬' or '-' downwards facing horizontal separator
  2168. --- vert '│' or '|' vertical separators `:vsplit`
  2169. --- vertleft '┤' or '|' left facing vertical separator
  2170. --- vertright '├' or '|' right facing vertical separator
  2171. --- verthoriz '┼' or '+' overlapping vertical and horizontal
  2172. --- separator
  2173. --- fold '·' or '-' filling 'foldtext'
  2174. --- foldopen '-' mark the beginning of a fold
  2175. --- foldclose '+' show a closed fold
  2176. --- foldsep '│' or '|' open fold middle marker
  2177. --- diff '-' deleted lines of the 'diff' option
  2178. --- msgsep ' ' message separator 'display'
  2179. --- eob '~' empty lines at the end of a buffer
  2180. --- lastline '@' 'display' contains lastline/truncate
  2181. ---
  2182. --- Any one that is omitted will fall back to the default.
  2183. ---
  2184. --- Note that "horiz", "horizup", "horizdown", "vertleft", "vertright" and
  2185. --- "verthoriz" are only used when 'laststatus' is 3, since only vertical
  2186. --- window separators are used otherwise.
  2187. ---
  2188. --- If 'ambiwidth' is "double" then "horiz", "horizup", "horizdown",
  2189. --- "vert", "vertleft", "vertright", "verthoriz", "foldsep" and "fold"
  2190. --- default to single-byte alternatives.
  2191. ---
  2192. --- Example:
  2193. ---
  2194. --- ```vim
  2195. --- set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
  2196. --- ```
  2197. ---
  2198. --- For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
  2199. --- single-byte and multibyte characters are supported. But double-width
  2200. --- characters are not supported. `E1512`
  2201. ---
  2202. --- The highlighting used for these items:
  2203. --- item highlight group ~
  2204. --- stl StatusLine `hl-StatusLine`
  2205. --- stlnc StatusLineNC `hl-StatusLineNC`
  2206. --- wbr WinBar `hl-WinBar` or `hl-WinBarNC`
  2207. --- horiz WinSeparator `hl-WinSeparator`
  2208. --- horizup WinSeparator `hl-WinSeparator`
  2209. --- horizdown WinSeparator `hl-WinSeparator`
  2210. --- vert WinSeparator `hl-WinSeparator`
  2211. --- vertleft WinSeparator `hl-WinSeparator`
  2212. --- vertright WinSeparator `hl-WinSeparator`
  2213. --- verthoriz WinSeparator `hl-WinSeparator`
  2214. --- fold Folded `hl-Folded`
  2215. --- diff DiffDelete `hl-DiffDelete`
  2216. --- eob EndOfBuffer `hl-EndOfBuffer`
  2217. --- lastline NonText `hl-NonText`
  2218. ---
  2219. --- @type string
  2220. vim.o.fillchars = ""
  2221. vim.o.fcs = vim.o.fillchars
  2222. vim.wo.fillchars = vim.o.fillchars
  2223. vim.wo.fcs = vim.wo.fillchars
  2224. vim.go.fillchars = vim.o.fillchars
  2225. vim.go.fcs = vim.go.fillchars
  2226. --- Function that is called to obtain the filename(s) for the `:find`
  2227. --- command. When this option is empty, the internal `file-searching`
  2228. --- mechanism is used.
  2229. ---
  2230. --- The value can be the name of a function, a `lambda` or a `Funcref`.
  2231. --- See `option-value-function` for more information.
  2232. ---
  2233. --- The function is called with two arguments. The first argument is a
  2234. --- `String` and is the `:find` command argument. The second argument is
  2235. --- a `Boolean` and is set to `v:true` when the function is called to get
  2236. --- a List of command-line completion matches for the `:find` command.
  2237. --- The function should return a List of strings.
  2238. ---
  2239. --- The function is called only once per `:find` command invocation.
  2240. --- The function can process all the directories specified in 'path'.
  2241. ---
  2242. --- If a match is found, the function should return a `List` containing
  2243. --- one or more file names. If a match is not found, the function
  2244. --- should return an empty List.
  2245. ---
  2246. --- If any errors are encountered during the function invocation, an
  2247. --- empty List is used as the return value.
  2248. ---
  2249. --- It is not allowed to change text or jump to another window while
  2250. --- executing the 'findfunc' `textlock`.
  2251. ---
  2252. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2253. --- security reasons.
  2254. ---
  2255. --- Examples:
  2256. ---
  2257. --- ```vim
  2258. --- " Use glob()
  2259. --- func FindFuncGlob(cmdarg, cmdcomplete)
  2260. --- let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
  2261. --- return glob(pat, v:false, v:true)
  2262. --- endfunc
  2263. --- set findfunc=FindFuncGlob
  2264. ---
  2265. --- " Use the 'git ls-files' output
  2266. --- func FindGitFiles(cmdarg, cmdcomplete)
  2267. --- let fnames = systemlist('git ls-files')
  2268. --- return fnames->filter('v:val =~? a:cmdarg')
  2269. --- endfunc
  2270. --- set findfunc=FindGitFiles
  2271. --- ```
  2272. ---
  2273. ---
  2274. --- @type string
  2275. vim.o.findfunc = ""
  2276. vim.o.ffu = vim.o.findfunc
  2277. vim.bo.findfunc = vim.o.findfunc
  2278. vim.bo.ffu = vim.bo.findfunc
  2279. vim.go.findfunc = vim.o.findfunc
  2280. vim.go.ffu = vim.go.findfunc
  2281. --- When writing a file and this option is on, <EOL> at the end of file
  2282. --- will be restored if missing. Turn this option off if you want to
  2283. --- preserve the situation from the original file.
  2284. --- When the 'binary' option is set the value of this option doesn't
  2285. --- matter.
  2286. --- See the 'endofline' option.
  2287. --- See `eol-and-eof` for example settings.
  2288. ---
  2289. --- @type boolean
  2290. vim.o.fixendofline = true
  2291. vim.o.fixeol = vim.o.fixendofline
  2292. vim.bo.fixendofline = vim.o.fixendofline
  2293. vim.bo.fixeol = vim.bo.fixendofline
  2294. --- When set to "all", a fold is closed when the cursor isn't in it and
  2295. --- its level is higher than 'foldlevel'. Useful if you want folds to
  2296. --- automatically close when moving out of them.
  2297. ---
  2298. --- @type string
  2299. vim.o.foldclose = ""
  2300. vim.o.fcl = vim.o.foldclose
  2301. vim.go.foldclose = vim.o.foldclose
  2302. vim.go.fcl = vim.go.foldclose
  2303. --- When and how to draw the foldcolumn. Valid values are:
  2304. --- "auto": resize to the minimum amount of folds to display.
  2305. --- "auto:[1-9]": resize to accommodate multiple folds up to the
  2306. --- selected level
  2307. --- "0": to disable foldcolumn
  2308. --- "[1-9]": to display a fixed number of columns
  2309. --- See `folding`.
  2310. ---
  2311. --- @type 'auto'|'auto:1'|'auto:2'|'auto:3'|'auto:4'|'auto:5'|'auto:6'|'auto:7'|'auto:8'|'auto:9'|'0'|'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'
  2312. vim.o.foldcolumn = "0"
  2313. vim.o.fdc = vim.o.foldcolumn
  2314. vim.wo.foldcolumn = vim.o.foldcolumn
  2315. vim.wo.fdc = vim.wo.foldcolumn
  2316. --- When off, all folds are open. This option can be used to quickly
  2317. --- switch between showing all text unfolded and viewing the text with
  2318. --- folds (including manually opened or closed folds). It can be toggled
  2319. --- with the `zi` command. The 'foldcolumn' will remain blank when
  2320. --- 'foldenable' is off.
  2321. --- This option is set by commands that create a new fold or close a fold.
  2322. --- See `folding`.
  2323. ---
  2324. --- @type boolean
  2325. vim.o.foldenable = true
  2326. vim.o.fen = vim.o.foldenable
  2327. vim.wo.foldenable = vim.o.foldenable
  2328. vim.wo.fen = vim.wo.foldenable
  2329. --- The expression used for when 'foldmethod' is "expr". It is evaluated
  2330. --- for each line to obtain its fold level. The context is set to the
  2331. --- script where 'foldexpr' was set, script-local items can be accessed.
  2332. --- See `fold-expr` for the usage.
  2333. ---
  2334. --- The expression will be evaluated in the `sandbox` if set from a
  2335. --- modeline, see `sandbox-option`.
  2336. --- This option can't be set from a `modeline` when the 'diff' option is
  2337. --- on or the 'modelineexpr' option is off.
  2338. ---
  2339. --- It is not allowed to change text or jump to another window while
  2340. --- evaluating 'foldexpr' `textlock`.
  2341. ---
  2342. --- @type string
  2343. vim.o.foldexpr = "0"
  2344. vim.o.fde = vim.o.foldexpr
  2345. vim.wo.foldexpr = vim.o.foldexpr
  2346. vim.wo.fde = vim.wo.foldexpr
  2347. --- Used only when 'foldmethod' is "indent". Lines starting with
  2348. --- characters in 'foldignore' will get their fold level from surrounding
  2349. --- lines. White space is skipped before checking for this character.
  2350. --- The default "#" works well for C programs. See `fold-indent`.
  2351. ---
  2352. --- @type string
  2353. vim.o.foldignore = "#"
  2354. vim.o.fdi = vim.o.foldignore
  2355. vim.wo.foldignore = vim.o.foldignore
  2356. vim.wo.fdi = vim.wo.foldignore
  2357. --- Sets the fold level: Folds with a higher level will be closed.
  2358. --- Setting this option to zero will close all folds. Higher numbers will
  2359. --- close fewer folds.
  2360. --- This option is set by commands like `zm`, `zM` and `zR`.
  2361. --- See `fold-foldlevel`.
  2362. ---
  2363. --- @type integer
  2364. vim.o.foldlevel = 0
  2365. vim.o.fdl = vim.o.foldlevel
  2366. vim.wo.foldlevel = vim.o.foldlevel
  2367. vim.wo.fdl = vim.wo.foldlevel
  2368. --- Sets 'foldlevel' when starting to edit another buffer in a window.
  2369. --- Useful to always start editing with all folds closed (value zero),
  2370. --- some folds closed (one) or no folds closed (99).
  2371. --- This is done before reading any modeline, thus a setting in a modeline
  2372. --- overrules this option. Starting to edit a file for `diff-mode` also
  2373. --- ignores this option and closes all folds.
  2374. --- It is also done before BufReadPre autocommands, to allow an autocmd to
  2375. --- overrule the 'foldlevel' value for specific files.
  2376. --- When the value is negative, it is not used.
  2377. ---
  2378. --- @type integer
  2379. vim.o.foldlevelstart = -1
  2380. vim.o.fdls = vim.o.foldlevelstart
  2381. vim.go.foldlevelstart = vim.o.foldlevelstart
  2382. vim.go.fdls = vim.go.foldlevelstart
  2383. --- The start and end marker used when 'foldmethod' is "marker". There
  2384. --- must be one comma, which separates the start and end marker. The
  2385. --- marker is a literal string (a regular expression would be too slow).
  2386. --- See `fold-marker`.
  2387. ---
  2388. --- @type string
  2389. vim.o.foldmarker = "{{{,}}}"
  2390. vim.o.fmr = vim.o.foldmarker
  2391. vim.wo.foldmarker = vim.o.foldmarker
  2392. vim.wo.fmr = vim.wo.foldmarker
  2393. --- The kind of folding used for the current window. Possible values:
  2394. --- `fold-manual` manual Folds are created manually.
  2395. --- `fold-indent` indent Lines with equal indent form a fold.
  2396. --- `fold-expr` expr 'foldexpr' gives the fold level of a line.
  2397. --- `fold-marker` marker Markers are used to specify folds.
  2398. --- `fold-syntax` syntax Syntax highlighting items specify folds.
  2399. --- `fold-diff` diff Fold text that is not changed.
  2400. ---
  2401. --- @type 'manual'|'expr'|'marker'|'indent'|'syntax'|'diff'
  2402. vim.o.foldmethod = "manual"
  2403. vim.o.fdm = vim.o.foldmethod
  2404. vim.wo.foldmethod = vim.o.foldmethod
  2405. vim.wo.fdm = vim.wo.foldmethod
  2406. --- Sets the number of screen lines above which a fold can be displayed
  2407. --- closed. Also for manually closed folds. With the default value of
  2408. --- one a fold can only be closed if it takes up two or more screen lines.
  2409. --- Set to zero to be able to close folds of just one screen line.
  2410. --- Note that this only has an effect on what is displayed. After using
  2411. --- "zc" to close a fold, which is displayed open because it's smaller
  2412. --- than 'foldminlines', a following "zc" may close a containing fold.
  2413. ---
  2414. --- @type integer
  2415. vim.o.foldminlines = 1
  2416. vim.o.fml = vim.o.foldminlines
  2417. vim.wo.foldminlines = vim.o.foldminlines
  2418. vim.wo.fml = vim.wo.foldminlines
  2419. --- Sets the maximum nesting of folds for the "indent" and "syntax"
  2420. --- methods. This avoids that too many folds will be created. Using more
  2421. --- than 20 doesn't work, because the internal limit is 20.
  2422. ---
  2423. --- @type integer
  2424. vim.o.foldnestmax = 20
  2425. vim.o.fdn = vim.o.foldnestmax
  2426. vim.wo.foldnestmax = vim.o.foldnestmax
  2427. vim.wo.fdn = vim.wo.foldnestmax
  2428. --- Specifies for which type of commands folds will be opened, if the
  2429. --- command moves the cursor into a closed fold. It is a comma-separated
  2430. --- list of items.
  2431. --- NOTE: When the command is part of a mapping this option is not used.
  2432. --- Add the `zv` command to the mapping to get the same effect.
  2433. --- (rationale: the mapping may want to control opening folds itself)
  2434. ---
  2435. --- item commands ~
  2436. --- all any
  2437. --- block (, {, [[, [{, etc.
  2438. --- hor horizontal movements: "l", "w", "fx", etc.
  2439. --- insert any command in Insert mode
  2440. --- jump far jumps: "G", "gg", etc.
  2441. --- mark jumping to a mark: "'m", CTRL-O, etc.
  2442. --- percent "%"
  2443. --- quickfix ":cn", ":crew", ":make", etc.
  2444. --- search search for a pattern: "/", "n", "*", "gd", etc.
  2445. --- (not for a search pattern in a ":" command)
  2446. --- Also for `[s` and `]s`.
  2447. --- tag jumping to a tag: ":ta", CTRL-T, etc.
  2448. --- undo undo or redo: "u" and CTRL-R
  2449. --- When a movement command is used for an operator (e.g., "dl" or "y%")
  2450. --- this option is not used. This means the operator will include the
  2451. --- whole closed fold.
  2452. --- Note that vertical movements are not here, because it would make it
  2453. --- very difficult to move onto a closed fold.
  2454. --- In insert mode the folds containing the cursor will always be open
  2455. --- when text is inserted.
  2456. --- To close folds you can re-apply 'foldlevel' with the `zx` command or
  2457. --- set the 'foldclose' option to "all".
  2458. ---
  2459. --- @type string
  2460. vim.o.foldopen = "block,hor,mark,percent,quickfix,search,tag,undo"
  2461. vim.o.fdo = vim.o.foldopen
  2462. vim.go.foldopen = vim.o.foldopen
  2463. vim.go.fdo = vim.go.foldopen
  2464. --- An expression which is used to specify the text displayed for a closed
  2465. --- fold. The context is set to the script where 'foldexpr' was set,
  2466. --- script-local items can be accessed. See `fold-foldtext` for the
  2467. --- usage.
  2468. ---
  2469. --- The expression will be evaluated in the `sandbox` if set from a
  2470. --- modeline, see `sandbox-option`.
  2471. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  2472. ---
  2473. --- It is not allowed to change text or jump to another window while
  2474. --- evaluating 'foldtext' `textlock`.
  2475. ---
  2476. --- When set to an empty string, foldtext is disabled, and the line
  2477. --- is displayed normally with highlighting and no line wrapping.
  2478. ---
  2479. --- @type string
  2480. vim.o.foldtext = "foldtext()"
  2481. vim.o.fdt = vim.o.foldtext
  2482. vim.wo.foldtext = vim.o.foldtext
  2483. vim.wo.fdt = vim.wo.foldtext
  2484. --- Expression which is evaluated to format a range of lines for the `gq`
  2485. --- operator or automatic formatting (see 'formatoptions'). When this
  2486. --- option is empty 'formatprg' is used.
  2487. ---
  2488. --- The `v:lnum` variable holds the first line to be formatted.
  2489. --- The `v:count` variable holds the number of lines to be formatted.
  2490. --- The `v:char` variable holds the character that is going to be
  2491. --- inserted if the expression is being evaluated due to
  2492. --- automatic formatting. This can be empty. Don't insert
  2493. --- it yet!
  2494. ---
  2495. --- Example:
  2496. ---
  2497. --- ```vim
  2498. --- set formatexpr=mylang#Format()
  2499. --- ```
  2500. --- This will invoke the mylang#Format() function in the
  2501. --- autoload/mylang.vim file in 'runtimepath'. `autoload`
  2502. ---
  2503. --- The advantage of using a function call without arguments is that it is
  2504. --- faster, see `expr-option-function`.
  2505. ---
  2506. --- The expression is also evaluated when 'textwidth' is set and adding
  2507. --- text beyond that limit. This happens under the same conditions as
  2508. --- when internal formatting is used. Make sure the cursor is kept in the
  2509. --- same spot relative to the text then! The `mode()` function will
  2510. --- return "i" or "R" in this situation.
  2511. ---
  2512. --- When the expression evaluates to non-zero Vim will fall back to using
  2513. --- the internal format mechanism.
  2514. ---
  2515. --- If the expression starts with s: or `<SID>`, then it is replaced with
  2516. --- the script ID (`local-function`). Example:
  2517. ---
  2518. --- ```vim
  2519. --- set formatexpr=s:MyFormatExpr()
  2520. --- set formatexpr=<SID>SomeFormatExpr()
  2521. --- ```
  2522. --- Otherwise, the expression is evaluated in the context of the script
  2523. --- where the option was set, thus script-local items are available.
  2524. ---
  2525. --- The expression will be evaluated in the `sandbox` when set from a
  2526. --- modeline, see `sandbox-option`. That stops the option from working,
  2527. --- since changing the buffer text is not allowed.
  2528. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  2529. --- NOTE: This option is set to "" when 'compatible' is set.
  2530. ---
  2531. --- @type string
  2532. vim.o.formatexpr = ""
  2533. vim.o.fex = vim.o.formatexpr
  2534. vim.bo.formatexpr = vim.o.formatexpr
  2535. vim.bo.fex = vim.bo.formatexpr
  2536. --- A pattern that is used to recognize a list header. This is used for
  2537. --- the "n" flag in 'formatoptions'.
  2538. --- The pattern must match exactly the text that will be the indent for
  2539. --- the line below it. You can use `/\ze` to mark the end of the match
  2540. --- while still checking more characters. There must be a character
  2541. --- following the pattern, when it matches the whole line it is handled
  2542. --- like there is no match.
  2543. --- The default recognizes a number, followed by an optional punctuation
  2544. --- character and white space.
  2545. ---
  2546. --- @type string
  2547. vim.o.formatlistpat = "^\\s*\\d\\+[\\]:.)}\\t ]\\s*"
  2548. vim.o.flp = vim.o.formatlistpat
  2549. vim.bo.formatlistpat = vim.o.formatlistpat
  2550. vim.bo.flp = vim.bo.formatlistpat
  2551. --- This is a sequence of letters which describes how automatic
  2552. --- formatting is to be done.
  2553. --- See `fo-table` for possible values and `gq` for how to format text.
  2554. --- Commas can be inserted for readability.
  2555. --- To avoid problems with flags that are added in the future, use the
  2556. --- "+=" and "-=" feature of ":set" `add-option-flags`.
  2557. ---
  2558. --- @type string
  2559. vim.o.formatoptions = "tcqj"
  2560. vim.o.fo = vim.o.formatoptions
  2561. vim.bo.formatoptions = vim.o.formatoptions
  2562. vim.bo.fo = vim.bo.formatoptions
  2563. --- The name of an external program that will be used to format the lines
  2564. --- selected with the `gq` operator. The program must take the input on
  2565. --- stdin and produce the output on stdout. The Unix program "fmt" is
  2566. --- such a program.
  2567. --- If the 'formatexpr' option is not empty it will be used instead.
  2568. --- Otherwise, if 'formatprg' option is an empty string, the internal
  2569. --- format function will be used `C-indenting`.
  2570. --- Environment variables are expanded `:set_env`. See `option-backslash`
  2571. --- about including spaces and backslashes.
  2572. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2573. --- security reasons.
  2574. ---
  2575. --- @type string
  2576. vim.o.formatprg = ""
  2577. vim.o.fp = vim.o.formatprg
  2578. vim.bo.formatprg = vim.o.formatprg
  2579. vim.bo.fp = vim.bo.formatprg
  2580. vim.go.formatprg = vim.o.formatprg
  2581. vim.go.fp = vim.go.formatprg
  2582. --- When on, the OS function fsync() will be called after saving a file
  2583. --- (`:write`, `writefile()`, …), `swap-file`, `undo-persistence` and `shada-file`.
  2584. --- This flushes the file to disk, ensuring that it is safely written.
  2585. --- Slow on some systems: writing buffers, quitting Nvim, and other
  2586. --- operations may sometimes take a few seconds.
  2587. ---
  2588. --- Files are ALWAYS flushed ('fsync' is ignored) when:
  2589. --- - `CursorHold` event is triggered
  2590. --- - `:preserve` is called
  2591. --- - system signals low battery life
  2592. --- - Nvim exits abnormally
  2593. ---
  2594. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2595. --- security reasons.
  2596. ---
  2597. --- @type boolean
  2598. vim.o.fsync = true
  2599. vim.o.fs = vim.o.fsync
  2600. vim.go.fsync = vim.o.fsync
  2601. vim.go.fs = vim.go.fsync
  2602. --- When on, the ":substitute" flag 'g' is default on. This means that
  2603. --- all matches in a line are substituted instead of one. When a 'g' flag
  2604. --- is given to a ":substitute" command, this will toggle the substitution
  2605. --- of all or one match. See `complex-change`.
  2606. ---
  2607. --- command 'gdefault' on 'gdefault' off ~
  2608. --- :s/// subst. all subst. one
  2609. --- :s///g subst. one subst. all
  2610. --- :s///gg subst. all subst. one
  2611. ---
  2612. --- NOTE: Setting this option may break plugins that rely on the default
  2613. --- behavior of the 'g' flag. This will also make the 'g' flag have the
  2614. --- opposite effect of that documented in `:s_g`.
  2615. ---
  2616. --- @type boolean
  2617. vim.o.gdefault = false
  2618. vim.o.gd = vim.o.gdefault
  2619. vim.go.gdefault = vim.o.gdefault
  2620. vim.go.gd = vim.go.gdefault
  2621. --- Format to recognize for the ":grep" command output.
  2622. --- This is a scanf-like string that uses the same format as the
  2623. --- 'errorformat' option: see `errorformat`.
  2624. ---
  2625. --- If ripgrep ('grepprg') is available, this option defaults to `%f:%l:%c:%m`.
  2626. ---
  2627. --- @type string
  2628. vim.o.grepformat = "%f:%l:%m,%f:%l%m,%f %l%m"
  2629. vim.o.gfm = vim.o.grepformat
  2630. vim.go.grepformat = vim.o.grepformat
  2631. vim.go.gfm = vim.go.grepformat
  2632. --- Program to use for the `:grep` command. This option may contain '%'
  2633. --- and '#' characters, which are expanded like when used in a command-
  2634. --- line. The placeholder "$*" is allowed to specify where the arguments
  2635. --- will be included. Environment variables are expanded `:set_env`. See
  2636. --- `option-backslash` about including spaces and backslashes.
  2637. --- Special value: When 'grepprg' is set to "internal" the `:grep` command
  2638. --- works like `:vimgrep`, `:lgrep` like `:lvimgrep`, `:grepadd` like
  2639. --- `:vimgrepadd` and `:lgrepadd` like `:lvimgrepadd`.
  2640. --- See also the section `:make_makeprg`, since most of the comments there
  2641. --- apply equally to 'grepprg'.
  2642. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2643. --- security reasons.
  2644. --- This option defaults to:
  2645. --- - `rg --vimgrep -uu ` if ripgrep is available (`:checkhealth`),
  2646. --- - `grep -HIn $* /dev/null` on Unix,
  2647. --- - `findstr /n $* nul` on Windows.
  2648. --- Ripgrep can perform additional filtering such as using .gitignore rules
  2649. --- and skipping hidden files. This is disabled by default (see the -u option)
  2650. --- to more closely match the behaviour of standard grep.
  2651. --- You can make ripgrep match Vim's case handling using the
  2652. --- -i/--ignore-case and -S/--smart-case options.
  2653. --- An `OptionSet` autocmd can be used to set it up to match automatically.
  2654. ---
  2655. --- @type string
  2656. vim.o.grepprg = "grep -HIn $* /dev/null"
  2657. vim.o.gp = vim.o.grepprg
  2658. vim.bo.grepprg = vim.o.grepprg
  2659. vim.bo.gp = vim.bo.grepprg
  2660. vim.go.grepprg = vim.o.grepprg
  2661. vim.go.gp = vim.go.grepprg
  2662. --- Configures the cursor style for each mode. Works in the GUI and many
  2663. --- terminals. See `tui-cursor-shape`.
  2664. ---
  2665. --- To disable cursor-styling, reset the option:
  2666. ---
  2667. --- ```vim
  2668. --- set guicursor=
  2669. --- ```
  2670. --- To enable mode shapes, "Cursor" highlight, and blinking:
  2671. ---
  2672. --- ```vim
  2673. --- set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50
  2674. --- \,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor
  2675. --- \,sm:block-blinkwait175-blinkoff150-blinkon175
  2676. --- ```
  2677. --- The option is a comma-separated list of parts. Each part consists of a
  2678. --- mode-list and an argument-list:
  2679. --- mode-list:argument-list,mode-list:argument-list,..
  2680. --- The mode-list is a dash separated list of these modes:
  2681. --- n Normal mode
  2682. --- v Visual mode
  2683. --- ve Visual mode with 'selection' "exclusive" (same as 'v',
  2684. --- if not specified)
  2685. --- o Operator-pending mode
  2686. --- i Insert mode
  2687. --- r Replace mode
  2688. --- c Command-line Normal (append) mode
  2689. --- ci Command-line Insert mode
  2690. --- cr Command-line Replace mode
  2691. --- sm showmatch in Insert mode
  2692. --- t Terminal mode
  2693. --- a all modes
  2694. --- The argument-list is a dash separated list of these arguments:
  2695. --- hor{N} horizontal bar, {N} percent of the character height
  2696. --- ver{N} vertical bar, {N} percent of the character width
  2697. --- block block cursor, fills the whole character
  2698. --- - Only one of the above three should be present.
  2699. --- - Default is "block" for each mode.
  2700. --- blinkwait{N} *cursor-blinking*
  2701. --- blinkon{N}
  2702. --- blinkoff{N}
  2703. --- blink times for cursor: blinkwait is the delay before
  2704. --- the cursor starts blinking, blinkon is the time that
  2705. --- the cursor is shown and blinkoff is the time that the
  2706. --- cursor is not shown. Times are in msec. When one of
  2707. --- the numbers is zero, there is no blinking. E.g.:
  2708. ---
  2709. --- ```vim
  2710. --- set guicursor=n:blinkon0
  2711. --- ```
  2712. ---
  2713. --- Default is "blinkon0" for each mode.
  2714. --- {group-name}
  2715. --- Highlight group that decides the color and font of the
  2716. --- cursor.
  2717. --- In the `TUI`:
  2718. --- - `inverse`/reverse and no group-name are interpreted
  2719. --- as "host-terminal default cursor colors" which
  2720. --- typically means "inverted bg and fg colors".
  2721. --- - `ctermfg` and `guifg` are ignored.
  2722. --- {group-name}/{group-name}
  2723. --- Two highlight group names, the first is used when
  2724. --- no language mappings are used, the other when they
  2725. --- are. `language-mapping`
  2726. ---
  2727. --- Examples of parts:
  2728. --- n-c-v:block-nCursor In Normal, Command-line and Visual mode, use a
  2729. --- block cursor with colors from the "nCursor"
  2730. --- highlight group
  2731. --- n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20
  2732. --- In Normal et al. modes, use a block cursor
  2733. --- with the default colors defined by the host
  2734. --- terminal. In Insert-like modes, use
  2735. --- a vertical bar cursor with colors from
  2736. --- "Cursor" highlight group. In Replace-like
  2737. --- modes, use an underline cursor with
  2738. --- default colors.
  2739. --- i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
  2740. --- In Insert and Command-line Insert mode, use a
  2741. --- 30% vertical bar cursor with colors from the
  2742. --- "iCursor" highlight group. Blink a bit
  2743. --- faster.
  2744. ---
  2745. --- The 'a' mode is different. It will set the given argument-list for
  2746. --- all modes. It does not reset anything to defaults. This can be used
  2747. --- to do a common setting for all modes. For example, to switch off
  2748. --- blinking: "a:blinkon0"
  2749. ---
  2750. --- Examples of cursor highlighting:
  2751. ---
  2752. --- ```vim
  2753. --- highlight Cursor gui=reverse guifg=NONE guibg=NONE
  2754. --- highlight Cursor gui=NONE guifg=bg guibg=fg
  2755. --- ```
  2756. ---
  2757. ---
  2758. --- @type string
  2759. vim.o.guicursor = "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20,t:block-blinkon500-blinkoff500-TermCursor"
  2760. vim.o.gcr = vim.o.guicursor
  2761. vim.go.guicursor = vim.o.guicursor
  2762. vim.go.gcr = vim.go.guicursor
  2763. --- This is a list of fonts which will be used for the GUI version of Vim.
  2764. --- In its simplest form the value is just one font name. When
  2765. --- the font cannot be found you will get an error message. To try other
  2766. --- font names a list can be specified, font names separated with commas.
  2767. --- The first valid font is used.
  2768. ---
  2769. --- Spaces after a comma are ignored. To include a comma in a font name
  2770. --- precede it with a backslash. Setting an option requires an extra
  2771. --- backslash before a space and a backslash. See also
  2772. --- `option-backslash`. For example:
  2773. ---
  2774. --- ```vim
  2775. --- set guifont=Screen15,\ 7x13,font\\,with\\,commas
  2776. --- ```
  2777. --- will make Vim try to use the font "Screen15" first, and if it fails it
  2778. --- will try to use "7x13" and then "font,with,commas" instead.
  2779. ---
  2780. --- If none of the fonts can be loaded, Vim will keep the current setting.
  2781. --- If an empty font list is given, Vim will try using other resource
  2782. --- settings (for X, it will use the Vim.font resource), and finally it
  2783. --- will try some builtin default which should always be there ("7x13" in
  2784. --- the case of X). The font names given should be "normal" fonts. Vim
  2785. --- will try to find the related bold and italic fonts.
  2786. ---
  2787. --- For Win32 and Mac OS:
  2788. ---
  2789. --- ```vim
  2790. --- set guifont=*
  2791. --- ```
  2792. --- will bring up a font requester, where you can pick the font you want.
  2793. ---
  2794. --- The font name depends on the GUI used.
  2795. ---
  2796. --- For Mac OSX you can use something like this:
  2797. ---
  2798. --- ```vim
  2799. --- set guifont=Monaco:h10
  2800. --- ```
  2801. --- *E236*
  2802. --- Note that the fonts must be mono-spaced (all characters have the same
  2803. --- width).
  2804. ---
  2805. --- To preview a font on X11, you might be able to use the "xfontsel"
  2806. --- program. The "xlsfonts" program gives a list of all available fonts.
  2807. ---
  2808. --- For the Win32 GUI *E244* *E245*
  2809. --- - takes these options in the font name:
  2810. --- hXX - height is XX (points, can be floating-point)
  2811. --- wXX - width is XX (points, can be floating-point)
  2812. --- b - bold
  2813. --- i - italic
  2814. --- u - underline
  2815. --- s - strikeout
  2816. --- cXX - character set XX. Valid charsets are: ANSI, ARABIC,
  2817. --- BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
  2818. --- HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
  2819. --- SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
  2820. --- Normally you would use "cDEFAULT".
  2821. ---
  2822. --- Use a ':' to separate the options.
  2823. --- - A '_' can be used in the place of a space, so you don't need to use
  2824. --- backslashes to escape the spaces.
  2825. --- - Examples:
  2826. ---
  2827. --- ```vim
  2828. --- set guifont=courier_new:h12:w5:b:cRUSSIAN
  2829. --- set guifont=Andale_Mono:h7.5:w4.5
  2830. --- ```
  2831. ---
  2832. ---
  2833. --- @type string
  2834. vim.o.guifont = ""
  2835. vim.o.gfn = vim.o.guifont
  2836. vim.go.guifont = vim.o.guifont
  2837. vim.go.gfn = vim.go.guifont
  2838. --- Comma-separated list of fonts to be used for double-width characters.
  2839. --- The first font that can be loaded is used.
  2840. --- Note: The size of these fonts must be exactly twice as wide as the one
  2841. --- specified with 'guifont' and the same height.
  2842. ---
  2843. --- When 'guifont' has a valid font and 'guifontwide' is empty Vim will
  2844. --- attempt to set 'guifontwide' to a matching double-width font.
  2845. ---
  2846. --- @type string
  2847. vim.o.guifontwide = ""
  2848. vim.o.gfw = vim.o.guifontwide
  2849. vim.go.guifontwide = vim.o.guifontwide
  2850. vim.go.gfw = vim.go.guifontwide
  2851. --- Name of the main help file. All distributed help files should be
  2852. --- placed together in one directory. Additionally, all "doc" directories
  2853. --- in 'runtimepath' will be used.
  2854. --- Environment variables are expanded `:set_env`. For example:
  2855. --- "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
  2856. --- tried. Also see `$VIMRUNTIME` and `option-backslash` about including
  2857. --- spaces and backslashes.
  2858. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2859. --- security reasons.
  2860. ---
  2861. --- @type string
  2862. vim.o.helpfile = "$VIMRUNTIME/doc/help.txt"
  2863. vim.o.hf = vim.o.helpfile
  2864. vim.go.helpfile = vim.o.helpfile
  2865. vim.go.hf = vim.go.helpfile
  2866. --- Minimal initial height of the help window when it is opened with the
  2867. --- ":help" command. The initial height of the help window is half of the
  2868. --- current window, or (when the 'ea' option is on) the same as other
  2869. --- windows. When the height is less than 'helpheight', the height is
  2870. --- set to 'helpheight'. Set to zero to disable.
  2871. ---
  2872. --- @type integer
  2873. vim.o.helpheight = 20
  2874. vim.o.hh = vim.o.helpheight
  2875. vim.go.helpheight = vim.o.helpheight
  2876. vim.go.hh = vim.go.helpheight
  2877. --- Comma-separated list of languages. Vim will use the first language
  2878. --- for which the desired help can be found. The English help will always
  2879. --- be used as a last resort. You can add "en" to prefer English over
  2880. --- another language, but that will only find tags that exist in that
  2881. --- language and not in the English help.
  2882. --- Example:
  2883. ---
  2884. --- ```vim
  2885. --- set helplang=de,it
  2886. --- ```
  2887. --- This will first search German, then Italian and finally English help
  2888. --- files.
  2889. --- When using `CTRL-]` and ":help!" in a non-English help file Vim will
  2890. --- try to find the tag in the current language before using this option.
  2891. --- See `help-translated`.
  2892. ---
  2893. --- @type string
  2894. vim.o.helplang = ""
  2895. vim.o.hlg = vim.o.helplang
  2896. vim.go.helplang = vim.o.helplang
  2897. vim.go.hlg = vim.go.helplang
  2898. --- When off a buffer is unloaded (including loss of undo information)
  2899. --- when it is `abandon`ed. When on a buffer becomes hidden when it is
  2900. --- `abandon`ed. A buffer displayed in another window does not become
  2901. --- hidden, of course.
  2902. ---
  2903. --- Commands that move through the buffer list sometimes hide a buffer
  2904. --- although the 'hidden' option is off when these three are true:
  2905. --- - the buffer is modified
  2906. --- - 'autowrite' is off or writing is not possible
  2907. --- - the '!' flag was used
  2908. --- Also see `windows`.
  2909. ---
  2910. --- To hide a specific buffer use the 'bufhidden' option.
  2911. --- 'hidden' is set for one command with ":hide {command}" `:hide`.
  2912. ---
  2913. --- @type boolean
  2914. vim.o.hidden = true
  2915. vim.o.hid = vim.o.hidden
  2916. vim.go.hidden = vim.o.hidden
  2917. vim.go.hid = vim.go.hidden
  2918. --- A history of ":" commands, and a history of previous search patterns
  2919. --- is remembered. This option decides how many entries may be stored in
  2920. --- each of these histories (see `cmdline-editing` and 'messagesopt' for
  2921. --- the number of messages to remember).
  2922. --- The maximum value is 10000.
  2923. ---
  2924. --- @type integer
  2925. vim.o.history = 10000
  2926. vim.o.hi = vim.o.history
  2927. vim.go.history = vim.o.history
  2928. vim.go.hi = vim.go.history
  2929. --- When there is a previous search pattern, highlight all its matches.
  2930. --- The `hl-Search` highlight group determines the highlighting for all
  2931. --- matches not under the cursor while the `hl-CurSearch` highlight group
  2932. --- (if defined) determines the highlighting for the match under the
  2933. --- cursor. If `hl-CurSearch` is not defined, then `hl-Search` is used for
  2934. --- both. Note that only the matching text is highlighted, any offsets
  2935. --- are not applied.
  2936. --- See also: 'incsearch' and `:match`.
  2937. --- When you get bored looking at the highlighted matches, you can turn it
  2938. --- off with `:nohlsearch`. This does not change the option value, as
  2939. --- soon as you use a search command, the highlighting comes back.
  2940. --- 'redrawtime' specifies the maximum time spent on finding matches.
  2941. --- When the search pattern can match an end-of-line, Vim will try to
  2942. --- highlight all of the matched text. However, this depends on where the
  2943. --- search starts. This will be the first line in the window or the first
  2944. --- line below a closed fold. A match in a previous line which is not
  2945. --- drawn may not continue in a newly drawn line.
  2946. --- You can specify whether the highlight status is restored on startup
  2947. --- with the 'h' flag in 'shada' `shada-h`.
  2948. ---
  2949. --- @type boolean
  2950. vim.o.hlsearch = true
  2951. vim.o.hls = vim.o.hlsearch
  2952. vim.go.hlsearch = vim.o.hlsearch
  2953. vim.go.hls = vim.go.hlsearch
  2954. --- When on, the icon text of the window will be set to the value of
  2955. --- 'iconstring' (if it is not empty), or to the name of the file
  2956. --- currently being edited. Only the last part of the name is used.
  2957. --- Overridden by the 'iconstring' option.
  2958. --- Only works if the terminal supports setting window icons.
  2959. ---
  2960. --- @type boolean
  2961. vim.o.icon = false
  2962. vim.go.icon = vim.o.icon
  2963. --- When this option is not empty, it will be used for the icon text of
  2964. --- the window. This happens only when the 'icon' option is on.
  2965. --- Only works if the terminal supports setting window icon text
  2966. --- When this option contains printf-style '%' items, they will be
  2967. --- expanded according to the rules used for 'statusline'. See
  2968. --- 'titlestring' for example settings.
  2969. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  2970. ---
  2971. --- @type string
  2972. vim.o.iconstring = ""
  2973. vim.go.iconstring = vim.o.iconstring
  2974. --- Ignore case in search patterns, `cmdline-completion`, when
  2975. --- searching in the tags file, and `expr-==`.
  2976. --- Also see 'smartcase' and 'tagcase'.
  2977. --- Can be overruled by using "\c" or "\C" in the pattern, see
  2978. --- `/ignorecase`.
  2979. ---
  2980. --- @type boolean
  2981. vim.o.ignorecase = false
  2982. vim.o.ic = vim.o.ignorecase
  2983. vim.go.ignorecase = vim.o.ignorecase
  2984. vim.go.ic = vim.go.ignorecase
  2985. --- Specifies whether :lmap or an Input Method (IM) is to be used in
  2986. --- Insert mode. Valid values:
  2987. --- 0 :lmap is off and IM is off
  2988. --- 1 :lmap is ON and IM is off
  2989. --- 2 :lmap is off and IM is ON
  2990. --- To always reset the option to zero when leaving Insert mode with <Esc>
  2991. --- this can be used:
  2992. ---
  2993. --- ```vim
  2994. --- inoremap <ESC> <ESC>:set iminsert=0<CR>
  2995. --- ```
  2996. --- This makes :lmap and IM turn off automatically when leaving Insert
  2997. --- mode.
  2998. --- Note that this option changes when using CTRL-^ in Insert mode
  2999. --- `i_CTRL-^`.
  3000. --- The value is set to 1 when setting 'keymap' to a valid keymap name.
  3001. --- It is also used for the argument of commands like "r" and "f".
  3002. ---
  3003. --- @type integer
  3004. vim.o.iminsert = 0
  3005. vim.o.imi = vim.o.iminsert
  3006. vim.bo.iminsert = vim.o.iminsert
  3007. vim.bo.imi = vim.bo.iminsert
  3008. --- Specifies whether :lmap or an Input Method (IM) is to be used when
  3009. --- entering a search pattern. Valid values:
  3010. --- -1 the value of 'iminsert' is used, makes it look like
  3011. --- 'iminsert' is also used when typing a search pattern
  3012. --- 0 :lmap is off and IM is off
  3013. --- 1 :lmap is ON and IM is off
  3014. --- 2 :lmap is off and IM is ON
  3015. --- Note that this option changes when using CTRL-^ in Command-line mode
  3016. --- `c_CTRL-^`.
  3017. --- The value is set to 1 when it is not -1 and setting the 'keymap'
  3018. --- option to a valid keymap name.
  3019. ---
  3020. --- @type integer
  3021. vim.o.imsearch = -1
  3022. vim.o.ims = vim.o.imsearch
  3023. vim.bo.imsearch = vim.o.imsearch
  3024. vim.bo.ims = vim.bo.imsearch
  3025. --- When nonempty, shows the effects of `:substitute`, `:smagic|,
  3026. --- |:snomagic` and user commands with the `:command-preview` flag as you
  3027. --- type.
  3028. ---
  3029. --- Possible values:
  3030. --- nosplit Shows the effects of a command incrementally in the
  3031. --- buffer.
  3032. --- split Like "nosplit", but also shows partial off-screen
  3033. --- results in a preview window.
  3034. ---
  3035. --- If the preview for built-in commands is too slow (exceeds
  3036. --- 'redrawtime') then 'inccommand' is automatically disabled until
  3037. --- `Command-line-mode` is done.
  3038. ---
  3039. --- @type 'nosplit'|'split'|''
  3040. vim.o.inccommand = "nosplit"
  3041. vim.o.icm = vim.o.inccommand
  3042. vim.go.inccommand = vim.o.inccommand
  3043. vim.go.icm = vim.go.inccommand
  3044. --- Pattern to be used to find an include command. It is a search
  3045. --- pattern, just like for the "/" command (See `pattern`). This option
  3046. --- is used for the commands "[i", "]I", "[d", etc.
  3047. --- Normally the 'isfname' option is used to recognize the file name that
  3048. --- comes after the matched pattern. But if "\zs" appears in the pattern
  3049. --- then the text matched from "\zs" to the end, or until "\ze" if it
  3050. --- appears, is used as the file name. Use this to include characters
  3051. --- that are not in 'isfname', such as a space. You can then use
  3052. --- 'includeexpr' to process the matched text.
  3053. --- See `option-backslash` about including spaces and backslashes.
  3054. ---
  3055. --- @type string
  3056. vim.o.include = ""
  3057. vim.o.inc = vim.o.include
  3058. vim.bo.include = vim.o.include
  3059. vim.bo.inc = vim.bo.include
  3060. vim.go.include = vim.o.include
  3061. vim.go.inc = vim.go.include
  3062. --- Expression to be used to transform the string found with the 'include'
  3063. --- option to a file name. Mostly useful to change "." to "/" for Java:
  3064. ---
  3065. --- ```vim
  3066. --- setlocal includeexpr=substitute(v:fname,'\\.','/','g')
  3067. --- ```
  3068. --- The "v:fname" variable will be set to the file name that was detected.
  3069. --- Note the double backslash: the `:set` command first halves them, then
  3070. --- one remains in the value, where "\." matches a dot literally. For
  3071. --- simple character replacements `tr()` avoids the need for escaping:
  3072. ---
  3073. --- ```vim
  3074. --- setlocal includeexpr=tr(v:fname,'.','/')
  3075. --- ```
  3076. ---
  3077. --- Also used for the `gf` command if an unmodified file name can't be
  3078. --- found. Allows doing "gf" on the name after an 'include' statement.
  3079. --- Also used for `<cfile>`.
  3080. ---
  3081. --- If the expression starts with s: or `<SID>`, then it is replaced with
  3082. --- the script ID (`local-function`). Example:
  3083. ---
  3084. --- ```vim
  3085. --- setlocal includeexpr=s:MyIncludeExpr()
  3086. --- setlocal includeexpr=<SID>SomeIncludeExpr()
  3087. --- ```
  3088. --- Otherwise, the expression is evaluated in the context of the script
  3089. --- where the option was set, thus script-local items are available.
  3090. ---
  3091. --- It is more efficient if the value is just a function call without
  3092. --- arguments, see `expr-option-function`.
  3093. ---
  3094. --- The expression will be evaluated in the `sandbox` when set from a
  3095. --- modeline, see `sandbox-option`.
  3096. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  3097. ---
  3098. --- It is not allowed to change text or jump to another window while
  3099. --- evaluating 'includeexpr' `textlock`.
  3100. ---
  3101. --- @type string
  3102. vim.o.includeexpr = ""
  3103. vim.o.inex = vim.o.includeexpr
  3104. vim.bo.includeexpr = vim.o.includeexpr
  3105. vim.bo.inex = vim.bo.includeexpr
  3106. --- While typing a search command, show where the pattern, as it was typed
  3107. --- so far, matches. The matched string is highlighted. If the pattern
  3108. --- is invalid or not found, nothing is shown. The screen will be updated
  3109. --- often, this is only useful on fast terminals.
  3110. --- Note that the match will be shown, but the cursor will return to its
  3111. --- original position when no match is found and when pressing <Esc>. You
  3112. --- still need to finish the search command with <Enter> to move the
  3113. --- cursor to the match.
  3114. --- You can use the CTRL-G and CTRL-T keys to move to the next and
  3115. --- previous match. `c_CTRL-G` `c_CTRL-T`
  3116. --- Vim only searches for about half a second. With a complicated
  3117. --- pattern and/or a lot of text the match may not be found. This is to
  3118. --- avoid that Vim hangs while you are typing the pattern.
  3119. --- The `hl-IncSearch` highlight group determines the highlighting.
  3120. --- When 'hlsearch' is on, all matched strings are highlighted too while
  3121. --- typing a search command. See also: 'hlsearch'.
  3122. --- If you don't want to turn 'hlsearch' on, but want to highlight all
  3123. --- matches while searching, you can turn on and off 'hlsearch' with
  3124. --- autocmd. Example:
  3125. ---
  3126. --- ```vim
  3127. --- augroup vimrc-incsearch-highlight
  3128. --- autocmd!
  3129. --- autocmd CmdlineEnter /,\? :set hlsearch
  3130. --- autocmd CmdlineLeave /,\? :set nohlsearch
  3131. --- augroup END
  3132. --- ```
  3133. ---
  3134. --- CTRL-L can be used to add one character from after the current match
  3135. --- to the command line. If 'ignorecase' and 'smartcase' are set and the
  3136. --- command line has no uppercase characters, the added character is
  3137. --- converted to lowercase.
  3138. --- CTRL-R CTRL-W can be used to add the word at the end of the current
  3139. --- match, excluding the characters that were already typed.
  3140. ---
  3141. --- @type boolean
  3142. vim.o.incsearch = true
  3143. vim.o.is = vim.o.incsearch
  3144. vim.go.incsearch = vim.o.incsearch
  3145. vim.go.is = vim.go.incsearch
  3146. --- Expression which is evaluated to obtain the proper indent for a line.
  3147. --- It is used when a new line is created, for the `=` operator and
  3148. --- in Insert mode as specified with the 'indentkeys' option.
  3149. --- When this option is not empty, it overrules the 'cindent' and
  3150. --- 'smartindent' indenting. When 'lisp' is set, this option is
  3151. --- only used when 'lispoptions' contains "expr:1".
  3152. --- The expression is evaluated with `v:lnum` set to the line number for
  3153. --- which the indent is to be computed. The cursor is also in this line
  3154. --- when the expression is evaluated (but it may be moved around).
  3155. ---
  3156. --- If the expression starts with s: or `<SID>`, then it is replaced with
  3157. --- the script ID (`local-function`). Example:
  3158. ---
  3159. --- ```vim
  3160. --- set indentexpr=s:MyIndentExpr()
  3161. --- set indentexpr=<SID>SomeIndentExpr()
  3162. --- ```
  3163. --- Otherwise, the expression is evaluated in the context of the script
  3164. --- where the option was set, thus script-local items are available.
  3165. ---
  3166. --- The advantage of using a function call without arguments is that it is
  3167. --- faster, see `expr-option-function`.
  3168. ---
  3169. --- The expression must return the number of spaces worth of indent. It
  3170. --- can return "-1" to keep the current indent (this means 'autoindent' is
  3171. --- used for the indent).
  3172. --- Functions useful for computing the indent are `indent()`, `cindent()`
  3173. --- and `lispindent()`.
  3174. --- The evaluation of the expression must not have side effects! It must
  3175. --- not change the text, jump to another window, etc. Afterwards the
  3176. --- cursor position is always restored, thus the cursor may be moved.
  3177. --- Normally this option would be set to call a function:
  3178. ---
  3179. --- ```vim
  3180. --- set indentexpr=GetMyIndent()
  3181. --- ```
  3182. --- Error messages will be suppressed, unless the 'debug' option contains
  3183. --- "msg".
  3184. --- See `indent-expression`.
  3185. ---
  3186. --- The expression will be evaluated in the `sandbox` when set from a
  3187. --- modeline, see `sandbox-option`.
  3188. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  3189. ---
  3190. --- It is not allowed to change text or jump to another window while
  3191. --- evaluating 'indentexpr' `textlock`.
  3192. ---
  3193. --- @type string
  3194. vim.o.indentexpr = ""
  3195. vim.o.inde = vim.o.indentexpr
  3196. vim.bo.indentexpr = vim.o.indentexpr
  3197. vim.bo.inde = vim.bo.indentexpr
  3198. --- A list of keys that, when typed in Insert mode, cause reindenting of
  3199. --- the current line. Only happens if 'indentexpr' isn't empty.
  3200. --- The format is identical to 'cinkeys', see `indentkeys-format`.
  3201. --- See `C-indenting` and `indent-expression`.
  3202. ---
  3203. --- @type string
  3204. vim.o.indentkeys = "0{,0},0),0],:,0#,!^F,o,O,e"
  3205. vim.o.indk = vim.o.indentkeys
  3206. vim.bo.indentkeys = vim.o.indentkeys
  3207. vim.bo.indk = vim.bo.indentkeys
  3208. --- When doing keyword completion in insert mode `ins-completion`, and
  3209. --- 'ignorecase' is also on, the case of the match is adjusted depending
  3210. --- on the typed text. If the typed text contains a lowercase letter
  3211. --- where the match has an upper case letter, the completed part is made
  3212. --- lowercase. If the typed text has no lowercase letters and the match
  3213. --- has a lowercase letter where the typed text has an uppercase letter,
  3214. --- and there is a letter before it, the completed part is made uppercase.
  3215. --- With 'noinfercase' the match is used as-is.
  3216. ---
  3217. --- @type boolean
  3218. vim.o.infercase = false
  3219. vim.o.inf = vim.o.infercase
  3220. vim.bo.infercase = vim.o.infercase
  3221. vim.bo.inf = vim.bo.infercase
  3222. --- The characters specified by this option are included in file names and
  3223. --- path names. Filenames are used for commands like "gf", "[i" and in
  3224. --- the tags file. It is also used for "\f" in a `pattern`.
  3225. --- Multi-byte characters 256 and above are always included, only the
  3226. --- characters up to 255 are specified with this option.
  3227. --- For UTF-8 the characters 0xa0 to 0xff are included as well.
  3228. --- Think twice before adding white space to this option. Although a
  3229. --- space may appear inside a file name, the effect will be that Vim
  3230. --- doesn't know where a file name starts or ends when doing completion.
  3231. --- It most likely works better without a space in 'isfname'.
  3232. ---
  3233. --- Note that on systems using a backslash as path separator, Vim tries to
  3234. --- do its best to make it work as you would expect. That is a bit
  3235. --- tricky, since Vi originally used the backslash to escape special
  3236. --- characters. Vim will not remove a backslash in front of a normal file
  3237. --- name character on these systems, but it will on Unix and alikes. The
  3238. --- '&' and '^' are not included by default, because these are special for
  3239. --- cmd.exe.
  3240. ---
  3241. --- The format of this option is a list of parts, separated with commas.
  3242. --- Each part can be a single character number or a range. A range is two
  3243. --- character numbers with '-' in between. A character number can be a
  3244. --- decimal number between 0 and 255 or the ASCII character itself (does
  3245. --- not work for digits). Example:
  3246. --- "_,-,128-140,#-43" (include '_' and '-' and the range
  3247. --- 128 to 140 and '#' to 43)
  3248. --- If a part starts with '^', the following character number or range
  3249. --- will be excluded from the option. The option is interpreted from left
  3250. --- to right. Put the excluded character after the range where it is
  3251. --- included. To include '^' itself use it as the last character of the
  3252. --- option or the end of a range. Example:
  3253. --- "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
  3254. --- If the character is '@', all characters where isalpha() returns TRUE
  3255. --- are included. Normally these are the characters a to z and A to Z,
  3256. --- plus accented characters. To include '@' itself use "@-@". Examples:
  3257. --- "@,^a-z" All alphabetic characters, excluding lower
  3258. --- case ASCII letters.
  3259. --- "a-z,A-Z,@-@" All letters plus the '@' character.
  3260. --- A comma can be included by using it where a character number is
  3261. --- expected. Example:
  3262. --- "48-57,,,_" Digits, comma and underscore.
  3263. --- A comma can be excluded by prepending a '^'. Example:
  3264. --- " -~,^,,9" All characters from space to '~', excluding
  3265. --- comma, plus <Tab>.
  3266. --- See `option-backslash` about including spaces and backslashes.
  3267. ---
  3268. --- @type string
  3269. vim.o.isfname = "@,48-57,/,.,-,_,+,,,#,$,%,~,="
  3270. vim.o.isf = vim.o.isfname
  3271. vim.go.isfname = vim.o.isfname
  3272. vim.go.isf = vim.go.isfname
  3273. --- The characters given by this option are included in identifiers.
  3274. --- Identifiers are used in recognizing environment variables and after a
  3275. --- match of the 'define' option. It is also used for "\i" in a
  3276. --- `pattern`. See 'isfname' for a description of the format of this
  3277. --- option. For '@' only characters up to 255 are used.
  3278. --- Careful: If you change this option, it might break expanding
  3279. --- environment variables. E.g., when '/' is included and Vim tries to
  3280. --- expand "$HOME/.local/state/nvim/shada/main.shada". Maybe you should
  3281. --- change 'iskeyword' instead.
  3282. ---
  3283. --- @type string
  3284. vim.o.isident = "@,48-57,_,192-255"
  3285. vim.o.isi = vim.o.isident
  3286. vim.go.isident = vim.o.isident
  3287. vim.go.isi = vim.go.isident
  3288. --- Keywords are used in searching and recognizing with many commands:
  3289. --- "w", "*", "[i", etc. It is also used for "\k" in a `pattern`. See
  3290. --- 'isfname' for a description of the format of this option. For '@'
  3291. --- characters above 255 check the "word" character class (any character
  3292. --- that is not white space or punctuation).
  3293. --- For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
  3294. --- For a help file it is set to all non-blank printable characters except
  3295. --- "*", '"' and '|' (so that CTRL-] on a command finds the help for that
  3296. --- command).
  3297. --- When the 'lisp' option is on the '-' character is always included.
  3298. --- This option also influences syntax highlighting, unless the syntax
  3299. --- uses `:syn-iskeyword`.
  3300. ---
  3301. --- @type string
  3302. vim.o.iskeyword = "@,48-57,_,192-255"
  3303. vim.o.isk = vim.o.iskeyword
  3304. vim.bo.iskeyword = vim.o.iskeyword
  3305. vim.bo.isk = vim.bo.iskeyword
  3306. --- The characters given by this option are displayed directly on the
  3307. --- screen. It is also used for "\p" in a `pattern`. The characters from
  3308. --- space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
  3309. --- even when they are not included in 'isprint' or excluded. See
  3310. --- 'isfname' for a description of the format of this option.
  3311. ---
  3312. --- Non-printable characters are displayed with two characters:
  3313. --- 0 - 31 "^@" - "^_"
  3314. --- 32 - 126 always single characters
  3315. --- 127 "^?"
  3316. --- 128 - 159 "~@" - "~_"
  3317. --- 160 - 254 "| " - "|~"
  3318. --- 255 "~?"
  3319. --- Illegal bytes from 128 to 255 (invalid UTF-8) are
  3320. --- displayed as <xx>, with the hexadecimal value of the byte.
  3321. --- When 'display' contains "uhex" all unprintable characters are
  3322. --- displayed as <xx>.
  3323. --- The SpecialKey highlighting will be used for unprintable characters.
  3324. --- `hl-SpecialKey`
  3325. ---
  3326. --- Multi-byte characters 256 and above are always included, only the
  3327. --- characters up to 255 are specified with this option. When a character
  3328. --- is printable but it is not available in the current font, a
  3329. --- replacement character will be shown.
  3330. --- Unprintable and zero-width Unicode characters are displayed as <xxxx>.
  3331. --- There is no option to specify these characters.
  3332. ---
  3333. --- @type string
  3334. vim.o.isprint = "@,161-255"
  3335. vim.o.isp = vim.o.isprint
  3336. vim.go.isprint = vim.o.isprint
  3337. vim.go.isp = vim.go.isprint
  3338. --- Insert two spaces after a '.', '?' and '!' with a join command.
  3339. --- Otherwise only one space is inserted.
  3340. ---
  3341. --- @type boolean
  3342. vim.o.joinspaces = false
  3343. vim.o.js = vim.o.joinspaces
  3344. vim.go.joinspaces = vim.o.joinspaces
  3345. vim.go.js = vim.go.joinspaces
  3346. --- List of words that change the behavior of the `jumplist`.
  3347. --- stack Make the jumplist behave like the tagstack.
  3348. --- Relative location of entries in the jumplist is
  3349. --- preserved at the cost of discarding subsequent entries
  3350. --- when navigating backwards in the jumplist and then
  3351. --- jumping to a location. `jumplist-stack`
  3352. ---
  3353. --- view When moving through the jumplist, `changelist|,
  3354. --- |alternate-file` or using `mark-motions` try to
  3355. --- restore the `mark-view` in which the action occurred.
  3356. ---
  3357. --- clean Remove unloaded buffers from the jumplist.
  3358. --- EXPERIMENTAL: this flag may change in the future.
  3359. ---
  3360. --- @type string
  3361. vim.o.jumpoptions = "clean"
  3362. vim.o.jop = vim.o.jumpoptions
  3363. vim.go.jumpoptions = vim.o.jumpoptions
  3364. vim.go.jop = vim.go.jumpoptions
  3365. --- Name of a keyboard mapping. See `mbyte-keymap`.
  3366. --- Setting this option to a valid keymap name has the side effect of
  3367. --- setting 'iminsert' to one, so that the keymap becomes effective.
  3368. --- 'imsearch' is also set to one, unless it was -1
  3369. --- Only alphanumeric characters, '.', '-' and '_' can be used.
  3370. ---
  3371. --- @type string
  3372. vim.o.keymap = ""
  3373. vim.o.kmp = vim.o.keymap
  3374. vim.bo.keymap = vim.o.keymap
  3375. vim.bo.kmp = vim.bo.keymap
  3376. --- List of comma-separated words, which enable special things that keys
  3377. --- can do. These values can be used:
  3378. --- startsel Using a shifted special key starts selection (either
  3379. --- Select mode or Visual mode, depending on "key" being
  3380. --- present in 'selectmode').
  3381. --- stopsel Using a not-shifted special key stops selection.
  3382. --- Special keys in this context are the cursor keys, <End>, <Home>,
  3383. --- <PageUp> and <PageDown>.
  3384. ---
  3385. --- @type string
  3386. vim.o.keymodel = ""
  3387. vim.o.km = vim.o.keymodel
  3388. vim.go.keymodel = vim.o.keymodel
  3389. vim.go.km = vim.go.keymodel
  3390. --- Program to use for the `K` command. Environment variables are
  3391. --- expanded `:set_env`. ":help" may be used to access the Vim internal
  3392. --- help. (Note that previously setting the global option to the empty
  3393. --- value did this, which is now deprecated.)
  3394. --- When the first character is ":", the command is invoked as a Vim
  3395. --- Ex command prefixed with [count].
  3396. --- When "man" or "man -s" is used, Vim will automatically translate
  3397. --- a [count] for the "K" command to a section number.
  3398. --- See `option-backslash` about including spaces and backslashes.
  3399. --- Example:
  3400. ---
  3401. --- ```vim
  3402. --- set keywordprg=man\ -s
  3403. --- set keywordprg=:Man
  3404. --- ```
  3405. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3406. --- security reasons.
  3407. ---
  3408. --- @type string
  3409. vim.o.keywordprg = ":Man"
  3410. vim.o.kp = vim.o.keywordprg
  3411. vim.bo.keywordprg = vim.o.keywordprg
  3412. vim.bo.kp = vim.bo.keywordprg
  3413. vim.go.keywordprg = vim.o.keywordprg
  3414. vim.go.kp = vim.go.keywordprg
  3415. --- This option allows switching your keyboard into a special language
  3416. --- mode. When you are typing text in Insert mode the characters are
  3417. --- inserted directly. When in Normal mode the 'langmap' option takes
  3418. --- care of translating these special characters to the original meaning
  3419. --- of the key. This means you don't have to change the keyboard mode to
  3420. --- be able to execute Normal mode commands.
  3421. --- This is the opposite of the 'keymap' option, where characters are
  3422. --- mapped in Insert mode.
  3423. --- Also consider setting 'langremap' to off, to prevent 'langmap' from
  3424. --- applying to characters resulting from a mapping.
  3425. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3426. --- security reasons.
  3427. ---
  3428. --- Example (for Greek, in UTF-8): *greek*
  3429. ---
  3430. --- ```vim
  3431. --- set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz
  3432. --- ```
  3433. --- Example (exchanges meaning of z and y for commands):
  3434. ---
  3435. --- ```vim
  3436. --- set langmap=zy,yz,ZY,YZ
  3437. --- ```
  3438. ---
  3439. --- The 'langmap' option is a list of parts, separated with commas. Each
  3440. --- part can be in one of two forms:
  3441. --- 1. A list of pairs. Each pair is a "from" character immediately
  3442. --- followed by the "to" character. Examples: "aA", "aAbBcC".
  3443. --- 2. A list of "from" characters, a semicolon and a list of "to"
  3444. --- characters. Example: "abc;ABC"
  3445. --- Example: "aA,fgh;FGH,cCdDeE"
  3446. --- Special characters need to be preceded with a backslash. These are
  3447. --- ";", ',', '"', '|' and backslash itself.
  3448. ---
  3449. --- This will allow you to activate vim actions without having to switch
  3450. --- back and forth between the languages. Your language characters will
  3451. --- be understood as normal vim English characters (according to the
  3452. --- langmap mappings) in the following cases:
  3453. --- o Normal/Visual mode (commands, buffer/register names, user mappings)
  3454. --- o Insert/Replace Mode: Register names after CTRL-R
  3455. --- o Insert/Replace Mode: Mappings
  3456. --- Characters entered in Command-line mode will NOT be affected by
  3457. --- this option. Note that this option can be changed at any time
  3458. --- allowing to switch between mappings for different languages/encodings.
  3459. --- Use a mapping to avoid having to type it each time!
  3460. ---
  3461. --- @type string
  3462. vim.o.langmap = ""
  3463. vim.o.lmap = vim.o.langmap
  3464. vim.go.langmap = vim.o.langmap
  3465. vim.go.lmap = vim.go.langmap
  3466. --- Language to use for menu translation. Tells which file is loaded
  3467. --- from the "lang" directory in 'runtimepath':
  3468. ---
  3469. --- ```vim
  3470. --- "lang/menu_" .. &langmenu .. ".vim"
  3471. --- ```
  3472. --- (without the spaces). For example, to always use the Dutch menus, no
  3473. --- matter what $LANG is set to:
  3474. ---
  3475. --- ```vim
  3476. --- set langmenu=nl_NL.ISO_8859-1
  3477. --- ```
  3478. --- When 'langmenu' is empty, `v:lang` is used.
  3479. --- Only normal file name characters can be used, `/\*?[|<>` are illegal.
  3480. --- If your $LANG is set to a non-English language but you do want to use
  3481. --- the English menus:
  3482. ---
  3483. --- ```vim
  3484. --- set langmenu=none
  3485. --- ```
  3486. --- This option must be set before loading menus, switching on filetype
  3487. --- detection or syntax highlighting. Once the menus are defined setting
  3488. --- this option has no effect. But you could do this:
  3489. ---
  3490. --- ```vim
  3491. --- source $VIMRUNTIME/delmenu.vim
  3492. --- set langmenu=de_DE.ISO_8859-1
  3493. --- source $VIMRUNTIME/menu.vim
  3494. --- ```
  3495. --- Warning: This deletes all menus that you defined yourself!
  3496. ---
  3497. --- @type string
  3498. vim.o.langmenu = ""
  3499. vim.o.lm = vim.o.langmenu
  3500. vim.go.langmenu = vim.o.langmenu
  3501. vim.go.lm = vim.go.langmenu
  3502. --- When off, setting 'langmap' does not apply to characters resulting from
  3503. --- a mapping. If setting 'langmap' disables some of your mappings, make
  3504. --- sure this option is off.
  3505. ---
  3506. --- @type boolean
  3507. vim.o.langremap = false
  3508. vim.o.lrm = vim.o.langremap
  3509. vim.go.langremap = vim.o.langremap
  3510. vim.go.lrm = vim.go.langremap
  3511. --- The value of this option influences when the last window will have a
  3512. --- status line:
  3513. --- 0: never
  3514. --- 1: only if there are at least two windows
  3515. --- 2: always
  3516. --- 3: always and ONLY the last window
  3517. --- The screen looks nicer with a status line if you have several
  3518. --- windows, but it takes another screen line. `status-line`
  3519. ---
  3520. --- @type integer
  3521. vim.o.laststatus = 2
  3522. vim.o.ls = vim.o.laststatus
  3523. vim.go.laststatus = vim.o.laststatus
  3524. vim.go.ls = vim.go.laststatus
  3525. --- When this option is set, the screen will not be redrawn while
  3526. --- executing macros, registers and other commands that have not been
  3527. --- typed. Also, updating the window title is postponed. To force an
  3528. --- update use `:redraw`.
  3529. --- This may occasionally cause display errors. It is only meant to be set
  3530. --- temporarily when performing an operation where redrawing may cause
  3531. --- flickering or cause a slowdown.
  3532. ---
  3533. --- @type boolean
  3534. vim.o.lazyredraw = false
  3535. vim.o.lz = vim.o.lazyredraw
  3536. vim.go.lazyredraw = vim.o.lazyredraw
  3537. vim.go.lz = vim.go.lazyredraw
  3538. --- If on, Vim will wrap long lines at a character in 'breakat' rather
  3539. --- than at the last character that fits on the screen. Unlike
  3540. --- 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
  3541. --- it only affects the way the file is displayed, not its contents.
  3542. --- If 'breakindent' is set, line is visually indented. Then, the value
  3543. --- of 'showbreak' is used to put in front of wrapped lines. This option
  3544. --- is not used when the 'wrap' option is off.
  3545. --- Note that <Tab> characters after an <EOL> are mostly not displayed
  3546. --- with the right amount of white space.
  3547. ---
  3548. --- @type boolean
  3549. vim.o.linebreak = false
  3550. vim.o.lbr = vim.o.linebreak
  3551. vim.wo.linebreak = vim.o.linebreak
  3552. vim.wo.lbr = vim.wo.linebreak
  3553. --- Number of lines of the Vim window.
  3554. --- Normally you don't need to set this. It is done automatically by the
  3555. --- terminal initialization code.
  3556. --- When Vim is running in the GUI or in a resizable window, setting this
  3557. --- option will cause the window size to be changed. When you only want
  3558. --- to use the size for the GUI, put the command in your `gvimrc` file.
  3559. --- Vim limits the number of lines to what fits on the screen. You can
  3560. --- use this command to get the tallest window possible:
  3561. ---
  3562. --- ```vim
  3563. --- set lines=999
  3564. --- ```
  3565. --- Minimum value is 2, maximum value is 1000.
  3566. ---
  3567. --- @type integer
  3568. vim.o.lines = 24
  3569. vim.go.lines = vim.o.lines
  3570. --- only in the GUI
  3571. --- Number of pixel lines inserted between characters. Useful if the font
  3572. --- uses the full character cell height, making lines touch each other.
  3573. --- When non-zero there is room for underlining.
  3574. --- With some fonts there can be too much room between lines (to have
  3575. --- space for ascents and descents). Then it makes sense to set
  3576. --- 'linespace' to a negative value. This may cause display problems
  3577. --- though!
  3578. ---
  3579. --- @type integer
  3580. vim.o.linespace = 0
  3581. vim.o.lsp = vim.o.linespace
  3582. vim.go.linespace = vim.o.linespace
  3583. vim.go.lsp = vim.go.linespace
  3584. --- Lisp mode: When <Enter> is typed in insert mode set the indent for
  3585. --- the next line to Lisp standards (well, sort of). Also happens with
  3586. --- "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
  3587. --- flag in 'cpoptions' changes the method of indenting: Vi compatible or
  3588. --- better. Also see 'lispwords'.
  3589. --- The '-' character is included in keyword characters. Redefines the
  3590. --- "=" operator to use this same indentation algorithm rather than
  3591. --- calling an external program if 'equalprg' is empty.
  3592. ---
  3593. --- @type boolean
  3594. vim.o.lisp = false
  3595. vim.bo.lisp = vim.o.lisp
  3596. --- Comma-separated list of items that influence the Lisp indenting when
  3597. --- enabled with the `'lisp'` option. Currently only one item is
  3598. --- supported:
  3599. --- expr:1 use 'indentexpr' for Lisp indenting when it is set
  3600. --- expr:0 do not use 'indentexpr' for Lisp indenting (default)
  3601. --- Note that when using 'indentexpr' the `=` operator indents all the
  3602. --- lines, otherwise the first line is not indented (Vi-compatible).
  3603. ---
  3604. --- @type string
  3605. vim.o.lispoptions = ""
  3606. vim.o.lop = vim.o.lispoptions
  3607. vim.bo.lispoptions = vim.o.lispoptions
  3608. vim.bo.lop = vim.bo.lispoptions
  3609. --- Comma-separated list of words that influence the Lisp indenting when
  3610. --- enabled with the `'lisp'` option.
  3611. ---
  3612. --- @type string
  3613. vim.o.lispwords = "defun,define,defmacro,set!,lambda,if,case,let,flet,let*,letrec,do,do*,define-syntax,let-syntax,letrec-syntax,destructuring-bind,defpackage,defparameter,defstruct,deftype,defvar,do-all-symbols,do-external-symbols,do-symbols,dolist,dotimes,ecase,etypecase,eval-when,labels,macrolet,multiple-value-bind,multiple-value-call,multiple-value-prog1,multiple-value-setq,prog1,progv,typecase,unless,unwind-protect,when,with-input-from-string,with-open-file,with-open-stream,with-output-to-string,with-package-iterator,define-condition,handler-bind,handler-case,restart-bind,restart-case,with-simple-restart,store-value,use-value,muffle-warning,abort,continue,with-slots,with-slots*,with-accessors,with-accessors*,defclass,defmethod,print-unreadable-object"
  3614. vim.o.lw = vim.o.lispwords
  3615. vim.bo.lispwords = vim.o.lispwords
  3616. vim.bo.lw = vim.bo.lispwords
  3617. vim.go.lispwords = vim.o.lispwords
  3618. vim.go.lw = vim.go.lispwords
  3619. --- List mode: By default, show tabs as ">", trailing spaces as "-", and
  3620. --- non-breakable space characters as "+". Useful to see the difference
  3621. --- between tabs and spaces and for trailing blanks. Further changed by
  3622. --- the 'listchars' option.
  3623. ---
  3624. --- When 'listchars' does not contain "tab" field, tabs are shown as "^I"
  3625. --- or "<09>", like how unprintable characters are displayed.
  3626. ---
  3627. --- The cursor is displayed at the start of the space a Tab character
  3628. --- occupies, not at the end as usual in Normal mode. To get this cursor
  3629. --- position while displaying Tabs with spaces, use:
  3630. ---
  3631. --- ```vim
  3632. --- set list lcs=tab:\ \
  3633. --- ```
  3634. ---
  3635. --- Note that list mode will also affect formatting (set with 'textwidth'
  3636. --- or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
  3637. --- changing the way tabs are displayed.
  3638. ---
  3639. --- @type boolean
  3640. vim.o.list = false
  3641. vim.wo.list = vim.o.list
  3642. --- Strings to use in 'list' mode and for the `:list` command. It is a
  3643. --- comma-separated list of string settings. *E1511*
  3644. ---
  3645. --- *lcs-eol*
  3646. --- eol:c Character to show at the end of each line. When
  3647. --- omitted, there is no extra character at the end of the
  3648. --- line.
  3649. --- *lcs-tab*
  3650. --- tab:xy[z] Two or three characters to be used to show a tab.
  3651. --- The third character is optional.
  3652. ---
  3653. --- tab:xy The 'x' is always used, then 'y' as many times as will
  3654. --- fit. Thus "tab:>-" displays:
  3655. --- ```
  3656. ---
  3657. --- ```
  3658. --- >-
  3659. --- >--
  3660. --- etc.
  3661. --- ```
  3662. ---
  3663. --- tab:xyz The 'z' is always used, then 'x' is prepended, and
  3664. --- then 'y' is used as many times as will fit. Thus
  3665. --- "tab:<->" displays:
  3666. --- ```
  3667. ---
  3668. --- ```
  3669. --- <>
  3670. --- <->
  3671. --- <-->
  3672. --- etc.
  3673. --- ```
  3674. ---
  3675. --- When "tab:" is omitted, a tab is shown as ^I.
  3676. --- *lcs-space*
  3677. --- space:c Character to show for a space. When omitted, spaces
  3678. --- are left blank.
  3679. --- *lcs-multispace*
  3680. --- multispace:c...
  3681. --- One or more characters to use cyclically to show for
  3682. --- multiple consecutive spaces. Overrides the "space"
  3683. --- setting, except for single spaces. When omitted, the
  3684. --- "space" setting is used. For example,
  3685. --- `:set listchars=multispace:---+` shows ten consecutive
  3686. --- spaces as:
  3687. --- ```
  3688. --- ---+---+--
  3689. --- ```
  3690. ---
  3691. --- *lcs-lead*
  3692. --- lead:c Character to show for leading spaces. When omitted,
  3693. --- leading spaces are blank. Overrides the "space" and
  3694. --- "multispace" settings for leading spaces. You can
  3695. --- combine it with "tab:", for example:
  3696. ---
  3697. --- ```vim
  3698. --- set listchars+=tab:>-,lead:.
  3699. --- ```
  3700. ---
  3701. --- *lcs-leadmultispace*
  3702. --- leadmultispace:c...
  3703. --- Like the `lcs-multispace` value, but for leading
  3704. --- spaces only. Also overrides `lcs-lead` for leading
  3705. --- multiple spaces.
  3706. --- `:set listchars=leadmultispace:---+` shows ten
  3707. --- consecutive leading spaces as:
  3708. --- ```
  3709. --- ---+---+--XXX
  3710. --- ```
  3711. ---
  3712. --- Where "XXX" denotes the first non-blank characters in
  3713. --- the line.
  3714. --- *lcs-trail*
  3715. --- trail:c Character to show for trailing spaces. When omitted,
  3716. --- trailing spaces are blank. Overrides the "space" and
  3717. --- "multispace" settings for trailing spaces.
  3718. --- *lcs-extends*
  3719. --- extends:c Character to show in the last column, when 'wrap' is
  3720. --- off and the line continues beyond the right of the
  3721. --- screen.
  3722. --- *lcs-precedes*
  3723. --- precedes:c Character to show in the first visible column of the
  3724. --- physical line, when there is text preceding the
  3725. --- character visible in the first column.
  3726. --- *lcs-conceal*
  3727. --- conceal:c Character to show in place of concealed text, when
  3728. --- 'conceallevel' is set to 1. A space when omitted.
  3729. --- *lcs-nbsp*
  3730. --- nbsp:c Character to show for a non-breakable space character
  3731. --- (0xA0 (160 decimal) and U+202F). Left blank when
  3732. --- omitted.
  3733. ---
  3734. --- The characters ':' and ',' should not be used. UTF-8 characters can
  3735. --- be used. All characters must be single width. *E1512*
  3736. ---
  3737. --- Each character can be specified as hex:
  3738. ---
  3739. --- ```vim
  3740. --- set listchars=eol:\\x24
  3741. --- set listchars=eol:\\u21b5
  3742. --- set listchars=eol:\\U000021b5
  3743. --- ```
  3744. --- Note that a double backslash is used. The number of hex characters
  3745. --- must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
  3746. ---
  3747. --- Examples:
  3748. ---
  3749. --- ```vim
  3750. --- set lcs=tab:>-,trail:-
  3751. --- set lcs=tab:>-,eol:<,nbsp:%
  3752. --- set lcs=extends:>,precedes:<
  3753. --- ```
  3754. --- `hl-NonText` highlighting will be used for "eol", "extends" and
  3755. --- "precedes". `hl-Whitespace` for "nbsp", "space", "tab", "multispace",
  3756. --- "lead" and "trail".
  3757. ---
  3758. --- @type string
  3759. vim.o.listchars = "tab:> ,trail:-,nbsp:+"
  3760. vim.o.lcs = vim.o.listchars
  3761. vim.wo.listchars = vim.o.listchars
  3762. vim.wo.lcs = vim.wo.listchars
  3763. vim.go.listchars = vim.o.listchars
  3764. vim.go.lcs = vim.go.listchars
  3765. --- When on the plugin scripts are loaded when starting up `load-plugins`.
  3766. --- This option can be reset in your `vimrc` file to disable the loading
  3767. --- of plugins.
  3768. --- Note that using the "-u NONE" and "--noplugin" command line arguments
  3769. --- reset this option. `-u` `--noplugin`
  3770. ---
  3771. --- @type boolean
  3772. vim.o.loadplugins = true
  3773. vim.o.lpl = vim.o.loadplugins
  3774. vim.go.loadplugins = vim.o.loadplugins
  3775. vim.go.lpl = vim.go.loadplugins
  3776. --- Changes the special characters that can be used in search patterns.
  3777. --- See `pattern`.
  3778. --- WARNING: Switching this option off most likely breaks plugins! That
  3779. --- is because many patterns assume it's on and will fail when it's off.
  3780. --- Only switch it off when working with old Vi scripts. In any other
  3781. --- situation write patterns that work when 'magic' is on. Include "\M"
  3782. --- when you want to `/\M`.
  3783. ---
  3784. --- @type boolean
  3785. vim.o.magic = true
  3786. vim.go.magic = vim.o.magic
  3787. --- Name of the errorfile for the `:make` command (see `:make_makeprg`)
  3788. --- and the `:grep` command.
  3789. --- When it is empty, an internally generated temp file will be used.
  3790. --- When "##" is included, it is replaced by a number to make the name
  3791. --- unique. This makes sure that the ":make" command doesn't overwrite an
  3792. --- existing file.
  3793. --- NOT used for the ":cf" command. See 'errorfile' for that.
  3794. --- Environment variables are expanded `:set_env`.
  3795. --- See `option-backslash` about including spaces and backslashes.
  3796. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3797. --- security reasons.
  3798. ---
  3799. --- @type string
  3800. vim.o.makeef = ""
  3801. vim.o.mef = vim.o.makeef
  3802. vim.go.makeef = vim.o.makeef
  3803. vim.go.mef = vim.go.makeef
  3804. --- Encoding used for reading the output of external commands. When empty,
  3805. --- encoding is not converted.
  3806. --- This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
  3807. --- `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
  3808. --- and `:laddfile`.
  3809. ---
  3810. --- This would be mostly useful when you use MS-Windows. If iconv is
  3811. --- enabled, setting 'makeencoding' to "char" has the same effect as
  3812. --- setting to the system locale encoding. Example:
  3813. ---
  3814. --- ```vim
  3815. --- set makeencoding=char " system locale is used
  3816. --- ```
  3817. ---
  3818. ---
  3819. --- @type string
  3820. vim.o.makeencoding = ""
  3821. vim.o.menc = vim.o.makeencoding
  3822. vim.bo.makeencoding = vim.o.makeencoding
  3823. vim.bo.menc = vim.bo.makeencoding
  3824. vim.go.makeencoding = vim.o.makeencoding
  3825. vim.go.menc = vim.go.makeencoding
  3826. --- Program to use for the ":make" command. See `:make_makeprg`.
  3827. --- This option may contain '%' and '#' characters (see `:_%` and `:_#`),
  3828. --- which are expanded to the current and alternate file name. Use `::S`
  3829. --- to escape file names in case they contain special characters.
  3830. --- Environment variables are expanded `:set_env`. See `option-backslash`
  3831. --- about including spaces and backslashes.
  3832. --- Note that a '|' must be escaped twice: once for ":set" and once for
  3833. --- the interpretation of a command. When you use a filter called
  3834. --- "myfilter" do it like this:
  3835. ---
  3836. --- ```vim
  3837. --- set makeprg=gmake\ \\\|\ myfilter
  3838. --- ```
  3839. --- The placeholder "$*" can be given (even multiple times) to specify
  3840. --- where the arguments will be included, for example:
  3841. ---
  3842. --- ```vim
  3843. --- set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  3844. --- ```
  3845. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3846. --- security reasons.
  3847. ---
  3848. --- @type string
  3849. vim.o.makeprg = "make"
  3850. vim.o.mp = vim.o.makeprg
  3851. vim.bo.makeprg = vim.o.makeprg
  3852. vim.bo.mp = vim.bo.makeprg
  3853. vim.go.makeprg = vim.o.makeprg
  3854. vim.go.mp = vim.go.makeprg
  3855. --- Characters that form pairs. The `%` command jumps from one to the
  3856. --- other.
  3857. --- Only character pairs are allowed that are different, thus you cannot
  3858. --- jump between two double quotes.
  3859. --- The characters must be separated by a colon.
  3860. --- The pairs must be separated by a comma. Example for including '<' and
  3861. --- '>' (for HTML):
  3862. ---
  3863. --- ```vim
  3864. --- set mps+=<:>
  3865. --- ```
  3866. --- A more exotic example, to jump between the '=' and ';' in an
  3867. --- assignment, useful for languages like C and Java:
  3868. ---
  3869. --- ```vim
  3870. --- au FileType c,cpp,java set mps+==:;
  3871. --- ```
  3872. --- For a more advanced way of using "%", see the matchit.vim plugin in
  3873. --- the $VIMRUNTIME/plugin directory. `add-local-help`
  3874. ---
  3875. --- @type string
  3876. vim.o.matchpairs = "(:),{:},[:]"
  3877. vim.o.mps = vim.o.matchpairs
  3878. vim.bo.matchpairs = vim.o.matchpairs
  3879. vim.bo.mps = vim.bo.matchpairs
  3880. --- Tenths of a second to show the matching paren, when 'showmatch' is
  3881. --- set. Note that this is not in milliseconds, like other options that
  3882. --- set a time. This is to be compatible with Nvi.
  3883. ---
  3884. --- @type integer
  3885. vim.o.matchtime = 5
  3886. vim.o.mat = vim.o.matchtime
  3887. vim.go.matchtime = vim.o.matchtime
  3888. vim.go.mat = vim.go.matchtime
  3889. --- Maximum depth of function calls for user functions. This normally
  3890. --- catches endless recursion. When using a recursive function with
  3891. --- more depth, set 'maxfuncdepth' to a bigger number. But this will use
  3892. --- more memory, there is the danger of failing when memory is exhausted.
  3893. --- Increasing this limit above 200 also changes the maximum for Ex
  3894. --- command recursion, see `E169`.
  3895. --- See also `:function`.
  3896. --- Also used for maximum depth of callback functions.
  3897. ---
  3898. --- @type integer
  3899. vim.o.maxfuncdepth = 100
  3900. vim.o.mfd = vim.o.maxfuncdepth
  3901. vim.go.maxfuncdepth = vim.o.maxfuncdepth
  3902. vim.go.mfd = vim.go.maxfuncdepth
  3903. --- Maximum number of times a mapping is done without resulting in a
  3904. --- character to be used. This normally catches endless mappings, like
  3905. --- ":map x y" with ":map y x". It still does not catch ":map g wg",
  3906. --- because the 'w' is used before the next mapping is done. See also
  3907. --- `key-mapping`.
  3908. ---
  3909. --- @type integer
  3910. vim.o.maxmapdepth = 1000
  3911. vim.o.mmd = vim.o.maxmapdepth
  3912. vim.go.maxmapdepth = vim.o.maxmapdepth
  3913. vim.go.mmd = vim.go.maxmapdepth
  3914. --- Maximum amount of memory (in Kbyte) to use for pattern matching.
  3915. --- The maximum value is about 2000000. Use this to work without a limit.
  3916. --- *E363*
  3917. --- When Vim runs into the limit it gives an error message and mostly
  3918. --- behaves like CTRL-C was typed.
  3919. --- Running into the limit often means that the pattern is very
  3920. --- inefficient or too complex. This may already happen with the pattern
  3921. --- "\(.\)*" on a very long line. ".*" works much better.
  3922. --- Might also happen on redraw, when syntax rules try to match a complex
  3923. --- text structure.
  3924. --- Vim may run out of memory before hitting the 'maxmempattern' limit, in
  3925. --- which case you get an "Out of memory" error instead.
  3926. ---
  3927. --- @type integer
  3928. vim.o.maxmempattern = 1000
  3929. vim.o.mmp = vim.o.maxmempattern
  3930. vim.go.maxmempattern = vim.o.maxmempattern
  3931. vim.go.mmp = vim.go.maxmempattern
  3932. --- Maximum number of items to use in a menu. Used for menus that are
  3933. --- generated from a list of items, e.g., the Buffers menu. Changing this
  3934. --- option has no direct effect, the menu must be refreshed first.
  3935. ---
  3936. --- @type integer
  3937. vim.o.menuitems = 25
  3938. vim.o.mis = vim.o.menuitems
  3939. vim.go.menuitems = vim.o.menuitems
  3940. vim.go.mis = vim.go.menuitems
  3941. --- Option settings for outputting messages. It can consist of the
  3942. --- following items. Items must be separated by a comma.
  3943. ---
  3944. --- hit-enter Use a `hit-enter` prompt when the message is longer than
  3945. --- 'cmdheight' size.
  3946. ---
  3947. --- wait:{n} Instead of using a `hit-enter` prompt, simply wait for
  3948. --- {n} milliseconds so that the user has a chance to read
  3949. --- the message. The maximum value of {n} is 10000. Use
  3950. --- 0 to disable the wait (but then the user may miss an
  3951. --- important message).
  3952. --- This item is ignored when "hit-enter" is present, but
  3953. --- required when "hit-enter" is not present.
  3954. ---
  3955. --- history:{n} Determines how many entries are remembered in the
  3956. --- `:messages` history. The maximum value is 10000.
  3957. --- Setting it to zero clears the message history.
  3958. --- This item must always be present.
  3959. ---
  3960. --- @type string
  3961. vim.o.messagesopt = "hit-enter,history:500"
  3962. vim.o.mopt = vim.o.messagesopt
  3963. vim.go.messagesopt = vim.o.messagesopt
  3964. vim.go.mopt = vim.go.messagesopt
  3965. --- Parameters for `:mkspell`. This tunes when to start compressing the
  3966. --- word tree. Compression can be slow when there are many words, but
  3967. --- it's needed to avoid running out of memory. The amount of memory used
  3968. --- per word depends very much on how similar the words are, that's why
  3969. --- this tuning is complicated.
  3970. ---
  3971. --- There are three numbers, separated by commas:
  3972. --- ```
  3973. --- {start},{inc},{added}
  3974. --- ```
  3975. ---
  3976. --- For most languages the uncompressed word tree fits in memory. {start}
  3977. --- gives the amount of memory in Kbyte that can be used before any
  3978. --- compression is done. It should be a bit smaller than the amount of
  3979. --- memory that is available to Vim.
  3980. ---
  3981. --- When going over the {start} limit the {inc} number specifies the
  3982. --- amount of memory in Kbyte that can be allocated before another
  3983. --- compression is done. A low number means compression is done after
  3984. --- less words are added, which is slow. A high number means more memory
  3985. --- will be allocated.
  3986. ---
  3987. --- After doing compression, {added} times 1024 words can be added before
  3988. --- the {inc} limit is ignored and compression is done when any extra
  3989. --- amount of memory is needed. A low number means there is a smaller
  3990. --- chance of hitting the {inc} limit, less memory is used but it's
  3991. --- slower.
  3992. ---
  3993. --- The languages for which these numbers are important are Italian and
  3994. --- Hungarian. The default works for when you have about 512 Mbyte. If
  3995. --- you have 1 Gbyte you could use:
  3996. ---
  3997. --- ```vim
  3998. --- set mkspellmem=900000,3000,800
  3999. --- ```
  4000. --- If you have less than 512 Mbyte `:mkspell` may fail for some
  4001. --- languages, no matter what you set 'mkspellmem' to.
  4002. ---
  4003. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4004. --- security reasons.
  4005. ---
  4006. --- @type string
  4007. vim.o.mkspellmem = "460000,2000,500"
  4008. vim.o.msm = vim.o.mkspellmem
  4009. vim.go.mkspellmem = vim.o.mkspellmem
  4010. vim.go.msm = vim.go.mkspellmem
  4011. --- If 'modeline' is on 'modelines' gives the number of lines that is
  4012. --- checked for set commands. If 'modeline' is off or 'modelines' is zero
  4013. --- no lines are checked. See `modeline`.
  4014. ---
  4015. --- @type boolean
  4016. vim.o.modeline = true
  4017. vim.o.ml = vim.o.modeline
  4018. vim.bo.modeline = vim.o.modeline
  4019. vim.bo.ml = vim.bo.modeline
  4020. --- When on allow some options that are an expression to be set in the
  4021. --- modeline. Check the option for whether it is affected by
  4022. --- 'modelineexpr'. Also see `modeline`.
  4023. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4024. --- security reasons.
  4025. ---
  4026. --- @type boolean
  4027. vim.o.modelineexpr = false
  4028. vim.o.mle = vim.o.modelineexpr
  4029. vim.go.modelineexpr = vim.o.modelineexpr
  4030. vim.go.mle = vim.go.modelineexpr
  4031. --- If 'modeline' is on 'modelines' gives the number of lines that is
  4032. --- checked for set commands. If 'modeline' is off or 'modelines' is zero
  4033. --- no lines are checked. See `modeline`.
  4034. ---
  4035. ---
  4036. --- @type integer
  4037. vim.o.modelines = 5
  4038. vim.o.mls = vim.o.modelines
  4039. vim.go.modelines = vim.o.modelines
  4040. vim.go.mls = vim.go.modelines
  4041. --- When off the buffer contents cannot be changed. The 'fileformat' and
  4042. --- 'fileencoding' options also can't be changed.
  4043. --- Can be reset on startup with the `-M` command line argument.
  4044. ---
  4045. --- @type boolean
  4046. vim.o.modifiable = true
  4047. vim.o.ma = vim.o.modifiable
  4048. vim.bo.modifiable = vim.o.modifiable
  4049. vim.bo.ma = vim.bo.modifiable
  4050. --- When on, the buffer is considered to be modified. This option is set
  4051. --- when:
  4052. --- 1. A change was made to the text since it was last written. Using the
  4053. --- `undo` command to go back to the original text will reset the
  4054. --- option. But undoing changes that were made before writing the
  4055. --- buffer will set the option again, since the text is different from
  4056. --- when it was written.
  4057. --- 2. 'fileformat' or 'fileencoding' is different from its original
  4058. --- value. The original value is set when the buffer is read or
  4059. --- written. A ":set nomodified" command also resets the original
  4060. --- values to the current values and the 'modified' option will be
  4061. --- reset.
  4062. --- Similarly for 'eol' and 'bomb'.
  4063. --- This option is not set when a change is made to the buffer as the
  4064. --- result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
  4065. --- FileAppendPost or VimLeave autocommand event. See `gzip-example` for
  4066. --- an explanation.
  4067. --- When 'buftype' is "nowrite" or "nofile" this option may be set, but
  4068. --- will be ignored.
  4069. --- Note that the text may actually be the same, e.g. 'modified' is set
  4070. --- when using "rA" on an "A".
  4071. ---
  4072. --- @type boolean
  4073. vim.o.modified = false
  4074. vim.o.mod = vim.o.modified
  4075. vim.bo.modified = vim.o.modified
  4076. vim.bo.mod = vim.bo.modified
  4077. --- When on, listings pause when the whole screen is filled. You will get
  4078. --- the `more-prompt`. When this option is off there are no pauses, the
  4079. --- listing continues until finished.
  4080. ---
  4081. --- @type boolean
  4082. vim.o.more = true
  4083. vim.go.more = vim.o.more
  4084. --- Enables mouse support. For example, to enable the mouse in Normal mode
  4085. --- and Visual mode:
  4086. ---
  4087. --- ```vim
  4088. --- set mouse=nv
  4089. --- ```
  4090. ---
  4091. --- To temporarily disable mouse support, hold the shift key while using
  4092. --- the mouse.
  4093. ---
  4094. --- Mouse support can be enabled for different modes:
  4095. --- n Normal mode
  4096. --- v Visual mode
  4097. --- i Insert mode
  4098. --- c Command-line mode
  4099. --- h all previous modes when editing a help file
  4100. --- a all previous modes
  4101. --- r for `hit-enter` and `more-prompt` prompt
  4102. ---
  4103. --- Left-click anywhere in a text buffer to place the cursor there. This
  4104. --- works with operators too, e.g. type `d` then left-click to delete text
  4105. --- from the current cursor position to the position where you clicked.
  4106. ---
  4107. --- Drag the `status-line` or vertical separator of a window to resize it.
  4108. ---
  4109. --- If enabled for "v" (Visual mode) then double-click selects word-wise,
  4110. --- triple-click makes it line-wise, and quadruple-click makes it
  4111. --- rectangular block-wise.
  4112. ---
  4113. --- For scrolling with a mouse wheel see `scroll-mouse-wheel`.
  4114. ---
  4115. --- Note: When enabling the mouse in a terminal, copy/paste will use the
  4116. --- "* register if possible. See also 'clipboard'.
  4117. ---
  4118. --- Related options:
  4119. --- 'mousefocus' window focus follows mouse pointer
  4120. --- 'mousemodel' what mouse button does which action
  4121. --- 'mousehide' hide mouse pointer while typing text
  4122. --- 'selectmode' whether to start Select mode or Visual mode
  4123. ---
  4124. --- @type string
  4125. vim.o.mouse = "nvi"
  4126. vim.go.mouse = vim.o.mouse
  4127. --- The window that the mouse pointer is on is automatically activated.
  4128. --- When changing the window layout or window focus in another way, the
  4129. --- mouse pointer is moved to the window with keyboard focus. Off is the
  4130. --- default because it makes using the pull down menus a little goofy, as
  4131. --- a pointer transit may activate a window unintentionally.
  4132. ---
  4133. --- @type boolean
  4134. vim.o.mousefocus = false
  4135. vim.o.mousef = vim.o.mousefocus
  4136. vim.go.mousefocus = vim.o.mousefocus
  4137. vim.go.mousef = vim.go.mousefocus
  4138. --- only in the GUI
  4139. --- When on, the mouse pointer is hidden when characters are typed.
  4140. --- The mouse pointer is restored when the mouse is moved.
  4141. ---
  4142. --- @type boolean
  4143. vim.o.mousehide = true
  4144. vim.o.mh = vim.o.mousehide
  4145. vim.go.mousehide = vim.o.mousehide
  4146. vim.go.mh = vim.go.mousehide
  4147. --- Sets the model to use for the mouse. The name mostly specifies what
  4148. --- the right mouse button is used for:
  4149. --- extend Right mouse button extends a selection. This works
  4150. --- like in an xterm.
  4151. --- popup Right mouse button pops up a menu. The shifted left
  4152. --- mouse button extends a selection. This works like
  4153. --- with Microsoft Windows.
  4154. --- popup_setpos Like "popup", but the cursor will be moved to the
  4155. --- position where the mouse was clicked, and thus the
  4156. --- selected operation will act upon the clicked object.
  4157. --- If clicking inside a selection, that selection will
  4158. --- be acted upon, i.e. no cursor move. This implies of
  4159. --- course, that right clicking outside a selection will
  4160. --- end Visual mode.
  4161. --- Overview of what button does what for each model:
  4162. --- mouse extend popup(_setpos) ~
  4163. --- left click place cursor place cursor
  4164. --- left drag start selection start selection
  4165. --- shift-left search word extend selection
  4166. --- right click extend selection popup menu (place cursor)
  4167. --- right drag extend selection -
  4168. --- middle click paste paste
  4169. ---
  4170. --- In the "popup" model the right mouse button produces a pop-up menu.
  4171. --- Nvim creates a default `popup-menu` but you can redefine it.
  4172. ---
  4173. --- Note that you can further refine the meaning of buttons with mappings.
  4174. --- See `mouse-overview`. But mappings are NOT used for modeless selection.
  4175. ---
  4176. --- Example:
  4177. ---
  4178. --- ```vim
  4179. --- map <S-LeftMouse> <RightMouse>
  4180. --- map <S-LeftDrag> <RightDrag>
  4181. --- map <S-LeftRelease> <RightRelease>
  4182. --- map <2-S-LeftMouse> <2-RightMouse>
  4183. --- map <2-S-LeftDrag> <2-RightDrag>
  4184. --- map <2-S-LeftRelease> <2-RightRelease>
  4185. --- map <3-S-LeftMouse> <3-RightMouse>
  4186. --- map <3-S-LeftDrag> <3-RightDrag>
  4187. --- map <3-S-LeftRelease> <3-RightRelease>
  4188. --- map <4-S-LeftMouse> <4-RightMouse>
  4189. --- map <4-S-LeftDrag> <4-RightDrag>
  4190. --- map <4-S-LeftRelease> <4-RightRelease>
  4191. --- ```
  4192. ---
  4193. --- Mouse commands requiring the CTRL modifier can be simulated by typing
  4194. --- the "g" key before using the mouse:
  4195. --- "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click)
  4196. --- "g<RightMouse>" is "<C-RightMouse> ("CTRL-T")
  4197. ---
  4198. --- @type 'extend'|'popup'|'popup_setpos'
  4199. vim.o.mousemodel = "popup_setpos"
  4200. vim.o.mousem = vim.o.mousemodel
  4201. vim.go.mousemodel = vim.o.mousemodel
  4202. vim.go.mousem = vim.go.mousemodel
  4203. --- When on, mouse move events are delivered to the input queue and are
  4204. --- available for mapping. The default, off, avoids the mouse movement
  4205. --- overhead except when needed.
  4206. --- Warning: Setting this option can make pending mappings to be aborted
  4207. --- when the mouse is moved.
  4208. ---
  4209. --- @type boolean
  4210. vim.o.mousemoveevent = false
  4211. vim.o.mousemev = vim.o.mousemoveevent
  4212. vim.go.mousemoveevent = vim.o.mousemoveevent
  4213. vim.go.mousemev = vim.go.mousemoveevent
  4214. --- This option controls the number of lines / columns to scroll by when
  4215. --- scrolling with a mouse wheel (`scroll-mouse-wheel`). The option is
  4216. --- a comma-separated list. Each part consists of a direction and a count
  4217. --- as follows:
  4218. --- direction:count,direction:count
  4219. --- Direction is one of either "hor" or "ver". "hor" controls horizontal
  4220. --- scrolling and "ver" controls vertical scrolling. Count sets the amount
  4221. --- to scroll by for the given direction, it should be a non negative
  4222. --- integer. Each direction should be set at most once. If a direction
  4223. --- is omitted, a default value is used (6 for horizontal scrolling and 3
  4224. --- for vertical scrolling). You can disable mouse scrolling by using
  4225. --- a count of 0.
  4226. ---
  4227. --- Example:
  4228. ---
  4229. --- ```vim
  4230. --- set mousescroll=ver:5,hor:2
  4231. --- ```
  4232. --- Will make Nvim scroll 5 lines at a time when scrolling vertically, and
  4233. --- scroll 2 columns at a time when scrolling horizontally.
  4234. ---
  4235. --- @type string
  4236. vim.o.mousescroll = "ver:3,hor:6"
  4237. vim.go.mousescroll = vim.o.mousescroll
  4238. --- Defines the maximum time in msec between two mouse clicks for the
  4239. --- second click to be recognized as a multi click.
  4240. ---
  4241. --- @type integer
  4242. vim.o.mousetime = 500
  4243. vim.o.mouset = vim.o.mousetime
  4244. vim.go.mousetime = vim.o.mousetime
  4245. vim.go.mouset = vim.go.mousetime
  4246. --- This defines what bases Vim will consider for numbers when using the
  4247. --- CTRL-A and CTRL-X commands for adding to and subtracting from a number
  4248. --- respectively; see `CTRL-A` for more info on these commands.
  4249. --- alpha If included, single alphabetical characters will be
  4250. --- incremented or decremented. This is useful for a list with a
  4251. --- letter index a), b), etc. *octal-nrformats*
  4252. --- octal If included, numbers that start with a zero will be considered
  4253. --- to be octal. Example: Using CTRL-A on "007" results in "010".
  4254. --- hex If included, numbers starting with "0x" or "0X" will be
  4255. --- considered to be hexadecimal. Example: Using CTRL-X on
  4256. --- "0x100" results in "0x0ff".
  4257. --- bin If included, numbers starting with "0b" or "0B" will be
  4258. --- considered to be binary. Example: Using CTRL-X on
  4259. --- "0b1000" subtracts one, resulting in "0b0111".
  4260. --- unsigned If included, numbers are recognized as unsigned. Thus a
  4261. --- leading dash or negative sign won't be considered as part of
  4262. --- the number. Examples:
  4263. --- Using CTRL-X on "2020" in "9-2020" results in "9-2019"
  4264. --- (without "unsigned" it would become "9-2021").
  4265. --- Using CTRL-A on "2020" in "9-2020" results in "9-2021"
  4266. --- (without "unsigned" it would become "9-2019").
  4267. --- Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
  4268. --- (2^64 - 1) has no effect, overflow is prevented.
  4269. --- blank If included, treat numbers as signed or unsigned based on
  4270. --- preceding whitespace. If a number with a leading dash has its
  4271. --- dash immediately preceded by a non-whitespace character (i.e.,
  4272. --- not a tab or a " "), the negative sign won't be considered as
  4273. --- part of the number. For example:
  4274. --- Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
  4275. --- (without "blank" it would become "Carbon-13").
  4276. --- Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
  4277. --- (because -8 is preceded by whitespace. If "unsigned" was
  4278. --- set, it would result in "Carbon -7").
  4279. --- If this format is included, overflow is prevented as if
  4280. --- "unsigned" were set. If both this format and "unsigned" are
  4281. --- included, "unsigned" will take precedence.
  4282. ---
  4283. --- Numbers which simply begin with a digit in the range 1-9 are always
  4284. --- considered decimal. This also happens for numbers that are not
  4285. --- recognized as octal or hex.
  4286. ---
  4287. --- @type string
  4288. vim.o.nrformats = "bin,hex"
  4289. vim.o.nf = vim.o.nrformats
  4290. vim.bo.nrformats = vim.o.nrformats
  4291. vim.bo.nf = vim.bo.nrformats
  4292. --- Print the line number in front of each line. When the 'n' option is
  4293. --- excluded from 'cpoptions' a wrapped line will not use the column of
  4294. --- line numbers.
  4295. --- Use the 'numberwidth' option to adjust the room for the line number.
  4296. --- When a long, wrapped line doesn't start with the first character, '-'
  4297. --- characters are put before the number.
  4298. --- For highlighting see `hl-LineNr`, `hl-CursorLineNr`, and the
  4299. --- `:sign-define` "numhl" argument.
  4300. --- *number_relativenumber*
  4301. --- The 'relativenumber' option changes the displayed number to be
  4302. --- relative to the cursor. Together with 'number' there are these
  4303. --- four combinations (cursor in line 3):
  4304. ---
  4305. --- 'nonu' 'nu' 'nonu' 'nu'
  4306. --- 'nornu' 'nornu' 'rnu' 'rnu'
  4307. --- ```
  4308. --- |apple | 1 apple | 2 apple | 2 apple
  4309. --- |pear | 2 pear | 1 pear | 1 pear
  4310. --- |nobody | 3 nobody | 0 nobody |3 nobody
  4311. --- |there | 4 there | 1 there | 1 there
  4312. --- ```
  4313. ---
  4314. ---
  4315. --- @type boolean
  4316. vim.o.number = false
  4317. vim.o.nu = vim.o.number
  4318. vim.wo.number = vim.o.number
  4319. vim.wo.nu = vim.wo.number
  4320. --- Minimal number of columns to use for the line number. Only relevant
  4321. --- when the 'number' or 'relativenumber' option is set or printing lines
  4322. --- with a line number. Since one space is always between the number and
  4323. --- the text, there is one less character for the number itself.
  4324. --- The value is the minimum width. A bigger width is used when needed to
  4325. --- fit the highest line number in the buffer respectively the number of
  4326. --- rows in the window, depending on whether 'number' or 'relativenumber'
  4327. --- is set. Thus with the Vim default of 4 there is room for a line number
  4328. --- up to 999. When the buffer has 1000 lines five columns will be used.
  4329. --- The minimum value is 1, the maximum value is 20.
  4330. ---
  4331. --- @type integer
  4332. vim.o.numberwidth = 4
  4333. vim.o.nuw = vim.o.numberwidth
  4334. vim.wo.numberwidth = vim.o.numberwidth
  4335. vim.wo.nuw = vim.wo.numberwidth
  4336. --- This option specifies a function to be used for Insert mode omni
  4337. --- completion with CTRL-X CTRL-O. `i_CTRL-X_CTRL-O`
  4338. --- See `complete-functions` for an explanation of how the function is
  4339. --- invoked and what it should return. The value can be the name of a
  4340. --- function, a `lambda` or a `Funcref`. See `option-value-function` for
  4341. --- more information.
  4342. --- This option is usually set by a filetype plugin:
  4343. --- `:filetype-plugin-on`
  4344. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4345. --- security reasons.
  4346. ---
  4347. --- @type string
  4348. vim.o.omnifunc = ""
  4349. vim.o.ofu = vim.o.omnifunc
  4350. vim.bo.omnifunc = vim.o.omnifunc
  4351. vim.bo.ofu = vim.bo.omnifunc
  4352. --- This option specifies a function to be called by the `g@` operator.
  4353. --- See `:map-operator` for more info and an example. The value can be
  4354. --- the name of a function, a `lambda` or a `Funcref`. See
  4355. --- `option-value-function` for more information.
  4356. ---
  4357. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4358. --- security reasons.
  4359. ---
  4360. --- @type string
  4361. vim.o.operatorfunc = ""
  4362. vim.o.opfunc = vim.o.operatorfunc
  4363. vim.go.operatorfunc = vim.o.operatorfunc
  4364. vim.go.opfunc = vim.go.operatorfunc
  4365. --- Directories used to find packages.
  4366. --- See `packages` and `packages-runtimepath`.
  4367. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4368. --- security reasons.
  4369. ---
  4370. --- @type string
  4371. vim.o.packpath = "..."
  4372. vim.o.pp = vim.o.packpath
  4373. vim.go.packpath = vim.o.packpath
  4374. vim.go.pp = vim.go.packpath
  4375. --- Specifies the nroff macros that separate paragraphs. These are pairs
  4376. --- of two letters (see `object-motions`).
  4377. ---
  4378. --- @type string
  4379. vim.o.paragraphs = "IPLPPPQPP TPHPLIPpLpItpplpipbp"
  4380. vim.o.para = vim.o.paragraphs
  4381. vim.go.paragraphs = vim.o.paragraphs
  4382. vim.go.para = vim.go.paragraphs
  4383. --- Expression which is evaluated to apply a patch to a file and generate
  4384. --- the resulting new version of the file. See `diff-patchexpr`.
  4385. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4386. --- security reasons.
  4387. ---
  4388. --- @type string
  4389. vim.o.patchexpr = ""
  4390. vim.o.pex = vim.o.patchexpr
  4391. vim.go.patchexpr = vim.o.patchexpr
  4392. vim.go.pex = vim.go.patchexpr
  4393. --- When non-empty the oldest version of a file is kept. This can be used
  4394. --- to keep the original version of a file if you are changing files in a
  4395. --- source distribution. Only the first time that a file is written a
  4396. --- copy of the original file will be kept. The name of the copy is the
  4397. --- name of the original file with the string in the 'patchmode' option
  4398. --- appended. This option should start with a dot. Use a string like
  4399. --- ".orig" or ".org". 'backupdir' must not be empty for this to work
  4400. --- (Detail: The backup file is renamed to the patchmode file after the
  4401. --- new file has been successfully written, that's why it must be possible
  4402. --- to write a backup file). If there was no file to be backed up, an
  4403. --- empty file is created.
  4404. --- When the 'backupskip' pattern matches, a patchmode file is not made.
  4405. --- Using 'patchmode' for compressed files appends the extension at the
  4406. --- end (e.g., "file.gz.orig"), thus the resulting name isn't always
  4407. --- recognized as a compressed file.
  4408. --- Only normal file name characters can be used, `/\*?[|<>` are illegal.
  4409. ---
  4410. --- @type string
  4411. vim.o.patchmode = ""
  4412. vim.o.pm = vim.o.patchmode
  4413. vim.go.patchmode = vim.o.patchmode
  4414. vim.go.pm = vim.go.patchmode
  4415. --- This is a list of directories which will be searched when using the
  4416. --- `gf`, [f, ]f, ^Wf, `:find`, `:sfind`, `:tabfind` and other commands,
  4417. --- provided that the file being searched for has a relative path (not
  4418. --- starting with "/", "./" or "../"). The directories in the 'path'
  4419. --- option may be relative or absolute.
  4420. --- - Use commas to separate directory names:
  4421. ---
  4422. --- ```vim
  4423. --- set path=.,/usr/local/include,/usr/include
  4424. --- ```
  4425. --- - Spaces can also be used to separate directory names. To have a
  4426. --- space in a directory name, precede it with an extra backslash, and
  4427. --- escape the space:
  4428. ---
  4429. --- ```vim
  4430. --- set path=.,/dir/with\\\ space
  4431. --- ```
  4432. --- - To include a comma in a directory name precede it with an extra
  4433. --- backslash:
  4434. ---
  4435. --- ```vim
  4436. --- set path=.,/dir/with\\,comma
  4437. --- ```
  4438. --- - To search relative to the directory of the current file, use:
  4439. ---
  4440. --- ```vim
  4441. --- set path=.
  4442. --- ```
  4443. --- - To search in the current directory use an empty string between two
  4444. --- commas:
  4445. ---
  4446. --- ```vim
  4447. --- set path=,,
  4448. --- ```
  4449. --- - A directory name may end in a ':' or '/'.
  4450. --- - Environment variables are expanded `:set_env`.
  4451. --- - When using `netrw.vim` URLs can be used. For example, adding
  4452. --- "https://www.vim.org" will make ":find index.html" work.
  4453. --- - Search upwards and downwards in a directory tree using "*", "**" and
  4454. --- ";". See `file-searching` for info and syntax.
  4455. --- - Careful with '\' characters, type two to get one in the option:
  4456. ---
  4457. --- ```vim
  4458. --- set path=.,c:\\include
  4459. --- ```
  4460. --- Or just use '/' instead:
  4461. ---
  4462. --- ```vim
  4463. --- set path=.,c:/include
  4464. --- ```
  4465. --- Don't forget "." or files won't even be found in the same directory as
  4466. --- the file!
  4467. --- The maximum length is limited. How much depends on the system, mostly
  4468. --- it is something like 256 or 1024 characters.
  4469. --- You can check if all the include files are found, using the value of
  4470. --- 'path', see `:checkpath`.
  4471. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  4472. --- directories from the list. This avoids problems when a future version
  4473. --- uses another default. To remove the current directory use:
  4474. ---
  4475. --- ```vim
  4476. --- set path-=
  4477. --- ```
  4478. --- To add the current directory use:
  4479. ---
  4480. --- ```vim
  4481. --- set path+=
  4482. --- ```
  4483. --- To use an environment variable, you probably need to replace the
  4484. --- separator. Here is an example to append $INCL, in which directory
  4485. --- names are separated with a semicolon:
  4486. ---
  4487. --- ```vim
  4488. --- let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
  4489. --- ```
  4490. --- Replace the ';' with a ':' or whatever separator is used. Note that
  4491. --- this doesn't work when $INCL contains a comma or white space.
  4492. ---
  4493. --- @type string
  4494. vim.o.path = ".,,"
  4495. vim.o.pa = vim.o.path
  4496. vim.bo.path = vim.o.path
  4497. vim.bo.pa = vim.bo.path
  4498. vim.go.path = vim.o.path
  4499. vim.go.pa = vim.go.path
  4500. --- When changing the indent of the current line, preserve as much of the
  4501. --- indent structure as possible. Normally the indent is replaced by a
  4502. --- series of tabs followed by spaces as required (unless `'expandtab'` is
  4503. --- enabled, in which case only spaces are used). Enabling this option
  4504. --- means the indent will preserve as many existing characters as possible
  4505. --- for indenting, and only add additional tabs or spaces as required.
  4506. --- 'expandtab' does not apply to the preserved white space, a Tab remains
  4507. --- a Tab.
  4508. --- NOTE: When using ">>" multiple times the resulting indent is a mix of
  4509. --- tabs and spaces. You might not like this.
  4510. --- Also see 'copyindent'.
  4511. --- Use `:retab` to clean up white space.
  4512. ---
  4513. --- @type boolean
  4514. vim.o.preserveindent = false
  4515. vim.o.pi = vim.o.preserveindent
  4516. vim.bo.preserveindent = vim.o.preserveindent
  4517. vim.bo.pi = vim.bo.preserveindent
  4518. --- Default height for a preview window. Used for `:ptag` and associated
  4519. --- commands. Used for `CTRL-W_}` when no count is given.
  4520. ---
  4521. --- @type integer
  4522. vim.o.previewheight = 12
  4523. vim.o.pvh = vim.o.previewheight
  4524. vim.go.previewheight = vim.o.previewheight
  4525. vim.go.pvh = vim.go.previewheight
  4526. --- Identifies the preview window. Only one window can have this option
  4527. --- set. It's normally not set directly, but by using one of the commands
  4528. --- `:ptag`, `:pedit`, etc.
  4529. ---
  4530. --- @type boolean
  4531. vim.o.previewwindow = false
  4532. vim.o.pvw = vim.o.previewwindow
  4533. vim.wo.previewwindow = vim.o.previewwindow
  4534. vim.wo.pvw = vim.wo.previewwindow
  4535. --- Enables pseudo-transparency for the `popup-menu`. Valid values are in
  4536. --- the range of 0 for fully opaque popupmenu (disabled) to 100 for fully
  4537. --- transparent background. Values between 0-30 are typically most useful.
  4538. ---
  4539. --- It is possible to override the level for individual highlights within
  4540. --- the popupmenu using `highlight-blend`. For instance, to enable
  4541. --- transparency but force the current selected element to be fully opaque:
  4542. ---
  4543. --- ```vim
  4544. ---
  4545. --- set pumblend=15
  4546. --- hi PmenuSel blend=0
  4547. --- ```
  4548. ---
  4549. --- UI-dependent. Works best with RGB colors. 'termguicolors'
  4550. ---
  4551. --- @type integer
  4552. vim.o.pumblend = 0
  4553. vim.o.pb = vim.o.pumblend
  4554. vim.go.pumblend = vim.o.pumblend
  4555. vim.go.pb = vim.go.pumblend
  4556. --- Maximum number of items to show in the popup menu
  4557. --- (`ins-completion-menu`). Zero means "use available screen space".
  4558. ---
  4559. --- @type integer
  4560. vim.o.pumheight = 0
  4561. vim.o.ph = vim.o.pumheight
  4562. vim.go.pumheight = vim.o.pumheight
  4563. vim.go.ph = vim.go.pumheight
  4564. --- Minimum width for the popup menu (`ins-completion-menu`). If the
  4565. --- cursor column + 'pumwidth' exceeds screen width, the popup menu is
  4566. --- nudged to fit on the screen.
  4567. ---
  4568. --- @type integer
  4569. vim.o.pumwidth = 15
  4570. vim.o.pw = vim.o.pumwidth
  4571. vim.go.pumwidth = vim.o.pumwidth
  4572. vim.go.pw = vim.go.pumwidth
  4573. --- Specifies the python version used for pyx* functions and commands
  4574. --- `python_x`. As only Python 3 is supported, this always has the value
  4575. --- `3`. Setting any other value is an error.
  4576. ---
  4577. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4578. --- security reasons.
  4579. ---
  4580. --- @type integer
  4581. vim.o.pyxversion = 3
  4582. vim.o.pyx = vim.o.pyxversion
  4583. vim.go.pyxversion = vim.o.pyxversion
  4584. vim.go.pyx = vim.go.pyxversion
  4585. --- This option specifies a function to be used to get the text to display
  4586. --- in the quickfix and location list windows. This can be used to
  4587. --- customize the information displayed in the quickfix or location window
  4588. --- for each entry in the corresponding quickfix or location list. See
  4589. --- `quickfix-window-function` for an explanation of how to write the
  4590. --- function and an example. The value can be the name of a function, a
  4591. --- `lambda` or a `Funcref`. See `option-value-function` for more
  4592. --- information.
  4593. ---
  4594. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4595. --- security reasons.
  4596. ---
  4597. --- @type string
  4598. vim.o.quickfixtextfunc = ""
  4599. vim.o.qftf = vim.o.quickfixtextfunc
  4600. vim.go.quickfixtextfunc = vim.o.quickfixtextfunc
  4601. vim.go.qftf = vim.go.quickfixtextfunc
  4602. --- The characters that are used to escape quotes in a string. Used for
  4603. --- objects like a', a" and a` `a'`.
  4604. --- When one of the characters in this option is found inside a string,
  4605. --- the following character will be skipped. The default value makes the
  4606. --- text "foo\"bar\\" considered to be one string.
  4607. ---
  4608. --- @type string
  4609. vim.o.quoteescape = "\\"
  4610. vim.o.qe = vim.o.quoteescape
  4611. vim.bo.quoteescape = vim.o.quoteescape
  4612. vim.bo.qe = vim.bo.quoteescape
  4613. --- If on, writes fail unless you use a '!'. Protects you from
  4614. --- accidentally overwriting a file. Default on when Vim is started
  4615. --- in read-only mode ("vim -R") or when the executable is called "view".
  4616. --- When using ":w!" the 'readonly' option is reset for the current
  4617. --- buffer, unless the 'Z' flag is in 'cpoptions'.
  4618. --- When using the ":view" command the 'readonly' option is set for the
  4619. --- newly edited buffer.
  4620. --- See 'modifiable' for disallowing changes to the buffer.
  4621. ---
  4622. --- @type boolean
  4623. vim.o.readonly = false
  4624. vim.o.ro = vim.o.readonly
  4625. vim.bo.readonly = vim.o.readonly
  4626. vim.bo.ro = vim.bo.readonly
  4627. --- Flags to change the way redrawing works, for debugging purposes.
  4628. --- Most useful with 'writedelay' set to some reasonable value.
  4629. --- Supports the following flags:
  4630. --- compositor Indicate each redraw event handled by the compositor
  4631. --- by briefly flashing the redrawn regions in colors
  4632. --- indicating the redraw type. These are the highlight
  4633. --- groups used (and their default colors):
  4634. --- RedrawDebugNormal gui=reverse normal redraw passed through
  4635. --- RedrawDebugClear guibg=Yellow clear event passed through
  4636. --- RedrawDebugComposed guibg=Green redraw event modified by the
  4637. --- compositor (due to
  4638. --- overlapping grids, etc)
  4639. --- RedrawDebugRecompose guibg=Red redraw generated by the
  4640. --- compositor itself, due to a
  4641. --- grid being moved or deleted.
  4642. --- line introduce a delay after each line drawn on the screen.
  4643. --- When using the TUI or another single-grid UI, "compositor"
  4644. --- gives more information and should be preferred (every
  4645. --- line is processed as a separate event by the compositor)
  4646. --- flush introduce a delay after each "flush" event.
  4647. --- nothrottle Turn off throttling of the message grid. This is an
  4648. --- optimization that joins many small scrolls to one
  4649. --- larger scroll when drawing the message area (with
  4650. --- 'display' msgsep flag active).
  4651. --- invalid Enable stricter checking (abort) of inconsistencies
  4652. --- of the internal screen state. This is mostly
  4653. --- useful when running nvim inside a debugger (and
  4654. --- the test suite).
  4655. --- nodelta Send all internally redrawn cells to the UI, even if
  4656. --- they are unchanged from the already displayed state.
  4657. ---
  4658. --- @type string
  4659. vim.o.redrawdebug = ""
  4660. vim.o.rdb = vim.o.redrawdebug
  4661. vim.go.redrawdebug = vim.o.redrawdebug
  4662. vim.go.rdb = vim.go.redrawdebug
  4663. --- Time in milliseconds for redrawing the display. Applies to
  4664. --- 'hlsearch', 'inccommand', `:match` highlighting, syntax highlighting,
  4665. --- and async `LanguageTree:parse()`.
  4666. --- When redrawing takes more than this many milliseconds no further
  4667. --- matches will be highlighted.
  4668. --- For syntax highlighting the time applies per window. When over the
  4669. --- limit syntax highlighting is disabled until `CTRL-L` is used.
  4670. --- This is used to avoid that Vim hangs when using a very complicated
  4671. --- pattern.
  4672. ---
  4673. --- @type integer
  4674. vim.o.redrawtime = 2000
  4675. vim.o.rdt = vim.o.redrawtime
  4676. vim.go.redrawtime = vim.o.redrawtime
  4677. vim.go.rdt = vim.go.redrawtime
  4678. --- This selects the default regexp engine. `two-engines`
  4679. --- The possible values are:
  4680. --- 0 automatic selection
  4681. --- 1 old engine
  4682. --- 2 NFA engine
  4683. --- Note that when using the NFA engine and the pattern contains something
  4684. --- that is not supported the pattern will not match. This is only useful
  4685. --- for debugging the regexp engine.
  4686. --- Using automatic selection enables Vim to switch the engine, if the
  4687. --- default engine becomes too costly. E.g., when the NFA engine uses too
  4688. --- many states. This should prevent Vim from hanging on a combination of
  4689. --- a complex pattern with long text.
  4690. ---
  4691. --- @type integer
  4692. vim.o.regexpengine = 0
  4693. vim.o.re = vim.o.regexpengine
  4694. vim.go.regexpengine = vim.o.regexpengine
  4695. vim.go.re = vim.go.regexpengine
  4696. --- Show the line number relative to the line with the cursor in front of
  4697. --- each line. Relative line numbers help you use the `count` you can
  4698. --- precede some vertical motion commands (e.g. j k + -) with, without
  4699. --- having to calculate it yourself. Especially useful in combination with
  4700. --- other commands (e.g. y d c < > gq gw =).
  4701. --- When the 'n' option is excluded from 'cpoptions' a wrapped
  4702. --- line will not use the column of line numbers.
  4703. --- The 'numberwidth' option can be used to set the room used for the line
  4704. --- number.
  4705. --- When a long, wrapped line doesn't start with the first character, '-'
  4706. --- characters are put before the number.
  4707. --- See `hl-LineNr` and `hl-CursorLineNr` for the highlighting used for
  4708. --- the number.
  4709. ---
  4710. --- The number in front of the cursor line also depends on the value of
  4711. --- 'number', see `number_relativenumber` for all combinations of the two
  4712. --- options.
  4713. ---
  4714. --- @type boolean
  4715. vim.o.relativenumber = false
  4716. vim.o.rnu = vim.o.relativenumber
  4717. vim.wo.relativenumber = vim.o.relativenumber
  4718. vim.wo.rnu = vim.wo.relativenumber
  4719. --- Threshold for reporting number of lines changed. When the number of
  4720. --- changed lines is more than 'report' a message will be given for most
  4721. --- ":" commands. If you want it always, set 'report' to 0.
  4722. --- For the ":substitute" command the number of substitutions is used
  4723. --- instead of the number of lines.
  4724. ---
  4725. --- @type integer
  4726. vim.o.report = 2
  4727. vim.go.report = vim.o.report
  4728. --- Inserting characters in Insert mode will work backwards. See "typing
  4729. --- backwards" `ins-reverse`. This option can be toggled with the CTRL-_
  4730. --- command in Insert mode, when 'allowrevins' is set.
  4731. ---
  4732. --- @type boolean
  4733. vim.o.revins = false
  4734. vim.o.ri = vim.o.revins
  4735. vim.go.revins = vim.o.revins
  4736. vim.go.ri = vim.go.revins
  4737. --- When on, display orientation becomes right-to-left, i.e., characters
  4738. --- that are stored in the file appear from the right to the left.
  4739. --- Using this option, it is possible to edit files for languages that
  4740. --- are written from the right to the left such as Hebrew and Arabic.
  4741. --- This option is per window, so it is possible to edit mixed files
  4742. --- simultaneously, or to view the same file in both ways (this is
  4743. --- useful whenever you have a mixed text file with both right-to-left
  4744. --- and left-to-right strings so that both sets are displayed properly
  4745. --- in different windows). Also see `rileft.txt`.
  4746. ---
  4747. --- @type boolean
  4748. vim.o.rightleft = false
  4749. vim.o.rl = vim.o.rightleft
  4750. vim.wo.rightleft = vim.o.rightleft
  4751. vim.wo.rl = vim.wo.rightleft
  4752. --- Each word in this option enables the command line editing to work in
  4753. --- right-to-left mode for a group of commands:
  4754. ---
  4755. --- search "/" and "?" commands
  4756. ---
  4757. --- This is useful for languages such as Hebrew, Arabic and Farsi.
  4758. --- The 'rightleft' option must be set for 'rightleftcmd' to take effect.
  4759. ---
  4760. --- @type string
  4761. vim.o.rightleftcmd = "search"
  4762. vim.o.rlc = vim.o.rightleftcmd
  4763. vim.wo.rightleftcmd = vim.o.rightleftcmd
  4764. vim.wo.rlc = vim.wo.rightleftcmd
  4765. --- Show the line and column number of the cursor position, separated by a
  4766. --- comma. When there is room, the relative position of the displayed
  4767. --- text in the file is shown on the far right:
  4768. --- Top first line is visible
  4769. --- Bot last line is visible
  4770. --- All first and last line are visible
  4771. --- 45% relative position in the file
  4772. --- If 'rulerformat' is set, it will determine the contents of the ruler.
  4773. --- Each window has its own ruler. If a window has a status line, the
  4774. --- ruler is shown there. If a window doesn't have a status line and
  4775. --- 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
  4776. --- the last line of the screen. If the statusline is given by
  4777. --- 'statusline' (i.e. not empty), this option takes precedence over
  4778. --- 'ruler' and 'rulerformat'.
  4779. --- If the number of characters displayed is different from the number of
  4780. --- bytes in the text (e.g., for a TAB or a multibyte character), both
  4781. --- the text column (byte number) and the screen column are shown,
  4782. --- separated with a dash.
  4783. --- For an empty line "0-1" is shown.
  4784. --- For an empty buffer the line number will also be zero: "0,0-1".
  4785. --- If you don't want to see the ruler all the time but want to know where
  4786. --- you are, use "g CTRL-G" `g_CTRL-G`.
  4787. ---
  4788. --- @type boolean
  4789. vim.o.ruler = true
  4790. vim.o.ru = vim.o.ruler
  4791. vim.go.ruler = vim.o.ruler
  4792. vim.go.ru = vim.go.ruler
  4793. --- When this option is not empty, it determines the content of the ruler
  4794. --- string, as displayed for the 'ruler' option.
  4795. --- The format of this option is like that of 'statusline'.
  4796. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  4797. ---
  4798. --- The default ruler width is 17 characters. To make the ruler 15
  4799. --- characters wide, put "%15(" at the start and "%)" at the end.
  4800. --- Example:
  4801. ---
  4802. --- ```vim
  4803. --- set rulerformat=%15(%c%V\ %p%%%)
  4804. --- ```
  4805. ---
  4806. ---
  4807. --- @type string
  4808. vim.o.rulerformat = ""
  4809. vim.o.ruf = vim.o.rulerformat
  4810. vim.go.rulerformat = vim.o.rulerformat
  4811. vim.go.ruf = vim.go.rulerformat
  4812. --- List of directories to be searched for these runtime files:
  4813. --- filetype.lua filetypes `new-filetype`
  4814. --- autoload/ automatically loaded scripts `autoload-functions`
  4815. --- colors/ color scheme files `:colorscheme`
  4816. --- compiler/ compiler files `:compiler`
  4817. --- doc/ documentation `write-local-help`
  4818. --- ftplugin/ filetype plugins `write-filetype-plugin`
  4819. --- indent/ indent scripts `indent-expression`
  4820. --- keymap/ key mapping files `mbyte-keymap`
  4821. --- lang/ menu translations `:menutrans`
  4822. --- lsp/ LSP client configurations `lsp-config`
  4823. --- lua/ `Lua` plugins
  4824. --- menu.vim GUI menus `menu.vim`
  4825. --- pack/ packages `:packadd`
  4826. --- parser/ `treesitter` syntax parsers
  4827. --- plugin/ plugin scripts `write-plugin`
  4828. --- queries/ `treesitter` queries
  4829. --- rplugin/ `remote-plugin` scripts
  4830. --- spell/ spell checking files `spell`
  4831. --- syntax/ syntax files `mysyntaxfile`
  4832. --- tutor/ tutorial files `:Tutor`
  4833. ---
  4834. --- And any other file searched for with the `:runtime` command.
  4835. ---
  4836. --- Defaults are setup to search these locations:
  4837. --- 1. Your home directory, for personal preferences.
  4838. --- Given by `stdpath("config")`. `$XDG_CONFIG_HOME`
  4839. --- 2. Directories which must contain configuration files according to
  4840. --- `xdg` ($XDG_CONFIG_DIRS, defaults to /etc/xdg). This also contains
  4841. --- preferences from system administrator.
  4842. --- 3. Data home directory, for plugins installed by user.
  4843. --- Given by `stdpath("data")/site`. `$XDG_DATA_HOME`
  4844. --- 4. nvim/site subdirectories for each directory in $XDG_DATA_DIRS.
  4845. --- This is for plugins which were installed by system administrator,
  4846. --- but are not part of the Nvim distribution. XDG_DATA_DIRS defaults
  4847. --- to /usr/local/share/:/usr/share/, so system administrators are
  4848. --- expected to install site plugins to /usr/share/nvim/site.
  4849. --- 5. Session state directory, for state data such as swap, backupdir,
  4850. --- viewdir, undodir, etc.
  4851. --- Given by `stdpath("state")`. `$XDG_STATE_HOME`
  4852. --- 6. $VIMRUNTIME, for files distributed with Nvim.
  4853. --- *after-directory*
  4854. --- 7, 8, 9, 10. In after/ subdirectories of 1, 2, 3 and 4, with reverse
  4855. --- ordering. This is for preferences to overrule or add to the
  4856. --- distributed defaults or system-wide settings (rarely needed).
  4857. ---
  4858. --- *packages-runtimepath*
  4859. --- "start" packages will also be searched (`runtime-search-path`) for
  4860. --- runtime files after these, though such packages are not explicitly
  4861. --- reported in &runtimepath. But "opt" packages are explicitly added to
  4862. --- &runtimepath by `:packadd`.
  4863. ---
  4864. --- Note that, unlike 'path', no wildcards like "**" are allowed. Normal
  4865. --- wildcards are allowed, but can significantly slow down searching for
  4866. --- runtime files. For speed, use as few items as possible and avoid
  4867. --- wildcards.
  4868. --- See `:runtime`.
  4869. --- Example:
  4870. ---
  4871. --- ```vim
  4872. --- set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
  4873. --- ```
  4874. --- This will use the directory "~/vimruntime" first (containing your
  4875. --- personal Nvim runtime files), then "/mygroup/vim", and finally
  4876. --- "$VIMRUNTIME" (the default runtime files).
  4877. --- You can put a directory before $VIMRUNTIME to find files which replace
  4878. --- distributed runtime files. You can put a directory after $VIMRUNTIME
  4879. --- to find files which add to distributed runtime files.
  4880. ---
  4881. --- With `--clean` the home directory entries are not included.
  4882. ---
  4883. --- @type string
  4884. vim.o.runtimepath = "..."
  4885. vim.o.rtp = vim.o.runtimepath
  4886. vim.go.runtimepath = vim.o.runtimepath
  4887. vim.go.rtp = vim.go.runtimepath
  4888. --- Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
  4889. --- set to half the number of lines in the window when the window size
  4890. --- changes. This may happen when enabling the `status-line` or
  4891. --- 'tabline' option after setting the 'scroll' option.
  4892. --- If you give a count to the CTRL-U or CTRL-D command it will
  4893. --- be used as the new value for 'scroll'. Reset to half the window
  4894. --- height with ":set scroll=0".
  4895. ---
  4896. --- @type integer
  4897. vim.o.scroll = 0
  4898. vim.o.scr = vim.o.scroll
  4899. vim.wo.scroll = vim.o.scroll
  4900. vim.wo.scr = vim.wo.scroll
  4901. --- Maximum number of lines kept beyond the visible screen. Lines at the
  4902. --- top are deleted if new lines exceed this limit.
  4903. --- Minimum is 1, maximum is 100000.
  4904. --- Only in `terminal` buffers.
  4905. ---
  4906. --- Note: Lines that are not visible and kept in scrollback are not
  4907. --- reflown when the terminal buffer is resized horizontally.
  4908. ---
  4909. --- @type integer
  4910. vim.o.scrollback = -1
  4911. vim.o.scbk = vim.o.scrollback
  4912. vim.bo.scrollback = vim.o.scrollback
  4913. vim.bo.scbk = vim.bo.scrollback
  4914. --- See also `scroll-binding`. When this option is set, scrolling the
  4915. --- current window also scrolls other scrollbind windows (windows that
  4916. --- also have this option set). This option is useful for viewing the
  4917. --- differences between two versions of a file, see 'diff'.
  4918. --- See `'scrollopt'` for options that determine how this option should be
  4919. --- interpreted.
  4920. --- This option is mostly reset when splitting a window to edit another
  4921. --- file. This means that ":split | edit file" results in two windows
  4922. --- with scroll-binding, but ":split file" does not.
  4923. ---
  4924. --- @type boolean
  4925. vim.o.scrollbind = false
  4926. vim.o.scb = vim.o.scrollbind
  4927. vim.wo.scrollbind = vim.o.scrollbind
  4928. vim.wo.scb = vim.wo.scrollbind
  4929. --- Minimal number of lines to scroll when the cursor gets off the
  4930. --- screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
  4931. --- CTRL-D). Useful if your terminal scrolls very slowly.
  4932. --- When set to a negative number from -1 to -100 this is used as the
  4933. --- percentage of the window height. Thus -50 scrolls half the window
  4934. --- height.
  4935. ---
  4936. --- @type integer
  4937. vim.o.scrolljump = 1
  4938. vim.o.sj = vim.o.scrolljump
  4939. vim.go.scrolljump = vim.o.scrolljump
  4940. vim.go.sj = vim.go.scrolljump
  4941. --- Minimal number of screen lines to keep above and below the cursor.
  4942. --- This will make some context visible around where you are working. If
  4943. --- you set it to a very large value (999) the cursor line will always be
  4944. --- in the middle of the window (except at the start or end of the file or
  4945. --- when long lines wrap).
  4946. --- After using the local value, go back the global value with one of
  4947. --- these two:
  4948. ---
  4949. --- ```vim
  4950. --- setlocal scrolloff<
  4951. --- setlocal scrolloff=-1
  4952. --- ```
  4953. --- For scrolling horizontally see 'sidescrolloff'.
  4954. ---
  4955. --- @type integer
  4956. vim.o.scrolloff = 0
  4957. vim.o.so = vim.o.scrolloff
  4958. vim.wo.scrolloff = vim.o.scrolloff
  4959. vim.wo.so = vim.wo.scrolloff
  4960. vim.go.scrolloff = vim.o.scrolloff
  4961. vim.go.so = vim.go.scrolloff
  4962. --- This is a comma-separated list of words that specifies how
  4963. --- 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
  4964. --- Options.
  4965. --- The following words are available:
  4966. --- ver Bind vertical scrolling for 'scrollbind' windows
  4967. --- hor Bind horizontal scrolling for 'scrollbind' windows
  4968. --- jump Applies to the offset between two windows for vertical
  4969. --- scrolling. This offset is the difference in the first
  4970. --- displayed line of the bound windows. When moving
  4971. --- around in a window, another 'scrollbind' window may
  4972. --- reach a position before the start or after the end of
  4973. --- the buffer. The offset is not changed though, when
  4974. --- moving back the 'scrollbind' window will try to scroll
  4975. --- to the desired position when possible.
  4976. --- When now making that window the current one, two
  4977. --- things can be done with the relative offset:
  4978. --- 1. When "jump" is not included, the relative offset is
  4979. --- adjusted for the scroll position in the new current
  4980. --- window. When going back to the other window, the
  4981. --- new relative offset will be used.
  4982. --- 2. When "jump" is included, the other windows are
  4983. --- scrolled to keep the same relative offset. When
  4984. --- going back to the other window, it still uses the
  4985. --- same relative offset.
  4986. --- Also see `scroll-binding`.
  4987. --- When 'diff' mode is active there always is vertical scroll binding,
  4988. --- even when "ver" isn't there.
  4989. ---
  4990. --- @type string
  4991. vim.o.scrollopt = "ver,jump"
  4992. vim.o.sbo = vim.o.scrollopt
  4993. vim.go.scrollopt = vim.o.scrollopt
  4994. vim.go.sbo = vim.go.scrollopt
  4995. --- Specifies the nroff macros that separate sections. These are pairs of
  4996. --- two letters (See `object-motions`). The default makes a section start
  4997. --- at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
  4998. ---
  4999. --- @type string
  5000. vim.o.sections = "SHNHH HUnhsh"
  5001. vim.o.sect = vim.o.sections
  5002. vim.go.sections = vim.o.sections
  5003. vim.go.sect = vim.go.sections
  5004. --- This option defines the behavior of the selection. It is only used
  5005. --- in Visual and Select mode.
  5006. --- Possible values:
  5007. --- value past line inclusive ~
  5008. --- old no yes
  5009. --- inclusive yes yes
  5010. --- exclusive yes no
  5011. --- "past line" means that the cursor is allowed to be positioned one
  5012. --- character past the line.
  5013. --- "inclusive" means that the last character of the selection is included
  5014. --- in an operation. For example, when "x" is used to delete the
  5015. --- selection.
  5016. --- When "old" is used and 'virtualedit' allows the cursor to move past
  5017. --- the end of line the line break still isn't included.
  5018. --- When "exclusive" is used, cursor position in visual mode will be
  5019. --- adjusted for inclusive motions `inclusive-motion-selection-exclusive`.
  5020. --- Note that when "exclusive" is used and selecting from the end
  5021. --- backwards, you cannot include the last character of a line, when
  5022. --- starting in Normal mode and 'virtualedit' empty.
  5023. ---
  5024. --- @type 'inclusive'|'exclusive'|'old'
  5025. vim.o.selection = "inclusive"
  5026. vim.o.sel = vim.o.selection
  5027. vim.go.selection = vim.o.selection
  5028. vim.go.sel = vim.go.selection
  5029. --- This is a comma-separated list of words, which specifies when to start
  5030. --- Select mode instead of Visual mode, when a selection is started.
  5031. --- Possible values:
  5032. --- mouse when using the mouse
  5033. --- key when using shifted special keys
  5034. --- cmd when using "v", "V" or CTRL-V
  5035. --- See `Select-mode`.
  5036. ---
  5037. --- @type string
  5038. vim.o.selectmode = ""
  5039. vim.o.slm = vim.o.selectmode
  5040. vim.go.selectmode = vim.o.selectmode
  5041. vim.go.slm = vim.go.selectmode
  5042. --- Changes the effect of the `:mksession` command. It is a comma-
  5043. --- separated list of words. Each word enables saving and restoring
  5044. --- something:
  5045. --- word save and restore ~
  5046. --- blank empty windows
  5047. --- buffers hidden and unloaded buffers, not just those in windows
  5048. --- curdir the current directory
  5049. --- folds manually created folds, opened/closed folds and local
  5050. --- fold options
  5051. --- globals global variables that start with an uppercase letter
  5052. --- and contain at least one lowercase letter. Only
  5053. --- String and Number types are stored.
  5054. --- help the help window
  5055. --- localoptions options and mappings local to a window or buffer (not
  5056. --- global values for local options)
  5057. --- options all options and mappings (also global values for local
  5058. --- options)
  5059. --- skiprtp exclude 'runtimepath' and 'packpath' from the options
  5060. --- resize size of the Vim window: 'lines' and 'columns'
  5061. --- sesdir the directory in which the session file is located
  5062. --- will become the current directory (useful with
  5063. --- projects accessed over a network from different
  5064. --- systems)
  5065. --- tabpages all tab pages; without this only the current tab page
  5066. --- is restored, so that you can make a session for each
  5067. --- tab page separately
  5068. --- terminal include terminal windows where the command can be
  5069. --- restored
  5070. --- winpos position of the whole Vim window
  5071. --- winsize window sizes
  5072. --- slash `deprecated` Always enabled. Uses "/" in filenames.
  5073. --- unix `deprecated` Always enabled. Uses "\n" line endings.
  5074. ---
  5075. --- Don't include both "curdir" and "sesdir". When neither is included
  5076. --- filenames are stored as absolute paths.
  5077. --- If you leave out "options" many things won't work well after restoring
  5078. --- the session.
  5079. ---
  5080. --- @type string
  5081. vim.o.sessionoptions = "blank,buffers,curdir,folds,help,tabpages,winsize,terminal"
  5082. vim.o.ssop = vim.o.sessionoptions
  5083. vim.go.sessionoptions = vim.o.sessionoptions
  5084. vim.go.ssop = vim.go.sessionoptions
  5085. --- When non-empty, the shada file is read upon startup and written
  5086. --- when exiting Vim (see `shada-file`). The string should be a comma-
  5087. --- separated list of parameters, each consisting of a single character
  5088. --- identifying the particular parameter, followed by a number or string
  5089. --- which specifies the value of that parameter. If a particular
  5090. --- character is left out, then the default value is used for that
  5091. --- parameter. The following is a list of the identifying characters and
  5092. --- the effect of their value.
  5093. --- CHAR VALUE ~
  5094. --- *shada-!*
  5095. --- ! When included, save and restore global variables that start
  5096. --- with an uppercase letter, and don't contain a lowercase
  5097. --- letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
  5098. --- and "_K_L_M" are not. Nested List and Dict items may not be
  5099. --- read back correctly, you end up with an empty item.
  5100. --- *shada-quote*
  5101. --- " Maximum number of lines saved for each register. Old name of
  5102. --- the '<' item, with the disadvantage that you need to put a
  5103. --- backslash before the ", otherwise it will be recognized as the
  5104. --- start of a comment!
  5105. --- *shada-%*
  5106. --- % When included, save and restore the buffer list. If Vim is
  5107. --- started with a file name argument, the buffer list is not
  5108. --- restored. If Vim is started without a file name argument, the
  5109. --- buffer list is restored from the shada file. Quickfix
  5110. --- ('buftype'), unlisted ('buflisted'), unnamed and buffers on
  5111. --- removable media (`shada-r`) are not saved.
  5112. --- When followed by a number, the number specifies the maximum
  5113. --- number of buffers that are stored. Without a number all
  5114. --- buffers are stored.
  5115. --- *shada-'*
  5116. --- ' Maximum number of previously edited files for which the marks
  5117. --- are remembered. This parameter must always be included when
  5118. --- 'shada' is non-empty.
  5119. --- Including this item also means that the `jumplist` and the
  5120. --- `changelist` are stored in the shada file.
  5121. --- *shada-/*
  5122. --- / Maximum number of items in the search pattern history to be
  5123. --- saved. If non-zero, then the previous search and substitute
  5124. --- patterns are also saved. When not included, the value of
  5125. --- 'history' is used.
  5126. --- *shada-:*
  5127. --- : Maximum number of items in the command-line history to be
  5128. --- saved. When not included, the value of 'history' is used.
  5129. --- *shada-<*
  5130. --- \< Maximum number of lines saved for each register. If zero then
  5131. --- registers are not saved. When not included, all lines are
  5132. --- saved. '"' is the old name for this item.
  5133. --- Also see the 's' item below: limit specified in KiB.
  5134. --- *shada-@*
  5135. --- @ Maximum number of items in the input-line history to be
  5136. --- saved. When not included, the value of 'history' is used.
  5137. --- *shada-c*
  5138. --- c Dummy option, kept for compatibility reasons. Has no actual
  5139. --- effect: ShaDa always uses UTF-8 and 'encoding' value is fixed
  5140. --- to UTF-8 as well.
  5141. --- *shada-f*
  5142. --- f Whether file marks need to be stored. If zero, file marks ('0
  5143. --- to '9, 'A to 'Z) are not stored. When not present or when
  5144. --- non-zero, they are all stored. '0 is used for the current
  5145. --- cursor position (when exiting or when doing `:wshada`).
  5146. --- *shada-h*
  5147. --- h Disable the effect of 'hlsearch' when loading the shada
  5148. --- file. When not included, it depends on whether ":nohlsearch"
  5149. --- has been used since the last search command.
  5150. --- *shada-n*
  5151. --- n Name of the shada file. The name must immediately follow
  5152. --- the 'n'. Must be at the end of the option! If the
  5153. --- 'shadafile' option is set, that file name overrides the one
  5154. --- given here with 'shada'. Environment variables are
  5155. --- expanded when opening the file, not when setting the option.
  5156. --- *shada-r*
  5157. --- r Removable media. The argument is a string (up to the next
  5158. --- ','). This parameter can be given several times. Each
  5159. --- specifies the start of a path for which no marks will be
  5160. --- stored. This is to avoid removable media. For Windows you
  5161. --- could use "ra:,rb:". You can also use it for temp files,
  5162. --- e.g., for Unix: "r/tmp". Case is ignored.
  5163. --- *shada-s*
  5164. --- s Maximum size of an item contents in KiB. If zero then nothing
  5165. --- is saved. Unlike Vim this applies to all items, except for
  5166. --- the buffer list and header. Full item size is off by three
  5167. --- unsigned integers: with `s10` maximum item size may be 1 byte
  5168. --- (type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit
  5169. --- integer) + 3 bytes (item size: up to 16-bit integer because
  5170. --- 2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item
  5171. --- contents size) = 10253 bytes.
  5172. ---
  5173. --- Example:
  5174. ---
  5175. --- ```vim
  5176. --- set shada='50,<1000,s100,:0,n~/nvim/shada
  5177. --- ```
  5178. ---
  5179. --- '50 Marks will be remembered for the last 50 files you
  5180. --- edited.
  5181. --- <1000 Contents of registers (up to 1000 lines each) will be
  5182. --- remembered.
  5183. --- s100 Items with contents occupying more then 100 KiB are
  5184. --- skipped.
  5185. --- :0 Command-line history will not be saved.
  5186. --- n~/nvim/shada The name of the file to use is "~/nvim/shada".
  5187. --- no / Since '/' is not specified, the default will be used,
  5188. --- that is, save all of the search history, and also the
  5189. --- previous search and substitute patterns.
  5190. --- no % The buffer list will not be saved nor read back.
  5191. --- no h 'hlsearch' highlighting will be restored.
  5192. ---
  5193. --- When setting 'shada' from an empty value you can use `:rshada` to
  5194. --- load the contents of the file, this is not done automatically.
  5195. ---
  5196. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5197. --- security reasons.
  5198. ---
  5199. --- @type string
  5200. vim.o.shada = "!,'100,<50,s10,h"
  5201. vim.o.sd = vim.o.shada
  5202. vim.go.shada = vim.o.shada
  5203. vim.go.sd = vim.go.shada
  5204. --- When non-empty, overrides the file name used for `shada` (viminfo).
  5205. --- When equal to "NONE" no shada file will be read or written.
  5206. --- This option can be set with the `-i` command line flag. The `--clean`
  5207. --- command line flag sets it to "NONE".
  5208. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5209. --- security reasons.
  5210. ---
  5211. --- @type string
  5212. vim.o.shadafile = ""
  5213. vim.o.sdf = vim.o.shadafile
  5214. vim.go.shadafile = vim.o.shadafile
  5215. vim.go.sdf = vim.go.shadafile
  5216. --- Name of the shell to use for ! and :! commands. When changing the
  5217. --- value also check these options: 'shellpipe', 'shellslash'
  5218. --- 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
  5219. --- It is allowed to give an argument to the command, e.g. "csh -f".
  5220. --- See `option-backslash` about including spaces and backslashes.
  5221. --- Environment variables are expanded `:set_env`.
  5222. ---
  5223. --- If the name of the shell contains a space, you need to enclose it in
  5224. --- quotes. Example with quotes:
  5225. ---
  5226. --- ```vim
  5227. --- set shell=\"c:\program\ files\unix\sh.exe\"\ -f
  5228. --- ```
  5229. --- Note the backslash before each quote (to avoid starting a comment) and
  5230. --- each space (to avoid ending the option value), so better use `:let-&`
  5231. --- like this:
  5232. ---
  5233. --- ```vim
  5234. --- let &shell='"C:\Program Files\unix\sh.exe" -f'
  5235. --- ```
  5236. --- Also note that the "-f" is not inside the quotes, because it is not
  5237. --- part of the command name.
  5238. --- *shell-unquoting*
  5239. --- Rules regarding quotes:
  5240. --- 1. Option is split on space and tab characters that are not inside
  5241. --- quotes: "abc def" runs shell named "abc" with additional argument
  5242. --- "def", '"abc def"' runs shell named "abc def" with no additional
  5243. --- arguments (here and below: additional means “additional to
  5244. --- 'shellcmdflag'”).
  5245. --- 2. Quotes in option may be present in any position and any number:
  5246. --- '"abc"', '"a"bc', 'a"b"c', 'ab"c"' and '"a"b"c"' are all equivalent
  5247. --- to just "abc".
  5248. --- 3. Inside quotes backslash preceding backslash means one backslash.
  5249. --- Backslash preceding quote means one quote. Backslash preceding
  5250. --- anything else means backslash and next character literally:
  5251. --- '"a\\b"' is the same as "a\b", '"a\\"b"' runs shell named literally
  5252. --- 'a"b', '"a\b"' is the same as "a\b" again.
  5253. --- 4. Outside of quotes backslash always means itself, it cannot be used
  5254. --- to escape quote: 'a\"b"' is the same as "a\b".
  5255. --- Note that such processing is done after `:set` did its own round of
  5256. --- unescaping, so to keep yourself sane use `:let-&` like shown above.
  5257. --- *shell-powershell*
  5258. --- To use PowerShell:
  5259. ---
  5260. --- ```vim
  5261. --- let &shell = executable('pwsh') ? 'pwsh' : 'powershell'
  5262. --- let &shellcmdflag = '-NoLogo -NonInteractive -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.UTF8Encoding]::new();$PSDefaultParameterValues[''Out-File:Encoding'']=''utf8'';$PSStyle.OutputRendering=''plaintext'';Remove-Alias -Force -ErrorAction SilentlyContinue tee;'
  5263. --- let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode'
  5264. --- let &shellpipe = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode'
  5265. --- set shellquote= shellxquote=
  5266. --- ```
  5267. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5268. --- security reasons.
  5269. ---
  5270. --- @type string
  5271. vim.o.shell = "sh"
  5272. vim.o.sh = vim.o.shell
  5273. vim.go.shell = vim.o.shell
  5274. vim.go.sh = vim.go.shell
  5275. --- Flag passed to the shell to execute "!" and ":!" commands; e.g.,
  5276. --- `bash.exe -c ls` or `cmd.exe /s /c "dir"`. For MS-Windows, the
  5277. --- default is set according to the value of 'shell', to reduce the need
  5278. --- to set this option by the user.
  5279. --- On Unix it can have more than one flag. Each white space separated
  5280. --- part is passed as an argument to the shell command.
  5281. --- See `option-backslash` about including spaces and backslashes.
  5282. --- See `shell-unquoting` which talks about separating this option into
  5283. --- multiple arguments.
  5284. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5285. --- security reasons.
  5286. ---
  5287. --- @type string
  5288. vim.o.shellcmdflag = "-c"
  5289. vim.o.shcf = vim.o.shellcmdflag
  5290. vim.go.shellcmdflag = vim.o.shellcmdflag
  5291. vim.go.shcf = vim.go.shellcmdflag
  5292. --- String to be used to put the output of the ":make" command in the
  5293. --- error file. See also `:make_makeprg`. See `option-backslash` about
  5294. --- including spaces and backslashes.
  5295. --- The name of the temporary file can be represented by "%s" if necessary
  5296. --- (the file name is appended automatically if no %s appears in the value
  5297. --- of this option).
  5298. --- For MS-Windows the default is "2>&1| tee". The stdout and stderr are
  5299. --- saved in a file and echoed to the screen.
  5300. --- For Unix the default is "| tee". The stdout of the compiler is saved
  5301. --- in a file and echoed to the screen. If the 'shell' option is "csh" or
  5302. --- "tcsh" after initializations, the default becomes "|& tee". If the
  5303. --- 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  5304. --- "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
  5305. --- means that stderr is also included. Before using the 'shell' option a
  5306. --- path is removed, thus "/bin/sh" uses "sh".
  5307. --- The initialization of this option is done after reading the vimrc
  5308. --- and the other initializations, so that when the 'shell' option is set
  5309. --- there, the 'shellpipe' option changes automatically, unless it was
  5310. --- explicitly set before.
  5311. --- When 'shellpipe' is set to an empty string, no redirection of the
  5312. --- ":make" output will be done. This is useful if you use a 'makeprg'
  5313. --- that writes to 'makeef' by itself. If you want no piping, but do
  5314. --- want to include the 'makeef', set 'shellpipe' to a single space.
  5315. --- Don't forget to precede the space with a backslash: ":set sp=\ ".
  5316. --- In the future pipes may be used for filtering and this option will
  5317. --- become obsolete (at least for Unix).
  5318. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5319. --- security reasons.
  5320. ---
  5321. --- @type string
  5322. vim.o.shellpipe = "| tee"
  5323. vim.o.sp = vim.o.shellpipe
  5324. vim.go.shellpipe = vim.o.shellpipe
  5325. vim.go.sp = vim.go.shellpipe
  5326. --- Quoting character(s), put around the command passed to the shell, for
  5327. --- the "!" and ":!" commands. The redirection is kept outside of the
  5328. --- quoting. See 'shellxquote' to include the redirection. It's
  5329. --- probably not useful to set both options.
  5330. --- This is an empty string by default. Only known to be useful for
  5331. --- third-party shells on Windows systems, such as the MKS Korn Shell
  5332. --- or bash, where it should be "\"". The default is adjusted according
  5333. --- the value of 'shell', to reduce the need to set this option by the
  5334. --- user.
  5335. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5336. --- security reasons.
  5337. ---
  5338. --- @type string
  5339. vim.o.shellquote = ""
  5340. vim.o.shq = vim.o.shellquote
  5341. vim.go.shellquote = vim.o.shellquote
  5342. vim.go.shq = vim.go.shellquote
  5343. --- String to be used to put the output of a filter command in a temporary
  5344. --- file. See also `:!`. See `option-backslash` about including spaces
  5345. --- and backslashes.
  5346. --- The name of the temporary file can be represented by "%s" if necessary
  5347. --- (the file name is appended automatically if no %s appears in the value
  5348. --- of this option).
  5349. --- The default is ">". For Unix, if the 'shell' option is "csh" or
  5350. --- "tcsh" during initializations, the default becomes ">&". If the
  5351. --- 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  5352. --- "bash" or "fish", the default becomes ">%s 2>&1". This means that
  5353. --- stderr is also included. For Win32, the Unix checks are done and
  5354. --- additionally "cmd" is checked for, which makes the default ">%s 2>&1".
  5355. --- Also, the same names with ".exe" appended are checked for.
  5356. --- The initialization of this option is done after reading the vimrc
  5357. --- and the other initializations, so that when the 'shell' option is set
  5358. --- there, the 'shellredir' option changes automatically unless it was
  5359. --- explicitly set before.
  5360. --- In the future pipes may be used for filtering and this option will
  5361. --- become obsolete (at least for Unix).
  5362. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5363. --- security reasons.
  5364. ---
  5365. --- @type string
  5366. vim.o.shellredir = ">"
  5367. vim.o.srr = vim.o.shellredir
  5368. vim.go.shellredir = vim.o.shellredir
  5369. vim.go.srr = vim.go.shellredir
  5370. --- only modifiable in MS-Windows
  5371. --- When set, a forward slash is used when expanding file names. This is
  5372. --- useful when a Unix-like shell is used instead of cmd.exe. Backward
  5373. --- slashes can still be typed, but they are changed to forward slashes by
  5374. --- Vim.
  5375. --- Note that setting or resetting this option has no effect for some
  5376. --- existing file names, thus this option needs to be set before opening
  5377. --- any file for best results. This might change in the future.
  5378. --- 'shellslash' only works when a backslash can be used as a path
  5379. --- separator. To test if this is so use:
  5380. ---
  5381. --- ```vim
  5382. --- if exists('+shellslash')
  5383. --- ```
  5384. --- Also see 'completeslash'.
  5385. ---
  5386. --- @type boolean
  5387. vim.o.shellslash = true
  5388. vim.o.ssl = vim.o.shellslash
  5389. vim.go.shellslash = vim.o.shellslash
  5390. vim.go.ssl = vim.go.shellslash
  5391. --- When on, use temp files for shell commands. When off use a pipe.
  5392. --- When using a pipe is not possible temp files are used anyway.
  5393. --- The advantage of using a pipe is that nobody can read the temp file
  5394. --- and the 'shell' command does not need to support redirection.
  5395. --- The advantage of using a temp file is that the file type and encoding
  5396. --- can be detected.
  5397. --- The `FilterReadPre`, `FilterReadPost` and `FilterWritePre|,
  5398. --- |FilterWritePost` autocommands event are not triggered when
  5399. --- 'shelltemp' is off.
  5400. --- `system()` does not respect this option, it always uses pipes.
  5401. ---
  5402. --- @type boolean
  5403. vim.o.shelltemp = true
  5404. vim.o.stmp = vim.o.shelltemp
  5405. vim.go.shelltemp = vim.o.shelltemp
  5406. vim.go.stmp = vim.go.shelltemp
  5407. --- When 'shellxquote' is set to "(" then the characters listed in this
  5408. --- option will be escaped with a '^' character. This makes it possible
  5409. --- to execute most external commands with cmd.exe.
  5410. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5411. --- security reasons.
  5412. ---
  5413. --- @type string
  5414. vim.o.shellxescape = ""
  5415. vim.o.sxe = vim.o.shellxescape
  5416. vim.go.shellxescape = vim.o.shellxescape
  5417. vim.go.sxe = vim.go.shellxescape
  5418. --- Quoting character(s), put around the command passed to the shell, for
  5419. --- the "!" and ":!" commands. Includes the redirection. See
  5420. --- 'shellquote' to exclude the redirection. It's probably not useful
  5421. --- to set both options.
  5422. --- When the value is '(' then ')' is appended. When the value is '"('
  5423. --- then ')"' is appended.
  5424. --- When the value is '(' then also see 'shellxescape'.
  5425. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5426. --- security reasons.
  5427. ---
  5428. --- @type string
  5429. vim.o.shellxquote = ""
  5430. vim.o.sxq = vim.o.shellxquote
  5431. vim.go.shellxquote = vim.o.shellxquote
  5432. vim.go.sxq = vim.go.shellxquote
  5433. --- Round indent to multiple of 'shiftwidth'. Applies to > and <
  5434. --- commands. CTRL-T and CTRL-D in Insert mode always round the indent to
  5435. --- a multiple of 'shiftwidth' (this is Vi compatible).
  5436. ---
  5437. --- @type boolean
  5438. vim.o.shiftround = false
  5439. vim.o.sr = vim.o.shiftround
  5440. vim.go.shiftround = vim.o.shiftround
  5441. vim.go.sr = vim.go.shiftround
  5442. --- Number of spaces to use for each step of (auto)indent. Used for
  5443. --- `'cindent'`, `>>`, `<<`, etc.
  5444. --- When zero the 'tabstop' value will be used. Use the `shiftwidth()`
  5445. --- function to get the effective shiftwidth value.
  5446. ---
  5447. --- @type integer
  5448. vim.o.shiftwidth = 8
  5449. vim.o.sw = vim.o.shiftwidth
  5450. vim.bo.shiftwidth = vim.o.shiftwidth
  5451. vim.bo.sw = vim.bo.shiftwidth
  5452. --- This option helps to avoid all the `hit-enter` prompts caused by file
  5453. --- messages, for example with CTRL-G, and to avoid some other messages.
  5454. --- It is a list of flags:
  5455. --- flag meaning when present ~
  5456. --- l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
  5457. --- m use "[+]" instead of "[Modified]" *shm-m*
  5458. --- r use "[RO]" instead of "[readonly]" *shm-r*
  5459. --- w use "[w]" instead of "written" for file write message *shm-w*
  5460. --- and "[a]" instead of "appended" for ':w >> file' command
  5461. --- a all of the above abbreviations *shm-a*
  5462. ---
  5463. --- o overwrite message for writing a file with subsequent *shm-o*
  5464. --- message for reading a file (useful for ":wn" or when
  5465. --- 'autowrite' on)
  5466. --- O message for reading a file overwrites any previous *shm-O*
  5467. --- message; also for quickfix message (e.g., ":cn")
  5468. --- s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
  5469. --- "search hit TOP, continuing at BOTTOM" messages; when using
  5470. --- the search count do not show "W" before the count message
  5471. --- (see `shm-S` below)
  5472. --- t truncate file message at the start if it is too long *shm-t*
  5473. --- to fit on the command-line, "<" will appear in the left most
  5474. --- column; ignored in Ex mode
  5475. --- T truncate other messages in the middle if they are too *shm-T*
  5476. --- long to fit on the command line; "..." will appear in the
  5477. --- middle; ignored in Ex mode
  5478. --- W don't give "written" or "[w]" when writing a file *shm-W*
  5479. --- A don't give the "ATTENTION" message when an existing *shm-A*
  5480. --- swap file is found
  5481. --- I don't give the intro message when starting Vim, *shm-I*
  5482. --- see `:intro`
  5483. --- c don't give `ins-completion-menu` messages; for *shm-c*
  5484. --- example, "-- XXX completion (YYY)", "match 1 of 2", "The only
  5485. --- match", "Pattern not found", "Back at original", etc.
  5486. --- C don't give messages while scanning for ins-completion *shm-C*
  5487. --- items, for instance "scanning tags"
  5488. --- q do not show "recording @a" when recording a macro *shm-q*
  5489. --- F don't give the file info when editing a file, like *shm-F*
  5490. --- `:silent` was used for the command; note that this also
  5491. --- affects messages from 'autoread' reloading
  5492. --- S do not show search count message when searching, e.g. *shm-S*
  5493. --- "[1/5]". When the "S" flag is not present (e.g. search count
  5494. --- is shown), the "search hit BOTTOM, continuing at TOP" and
  5495. --- "search hit TOP, continuing at BOTTOM" messages are only
  5496. --- indicated by a "W" (Mnemonic: Wrapped) letter before the
  5497. --- search count statistics.
  5498. ---
  5499. --- This gives you the opportunity to avoid that a change between buffers
  5500. --- requires you to hit <Enter>, but still gives as useful a message as
  5501. --- possible for the space available. To get the whole message that you
  5502. --- would have got with 'shm' empty, use ":file!"
  5503. --- Useful values:
  5504. --- shm= No abbreviation of message.
  5505. --- shm=a Abbreviation, but no loss of information.
  5506. --- shm=at Abbreviation, and truncate message when necessary.
  5507. ---
  5508. --- @type string
  5509. vim.o.shortmess = "ltToOCF"
  5510. vim.o.shm = vim.o.shortmess
  5511. vim.go.shortmess = vim.o.shortmess
  5512. vim.go.shm = vim.go.shortmess
  5513. --- String to put at the start of lines that have been wrapped. Useful
  5514. --- values are "> " or "+++ ":
  5515. ---
  5516. --- ```vim
  5517. --- let &showbreak = "> "
  5518. --- let &showbreak = '+++ '
  5519. --- ```
  5520. --- Only printable single-cell characters are allowed, excluding <Tab> and
  5521. --- comma (in a future version the comma might be used to separate the
  5522. --- part that is shown at the end and at the start of a line).
  5523. --- The `hl-NonText` highlight group determines the highlighting.
  5524. --- Note that tabs after the showbreak will be displayed differently.
  5525. --- If you want the 'showbreak' to appear in between line numbers, add the
  5526. --- "n" flag to 'cpoptions'.
  5527. --- A window-local value overrules a global value. If the global value is
  5528. --- set and you want no value in the current window use NONE:
  5529. ---
  5530. --- ```vim
  5531. --- setlocal showbreak=NONE
  5532. --- ```
  5533. ---
  5534. ---
  5535. --- @type string
  5536. vim.o.showbreak = ""
  5537. vim.o.sbr = vim.o.showbreak
  5538. vim.wo.showbreak = vim.o.showbreak
  5539. vim.wo.sbr = vim.wo.showbreak
  5540. vim.go.showbreak = vim.o.showbreak
  5541. vim.go.sbr = vim.go.showbreak
  5542. --- Show (partial) command in the last line of the screen. Set this
  5543. --- option off if your terminal is slow.
  5544. --- In Visual mode the size of the selected area is shown:
  5545. --- - When selecting characters within a line, the number of characters.
  5546. --- If the number of bytes is different it is also displayed: "2-6"
  5547. --- means two characters and six bytes.
  5548. --- - When selecting more than one line, the number of lines.
  5549. --- - When selecting a block, the size in screen characters:
  5550. --- {lines}x{columns}.
  5551. --- This information can be displayed in an alternative location using the
  5552. --- 'showcmdloc' option, useful when 'cmdheight' is 0.
  5553. ---
  5554. --- @type boolean
  5555. vim.o.showcmd = true
  5556. vim.o.sc = vim.o.showcmd
  5557. vim.go.showcmd = vim.o.showcmd
  5558. vim.go.sc = vim.go.showcmd
  5559. --- This option can be used to display the (partially) entered command in
  5560. --- another location. Possible values are:
  5561. --- last Last line of the screen (default).
  5562. --- statusline Status line of the current window.
  5563. --- tabline First line of the screen if 'showtabline' is enabled.
  5564. --- Setting this option to "statusline" or "tabline" means that these will
  5565. --- be redrawn whenever the command changes, which can be on every key
  5566. --- pressed.
  5567. --- The %S 'statusline' item can be used in 'statusline' or 'tabline' to
  5568. --- place the text. Without a custom 'statusline' or 'tabline' it will be
  5569. --- displayed in a convenient location.
  5570. ---
  5571. --- @type 'last'|'statusline'|'tabline'
  5572. vim.o.showcmdloc = "last"
  5573. vim.o.sloc = vim.o.showcmdloc
  5574. vim.go.showcmdloc = vim.o.showcmdloc
  5575. vim.go.sloc = vim.go.showcmdloc
  5576. --- When completing a word in insert mode (see `ins-completion`) from the
  5577. --- tags file, show both the tag name and a tidied-up form of the search
  5578. --- pattern (if there is one) as possible matches. Thus, if you have
  5579. --- matched a C function, you can see a template for what arguments are
  5580. --- required (coding style permitting).
  5581. --- Note that this doesn't work well together with having "longest" in
  5582. --- 'completeopt', because the completion from the search pattern may not
  5583. --- match the typed text.
  5584. ---
  5585. --- @type boolean
  5586. vim.o.showfulltag = false
  5587. vim.o.sft = vim.o.showfulltag
  5588. vim.go.showfulltag = vim.o.showfulltag
  5589. vim.go.sft = vim.go.showfulltag
  5590. --- When a bracket is inserted, briefly jump to the matching one. The
  5591. --- jump is only done if the match can be seen on the screen. The time to
  5592. --- show the match can be set with 'matchtime'.
  5593. --- A Beep is given if there is no match (no matter if the match can be
  5594. --- seen or not).
  5595. --- When the 'm' flag is not included in 'cpoptions', typing a character
  5596. --- will immediately move the cursor back to where it belongs.
  5597. --- See the "sm" field in 'guicursor' for setting the cursor shape and
  5598. --- blinking when showing the match.
  5599. --- The 'matchpairs' option can be used to specify the characters to show
  5600. --- matches for. 'rightleft' and 'revins' are used to look for opposite
  5601. --- matches.
  5602. --- Also see the matchparen plugin for highlighting the match when moving
  5603. --- around `pi_paren.txt`.
  5604. --- Note: Use of the short form is rated PG.
  5605. ---
  5606. --- @type boolean
  5607. vim.o.showmatch = false
  5608. vim.o.sm = vim.o.showmatch
  5609. vim.go.showmatch = vim.o.showmatch
  5610. vim.go.sm = vim.go.showmatch
  5611. --- If in Insert, Replace or Visual mode put a message on the last line.
  5612. --- The `hl-ModeMsg` highlight group determines the highlighting.
  5613. --- The option has no effect when 'cmdheight' is zero.
  5614. ---
  5615. --- @type boolean
  5616. vim.o.showmode = true
  5617. vim.o.smd = vim.o.showmode
  5618. vim.go.showmode = vim.o.showmode
  5619. vim.go.smd = vim.go.showmode
  5620. --- The value of this option specifies when the line with tab page labels
  5621. --- will be displayed:
  5622. --- 0: never
  5623. --- 1: only if there are at least two tab pages
  5624. --- 2: always
  5625. --- This is both for the GUI and non-GUI implementation of the tab pages
  5626. --- line.
  5627. --- See `tab-page` for more information about tab pages.
  5628. ---
  5629. --- @type integer
  5630. vim.o.showtabline = 1
  5631. vim.o.stal = vim.o.showtabline
  5632. vim.go.showtabline = vim.o.showtabline
  5633. vim.go.stal = vim.go.showtabline
  5634. --- The minimal number of columns to scroll horizontally. Used only when
  5635. --- the 'wrap' option is off and the cursor is moved off of the screen.
  5636. --- When it is zero the cursor will be put in the middle of the screen.
  5637. --- When using a slow terminal set it to a large number or 0. Not used
  5638. --- for "zh" and "zl" commands.
  5639. ---
  5640. --- @type integer
  5641. vim.o.sidescroll = 1
  5642. vim.o.ss = vim.o.sidescroll
  5643. vim.go.sidescroll = vim.o.sidescroll
  5644. vim.go.ss = vim.go.sidescroll
  5645. --- The minimal number of screen columns to keep to the left and to the
  5646. --- right of the cursor if 'nowrap' is set. Setting this option to a
  5647. --- value greater than 0 while having `'sidescroll'` also at a non-zero
  5648. --- value makes some context visible in the line you are scrolling in
  5649. --- horizontally (except at beginning of the line). Setting this option
  5650. --- to a large value (like 999) has the effect of keeping the cursor
  5651. --- horizontally centered in the window, as long as one does not come too
  5652. --- close to the beginning of the line.
  5653. --- After using the local value, go back the global value with one of
  5654. --- these two:
  5655. ---
  5656. --- ```vim
  5657. --- setlocal sidescrolloff<
  5658. --- setlocal sidescrolloff=-1
  5659. --- ```
  5660. ---
  5661. --- Example: Try this together with 'sidescroll' and 'listchars' as
  5662. --- in the following example to never allow the cursor to move
  5663. --- onto the "extends" character:
  5664. ---
  5665. --- ```vim
  5666. ---
  5667. --- set nowrap sidescroll=1 listchars=extends:>,precedes:<
  5668. --- set sidescrolloff=1
  5669. --- ```
  5670. ---
  5671. ---
  5672. --- @type integer
  5673. vim.o.sidescrolloff = 0
  5674. vim.o.siso = vim.o.sidescrolloff
  5675. vim.wo.sidescrolloff = vim.o.sidescrolloff
  5676. vim.wo.siso = vim.wo.sidescrolloff
  5677. vim.go.sidescrolloff = vim.o.sidescrolloff
  5678. vim.go.siso = vim.go.sidescrolloff
  5679. --- When and how to draw the signcolumn. Valid values are:
  5680. --- "auto" only when there is a sign to display
  5681. --- "auto:[1-9]" resize to accommodate multiple signs up to the
  5682. --- given number (maximum 9), e.g. "auto:4"
  5683. --- "auto:[1-8]-[2-9]"
  5684. --- resize to accommodate multiple signs up to the
  5685. --- given maximum number (maximum 9) while keeping
  5686. --- at least the given minimum (maximum 8) fixed
  5687. --- space. The minimum number should always be less
  5688. --- than the maximum number, e.g. "auto:2-5"
  5689. --- "no" never
  5690. --- "yes" always
  5691. --- "yes:[1-9]" always, with fixed space for signs up to the given
  5692. --- number (maximum 9), e.g. "yes:3"
  5693. --- "number" display signs in the 'number' column. If the number
  5694. --- column is not present, then behaves like "auto".
  5695. ---
  5696. --- @type 'yes'|'no'|'auto'|'auto:1'|'auto:2'|'auto:3'|'auto:4'|'auto:5'|'auto:6'|'auto:7'|'auto:8'|'auto:9'|'yes:1'|'yes:2'|'yes:3'|'yes:4'|'yes:5'|'yes:6'|'yes:7'|'yes:8'|'yes:9'|'number'
  5697. vim.o.signcolumn = "auto"
  5698. vim.o.scl = vim.o.signcolumn
  5699. vim.wo.signcolumn = vim.o.signcolumn
  5700. vim.wo.scl = vim.wo.signcolumn
  5701. --- Override the 'ignorecase' option if the search pattern contains upper
  5702. --- case characters. Only used when the search pattern is typed and
  5703. --- 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
  5704. --- ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
  5705. --- "*" and "#" you can make 'smartcase' used by doing a "/" command,
  5706. --- recalling the search pattern from history and hitting <Enter>.
  5707. ---
  5708. --- @type boolean
  5709. vim.o.smartcase = false
  5710. vim.o.scs = vim.o.smartcase
  5711. vim.go.smartcase = vim.o.smartcase
  5712. vim.go.scs = vim.go.smartcase
  5713. --- Do smart autoindenting when starting a new line. Works for C-like
  5714. --- programs, but can also be used for other languages. 'cindent' does
  5715. --- something like this, works better in most cases, but is more strict,
  5716. --- see `C-indenting`. When 'cindent' is on or 'indentexpr' is set,
  5717. --- setting 'si' has no effect. 'indentexpr' is a more advanced
  5718. --- alternative.
  5719. --- Normally 'autoindent' should also be on when using 'smartindent'.
  5720. --- An indent is automatically inserted:
  5721. --- - After a line ending in "{".
  5722. --- - After a line starting with a keyword from 'cinwords'.
  5723. --- - Before a line starting with "}" (only with the "O" command).
  5724. --- When typing '}' as the first character in a new line, that line is
  5725. --- given the same indent as the matching "{".
  5726. --- When typing '#' as the first character in a new line, the indent for
  5727. --- that line is removed, the '#' is put in the first column. The indent
  5728. --- is restored for the next line. If you don't want this, use this
  5729. --- mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
  5730. --- When using the ">>" command, lines starting with '#' are not shifted
  5731. --- right.
  5732. ---
  5733. --- @type boolean
  5734. vim.o.smartindent = false
  5735. vim.o.si = vim.o.smartindent
  5736. vim.bo.smartindent = vim.o.smartindent
  5737. vim.bo.si = vim.bo.smartindent
  5738. --- When on, a <Tab> in front of a line inserts blanks according to
  5739. --- 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
  5740. --- <BS> will delete a 'shiftwidth' worth of space at the start of the
  5741. --- line.
  5742. --- When off, a <Tab> always inserts blanks according to 'tabstop' or
  5743. --- 'softtabstop'. 'shiftwidth' is only used for shifting text left or
  5744. --- right `shift-left-right`.
  5745. --- What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
  5746. --- option. Also see `ins-expandtab`. When 'expandtab' is not set, the
  5747. --- number of spaces is minimized by using <Tab>s.
  5748. ---
  5749. --- @type boolean
  5750. vim.o.smarttab = true
  5751. vim.o.sta = vim.o.smarttab
  5752. vim.go.smarttab = vim.o.smarttab
  5753. vim.go.sta = vim.go.smarttab
  5754. --- Scrolling works with screen lines. When 'wrap' is set and the first
  5755. --- line in the window wraps part of it may not be visible, as if it is
  5756. --- above the window. "<<<" is displayed at the start of the first line,
  5757. --- highlighted with `hl-NonText`.
  5758. --- You may also want to add "lastline" to the 'display' option to show as
  5759. --- much of the last line as possible.
  5760. --- NOTE: partly implemented, doesn't work yet for `gj` and `gk`.
  5761. ---
  5762. --- @type boolean
  5763. vim.o.smoothscroll = false
  5764. vim.o.sms = vim.o.smoothscroll
  5765. vim.wo.smoothscroll = vim.o.smoothscroll
  5766. vim.wo.sms = vim.wo.smoothscroll
  5767. --- Number of spaces that a <Tab> counts for while performing editing
  5768. --- operations, like inserting a <Tab> or using <BS>. It "feels" like
  5769. --- <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
  5770. --- used. This is useful to keep the 'ts' setting at its standard value
  5771. --- of 8, while being able to edit like it is set to 'sts'. However,
  5772. --- commands like "x" still work on the actual characters.
  5773. --- When 'sts' is zero, this feature is off.
  5774. --- When 'sts' is negative, the value of 'shiftwidth' is used.
  5775. --- See also `ins-expandtab`. When 'expandtab' is not set, the number of
  5776. --- spaces is minimized by using <Tab>s.
  5777. --- The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
  5778. --- set.
  5779. ---
  5780. --- The value of 'softtabstop' will be ignored if `'varsofttabstop'` is set
  5781. --- to anything other than an empty string.
  5782. ---
  5783. --- @type integer
  5784. vim.o.softtabstop = 0
  5785. vim.o.sts = vim.o.softtabstop
  5786. vim.bo.softtabstop = vim.o.softtabstop
  5787. vim.bo.sts = vim.bo.softtabstop
  5788. --- When on spell checking will be done. See `spell`.
  5789. --- The languages are specified with 'spelllang'.
  5790. ---
  5791. --- @type boolean
  5792. vim.o.spell = false
  5793. vim.wo.spell = vim.o.spell
  5794. --- Pattern to locate the end of a sentence. The following word will be
  5795. --- checked to start with a capital letter. If not then it is highlighted
  5796. --- with SpellCap `hl-SpellCap` (unless the word is also badly spelled).
  5797. --- When this check is not wanted make this option empty.
  5798. --- Only used when 'spell' is set.
  5799. --- Be careful with special characters, see `option-backslash` about
  5800. --- including spaces and backslashes.
  5801. --- To set this option automatically depending on the language, see
  5802. --- `set-spc-auto`.
  5803. ---
  5804. --- @type string
  5805. vim.o.spellcapcheck = "[.?!]\\_[\\])'\"\\t ]\\+"
  5806. vim.o.spc = vim.o.spellcapcheck
  5807. vim.bo.spellcapcheck = vim.o.spellcapcheck
  5808. vim.bo.spc = vim.bo.spellcapcheck
  5809. --- Name of the word list file where words are added for the `zg` and `zw`
  5810. --- commands. It must end in ".{encoding}.add". You need to include the
  5811. --- path, otherwise the file is placed in the current directory.
  5812. --- The path may include characters from 'isfname', ' ', ',', '@' and ':'.
  5813. --- *E765*
  5814. --- It may also be a comma-separated list of names. A count before the
  5815. --- `zg` and `zw` commands can be used to access each. This allows using
  5816. --- a personal word list file and a project word list file.
  5817. --- When a word is added while this option is empty Vim will set it for
  5818. --- you: Using the first directory in 'runtimepath' that is writable. If
  5819. --- there is no "spell" directory yet it will be created. For the file
  5820. --- name the first language name that appears in 'spelllang' is used,
  5821. --- ignoring the region.
  5822. --- The resulting ".spl" file will be used for spell checking, it does not
  5823. --- have to appear in 'spelllang'.
  5824. --- Normally one file is used for all regions, but you can add the region
  5825. --- name if you want to. However, it will then only be used when
  5826. --- 'spellfile' is set to it, for entries in 'spelllang' only files
  5827. --- without region name will be found.
  5828. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5829. --- security reasons.
  5830. ---
  5831. --- @type string
  5832. vim.o.spellfile = ""
  5833. vim.o.spf = vim.o.spellfile
  5834. vim.bo.spellfile = vim.o.spellfile
  5835. vim.bo.spf = vim.bo.spellfile
  5836. --- A comma-separated list of word list names. When the 'spell' option is
  5837. --- on spellchecking will be done for these languages. Example:
  5838. ---
  5839. --- ```vim
  5840. --- set spelllang=en_us,nl,medical
  5841. --- ```
  5842. --- This means US English, Dutch and medical words are recognized. Words
  5843. --- that are not recognized will be highlighted.
  5844. --- The word list name must consist of alphanumeric characters, a dash or
  5845. --- an underscore. It should not include a comma or dot. Using a dash is
  5846. --- recommended to separate the two letter language name from a
  5847. --- specification. Thus "en-rare" is used for rare English words.
  5848. --- A region name must come last and have the form "_xx", where "xx" is
  5849. --- the two-letter, lower case region name. You can use more than one
  5850. --- region by listing them: "en_us,en_ca" supports both US and Canadian
  5851. --- English, but not words specific for Australia, New Zealand or Great
  5852. --- Britain. (Note: currently en_au and en_nz dictionaries are older than
  5853. --- en_ca, en_gb and en_us).
  5854. --- If the name "cjk" is included East Asian characters are excluded from
  5855. --- spell checking. This is useful when editing text that also has Asian
  5856. --- words.
  5857. --- Note that the "medical" dictionary does not exist, it is just an
  5858. --- example of a longer name.
  5859. --- *E757*
  5860. --- As a special case the name of a .spl file can be given as-is. The
  5861. --- first "_xx" in the name is removed and used as the region name
  5862. --- (_xx is an underscore, two letters and followed by a non-letter).
  5863. --- This is mainly for testing purposes. You must make sure the correct
  5864. --- encoding is used, Vim doesn't check it.
  5865. --- How the related spell files are found is explained here: `spell-load`.
  5866. ---
  5867. --- If the `spellfile.vim` plugin is active and you use a language name
  5868. --- for which Vim cannot find the .spl file in 'runtimepath' the plugin
  5869. --- will ask you if you want to download the file.
  5870. ---
  5871. --- After this option has been set successfully, Vim will source the files
  5872. --- "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
  5873. --- up to the first character that is not an ASCII letter or number and
  5874. --- not a dash. Also see `set-spc-auto`.
  5875. ---
  5876. --- @type string
  5877. vim.o.spelllang = "en"
  5878. vim.o.spl = vim.o.spelllang
  5879. vim.bo.spelllang = vim.o.spelllang
  5880. vim.bo.spl = vim.bo.spelllang
  5881. --- A comma-separated list of options for spell checking:
  5882. --- camel When a word is CamelCased, assume "Cased" is a
  5883. --- separate word: every upper-case character in a word
  5884. --- that comes after a lower case character indicates the
  5885. --- start of a new word.
  5886. --- noplainbuffer Only spellcheck a buffer when 'syntax' is enabled,
  5887. --- or when extmarks are set within the buffer. Only
  5888. --- designated regions of the buffer are spellchecked in
  5889. --- this case.
  5890. ---
  5891. --- @type string
  5892. vim.o.spelloptions = ""
  5893. vim.o.spo = vim.o.spelloptions
  5894. vim.bo.spelloptions = vim.o.spelloptions
  5895. vim.bo.spo = vim.bo.spelloptions
  5896. --- Methods used for spelling suggestions. Both for the `z=` command and
  5897. --- the `spellsuggest()` function. This is a comma-separated list of
  5898. --- items:
  5899. ---
  5900. --- best Internal method that works best for English. Finds
  5901. --- changes like "fast" and uses a bit of sound-a-like
  5902. --- scoring to improve the ordering.
  5903. ---
  5904. --- double Internal method that uses two methods and mixes the
  5905. --- results. The first method is "fast", the other method
  5906. --- computes how much the suggestion sounds like the bad
  5907. --- word. That only works when the language specifies
  5908. --- sound folding. Can be slow and doesn't always give
  5909. --- better results.
  5910. ---
  5911. --- fast Internal method that only checks for simple changes:
  5912. --- character inserts/deletes/swaps. Works well for
  5913. --- simple typing mistakes.
  5914. ---
  5915. --- {number} The maximum number of suggestions listed for `z=`.
  5916. --- Not used for `spellsuggest()`. The number of
  5917. --- suggestions is never more than the value of 'lines'
  5918. --- minus two.
  5919. ---
  5920. --- timeout:{millisec} Limit the time searching for suggestions to
  5921. --- {millisec} milliseconds. Applies to the following
  5922. --- methods. When omitted the limit is 5000. When
  5923. --- negative there is no limit.
  5924. ---
  5925. --- file:{filename} Read file {filename}, which must have two columns,
  5926. --- separated by a slash. The first column contains the
  5927. --- bad word, the second column the suggested good word.
  5928. --- Example:
  5929. --- theribal/terrible ~
  5930. --- Use this for common mistakes that do not appear at the
  5931. --- top of the suggestion list with the internal methods.
  5932. --- Lines without a slash are ignored, use this for
  5933. --- comments.
  5934. --- The word in the second column must be correct,
  5935. --- otherwise it will not be used. Add the word to an
  5936. --- ".add" file if it is currently flagged as a spelling
  5937. --- mistake.
  5938. --- The file is used for all languages.
  5939. ---
  5940. --- expr:{expr} Evaluate expression {expr}. Use a function to avoid
  5941. --- trouble with spaces. Best is to call a function
  5942. --- without arguments, see `expr-option-function|.
  5943. --- |v:val` holds the badly spelled word. The expression
  5944. --- must evaluate to a List of Lists, each with a
  5945. --- suggestion and a score.
  5946. --- Example:
  5947. --- [['the', 33], ['that', 44]] ~
  5948. --- Set 'verbose' and use `z=` to see the scores that the
  5949. --- internal methods use. A lower score is better.
  5950. --- This may invoke `spellsuggest()` if you temporarily
  5951. --- set 'spellsuggest' to exclude the "expr:" part.
  5952. --- Errors are silently ignored, unless you set the
  5953. --- 'verbose' option to a non-zero value.
  5954. ---
  5955. --- Only one of "best", "double" or "fast" may be used. The others may
  5956. --- appear several times in any order. Example:
  5957. ---
  5958. --- ```vim
  5959. --- set sps=file:~/.config/nvim/sugg,best,expr:MySuggest()
  5960. --- ```
  5961. ---
  5962. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5963. --- security reasons.
  5964. ---
  5965. --- @type string
  5966. vim.o.spellsuggest = "best"
  5967. vim.o.sps = vim.o.spellsuggest
  5968. vim.go.spellsuggest = vim.o.spellsuggest
  5969. vim.go.sps = vim.go.spellsuggest
  5970. --- When on, splitting a window will put the new window below the current
  5971. --- one. `:split`
  5972. ---
  5973. --- @type boolean
  5974. vim.o.splitbelow = false
  5975. vim.o.sb = vim.o.splitbelow
  5976. vim.go.splitbelow = vim.o.splitbelow
  5977. vim.go.sb = vim.go.splitbelow
  5978. --- The value of this option determines the scroll behavior when opening,
  5979. --- closing or resizing horizontal splits.
  5980. ---
  5981. --- Possible values are:
  5982. --- cursor Keep the same relative cursor position.
  5983. --- screen Keep the text on the same screen line.
  5984. --- topline Keep the topline the same.
  5985. ---
  5986. --- For the "screen" and "topline" values, the cursor position will be
  5987. --- changed when necessary. In this case, the jumplist will be populated
  5988. --- with the previous cursor position. For "screen", the text cannot always
  5989. --- be kept on the same screen line when 'wrap' is enabled.
  5990. ---
  5991. --- @type 'cursor'|'screen'|'topline'
  5992. vim.o.splitkeep = "cursor"
  5993. vim.o.spk = vim.o.splitkeep
  5994. vim.go.splitkeep = vim.o.splitkeep
  5995. vim.go.spk = vim.go.splitkeep
  5996. --- When on, splitting a window will put the new window right of the
  5997. --- current one. `:vsplit`
  5998. ---
  5999. --- @type boolean
  6000. vim.o.splitright = false
  6001. vim.o.spr = vim.o.splitright
  6002. vim.go.splitright = vim.o.splitright
  6003. vim.go.spr = vim.go.splitright
  6004. --- When "on" the commands listed below move the cursor to the first
  6005. --- non-blank of the line. When off the cursor is kept in the same column
  6006. --- (if possible). This applies to the commands:
  6007. --- - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
  6008. --- - "d", "<<", "==" and ">>" with a linewise operator
  6009. --- (`operator-resulting-pos`)
  6010. --- - "%" with a count
  6011. --- - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
  6012. --- - Ex commands that only have a line number, e.g., ":25" or ":+".
  6013. --- In case of buffer changing commands the cursor is placed at the column
  6014. --- where it was the last time the buffer was edited.
  6015. ---
  6016. --- @type boolean
  6017. vim.o.startofline = false
  6018. vim.o.sol = vim.o.startofline
  6019. vim.go.startofline = vim.o.startofline
  6020. vim.go.sol = vim.go.startofline
  6021. --- When non-empty, this option determines the content of the area to the
  6022. --- side of a window, normally containing the fold, sign and number columns.
  6023. --- The format of this option is like that of 'statusline'.
  6024. ---
  6025. --- Some of the items from the 'statusline' format are different for
  6026. --- 'statuscolumn':
  6027. ---
  6028. --- %l line number column for currently drawn line
  6029. --- %s sign column for currently drawn line
  6030. --- %C fold column for currently drawn line
  6031. ---
  6032. --- The 'statuscolumn' width follows that of the default columns and
  6033. --- adapts to the `'numberwidth'`, `'signcolumn'` and `'foldcolumn'` option
  6034. --- values (regardless of whether the sign and fold items are present).
  6035. --- Additionally, the 'statuscolumn' grows with the size of the evaluated
  6036. --- format string, up to a point (following the maximum size of the default
  6037. --- fold, sign and number columns). Shrinking only happens when the number
  6038. --- of lines in a buffer changes, or the 'statuscolumn' option is set.
  6039. ---
  6040. --- The `v:lnum` variable holds the line number to be drawn.
  6041. --- The `v:relnum` variable holds the relative line number to be drawn.
  6042. --- The `v:virtnum` variable is negative when drawing virtual lines, zero
  6043. --- when drawing the actual buffer line, and positive when
  6044. --- drawing the wrapped part of a buffer line.
  6045. ---
  6046. --- When using `v:relnum`, keep in mind that cursor movement by itself will
  6047. --- not cause the 'statuscolumn' to update unless `'relativenumber'` is set.
  6048. ---
  6049. --- NOTE: The %@ click execute function item is supported as well but the
  6050. --- specified function will be the same for each row in the same column.
  6051. --- It cannot be switched out through a dynamic 'statuscolumn' format, the
  6052. --- handler should be written with this in mind.
  6053. ---
  6054. --- Examples:
  6055. ---
  6056. --- ```vim
  6057. --- " Line number with bar separator and click handlers:
  6058. --- set statuscolumn=%@SignCb@%s%=%T%@NumCb@%l│%T
  6059. ---
  6060. --- " Line numbers in hexadecimal for non wrapped part of lines:
  6061. --- let &stc='%=%{v:virtnum>0?"":printf("%x",v:lnum)} '
  6062. ---
  6063. --- " Human readable line numbers with thousands separator:
  6064. --- let &stc='%{substitute(v:lnum,"\\d\\zs\\ze\\'
  6065. --- . '%(\\d\\d\\d\\)\\+$",",","g")}'
  6066. ---
  6067. --- " Both relative and absolute line numbers with different
  6068. --- " highlighting for odd and even relative numbers:
  6069. --- let &stc='%#NonText#%{&nu?v:lnum:""}' .
  6070. --- '%=%{&rnu&&(v:lnum%2)?"\ ".v:relnum:""}' .
  6071. --- '%#LineNr#%{&rnu&&!(v:lnum%2)?"\ ".v:relnum:""}'
  6072. --- ```
  6073. --- WARNING: this expression is evaluated for each screen line so defining
  6074. --- an expensive expression can negatively affect render performance.
  6075. ---
  6076. --- @type string
  6077. vim.o.statuscolumn = ""
  6078. vim.o.stc = vim.o.statuscolumn
  6079. vim.wo.statuscolumn = vim.o.statuscolumn
  6080. vim.wo.stc = vim.wo.statuscolumn
  6081. --- When non-empty, this option determines the content of the status line.
  6082. --- Also see `status-line`.
  6083. ---
  6084. --- The option consists of printf style '%' items interspersed with
  6085. --- normal text. Each status line item is of the form:
  6086. --- %-0{minwid}.{maxwid}{item}
  6087. --- All fields except the {item} are optional. A single percent sign can
  6088. --- be given as "%%".
  6089. ---
  6090. --- *stl-%!*
  6091. --- When the option starts with "%!" then it is used as an expression,
  6092. --- evaluated and the result is used as the option value. Example:
  6093. ---
  6094. --- ```vim
  6095. --- set statusline=%!MyStatusLine()
  6096. --- ```
  6097. --- The *g:statusline_winid* variable will be set to the `window-ID` of the
  6098. --- window that the status line belongs to.
  6099. --- The result can contain %{} items that will be evaluated too.
  6100. --- Note that the "%!" expression is evaluated in the context of the
  6101. --- current window and buffer, while %{} items are evaluated in the
  6102. --- context of the window that the statusline belongs to.
  6103. ---
  6104. --- When there is error while evaluating the option then it will be made
  6105. --- empty to avoid further errors. Otherwise screen updating would loop.
  6106. --- When the result contains unprintable characters the result is
  6107. --- unpredictable.
  6108. ---
  6109. --- Note that the only effect of 'ruler' when this option is set (and
  6110. --- 'laststatus' is 2 or 3) is controlling the output of `CTRL-G`.
  6111. ---
  6112. --- field meaning ~
  6113. --- - Left justify the item. The default is right justified
  6114. --- when minwid is larger than the length of the item.
  6115. --- 0 Leading zeroes in numeric items. Overridden by "-".
  6116. --- minwid Minimum width of the item, padding as set by "-" & "0".
  6117. --- Value must be 50 or less.
  6118. --- maxwid Maximum width of the item. Truncation occurs with a "<"
  6119. --- on the left for text items. Numeric items will be
  6120. --- shifted down to maxwid-2 digits followed by ">"number
  6121. --- where number is the amount of missing digits, much like
  6122. --- an exponential notation.
  6123. --- item A one letter code as described below.
  6124. ---
  6125. --- Following is a description of the possible statusline items. The
  6126. --- second character in "item" is the type:
  6127. --- N for number
  6128. --- S for string
  6129. --- F for flags as described below
  6130. --- - not applicable
  6131. ---
  6132. --- item meaning ~
  6133. --- f S Path to the file in the buffer, as typed or relative to current
  6134. --- directory.
  6135. --- F S Full path to the file in the buffer.
  6136. --- t S File name (tail) of file in the buffer.
  6137. --- m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
  6138. --- M F Modified flag, text is ",+" or ",-".
  6139. --- r F Readonly flag, text is "[RO]".
  6140. --- R F Readonly flag, text is ",RO".
  6141. --- h F Help buffer flag, text is "[help]".
  6142. --- H F Help buffer flag, text is ",HLP".
  6143. --- w F Preview window flag, text is "[Preview]".
  6144. --- W F Preview window flag, text is ",PRV".
  6145. --- y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
  6146. --- Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
  6147. --- q S "[Quickfix List]", "[Location List]" or empty.
  6148. --- k S Value of "b:keymap_name" or 'keymap' when `:lmap` mappings are
  6149. --- being used: "<keymap>"
  6150. --- n N Buffer number.
  6151. --- b N Value of character under cursor.
  6152. --- B N As above, in hexadecimal.
  6153. --- o N Byte number in file of byte under cursor, first byte is 1.
  6154. --- Mnemonic: Offset from start of file (with one added)
  6155. --- O N As above, in hexadecimal.
  6156. --- l N Line number.
  6157. --- L N Number of lines in buffer.
  6158. --- c N Column number (byte index).
  6159. --- v N Virtual column number (screen column).
  6160. --- V N Virtual column number as -{num}. Not displayed if equal to 'c'.
  6161. --- p N Percentage through file in lines as in `CTRL-G`.
  6162. --- P S Percentage through file of displayed window. This is like the
  6163. --- percentage described for 'ruler'. Always 3 in length, unless
  6164. --- translated.
  6165. --- S S 'showcmd' content, see 'showcmdloc'.
  6166. --- a S Argument list status as in default title. ({current} of {max})
  6167. --- Empty if the argument file count is zero or one.
  6168. --- { NF Evaluate expression between "%{" and "}" and substitute result.
  6169. --- Note that there is no "%" before the closing "}". The
  6170. --- expression cannot contain a "}" character, call a function to
  6171. --- work around that. See `stl-%{` below.
  6172. --- `{%` - This is almost same as "{" except the result of the expression is
  6173. --- re-evaluated as a statusline format string. Thus if the
  6174. --- return value of expr contains "%" items they will get expanded.
  6175. --- The expression can contain the "}" character, the end of
  6176. --- expression is denoted by "%}".
  6177. --- For example:
  6178. ---
  6179. --- ```vim
  6180. --- func! Stl_filename() abort
  6181. --- return "%t"
  6182. --- endfunc
  6183. --- ```
  6184. --- `stl=%{Stl_filename()}` results in `"%t"`
  6185. --- `stl=%{%Stl_filename()%}` results in `"Name of current file"`
  6186. --- %} - End of "{%" expression
  6187. --- ( - Start of item group. Can be used for setting the width and
  6188. --- alignment of a section. Must be followed by %) somewhere.
  6189. --- ) - End of item group. No width fields allowed.
  6190. --- T N For 'tabline': start of tab page N label. Use %T or %X to end
  6191. --- the label. Clicking this label with left mouse button switches
  6192. --- to the specified tab page, while clicking it with middle mouse
  6193. --- button closes the specified tab page.
  6194. --- X N For 'tabline': start of close tab N label. Use %X or %T to end
  6195. --- the label, e.g.: %3Xclose%X. Use %999X for a "close current
  6196. --- tab" label. Clicking this label with left mouse button closes
  6197. --- the specified tab page.
  6198. --- @ N Start of execute function label. Use %X or %T to end the label,
  6199. --- e.g.: %10@SwitchBuffer@foo.c%X. Clicking this label runs the
  6200. --- specified function: in the example when clicking once using left
  6201. --- mouse button on "foo.c", a `SwitchBuffer(10, 1, 'l', ' ')`
  6202. --- expression will be run. The specified function receives the
  6203. --- following arguments in order:
  6204. --- 1. minwid field value or zero if no N was specified
  6205. --- 2. number of mouse clicks to detect multiple clicks
  6206. --- 3. mouse button used: "l", "r" or "m" for left, right or middle
  6207. --- button respectively; one should not rely on third argument
  6208. --- being only "l", "r" or "m": any other non-empty string value
  6209. --- that contains only ASCII lower case letters may be expected
  6210. --- for other mouse buttons
  6211. --- 4. modifiers pressed: string which contains "s" if shift
  6212. --- modifier was pressed, "c" for control, "a" for alt and "m"
  6213. --- for meta; currently if modifier is not pressed string
  6214. --- contains space instead, but one should not rely on presence
  6215. --- of spaces or specific order of modifiers: use `stridx()` to
  6216. --- test whether some modifier is present; string is guaranteed
  6217. --- to contain only ASCII letters and spaces, one letter per
  6218. --- modifier; "?" modifier may also be present, but its presence
  6219. --- is a bug that denotes that new mouse button recognition was
  6220. --- added without modifying code that reacts on mouse clicks on
  6221. --- this label.
  6222. --- Use `getmousepos()`.winid in the specified function to get the
  6223. --- corresponding window id of the clicked item.
  6224. --- \< - Where to truncate line if too long. Default is at the start.
  6225. --- No width fields allowed.
  6226. --- = - Separation point between alignment sections. Each section will
  6227. --- be separated by an equal number of spaces. With one %= what
  6228. --- comes after it will be right-aligned. With two %= there is a
  6229. --- middle part, with white space left and right of it.
  6230. --- No width fields allowed.
  6231. --- # - Set highlight group. The name must follow and then a # again.
  6232. --- Thus use %#HLname# for highlight group HLname. The same
  6233. --- highlighting is used, also for the statusline of non-current
  6234. --- windows.
  6235. --- * - Set highlight group to User{N}, where {N} is taken from the
  6236. --- minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
  6237. --- The difference between User{N} and StatusLine will be applied to
  6238. --- StatusLineNC for the statusline of non-current windows.
  6239. --- The number N must be between 1 and 9. See `hl-User1..9`
  6240. ---
  6241. --- When displaying a flag, Vim removes the leading comma, if any, when
  6242. --- that flag comes right after plaintext. This will make a nice display
  6243. --- when flags are used like in the examples below.
  6244. ---
  6245. --- When all items in a group becomes an empty string (i.e. flags that are
  6246. --- not set) and a minwid is not set for the group, the whole group will
  6247. --- become empty. This will make a group like the following disappear
  6248. --- completely from the statusline when none of the flags are set.
  6249. ---
  6250. --- ```vim
  6251. --- set statusline=...%(\ [%M%R%H]%)...
  6252. --- ```
  6253. --- Beware that an expression is evaluated each and every time the status
  6254. --- line is displayed.
  6255. --- *stl-%{* *g:actual_curbuf* *g:actual_curwin*
  6256. --- While evaluating %{} the current buffer and current window will be set
  6257. --- temporarily to that of the window (and buffer) whose statusline is
  6258. --- currently being drawn. The expression will evaluate in this context.
  6259. --- The variable "g:actual_curbuf" is set to the `bufnr()` number of the
  6260. --- real current buffer and "g:actual_curwin" to the `window-ID` of the
  6261. --- real current window. These values are strings.
  6262. ---
  6263. --- The 'statusline' option will be evaluated in the `sandbox` if set from
  6264. --- a modeline, see `sandbox-option`.
  6265. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  6266. ---
  6267. --- It is not allowed to change text or jump to another window while
  6268. --- evaluating 'statusline' `textlock`.
  6269. ---
  6270. --- If the statusline is not updated when you want it (e.g., after setting
  6271. --- a variable that's used in an expression), you can force an update by
  6272. --- using `:redrawstatus`.
  6273. ---
  6274. --- A result of all digits is regarded a number for display purposes.
  6275. --- Otherwise the result is taken as flag text and applied to the rules
  6276. --- described above.
  6277. ---
  6278. --- Watch out for errors in expressions. They may render Vim unusable!
  6279. --- If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
  6280. --- edit your vimrc or whatever with "vim --clean" to get it right.
  6281. ---
  6282. --- Examples:
  6283. --- Emulate standard status line with 'ruler' set
  6284. ---
  6285. --- ```vim
  6286. --- set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
  6287. --- ```
  6288. --- Similar, but add ASCII value of char under the cursor (like "ga")
  6289. ---
  6290. --- ```vim
  6291. --- set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
  6292. --- ```
  6293. --- Display byte count and byte value, modified flag in red.
  6294. ---
  6295. --- ```vim
  6296. --- set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
  6297. --- hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
  6298. --- ```
  6299. --- Display a ,GZ flag if a compressed file is loaded
  6300. ---
  6301. --- ```vim
  6302. --- set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
  6303. --- ```
  6304. --- In the `:autocmd`'s:
  6305. ---
  6306. --- ```vim
  6307. --- let b:gzflag = 1
  6308. --- ```
  6309. --- And:
  6310. ---
  6311. --- ```vim
  6312. --- unlet b:gzflag
  6313. --- ```
  6314. --- And define this function:
  6315. ---
  6316. --- ```vim
  6317. --- function VarExists(var, val)
  6318. --- if exists(a:var) | return a:val | else | return '' | endif
  6319. --- endfunction
  6320. --- ```
  6321. ---
  6322. ---
  6323. --- @type string
  6324. vim.o.statusline = ""
  6325. vim.o.stl = vim.o.statusline
  6326. vim.wo.statusline = vim.o.statusline
  6327. vim.wo.stl = vim.wo.statusline
  6328. vim.go.statusline = vim.o.statusline
  6329. vim.go.stl = vim.go.statusline
  6330. --- Files with these suffixes get a lower priority when multiple files
  6331. --- match a wildcard. See `suffixes`. Commas can be used to separate the
  6332. --- suffixes. Spaces after the comma are ignored. A dot is also seen as
  6333. --- the start of a suffix. To avoid a dot or comma being recognized as a
  6334. --- separator, precede it with a backslash (see `option-backslash` about
  6335. --- including spaces and backslashes).
  6336. --- See 'wildignore' for completely ignoring files.
  6337. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  6338. --- suffixes from the list. This avoids problems when a future version
  6339. --- uses another default.
  6340. ---
  6341. --- @type string
  6342. vim.o.suffixes = ".bak,~,.o,.h,.info,.swp,.obj"
  6343. vim.o.su = vim.o.suffixes
  6344. vim.go.suffixes = vim.o.suffixes
  6345. vim.go.su = vim.go.suffixes
  6346. --- Comma-separated list of suffixes, which are used when searching for a
  6347. --- file for the "gf", "[I", etc. commands. Example:
  6348. ---
  6349. --- ```vim
  6350. --- set suffixesadd=.java
  6351. --- ```
  6352. ---
  6353. ---
  6354. --- @type string
  6355. vim.o.suffixesadd = ""
  6356. vim.o.sua = vim.o.suffixesadd
  6357. vim.bo.suffixesadd = vim.o.suffixesadd
  6358. vim.bo.sua = vim.bo.suffixesadd
  6359. --- Use a swapfile for the buffer. This option can be reset when a
  6360. --- swapfile is not wanted for a specific buffer. For example, with
  6361. --- confidential information that even root must not be able to access.
  6362. --- Careful: All text will be in memory:
  6363. --- - Don't use this for big files.
  6364. --- - Recovery will be impossible!
  6365. --- A swapfile will only be present when `'updatecount'` is non-zero and
  6366. --- 'swapfile' is set.
  6367. --- When 'swapfile' is reset, the swap file for the current buffer is
  6368. --- immediately deleted. When 'swapfile' is set, and 'updatecount' is
  6369. --- non-zero, a swap file is immediately created.
  6370. --- Also see `swap-file`.
  6371. --- If you want to open a new buffer without creating a swap file for it,
  6372. --- use the `:noswapfile` modifier.
  6373. --- See 'directory' for where the swap file is created.
  6374. ---
  6375. --- This option is used together with 'bufhidden' and 'buftype' to
  6376. --- specify special kinds of buffers. See `special-buffers`.
  6377. ---
  6378. --- @type boolean
  6379. vim.o.swapfile = true
  6380. vim.o.swf = vim.o.swapfile
  6381. vim.bo.swapfile = vim.o.swapfile
  6382. vim.bo.swf = vim.bo.swapfile
  6383. --- This option controls the behavior when switching between buffers.
  6384. --- This option is checked, when
  6385. --- - jumping to errors with the `quickfix` commands (`:cc`, `:cn`, `:cp`,
  6386. --- etc.).
  6387. --- - jumping to a tag using the `:stag` command.
  6388. --- - opening a file using the `CTRL-W_f` or `CTRL-W_F` command.
  6389. --- - jumping to a buffer using a buffer split command (e.g. `:sbuffer`,
  6390. --- `:sbnext`, or `:sbrewind`).
  6391. --- Possible values (comma-separated list):
  6392. --- useopen If included, jump to the first open window in the
  6393. --- current tab page that contains the specified buffer
  6394. --- (if there is one). Otherwise: Do not examine other
  6395. --- windows.
  6396. --- usetab Like "useopen", but also consider windows in other tab
  6397. --- pages.
  6398. --- split If included, split the current window before loading
  6399. --- a buffer for a `quickfix` command that display errors.
  6400. --- Otherwise: do not split, use current window (when used
  6401. --- in the quickfix window: the previously used window or
  6402. --- split if there is no other window).
  6403. --- vsplit Just like "split" but split vertically.
  6404. --- newtab Like "split", but open a new tab page. Overrules
  6405. --- "split" when both are present.
  6406. --- uselast If included, jump to the previously used window when
  6407. --- jumping to errors with `quickfix` commands.
  6408. --- If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
  6409. --- applied to the split window.
  6410. ---
  6411. --- @type string
  6412. vim.o.switchbuf = "uselast"
  6413. vim.o.swb = vim.o.switchbuf
  6414. vim.go.switchbuf = vim.o.switchbuf
  6415. vim.go.swb = vim.go.switchbuf
  6416. --- Maximum column in which to search for syntax items. In long lines the
  6417. --- text after this column is not highlighted and following lines may not
  6418. --- be highlighted correctly, because the syntax state is cleared.
  6419. --- This helps to avoid very slow redrawing for an XML file that is one
  6420. --- long line.
  6421. --- Set to zero to remove the limit.
  6422. ---
  6423. --- @type integer
  6424. vim.o.synmaxcol = 3000
  6425. vim.o.smc = vim.o.synmaxcol
  6426. vim.bo.synmaxcol = vim.o.synmaxcol
  6427. vim.bo.smc = vim.bo.synmaxcol
  6428. --- When this option is set, the syntax with this name is loaded, unless
  6429. --- syntax highlighting has been switched off with ":syntax off".
  6430. --- Otherwise this option does not always reflect the current syntax (the
  6431. --- b:current_syntax variable does).
  6432. --- This option is most useful in a modeline, for a file which syntax is
  6433. --- not automatically recognized. Example, in an IDL file: >c
  6434. --- /* vim: set syntax=idl : */
  6435. --- ```
  6436. --- When a dot appears in the value then this separates two filetype
  6437. --- names. Example: >c
  6438. --- /* vim: set syntax=c.doxygen : */
  6439. --- ```
  6440. --- This will use the "c" syntax first, then the "doxygen" syntax.
  6441. --- Note that the second one must be prepared to be loaded as an addition,
  6442. --- otherwise it will be skipped. More than one dot may appear.
  6443. --- To switch off syntax highlighting for the current file, use:
  6444. ---
  6445. --- ```vim
  6446. --- set syntax=OFF
  6447. --- ```
  6448. --- To switch syntax highlighting on according to the current value of the
  6449. --- 'filetype' option:
  6450. ---
  6451. --- ```vim
  6452. --- set syntax=ON
  6453. --- ```
  6454. --- What actually happens when setting the 'syntax' option is that the
  6455. --- Syntax autocommand event is triggered with the value as argument.
  6456. --- This option is not copied to another buffer, independent of the 's' or
  6457. --- 'S' flag in 'cpoptions'.
  6458. --- Only alphanumeric characters, '.', '-' and '_' can be used.
  6459. ---
  6460. --- @type string
  6461. vim.o.syntax = ""
  6462. vim.o.syn = vim.o.syntax
  6463. vim.bo.syntax = vim.o.syntax
  6464. vim.bo.syn = vim.bo.syntax
  6465. --- This option controls the behavior when closing tab pages (e.g., using
  6466. --- `:tabclose`). When empty Vim goes to the next (right) tab page.
  6467. ---
  6468. --- Possible values (comma-separated list):
  6469. --- left If included, go to the previous tab page instead of
  6470. --- the next one.
  6471. --- uselast If included, go to the previously used tab page if
  6472. --- possible. This option takes precedence over the
  6473. --- others.
  6474. ---
  6475. --- @type string
  6476. vim.o.tabclose = ""
  6477. vim.o.tcl = vim.o.tabclose
  6478. vim.go.tabclose = vim.o.tabclose
  6479. vim.go.tcl = vim.go.tabclose
  6480. --- When non-empty, this option determines the content of the tab pages
  6481. --- line at the top of the Vim window. When empty Vim will use a default
  6482. --- tab pages line. See `setting-tabline` for more info.
  6483. ---
  6484. --- The tab pages line only appears as specified with the 'showtabline'
  6485. --- option and only when there is no GUI tab line. When 'e' is in
  6486. --- 'guioptions' and the GUI supports a tab line 'guitablabel' is used
  6487. --- instead. Note that the two tab pages lines are very different.
  6488. ---
  6489. --- The value is evaluated like with 'statusline'. You can use
  6490. --- `tabpagenr()`, `tabpagewinnr()` and `tabpagebuflist()` to figure out
  6491. --- the text to be displayed. Use "%1T" for the first label, "%2T" for
  6492. --- the second one, etc. Use "%X" items for closing labels.
  6493. ---
  6494. --- When changing something that is used in 'tabline' that does not
  6495. --- trigger it to be updated, use `:redrawtabline`.
  6496. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  6497. ---
  6498. --- Keep in mind that only one of the tab pages is the current one, others
  6499. --- are invisible and you can't jump to their windows.
  6500. ---
  6501. --- @type string
  6502. vim.o.tabline = ""
  6503. vim.o.tal = vim.o.tabline
  6504. vim.go.tabline = vim.o.tabline
  6505. vim.go.tal = vim.go.tabline
  6506. --- Maximum number of tab pages to be opened by the `-p` command line
  6507. --- argument or the ":tab all" command. `tabpage`
  6508. ---
  6509. --- @type integer
  6510. vim.o.tabpagemax = 50
  6511. vim.o.tpm = vim.o.tabpagemax
  6512. vim.go.tabpagemax = vim.o.tabpagemax
  6513. vim.go.tpm = vim.go.tabpagemax
  6514. --- Number of spaces that a <Tab> in the file counts for. Also see
  6515. --- the `:retab` command, and the 'softtabstop' option.
  6516. ---
  6517. --- Note: Setting 'tabstop' to any other value than 8 can make your file
  6518. --- appear wrong in many places.
  6519. --- The value must be more than 0 and less than 10000.
  6520. ---
  6521. --- There are five main ways to use tabs in Vim:
  6522. --- 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
  6523. --- (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
  6524. --- will use a mix of tabs and spaces, but typing <Tab> and <BS> will
  6525. --- behave like a tab appears every 4 (or 3) characters.
  6526. --- This is the recommended way, the file will look the same with other
  6527. --- tools and when listing it in a terminal.
  6528. --- 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
  6529. --- 'expandtab'. This way you will always insert spaces. The
  6530. --- formatting will never be messed up when 'tabstop' is changed (leave
  6531. --- it at 8 just in case). The file will be a bit larger.
  6532. --- You do need to check if no Tabs exist in the file. You can get rid
  6533. --- of them by first setting 'expandtab' and using `%retab!`, making
  6534. --- sure the value of 'tabstop' is set correctly.
  6535. --- 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
  6536. --- 'expandtab'. This way you will always insert spaces. The
  6537. --- formatting will never be messed up when 'tabstop' is changed.
  6538. --- You do need to check if no Tabs exist in the file, just like in the
  6539. --- item just above.
  6540. --- 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
  6541. --- `modeline` to set these values when editing the file again. Only
  6542. --- works when using Vim to edit the file, other tools assume a tabstop
  6543. --- is worth 8 spaces.
  6544. --- 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
  6545. --- 'noexpandtab'. This should then work (for initial indents only)
  6546. --- for any tabstop setting that people use. It might be nice to have
  6547. --- tabs after the first non-blank inserted as spaces if you do this
  6548. --- though. Otherwise aligned comments will be wrong when 'tabstop' is
  6549. --- changed.
  6550. ---
  6551. --- The value of 'tabstop' will be ignored if `'vartabstop'` is set to
  6552. --- anything other than an empty string.
  6553. ---
  6554. --- @type integer
  6555. vim.o.tabstop = 8
  6556. vim.o.ts = vim.o.tabstop
  6557. vim.bo.tabstop = vim.o.tabstop
  6558. vim.bo.ts = vim.bo.tabstop
  6559. --- When searching for a tag (e.g., for the `:ta` command), Vim can either
  6560. --- use a binary search or a linear search in a tags file. Binary
  6561. --- searching makes searching for a tag a LOT faster, but a linear search
  6562. --- will find more tags if the tags file wasn't properly sorted.
  6563. --- Vim normally assumes that your tags files are sorted, or indicate that
  6564. --- they are not sorted. Only when this is not the case does the
  6565. --- 'tagbsearch' option need to be switched off.
  6566. ---
  6567. --- When 'tagbsearch' is on, binary searching is first used in the tags
  6568. --- files. In certain situations, Vim will do a linear search instead for
  6569. --- certain files, or retry all files with a linear search. When
  6570. --- 'tagbsearch' is off, only a linear search is done.
  6571. ---
  6572. --- Linear searching is done anyway, for one file, when Vim finds a line
  6573. --- at the start of the file indicating that it's not sorted:
  6574. --- ```
  6575. --- !_TAG_FILE_SORTED 0 /some comment/
  6576. --- ```
  6577. --- [The whitespace before and after the '0' must be a single <Tab>]
  6578. ---
  6579. --- When a binary search was done and no match was found in any of the
  6580. --- files listed in 'tags', and case is ignored or a pattern is used
  6581. --- instead of a normal tag name, a retry is done with a linear search.
  6582. --- Tags in unsorted tags files, and matches with different case will only
  6583. --- be found in the retry.
  6584. ---
  6585. --- If a tag file indicates that it is case-fold sorted, the second,
  6586. --- linear search can be avoided when case is ignored. Use a value of '2'
  6587. --- in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
  6588. --- sorted with the -f switch to "sort" in most unices, as in the command:
  6589. --- "sort -f -o tags tags". For Universal ctags and Exuberant ctags
  6590. --- version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
  6591. --- used for this as well. Note that case must be folded to uppercase for
  6592. --- this to work.
  6593. ---
  6594. --- By default, tag searches are case-sensitive. Case is ignored when
  6595. --- 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
  6596. --- "ignore".
  6597. --- Also when 'tagcase' is "followscs" and 'smartcase' is set, or
  6598. --- 'tagcase' is "smart", and the pattern contains only lowercase
  6599. --- characters.
  6600. ---
  6601. --- When 'tagbsearch' is off, tags searching is slower when a full match
  6602. --- exists, but faster when no full match exists. Tags in unsorted tags
  6603. --- files may only be found with 'tagbsearch' off.
  6604. --- When the tags file is not sorted, or sorted in a wrong way (not on
  6605. --- ASCII byte value), 'tagbsearch' should be off, or the line given above
  6606. --- must be included in the tags file.
  6607. --- This option doesn't affect commands that find all matching tags (e.g.,
  6608. --- command-line completion and ":help").
  6609. ---
  6610. --- @type boolean
  6611. vim.o.tagbsearch = true
  6612. vim.o.tbs = vim.o.tagbsearch
  6613. vim.go.tagbsearch = vim.o.tagbsearch
  6614. vim.go.tbs = vim.go.tagbsearch
  6615. --- This option specifies how case is handled when searching the tags
  6616. --- file:
  6617. --- followic Follow the 'ignorecase' option
  6618. --- followscs Follow the 'smartcase' and 'ignorecase' options
  6619. --- ignore Ignore case
  6620. --- match Match case
  6621. --- smart Ignore case unless an upper case letter is used
  6622. ---
  6623. --- @type 'followic'|'ignore'|'match'|'followscs'|'smart'
  6624. vim.o.tagcase = "followic"
  6625. vim.o.tc = vim.o.tagcase
  6626. vim.bo.tagcase = vim.o.tagcase
  6627. vim.bo.tc = vim.bo.tagcase
  6628. vim.go.tagcase = vim.o.tagcase
  6629. vim.go.tc = vim.go.tagcase
  6630. --- This option specifies a function to be used to perform tag searches.
  6631. --- The function gets the tag pattern and should return a List of matching
  6632. --- tags. See `tag-function` for an explanation of how to write the
  6633. --- function and an example. The value can be the name of a function, a
  6634. --- `lambda` or a `Funcref`. See `option-value-function` for more
  6635. --- information.
  6636. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6637. --- security reasons.
  6638. ---
  6639. --- @type string
  6640. vim.o.tagfunc = ""
  6641. vim.o.tfu = vim.o.tagfunc
  6642. vim.bo.tagfunc = vim.o.tagfunc
  6643. vim.bo.tfu = vim.bo.tagfunc
  6644. --- If non-zero, tags are significant up to this number of characters.
  6645. ---
  6646. --- @type integer
  6647. vim.o.taglength = 0
  6648. vim.o.tl = vim.o.taglength
  6649. vim.go.taglength = vim.o.taglength
  6650. vim.go.tl = vim.go.taglength
  6651. --- If on and using a tags file in another directory, file names in that
  6652. --- tags file are relative to the directory where the tags file is.
  6653. ---
  6654. --- @type boolean
  6655. vim.o.tagrelative = true
  6656. vim.o.tr = vim.o.tagrelative
  6657. vim.go.tagrelative = vim.o.tagrelative
  6658. vim.go.tr = vim.go.tagrelative
  6659. --- Filenames for the tag command, separated by spaces or commas. To
  6660. --- include a space or comma in a file name, precede it with backslashes
  6661. --- (see `option-backslash` about including spaces/commas and backslashes).
  6662. --- When a file name starts with "./", the '.' is replaced with the path
  6663. --- of the current file. But only when the 'd' flag is not included in
  6664. --- 'cpoptions'. Environment variables are expanded `:set_env`. Also see
  6665. --- `tags-option`.
  6666. --- "*", "**" and other wildcards can be used to search for tags files in
  6667. --- a directory tree. See `file-searching`. E.g., "/lib/**/tags" will
  6668. --- find all files named "tags" below "/lib". The filename itself cannot
  6669. --- contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
  6670. --- files called "tags?".
  6671. --- The `tagfiles()` function can be used to get a list of the file names
  6672. --- actually used.
  6673. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  6674. --- file names from the list. This avoids problems when a future version
  6675. --- uses another default.
  6676. ---
  6677. --- @type string
  6678. vim.o.tags = "./tags;,tags"
  6679. vim.o.tag = vim.o.tags
  6680. vim.bo.tags = vim.o.tags
  6681. vim.bo.tag = vim.bo.tags
  6682. vim.go.tags = vim.o.tags
  6683. vim.go.tag = vim.go.tags
  6684. --- When on, the `tagstack` is used normally. When off, a ":tag" or
  6685. --- ":tselect" command with an argument will not push the tag onto the
  6686. --- tagstack. A following ":tag" without an argument, a ":pop" command or
  6687. --- any other command that uses the tagstack will use the unmodified
  6688. --- tagstack, but does change the pointer to the active entry.
  6689. --- Resetting this option is useful when using a ":tag" command in a
  6690. --- mapping which should not change the tagstack.
  6691. ---
  6692. --- @type boolean
  6693. vim.o.tagstack = true
  6694. vim.o.tgst = vim.o.tagstack
  6695. vim.go.tagstack = vim.o.tagstack
  6696. vim.go.tgst = vim.go.tagstack
  6697. --- The terminal is in charge of Bi-directionality of text (as specified
  6698. --- by Unicode). The terminal is also expected to do the required shaping
  6699. --- that some languages (such as Arabic) require.
  6700. --- Setting this option implies that 'rightleft' will not be set when
  6701. --- 'arabic' is set and the value of 'arabicshape' will be ignored.
  6702. --- Note that setting 'termbidi' has the immediate effect that
  6703. --- 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
  6704. --- For further details see `arabic.txt`.
  6705. ---
  6706. --- @type boolean
  6707. vim.o.termbidi = false
  6708. vim.o.tbidi = vim.o.termbidi
  6709. vim.go.termbidi = vim.o.termbidi
  6710. vim.go.tbidi = vim.go.termbidi
  6711. --- Enables 24-bit RGB color in the `TUI`. Uses "gui" `:highlight`
  6712. --- attributes instead of "cterm" attributes. `guifg`
  6713. --- Requires an ISO-8613-3 compatible terminal.
  6714. ---
  6715. --- Nvim will automatically attempt to determine if the host terminal
  6716. --- supports 24-bit color and will enable this option if it does
  6717. --- (unless explicitly disabled by the user).
  6718. ---
  6719. --- @type boolean
  6720. vim.o.termguicolors = false
  6721. vim.o.tgc = vim.o.termguicolors
  6722. vim.go.termguicolors = vim.o.termguicolors
  6723. vim.go.tgc = vim.go.termguicolors
  6724. --- A comma-separated list of options for specifying control characters
  6725. --- to be removed from the text pasted into the terminal window. The
  6726. --- supported values are:
  6727. ---
  6728. --- BS Backspace
  6729. ---
  6730. --- HT TAB
  6731. ---
  6732. --- FF Form feed
  6733. ---
  6734. --- ESC Escape
  6735. ---
  6736. --- DEL DEL
  6737. ---
  6738. --- C0 Other control characters, excluding Line feed and
  6739. --- Carriage return < ' '
  6740. ---
  6741. --- C1 Control characters 0x80...0x9F
  6742. ---
  6743. --- @type string
  6744. vim.o.termpastefilter = "BS,HT,ESC,DEL"
  6745. vim.o.tpf = vim.o.termpastefilter
  6746. vim.go.termpastefilter = vim.o.termpastefilter
  6747. vim.go.tpf = vim.go.termpastefilter
  6748. --- If the host terminal supports it, buffer all screen updates
  6749. --- made during a redraw cycle so that each screen is displayed in
  6750. --- the terminal all at once. This can prevent tearing or flickering
  6751. --- when the terminal updates faster than Nvim can redraw.
  6752. ---
  6753. --- @type boolean
  6754. vim.o.termsync = true
  6755. vim.go.termsync = vim.o.termsync
  6756. --- Maximum width of text that is being inserted. A longer line will be
  6757. --- broken after white space to get this width. A zero value disables
  6758. --- this.
  6759. --- When 'textwidth' is zero, 'wrapmargin' may be used. See also
  6760. --- 'formatoptions' and `ins-textwidth`.
  6761. --- When 'formatexpr' is set it will be used to break the line.
  6762. ---
  6763. --- @type integer
  6764. vim.o.textwidth = 0
  6765. vim.o.tw = vim.o.textwidth
  6766. vim.bo.textwidth = vim.o.textwidth
  6767. vim.bo.tw = vim.bo.textwidth
  6768. --- List of file names, separated by commas, that are used to lookup words
  6769. --- for thesaurus completion commands `i_CTRL-X_CTRL-T`. See
  6770. --- `compl-thesaurus`.
  6771. ---
  6772. --- This option is not used if 'thesaurusfunc' is set, either for the
  6773. --- buffer or globally.
  6774. ---
  6775. --- To include a comma in a file name precede it with a backslash. Spaces
  6776. --- after a comma are ignored, otherwise spaces are included in the file
  6777. --- name. See `option-backslash` about using backslashes. The use of
  6778. --- `:set+=` and `:set-=` is preferred when adding or removing directories
  6779. --- from the list. This avoids problems when a future version uses
  6780. --- another default. Backticks cannot be used in this option for security
  6781. --- reasons.
  6782. ---
  6783. --- @type string
  6784. vim.o.thesaurus = ""
  6785. vim.o.tsr = vim.o.thesaurus
  6786. vim.bo.thesaurus = vim.o.thesaurus
  6787. vim.bo.tsr = vim.bo.thesaurus
  6788. vim.go.thesaurus = vim.o.thesaurus
  6789. vim.go.tsr = vim.go.thesaurus
  6790. --- This option specifies a function to be used for thesaurus completion
  6791. --- with CTRL-X CTRL-T. `i_CTRL-X_CTRL-T` See `compl-thesaurusfunc`.
  6792. --- The value can be the name of a function, a `lambda` or a `Funcref`.
  6793. --- See `option-value-function` for more information.
  6794. ---
  6795. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6796. --- security reasons.
  6797. ---
  6798. --- @type string
  6799. vim.o.thesaurusfunc = ""
  6800. vim.o.tsrfu = vim.o.thesaurusfunc
  6801. vim.bo.thesaurusfunc = vim.o.thesaurusfunc
  6802. vim.bo.tsrfu = vim.bo.thesaurusfunc
  6803. vim.go.thesaurusfunc = vim.o.thesaurusfunc
  6804. vim.go.tsrfu = vim.go.thesaurusfunc
  6805. --- When on: The tilde command "~" behaves like an operator.
  6806. ---
  6807. --- @type boolean
  6808. vim.o.tildeop = false
  6809. vim.o.top = vim.o.tildeop
  6810. vim.go.tildeop = vim.o.tildeop
  6811. vim.go.top = vim.go.tildeop
  6812. --- This option and 'timeoutlen' determine the behavior when part of a
  6813. --- mapped key sequence has been received. For example, if <c-f> is
  6814. --- pressed and 'timeout' is set, Nvim will wait 'timeoutlen' milliseconds
  6815. --- for any key that can follow <c-f> in a mapping.
  6816. ---
  6817. --- @type boolean
  6818. vim.o.timeout = true
  6819. vim.o.to = vim.o.timeout
  6820. vim.go.timeout = vim.o.timeout
  6821. vim.go.to = vim.go.timeout
  6822. --- Time in milliseconds to wait for a mapped sequence to complete.
  6823. ---
  6824. --- @type integer
  6825. vim.o.timeoutlen = 1000
  6826. vim.o.tm = vim.o.timeoutlen
  6827. vim.go.timeoutlen = vim.o.timeoutlen
  6828. vim.go.tm = vim.go.timeoutlen
  6829. --- When on, the title of the window will be set to the value of
  6830. --- 'titlestring' (if it is not empty), or to:
  6831. --- filename [+=-] (path) - Nvim
  6832. --- Where:
  6833. --- filename the name of the file being edited
  6834. --- - indicates the file cannot be modified, 'ma' off
  6835. --- + indicates the file was modified
  6836. --- = indicates the file is read-only
  6837. --- =+ indicates the file is read-only and modified
  6838. --- (path) is the path of the file being edited
  6839. --- - Nvim the server name `v:servername` or "Nvim"
  6840. ---
  6841. --- @type boolean
  6842. vim.o.title = false
  6843. vim.go.title = vim.o.title
  6844. --- Gives the percentage of 'columns' to use for the length of the window
  6845. --- title. When the title is longer, only the end of the path name is
  6846. --- shown. A '<' character before the path name is used to indicate this.
  6847. --- Using a percentage makes this adapt to the width of the window. But
  6848. --- it won't work perfectly, because the actual number of characters
  6849. --- available also depends on the font used and other things in the title
  6850. --- bar. When 'titlelen' is zero the full path is used. Otherwise,
  6851. --- values from 1 to 30000 percent can be used.
  6852. --- 'titlelen' is also used for the 'titlestring' option.
  6853. ---
  6854. --- @type integer
  6855. vim.o.titlelen = 85
  6856. vim.go.titlelen = vim.o.titlelen
  6857. --- If not empty, this option will be used to set the window title when
  6858. --- exiting. Only if 'title' is enabled.
  6859. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6860. --- security reasons.
  6861. ---
  6862. --- @type string
  6863. vim.o.titleold = ""
  6864. vim.go.titleold = vim.o.titleold
  6865. --- When this option is not empty, it will be used for the title of the
  6866. --- window. This happens only when the 'title' option is on.
  6867. ---
  6868. --- When this option contains printf-style '%' items, they will be
  6869. --- expanded according to the rules used for 'statusline'. If it contains
  6870. --- an invalid '%' format, the value is used as-is and no error or warning
  6871. --- will be given when the value is set.
  6872. ---
  6873. --- The default behaviour is equivalent to:
  6874. ---
  6875. --- ```vim
  6876. --- set titlestring=%t%(\ %M%)%(\ \(%{expand(\"%:~:h\")}\)%)%a\ -\ Nvim
  6877. --- ```
  6878. ---
  6879. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  6880. ---
  6881. --- Example:
  6882. ---
  6883. --- ```vim
  6884. --- auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
  6885. --- set title titlestring=%<%F%=%l/%L-%P titlelen=70
  6886. --- ```
  6887. --- The value of 'titlelen' is used to align items in the middle or right
  6888. --- of the available space.
  6889. --- Some people prefer to have the file name first:
  6890. ---
  6891. --- ```vim
  6892. --- set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
  6893. --- ```
  6894. --- Note the use of "%{ }" and an expression to get the path of the file,
  6895. --- without the file name. The "%( %)" constructs are used to add a
  6896. --- separating space only when needed.
  6897. --- NOTE: Use of special characters in 'titlestring' may cause the display
  6898. --- to be garbled (e.g., when it contains a CR or NL character).
  6899. ---
  6900. --- @type string
  6901. vim.o.titlestring = ""
  6902. vim.go.titlestring = vim.o.titlestring
  6903. --- This option and 'ttimeoutlen' determine the behavior when part of a
  6904. --- key code sequence has been received by the `TUI`.
  6905. ---
  6906. --- For example if <Esc> (the \x1b byte) is received and 'ttimeout' is
  6907. --- set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to
  6908. --- complete a key code sequence. If no input arrives before the timeout,
  6909. --- a single <Esc> is assumed. Many TUI cursor key codes start with <Esc>.
  6910. ---
  6911. --- On very slow systems this may fail, causing cursor keys not to work
  6912. --- sometimes. If you discover this problem you can ":set ttimeoutlen=9999".
  6913. --- Nvim will wait for the next character to arrive after an <Esc>.
  6914. ---
  6915. --- @type boolean
  6916. vim.o.ttimeout = true
  6917. vim.go.ttimeout = vim.o.ttimeout
  6918. --- Time in milliseconds to wait for a key code sequence to complete. Also
  6919. --- used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has
  6920. --- been typed.
  6921. ---
  6922. --- @type integer
  6923. vim.o.ttimeoutlen = 50
  6924. vim.o.ttm = vim.o.ttimeoutlen
  6925. vim.go.ttimeoutlen = vim.o.ttimeoutlen
  6926. vim.go.ttm = vim.go.ttimeoutlen
  6927. --- List of directory names for undo files, separated with commas.
  6928. --- See 'backupdir' for details of the format.
  6929. --- "." means using the directory of the file. The undo file name for
  6930. --- "file.txt" is ".file.txt.un~".
  6931. --- For other directories the file name is the full path of the edited
  6932. --- file, with path separators replaced with "%".
  6933. --- When writing: The first directory that exists is used. "." always
  6934. --- works, no directories after "." will be used for writing. If none of
  6935. --- the directories exist Nvim will attempt to create the last directory in
  6936. --- the list.
  6937. --- When reading all entries are tried to find an undo file. The first
  6938. --- undo file that exists is used. When it cannot be read an error is
  6939. --- given, no further entry is used.
  6940. --- See `undo-persistence`.
  6941. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6942. --- security reasons.
  6943. ---
  6944. --- Note that unlike 'directory' and 'backupdir', 'undodir' always acts as
  6945. --- though the trailing slashes are present (see 'backupdir' for what this
  6946. --- means).
  6947. ---
  6948. --- @type string
  6949. vim.o.undodir = "$XDG_STATE_HOME/nvim/undo//"
  6950. vim.o.udir = vim.o.undodir
  6951. vim.go.undodir = vim.o.undodir
  6952. vim.go.udir = vim.go.undodir
  6953. --- When on, Vim automatically saves undo history to an undo file when
  6954. --- writing a buffer to a file, and restores undo history from the same
  6955. --- file on buffer read.
  6956. --- The directory where the undo file is stored is specified by 'undodir'.
  6957. --- For more information about this feature see `undo-persistence`.
  6958. --- The undo file is not read when 'undoreload' causes the buffer from
  6959. --- before a reload to be saved for undo.
  6960. --- When 'undofile' is turned off the undo file is NOT deleted.
  6961. ---
  6962. --- @type boolean
  6963. vim.o.undofile = false
  6964. vim.o.udf = vim.o.undofile
  6965. vim.bo.undofile = vim.o.undofile
  6966. vim.bo.udf = vim.bo.undofile
  6967. --- Maximum number of changes that can be undone. Since undo information
  6968. --- is kept in memory, higher numbers will cause more memory to be used.
  6969. --- Nevertheless, a single change can already use a large amount of memory.
  6970. --- Set to 0 for Vi compatibility: One level of undo and "u" undoes
  6971. --- itself:
  6972. ---
  6973. --- ```vim
  6974. --- set ul=0
  6975. --- ```
  6976. --- But you can also get Vi compatibility by including the 'u' flag in
  6977. --- 'cpoptions', and still be able to use CTRL-R to repeat undo.
  6978. --- Also see `undo-two-ways`.
  6979. --- Set to -1 for no undo at all. You might want to do this only for the
  6980. --- current buffer:
  6981. ---
  6982. --- ```vim
  6983. --- setlocal ul=-1
  6984. --- ```
  6985. --- This helps when you run out of memory for a single change.
  6986. ---
  6987. --- The local value is set to -123456 when the global value is to be used.
  6988. ---
  6989. --- Also see `clear-undo`.
  6990. ---
  6991. --- @type integer
  6992. vim.o.undolevels = 1000
  6993. vim.o.ul = vim.o.undolevels
  6994. vim.bo.undolevels = vim.o.undolevels
  6995. vim.bo.ul = vim.bo.undolevels
  6996. vim.go.undolevels = vim.o.undolevels
  6997. vim.go.ul = vim.go.undolevels
  6998. --- Save the whole buffer for undo when reloading it. This applies to the
  6999. --- ":e!" command and reloading for when the buffer changed outside of
  7000. --- Vim. `FileChangedShell`
  7001. --- The save only happens when this option is negative or when the number
  7002. --- of lines is smaller than the value of this option.
  7003. --- Set this option to zero to disable undo for a reload.
  7004. ---
  7005. --- When saving undo for a reload, any undo file is not read.
  7006. ---
  7007. --- Note that this causes the whole buffer to be stored in memory. Set
  7008. --- this option to a lower value if you run out of memory.
  7009. ---
  7010. --- @type integer
  7011. vim.o.undoreload = 10000
  7012. vim.o.ur = vim.o.undoreload
  7013. vim.go.undoreload = vim.o.undoreload
  7014. vim.go.ur = vim.go.undoreload
  7015. --- After typing this many characters the swap file will be written to
  7016. --- disk. When zero, no swap file will be created at all (see chapter on
  7017. --- recovery `crash-recovery`). 'updatecount' is set to zero by starting
  7018. --- Vim with the "-n" option, see `startup`. When editing in readonly
  7019. --- mode this option will be initialized to 10000.
  7020. --- The swapfile can be disabled per buffer with `'swapfile'`.
  7021. --- When 'updatecount' is set from zero to non-zero, swap files are
  7022. --- created for all buffers that have 'swapfile' set. When 'updatecount'
  7023. --- is set to zero, existing swap files are not deleted.
  7024. --- This option has no meaning in buffers where `'buftype'` is "nofile"
  7025. --- or "nowrite".
  7026. ---
  7027. --- @type integer
  7028. vim.o.updatecount = 200
  7029. vim.o.uc = vim.o.updatecount
  7030. vim.go.updatecount = vim.o.updatecount
  7031. vim.go.uc = vim.go.updatecount
  7032. --- If this many milliseconds nothing is typed the swap file will be
  7033. --- written to disk (see `crash-recovery`). Also used for the
  7034. --- `CursorHold` autocommand event.
  7035. ---
  7036. --- @type integer
  7037. vim.o.updatetime = 4000
  7038. vim.o.ut = vim.o.updatetime
  7039. vim.go.updatetime = vim.o.updatetime
  7040. vim.go.ut = vim.go.updatetime
  7041. --- A list of the number of spaces that a <Tab> counts for while editing,
  7042. --- such as inserting a <Tab> or using <BS>. It "feels" like variable-
  7043. --- width <Tab>s are being inserted, while in fact a mixture of spaces
  7044. --- and <Tab>s is used. Tab widths are separated with commas, with the
  7045. --- final value applying to all subsequent tabs.
  7046. ---
  7047. --- For example, when editing assembly language files where statements
  7048. --- start in the 9th column and comments in the 41st, it may be useful
  7049. --- to use the following:
  7050. ---
  7051. --- ```vim
  7052. --- set varsofttabstop=8,32,8
  7053. --- ```
  7054. --- This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
  7055. --- for every column thereafter.
  7056. ---
  7057. --- Note that the value of `'softtabstop'` will be ignored while
  7058. --- 'varsofttabstop' is set.
  7059. ---
  7060. --- @type string
  7061. vim.o.varsofttabstop = ""
  7062. vim.o.vsts = vim.o.varsofttabstop
  7063. vim.bo.varsofttabstop = vim.o.varsofttabstop
  7064. vim.bo.vsts = vim.bo.varsofttabstop
  7065. --- A list of the number of spaces that a <Tab> in the file counts for,
  7066. --- separated by commas. Each value corresponds to one tab, with the
  7067. --- final value applying to all subsequent tabs. For example:
  7068. ---
  7069. --- ```vim
  7070. --- set vartabstop=4,20,10,8
  7071. --- ```
  7072. --- This will make the first tab 4 spaces wide, the second 20 spaces,
  7073. --- the third 10 spaces, and all following tabs 8 spaces.
  7074. ---
  7075. --- Note that the value of `'tabstop'` will be ignored while 'vartabstop'
  7076. --- is set.
  7077. ---
  7078. --- @type string
  7079. vim.o.vartabstop = ""
  7080. vim.o.vts = vim.o.vartabstop
  7081. vim.bo.vartabstop = vim.o.vartabstop
  7082. vim.bo.vts = vim.bo.vartabstop
  7083. --- Sets the verbosity level. Also set by `-V` and `:verbose`.
  7084. ---
  7085. --- Tracing of assignments to options, mappings, etc. in Lua scripts is
  7086. --- enabled at level 1; Lua scripts are not traced when 'verbose' is 0,
  7087. --- for performance.
  7088. ---
  7089. --- If greater than or equal to a given level, Nvim produces the following
  7090. --- messages:
  7091. ---
  7092. --- Level Messages ~
  7093. --- ----------------------------------------------------------------------
  7094. --- 1 Enables Lua tracing (see above). Does not produce messages.
  7095. --- 2 When a file is ":source"'ed, or `shada` file is read or written.
  7096. --- 3 UI info, terminal capabilities.
  7097. --- 4 Shell commands.
  7098. --- 5 Every searched tags file and include file.
  7099. --- 8 Files for which a group of autocommands is executed.
  7100. --- 9 Executed autocommands.
  7101. --- 11 Finding items in a path.
  7102. --- 12 Vimscript function calls.
  7103. --- 13 When an exception is thrown, caught, finished, or discarded.
  7104. --- 14 Anything pending in a ":finally" clause.
  7105. --- 15 Ex commands from a script (truncated at 200 characters).
  7106. --- 16 Ex commands.
  7107. ---
  7108. --- If 'verbosefile' is set then the verbose messages are not displayed.
  7109. ---
  7110. --- @type integer
  7111. vim.o.verbose = 0
  7112. vim.o.vbs = vim.o.verbose
  7113. vim.go.verbose = vim.o.verbose
  7114. vim.go.vbs = vim.go.verbose
  7115. --- When not empty all messages are written in a file with this name.
  7116. --- When the file exists messages are appended.
  7117. --- Writing to the file ends when Vim exits or when 'verbosefile' is made
  7118. --- empty. Writes are buffered, thus may not show up for some time.
  7119. --- Setting 'verbosefile' to a new value is like making it empty first.
  7120. --- The difference with `:redir` is that verbose messages are not
  7121. --- displayed when 'verbosefile' is set.
  7122. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  7123. --- security reasons.
  7124. ---
  7125. --- @type string
  7126. vim.o.verbosefile = ""
  7127. vim.o.vfile = vim.o.verbosefile
  7128. vim.go.verbosefile = vim.o.verbosefile
  7129. vim.go.vfile = vim.go.verbosefile
  7130. --- Name of the directory where to store files for `:mkview`.
  7131. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  7132. --- security reasons.
  7133. ---
  7134. --- @type string
  7135. vim.o.viewdir = "$XDG_STATE_HOME/nvim/view//"
  7136. vim.o.vdir = vim.o.viewdir
  7137. vim.go.viewdir = vim.o.viewdir
  7138. vim.go.vdir = vim.go.viewdir
  7139. --- Changes the effect of the `:mkview` command. It is a comma-separated
  7140. --- list of words. Each word enables saving and restoring something:
  7141. --- word save and restore ~
  7142. --- cursor cursor position in file and in window
  7143. --- curdir local current directory, if set with `:lcd`
  7144. --- folds manually created folds, opened/closed folds and local
  7145. --- fold options
  7146. --- options options and mappings local to a window or buffer (not
  7147. --- global values for local options)
  7148. --- localoptions same as "options"
  7149. --- slash `deprecated` Always enabled. Uses "/" in filenames.
  7150. --- unix `deprecated` Always enabled. Uses "\n" line endings.
  7151. ---
  7152. --- @type string
  7153. vim.o.viewoptions = "folds,cursor,curdir"
  7154. vim.o.vop = vim.o.viewoptions
  7155. vim.go.viewoptions = vim.o.viewoptions
  7156. vim.go.vop = vim.go.viewoptions
  7157. --- A comma-separated list of these words:
  7158. --- block Allow virtual editing in Visual block mode.
  7159. --- insert Allow virtual editing in Insert mode.
  7160. --- all Allow virtual editing in all modes.
  7161. --- onemore Allow the cursor to move just past the end of the line
  7162. --- none When used as the local value, do not allow virtual
  7163. --- editing even when the global value is set. When used
  7164. --- as the global value, "none" is the same as "".
  7165. --- NONE Alternative spelling of "none".
  7166. ---
  7167. --- Virtual editing means that the cursor can be positioned where there is
  7168. --- no actual character. This can be halfway into a tab or beyond the end
  7169. --- of the line. Useful for selecting a rectangle in Visual mode and
  7170. --- editing a table.
  7171. --- "onemore" is not the same, it will only allow moving the cursor just
  7172. --- after the last character of the line. This makes some commands more
  7173. --- consistent. Previously the cursor was always past the end of the line
  7174. --- if the line was empty. But it is far from Vi compatible. It may also
  7175. --- break some plugins or Vim scripts. For example because `l` can move
  7176. --- the cursor after the last character. Use with care!
  7177. --- Using the `$` command will move to the last character in the line, not
  7178. --- past it. This may actually move the cursor to the left!
  7179. --- The `g$` command will move to the end of the screen line.
  7180. --- It doesn't make sense to combine "all" with "onemore", but you will
  7181. --- not get a warning for it.
  7182. --- When combined with other words, "none" is ignored.
  7183. ---
  7184. --- @type string
  7185. vim.o.virtualedit = ""
  7186. vim.o.ve = vim.o.virtualedit
  7187. vim.wo.virtualedit = vim.o.virtualedit
  7188. vim.wo.ve = vim.wo.virtualedit
  7189. vim.go.virtualedit = vim.o.virtualedit
  7190. vim.go.ve = vim.go.virtualedit
  7191. --- Use visual bell instead of beeping. Also see 'errorbells'.
  7192. ---
  7193. --- @type boolean
  7194. vim.o.visualbell = false
  7195. vim.o.vb = vim.o.visualbell
  7196. vim.go.visualbell = vim.o.visualbell
  7197. vim.go.vb = vim.go.visualbell
  7198. --- Give a warning message when a shell command is used while the buffer
  7199. --- has been changed.
  7200. ---
  7201. --- @type boolean
  7202. vim.o.warn = true
  7203. vim.go.warn = vim.o.warn
  7204. --- Allow specified keys that move the cursor left/right to move to the
  7205. --- previous/next line when the cursor is on the first/last character in
  7206. --- the line. Concatenate characters to allow this for these keys:
  7207. --- char key mode ~
  7208. --- b <BS> Normal and Visual
  7209. --- s <Space> Normal and Visual
  7210. --- h "h" Normal and Visual (not recommended)
  7211. --- l "l" Normal and Visual (not recommended)
  7212. --- < <Left> Normal and Visual
  7213. --- > <Right> Normal and Visual
  7214. --- ~ "~" Normal
  7215. --- [ <Left> Insert and Replace
  7216. --- ] <Right> Insert and Replace
  7217. --- For example:
  7218. ---
  7219. --- ```vim
  7220. --- set ww=<,>,[,]
  7221. --- ```
  7222. --- allows wrap only when cursor keys are used.
  7223. --- When the movement keys are used in combination with a delete or change
  7224. --- operator, the <EOL> also counts for a character. This makes "3h"
  7225. --- different from "3dh" when the cursor crosses the end of a line. This
  7226. --- is also true for "x" and "X", because they do the same as "dl" and
  7227. --- "dh". If you use this, you may also want to use the mapping
  7228. --- ":map <BS> X" to make backspace delete the character in front of the
  7229. --- cursor.
  7230. --- When 'l' is included and it is used after an operator at the end of a
  7231. --- line (not an empty line) then it will not move to the next line. This
  7232. --- makes "dl", "cl", "yl" etc. work normally.
  7233. ---
  7234. --- @type string
  7235. vim.o.whichwrap = "b,s"
  7236. vim.o.ww = vim.o.whichwrap
  7237. vim.go.whichwrap = vim.o.whichwrap
  7238. vim.go.ww = vim.go.whichwrap
  7239. --- Character you have to type to start wildcard expansion in the
  7240. --- command-line, as specified with 'wildmode'.
  7241. --- More info here: `cmdline-completion`.
  7242. --- The character is not recognized when used inside a macro. See
  7243. --- 'wildcharm' for that.
  7244. --- Some keys will not work, such as CTRL-C, <CR> and Enter.
  7245. --- <Esc> can be used, but hitting it twice in a row will still exit
  7246. --- command-line as a failsafe measure.
  7247. --- Although 'wc' is a number option, it can be specified as a number, a
  7248. --- single character, a `key-notation` (e.g. <Up>, <C-F>) or a letter
  7249. --- preceded with a caret (e.g. `^F` is CTRL-F):
  7250. ---
  7251. --- ```vim
  7252. --- :set wc=27
  7253. --- :set wc=X
  7254. --- :set wc=^I
  7255. --- set wc=<Tab>
  7256. --- ```
  7257. ---
  7258. ---
  7259. --- @type integer
  7260. vim.o.wildchar = 9
  7261. vim.o.wc = vim.o.wildchar
  7262. vim.go.wildchar = vim.o.wildchar
  7263. vim.go.wc = vim.go.wildchar
  7264. --- 'wildcharm' works exactly like 'wildchar', except that it is
  7265. --- recognized when used inside a macro. You can find "spare" command-line
  7266. --- keys suitable for this option by looking at `ex-edit-index`. Normally
  7267. --- you'll never actually type 'wildcharm', just use it in mappings that
  7268. --- automatically invoke completion mode, e.g.:
  7269. ---
  7270. --- ```vim
  7271. --- set wcm=<C-Z>
  7272. --- cnoremap ss so $vim/sessions/*.vim<C-Z>
  7273. --- ```
  7274. --- Then after typing :ss you can use CTRL-P & CTRL-N.
  7275. ---
  7276. --- @type integer
  7277. vim.o.wildcharm = 0
  7278. vim.o.wcm = vim.o.wildcharm
  7279. vim.go.wildcharm = vim.o.wildcharm
  7280. vim.go.wcm = vim.go.wildcharm
  7281. --- A list of file patterns. A file that matches with one of these
  7282. --- patterns is ignored when expanding `wildcards`, completing file or
  7283. --- directory names, and influences the result of `expand()`, `glob()` and
  7284. --- `globpath()` unless a flag is passed to disable this.
  7285. --- The pattern is used like with `:autocmd`, see `autocmd-pattern`.
  7286. --- Also see 'suffixes'.
  7287. --- Example:
  7288. ---
  7289. --- ```vim
  7290. --- set wildignore=*.o,*.obj
  7291. --- ```
  7292. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  7293. --- a pattern from the list. This avoids problems when a future version
  7294. --- uses another default.
  7295. ---
  7296. --- @type string
  7297. vim.o.wildignore = ""
  7298. vim.o.wig = vim.o.wildignore
  7299. vim.go.wildignore = vim.o.wildignore
  7300. vim.go.wig = vim.go.wildignore
  7301. --- When set case is ignored when completing file names and directories.
  7302. --- Has no effect when 'fileignorecase' is set.
  7303. --- Does not apply when the shell is used to expand wildcards, which
  7304. --- happens when there are special characters.
  7305. ---
  7306. --- @type boolean
  7307. vim.o.wildignorecase = false
  7308. vim.o.wic = vim.o.wildignorecase
  7309. vim.go.wildignorecase = vim.o.wildignorecase
  7310. vim.go.wic = vim.go.wildignorecase
  7311. --- When 'wildmenu' is on, command-line completion operates in an enhanced
  7312. --- mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
  7313. --- the possible matches are shown.
  7314. --- When 'wildoptions' contains "pum", then the completion matches are
  7315. --- shown in a popup menu. Otherwise they are displayed just above the
  7316. --- command line, with the first match highlighted (overwriting the status
  7317. --- line, if there is one).
  7318. --- Keys that show the previous/next match, such as <Tab> or
  7319. --- CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
  7320. --- 'wildmode' must specify "full": "longest" and "list" do not start
  7321. --- 'wildmenu' mode. You can check the current mode with `wildmenumode()`.
  7322. --- The menu is cancelled when a key is hit that is not used for selecting
  7323. --- a completion.
  7324. ---
  7325. --- While the menu is active these keys have special meanings:
  7326. --- CTRL-P - go to the previous entry
  7327. --- CTRL-N - go to the next entry
  7328. --- <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
  7329. --- <PageUp> - select a match several entries back
  7330. --- <PageDown> - select a match several entries further
  7331. --- <Up> - in filename/menu name completion: move up into
  7332. --- parent directory or parent menu.
  7333. --- <Down> - in filename/menu name completion: move into a
  7334. --- subdirectory or submenu.
  7335. --- <CR> - in menu completion, when the cursor is just after a
  7336. --- dot: move into a submenu.
  7337. --- CTRL-E - end completion, go back to what was there before
  7338. --- selecting a match.
  7339. --- CTRL-Y - accept the currently selected match and stop
  7340. --- completion.
  7341. ---
  7342. --- If you want <Left> and <Right> to move the cursor instead of selecting
  7343. --- a different match, use this:
  7344. ---
  7345. --- ```vim
  7346. --- cnoremap <Left> <Space><BS><Left>
  7347. --- cnoremap <Right> <Space><BS><Right>
  7348. --- ```
  7349. ---
  7350. --- `hl-WildMenu` highlights the current match.
  7351. ---
  7352. --- @type boolean
  7353. vim.o.wildmenu = true
  7354. vim.o.wmnu = vim.o.wildmenu
  7355. vim.go.wildmenu = vim.o.wildmenu
  7356. vim.go.wmnu = vim.go.wildmenu
  7357. --- Completion mode that is used for the character specified with
  7358. --- 'wildchar'. It is a comma-separated list of up to four parts. Each
  7359. --- part specifies what to do for each consecutive use of 'wildchar'. The
  7360. --- first part specifies the behavior for the first use of 'wildchar',
  7361. --- The second part for the second use, etc.
  7362. ---
  7363. --- Each part consists of a colon separated list consisting of the
  7364. --- following possible values:
  7365. --- "" Complete only the first match.
  7366. --- "full" Complete the next full match. After the last match,
  7367. --- the original string is used and then the first match
  7368. --- again. Will also start 'wildmenu' if it is enabled.
  7369. --- "longest" Complete till longest common string. If this doesn't
  7370. --- result in a longer string, use the next part.
  7371. --- "list" When more than one match, list all matches.
  7372. --- "lastused" When completing buffer names and more than one buffer
  7373. --- matches, sort buffers by time last used (other than
  7374. --- the current buffer).
  7375. --- When there is only a single match, it is fully completed in all cases.
  7376. ---
  7377. --- Examples of useful colon-separated values:
  7378. --- "longest:full" Like "longest", but also start 'wildmenu' if it is
  7379. --- enabled. Will not complete to the next full match.
  7380. --- "list:full" When more than one match, list all matches and
  7381. --- complete first match.
  7382. --- "list:longest" When more than one match, list all matches and
  7383. --- complete till longest common string.
  7384. --- "list:lastused" When more than one buffer matches, list all matches
  7385. --- and sort buffers by time last used (other than the
  7386. --- current buffer).
  7387. ---
  7388. --- Examples:
  7389. ---
  7390. --- ```vim
  7391. --- set wildmode=full
  7392. --- ```
  7393. --- Complete first full match, next match, etc. (the default)
  7394. ---
  7395. --- ```vim
  7396. --- set wildmode=longest,full
  7397. --- ```
  7398. --- Complete longest common string, then each full match
  7399. ---
  7400. --- ```vim
  7401. --- set wildmode=list:full
  7402. --- ```
  7403. --- List all matches and complete each full match
  7404. ---
  7405. --- ```vim
  7406. --- set wildmode=list,full
  7407. --- ```
  7408. --- List all matches without completing, then each full match
  7409. ---
  7410. --- ```vim
  7411. --- set wildmode=longest,list
  7412. --- ```
  7413. --- Complete longest common string, then list alternatives.
  7414. --- More info here: `cmdline-completion`.
  7415. ---
  7416. --- @type string
  7417. vim.o.wildmode = "full"
  7418. vim.o.wim = vim.o.wildmode
  7419. vim.go.wildmode = vim.o.wildmode
  7420. vim.go.wim = vim.go.wildmode
  7421. --- A list of words that change how `cmdline-completion` is done.
  7422. --- The following values are supported:
  7423. --- fuzzy Use `fuzzy-matching` to find completion matches. When
  7424. --- this value is specified, wildcard expansion will not
  7425. --- be used for completion. The matches will be sorted by
  7426. --- the "best match" rather than alphabetically sorted.
  7427. --- This will find more matches than the wildcard
  7428. --- expansion. Currently fuzzy matching based completion
  7429. --- is not supported for file and directory names and
  7430. --- instead wildcard expansion is used.
  7431. --- pum Display the completion matches using the popup menu
  7432. --- in the same style as the `ins-completion-menu`.
  7433. --- tagfile When using CTRL-D to list matching tags, the kind of
  7434. --- tag and the file of the tag is listed. Only one match
  7435. --- is displayed per line. Often used tag kinds are:
  7436. --- d #define
  7437. --- f function
  7438. ---
  7439. --- @type string
  7440. vim.o.wildoptions = "pum,tagfile"
  7441. vim.o.wop = vim.o.wildoptions
  7442. vim.go.wildoptions = vim.o.wildoptions
  7443. vim.go.wop = vim.go.wildoptions
  7444. --- only used in Win32
  7445. --- Some GUI versions allow the access to menu entries by using the ALT
  7446. --- key in combination with a character that appears underlined in the
  7447. --- menu. This conflicts with the use of the ALT key for mappings and
  7448. --- entering special characters. This option tells what to do:
  7449. --- no Don't use ALT keys for menus. ALT key combinations can be
  7450. --- mapped, but there is no automatic handling.
  7451. --- yes ALT key handling is done by the windowing system. ALT key
  7452. --- combinations cannot be mapped.
  7453. --- menu Using ALT in combination with a character that is a menu
  7454. --- shortcut key, will be handled by the windowing system. Other
  7455. --- keys can be mapped.
  7456. --- If the menu is disabled by excluding 'm' from 'guioptions', the ALT
  7457. --- key is never used for the menu.
  7458. --- This option is not used for <F10>; on Win32.
  7459. ---
  7460. --- @type 'yes'|'menu'|'no'
  7461. vim.o.winaltkeys = "menu"
  7462. vim.o.wak = vim.o.winaltkeys
  7463. vim.go.winaltkeys = vim.o.winaltkeys
  7464. vim.go.wak = vim.go.winaltkeys
  7465. --- When non-empty, this option enables the window bar and determines its
  7466. --- contents. The window bar is a bar that's shown at the top of every
  7467. --- window with it enabled. The value of 'winbar' is evaluated like with
  7468. --- 'statusline'.
  7469. ---
  7470. --- When changing something that is used in 'winbar' that does not trigger
  7471. --- it to be updated, use `:redrawstatus`.
  7472. ---
  7473. --- Floating windows do not use the global value of 'winbar'. The
  7474. --- window-local value of 'winbar' must be set for a floating window to
  7475. --- have a window bar.
  7476. ---
  7477. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  7478. ---
  7479. --- @type string
  7480. vim.o.winbar = ""
  7481. vim.o.wbr = vim.o.winbar
  7482. vim.wo.winbar = vim.o.winbar
  7483. vim.wo.wbr = vim.wo.winbar
  7484. vim.go.winbar = vim.o.winbar
  7485. vim.go.wbr = vim.go.winbar
  7486. --- Enables pseudo-transparency for a floating window. Valid values are in
  7487. --- the range of 0 for fully opaque window (disabled) to 100 for fully
  7488. --- transparent background. Values between 0-30 are typically most useful.
  7489. ---
  7490. --- UI-dependent. Works best with RGB colors. 'termguicolors'
  7491. ---
  7492. --- @type integer
  7493. vim.o.winblend = 0
  7494. vim.o.winbl = vim.o.winblend
  7495. vim.wo.winblend = vim.o.winblend
  7496. vim.wo.winbl = vim.wo.winblend
  7497. --- Window height used for `CTRL-F` and `CTRL-B` when there is only one
  7498. --- window and the value is smaller than 'lines' minus one. The screen
  7499. --- will scroll 'window' minus two lines, with a minimum of one.
  7500. --- When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
  7501. --- in a much smarter way, taking care of wrapping lines.
  7502. --- When resizing the Vim window, and the value is smaller than 1 or more
  7503. --- than or equal to 'lines' it will be set to 'lines' minus 1.
  7504. --- Note: Do not confuse this with the height of the Vim window, use
  7505. --- 'lines' for that.
  7506. ---
  7507. --- @type integer
  7508. vim.o.window = 0
  7509. vim.o.wi = vim.o.window
  7510. vim.go.window = vim.o.window
  7511. vim.go.wi = vim.go.window
  7512. --- If enabled, the window and the buffer it is displaying are paired.
  7513. --- For example, attempting to change the buffer with `:edit` will fail.
  7514. --- Other commands which change a window's buffer such as `:cnext` will
  7515. --- also skip any window with 'winfixbuf' enabled. However if an Ex
  7516. --- command has a "!" modifier, it can force switching buffers.
  7517. ---
  7518. --- @type boolean
  7519. vim.o.winfixbuf = false
  7520. vim.o.wfb = vim.o.winfixbuf
  7521. vim.wo.winfixbuf = vim.o.winfixbuf
  7522. vim.wo.wfb = vim.wo.winfixbuf
  7523. --- Keep the window height when windows are opened or closed and
  7524. --- 'equalalways' is set. Also for `CTRL-W_=`. Set by default for the
  7525. --- `preview-window` and `quickfix-window`.
  7526. --- The height may be changed anyway when running out of room.
  7527. ---
  7528. --- @type boolean
  7529. vim.o.winfixheight = false
  7530. vim.o.wfh = vim.o.winfixheight
  7531. vim.wo.winfixheight = vim.o.winfixheight
  7532. vim.wo.wfh = vim.wo.winfixheight
  7533. --- Keep the window width when windows are opened or closed and
  7534. --- 'equalalways' is set. Also for `CTRL-W_=`.
  7535. --- The width may be changed anyway when running out of room.
  7536. ---
  7537. --- @type boolean
  7538. vim.o.winfixwidth = false
  7539. vim.o.wfw = vim.o.winfixwidth
  7540. vim.wo.winfixwidth = vim.o.winfixwidth
  7541. vim.wo.wfw = vim.wo.winfixwidth
  7542. --- Minimal number of lines for the current window. This is not a hard
  7543. --- minimum, Vim will use fewer lines if there is not enough room. If the
  7544. --- focus goes to a window that is smaller, its size is increased, at the
  7545. --- cost of the height of other windows.
  7546. --- Set 'winheight' to a small number for normal editing.
  7547. --- Set it to 999 to make the current window fill most of the screen.
  7548. --- Other windows will be only 'winminheight' high. This has the drawback
  7549. --- that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
  7550. --- to create only two windows, set the option after startup is done,
  7551. --- using the `VimEnter` event:
  7552. ---
  7553. --- ```vim
  7554. --- au VimEnter * set winheight=999
  7555. --- ```
  7556. --- Minimum value is 1.
  7557. --- The height is not adjusted after one of the commands that change the
  7558. --- height of the current window.
  7559. --- 'winheight' applies to the current window. Use 'winminheight' to set
  7560. --- the minimal height for other windows.
  7561. ---
  7562. --- @type integer
  7563. vim.o.winheight = 1
  7564. vim.o.wh = vim.o.winheight
  7565. vim.go.winheight = vim.o.winheight
  7566. vim.go.wh = vim.go.winheight
  7567. --- Window-local highlights. Comma-delimited list of highlight
  7568. --- `group-name` pairs "{hl-from}:{hl-to},..." where each {hl-from} is
  7569. --- a `highlight-groups` item to be overridden by {hl-to} group in
  7570. --- the window.
  7571. ---
  7572. --- Note: highlight namespaces take precedence over 'winhighlight'.
  7573. --- See `nvim_win_set_hl_ns()` and `nvim_set_hl()`.
  7574. ---
  7575. --- Highlights of vertical separators are determined by the window to the
  7576. --- left of the separator. The 'tabline' highlight of a tabpage is
  7577. --- decided by the last-focused window of the tabpage. Highlights of
  7578. --- the popupmenu are determined by the current window. Highlights in the
  7579. --- message area cannot be overridden.
  7580. ---
  7581. --- Example: show a different color for non-current windows:
  7582. ---
  7583. --- ```vim
  7584. --- set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC
  7585. --- ```
  7586. ---
  7587. ---
  7588. --- @type string
  7589. vim.o.winhighlight = ""
  7590. vim.o.winhl = vim.o.winhighlight
  7591. vim.wo.winhighlight = vim.o.winhighlight
  7592. vim.wo.winhl = vim.wo.winhighlight
  7593. --- The minimal height of a window, when it's not the current window.
  7594. --- This is a hard minimum, windows will never become smaller.
  7595. --- When set to zero, windows may be "squashed" to zero lines (i.e. just a
  7596. --- status bar) if necessary. They will return to at least one line when
  7597. --- they become active (since the cursor has to have somewhere to go.)
  7598. --- Use 'winheight' to set the minimal height of the current window.
  7599. --- This option is only checked when making a window smaller. Don't use a
  7600. --- large number, it will cause errors when opening more than a few
  7601. --- windows. A value of 0 to 3 is reasonable.
  7602. ---
  7603. --- @type integer
  7604. vim.o.winminheight = 1
  7605. vim.o.wmh = vim.o.winminheight
  7606. vim.go.winminheight = vim.o.winminheight
  7607. vim.go.wmh = vim.go.winminheight
  7608. --- The minimal width of a window, when it's not the current window.
  7609. --- This is a hard minimum, windows will never become smaller.
  7610. --- When set to zero, windows may be "squashed" to zero columns (i.e. just
  7611. --- a vertical separator) if necessary. They will return to at least one
  7612. --- line when they become active (since the cursor has to have somewhere
  7613. --- to go.)
  7614. --- Use 'winwidth' to set the minimal width of the current window.
  7615. --- This option is only checked when making a window smaller. Don't use a
  7616. --- large number, it will cause errors when opening more than a few
  7617. --- windows. A value of 0 to 12 is reasonable.
  7618. ---
  7619. --- @type integer
  7620. vim.o.winminwidth = 1
  7621. vim.o.wmw = vim.o.winminwidth
  7622. vim.go.winminwidth = vim.o.winminwidth
  7623. vim.go.wmw = vim.go.winminwidth
  7624. --- Minimal number of columns for the current window. This is not a hard
  7625. --- minimum, Vim will use fewer columns if there is not enough room. If
  7626. --- the current window is smaller, its size is increased, at the cost of
  7627. --- the width of other windows. Set it to 999 to make the current window
  7628. --- always fill the screen. Set it to a small number for normal editing.
  7629. --- The width is not adjusted after one of the commands to change the
  7630. --- width of the current window.
  7631. --- 'winwidth' applies to the current window. Use 'winminwidth' to set
  7632. --- the minimal width for other windows.
  7633. ---
  7634. --- @type integer
  7635. vim.o.winwidth = 20
  7636. vim.o.wiw = vim.o.winwidth
  7637. vim.go.winwidth = vim.o.winwidth
  7638. vim.go.wiw = vim.go.winwidth
  7639. --- This option changes how text is displayed. It doesn't change the text
  7640. --- in the buffer, see 'textwidth' for that.
  7641. --- When on, lines longer than the width of the window will wrap and
  7642. --- displaying continues on the next line. When off lines will not wrap
  7643. --- and only part of long lines will be displayed. When the cursor is
  7644. --- moved to a part that is not shown, the screen will scroll
  7645. --- horizontally.
  7646. --- The line will be broken in the middle of a word if necessary. See
  7647. --- 'linebreak' to get the break at a word boundary.
  7648. --- To make scrolling horizontally a bit more useful, try this:
  7649. ---
  7650. --- ```vim
  7651. --- set sidescroll=5
  7652. --- set listchars+=precedes:<,extends:>
  7653. --- ```
  7654. --- See 'sidescroll', 'listchars' and `wrap-off`.
  7655. --- This option can't be set from a `modeline` when the 'diff' option is
  7656. --- on.
  7657. ---
  7658. --- @type boolean
  7659. vim.o.wrap = true
  7660. vim.wo.wrap = vim.o.wrap
  7661. --- Number of characters from the right window border where wrapping
  7662. --- starts. When typing text beyond this limit, an <EOL> will be inserted
  7663. --- and inserting continues on the next line.
  7664. --- Options that add a margin, such as 'number' and 'foldcolumn', cause
  7665. --- the text width to be further reduced.
  7666. --- When 'textwidth' is non-zero, this option is not used.
  7667. --- See also 'formatoptions' and `ins-textwidth`.
  7668. ---
  7669. --- @type integer
  7670. vim.o.wrapmargin = 0
  7671. vim.o.wm = vim.o.wrapmargin
  7672. vim.bo.wrapmargin = vim.o.wrapmargin
  7673. vim.bo.wm = vim.bo.wrapmargin
  7674. --- Searches wrap around the end of the file. Also applies to `]s` and
  7675. --- `[s`, searching for spelling mistakes.
  7676. ---
  7677. --- @type boolean
  7678. vim.o.wrapscan = true
  7679. vim.o.ws = vim.o.wrapscan
  7680. vim.go.wrapscan = vim.o.wrapscan
  7681. vim.go.ws = vim.go.wrapscan
  7682. --- Allows writing files. When not set, writing a file is not allowed.
  7683. --- Can be used for a view-only mode, where modifications to the text are
  7684. --- still allowed. Can be reset with the `-m` or `-M` command line
  7685. --- argument. Filtering text is still possible, even though this requires
  7686. --- writing a temporary file.
  7687. ---
  7688. --- @type boolean
  7689. vim.o.write = true
  7690. vim.go.write = vim.o.write
  7691. --- Allows writing to any file with no need for "!" override.
  7692. ---
  7693. --- @type boolean
  7694. vim.o.writeany = false
  7695. vim.o.wa = vim.o.writeany
  7696. vim.go.writeany = vim.o.writeany
  7697. vim.go.wa = vim.go.writeany
  7698. --- Make a backup before overwriting a file. The backup is removed after
  7699. --- the file was successfully written, unless the 'backup' option is
  7700. --- also on.
  7701. --- WARNING: Switching this option off means that when Vim fails to write
  7702. --- your buffer correctly and then, for whatever reason, Vim exits, you
  7703. --- lose both the original file and what you were writing. Only reset
  7704. --- this option if your file system is almost full and it makes the write
  7705. --- fail (and make sure not to exit Vim until the write was successful).
  7706. --- See `backup-table` for another explanation.
  7707. --- When the 'backupskip' pattern matches, a backup is not made anyway.
  7708. --- Depending on 'backupcopy' the backup is a new file or the original
  7709. --- file renamed (and a new file is written).
  7710. ---
  7711. --- @type boolean
  7712. vim.o.writebackup = true
  7713. vim.o.wb = vim.o.writebackup
  7714. vim.go.writebackup = vim.o.writebackup
  7715. vim.go.wb = vim.go.writebackup
  7716. --- Only takes effect together with 'redrawdebug'.
  7717. --- The number of milliseconds to wait after each line or each flush
  7718. ---
  7719. --- @type integer
  7720. vim.o.writedelay = 0
  7721. vim.o.wd = vim.o.writedelay
  7722. vim.go.writedelay = vim.o.writedelay
  7723. vim.go.wd = vim.go.writedelay