options.lua 322 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043
  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 string
  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 string
  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 string
  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 string
  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 present,
  1042. --- "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. --- @type string
  1053. vim.o.completeopt = "menu,preview"
  1054. vim.o.cot = vim.o.completeopt
  1055. vim.bo.completeopt = vim.o.completeopt
  1056. vim.bo.cot = vim.bo.completeopt
  1057. vim.go.completeopt = vim.o.completeopt
  1058. vim.go.cot = vim.go.completeopt
  1059. --- only modifiable in MS-Windows
  1060. --- When this option is set it overrules 'shellslash' for completion:
  1061. --- - When this option is set to "slash", a forward slash is used for path
  1062. --- completion in insert mode. This is useful when editing HTML tag, or
  1063. --- Makefile with 'noshellslash' on MS-Windows.
  1064. --- - When this option is set to "backslash", backslash is used. This is
  1065. --- useful when editing a batch file with 'shellslash' set on MS-Windows.
  1066. --- - When this option is empty, same character is used as for
  1067. --- 'shellslash'.
  1068. --- For Insert mode completion the buffer-local value is used. For
  1069. --- command line completion the global value is used.
  1070. ---
  1071. --- @type string
  1072. vim.o.completeslash = ""
  1073. vim.o.csl = vim.o.completeslash
  1074. vim.bo.completeslash = vim.o.completeslash
  1075. vim.bo.csl = vim.bo.completeslash
  1076. --- Sets the modes in which text in the cursor line can also be concealed.
  1077. --- When the current mode is listed then concealing happens just like in
  1078. --- other lines.
  1079. --- n Normal mode
  1080. --- v Visual mode
  1081. --- i Insert mode
  1082. --- c Command line editing, for 'incsearch'
  1083. ---
  1084. --- 'v' applies to all lines in the Visual area, not only the cursor.
  1085. --- A useful value is "nc". This is used in help files. So long as you
  1086. --- are moving around text is concealed, but when starting to insert text
  1087. --- or selecting a Visual area the concealed text is displayed, so that
  1088. --- you can see what you are doing.
  1089. --- Keep in mind that the cursor position is not always where it's
  1090. --- displayed. E.g., when moving vertically it may change column.
  1091. ---
  1092. --- @type string
  1093. vim.o.concealcursor = ""
  1094. vim.o.cocu = vim.o.concealcursor
  1095. vim.wo.concealcursor = vim.o.concealcursor
  1096. vim.wo.cocu = vim.wo.concealcursor
  1097. --- Determine how text with the "conceal" syntax attribute `:syn-conceal`
  1098. --- is shown:
  1099. ---
  1100. --- Value Effect ~
  1101. --- 0 Text is shown normally
  1102. --- 1 Each block of concealed text is replaced with one
  1103. --- character. If the syntax item does not have a custom
  1104. --- replacement character defined (see `:syn-cchar`) the
  1105. --- character defined in 'listchars' is used.
  1106. --- It is highlighted with the "Conceal" highlight group.
  1107. --- 2 Concealed text is completely hidden unless it has a
  1108. --- custom replacement character defined (see
  1109. --- `:syn-cchar`).
  1110. --- 3 Concealed text is completely hidden.
  1111. ---
  1112. --- Note: in the cursor line concealed text is not hidden, so that you can
  1113. --- edit and copy the text. This can be changed with the 'concealcursor'
  1114. --- option.
  1115. ---
  1116. --- @type integer
  1117. vim.o.conceallevel = 0
  1118. vim.o.cole = vim.o.conceallevel
  1119. vim.wo.conceallevel = vim.o.conceallevel
  1120. vim.wo.cole = vim.wo.conceallevel
  1121. --- When 'confirm' is on, certain operations that would normally
  1122. --- fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
  1123. --- instead raise a dialog asking if you wish to save the current
  1124. --- file(s). You can still use a ! to unconditionally `abandon` a buffer.
  1125. --- If 'confirm' is off you can still activate confirmation for one
  1126. --- command only (this is most useful in mappings) with the `:confirm`
  1127. --- command.
  1128. --- Also see the `confirm()` function and the 'v' flag in 'guioptions'.
  1129. ---
  1130. --- @type boolean
  1131. vim.o.confirm = false
  1132. vim.o.cf = vim.o.confirm
  1133. vim.go.confirm = vim.o.confirm
  1134. vim.go.cf = vim.go.confirm
  1135. --- Copy the structure of the existing lines indent when autoindenting a
  1136. --- new line. Normally the new indent is reconstructed by a series of
  1137. --- tabs followed by spaces as required (unless `'expandtab'` is enabled,
  1138. --- in which case only spaces are used). Enabling this option makes the
  1139. --- new line copy whatever characters were used for indenting on the
  1140. --- existing line. 'expandtab' has no effect on these characters, a Tab
  1141. --- remains a Tab. If the new indent is greater than on the existing
  1142. --- line, the remaining space is filled in the normal manner.
  1143. --- See 'preserveindent'.
  1144. ---
  1145. --- @type boolean
  1146. vim.o.copyindent = false
  1147. vim.o.ci = vim.o.copyindent
  1148. vim.bo.copyindent = vim.o.copyindent
  1149. vim.bo.ci = vim.bo.copyindent
  1150. --- A sequence of single character flags. When a character is present
  1151. --- this indicates Vi-compatible behavior. This is used for things where
  1152. --- not being Vi-compatible is mostly or sometimes preferred.
  1153. --- 'cpoptions' stands for "compatible-options".
  1154. --- Commas can be added for readability.
  1155. --- To avoid problems with flags that are added in the future, use the
  1156. --- "+=" and "-=" feature of ":set" `add-option-flags`.
  1157. ---
  1158. --- contains behavior ~
  1159. --- *cpo-a*
  1160. --- a When included, a ":read" command with a file name
  1161. --- argument will set the alternate file name for the
  1162. --- current window.
  1163. --- *cpo-A*
  1164. --- A When included, a ":write" command with a file name
  1165. --- argument will set the alternate file name for the
  1166. --- current window.
  1167. --- *cpo-b*
  1168. --- b "\|" in a ":map" command is recognized as the end of
  1169. --- the map command. The '\' is included in the mapping,
  1170. --- the text after the '|' is interpreted as the next
  1171. --- command. Use a CTRL-V instead of a backslash to
  1172. --- include the '|' in the mapping. Applies to all
  1173. --- mapping, abbreviation, menu and autocmd commands.
  1174. --- See also `map_bar`.
  1175. --- *cpo-B*
  1176. --- B A backslash has no special meaning in mappings,
  1177. --- abbreviations, user commands and the "to" part of the
  1178. --- menu commands. Remove this flag to be able to use a
  1179. --- backslash like a CTRL-V. For example, the command
  1180. --- ":map X \\<Esc>" results in X being mapped to:
  1181. --- 'B' included: "\^[" (^[ is a real <Esc>)
  1182. --- 'B' excluded: "<Esc>" (5 characters)
  1183. --- *cpo-c*
  1184. --- c Searching continues at the end of any match at the
  1185. --- cursor position, but not further than the start of the
  1186. --- next line. When not present searching continues
  1187. --- one character from the cursor position. With 'c'
  1188. --- "abababababab" only gets three matches when repeating
  1189. --- "/abab", without 'c' there are five matches.
  1190. --- *cpo-C*
  1191. --- C Do not concatenate sourced lines that start with a
  1192. --- backslash. See `line-continuation`.
  1193. --- *cpo-d*
  1194. --- d Using "./" in the 'tags' option doesn't mean to use
  1195. --- the tags file relative to the current file, but the
  1196. --- tags file in the current directory.
  1197. --- *cpo-D*
  1198. --- D Can't use CTRL-K to enter a digraph after Normal mode
  1199. --- commands with a character argument, like `r`, `f` and
  1200. --- `t`.
  1201. --- *cpo-e*
  1202. --- e When executing a register with ":@r", always add a
  1203. --- <CR> to the last line, also when the register is not
  1204. --- linewise. If this flag is not present, the register
  1205. --- is not linewise and the last line does not end in a
  1206. --- <CR>, then the last line is put on the command-line
  1207. --- and can be edited before hitting <CR>.
  1208. --- *cpo-E*
  1209. --- E It is an error when using "y", "d", "c", "g~", "gu" or
  1210. --- "gU" on an Empty region. The operators only work when
  1211. --- at least one character is to be operated on. Example:
  1212. --- This makes "y0" fail in the first column.
  1213. --- *cpo-f*
  1214. --- f When included, a ":read" command with a file name
  1215. --- argument will set the file name for the current buffer,
  1216. --- if the current buffer doesn't have a file name yet.
  1217. --- *cpo-F*
  1218. --- F When included, a ":write" command with a file name
  1219. --- argument will set the file name for the current
  1220. --- buffer, if the current buffer doesn't have a file name
  1221. --- yet. Also see `cpo-P`.
  1222. --- *cpo-i*
  1223. --- i When included, interrupting the reading of a file will
  1224. --- leave it modified.
  1225. --- *cpo-I*
  1226. --- I When moving the cursor up or down just after inserting
  1227. --- indent for 'autoindent', do not delete the indent.
  1228. --- *cpo-J*
  1229. --- J A `sentence` has to be followed by two spaces after
  1230. --- the '.', '!' or '?'. A <Tab> is not recognized as
  1231. --- white space.
  1232. --- *cpo-K*
  1233. --- K Don't wait for a key code to complete when it is
  1234. --- halfway through a mapping. This breaks mapping
  1235. --- <F1><F1> when only part of the second <F1> has been
  1236. --- read. It enables cancelling the mapping by typing
  1237. --- <F1><Esc>.
  1238. --- *cpo-l*
  1239. --- l Backslash in a [] range in a search pattern is taken
  1240. --- literally, only "\]", "\^", "\-" and "\\" are special.
  1241. --- See `/[]`
  1242. --- 'l' included: "/[ \t]" finds <Space>, '\' and 't'
  1243. --- 'l' excluded: "/[ \t]" finds <Space> and <Tab>
  1244. --- *cpo-L*
  1245. --- L When the 'list' option is set, 'wrapmargin',
  1246. --- 'textwidth', 'softtabstop' and Virtual Replace mode
  1247. --- (see `gR`) count a <Tab> as two characters, instead of
  1248. --- the normal behavior of a <Tab>.
  1249. --- *cpo-m*
  1250. --- m When included, a showmatch will always wait half a
  1251. --- second. When not included, a showmatch will wait half
  1252. --- a second or until a character is typed. `'showmatch'`
  1253. --- *cpo-M*
  1254. --- M When excluded, "%" matching will take backslashes into
  1255. --- account. Thus in "( \( )" and "\( ( \)" the outer
  1256. --- parenthesis match. When included "%" ignores
  1257. --- backslashes, which is Vi compatible.
  1258. --- *cpo-n*
  1259. --- n When included, the column used for 'number' and
  1260. --- 'relativenumber' will also be used for text of wrapped
  1261. --- lines.
  1262. --- *cpo-o*
  1263. --- o Line offset to search command is not remembered for
  1264. --- next search.
  1265. --- *cpo-O*
  1266. --- O Don't complain if a file is being overwritten, even
  1267. --- when it didn't exist when editing it. This is a
  1268. --- protection against a file unexpectedly created by
  1269. --- someone else. Vi didn't complain about this.
  1270. --- *cpo-P*
  1271. --- P When included, a ":write" command that appends to a
  1272. --- file will set the file name for the current buffer, if
  1273. --- the current buffer doesn't have a file name yet and
  1274. --- the 'F' flag is also included `cpo-F`.
  1275. --- *cpo-q*
  1276. --- q When joining multiple lines leave the cursor at the
  1277. --- position where it would be when joining two lines.
  1278. --- *cpo-r*
  1279. --- r Redo ("." command) uses "/" to repeat a search
  1280. --- command, instead of the actually used search string.
  1281. --- *cpo-R*
  1282. --- R Remove marks from filtered lines. Without this flag
  1283. --- marks are kept like `:keepmarks` was used.
  1284. --- *cpo-s*
  1285. --- s Set buffer options when entering the buffer for the
  1286. --- first time. This is like it is in Vim version 3.0.
  1287. --- And it is the default. If not present the options are
  1288. --- set when the buffer is created.
  1289. --- *cpo-S*
  1290. --- S Set buffer options always when entering a buffer
  1291. --- (except 'readonly', 'fileformat', 'filetype' and
  1292. --- 'syntax'). This is the (most) Vi compatible setting.
  1293. --- The options are set to the values in the current
  1294. --- buffer. When you change an option and go to another
  1295. --- buffer, the value is copied. Effectively makes the
  1296. --- buffer options global to all buffers.
  1297. ---
  1298. --- 's' 'S' copy buffer options
  1299. --- no no when buffer created
  1300. --- yes no when buffer first entered (default)
  1301. --- X yes each time when buffer entered (vi comp.)
  1302. --- *cpo-t*
  1303. --- t Search pattern for the tag command is remembered for
  1304. --- "n" command. Otherwise Vim only puts the pattern in
  1305. --- the history for search pattern, but doesn't change the
  1306. --- last used search pattern.
  1307. --- *cpo-u*
  1308. --- u Undo is Vi compatible. See `undo-two-ways`.
  1309. --- *cpo-v*
  1310. --- v Backspaced characters remain visible on the screen in
  1311. --- Insert mode. Without this flag the characters are
  1312. --- erased from the screen right away. With this flag the
  1313. --- screen newly typed text overwrites backspaced
  1314. --- characters.
  1315. --- *cpo-W*
  1316. --- W Don't overwrite a readonly file. When omitted, ":w!"
  1317. --- overwrites a readonly file, if possible.
  1318. --- *cpo-x*
  1319. --- x <Esc> on the command-line executes the command-line.
  1320. --- The default in Vim is to abandon the command-line,
  1321. --- because <Esc> normally aborts a command. `c_<Esc>`
  1322. --- *cpo-X*
  1323. --- X When using a count with "R" the replaced text is
  1324. --- deleted only once. Also when repeating "R" with "."
  1325. --- and a count.
  1326. --- *cpo-y*
  1327. --- y A yank command can be redone with ".". Think twice if
  1328. --- you really want to use this, it may break some
  1329. --- plugins, since most people expect "." to only repeat a
  1330. --- change.
  1331. --- *cpo-Z*
  1332. --- Z When using "w!" while the 'readonly' option is set,
  1333. --- don't reset 'readonly'.
  1334. --- *cpo-!*
  1335. --- ! When redoing a filter command, use the last used
  1336. --- external command, whatever it was. Otherwise the last
  1337. --- used -filter- command is used.
  1338. --- *cpo-$*
  1339. --- $ When making a change to one line, don't redisplay the
  1340. --- line, but put a '$' at the end of the changed text.
  1341. --- The changed text will be overwritten when you type the
  1342. --- new text. The line is redisplayed if you type any
  1343. --- command that moves the cursor from the insertion
  1344. --- point.
  1345. --- *cpo-%*
  1346. --- % Vi-compatible matching is done for the "%" command.
  1347. --- Does not recognize "#if", "#endif", etc.
  1348. --- Does not recognize "/*" and "*/".
  1349. --- Parens inside single and double quotes are also
  1350. --- counted, causing a string that contains a paren to
  1351. --- disturb the matching. For example, in a line like
  1352. --- "if (strcmp("foo(", s))" the first paren does not
  1353. --- match the last one. When this flag is not included,
  1354. --- parens inside single and double quotes are treated
  1355. --- specially. When matching a paren outside of quotes,
  1356. --- everything inside quotes is ignored. When matching a
  1357. --- paren inside quotes, it will find the matching one (if
  1358. --- there is one). This works very well for C programs.
  1359. --- This flag is also used for other features, such as
  1360. --- C-indenting.
  1361. --- *cpo-+*
  1362. --- + When included, a ":write file" command will reset the
  1363. --- 'modified' flag of the buffer, even though the buffer
  1364. --- itself may still be different from its file.
  1365. --- *cpo->*
  1366. --- > When appending to a register, put a line break before
  1367. --- the appended text.
  1368. --- *cpo-;*
  1369. --- ; When using `,` or `;` to repeat the last `t` search
  1370. --- and the cursor is right in front of the searched
  1371. --- character, the cursor won't move. When not included,
  1372. --- the cursor would skip over it and jump to the
  1373. --- following occurrence.
  1374. --- *cpo-_*
  1375. --- _ When using `cw` on a word, do not include the
  1376. --- whitespace following the word in the motion.
  1377. ---
  1378. --- @type string
  1379. vim.o.cpoptions = "aABceFs_"
  1380. vim.o.cpo = vim.o.cpoptions
  1381. vim.go.cpoptions = vim.o.cpoptions
  1382. vim.go.cpo = vim.go.cpoptions
  1383. --- When this option is set, as the cursor in the current
  1384. --- window moves other cursorbound windows (windows that also have
  1385. --- this option set) move their cursors to the corresponding line and
  1386. --- column. This option is useful for viewing the
  1387. --- differences between two versions of a file (see 'diff'); in diff mode,
  1388. --- inserted and deleted lines (though not characters within a line) are
  1389. --- taken into account.
  1390. ---
  1391. --- @type boolean
  1392. vim.o.cursorbind = false
  1393. vim.o.crb = vim.o.cursorbind
  1394. vim.wo.cursorbind = vim.o.cursorbind
  1395. vim.wo.crb = vim.wo.cursorbind
  1396. --- Highlight the screen column of the cursor with CursorColumn
  1397. --- `hl-CursorColumn`. Useful to align text. Will make screen redrawing
  1398. --- slower.
  1399. --- If you only want the highlighting in the current window you can use
  1400. --- these autocommands:
  1401. ---
  1402. --- ```vim
  1403. --- au WinLeave * set nocursorline nocursorcolumn
  1404. --- au WinEnter * set cursorline cursorcolumn
  1405. --- ```
  1406. ---
  1407. ---
  1408. --- @type boolean
  1409. vim.o.cursorcolumn = false
  1410. vim.o.cuc = vim.o.cursorcolumn
  1411. vim.wo.cursorcolumn = vim.o.cursorcolumn
  1412. vim.wo.cuc = vim.wo.cursorcolumn
  1413. --- Highlight the text line of the cursor with CursorLine `hl-CursorLine`.
  1414. --- Useful to easily spot the cursor. Will make screen redrawing slower.
  1415. --- When Visual mode is active the highlighting isn't used to make it
  1416. --- easier to see the selected text.
  1417. ---
  1418. --- @type boolean
  1419. vim.o.cursorline = false
  1420. vim.o.cul = vim.o.cursorline
  1421. vim.wo.cursorline = vim.o.cursorline
  1422. vim.wo.cul = vim.wo.cursorline
  1423. --- Comma-separated list of settings for how 'cursorline' is displayed.
  1424. --- Valid values:
  1425. --- "line" Highlight the text line of the cursor with
  1426. --- CursorLine `hl-CursorLine`.
  1427. --- "screenline" Highlight only the screen line of the cursor with
  1428. --- CursorLine `hl-CursorLine`.
  1429. --- "number" Highlight the line number of the cursor with
  1430. --- CursorLineNr `hl-CursorLineNr`.
  1431. ---
  1432. --- Special value:
  1433. --- "both" Alias for the values "line,number".
  1434. ---
  1435. --- "line" and "screenline" cannot be used together.
  1436. ---
  1437. --- @type string
  1438. vim.o.cursorlineopt = "both"
  1439. vim.o.culopt = vim.o.cursorlineopt
  1440. vim.wo.cursorlineopt = vim.o.cursorlineopt
  1441. vim.wo.culopt = vim.wo.cursorlineopt
  1442. --- These values can be used:
  1443. --- msg Error messages that would otherwise be omitted will be given
  1444. --- anyway.
  1445. --- throw Error messages that would otherwise be omitted will be given
  1446. --- anyway and also throw an exception and set `v:errmsg`.
  1447. --- beep A message will be given when otherwise only a beep would be
  1448. --- produced.
  1449. --- The values can be combined, separated by a comma.
  1450. --- "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
  1451. --- 'indentexpr'.
  1452. ---
  1453. --- @type string
  1454. vim.o.debug = ""
  1455. vim.go.debug = vim.o.debug
  1456. --- Pattern to be used to find a macro definition. It is a search
  1457. --- pattern, just like for the "/" command. This option is used for the
  1458. --- commands like "[i" and "[d" `include-search`. The 'isident' option is
  1459. --- used to recognize the defined name after the match:
  1460. --- ```
  1461. --- {match with 'define'}{non-ID chars}{defined name}{non-ID char}
  1462. --- ```
  1463. --- See `option-backslash` about inserting backslashes to include a space
  1464. --- or backslash.
  1465. --- For C++ this value would be useful, to include const type declarations:
  1466. --- ```
  1467. --- ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
  1468. --- ```
  1469. --- You can also use "\ze" just before the name and continue the pattern
  1470. --- to check what is following. E.g. for Javascript, if a function is
  1471. --- defined with `func_name = function(args)`:
  1472. --- ```
  1473. --- ^\s*\ze\i\+\s*=\s*function(
  1474. --- ```
  1475. --- If the function is defined with `func_name : function() {...`:
  1476. --- ```
  1477. --- ^\s*\ze\i\+\s*[:]\s*(*function\s*(
  1478. --- ```
  1479. --- When using the ":set" command, you need to double the backslashes!
  1480. --- To avoid that use `:let` with a single quote string:
  1481. ---
  1482. --- ```vim
  1483. --- let &l:define = '^\s*\ze\k\+\s*=\s*function('
  1484. --- ```
  1485. ---
  1486. ---
  1487. --- @type string
  1488. vim.o.define = ""
  1489. vim.o.def = vim.o.define
  1490. vim.bo.define = vim.o.define
  1491. vim.bo.def = vim.bo.define
  1492. vim.go.define = vim.o.define
  1493. vim.go.def = vim.go.define
  1494. --- If editing Unicode and this option is set, backspace and Normal mode
  1495. --- "x" delete each combining character on its own. When it is off (the
  1496. --- default) the character along with its combining characters are
  1497. --- deleted.
  1498. --- Note: When 'delcombine' is set "xx" may work differently from "2x"!
  1499. ---
  1500. --- This is useful for Arabic, Hebrew and many other languages where one
  1501. --- may have combining characters overtop of base characters, and want
  1502. --- to remove only the combining ones.
  1503. ---
  1504. --- @type boolean
  1505. vim.o.delcombine = false
  1506. vim.o.deco = vim.o.delcombine
  1507. vim.go.delcombine = vim.o.delcombine
  1508. vim.go.deco = vim.go.delcombine
  1509. --- List of file names, separated by commas, that are used to lookup words
  1510. --- for keyword completion commands `i_CTRL-X_CTRL-K`. Each file should
  1511. --- contain a list of words. This can be one word per line, or several
  1512. --- words per line, separated by non-keyword characters (white space is
  1513. --- preferred). Maximum line length is 510 bytes.
  1514. ---
  1515. --- When this option is empty or an entry "spell" is present, and spell
  1516. --- checking is enabled, words in the word lists for the currently active
  1517. --- 'spelllang' are used. See `spell`.
  1518. ---
  1519. --- To include a comma in a file name precede it with a backslash. Spaces
  1520. --- after a comma are ignored, otherwise spaces are included in the file
  1521. --- name. See `option-backslash` about using backslashes.
  1522. --- This has nothing to do with the `Dictionary` variable type.
  1523. --- Where to find a list of words?
  1524. --- - BSD/macOS include the "/usr/share/dict/words" file.
  1525. --- - Try "apt install spell" to get the "/usr/share/dict/words" file on
  1526. --- apt-managed systems (Debian/Ubuntu).
  1527. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  1528. --- directories from the list. This avoids problems when a future version
  1529. --- uses another default.
  1530. --- Backticks cannot be used in this option for security reasons.
  1531. ---
  1532. --- @type string
  1533. vim.o.dictionary = ""
  1534. vim.o.dict = vim.o.dictionary
  1535. vim.bo.dictionary = vim.o.dictionary
  1536. vim.bo.dict = vim.bo.dictionary
  1537. vim.go.dictionary = vim.o.dictionary
  1538. vim.go.dict = vim.go.dictionary
  1539. --- Join the current window in the group of windows that shows differences
  1540. --- between files. See `diff-mode`.
  1541. ---
  1542. --- @type boolean
  1543. vim.o.diff = false
  1544. vim.wo.diff = vim.o.diff
  1545. --- Expression which is evaluated to obtain a diff file (either ed-style
  1546. --- or unified-style) from two versions of a file. See `diff-diffexpr`.
  1547. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1548. --- security reasons.
  1549. ---
  1550. --- @type string
  1551. vim.o.diffexpr = ""
  1552. vim.o.dex = vim.o.diffexpr
  1553. vim.go.diffexpr = vim.o.diffexpr
  1554. vim.go.dex = vim.go.diffexpr
  1555. --- Option settings for diff mode. It can consist of the following items.
  1556. --- All are optional. Items must be separated by a comma.
  1557. ---
  1558. --- filler Show filler lines, to keep the text
  1559. --- synchronized with a window that has inserted
  1560. --- lines at the same position. Mostly useful
  1561. --- when windows are side-by-side and 'scrollbind'
  1562. --- is set.
  1563. ---
  1564. --- context:{n} Use a context of {n} lines between a change
  1565. --- and a fold that contains unchanged lines.
  1566. --- When omitted a context of six lines is used.
  1567. --- When using zero the context is actually one,
  1568. --- since folds require a line in between, also
  1569. --- for a deleted line. Set it to a very large
  1570. --- value (999999) to disable folding completely.
  1571. --- See `fold-diff`.
  1572. ---
  1573. --- iblank Ignore changes where lines are all blank. Adds
  1574. --- the "-B" flag to the "diff" command if
  1575. --- 'diffexpr' is empty. Check the documentation
  1576. --- of the "diff" command for what this does
  1577. --- exactly.
  1578. --- NOTE: the diff windows will get out of sync,
  1579. --- because no differences between blank lines are
  1580. --- taken into account.
  1581. ---
  1582. --- icase Ignore changes in case of text. "a" and "A"
  1583. --- are considered the same. Adds the "-i" flag
  1584. --- to the "diff" command if 'diffexpr' is empty.
  1585. ---
  1586. --- iwhite Ignore changes in amount of white space. Adds
  1587. --- the "-b" flag to the "diff" command if
  1588. --- 'diffexpr' is empty. Check the documentation
  1589. --- of the "diff" command for what this does
  1590. --- exactly. It should ignore adding trailing
  1591. --- white space, but not leading white space.
  1592. ---
  1593. --- iwhiteall Ignore all white space changes. Adds
  1594. --- the "-w" flag to the "diff" command if
  1595. --- 'diffexpr' is empty. Check the documentation
  1596. --- of the "diff" command for what this does
  1597. --- exactly.
  1598. ---
  1599. --- iwhiteeol Ignore white space changes at end of line.
  1600. --- Adds the "-Z" flag to the "diff" command if
  1601. --- 'diffexpr' is empty. Check the documentation
  1602. --- of the "diff" command for what this does
  1603. --- exactly.
  1604. ---
  1605. --- horizontal Start diff mode with horizontal splits (unless
  1606. --- explicitly specified otherwise).
  1607. ---
  1608. --- vertical Start diff mode with vertical splits (unless
  1609. --- explicitly specified otherwise).
  1610. ---
  1611. --- closeoff When a window is closed where 'diff' is set
  1612. --- and there is only one window remaining in the
  1613. --- same tab page with 'diff' set, execute
  1614. --- `:diffoff` in that window. This undoes a
  1615. --- `:diffsplit` command.
  1616. ---
  1617. --- hiddenoff Do not use diff mode for a buffer when it
  1618. --- becomes hidden.
  1619. ---
  1620. --- foldcolumn:{n} Set the 'foldcolumn' option to {n} when
  1621. --- starting diff mode. Without this 2 is used.
  1622. ---
  1623. --- followwrap Follow the 'wrap' option and leave as it is.
  1624. ---
  1625. --- internal Use the internal diff library. This is
  1626. --- ignored when 'diffexpr' is set. *E960*
  1627. --- When running out of memory when writing a
  1628. --- buffer this item will be ignored for diffs
  1629. --- involving that buffer. Set the 'verbose'
  1630. --- option to see when this happens.
  1631. ---
  1632. --- indent-heuristic
  1633. --- Use the indent heuristic for the internal
  1634. --- diff library.
  1635. ---
  1636. --- linematch:{n} Enable a second stage diff on each generated
  1637. --- hunk in order to align lines. When the total
  1638. --- number of lines in a hunk exceeds {n}, the
  1639. --- second stage diff will not be performed as
  1640. --- very large hunks can cause noticeable lag. A
  1641. --- recommended setting is "linematch:60", as this
  1642. --- will enable alignment for a 2 buffer diff with
  1643. --- hunks of up to 30 lines each, or a 3 buffer
  1644. --- diff with hunks of up to 20 lines each.
  1645. ---
  1646. --- algorithm:{text} Use the specified diff algorithm with the
  1647. --- internal diff engine. Currently supported
  1648. --- algorithms are:
  1649. --- myers the default algorithm
  1650. --- minimal spend extra time to generate the
  1651. --- smallest possible diff
  1652. --- patience patience diff algorithm
  1653. --- histogram histogram diff algorithm
  1654. ---
  1655. --- Examples:
  1656. ---
  1657. --- ```vim
  1658. --- set diffopt=internal,filler,context:4
  1659. --- set diffopt=
  1660. --- set diffopt=internal,filler,foldcolumn:3
  1661. --- set diffopt-=internal " do NOT use the internal diff parser
  1662. --- ```
  1663. ---
  1664. ---
  1665. --- @type string
  1666. vim.o.diffopt = "internal,filler,closeoff"
  1667. vim.o.dip = vim.o.diffopt
  1668. vim.go.diffopt = vim.o.diffopt
  1669. vim.go.dip = vim.go.diffopt
  1670. --- Enable the entering of digraphs in Insert mode with {char1} <BS>
  1671. --- {char2}. See `digraphs`.
  1672. ---
  1673. --- @type boolean
  1674. vim.o.digraph = false
  1675. vim.o.dg = vim.o.digraph
  1676. vim.go.digraph = vim.o.digraph
  1677. vim.go.dg = vim.go.digraph
  1678. --- List of directory names for the swap file, separated with commas.
  1679. ---
  1680. --- Possible items:
  1681. --- - The swap file will be created in the first directory where this is
  1682. --- possible. If it is not possible in any directory, but last
  1683. --- directory listed in the option does not exist, it is created.
  1684. --- - Empty means that no swap file will be used (recovery is
  1685. --- impossible!) and no `E303` error will be given.
  1686. --- - A directory "." means to put the swap file in the same directory as
  1687. --- the edited file. On Unix, a dot is prepended to the file name, so
  1688. --- it doesn't show in a directory listing. On MS-Windows the "hidden"
  1689. --- attribute is set and a dot prepended if possible.
  1690. --- - A directory starting with "./" (or ".\" for MS-Windows) means to put
  1691. --- the swap file relative to where the edited file is. The leading "."
  1692. --- is replaced with the path name of the edited file.
  1693. --- - For Unix and Win32, if a directory ends in two path separators "//",
  1694. --- the swap file name will be built from the complete path to the file
  1695. --- with all path separators replaced by percent '%' signs (including
  1696. --- the colon following the drive letter on Win32). This will ensure
  1697. --- file name uniqueness in the preserve directory.
  1698. --- On Win32, it is also possible to end with "\\". However, When a
  1699. --- separating comma is following, you must use "//", since "\\" will
  1700. --- include the comma in the file name. Therefore it is recommended to
  1701. --- use '//', instead of '\\'.
  1702. --- - Spaces after the comma are ignored, other spaces are considered part
  1703. --- of the directory name. To have a space at the start of a directory
  1704. --- name, precede it with a backslash.
  1705. --- - To include a comma in a directory name precede it with a backslash.
  1706. --- - A directory name may end in an ':' or '/'.
  1707. --- - Environment variables are expanded `:set_env`.
  1708. --- - Careful with '\' characters, type one before a space, type two to
  1709. --- get one in the option (see `option-backslash`), for example:
  1710. ---
  1711. --- ```vim
  1712. --- set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  1713. --- ```
  1714. ---
  1715. --- Editing the same file twice will result in a warning. Using "/tmp" on
  1716. --- is discouraged: if the system crashes you lose the swap file. And
  1717. --- others on the computer may be able to see the files.
  1718. --- Use `:set+=` and `:set-=` when adding or removing directories from the
  1719. --- list, this avoids problems if the Nvim default is changed.
  1720. ---
  1721. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1722. --- security reasons.
  1723. ---
  1724. --- @type string
  1725. vim.o.directory = "$XDG_STATE_HOME/nvim/swap//"
  1726. vim.o.dir = vim.o.directory
  1727. vim.go.directory = vim.o.directory
  1728. vim.go.dir = vim.go.directory
  1729. --- Change the way text is displayed. This is a comma-separated list of
  1730. --- flags:
  1731. --- lastline When included, as much as possible of the last line
  1732. --- in a window will be displayed. "@@@" is put in the
  1733. --- last columns of the last screen line to indicate the
  1734. --- rest of the line is not displayed.
  1735. --- truncate Like "lastline", but "@@@" is displayed in the first
  1736. --- column of the last screen line. Overrules "lastline".
  1737. --- uhex Show unprintable characters hexadecimal as <xx>
  1738. --- instead of using ^C and ~C.
  1739. --- msgsep Obsolete flag. Allowed but takes no effect. `msgsep`
  1740. ---
  1741. --- When neither "lastline" nor "truncate" is included, a last line that
  1742. --- doesn't fit is replaced with "@" lines.
  1743. ---
  1744. --- The "@" character can be changed by setting the "lastline" item in
  1745. --- 'fillchars'. The character is highlighted with `hl-NonText`.
  1746. ---
  1747. --- @type string
  1748. vim.o.display = "lastline"
  1749. vim.o.dy = vim.o.display
  1750. vim.go.display = vim.o.display
  1751. vim.go.dy = vim.go.display
  1752. --- Tells when the 'equalalways' option applies:
  1753. --- ver vertically, width of windows is not affected
  1754. --- hor horizontally, height of windows is not affected
  1755. --- both width and height of windows is affected
  1756. ---
  1757. --- @type string
  1758. vim.o.eadirection = "both"
  1759. vim.o.ead = vim.o.eadirection
  1760. vim.go.eadirection = vim.o.eadirection
  1761. vim.go.ead = vim.go.eadirection
  1762. --- When on all Unicode emoji characters are considered to be full width.
  1763. --- This excludes "text emoji" characters, which are normally displayed as
  1764. --- single width. However, such "text emoji" are treated as full-width
  1765. --- emoji if they are followed by the U+FE0F variant selector.
  1766. ---
  1767. --- Unfortunately there is no good specification for this and it has been
  1768. --- determined on trial-and-error basis. Use the `setcellwidths()`
  1769. --- function to change the behavior.
  1770. ---
  1771. --- @type boolean
  1772. vim.o.emoji = true
  1773. vim.o.emo = vim.o.emoji
  1774. vim.go.emoji = vim.o.emoji
  1775. vim.go.emo = vim.go.emoji
  1776. --- String-encoding used internally and for `RPC` communication.
  1777. --- Always UTF-8.
  1778. ---
  1779. --- See 'fileencoding' to control file-content encoding.
  1780. ---
  1781. --- @type string
  1782. vim.o.encoding = "utf-8"
  1783. vim.o.enc = vim.o.encoding
  1784. vim.go.encoding = vim.o.encoding
  1785. vim.go.enc = vim.go.encoding
  1786. --- Indicates that a CTRL-Z character was found at the end of the file
  1787. --- when reading it. Normally only happens when 'fileformat' is "dos".
  1788. --- When writing a file and this option is off and the 'binary' option
  1789. --- is on, or 'fixeol' option is off, no CTRL-Z will be written at the
  1790. --- end of the file.
  1791. --- See `eol-and-eof` for example settings.
  1792. ---
  1793. --- @type boolean
  1794. vim.o.endoffile = false
  1795. vim.o.eof = vim.o.endoffile
  1796. vim.bo.endoffile = vim.o.endoffile
  1797. vim.bo.eof = vim.bo.endoffile
  1798. --- When writing a file and this option is off and the 'binary' option
  1799. --- is on, or 'fixeol' option is off, no <EOL> will be written for the
  1800. --- last line in the file. This option is automatically set or reset when
  1801. --- starting to edit a new file, depending on whether file has an <EOL>
  1802. --- for the last line in the file. Normally you don't have to set or
  1803. --- reset this option.
  1804. --- When 'binary' is off and 'fixeol' is on the value is not used when
  1805. --- writing the file. When 'binary' is on or 'fixeol' is off it is used
  1806. --- to remember the presence of a <EOL> for the last line in the file, so
  1807. --- that when you write the file the situation from the original file can
  1808. --- be kept. But you can change it if you want to.
  1809. --- See `eol-and-eof` for example settings.
  1810. ---
  1811. --- @type boolean
  1812. vim.o.endofline = true
  1813. vim.o.eol = vim.o.endofline
  1814. vim.bo.endofline = vim.o.endofline
  1815. vim.bo.eol = vim.bo.endofline
  1816. --- When on, all the windows are automatically made the same size after
  1817. --- splitting or closing a window. This also happens the moment the
  1818. --- option is switched on. When off, splitting a window will reduce the
  1819. --- size of the current window and leave the other windows the same. When
  1820. --- closing a window the extra lines are given to the window next to it
  1821. --- (depending on 'splitbelow' and 'splitright').
  1822. --- When mixing vertically and horizontally split windows, a minimal size
  1823. --- is computed and some windows may be larger if there is room. The
  1824. --- 'eadirection' option tells in which direction the size is affected.
  1825. --- Changing the height and width of a window can be avoided by setting
  1826. --- 'winfixheight' and 'winfixwidth', respectively.
  1827. --- If a window size is specified when creating a new window sizes are
  1828. --- currently not equalized (it's complicated, but may be implemented in
  1829. --- the future).
  1830. ---
  1831. --- @type boolean
  1832. vim.o.equalalways = true
  1833. vim.o.ea = vim.o.equalalways
  1834. vim.go.equalalways = vim.o.equalalways
  1835. vim.go.ea = vim.go.equalalways
  1836. --- External program to use for "=" command. When this option is empty
  1837. --- the internal formatting functions are used; either 'lisp', 'cindent'
  1838. --- or 'indentexpr'.
  1839. --- Environment variables are expanded `:set_env`. See `option-backslash`
  1840. --- about including spaces and backslashes.
  1841. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1842. --- security reasons.
  1843. ---
  1844. --- @type string
  1845. vim.o.equalprg = ""
  1846. vim.o.ep = vim.o.equalprg
  1847. vim.bo.equalprg = vim.o.equalprg
  1848. vim.bo.ep = vim.bo.equalprg
  1849. vim.go.equalprg = vim.o.equalprg
  1850. vim.go.ep = vim.go.equalprg
  1851. --- Ring the bell (beep or screen flash) for error messages. This only
  1852. --- makes a difference for error messages, the bell will be used always
  1853. --- for a lot of errors without a message (e.g., hitting <Esc> in Normal
  1854. --- mode). See 'visualbell' to make the bell behave like a screen flash
  1855. --- or do nothing. See 'belloff' to finetune when to ring the bell.
  1856. ---
  1857. --- @type boolean
  1858. vim.o.errorbells = false
  1859. vim.o.eb = vim.o.errorbells
  1860. vim.go.errorbells = vim.o.errorbells
  1861. vim.go.eb = vim.go.errorbells
  1862. --- Name of the errorfile for the QuickFix mode (see `:cf`).
  1863. --- When the "-q" command-line argument is used, 'errorfile' is set to the
  1864. --- following argument. See `-q`.
  1865. --- NOT used for the ":make" command. See 'makeef' for that.
  1866. --- Environment variables are expanded `:set_env`.
  1867. --- See `option-backslash` about including spaces and backslashes.
  1868. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1869. --- security reasons.
  1870. ---
  1871. --- @type string
  1872. vim.o.errorfile = "errors.err"
  1873. vim.o.ef = vim.o.errorfile
  1874. vim.go.errorfile = vim.o.errorfile
  1875. vim.go.ef = vim.go.errorfile
  1876. --- Scanf-like description of the format for the lines in the error file
  1877. --- (see `errorformat`).
  1878. ---
  1879. --- @type string
  1880. 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"
  1881. vim.o.efm = vim.o.errorformat
  1882. vim.bo.errorformat = vim.o.errorformat
  1883. vim.bo.efm = vim.bo.errorformat
  1884. vim.go.errorformat = vim.o.errorformat
  1885. vim.go.efm = vim.go.errorformat
  1886. --- A list of autocommand event names, which are to be ignored.
  1887. --- When set to "all" or when "all" is one of the items, all autocommand
  1888. --- events are ignored, autocommands will not be executed.
  1889. --- Otherwise this is a comma-separated list of event names. Example:
  1890. ---
  1891. --- ```vim
  1892. --- set ei=WinEnter,WinLeave
  1893. --- ```
  1894. ---
  1895. ---
  1896. --- @type string
  1897. vim.o.eventignore = ""
  1898. vim.o.ei = vim.o.eventignore
  1899. vim.go.eventignore = vim.o.eventignore
  1900. vim.go.ei = vim.go.eventignore
  1901. --- In Insert mode: Use the appropriate number of spaces to insert a
  1902. --- <Tab>. Spaces are used in indents with the '>' and '<' commands and
  1903. --- when 'autoindent' is on. To insert a real tab when 'expandtab' is
  1904. --- on, use CTRL-V<Tab>. See also `:retab` and `ins-expandtab`.
  1905. ---
  1906. --- @type boolean
  1907. vim.o.expandtab = false
  1908. vim.o.et = vim.o.expandtab
  1909. vim.bo.expandtab = vim.o.expandtab
  1910. vim.bo.et = vim.bo.expandtab
  1911. --- Automatically execute .nvim.lua, .nvimrc, and .exrc files in the
  1912. --- current directory, if the file is in the `trust` list. Use `:trust` to
  1913. --- manage trusted files. See also `vim.secure.read()`.
  1914. ---
  1915. --- Compare 'exrc' to `editorconfig`:
  1916. --- - 'exrc' can execute any code; editorconfig only specifies settings.
  1917. --- - 'exrc' is Nvim-specific; editorconfig works in other editors.
  1918. ---
  1919. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  1920. --- security reasons.
  1921. ---
  1922. --- @type boolean
  1923. vim.o.exrc = false
  1924. vim.o.ex = vim.o.exrc
  1925. vim.go.exrc = vim.o.exrc
  1926. vim.go.ex = vim.go.exrc
  1927. --- File-content encoding for the current buffer. Conversion is done with
  1928. --- iconv() or as specified with 'charconvert'.
  1929. ---
  1930. --- When 'fileencoding' is not UTF-8, conversion will be done when
  1931. --- writing the file. For reading see below.
  1932. --- When 'fileencoding' is empty, the file will be saved with UTF-8
  1933. --- encoding (no conversion when reading or writing a file).
  1934. ---
  1935. --- WARNING: Conversion to a non-Unicode encoding can cause loss of
  1936. --- information!
  1937. ---
  1938. --- See `encoding-names` for the possible values. Additionally, values may be
  1939. --- specified that can be handled by the converter, see
  1940. --- `mbyte-conversion`.
  1941. ---
  1942. --- When reading a file 'fileencoding' will be set from 'fileencodings'.
  1943. --- To read a file in a certain encoding it won't work by setting
  1944. --- 'fileencoding', use the `++enc` argument. One exception: when
  1945. --- 'fileencodings' is empty the value of 'fileencoding' is used.
  1946. --- For a new file the global value of 'fileencoding' is used.
  1947. ---
  1948. --- Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
  1949. --- When the option is set, the value is converted to lowercase. Thus
  1950. --- you can set it with uppercase values too. '_' characters are
  1951. --- replaced with '-'. If a name is recognized from the list at
  1952. --- `encoding-names`, it is replaced by the standard name. For example
  1953. --- "ISO8859-2" becomes "iso-8859-2".
  1954. ---
  1955. --- When this option is set, after starting to edit a file, the 'modified'
  1956. --- option is set, because the file would be different when written.
  1957. ---
  1958. --- Keep in mind that changing 'fenc' from a modeline happens
  1959. --- AFTER the text has been read, thus it applies to when the file will be
  1960. --- written. If you do set 'fenc' in a modeline, you might want to set
  1961. --- 'nomodified' to avoid not being able to ":q".
  1962. ---
  1963. --- This option cannot be changed when 'modifiable' is off.
  1964. ---
  1965. --- @type string
  1966. vim.o.fileencoding = ""
  1967. vim.o.fenc = vim.o.fileencoding
  1968. vim.bo.fileencoding = vim.o.fileencoding
  1969. vim.bo.fenc = vim.bo.fileencoding
  1970. --- This is a list of character encodings considered when starting to edit
  1971. --- an existing file. When a file is read, Vim tries to use the first
  1972. --- mentioned character encoding. If an error is detected, the next one
  1973. --- in the list is tried. When an encoding is found that works,
  1974. --- 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
  1975. --- an empty string, which means that UTF-8 is used.
  1976. --- WARNING: Conversion can cause loss of information! You can use
  1977. --- the `++bad` argument to specify what is done with characters
  1978. --- that can't be converted.
  1979. --- For an empty file or a file with only ASCII characters most encodings
  1980. --- will work and the first entry of 'fileencodings' will be used (except
  1981. --- "ucs-bom", which requires the BOM to be present). If you prefer
  1982. --- another encoding use an BufReadPost autocommand event to test if your
  1983. --- preferred encoding is to be used. Example:
  1984. ---
  1985. --- ```vim
  1986. --- au BufReadPost * if search('\S', 'w') == 0 |
  1987. --- \ set fenc=iso-2022-jp | endif
  1988. --- ```
  1989. --- This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
  1990. --- non-blank characters.
  1991. --- When the `++enc` argument is used then the value of 'fileencodings' is
  1992. --- not used.
  1993. --- Note that 'fileencodings' is not used for a new file, the global value
  1994. --- of 'fileencoding' is used instead. You can set it with:
  1995. ---
  1996. --- ```vim
  1997. --- setglobal fenc=iso-8859-2
  1998. --- ```
  1999. --- This means that a non-existing file may get a different encoding than
  2000. --- an empty file.
  2001. --- The special value "ucs-bom" can be used to check for a Unicode BOM
  2002. --- (Byte Order Mark) at the start of the file. It must not be preceded
  2003. --- by "utf-8" or another Unicode encoding for this to work properly.
  2004. --- An entry for an 8-bit encoding (e.g., "latin1") should be the last,
  2005. --- because Vim cannot detect an error, thus the encoding is always
  2006. --- accepted.
  2007. --- The special value "default" can be used for the encoding from the
  2008. --- environment. It is useful when your environment uses a non-latin1
  2009. --- encoding, such as Russian.
  2010. --- When a file contains an illegal UTF-8 byte sequence it won't be
  2011. --- recognized as "utf-8". You can use the `8g8` command to find the
  2012. --- illegal byte sequence.
  2013. --- WRONG VALUES: WHAT'S WRONG:
  2014. --- latin1,utf-8 "latin1" will always be used
  2015. --- utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
  2016. --- file
  2017. --- cp1250,latin1 "cp1250" will always be used
  2018. --- If 'fileencodings' is empty, 'fileencoding' is not modified.
  2019. --- See 'fileencoding' for the possible values.
  2020. --- Setting this option does not have an effect until the next time a file
  2021. --- is read.
  2022. ---
  2023. --- @type string
  2024. vim.o.fileencodings = "ucs-bom,utf-8,default,latin1"
  2025. vim.o.fencs = vim.o.fileencodings
  2026. vim.go.fileencodings = vim.o.fileencodings
  2027. vim.go.fencs = vim.go.fileencodings
  2028. --- This gives the <EOL> of the current buffer, which is used for
  2029. --- reading/writing the buffer from/to a file:
  2030. --- dos <CR><NL>
  2031. --- unix <NL>
  2032. --- mac <CR>
  2033. --- When "dos" is used, CTRL-Z at the end of a file is ignored.
  2034. --- See `file-formats` and `file-read`.
  2035. --- For the character encoding of the file see 'fileencoding'.
  2036. --- When 'binary' is set, the value of 'fileformat' is ignored, file I/O
  2037. --- works like it was set to "unix".
  2038. --- This option is set automatically when starting to edit a file and
  2039. --- 'fileformats' is not empty and 'binary' is off.
  2040. --- When this option is set, after starting to edit a file, the 'modified'
  2041. --- option is set, because the file would be different when written.
  2042. --- This option cannot be changed when 'modifiable' is off.
  2043. ---
  2044. --- @type string
  2045. vim.o.fileformat = "unix"
  2046. vim.o.ff = vim.o.fileformat
  2047. vim.bo.fileformat = vim.o.fileformat
  2048. vim.bo.ff = vim.bo.fileformat
  2049. --- This gives the end-of-line (<EOL>) formats that will be tried when
  2050. --- starting to edit a new buffer and when reading a file into an existing
  2051. --- buffer:
  2052. --- - When empty, the format defined with 'fileformat' will be used
  2053. --- always. It is not set automatically.
  2054. --- - When set to one name, that format will be used whenever a new buffer
  2055. --- is opened. 'fileformat' is set accordingly for that buffer. The
  2056. --- 'fileformats' name will be used when a file is read into an existing
  2057. --- buffer, no matter what 'fileformat' for that buffer is set to.
  2058. --- - When more than one name is present, separated by commas, automatic
  2059. --- <EOL> detection will be done when reading a file. When starting to
  2060. --- edit a file, a check is done for the <EOL>:
  2061. --- 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
  2062. --- 'fileformat' is set to "dos".
  2063. --- 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
  2064. --- is set to "unix". Note that when a <NL> is found without a
  2065. --- preceding <CR>, "unix" is preferred over "dos".
  2066. --- 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
  2067. --- if 'fileformats' includes "mac", 'fileformat' is set to "mac".
  2068. --- This means that "mac" is only chosen when:
  2069. --- "unix" is not present or no <NL> is found in the file, and
  2070. --- "dos" is not present or no <CR><NL> is found in the file.
  2071. --- Except: if "unix" was chosen, but there is a <CR> before
  2072. --- the first <NL>, and there appear to be more <CR>s than <NL>s in
  2073. --- the first few lines, "mac" is used.
  2074. --- 4. If 'fileformat' is still not set, the first name from
  2075. --- 'fileformats' is used.
  2076. --- When reading a file into an existing buffer, the same is done, but
  2077. --- this happens like 'fileformat' has been set appropriately for that
  2078. --- file only, the option is not changed.
  2079. --- When 'binary' is set, the value of 'fileformats' is not used.
  2080. ---
  2081. --- When Vim starts up with an empty buffer the first item is used. You
  2082. --- can overrule this by setting 'fileformat' in your .vimrc.
  2083. ---
  2084. --- For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
  2085. --- are ":source"ed and for vimrc files, automatic <EOL> detection may be
  2086. --- done:
  2087. --- - When 'fileformats' is empty, there is no automatic detection. Dos
  2088. --- format will be used.
  2089. --- - When 'fileformats' is set to one or more names, automatic detection
  2090. --- is done. This is based on the first <NL> in the file: If there is a
  2091. --- <CR> in front of it, Dos format is used, otherwise Unix format is
  2092. --- used.
  2093. --- Also see `file-formats`.
  2094. ---
  2095. --- @type string
  2096. vim.o.fileformats = "unix,dos"
  2097. vim.o.ffs = vim.o.fileformats
  2098. vim.go.fileformats = vim.o.fileformats
  2099. vim.go.ffs = vim.go.fileformats
  2100. --- When set case is ignored when using file names and directories.
  2101. --- See 'wildignorecase' for only ignoring case when doing completion.
  2102. ---
  2103. --- @type boolean
  2104. vim.o.fileignorecase = false
  2105. vim.o.fic = vim.o.fileignorecase
  2106. vim.go.fileignorecase = vim.o.fileignorecase
  2107. vim.go.fic = vim.go.fileignorecase
  2108. --- When this option is set, the FileType autocommand event is triggered.
  2109. --- All autocommands that match with the value of this option will be
  2110. --- executed. Thus the value of 'filetype' is used in place of the file
  2111. --- name.
  2112. --- Otherwise this option does not always reflect the current file type.
  2113. --- This option is normally set when the file type is detected. To enable
  2114. --- this use the ":filetype on" command. `:filetype`
  2115. --- Setting this option to a different value is most useful in a modeline,
  2116. --- for a file for which the file type is not automatically recognized.
  2117. --- Example, for in an IDL file: >c
  2118. --- /* vim: set filetype=idl : */
  2119. --- ```
  2120. --- `FileType` `filetypes`
  2121. --- When a dot appears in the value then this separates two filetype
  2122. --- names, it should therefore not be used for a filetype. Example: >c
  2123. --- /* vim: set filetype=c.doxygen : */
  2124. --- ```
  2125. --- This will use the "c" filetype first, then the "doxygen" filetype.
  2126. --- This works both for filetype plugins and for syntax files. More than
  2127. --- one dot may appear.
  2128. --- This option is not copied to another buffer, independent of the 's' or
  2129. --- 'S' flag in 'cpoptions'.
  2130. --- Only alphanumeric characters, '-' and '_' can be used.
  2131. ---
  2132. --- @type string
  2133. vim.o.filetype = ""
  2134. vim.o.ft = vim.o.filetype
  2135. vim.bo.filetype = vim.o.filetype
  2136. vim.bo.ft = vim.bo.filetype
  2137. --- Characters to fill the statuslines, vertical separators and special
  2138. --- lines in the window.
  2139. --- It is a comma-separated list of items. Each item has a name, a colon
  2140. --- and the value of that item: `E1511`
  2141. ---
  2142. --- item default Used for ~
  2143. --- stl ' ' statusline of the current window
  2144. --- stlnc ' ' statusline of the non-current windows
  2145. --- wbr ' ' window bar
  2146. --- horiz '─' or '-' horizontal separators `:split`
  2147. --- horizup '┴' or '-' upwards facing horizontal separator
  2148. --- horizdown '┬' or '-' downwards facing horizontal separator
  2149. --- vert '│' or '|' vertical separators `:vsplit`
  2150. --- vertleft '┤' or '|' left facing vertical separator
  2151. --- vertright '├' or '|' right facing vertical separator
  2152. --- verthoriz '┼' or '+' overlapping vertical and horizontal
  2153. --- separator
  2154. --- fold '·' or '-' filling 'foldtext'
  2155. --- foldopen '-' mark the beginning of a fold
  2156. --- foldclose '+' show a closed fold
  2157. --- foldsep '│' or '|' open fold middle marker
  2158. --- diff '-' deleted lines of the 'diff' option
  2159. --- msgsep ' ' message separator 'display'
  2160. --- eob '~' empty lines at the end of a buffer
  2161. --- lastline '@' 'display' contains lastline/truncate
  2162. ---
  2163. --- Any one that is omitted will fall back to the default.
  2164. ---
  2165. --- Note that "horiz", "horizup", "horizdown", "vertleft", "vertright" and
  2166. --- "verthoriz" are only used when 'laststatus' is 3, since only vertical
  2167. --- window separators are used otherwise.
  2168. ---
  2169. --- If 'ambiwidth' is "double" then "horiz", "horizup", "horizdown",
  2170. --- "vert", "vertleft", "vertright", "verthoriz", "foldsep" and "fold"
  2171. --- default to single-byte alternatives.
  2172. ---
  2173. --- Example:
  2174. ---
  2175. --- ```vim
  2176. --- set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
  2177. --- ```
  2178. ---
  2179. --- For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
  2180. --- single-byte and multibyte characters are supported. But double-width
  2181. --- characters are not supported. `E1512`
  2182. ---
  2183. --- The highlighting used for these items:
  2184. --- item highlight group ~
  2185. --- stl StatusLine `hl-StatusLine`
  2186. --- stlnc StatusLineNC `hl-StatusLineNC`
  2187. --- wbr WinBar `hl-WinBar` or `hl-WinBarNC`
  2188. --- horiz WinSeparator `hl-WinSeparator`
  2189. --- horizup WinSeparator `hl-WinSeparator`
  2190. --- horizdown WinSeparator `hl-WinSeparator`
  2191. --- vert WinSeparator `hl-WinSeparator`
  2192. --- vertleft WinSeparator `hl-WinSeparator`
  2193. --- vertright WinSeparator `hl-WinSeparator`
  2194. --- verthoriz WinSeparator `hl-WinSeparator`
  2195. --- fold Folded `hl-Folded`
  2196. --- diff DiffDelete `hl-DiffDelete`
  2197. --- eob EndOfBuffer `hl-EndOfBuffer`
  2198. --- lastline NonText `hl-NonText`
  2199. ---
  2200. --- @type string
  2201. vim.o.fillchars = ""
  2202. vim.o.fcs = vim.o.fillchars
  2203. vim.wo.fillchars = vim.o.fillchars
  2204. vim.wo.fcs = vim.wo.fillchars
  2205. vim.go.fillchars = vim.o.fillchars
  2206. vim.go.fcs = vim.go.fillchars
  2207. --- Function that is called to obtain the filename(s) for the `:find`
  2208. --- command. When this option is empty, the internal `file-searching`
  2209. --- mechanism is used.
  2210. ---
  2211. --- The value can be the name of a function, a `lambda` or a `Funcref`.
  2212. --- See `option-value-function` for more information.
  2213. ---
  2214. --- The function is called with two arguments. The first argument is a
  2215. --- `String` and is the `:find` command argument. The second argument is
  2216. --- a `Boolean` and is set to `v:true` when the function is called to get
  2217. --- a List of command-line completion matches for the `:find` command.
  2218. --- The function should return a List of strings.
  2219. ---
  2220. --- The function is called only once per `:find` command invocation.
  2221. --- The function can process all the directories specified in 'path'.
  2222. ---
  2223. --- If a match is found, the function should return a `List` containing
  2224. --- one or more file names. If a match is not found, the function
  2225. --- should return an empty List.
  2226. ---
  2227. --- If any errors are encountered during the function invocation, an
  2228. --- empty List is used as the return value.
  2229. ---
  2230. --- It is not allowed to change text or jump to another window while
  2231. --- executing the 'findfunc' `textlock`.
  2232. ---
  2233. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2234. --- security reasons.
  2235. ---
  2236. --- Examples:
  2237. ---
  2238. --- ```vim
  2239. --- " Use glob()
  2240. --- func FindFuncGlob(cmdarg, cmdcomplete)
  2241. --- let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
  2242. --- return glob(pat, v:false, v:true)
  2243. --- endfunc
  2244. --- set findfunc=FindFuncGlob
  2245. ---
  2246. --- " Use the 'git ls-files' output
  2247. --- func FindGitFiles(cmdarg, cmdcomplete)
  2248. --- let fnames = systemlist('git ls-files')
  2249. --- return fnames->filter('v:val =~? a:cmdarg')
  2250. --- endfunc
  2251. --- set findfunc=FindGitFiles
  2252. --- ```
  2253. ---
  2254. ---
  2255. --- @type string
  2256. vim.o.findfunc = ""
  2257. vim.o.ffu = vim.o.findfunc
  2258. vim.bo.findfunc = vim.o.findfunc
  2259. vim.bo.ffu = vim.bo.findfunc
  2260. vim.go.findfunc = vim.o.findfunc
  2261. vim.go.ffu = vim.go.findfunc
  2262. --- When writing a file and this option is on, <EOL> at the end of file
  2263. --- will be restored if missing. Turn this option off if you want to
  2264. --- preserve the situation from the original file.
  2265. --- When the 'binary' option is set the value of this option doesn't
  2266. --- matter.
  2267. --- See the 'endofline' option.
  2268. --- See `eol-and-eof` for example settings.
  2269. ---
  2270. --- @type boolean
  2271. vim.o.fixendofline = true
  2272. vim.o.fixeol = vim.o.fixendofline
  2273. vim.bo.fixendofline = vim.o.fixendofline
  2274. vim.bo.fixeol = vim.bo.fixendofline
  2275. --- When set to "all", a fold is closed when the cursor isn't in it and
  2276. --- its level is higher than 'foldlevel'. Useful if you want folds to
  2277. --- automatically close when moving out of them.
  2278. ---
  2279. --- @type string
  2280. vim.o.foldclose = ""
  2281. vim.o.fcl = vim.o.foldclose
  2282. vim.go.foldclose = vim.o.foldclose
  2283. vim.go.fcl = vim.go.foldclose
  2284. --- When and how to draw the foldcolumn. Valid values are:
  2285. --- "auto": resize to the minimum amount of folds to display.
  2286. --- "auto:[1-9]": resize to accommodate multiple folds up to the
  2287. --- selected level
  2288. --- "0": to disable foldcolumn
  2289. --- "[1-9]": to display a fixed number of columns
  2290. --- See `folding`.
  2291. ---
  2292. --- @type string
  2293. vim.o.foldcolumn = "0"
  2294. vim.o.fdc = vim.o.foldcolumn
  2295. vim.wo.foldcolumn = vim.o.foldcolumn
  2296. vim.wo.fdc = vim.wo.foldcolumn
  2297. --- When off, all folds are open. This option can be used to quickly
  2298. --- switch between showing all text unfolded and viewing the text with
  2299. --- folds (including manually opened or closed folds). It can be toggled
  2300. --- with the `zi` command. The 'foldcolumn' will remain blank when
  2301. --- 'foldenable' is off.
  2302. --- This option is set by commands that create a new fold or close a fold.
  2303. --- See `folding`.
  2304. ---
  2305. --- @type boolean
  2306. vim.o.foldenable = true
  2307. vim.o.fen = vim.o.foldenable
  2308. vim.wo.foldenable = vim.o.foldenable
  2309. vim.wo.fen = vim.wo.foldenable
  2310. --- The expression used for when 'foldmethod' is "expr". It is evaluated
  2311. --- for each line to obtain its fold level. The context is set to the
  2312. --- script where 'foldexpr' was set, script-local items can be accessed.
  2313. --- See `fold-expr` for the usage.
  2314. ---
  2315. --- The expression will be evaluated in the `sandbox` if set from a
  2316. --- modeline, see `sandbox-option`.
  2317. --- This option can't be set from a `modeline` when the 'diff' option is
  2318. --- on or the 'modelineexpr' option is off.
  2319. ---
  2320. --- It is not allowed to change text or jump to another window while
  2321. --- evaluating 'foldexpr' `textlock`.
  2322. ---
  2323. --- @type string
  2324. vim.o.foldexpr = "0"
  2325. vim.o.fde = vim.o.foldexpr
  2326. vim.wo.foldexpr = vim.o.foldexpr
  2327. vim.wo.fde = vim.wo.foldexpr
  2328. --- Used only when 'foldmethod' is "indent". Lines starting with
  2329. --- characters in 'foldignore' will get their fold level from surrounding
  2330. --- lines. White space is skipped before checking for this character.
  2331. --- The default "#" works well for C programs. See `fold-indent`.
  2332. ---
  2333. --- @type string
  2334. vim.o.foldignore = "#"
  2335. vim.o.fdi = vim.o.foldignore
  2336. vim.wo.foldignore = vim.o.foldignore
  2337. vim.wo.fdi = vim.wo.foldignore
  2338. --- Sets the fold level: Folds with a higher level will be closed.
  2339. --- Setting this option to zero will close all folds. Higher numbers will
  2340. --- close fewer folds.
  2341. --- This option is set by commands like `zm`, `zM` and `zR`.
  2342. --- See `fold-foldlevel`.
  2343. ---
  2344. --- @type integer
  2345. vim.o.foldlevel = 0
  2346. vim.o.fdl = vim.o.foldlevel
  2347. vim.wo.foldlevel = vim.o.foldlevel
  2348. vim.wo.fdl = vim.wo.foldlevel
  2349. --- Sets 'foldlevel' when starting to edit another buffer in a window.
  2350. --- Useful to always start editing with all folds closed (value zero),
  2351. --- some folds closed (one) or no folds closed (99).
  2352. --- This is done before reading any modeline, thus a setting in a modeline
  2353. --- overrules this option. Starting to edit a file for `diff-mode` also
  2354. --- ignores this option and closes all folds.
  2355. --- It is also done before BufReadPre autocommands, to allow an autocmd to
  2356. --- overrule the 'foldlevel' value for specific files.
  2357. --- When the value is negative, it is not used.
  2358. ---
  2359. --- @type integer
  2360. vim.o.foldlevelstart = -1
  2361. vim.o.fdls = vim.o.foldlevelstart
  2362. vim.go.foldlevelstart = vim.o.foldlevelstart
  2363. vim.go.fdls = vim.go.foldlevelstart
  2364. --- The start and end marker used when 'foldmethod' is "marker". There
  2365. --- must be one comma, which separates the start and end marker. The
  2366. --- marker is a literal string (a regular expression would be too slow).
  2367. --- See `fold-marker`.
  2368. ---
  2369. --- @type string
  2370. vim.o.foldmarker = "{{{,}}}"
  2371. vim.o.fmr = vim.o.foldmarker
  2372. vim.wo.foldmarker = vim.o.foldmarker
  2373. vim.wo.fmr = vim.wo.foldmarker
  2374. --- The kind of folding used for the current window. Possible values:
  2375. --- `fold-manual` manual Folds are created manually.
  2376. --- `fold-indent` indent Lines with equal indent form a fold.
  2377. --- `fold-expr` expr 'foldexpr' gives the fold level of a line.
  2378. --- `fold-marker` marker Markers are used to specify folds.
  2379. --- `fold-syntax` syntax Syntax highlighting items specify folds.
  2380. --- `fold-diff` diff Fold text that is not changed.
  2381. ---
  2382. --- @type string
  2383. vim.o.foldmethod = "manual"
  2384. vim.o.fdm = vim.o.foldmethod
  2385. vim.wo.foldmethod = vim.o.foldmethod
  2386. vim.wo.fdm = vim.wo.foldmethod
  2387. --- Sets the number of screen lines above which a fold can be displayed
  2388. --- closed. Also for manually closed folds. With the default value of
  2389. --- one a fold can only be closed if it takes up two or more screen lines.
  2390. --- Set to zero to be able to close folds of just one screen line.
  2391. --- Note that this only has an effect on what is displayed. After using
  2392. --- "zc" to close a fold, which is displayed open because it's smaller
  2393. --- than 'foldminlines', a following "zc" may close a containing fold.
  2394. ---
  2395. --- @type integer
  2396. vim.o.foldminlines = 1
  2397. vim.o.fml = vim.o.foldminlines
  2398. vim.wo.foldminlines = vim.o.foldminlines
  2399. vim.wo.fml = vim.wo.foldminlines
  2400. --- Sets the maximum nesting of folds for the "indent" and "syntax"
  2401. --- methods. This avoids that too many folds will be created. Using more
  2402. --- than 20 doesn't work, because the internal limit is 20.
  2403. ---
  2404. --- @type integer
  2405. vim.o.foldnestmax = 20
  2406. vim.o.fdn = vim.o.foldnestmax
  2407. vim.wo.foldnestmax = vim.o.foldnestmax
  2408. vim.wo.fdn = vim.wo.foldnestmax
  2409. --- Specifies for which type of commands folds will be opened, if the
  2410. --- command moves the cursor into a closed fold. It is a comma-separated
  2411. --- list of items.
  2412. --- NOTE: When the command is part of a mapping this option is not used.
  2413. --- Add the `zv` command to the mapping to get the same effect.
  2414. --- (rationale: the mapping may want to control opening folds itself)
  2415. ---
  2416. --- item commands ~
  2417. --- all any
  2418. --- block (, {, [[, [{, etc.
  2419. --- hor horizontal movements: "l", "w", "fx", etc.
  2420. --- insert any command in Insert mode
  2421. --- jump far jumps: "G", "gg", etc.
  2422. --- mark jumping to a mark: "'m", CTRL-O, etc.
  2423. --- percent "%"
  2424. --- quickfix ":cn", ":crew", ":make", etc.
  2425. --- search search for a pattern: "/", "n", "*", "gd", etc.
  2426. --- (not for a search pattern in a ":" command)
  2427. --- Also for `[s` and `]s`.
  2428. --- tag jumping to a tag: ":ta", CTRL-T, etc.
  2429. --- undo undo or redo: "u" and CTRL-R
  2430. --- When a movement command is used for an operator (e.g., "dl" or "y%")
  2431. --- this option is not used. This means the operator will include the
  2432. --- whole closed fold.
  2433. --- Note that vertical movements are not here, because it would make it
  2434. --- very difficult to move onto a closed fold.
  2435. --- In insert mode the folds containing the cursor will always be open
  2436. --- when text is inserted.
  2437. --- To close folds you can re-apply 'foldlevel' with the `zx` command or
  2438. --- set the 'foldclose' option to "all".
  2439. ---
  2440. --- @type string
  2441. vim.o.foldopen = "block,hor,mark,percent,quickfix,search,tag,undo"
  2442. vim.o.fdo = vim.o.foldopen
  2443. vim.go.foldopen = vim.o.foldopen
  2444. vim.go.fdo = vim.go.foldopen
  2445. --- An expression which is used to specify the text displayed for a closed
  2446. --- fold. The context is set to the script where 'foldexpr' was set,
  2447. --- script-local items can be accessed. See `fold-foldtext` for the
  2448. --- usage.
  2449. ---
  2450. --- The expression will be evaluated in the `sandbox` if set from a
  2451. --- modeline, see `sandbox-option`.
  2452. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  2453. ---
  2454. --- It is not allowed to change text or jump to another window while
  2455. --- evaluating 'foldtext' `textlock`.
  2456. ---
  2457. --- When set to an empty string, foldtext is disabled, and the line
  2458. --- is displayed normally with highlighting and no line wrapping.
  2459. ---
  2460. --- @type string
  2461. vim.o.foldtext = "foldtext()"
  2462. vim.o.fdt = vim.o.foldtext
  2463. vim.wo.foldtext = vim.o.foldtext
  2464. vim.wo.fdt = vim.wo.foldtext
  2465. --- Expression which is evaluated to format a range of lines for the `gq`
  2466. --- operator or automatic formatting (see 'formatoptions'). When this
  2467. --- option is empty 'formatprg' is used.
  2468. ---
  2469. --- The `v:lnum` variable holds the first line to be formatted.
  2470. --- The `v:count` variable holds the number of lines to be formatted.
  2471. --- The `v:char` variable holds the character that is going to be
  2472. --- inserted if the expression is being evaluated due to
  2473. --- automatic formatting. This can be empty. Don't insert
  2474. --- it yet!
  2475. ---
  2476. --- Example:
  2477. ---
  2478. --- ```vim
  2479. --- set formatexpr=mylang#Format()
  2480. --- ```
  2481. --- This will invoke the mylang#Format() function in the
  2482. --- autoload/mylang.vim file in 'runtimepath'. `autoload`
  2483. ---
  2484. --- The advantage of using a function call without arguments is that it is
  2485. --- faster, see `expr-option-function`.
  2486. ---
  2487. --- The expression is also evaluated when 'textwidth' is set and adding
  2488. --- text beyond that limit. This happens under the same conditions as
  2489. --- when internal formatting is used. Make sure the cursor is kept in the
  2490. --- same spot relative to the text then! The `mode()` function will
  2491. --- return "i" or "R" in this situation.
  2492. ---
  2493. --- When the expression evaluates to non-zero Vim will fall back to using
  2494. --- the internal format mechanism.
  2495. ---
  2496. --- If the expression starts with s: or `<SID>`, then it is replaced with
  2497. --- the script ID (`local-function`). Example:
  2498. ---
  2499. --- ```vim
  2500. --- set formatexpr=s:MyFormatExpr()
  2501. --- set formatexpr=<SID>SomeFormatExpr()
  2502. --- ```
  2503. --- Otherwise, the expression is evaluated in the context of the script
  2504. --- where the option was set, thus script-local items are available.
  2505. ---
  2506. --- The expression will be evaluated in the `sandbox` when set from a
  2507. --- modeline, see `sandbox-option`. That stops the option from working,
  2508. --- since changing the buffer text is not allowed.
  2509. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  2510. --- NOTE: This option is set to "" when 'compatible' is set.
  2511. ---
  2512. --- @type string
  2513. vim.o.formatexpr = ""
  2514. vim.o.fex = vim.o.formatexpr
  2515. vim.bo.formatexpr = vim.o.formatexpr
  2516. vim.bo.fex = vim.bo.formatexpr
  2517. --- A pattern that is used to recognize a list header. This is used for
  2518. --- the "n" flag in 'formatoptions'.
  2519. --- The pattern must match exactly the text that will be the indent for
  2520. --- the line below it. You can use `/\ze` to mark the end of the match
  2521. --- while still checking more characters. There must be a character
  2522. --- following the pattern, when it matches the whole line it is handled
  2523. --- like there is no match.
  2524. --- The default recognizes a number, followed by an optional punctuation
  2525. --- character and white space.
  2526. ---
  2527. --- @type string
  2528. vim.o.formatlistpat = "^\\s*\\d\\+[\\]:.)}\\t ]\\s*"
  2529. vim.o.flp = vim.o.formatlistpat
  2530. vim.bo.formatlistpat = vim.o.formatlistpat
  2531. vim.bo.flp = vim.bo.formatlistpat
  2532. --- This is a sequence of letters which describes how automatic
  2533. --- formatting is to be done.
  2534. --- See `fo-table` for possible values and `gq` for how to format text.
  2535. --- Commas can be inserted for readability.
  2536. --- To avoid problems with flags that are added in the future, use the
  2537. --- "+=" and "-=" feature of ":set" `add-option-flags`.
  2538. ---
  2539. --- @type string
  2540. vim.o.formatoptions = "tcqj"
  2541. vim.o.fo = vim.o.formatoptions
  2542. vim.bo.formatoptions = vim.o.formatoptions
  2543. vim.bo.fo = vim.bo.formatoptions
  2544. --- The name of an external program that will be used to format the lines
  2545. --- selected with the `gq` operator. The program must take the input on
  2546. --- stdin and produce the output on stdout. The Unix program "fmt" is
  2547. --- such a program.
  2548. --- If the 'formatexpr' option is not empty it will be used instead.
  2549. --- Otherwise, if 'formatprg' option is an empty string, the internal
  2550. --- format function will be used `C-indenting`.
  2551. --- Environment variables are expanded `:set_env`. See `option-backslash`
  2552. --- about including spaces and backslashes.
  2553. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2554. --- security reasons.
  2555. ---
  2556. --- @type string
  2557. vim.o.formatprg = ""
  2558. vim.o.fp = vim.o.formatprg
  2559. vim.bo.formatprg = vim.o.formatprg
  2560. vim.bo.fp = vim.bo.formatprg
  2561. vim.go.formatprg = vim.o.formatprg
  2562. vim.go.fp = vim.go.formatprg
  2563. --- When on, the OS function fsync() will be called after saving a file
  2564. --- (`:write`, `writefile()`, …), `swap-file`, `undo-persistence` and `shada-file`.
  2565. --- This flushes the file to disk, ensuring that it is safely written.
  2566. --- Slow on some systems: writing buffers, quitting Nvim, and other
  2567. --- operations may sometimes take a few seconds.
  2568. ---
  2569. --- Files are ALWAYS flushed ('fsync' is ignored) when:
  2570. --- - `CursorHold` event is triggered
  2571. --- - `:preserve` is called
  2572. --- - system signals low battery life
  2573. --- - Nvim exits abnormally
  2574. ---
  2575. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2576. --- security reasons.
  2577. ---
  2578. --- @type boolean
  2579. vim.o.fsync = true
  2580. vim.o.fs = vim.o.fsync
  2581. vim.go.fsync = vim.o.fsync
  2582. vim.go.fs = vim.go.fsync
  2583. --- When on, the ":substitute" flag 'g' is default on. This means that
  2584. --- all matches in a line are substituted instead of one. When a 'g' flag
  2585. --- is given to a ":substitute" command, this will toggle the substitution
  2586. --- of all or one match. See `complex-change`.
  2587. ---
  2588. --- command 'gdefault' on 'gdefault' off ~
  2589. --- :s/// subst. all subst. one
  2590. --- :s///g subst. one subst. all
  2591. --- :s///gg subst. all subst. one
  2592. ---
  2593. --- NOTE: Setting this option may break plugins that rely on the default
  2594. --- behavior of the 'g' flag. This will also make the 'g' flag have the
  2595. --- opposite effect of that documented in `:s_g`.
  2596. ---
  2597. --- @type boolean
  2598. vim.o.gdefault = false
  2599. vim.o.gd = vim.o.gdefault
  2600. vim.go.gdefault = vim.o.gdefault
  2601. vim.go.gd = vim.go.gdefault
  2602. --- Format to recognize for the ":grep" command output.
  2603. --- This is a scanf-like string that uses the same format as the
  2604. --- 'errorformat' option: see `errorformat`.
  2605. ---
  2606. --- If ripgrep ('grepprg') is available, this option defaults to `%f:%l:%c:%m`.
  2607. ---
  2608. --- @type string
  2609. vim.o.grepformat = "%f:%l:%m,%f:%l%m,%f %l%m"
  2610. vim.o.gfm = vim.o.grepformat
  2611. vim.go.grepformat = vim.o.grepformat
  2612. vim.go.gfm = vim.go.grepformat
  2613. --- Program to use for the `:grep` command. This option may contain '%'
  2614. --- and '#' characters, which are expanded like when used in a command-
  2615. --- line. The placeholder "$*" is allowed to specify where the arguments
  2616. --- will be included. Environment variables are expanded `:set_env`. See
  2617. --- `option-backslash` about including spaces and backslashes.
  2618. --- Special value: When 'grepprg' is set to "internal" the `:grep` command
  2619. --- works like `:vimgrep`, `:lgrep` like `:lvimgrep`, `:grepadd` like
  2620. --- `:vimgrepadd` and `:lgrepadd` like `:lvimgrepadd`.
  2621. --- See also the section `:make_makeprg`, since most of the comments there
  2622. --- apply equally to 'grepprg'.
  2623. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2624. --- security reasons.
  2625. --- This option defaults to:
  2626. --- - `rg --vimgrep -uu ` if ripgrep is available (`:checkhealth`),
  2627. --- - `grep -HIn $* /dev/null` on Unix,
  2628. --- - `findstr /n $* nul` on Windows.
  2629. --- Ripgrep can perform additional filtering such as using .gitignore rules
  2630. --- and skipping hidden files. This is disabled by default (see the -u option)
  2631. --- to more closely match the behaviour of standard grep.
  2632. --- You can make ripgrep match Vim's case handling using the
  2633. --- -i/--ignore-case and -S/--smart-case options.
  2634. --- An `OptionSet` autocmd can be used to set it up to match automatically.
  2635. ---
  2636. --- @type string
  2637. vim.o.grepprg = "grep -HIn $* /dev/null"
  2638. vim.o.gp = vim.o.grepprg
  2639. vim.bo.grepprg = vim.o.grepprg
  2640. vim.bo.gp = vim.bo.grepprg
  2641. vim.go.grepprg = vim.o.grepprg
  2642. vim.go.gp = vim.go.grepprg
  2643. --- Configures the cursor style for each mode. Works in the GUI and many
  2644. --- terminals. See `tui-cursor-shape`.
  2645. ---
  2646. --- To disable cursor-styling, reset the option:
  2647. ---
  2648. --- ```vim
  2649. --- set guicursor=
  2650. --- ```
  2651. --- To enable mode shapes, "Cursor" highlight, and blinking:
  2652. ---
  2653. --- ```vim
  2654. --- set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50
  2655. --- \,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor
  2656. --- \,sm:block-blinkwait175-blinkoff150-blinkon175
  2657. --- ```
  2658. --- The option is a comma-separated list of parts. Each part consists of a
  2659. --- mode-list and an argument-list:
  2660. --- mode-list:argument-list,mode-list:argument-list,..
  2661. --- The mode-list is a dash separated list of these modes:
  2662. --- n Normal mode
  2663. --- v Visual mode
  2664. --- ve Visual mode with 'selection' "exclusive" (same as 'v',
  2665. --- if not specified)
  2666. --- o Operator-pending mode
  2667. --- i Insert mode
  2668. --- r Replace mode
  2669. --- c Command-line Normal (append) mode
  2670. --- ci Command-line Insert mode
  2671. --- cr Command-line Replace mode
  2672. --- sm showmatch in Insert mode
  2673. --- t Terminal mode
  2674. --- a all modes
  2675. --- The argument-list is a dash separated list of these arguments:
  2676. --- hor{N} horizontal bar, {N} percent of the character height
  2677. --- ver{N} vertical bar, {N} percent of the character width
  2678. --- block block cursor, fills the whole character
  2679. --- - Only one of the above three should be present.
  2680. --- - Default is "block" for each mode.
  2681. --- blinkwait{N} *cursor-blinking*
  2682. --- blinkon{N}
  2683. --- blinkoff{N}
  2684. --- blink times for cursor: blinkwait is the delay before
  2685. --- the cursor starts blinking, blinkon is the time that
  2686. --- the cursor is shown and blinkoff is the time that the
  2687. --- cursor is not shown. Times are in msec. When one of
  2688. --- the numbers is zero, there is no blinking. E.g.:
  2689. ---
  2690. --- ```vim
  2691. --- set guicursor=n:blinkon0
  2692. --- ```
  2693. ---
  2694. --- Default is "blinkon0" for each mode.
  2695. --- {group-name}
  2696. --- Highlight group that decides the color and font of the
  2697. --- cursor.
  2698. --- In the `TUI`:
  2699. --- - `inverse`/reverse and no group-name are interpreted
  2700. --- as "host-terminal default cursor colors" which
  2701. --- typically means "inverted bg and fg colors".
  2702. --- - `ctermfg` and `guifg` are ignored.
  2703. --- {group-name}/{group-name}
  2704. --- Two highlight group names, the first is used when
  2705. --- no language mappings are used, the other when they
  2706. --- are. `language-mapping`
  2707. ---
  2708. --- Examples of parts:
  2709. --- n-c-v:block-nCursor In Normal, Command-line and Visual mode, use a
  2710. --- block cursor with colors from the "nCursor"
  2711. --- highlight group
  2712. --- n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20
  2713. --- In Normal et al. modes, use a block cursor
  2714. --- with the default colors defined by the host
  2715. --- terminal. In Insert-like modes, use
  2716. --- a vertical bar cursor with colors from
  2717. --- "Cursor" highlight group. In Replace-like
  2718. --- modes, use an underline cursor with
  2719. --- default colors.
  2720. --- i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
  2721. --- In Insert and Command-line Insert mode, use a
  2722. --- 30% vertical bar cursor with colors from the
  2723. --- "iCursor" highlight group. Blink a bit
  2724. --- faster.
  2725. ---
  2726. --- The 'a' mode is different. It will set the given argument-list for
  2727. --- all modes. It does not reset anything to defaults. This can be used
  2728. --- to do a common setting for all modes. For example, to switch off
  2729. --- blinking: "a:blinkon0"
  2730. ---
  2731. --- Examples of cursor highlighting:
  2732. ---
  2733. --- ```vim
  2734. --- highlight Cursor gui=reverse guifg=NONE guibg=NONE
  2735. --- highlight Cursor gui=NONE guifg=bg guibg=fg
  2736. --- ```
  2737. ---
  2738. ---
  2739. --- @type string
  2740. vim.o.guicursor = "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20,t:block-blinkon500-blinkoff500-TermCursor"
  2741. vim.o.gcr = vim.o.guicursor
  2742. vim.go.guicursor = vim.o.guicursor
  2743. vim.go.gcr = vim.go.guicursor
  2744. --- This is a list of fonts which will be used for the GUI version of Vim.
  2745. --- In its simplest form the value is just one font name. When
  2746. --- the font cannot be found you will get an error message. To try other
  2747. --- font names a list can be specified, font names separated with commas.
  2748. --- The first valid font is used.
  2749. ---
  2750. --- Spaces after a comma are ignored. To include a comma in a font name
  2751. --- precede it with a backslash. Setting an option requires an extra
  2752. --- backslash before a space and a backslash. See also
  2753. --- `option-backslash`. For example:
  2754. ---
  2755. --- ```vim
  2756. --- set guifont=Screen15,\ 7x13,font\\,with\\,commas
  2757. --- ```
  2758. --- will make Vim try to use the font "Screen15" first, and if it fails it
  2759. --- will try to use "7x13" and then "font,with,commas" instead.
  2760. ---
  2761. --- If none of the fonts can be loaded, Vim will keep the current setting.
  2762. --- If an empty font list is given, Vim will try using other resource
  2763. --- settings (for X, it will use the Vim.font resource), and finally it
  2764. --- will try some builtin default which should always be there ("7x13" in
  2765. --- the case of X). The font names given should be "normal" fonts. Vim
  2766. --- will try to find the related bold and italic fonts.
  2767. ---
  2768. --- For Win32 and Mac OS:
  2769. ---
  2770. --- ```vim
  2771. --- set guifont=*
  2772. --- ```
  2773. --- will bring up a font requester, where you can pick the font you want.
  2774. ---
  2775. --- The font name depends on the GUI used.
  2776. ---
  2777. --- For Mac OSX you can use something like this:
  2778. ---
  2779. --- ```vim
  2780. --- set guifont=Monaco:h10
  2781. --- ```
  2782. --- *E236*
  2783. --- Note that the fonts must be mono-spaced (all characters have the same
  2784. --- width).
  2785. ---
  2786. --- To preview a font on X11, you might be able to use the "xfontsel"
  2787. --- program. The "xlsfonts" program gives a list of all available fonts.
  2788. ---
  2789. --- For the Win32 GUI *E244* *E245*
  2790. --- - takes these options in the font name:
  2791. --- hXX - height is XX (points, can be floating-point)
  2792. --- wXX - width is XX (points, can be floating-point)
  2793. --- b - bold
  2794. --- i - italic
  2795. --- u - underline
  2796. --- s - strikeout
  2797. --- cXX - character set XX. Valid charsets are: ANSI, ARABIC,
  2798. --- BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
  2799. --- HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
  2800. --- SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
  2801. --- Normally you would use "cDEFAULT".
  2802. ---
  2803. --- Use a ':' to separate the options.
  2804. --- - A '_' can be used in the place of a space, so you don't need to use
  2805. --- backslashes to escape the spaces.
  2806. --- - Examples:
  2807. ---
  2808. --- ```vim
  2809. --- set guifont=courier_new:h12:w5:b:cRUSSIAN
  2810. --- set guifont=Andale_Mono:h7.5:w4.5
  2811. --- ```
  2812. ---
  2813. ---
  2814. --- @type string
  2815. vim.o.guifont = ""
  2816. vim.o.gfn = vim.o.guifont
  2817. vim.go.guifont = vim.o.guifont
  2818. vim.go.gfn = vim.go.guifont
  2819. --- Comma-separated list of fonts to be used for double-width characters.
  2820. --- The first font that can be loaded is used.
  2821. --- Note: The size of these fonts must be exactly twice as wide as the one
  2822. --- specified with 'guifont' and the same height.
  2823. ---
  2824. --- When 'guifont' has a valid font and 'guifontwide' is empty Vim will
  2825. --- attempt to set 'guifontwide' to a matching double-width font.
  2826. ---
  2827. --- @type string
  2828. vim.o.guifontwide = ""
  2829. vim.o.gfw = vim.o.guifontwide
  2830. vim.go.guifontwide = vim.o.guifontwide
  2831. vim.go.gfw = vim.go.guifontwide
  2832. --- Name of the main help file. All distributed help files should be
  2833. --- placed together in one directory. Additionally, all "doc" directories
  2834. --- in 'runtimepath' will be used.
  2835. --- Environment variables are expanded `:set_env`. For example:
  2836. --- "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
  2837. --- tried. Also see `$VIMRUNTIME` and `option-backslash` about including
  2838. --- spaces and backslashes.
  2839. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  2840. --- security reasons.
  2841. ---
  2842. --- @type string
  2843. vim.o.helpfile = "$VIMRUNTIME/doc/help.txt"
  2844. vim.o.hf = vim.o.helpfile
  2845. vim.go.helpfile = vim.o.helpfile
  2846. vim.go.hf = vim.go.helpfile
  2847. --- Minimal initial height of the help window when it is opened with the
  2848. --- ":help" command. The initial height of the help window is half of the
  2849. --- current window, or (when the 'ea' option is on) the same as other
  2850. --- windows. When the height is less than 'helpheight', the height is
  2851. --- set to 'helpheight'. Set to zero to disable.
  2852. ---
  2853. --- @type integer
  2854. vim.o.helpheight = 20
  2855. vim.o.hh = vim.o.helpheight
  2856. vim.go.helpheight = vim.o.helpheight
  2857. vim.go.hh = vim.go.helpheight
  2858. --- Comma-separated list of languages. Vim will use the first language
  2859. --- for which the desired help can be found. The English help will always
  2860. --- be used as a last resort. You can add "en" to prefer English over
  2861. --- another language, but that will only find tags that exist in that
  2862. --- language and not in the English help.
  2863. --- Example:
  2864. ---
  2865. --- ```vim
  2866. --- set helplang=de,it
  2867. --- ```
  2868. --- This will first search German, then Italian and finally English help
  2869. --- files.
  2870. --- When using `CTRL-]` and ":help!" in a non-English help file Vim will
  2871. --- try to find the tag in the current language before using this option.
  2872. --- See `help-translated`.
  2873. ---
  2874. --- @type string
  2875. vim.o.helplang = ""
  2876. vim.o.hlg = vim.o.helplang
  2877. vim.go.helplang = vim.o.helplang
  2878. vim.go.hlg = vim.go.helplang
  2879. --- When off a buffer is unloaded (including loss of undo information)
  2880. --- when it is `abandon`ed. When on a buffer becomes hidden when it is
  2881. --- `abandon`ed. A buffer displayed in another window does not become
  2882. --- hidden, of course.
  2883. ---
  2884. --- Commands that move through the buffer list sometimes hide a buffer
  2885. --- although the 'hidden' option is off when these three are true:
  2886. --- - the buffer is modified
  2887. --- - 'autowrite' is off or writing is not possible
  2888. --- - the '!' flag was used
  2889. --- Also see `windows`.
  2890. ---
  2891. --- To hide a specific buffer use the 'bufhidden' option.
  2892. --- 'hidden' is set for one command with ":hide {command}" `:hide`.
  2893. ---
  2894. --- @type boolean
  2895. vim.o.hidden = true
  2896. vim.o.hid = vim.o.hidden
  2897. vim.go.hidden = vim.o.hidden
  2898. vim.go.hid = vim.go.hidden
  2899. --- A history of ":" commands, and a history of previous search patterns
  2900. --- is remembered. This option decides how many entries may be stored in
  2901. --- each of these histories (see `cmdline-editing` and 'messagesopt' for
  2902. --- the number of messages to remember).
  2903. --- The maximum value is 10000.
  2904. ---
  2905. --- @type integer
  2906. vim.o.history = 10000
  2907. vim.o.hi = vim.o.history
  2908. vim.go.history = vim.o.history
  2909. vim.go.hi = vim.go.history
  2910. --- When there is a previous search pattern, highlight all its matches.
  2911. --- The `hl-Search` highlight group determines the highlighting for all
  2912. --- matches not under the cursor while the `hl-CurSearch` highlight group
  2913. --- (if defined) determines the highlighting for the match under the
  2914. --- cursor. If `hl-CurSearch` is not defined, then `hl-Search` is used for
  2915. --- both. Note that only the matching text is highlighted, any offsets
  2916. --- are not applied.
  2917. --- See also: 'incsearch' and `:match`.
  2918. --- When you get bored looking at the highlighted matches, you can turn it
  2919. --- off with `:nohlsearch`. This does not change the option value, as
  2920. --- soon as you use a search command, the highlighting comes back.
  2921. --- 'redrawtime' specifies the maximum time spent on finding matches.
  2922. --- When the search pattern can match an end-of-line, Vim will try to
  2923. --- highlight all of the matched text. However, this depends on where the
  2924. --- search starts. This will be the first line in the window or the first
  2925. --- line below a closed fold. A match in a previous line which is not
  2926. --- drawn may not continue in a newly drawn line.
  2927. --- You can specify whether the highlight status is restored on startup
  2928. --- with the 'h' flag in 'shada' `shada-h`.
  2929. ---
  2930. --- @type boolean
  2931. vim.o.hlsearch = true
  2932. vim.o.hls = vim.o.hlsearch
  2933. vim.go.hlsearch = vim.o.hlsearch
  2934. vim.go.hls = vim.go.hlsearch
  2935. --- When on, the icon text of the window will be set to the value of
  2936. --- 'iconstring' (if it is not empty), or to the name of the file
  2937. --- currently being edited. Only the last part of the name is used.
  2938. --- Overridden by the 'iconstring' option.
  2939. --- Only works if the terminal supports setting window icons.
  2940. ---
  2941. --- @type boolean
  2942. vim.o.icon = false
  2943. vim.go.icon = vim.o.icon
  2944. --- When this option is not empty, it will be used for the icon text of
  2945. --- the window. This happens only when the 'icon' option is on.
  2946. --- Only works if the terminal supports setting window icon text
  2947. --- When this option contains printf-style '%' items, they will be
  2948. --- expanded according to the rules used for 'statusline'. See
  2949. --- 'titlestring' for example settings.
  2950. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  2951. ---
  2952. --- @type string
  2953. vim.o.iconstring = ""
  2954. vim.go.iconstring = vim.o.iconstring
  2955. --- Ignore case in search patterns, `cmdline-completion`, when
  2956. --- searching in the tags file, and `expr-==`.
  2957. --- Also see 'smartcase' and 'tagcase'.
  2958. --- Can be overruled by using "\c" or "\C" in the pattern, see
  2959. --- `/ignorecase`.
  2960. ---
  2961. --- @type boolean
  2962. vim.o.ignorecase = false
  2963. vim.o.ic = vim.o.ignorecase
  2964. vim.go.ignorecase = vim.o.ignorecase
  2965. vim.go.ic = vim.go.ignorecase
  2966. --- Specifies whether :lmap or an Input Method (IM) is to be used in
  2967. --- Insert mode. Valid values:
  2968. --- 0 :lmap is off and IM is off
  2969. --- 1 :lmap is ON and IM is off
  2970. --- 2 :lmap is off and IM is ON
  2971. --- To always reset the option to zero when leaving Insert mode with <Esc>
  2972. --- this can be used:
  2973. ---
  2974. --- ```vim
  2975. --- inoremap <ESC> <ESC>:set iminsert=0<CR>
  2976. --- ```
  2977. --- This makes :lmap and IM turn off automatically when leaving Insert
  2978. --- mode.
  2979. --- Note that this option changes when using CTRL-^ in Insert mode
  2980. --- `i_CTRL-^`.
  2981. --- The value is set to 1 when setting 'keymap' to a valid keymap name.
  2982. --- It is also used for the argument of commands like "r" and "f".
  2983. ---
  2984. --- @type integer
  2985. vim.o.iminsert = 0
  2986. vim.o.imi = vim.o.iminsert
  2987. vim.bo.iminsert = vim.o.iminsert
  2988. vim.bo.imi = vim.bo.iminsert
  2989. --- Specifies whether :lmap or an Input Method (IM) is to be used when
  2990. --- entering a search pattern. Valid values:
  2991. --- -1 the value of 'iminsert' is used, makes it look like
  2992. --- 'iminsert' is also used when typing a search pattern
  2993. --- 0 :lmap is off and IM is off
  2994. --- 1 :lmap is ON and IM is off
  2995. --- 2 :lmap is off and IM is ON
  2996. --- Note that this option changes when using CTRL-^ in Command-line mode
  2997. --- `c_CTRL-^`.
  2998. --- The value is set to 1 when it is not -1 and setting the 'keymap'
  2999. --- option to a valid keymap name.
  3000. ---
  3001. --- @type integer
  3002. vim.o.imsearch = -1
  3003. vim.o.ims = vim.o.imsearch
  3004. vim.bo.imsearch = vim.o.imsearch
  3005. vim.bo.ims = vim.bo.imsearch
  3006. --- When nonempty, shows the effects of `:substitute`, `:smagic|,
  3007. --- |:snomagic` and user commands with the `:command-preview` flag as you
  3008. --- type.
  3009. ---
  3010. --- Possible values:
  3011. --- nosplit Shows the effects of a command incrementally in the
  3012. --- buffer.
  3013. --- split Like "nosplit", but also shows partial off-screen
  3014. --- results in a preview window.
  3015. ---
  3016. --- If the preview for built-in commands is too slow (exceeds
  3017. --- 'redrawtime') then 'inccommand' is automatically disabled until
  3018. --- `Command-line-mode` is done.
  3019. ---
  3020. --- @type string
  3021. vim.o.inccommand = "nosplit"
  3022. vim.o.icm = vim.o.inccommand
  3023. vim.go.inccommand = vim.o.inccommand
  3024. vim.go.icm = vim.go.inccommand
  3025. --- Pattern to be used to find an include command. It is a search
  3026. --- pattern, just like for the "/" command (See `pattern`). This option
  3027. --- is used for the commands "[i", "]I", "[d", etc.
  3028. --- Normally the 'isfname' option is used to recognize the file name that
  3029. --- comes after the matched pattern. But if "\zs" appears in the pattern
  3030. --- then the text matched from "\zs" to the end, or until "\ze" if it
  3031. --- appears, is used as the file name. Use this to include characters
  3032. --- that are not in 'isfname', such as a space. You can then use
  3033. --- 'includeexpr' to process the matched text.
  3034. --- See `option-backslash` about including spaces and backslashes.
  3035. ---
  3036. --- @type string
  3037. vim.o.include = ""
  3038. vim.o.inc = vim.o.include
  3039. vim.bo.include = vim.o.include
  3040. vim.bo.inc = vim.bo.include
  3041. vim.go.include = vim.o.include
  3042. vim.go.inc = vim.go.include
  3043. --- Expression to be used to transform the string found with the 'include'
  3044. --- option to a file name. Mostly useful to change "." to "/" for Java:
  3045. ---
  3046. --- ```vim
  3047. --- setlocal includeexpr=substitute(v:fname,'\\.','/','g')
  3048. --- ```
  3049. --- The "v:fname" variable will be set to the file name that was detected.
  3050. --- Note the double backslash: the `:set` command first halves them, then
  3051. --- one remains in the value, where "\." matches a dot literally. For
  3052. --- simple character replacements `tr()` avoids the need for escaping:
  3053. ---
  3054. --- ```vim
  3055. --- setlocal includeexpr=tr(v:fname,'.','/')
  3056. --- ```
  3057. ---
  3058. --- Also used for the `gf` command if an unmodified file name can't be
  3059. --- found. Allows doing "gf" on the name after an 'include' statement.
  3060. --- Also used for `<cfile>`.
  3061. ---
  3062. --- If the expression starts with s: or `<SID>`, then it is replaced with
  3063. --- the script ID (`local-function`). Example:
  3064. ---
  3065. --- ```vim
  3066. --- setlocal includeexpr=s:MyIncludeExpr()
  3067. --- setlocal includeexpr=<SID>SomeIncludeExpr()
  3068. --- ```
  3069. --- Otherwise, the expression is evaluated in the context of the script
  3070. --- where the option was set, thus script-local items are available.
  3071. ---
  3072. --- It is more efficient if the value is just a function call without
  3073. --- arguments, see `expr-option-function`.
  3074. ---
  3075. --- The expression will be evaluated in the `sandbox` when set from a
  3076. --- modeline, see `sandbox-option`.
  3077. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  3078. ---
  3079. --- It is not allowed to change text or jump to another window while
  3080. --- evaluating 'includeexpr' `textlock`.
  3081. ---
  3082. --- @type string
  3083. vim.o.includeexpr = ""
  3084. vim.o.inex = vim.o.includeexpr
  3085. vim.bo.includeexpr = vim.o.includeexpr
  3086. vim.bo.inex = vim.bo.includeexpr
  3087. --- While typing a search command, show where the pattern, as it was typed
  3088. --- so far, matches. The matched string is highlighted. If the pattern
  3089. --- is invalid or not found, nothing is shown. The screen will be updated
  3090. --- often, this is only useful on fast terminals.
  3091. --- Note that the match will be shown, but the cursor will return to its
  3092. --- original position when no match is found and when pressing <Esc>. You
  3093. --- still need to finish the search command with <Enter> to move the
  3094. --- cursor to the match.
  3095. --- You can use the CTRL-G and CTRL-T keys to move to the next and
  3096. --- previous match. `c_CTRL-G` `c_CTRL-T`
  3097. --- Vim only searches for about half a second. With a complicated
  3098. --- pattern and/or a lot of text the match may not be found. This is to
  3099. --- avoid that Vim hangs while you are typing the pattern.
  3100. --- The `hl-IncSearch` highlight group determines the highlighting.
  3101. --- When 'hlsearch' is on, all matched strings are highlighted too while
  3102. --- typing a search command. See also: 'hlsearch'.
  3103. --- If you don't want to turn 'hlsearch' on, but want to highlight all
  3104. --- matches while searching, you can turn on and off 'hlsearch' with
  3105. --- autocmd. Example:
  3106. ---
  3107. --- ```vim
  3108. --- augroup vimrc-incsearch-highlight
  3109. --- autocmd!
  3110. --- autocmd CmdlineEnter /,\? :set hlsearch
  3111. --- autocmd CmdlineLeave /,\? :set nohlsearch
  3112. --- augroup END
  3113. --- ```
  3114. ---
  3115. --- CTRL-L can be used to add one character from after the current match
  3116. --- to the command line. If 'ignorecase' and 'smartcase' are set and the
  3117. --- command line has no uppercase characters, the added character is
  3118. --- converted to lowercase.
  3119. --- CTRL-R CTRL-W can be used to add the word at the end of the current
  3120. --- match, excluding the characters that were already typed.
  3121. ---
  3122. --- @type boolean
  3123. vim.o.incsearch = true
  3124. vim.o.is = vim.o.incsearch
  3125. vim.go.incsearch = vim.o.incsearch
  3126. vim.go.is = vim.go.incsearch
  3127. --- Expression which is evaluated to obtain the proper indent for a line.
  3128. --- It is used when a new line is created, for the `=` operator and
  3129. --- in Insert mode as specified with the 'indentkeys' option.
  3130. --- When this option is not empty, it overrules the 'cindent' and
  3131. --- 'smartindent' indenting. When 'lisp' is set, this option is
  3132. --- only used when 'lispoptions' contains "expr:1".
  3133. --- The expression is evaluated with `v:lnum` set to the line number for
  3134. --- which the indent is to be computed. The cursor is also in this line
  3135. --- when the expression is evaluated (but it may be moved around).
  3136. ---
  3137. --- If the expression starts with s: or `<SID>`, then it is replaced with
  3138. --- the script ID (`local-function`). Example:
  3139. ---
  3140. --- ```vim
  3141. --- set indentexpr=s:MyIndentExpr()
  3142. --- set indentexpr=<SID>SomeIndentExpr()
  3143. --- ```
  3144. --- Otherwise, the expression is evaluated in the context of the script
  3145. --- where the option was set, thus script-local items are available.
  3146. ---
  3147. --- The advantage of using a function call without arguments is that it is
  3148. --- faster, see `expr-option-function`.
  3149. ---
  3150. --- The expression must return the number of spaces worth of indent. It
  3151. --- can return "-1" to keep the current indent (this means 'autoindent' is
  3152. --- used for the indent).
  3153. --- Functions useful for computing the indent are `indent()`, `cindent()`
  3154. --- and `lispindent()`.
  3155. --- The evaluation of the expression must not have side effects! It must
  3156. --- not change the text, jump to another window, etc. Afterwards the
  3157. --- cursor position is always restored, thus the cursor may be moved.
  3158. --- Normally this option would be set to call a function:
  3159. ---
  3160. --- ```vim
  3161. --- set indentexpr=GetMyIndent()
  3162. --- ```
  3163. --- Error messages will be suppressed, unless the 'debug' option contains
  3164. --- "msg".
  3165. --- See `indent-expression`.
  3166. ---
  3167. --- The expression will be evaluated in the `sandbox` when set from a
  3168. --- modeline, see `sandbox-option`.
  3169. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  3170. ---
  3171. --- It is not allowed to change text or jump to another window while
  3172. --- evaluating 'indentexpr' `textlock`.
  3173. ---
  3174. --- @type string
  3175. vim.o.indentexpr = ""
  3176. vim.o.inde = vim.o.indentexpr
  3177. vim.bo.indentexpr = vim.o.indentexpr
  3178. vim.bo.inde = vim.bo.indentexpr
  3179. --- A list of keys that, when typed in Insert mode, cause reindenting of
  3180. --- the current line. Only happens if 'indentexpr' isn't empty.
  3181. --- The format is identical to 'cinkeys', see `indentkeys-format`.
  3182. --- See `C-indenting` and `indent-expression`.
  3183. ---
  3184. --- @type string
  3185. vim.o.indentkeys = "0{,0},0),0],:,0#,!^F,o,O,e"
  3186. vim.o.indk = vim.o.indentkeys
  3187. vim.bo.indentkeys = vim.o.indentkeys
  3188. vim.bo.indk = vim.bo.indentkeys
  3189. --- When doing keyword completion in insert mode `ins-completion`, and
  3190. --- 'ignorecase' is also on, the case of the match is adjusted depending
  3191. --- on the typed text. If the typed text contains a lowercase letter
  3192. --- where the match has an upper case letter, the completed part is made
  3193. --- lowercase. If the typed text has no lowercase letters and the match
  3194. --- has a lowercase letter where the typed text has an uppercase letter,
  3195. --- and there is a letter before it, the completed part is made uppercase.
  3196. --- With 'noinfercase' the match is used as-is.
  3197. ---
  3198. --- @type boolean
  3199. vim.o.infercase = false
  3200. vim.o.inf = vim.o.infercase
  3201. vim.bo.infercase = vim.o.infercase
  3202. vim.bo.inf = vim.bo.infercase
  3203. --- The characters specified by this option are included in file names and
  3204. --- path names. Filenames are used for commands like "gf", "[i" and in
  3205. --- the tags file. It is also used for "\f" in a `pattern`.
  3206. --- Multi-byte characters 256 and above are always included, only the
  3207. --- characters up to 255 are specified with this option.
  3208. --- For UTF-8 the characters 0xa0 to 0xff are included as well.
  3209. --- Think twice before adding white space to this option. Although a
  3210. --- space may appear inside a file name, the effect will be that Vim
  3211. --- doesn't know where a file name starts or ends when doing completion.
  3212. --- It most likely works better without a space in 'isfname'.
  3213. ---
  3214. --- Note that on systems using a backslash as path separator, Vim tries to
  3215. --- do its best to make it work as you would expect. That is a bit
  3216. --- tricky, since Vi originally used the backslash to escape special
  3217. --- characters. Vim will not remove a backslash in front of a normal file
  3218. --- name character on these systems, but it will on Unix and alikes. The
  3219. --- '&' and '^' are not included by default, because these are special for
  3220. --- cmd.exe.
  3221. ---
  3222. --- The format of this option is a list of parts, separated with commas.
  3223. --- Each part can be a single character number or a range. A range is two
  3224. --- character numbers with '-' in between. A character number can be a
  3225. --- decimal number between 0 and 255 or the ASCII character itself (does
  3226. --- not work for digits). Example:
  3227. --- "_,-,128-140,#-43" (include '_' and '-' and the range
  3228. --- 128 to 140 and '#' to 43)
  3229. --- If a part starts with '^', the following character number or range
  3230. --- will be excluded from the option. The option is interpreted from left
  3231. --- to right. Put the excluded character after the range where it is
  3232. --- included. To include '^' itself use it as the last character of the
  3233. --- option or the end of a range. Example:
  3234. --- "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
  3235. --- If the character is '@', all characters where isalpha() returns TRUE
  3236. --- are included. Normally these are the characters a to z and A to Z,
  3237. --- plus accented characters. To include '@' itself use "@-@". Examples:
  3238. --- "@,^a-z" All alphabetic characters, excluding lower
  3239. --- case ASCII letters.
  3240. --- "a-z,A-Z,@-@" All letters plus the '@' character.
  3241. --- A comma can be included by using it where a character number is
  3242. --- expected. Example:
  3243. --- "48-57,,,_" Digits, comma and underscore.
  3244. --- A comma can be excluded by prepending a '^'. Example:
  3245. --- " -~,^,,9" All characters from space to '~', excluding
  3246. --- comma, plus <Tab>.
  3247. --- See `option-backslash` about including spaces and backslashes.
  3248. ---
  3249. --- @type string
  3250. vim.o.isfname = "@,48-57,/,.,-,_,+,,,#,$,%,~,="
  3251. vim.o.isf = vim.o.isfname
  3252. vim.go.isfname = vim.o.isfname
  3253. vim.go.isf = vim.go.isfname
  3254. --- The characters given by this option are included in identifiers.
  3255. --- Identifiers are used in recognizing environment variables and after a
  3256. --- match of the 'define' option. It is also used for "\i" in a
  3257. --- `pattern`. See 'isfname' for a description of the format of this
  3258. --- option. For '@' only characters up to 255 are used.
  3259. --- Careful: If you change this option, it might break expanding
  3260. --- environment variables. E.g., when '/' is included and Vim tries to
  3261. --- expand "$HOME/.local/state/nvim/shada/main.shada". Maybe you should
  3262. --- change 'iskeyword' instead.
  3263. ---
  3264. --- @type string
  3265. vim.o.isident = "@,48-57,_,192-255"
  3266. vim.o.isi = vim.o.isident
  3267. vim.go.isident = vim.o.isident
  3268. vim.go.isi = vim.go.isident
  3269. --- Keywords are used in searching and recognizing with many commands:
  3270. --- "w", "*", "[i", etc. It is also used for "\k" in a `pattern`. See
  3271. --- 'isfname' for a description of the format of this option. For '@'
  3272. --- characters above 255 check the "word" character class (any character
  3273. --- that is not white space or punctuation).
  3274. --- For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
  3275. --- For a help file it is set to all non-blank printable characters except
  3276. --- "*", '"' and '|' (so that CTRL-] on a command finds the help for that
  3277. --- command).
  3278. --- When the 'lisp' option is on the '-' character is always included.
  3279. --- This option also influences syntax highlighting, unless the syntax
  3280. --- uses `:syn-iskeyword`.
  3281. ---
  3282. --- @type string
  3283. vim.o.iskeyword = "@,48-57,_,192-255"
  3284. vim.o.isk = vim.o.iskeyword
  3285. vim.bo.iskeyword = vim.o.iskeyword
  3286. vim.bo.isk = vim.bo.iskeyword
  3287. --- The characters given by this option are displayed directly on the
  3288. --- screen. It is also used for "\p" in a `pattern`. The characters from
  3289. --- space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
  3290. --- even when they are not included in 'isprint' or excluded. See
  3291. --- 'isfname' for a description of the format of this option.
  3292. ---
  3293. --- Non-printable characters are displayed with two characters:
  3294. --- 0 - 31 "^@" - "^_"
  3295. --- 32 - 126 always single characters
  3296. --- 127 "^?"
  3297. --- 128 - 159 "~@" - "~_"
  3298. --- 160 - 254 "| " - "|~"
  3299. --- 255 "~?"
  3300. --- Illegal bytes from 128 to 255 (invalid UTF-8) are
  3301. --- displayed as <xx>, with the hexadecimal value of the byte.
  3302. --- When 'display' contains "uhex" all unprintable characters are
  3303. --- displayed as <xx>.
  3304. --- The SpecialKey highlighting will be used for unprintable characters.
  3305. --- `hl-SpecialKey`
  3306. ---
  3307. --- Multi-byte characters 256 and above are always included, only the
  3308. --- characters up to 255 are specified with this option. When a character
  3309. --- is printable but it is not available in the current font, a
  3310. --- replacement character will be shown.
  3311. --- Unprintable and zero-width Unicode characters are displayed as <xxxx>.
  3312. --- There is no option to specify these characters.
  3313. ---
  3314. --- @type string
  3315. vim.o.isprint = "@,161-255"
  3316. vim.o.isp = vim.o.isprint
  3317. vim.go.isprint = vim.o.isprint
  3318. vim.go.isp = vim.go.isprint
  3319. --- Insert two spaces after a '.', '?' and '!' with a join command.
  3320. --- Otherwise only one space is inserted.
  3321. ---
  3322. --- @type boolean
  3323. vim.o.joinspaces = false
  3324. vim.o.js = vim.o.joinspaces
  3325. vim.go.joinspaces = vim.o.joinspaces
  3326. vim.go.js = vim.go.joinspaces
  3327. --- List of words that change the behavior of the `jumplist`.
  3328. --- stack Make the jumplist behave like the tagstack.
  3329. --- Relative location of entries in the jumplist is
  3330. --- preserved at the cost of discarding subsequent entries
  3331. --- when navigating backwards in the jumplist and then
  3332. --- jumping to a location. `jumplist-stack`
  3333. ---
  3334. --- view When moving through the jumplist, `changelist|,
  3335. --- |alternate-file` or using `mark-motions` try to
  3336. --- restore the `mark-view` in which the action occurred.
  3337. ---
  3338. --- clean Remove unloaded buffers from the jumplist.
  3339. --- EXPERIMENTAL: this flag may change in the future.
  3340. ---
  3341. --- @type string
  3342. vim.o.jumpoptions = "clean"
  3343. vim.o.jop = vim.o.jumpoptions
  3344. vim.go.jumpoptions = vim.o.jumpoptions
  3345. vim.go.jop = vim.go.jumpoptions
  3346. --- Name of a keyboard mapping. See `mbyte-keymap`.
  3347. --- Setting this option to a valid keymap name has the side effect of
  3348. --- setting 'iminsert' to one, so that the keymap becomes effective.
  3349. --- 'imsearch' is also set to one, unless it was -1
  3350. --- Only alphanumeric characters, '.', '-' and '_' can be used.
  3351. ---
  3352. --- @type string
  3353. vim.o.keymap = ""
  3354. vim.o.kmp = vim.o.keymap
  3355. vim.bo.keymap = vim.o.keymap
  3356. vim.bo.kmp = vim.bo.keymap
  3357. --- List of comma-separated words, which enable special things that keys
  3358. --- can do. These values can be used:
  3359. --- startsel Using a shifted special key starts selection (either
  3360. --- Select mode or Visual mode, depending on "key" being
  3361. --- present in 'selectmode').
  3362. --- stopsel Using a not-shifted special key stops selection.
  3363. --- Special keys in this context are the cursor keys, <End>, <Home>,
  3364. --- <PageUp> and <PageDown>.
  3365. ---
  3366. --- @type string
  3367. vim.o.keymodel = ""
  3368. vim.o.km = vim.o.keymodel
  3369. vim.go.keymodel = vim.o.keymodel
  3370. vim.go.km = vim.go.keymodel
  3371. --- Program to use for the `K` command. Environment variables are
  3372. --- expanded `:set_env`. ":help" may be used to access the Vim internal
  3373. --- help. (Note that previously setting the global option to the empty
  3374. --- value did this, which is now deprecated.)
  3375. --- When the first character is ":", the command is invoked as a Vim
  3376. --- Ex command prefixed with [count].
  3377. --- When "man" or "man -s" is used, Vim will automatically translate
  3378. --- a [count] for the "K" command to a section number.
  3379. --- See `option-backslash` about including spaces and backslashes.
  3380. --- Example:
  3381. ---
  3382. --- ```vim
  3383. --- set keywordprg=man\ -s
  3384. --- set keywordprg=:Man
  3385. --- ```
  3386. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3387. --- security reasons.
  3388. ---
  3389. --- @type string
  3390. vim.o.keywordprg = ":Man"
  3391. vim.o.kp = vim.o.keywordprg
  3392. vim.bo.keywordprg = vim.o.keywordprg
  3393. vim.bo.kp = vim.bo.keywordprg
  3394. vim.go.keywordprg = vim.o.keywordprg
  3395. vim.go.kp = vim.go.keywordprg
  3396. --- This option allows switching your keyboard into a special language
  3397. --- mode. When you are typing text in Insert mode the characters are
  3398. --- inserted directly. When in Normal mode the 'langmap' option takes
  3399. --- care of translating these special characters to the original meaning
  3400. --- of the key. This means you don't have to change the keyboard mode to
  3401. --- be able to execute Normal mode commands.
  3402. --- This is the opposite of the 'keymap' option, where characters are
  3403. --- mapped in Insert mode.
  3404. --- Also consider setting 'langremap' to off, to prevent 'langmap' from
  3405. --- applying to characters resulting from a mapping.
  3406. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3407. --- security reasons.
  3408. ---
  3409. --- Example (for Greek, in UTF-8): *greek*
  3410. ---
  3411. --- ```vim
  3412. --- 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
  3413. --- ```
  3414. --- Example (exchanges meaning of z and y for commands):
  3415. ---
  3416. --- ```vim
  3417. --- set langmap=zy,yz,ZY,YZ
  3418. --- ```
  3419. ---
  3420. --- The 'langmap' option is a list of parts, separated with commas. Each
  3421. --- part can be in one of two forms:
  3422. --- 1. A list of pairs. Each pair is a "from" character immediately
  3423. --- followed by the "to" character. Examples: "aA", "aAbBcC".
  3424. --- 2. A list of "from" characters, a semicolon and a list of "to"
  3425. --- characters. Example: "abc;ABC"
  3426. --- Example: "aA,fgh;FGH,cCdDeE"
  3427. --- Special characters need to be preceded with a backslash. These are
  3428. --- ";", ',', '"', '|' and backslash itself.
  3429. ---
  3430. --- This will allow you to activate vim actions without having to switch
  3431. --- back and forth between the languages. Your language characters will
  3432. --- be understood as normal vim English characters (according to the
  3433. --- langmap mappings) in the following cases:
  3434. --- o Normal/Visual mode (commands, buffer/register names, user mappings)
  3435. --- o Insert/Replace Mode: Register names after CTRL-R
  3436. --- o Insert/Replace Mode: Mappings
  3437. --- Characters entered in Command-line mode will NOT be affected by
  3438. --- this option. Note that this option can be changed at any time
  3439. --- allowing to switch between mappings for different languages/encodings.
  3440. --- Use a mapping to avoid having to type it each time!
  3441. ---
  3442. --- @type string
  3443. vim.o.langmap = ""
  3444. vim.o.lmap = vim.o.langmap
  3445. vim.go.langmap = vim.o.langmap
  3446. vim.go.lmap = vim.go.langmap
  3447. --- Language to use for menu translation. Tells which file is loaded
  3448. --- from the "lang" directory in 'runtimepath':
  3449. ---
  3450. --- ```vim
  3451. --- "lang/menu_" .. &langmenu .. ".vim"
  3452. --- ```
  3453. --- (without the spaces). For example, to always use the Dutch menus, no
  3454. --- matter what $LANG is set to:
  3455. ---
  3456. --- ```vim
  3457. --- set langmenu=nl_NL.ISO_8859-1
  3458. --- ```
  3459. --- When 'langmenu' is empty, `v:lang` is used.
  3460. --- Only normal file name characters can be used, `/\*?[|<>` are illegal.
  3461. --- If your $LANG is set to a non-English language but you do want to use
  3462. --- the English menus:
  3463. ---
  3464. --- ```vim
  3465. --- set langmenu=none
  3466. --- ```
  3467. --- This option must be set before loading menus, switching on filetype
  3468. --- detection or syntax highlighting. Once the menus are defined setting
  3469. --- this option has no effect. But you could do this:
  3470. ---
  3471. --- ```vim
  3472. --- source $VIMRUNTIME/delmenu.vim
  3473. --- set langmenu=de_DE.ISO_8859-1
  3474. --- source $VIMRUNTIME/menu.vim
  3475. --- ```
  3476. --- Warning: This deletes all menus that you defined yourself!
  3477. ---
  3478. --- @type string
  3479. vim.o.langmenu = ""
  3480. vim.o.lm = vim.o.langmenu
  3481. vim.go.langmenu = vim.o.langmenu
  3482. vim.go.lm = vim.go.langmenu
  3483. --- When off, setting 'langmap' does not apply to characters resulting from
  3484. --- a mapping. If setting 'langmap' disables some of your mappings, make
  3485. --- sure this option is off.
  3486. ---
  3487. --- @type boolean
  3488. vim.o.langremap = false
  3489. vim.o.lrm = vim.o.langremap
  3490. vim.go.langremap = vim.o.langremap
  3491. vim.go.lrm = vim.go.langremap
  3492. --- The value of this option influences when the last window will have a
  3493. --- status line:
  3494. --- 0: never
  3495. --- 1: only if there are at least two windows
  3496. --- 2: always
  3497. --- 3: always and ONLY the last window
  3498. --- The screen looks nicer with a status line if you have several
  3499. --- windows, but it takes another screen line. `status-line`
  3500. ---
  3501. --- @type integer
  3502. vim.o.laststatus = 2
  3503. vim.o.ls = vim.o.laststatus
  3504. vim.go.laststatus = vim.o.laststatus
  3505. vim.go.ls = vim.go.laststatus
  3506. --- When this option is set, the screen will not be redrawn while
  3507. --- executing macros, registers and other commands that have not been
  3508. --- typed. Also, updating the window title is postponed. To force an
  3509. --- update use `:redraw`.
  3510. --- This may occasionally cause display errors. It is only meant to be set
  3511. --- temporarily when performing an operation where redrawing may cause
  3512. --- flickering or cause a slowdown.
  3513. ---
  3514. --- @type boolean
  3515. vim.o.lazyredraw = false
  3516. vim.o.lz = vim.o.lazyredraw
  3517. vim.go.lazyredraw = vim.o.lazyredraw
  3518. vim.go.lz = vim.go.lazyredraw
  3519. --- If on, Vim will wrap long lines at a character in 'breakat' rather
  3520. --- than at the last character that fits on the screen. Unlike
  3521. --- 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
  3522. --- it only affects the way the file is displayed, not its contents.
  3523. --- If 'breakindent' is set, line is visually indented. Then, the value
  3524. --- of 'showbreak' is used to put in front of wrapped lines. This option
  3525. --- is not used when the 'wrap' option is off.
  3526. --- Note that <Tab> characters after an <EOL> are mostly not displayed
  3527. --- with the right amount of white space.
  3528. ---
  3529. --- @type boolean
  3530. vim.o.linebreak = false
  3531. vim.o.lbr = vim.o.linebreak
  3532. vim.wo.linebreak = vim.o.linebreak
  3533. vim.wo.lbr = vim.wo.linebreak
  3534. --- Number of lines of the Vim window.
  3535. --- Normally you don't need to set this. It is done automatically by the
  3536. --- terminal initialization code.
  3537. --- When Vim is running in the GUI or in a resizable window, setting this
  3538. --- option will cause the window size to be changed. When you only want
  3539. --- to use the size for the GUI, put the command in your `gvimrc` file.
  3540. --- Vim limits the number of lines to what fits on the screen. You can
  3541. --- use this command to get the tallest window possible:
  3542. ---
  3543. --- ```vim
  3544. --- set lines=999
  3545. --- ```
  3546. --- Minimum value is 2, maximum value is 1000.
  3547. ---
  3548. --- @type integer
  3549. vim.o.lines = 24
  3550. vim.go.lines = vim.o.lines
  3551. --- only in the GUI
  3552. --- Number of pixel lines inserted between characters. Useful if the font
  3553. --- uses the full character cell height, making lines touch each other.
  3554. --- When non-zero there is room for underlining.
  3555. --- With some fonts there can be too much room between lines (to have
  3556. --- space for ascents and descents). Then it makes sense to set
  3557. --- 'linespace' to a negative value. This may cause display problems
  3558. --- though!
  3559. ---
  3560. --- @type integer
  3561. vim.o.linespace = 0
  3562. vim.o.lsp = vim.o.linespace
  3563. vim.go.linespace = vim.o.linespace
  3564. vim.go.lsp = vim.go.linespace
  3565. --- Lisp mode: When <Enter> is typed in insert mode set the indent for
  3566. --- the next line to Lisp standards (well, sort of). Also happens with
  3567. --- "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
  3568. --- flag in 'cpoptions' changes the method of indenting: Vi compatible or
  3569. --- better. Also see 'lispwords'.
  3570. --- The '-' character is included in keyword characters. Redefines the
  3571. --- "=" operator to use this same indentation algorithm rather than
  3572. --- calling an external program if 'equalprg' is empty.
  3573. ---
  3574. --- @type boolean
  3575. vim.o.lisp = false
  3576. vim.bo.lisp = vim.o.lisp
  3577. --- Comma-separated list of items that influence the Lisp indenting when
  3578. --- enabled with the `'lisp'` option. Currently only one item is
  3579. --- supported:
  3580. --- expr:1 use 'indentexpr' for Lisp indenting when it is set
  3581. --- expr:0 do not use 'indentexpr' for Lisp indenting (default)
  3582. --- Note that when using 'indentexpr' the `=` operator indents all the
  3583. --- lines, otherwise the first line is not indented (Vi-compatible).
  3584. ---
  3585. --- @type string
  3586. vim.o.lispoptions = ""
  3587. vim.o.lop = vim.o.lispoptions
  3588. vim.bo.lispoptions = vim.o.lispoptions
  3589. vim.bo.lop = vim.bo.lispoptions
  3590. --- Comma-separated list of words that influence the Lisp indenting when
  3591. --- enabled with the `'lisp'` option.
  3592. ---
  3593. --- @type string
  3594. 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"
  3595. vim.o.lw = vim.o.lispwords
  3596. vim.bo.lispwords = vim.o.lispwords
  3597. vim.bo.lw = vim.bo.lispwords
  3598. vim.go.lispwords = vim.o.lispwords
  3599. vim.go.lw = vim.go.lispwords
  3600. --- List mode: By default, show tabs as ">", trailing spaces as "-", and
  3601. --- non-breakable space characters as "+". Useful to see the difference
  3602. --- between tabs and spaces and for trailing blanks. Further changed by
  3603. --- the 'listchars' option.
  3604. ---
  3605. --- When 'listchars' does not contain "tab" field, tabs are shown as "^I"
  3606. --- or "<09>", like how unprintable characters are displayed.
  3607. ---
  3608. --- The cursor is displayed at the start of the space a Tab character
  3609. --- occupies, not at the end as usual in Normal mode. To get this cursor
  3610. --- position while displaying Tabs with spaces, use:
  3611. ---
  3612. --- ```vim
  3613. --- set list lcs=tab:\ \
  3614. --- ```
  3615. ---
  3616. --- Note that list mode will also affect formatting (set with 'textwidth'
  3617. --- or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
  3618. --- changing the way tabs are displayed.
  3619. ---
  3620. --- @type boolean
  3621. vim.o.list = false
  3622. vim.wo.list = vim.o.list
  3623. --- Strings to use in 'list' mode and for the `:list` command. It is a
  3624. --- comma-separated list of string settings. *E1511*
  3625. ---
  3626. --- *lcs-eol*
  3627. --- eol:c Character to show at the end of each line. When
  3628. --- omitted, there is no extra character at the end of the
  3629. --- line.
  3630. --- *lcs-tab*
  3631. --- tab:xy[z] Two or three characters to be used to show a tab.
  3632. --- The third character is optional.
  3633. ---
  3634. --- tab:xy The 'x' is always used, then 'y' as many times as will
  3635. --- fit. Thus "tab:>-" displays:
  3636. --- ```
  3637. ---
  3638. --- ```
  3639. --- >-
  3640. --- >--
  3641. --- etc.
  3642. --- ```
  3643. ---
  3644. --- tab:xyz The 'z' is always used, then 'x' is prepended, and
  3645. --- then 'y' is used as many times as will fit. Thus
  3646. --- "tab:<->" displays:
  3647. --- ```
  3648. ---
  3649. --- ```
  3650. --- <>
  3651. --- <->
  3652. --- <-->
  3653. --- etc.
  3654. --- ```
  3655. ---
  3656. --- When "tab:" is omitted, a tab is shown as ^I.
  3657. --- *lcs-space*
  3658. --- space:c Character to show for a space. When omitted, spaces
  3659. --- are left blank.
  3660. --- *lcs-multispace*
  3661. --- multispace:c...
  3662. --- One or more characters to use cyclically to show for
  3663. --- multiple consecutive spaces. Overrides the "space"
  3664. --- setting, except for single spaces. When omitted, the
  3665. --- "space" setting is used. For example,
  3666. --- `:set listchars=multispace:---+` shows ten consecutive
  3667. --- spaces as:
  3668. --- ```
  3669. --- ---+---+--
  3670. --- ```
  3671. ---
  3672. --- *lcs-lead*
  3673. --- lead:c Character to show for leading spaces. When omitted,
  3674. --- leading spaces are blank. Overrides the "space" and
  3675. --- "multispace" settings for leading spaces. You can
  3676. --- combine it with "tab:", for example:
  3677. ---
  3678. --- ```vim
  3679. --- set listchars+=tab:>-,lead:.
  3680. --- ```
  3681. ---
  3682. --- *lcs-leadmultispace*
  3683. --- leadmultispace:c...
  3684. --- Like the `lcs-multispace` value, but for leading
  3685. --- spaces only. Also overrides `lcs-lead` for leading
  3686. --- multiple spaces.
  3687. --- `:set listchars=leadmultispace:---+` shows ten
  3688. --- consecutive leading spaces as:
  3689. --- ```
  3690. --- ---+---+--XXX
  3691. --- ```
  3692. ---
  3693. --- Where "XXX" denotes the first non-blank characters in
  3694. --- the line.
  3695. --- *lcs-trail*
  3696. --- trail:c Character to show for trailing spaces. When omitted,
  3697. --- trailing spaces are blank. Overrides the "space" and
  3698. --- "multispace" settings for trailing spaces.
  3699. --- *lcs-extends*
  3700. --- extends:c Character to show in the last column, when 'wrap' is
  3701. --- off and the line continues beyond the right of the
  3702. --- screen.
  3703. --- *lcs-precedes*
  3704. --- precedes:c Character to show in the first visible column of the
  3705. --- physical line, when there is text preceding the
  3706. --- character visible in the first column.
  3707. --- *lcs-conceal*
  3708. --- conceal:c Character to show in place of concealed text, when
  3709. --- 'conceallevel' is set to 1. A space when omitted.
  3710. --- *lcs-nbsp*
  3711. --- nbsp:c Character to show for a non-breakable space character
  3712. --- (0xA0 (160 decimal) and U+202F). Left blank when
  3713. --- omitted.
  3714. ---
  3715. --- The characters ':' and ',' should not be used. UTF-8 characters can
  3716. --- be used. All characters must be single width. *E1512*
  3717. ---
  3718. --- Each character can be specified as hex:
  3719. ---
  3720. --- ```vim
  3721. --- set listchars=eol:\\x24
  3722. --- set listchars=eol:\\u21b5
  3723. --- set listchars=eol:\\U000021b5
  3724. --- ```
  3725. --- Note that a double backslash is used. The number of hex characters
  3726. --- must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
  3727. ---
  3728. --- Examples:
  3729. ---
  3730. --- ```vim
  3731. --- set lcs=tab:>-,trail:-
  3732. --- set lcs=tab:>-,eol:<,nbsp:%
  3733. --- set lcs=extends:>,precedes:<
  3734. --- ```
  3735. --- `hl-NonText` highlighting will be used for "eol", "extends" and
  3736. --- "precedes". `hl-Whitespace` for "nbsp", "space", "tab", "multispace",
  3737. --- "lead" and "trail".
  3738. ---
  3739. --- @type string
  3740. vim.o.listchars = "tab:> ,trail:-,nbsp:+"
  3741. vim.o.lcs = vim.o.listchars
  3742. vim.wo.listchars = vim.o.listchars
  3743. vim.wo.lcs = vim.wo.listchars
  3744. vim.go.listchars = vim.o.listchars
  3745. vim.go.lcs = vim.go.listchars
  3746. --- When on the plugin scripts are loaded when starting up `load-plugins`.
  3747. --- This option can be reset in your `vimrc` file to disable the loading
  3748. --- of plugins.
  3749. --- Note that using the "-u NONE" and "--noplugin" command line arguments
  3750. --- reset this option. `-u` `--noplugin`
  3751. ---
  3752. --- @type boolean
  3753. vim.o.loadplugins = true
  3754. vim.o.lpl = vim.o.loadplugins
  3755. vim.go.loadplugins = vim.o.loadplugins
  3756. vim.go.lpl = vim.go.loadplugins
  3757. --- Changes the special characters that can be used in search patterns.
  3758. --- See `pattern`.
  3759. --- WARNING: Switching this option off most likely breaks plugins! That
  3760. --- is because many patterns assume it's on and will fail when it's off.
  3761. --- Only switch it off when working with old Vi scripts. In any other
  3762. --- situation write patterns that work when 'magic' is on. Include "\M"
  3763. --- when you want to `/\M`.
  3764. ---
  3765. --- @type boolean
  3766. vim.o.magic = true
  3767. vim.go.magic = vim.o.magic
  3768. --- Name of the errorfile for the `:make` command (see `:make_makeprg`)
  3769. --- and the `:grep` command.
  3770. --- When it is empty, an internally generated temp file will be used.
  3771. --- When "##" is included, it is replaced by a number to make the name
  3772. --- unique. This makes sure that the ":make" command doesn't overwrite an
  3773. --- existing file.
  3774. --- NOT used for the ":cf" command. See 'errorfile' for that.
  3775. --- Environment variables are expanded `:set_env`.
  3776. --- See `option-backslash` about including spaces and backslashes.
  3777. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3778. --- security reasons.
  3779. ---
  3780. --- @type string
  3781. vim.o.makeef = ""
  3782. vim.o.mef = vim.o.makeef
  3783. vim.go.makeef = vim.o.makeef
  3784. vim.go.mef = vim.go.makeef
  3785. --- Encoding used for reading the output of external commands. When empty,
  3786. --- encoding is not converted.
  3787. --- This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
  3788. --- `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
  3789. --- and `:laddfile`.
  3790. ---
  3791. --- This would be mostly useful when you use MS-Windows. If iconv is
  3792. --- enabled, setting 'makeencoding' to "char" has the same effect as
  3793. --- setting to the system locale encoding. Example:
  3794. ---
  3795. --- ```vim
  3796. --- set makeencoding=char " system locale is used
  3797. --- ```
  3798. ---
  3799. ---
  3800. --- @type string
  3801. vim.o.makeencoding = ""
  3802. vim.o.menc = vim.o.makeencoding
  3803. vim.bo.makeencoding = vim.o.makeencoding
  3804. vim.bo.menc = vim.bo.makeencoding
  3805. vim.go.makeencoding = vim.o.makeencoding
  3806. vim.go.menc = vim.go.makeencoding
  3807. --- Program to use for the ":make" command. See `:make_makeprg`.
  3808. --- This option may contain '%' and '#' characters (see `:_%` and `:_#`),
  3809. --- which are expanded to the current and alternate file name. Use `::S`
  3810. --- to escape file names in case they contain special characters.
  3811. --- Environment variables are expanded `:set_env`. See `option-backslash`
  3812. --- about including spaces and backslashes.
  3813. --- Note that a '|' must be escaped twice: once for ":set" and once for
  3814. --- the interpretation of a command. When you use a filter called
  3815. --- "myfilter" do it like this:
  3816. ---
  3817. --- ```vim
  3818. --- set makeprg=gmake\ \\\|\ myfilter
  3819. --- ```
  3820. --- The placeholder "$*" can be given (even multiple times) to specify
  3821. --- where the arguments will be included, for example:
  3822. ---
  3823. --- ```vim
  3824. --- set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  3825. --- ```
  3826. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3827. --- security reasons.
  3828. ---
  3829. --- @type string
  3830. vim.o.makeprg = "make"
  3831. vim.o.mp = vim.o.makeprg
  3832. vim.bo.makeprg = vim.o.makeprg
  3833. vim.bo.mp = vim.bo.makeprg
  3834. vim.go.makeprg = vim.o.makeprg
  3835. vim.go.mp = vim.go.makeprg
  3836. --- Characters that form pairs. The `%` command jumps from one to the
  3837. --- other.
  3838. --- Only character pairs are allowed that are different, thus you cannot
  3839. --- jump between two double quotes.
  3840. --- The characters must be separated by a colon.
  3841. --- The pairs must be separated by a comma. Example for including '<' and
  3842. --- '>' (for HTML):
  3843. ---
  3844. --- ```vim
  3845. --- set mps+=<:>
  3846. --- ```
  3847. --- A more exotic example, to jump between the '=' and ';' in an
  3848. --- assignment, useful for languages like C and Java:
  3849. ---
  3850. --- ```vim
  3851. --- au FileType c,cpp,java set mps+==:;
  3852. --- ```
  3853. --- For a more advanced way of using "%", see the matchit.vim plugin in
  3854. --- the $VIMRUNTIME/plugin directory. `add-local-help`
  3855. ---
  3856. --- @type string
  3857. vim.o.matchpairs = "(:),{:},[:]"
  3858. vim.o.mps = vim.o.matchpairs
  3859. vim.bo.matchpairs = vim.o.matchpairs
  3860. vim.bo.mps = vim.bo.matchpairs
  3861. --- Tenths of a second to show the matching paren, when 'showmatch' is
  3862. --- set. Note that this is not in milliseconds, like other options that
  3863. --- set a time. This is to be compatible with Nvi.
  3864. ---
  3865. --- @type integer
  3866. vim.o.matchtime = 5
  3867. vim.o.mat = vim.o.matchtime
  3868. vim.go.matchtime = vim.o.matchtime
  3869. vim.go.mat = vim.go.matchtime
  3870. --- Maximum depth of function calls for user functions. This normally
  3871. --- catches endless recursion. When using a recursive function with
  3872. --- more depth, set 'maxfuncdepth' to a bigger number. But this will use
  3873. --- more memory, there is the danger of failing when memory is exhausted.
  3874. --- Increasing this limit above 200 also changes the maximum for Ex
  3875. --- command recursion, see `E169`.
  3876. --- See also `:function`.
  3877. --- Also used for maximum depth of callback functions.
  3878. ---
  3879. --- @type integer
  3880. vim.o.maxfuncdepth = 100
  3881. vim.o.mfd = vim.o.maxfuncdepth
  3882. vim.go.maxfuncdepth = vim.o.maxfuncdepth
  3883. vim.go.mfd = vim.go.maxfuncdepth
  3884. --- Maximum number of times a mapping is done without resulting in a
  3885. --- character to be used. This normally catches endless mappings, like
  3886. --- ":map x y" with ":map y x". It still does not catch ":map g wg",
  3887. --- because the 'w' is used before the next mapping is done. See also
  3888. --- `key-mapping`.
  3889. ---
  3890. --- @type integer
  3891. vim.o.maxmapdepth = 1000
  3892. vim.o.mmd = vim.o.maxmapdepth
  3893. vim.go.maxmapdepth = vim.o.maxmapdepth
  3894. vim.go.mmd = vim.go.maxmapdepth
  3895. --- Maximum amount of memory (in Kbyte) to use for pattern matching.
  3896. --- The maximum value is about 2000000. Use this to work without a limit.
  3897. --- *E363*
  3898. --- When Vim runs into the limit it gives an error message and mostly
  3899. --- behaves like CTRL-C was typed.
  3900. --- Running into the limit often means that the pattern is very
  3901. --- inefficient or too complex. This may already happen with the pattern
  3902. --- "\(.\)*" on a very long line. ".*" works much better.
  3903. --- Might also happen on redraw, when syntax rules try to match a complex
  3904. --- text structure.
  3905. --- Vim may run out of memory before hitting the 'maxmempattern' limit, in
  3906. --- which case you get an "Out of memory" error instead.
  3907. ---
  3908. --- @type integer
  3909. vim.o.maxmempattern = 1000
  3910. vim.o.mmp = vim.o.maxmempattern
  3911. vim.go.maxmempattern = vim.o.maxmempattern
  3912. vim.go.mmp = vim.go.maxmempattern
  3913. --- Maximum number of items to use in a menu. Used for menus that are
  3914. --- generated from a list of items, e.g., the Buffers menu. Changing this
  3915. --- option has no direct effect, the menu must be refreshed first.
  3916. ---
  3917. --- @type integer
  3918. vim.o.menuitems = 25
  3919. vim.o.mis = vim.o.menuitems
  3920. vim.go.menuitems = vim.o.menuitems
  3921. vim.go.mis = vim.go.menuitems
  3922. --- Option settings for outputting messages. It can consist of the
  3923. --- following items. Items must be separated by a comma.
  3924. ---
  3925. --- hit-enter Use a `hit-enter` prompt when the message is longer than
  3926. --- 'cmdheight' size.
  3927. ---
  3928. --- wait:{n} Instead of using a `hit-enter` prompt, simply wait for
  3929. --- {n} milliseconds so that the user has a chance to read
  3930. --- the message. The maximum value of {n} is 10000. Use
  3931. --- 0 to disable the wait (but then the user may miss an
  3932. --- important message).
  3933. --- This item is ignored when "hit-enter" is present, but
  3934. --- required when "hit-enter" is not present.
  3935. ---
  3936. --- history:{n} Determines how many entries are remembered in the
  3937. --- `:messages` history. The maximum value is 10000.
  3938. --- Setting it to zero clears the message history.
  3939. --- This item must always be present.
  3940. ---
  3941. --- @type string
  3942. vim.o.messagesopt = "hit-enter,history:500"
  3943. vim.o.mopt = vim.o.messagesopt
  3944. vim.go.messagesopt = vim.o.messagesopt
  3945. vim.go.mopt = vim.go.messagesopt
  3946. --- Parameters for `:mkspell`. This tunes when to start compressing the
  3947. --- word tree. Compression can be slow when there are many words, but
  3948. --- it's needed to avoid running out of memory. The amount of memory used
  3949. --- per word depends very much on how similar the words are, that's why
  3950. --- this tuning is complicated.
  3951. ---
  3952. --- There are three numbers, separated by commas:
  3953. --- ```
  3954. --- {start},{inc},{added}
  3955. --- ```
  3956. ---
  3957. --- For most languages the uncompressed word tree fits in memory. {start}
  3958. --- gives the amount of memory in Kbyte that can be used before any
  3959. --- compression is done. It should be a bit smaller than the amount of
  3960. --- memory that is available to Vim.
  3961. ---
  3962. --- When going over the {start} limit the {inc} number specifies the
  3963. --- amount of memory in Kbyte that can be allocated before another
  3964. --- compression is done. A low number means compression is done after
  3965. --- less words are added, which is slow. A high number means more memory
  3966. --- will be allocated.
  3967. ---
  3968. --- After doing compression, {added} times 1024 words can be added before
  3969. --- the {inc} limit is ignored and compression is done when any extra
  3970. --- amount of memory is needed. A low number means there is a smaller
  3971. --- chance of hitting the {inc} limit, less memory is used but it's
  3972. --- slower.
  3973. ---
  3974. --- The languages for which these numbers are important are Italian and
  3975. --- Hungarian. The default works for when you have about 512 Mbyte. If
  3976. --- you have 1 Gbyte you could use:
  3977. ---
  3978. --- ```vim
  3979. --- set mkspellmem=900000,3000,800
  3980. --- ```
  3981. --- If you have less than 512 Mbyte `:mkspell` may fail for some
  3982. --- languages, no matter what you set 'mkspellmem' to.
  3983. ---
  3984. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  3985. --- security reasons.
  3986. ---
  3987. --- @type string
  3988. vim.o.mkspellmem = "460000,2000,500"
  3989. vim.o.msm = vim.o.mkspellmem
  3990. vim.go.mkspellmem = vim.o.mkspellmem
  3991. vim.go.msm = vim.go.mkspellmem
  3992. --- If 'modeline' is on 'modelines' gives the number of lines that is
  3993. --- checked for set commands. If 'modeline' is off or 'modelines' is zero
  3994. --- no lines are checked. See `modeline`.
  3995. ---
  3996. --- @type boolean
  3997. vim.o.modeline = true
  3998. vim.o.ml = vim.o.modeline
  3999. vim.bo.modeline = vim.o.modeline
  4000. vim.bo.ml = vim.bo.modeline
  4001. --- When on allow some options that are an expression to be set in the
  4002. --- modeline. Check the option for whether it is affected by
  4003. --- 'modelineexpr'. Also see `modeline`.
  4004. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4005. --- security reasons.
  4006. ---
  4007. --- @type boolean
  4008. vim.o.modelineexpr = false
  4009. vim.o.mle = vim.o.modelineexpr
  4010. vim.go.modelineexpr = vim.o.modelineexpr
  4011. vim.go.mle = vim.go.modelineexpr
  4012. --- If 'modeline' is on 'modelines' gives the number of lines that is
  4013. --- checked for set commands. If 'modeline' is off or 'modelines' is zero
  4014. --- no lines are checked. See `modeline`.
  4015. ---
  4016. ---
  4017. --- @type integer
  4018. vim.o.modelines = 5
  4019. vim.o.mls = vim.o.modelines
  4020. vim.go.modelines = vim.o.modelines
  4021. vim.go.mls = vim.go.modelines
  4022. --- When off the buffer contents cannot be changed. The 'fileformat' and
  4023. --- 'fileencoding' options also can't be changed.
  4024. --- Can be reset on startup with the `-M` command line argument.
  4025. ---
  4026. --- @type boolean
  4027. vim.o.modifiable = true
  4028. vim.o.ma = vim.o.modifiable
  4029. vim.bo.modifiable = vim.o.modifiable
  4030. vim.bo.ma = vim.bo.modifiable
  4031. --- When on, the buffer is considered to be modified. This option is set
  4032. --- when:
  4033. --- 1. A change was made to the text since it was last written. Using the
  4034. --- `undo` command to go back to the original text will reset the
  4035. --- option. But undoing changes that were made before writing the
  4036. --- buffer will set the option again, since the text is different from
  4037. --- when it was written.
  4038. --- 2. 'fileformat' or 'fileencoding' is different from its original
  4039. --- value. The original value is set when the buffer is read or
  4040. --- written. A ":set nomodified" command also resets the original
  4041. --- values to the current values and the 'modified' option will be
  4042. --- reset.
  4043. --- Similarly for 'eol' and 'bomb'.
  4044. --- This option is not set when a change is made to the buffer as the
  4045. --- result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
  4046. --- FileAppendPost or VimLeave autocommand event. See `gzip-example` for
  4047. --- an explanation.
  4048. --- When 'buftype' is "nowrite" or "nofile" this option may be set, but
  4049. --- will be ignored.
  4050. --- Note that the text may actually be the same, e.g. 'modified' is set
  4051. --- when using "rA" on an "A".
  4052. ---
  4053. --- @type boolean
  4054. vim.o.modified = false
  4055. vim.o.mod = vim.o.modified
  4056. vim.bo.modified = vim.o.modified
  4057. vim.bo.mod = vim.bo.modified
  4058. --- When on, listings pause when the whole screen is filled. You will get
  4059. --- the `more-prompt`. When this option is off there are no pauses, the
  4060. --- listing continues until finished.
  4061. ---
  4062. --- @type boolean
  4063. vim.o.more = true
  4064. vim.go.more = vim.o.more
  4065. --- Enables mouse support. For example, to enable the mouse in Normal mode
  4066. --- and Visual mode:
  4067. ---
  4068. --- ```vim
  4069. --- set mouse=nv
  4070. --- ```
  4071. ---
  4072. --- To temporarily disable mouse support, hold the shift key while using
  4073. --- the mouse.
  4074. ---
  4075. --- Mouse support can be enabled for different modes:
  4076. --- n Normal mode
  4077. --- v Visual mode
  4078. --- i Insert mode
  4079. --- c Command-line mode
  4080. --- h all previous modes when editing a help file
  4081. --- a all previous modes
  4082. --- r for `hit-enter` and `more-prompt` prompt
  4083. ---
  4084. --- Left-click anywhere in a text buffer to place the cursor there. This
  4085. --- works with operators too, e.g. type `d` then left-click to delete text
  4086. --- from the current cursor position to the position where you clicked.
  4087. ---
  4088. --- Drag the `status-line` or vertical separator of a window to resize it.
  4089. ---
  4090. --- If enabled for "v" (Visual mode) then double-click selects word-wise,
  4091. --- triple-click makes it line-wise, and quadruple-click makes it
  4092. --- rectangular block-wise.
  4093. ---
  4094. --- For scrolling with a mouse wheel see `scroll-mouse-wheel`.
  4095. ---
  4096. --- Note: When enabling the mouse in a terminal, copy/paste will use the
  4097. --- "* register if possible. See also 'clipboard'.
  4098. ---
  4099. --- Related options:
  4100. --- 'mousefocus' window focus follows mouse pointer
  4101. --- 'mousemodel' what mouse button does which action
  4102. --- 'mousehide' hide mouse pointer while typing text
  4103. --- 'selectmode' whether to start Select mode or Visual mode
  4104. ---
  4105. --- @type string
  4106. vim.o.mouse = "nvi"
  4107. vim.go.mouse = vim.o.mouse
  4108. --- The window that the mouse pointer is on is automatically activated.
  4109. --- When changing the window layout or window focus in another way, the
  4110. --- mouse pointer is moved to the window with keyboard focus. Off is the
  4111. --- default because it makes using the pull down menus a little goofy, as
  4112. --- a pointer transit may activate a window unintentionally.
  4113. ---
  4114. --- @type boolean
  4115. vim.o.mousefocus = false
  4116. vim.o.mousef = vim.o.mousefocus
  4117. vim.go.mousefocus = vim.o.mousefocus
  4118. vim.go.mousef = vim.go.mousefocus
  4119. --- only in the GUI
  4120. --- When on, the mouse pointer is hidden when characters are typed.
  4121. --- The mouse pointer is restored when the mouse is moved.
  4122. ---
  4123. --- @type boolean
  4124. vim.o.mousehide = true
  4125. vim.o.mh = vim.o.mousehide
  4126. vim.go.mousehide = vim.o.mousehide
  4127. vim.go.mh = vim.go.mousehide
  4128. --- Sets the model to use for the mouse. The name mostly specifies what
  4129. --- the right mouse button is used for:
  4130. --- extend Right mouse button extends a selection. This works
  4131. --- like in an xterm.
  4132. --- popup Right mouse button pops up a menu. The shifted left
  4133. --- mouse button extends a selection. This works like
  4134. --- with Microsoft Windows.
  4135. --- popup_setpos Like "popup", but the cursor will be moved to the
  4136. --- position where the mouse was clicked, and thus the
  4137. --- selected operation will act upon the clicked object.
  4138. --- If clicking inside a selection, that selection will
  4139. --- be acted upon, i.e. no cursor move. This implies of
  4140. --- course, that right clicking outside a selection will
  4141. --- end Visual mode.
  4142. --- Overview of what button does what for each model:
  4143. --- mouse extend popup(_setpos) ~
  4144. --- left click place cursor place cursor
  4145. --- left drag start selection start selection
  4146. --- shift-left search word extend selection
  4147. --- right click extend selection popup menu (place cursor)
  4148. --- right drag extend selection -
  4149. --- middle click paste paste
  4150. ---
  4151. --- In the "popup" model the right mouse button produces a pop-up menu.
  4152. --- Nvim creates a default `popup-menu` but you can redefine it.
  4153. ---
  4154. --- Note that you can further refine the meaning of buttons with mappings.
  4155. --- See `mouse-overview`. But mappings are NOT used for modeless selection.
  4156. ---
  4157. --- Example:
  4158. ---
  4159. --- ```vim
  4160. --- map <S-LeftMouse> <RightMouse>
  4161. --- map <S-LeftDrag> <RightDrag>
  4162. --- map <S-LeftRelease> <RightRelease>
  4163. --- map <2-S-LeftMouse> <2-RightMouse>
  4164. --- map <2-S-LeftDrag> <2-RightDrag>
  4165. --- map <2-S-LeftRelease> <2-RightRelease>
  4166. --- map <3-S-LeftMouse> <3-RightMouse>
  4167. --- map <3-S-LeftDrag> <3-RightDrag>
  4168. --- map <3-S-LeftRelease> <3-RightRelease>
  4169. --- map <4-S-LeftMouse> <4-RightMouse>
  4170. --- map <4-S-LeftDrag> <4-RightDrag>
  4171. --- map <4-S-LeftRelease> <4-RightRelease>
  4172. --- ```
  4173. ---
  4174. --- Mouse commands requiring the CTRL modifier can be simulated by typing
  4175. --- the "g" key before using the mouse:
  4176. --- "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click)
  4177. --- "g<RightMouse>" is "<C-RightMouse> ("CTRL-T")
  4178. ---
  4179. --- @type string
  4180. vim.o.mousemodel = "popup_setpos"
  4181. vim.o.mousem = vim.o.mousemodel
  4182. vim.go.mousemodel = vim.o.mousemodel
  4183. vim.go.mousem = vim.go.mousemodel
  4184. --- When on, mouse move events are delivered to the input queue and are
  4185. --- available for mapping. The default, off, avoids the mouse movement
  4186. --- overhead except when needed.
  4187. --- Warning: Setting this option can make pending mappings to be aborted
  4188. --- when the mouse is moved.
  4189. ---
  4190. --- @type boolean
  4191. vim.o.mousemoveevent = false
  4192. vim.o.mousemev = vim.o.mousemoveevent
  4193. vim.go.mousemoveevent = vim.o.mousemoveevent
  4194. vim.go.mousemev = vim.go.mousemoveevent
  4195. --- This option controls the number of lines / columns to scroll by when
  4196. --- scrolling with a mouse wheel (`scroll-mouse-wheel`). The option is
  4197. --- a comma-separated list. Each part consists of a direction and a count
  4198. --- as follows:
  4199. --- direction:count,direction:count
  4200. --- Direction is one of either "hor" or "ver". "hor" controls horizontal
  4201. --- scrolling and "ver" controls vertical scrolling. Count sets the amount
  4202. --- to scroll by for the given direction, it should be a non negative
  4203. --- integer. Each direction should be set at most once. If a direction
  4204. --- is omitted, a default value is used (6 for horizontal scrolling and 3
  4205. --- for vertical scrolling). You can disable mouse scrolling by using
  4206. --- a count of 0.
  4207. ---
  4208. --- Example:
  4209. ---
  4210. --- ```vim
  4211. --- set mousescroll=ver:5,hor:2
  4212. --- ```
  4213. --- Will make Nvim scroll 5 lines at a time when scrolling vertically, and
  4214. --- scroll 2 columns at a time when scrolling horizontally.
  4215. ---
  4216. --- @type string
  4217. vim.o.mousescroll = "ver:3,hor:6"
  4218. vim.go.mousescroll = vim.o.mousescroll
  4219. --- Defines the maximum time in msec between two mouse clicks for the
  4220. --- second click to be recognized as a multi click.
  4221. ---
  4222. --- @type integer
  4223. vim.o.mousetime = 500
  4224. vim.o.mouset = vim.o.mousetime
  4225. vim.go.mousetime = vim.o.mousetime
  4226. vim.go.mouset = vim.go.mousetime
  4227. --- This defines what bases Vim will consider for numbers when using the
  4228. --- CTRL-A and CTRL-X commands for adding to and subtracting from a number
  4229. --- respectively; see `CTRL-A` for more info on these commands.
  4230. --- alpha If included, single alphabetical characters will be
  4231. --- incremented or decremented. This is useful for a list with a
  4232. --- letter index a), b), etc. *octal-nrformats*
  4233. --- octal If included, numbers that start with a zero will be considered
  4234. --- to be octal. Example: Using CTRL-A on "007" results in "010".
  4235. --- hex If included, numbers starting with "0x" or "0X" will be
  4236. --- considered to be hexadecimal. Example: Using CTRL-X on
  4237. --- "0x100" results in "0x0ff".
  4238. --- bin If included, numbers starting with "0b" or "0B" will be
  4239. --- considered to be binary. Example: Using CTRL-X on
  4240. --- "0b1000" subtracts one, resulting in "0b0111".
  4241. --- unsigned If included, numbers are recognized as unsigned. Thus a
  4242. --- leading dash or negative sign won't be considered as part of
  4243. --- the number. Examples:
  4244. --- Using CTRL-X on "2020" in "9-2020" results in "9-2019"
  4245. --- (without "unsigned" it would become "9-2021").
  4246. --- Using CTRL-A on "2020" in "9-2020" results in "9-2021"
  4247. --- (without "unsigned" it would become "9-2019").
  4248. --- Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
  4249. --- (2^64 - 1) has no effect, overflow is prevented.
  4250. --- blank If included, treat numbers as signed or unsigned based on
  4251. --- preceding whitespace. If a number with a leading dash has its
  4252. --- dash immediately preceded by a non-whitespace character (i.e.,
  4253. --- not a tab or a " "), the negative sign won't be considered as
  4254. --- part of the number. For example:
  4255. --- Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
  4256. --- (without "blank" it would become "Carbon-13").
  4257. --- Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
  4258. --- (because -8 is preceded by whitespace. If "unsigned" was
  4259. --- set, it would result in "Carbon -7").
  4260. --- If this format is included, overflow is prevented as if
  4261. --- "unsigned" were set. If both this format and "unsigned" are
  4262. --- included, "unsigned" will take precedence.
  4263. ---
  4264. --- Numbers which simply begin with a digit in the range 1-9 are always
  4265. --- considered decimal. This also happens for numbers that are not
  4266. --- recognized as octal or hex.
  4267. ---
  4268. --- @type string
  4269. vim.o.nrformats = "bin,hex"
  4270. vim.o.nf = vim.o.nrformats
  4271. vim.bo.nrformats = vim.o.nrformats
  4272. vim.bo.nf = vim.bo.nrformats
  4273. --- Print the line number in front of each line. When the 'n' option is
  4274. --- excluded from 'cpoptions' a wrapped line will not use the column of
  4275. --- line numbers.
  4276. --- Use the 'numberwidth' option to adjust the room for the line number.
  4277. --- When a long, wrapped line doesn't start with the first character, '-'
  4278. --- characters are put before the number.
  4279. --- For highlighting see `hl-LineNr`, `hl-CursorLineNr`, and the
  4280. --- `:sign-define` "numhl" argument.
  4281. --- *number_relativenumber*
  4282. --- The 'relativenumber' option changes the displayed number to be
  4283. --- relative to the cursor. Together with 'number' there are these
  4284. --- four combinations (cursor in line 3):
  4285. ---
  4286. --- 'nonu' 'nu' 'nonu' 'nu'
  4287. --- 'nornu' 'nornu' 'rnu' 'rnu'
  4288. --- ```
  4289. --- |apple | 1 apple | 2 apple | 2 apple
  4290. --- |pear | 2 pear | 1 pear | 1 pear
  4291. --- |nobody | 3 nobody | 0 nobody |3 nobody
  4292. --- |there | 4 there | 1 there | 1 there
  4293. --- ```
  4294. ---
  4295. ---
  4296. --- @type boolean
  4297. vim.o.number = false
  4298. vim.o.nu = vim.o.number
  4299. vim.wo.number = vim.o.number
  4300. vim.wo.nu = vim.wo.number
  4301. --- Minimal number of columns to use for the line number. Only relevant
  4302. --- when the 'number' or 'relativenumber' option is set or printing lines
  4303. --- with a line number. Since one space is always between the number and
  4304. --- the text, there is one less character for the number itself.
  4305. --- The value is the minimum width. A bigger width is used when needed to
  4306. --- fit the highest line number in the buffer respectively the number of
  4307. --- rows in the window, depending on whether 'number' or 'relativenumber'
  4308. --- is set. Thus with the Vim default of 4 there is room for a line number
  4309. --- up to 999. When the buffer has 1000 lines five columns will be used.
  4310. --- The minimum value is 1, the maximum value is 20.
  4311. ---
  4312. --- @type integer
  4313. vim.o.numberwidth = 4
  4314. vim.o.nuw = vim.o.numberwidth
  4315. vim.wo.numberwidth = vim.o.numberwidth
  4316. vim.wo.nuw = vim.wo.numberwidth
  4317. --- This option specifies a function to be used for Insert mode omni
  4318. --- completion with CTRL-X CTRL-O. `i_CTRL-X_CTRL-O`
  4319. --- See `complete-functions` for an explanation of how the function is
  4320. --- invoked and what it should return. The value can be the name of a
  4321. --- function, a `lambda` or a `Funcref`. See `option-value-function` for
  4322. --- more information.
  4323. --- This option is usually set by a filetype plugin:
  4324. --- `:filetype-plugin-on`
  4325. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4326. --- security reasons.
  4327. ---
  4328. --- @type string
  4329. vim.o.omnifunc = ""
  4330. vim.o.ofu = vim.o.omnifunc
  4331. vim.bo.omnifunc = vim.o.omnifunc
  4332. vim.bo.ofu = vim.bo.omnifunc
  4333. --- This option specifies a function to be called by the `g@` operator.
  4334. --- See `:map-operator` for more info and an example. The value can be
  4335. --- the name of a function, a `lambda` or a `Funcref`. See
  4336. --- `option-value-function` for more information.
  4337. ---
  4338. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4339. --- security reasons.
  4340. ---
  4341. --- @type string
  4342. vim.o.operatorfunc = ""
  4343. vim.o.opfunc = vim.o.operatorfunc
  4344. vim.go.operatorfunc = vim.o.operatorfunc
  4345. vim.go.opfunc = vim.go.operatorfunc
  4346. --- Directories used to find packages.
  4347. --- See `packages` and `packages-runtimepath`.
  4348. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4349. --- security reasons.
  4350. ---
  4351. --- @type string
  4352. vim.o.packpath = "..."
  4353. vim.o.pp = vim.o.packpath
  4354. vim.go.packpath = vim.o.packpath
  4355. vim.go.pp = vim.go.packpath
  4356. --- Specifies the nroff macros that separate paragraphs. These are pairs
  4357. --- of two letters (see `object-motions`).
  4358. ---
  4359. --- @type string
  4360. vim.o.paragraphs = "IPLPPPQPP TPHPLIPpLpItpplpipbp"
  4361. vim.o.para = vim.o.paragraphs
  4362. vim.go.paragraphs = vim.o.paragraphs
  4363. vim.go.para = vim.go.paragraphs
  4364. --- Expression which is evaluated to apply a patch to a file and generate
  4365. --- the resulting new version of the file. See `diff-patchexpr`.
  4366. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4367. --- security reasons.
  4368. ---
  4369. --- @type string
  4370. vim.o.patchexpr = ""
  4371. vim.o.pex = vim.o.patchexpr
  4372. vim.go.patchexpr = vim.o.patchexpr
  4373. vim.go.pex = vim.go.patchexpr
  4374. --- When non-empty the oldest version of a file is kept. This can be used
  4375. --- to keep the original version of a file if you are changing files in a
  4376. --- source distribution. Only the first time that a file is written a
  4377. --- copy of the original file will be kept. The name of the copy is the
  4378. --- name of the original file with the string in the 'patchmode' option
  4379. --- appended. This option should start with a dot. Use a string like
  4380. --- ".orig" or ".org". 'backupdir' must not be empty for this to work
  4381. --- (Detail: The backup file is renamed to the patchmode file after the
  4382. --- new file has been successfully written, that's why it must be possible
  4383. --- to write a backup file). If there was no file to be backed up, an
  4384. --- empty file is created.
  4385. --- When the 'backupskip' pattern matches, a patchmode file is not made.
  4386. --- Using 'patchmode' for compressed files appends the extension at the
  4387. --- end (e.g., "file.gz.orig"), thus the resulting name isn't always
  4388. --- recognized as a compressed file.
  4389. --- Only normal file name characters can be used, `/\*?[|<>` are illegal.
  4390. ---
  4391. --- @type string
  4392. vim.o.patchmode = ""
  4393. vim.o.pm = vim.o.patchmode
  4394. vim.go.patchmode = vim.o.patchmode
  4395. vim.go.pm = vim.go.patchmode
  4396. --- This is a list of directories which will be searched when using the
  4397. --- `gf`, [f, ]f, ^Wf, `:find`, `:sfind`, `:tabfind` and other commands,
  4398. --- provided that the file being searched for has a relative path (not
  4399. --- starting with "/", "./" or "../"). The directories in the 'path'
  4400. --- option may be relative or absolute.
  4401. --- - Use commas to separate directory names:
  4402. ---
  4403. --- ```vim
  4404. --- set path=.,/usr/local/include,/usr/include
  4405. --- ```
  4406. --- - Spaces can also be used to separate directory names. To have a
  4407. --- space in a directory name, precede it with an extra backslash, and
  4408. --- escape the space:
  4409. ---
  4410. --- ```vim
  4411. --- set path=.,/dir/with\\\ space
  4412. --- ```
  4413. --- - To include a comma in a directory name precede it with an extra
  4414. --- backslash:
  4415. ---
  4416. --- ```vim
  4417. --- set path=.,/dir/with\\,comma
  4418. --- ```
  4419. --- - To search relative to the directory of the current file, use:
  4420. ---
  4421. --- ```vim
  4422. --- set path=.
  4423. --- ```
  4424. --- - To search in the current directory use an empty string between two
  4425. --- commas:
  4426. ---
  4427. --- ```vim
  4428. --- set path=,,
  4429. --- ```
  4430. --- - A directory name may end in a ':' or '/'.
  4431. --- - Environment variables are expanded `:set_env`.
  4432. --- - When using `netrw.vim` URLs can be used. For example, adding
  4433. --- "https://www.vim.org" will make ":find index.html" work.
  4434. --- - Search upwards and downwards in a directory tree using "*", "**" and
  4435. --- ";". See `file-searching` for info and syntax.
  4436. --- - Careful with '\' characters, type two to get one in the option:
  4437. ---
  4438. --- ```vim
  4439. --- set path=.,c:\\include
  4440. --- ```
  4441. --- Or just use '/' instead:
  4442. ---
  4443. --- ```vim
  4444. --- set path=.,c:/include
  4445. --- ```
  4446. --- Don't forget "." or files won't even be found in the same directory as
  4447. --- the file!
  4448. --- The maximum length is limited. How much depends on the system, mostly
  4449. --- it is something like 256 or 1024 characters.
  4450. --- You can check if all the include files are found, using the value of
  4451. --- 'path', see `:checkpath`.
  4452. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  4453. --- directories from the list. This avoids problems when a future version
  4454. --- uses another default. To remove the current directory use:
  4455. ---
  4456. --- ```vim
  4457. --- set path-=
  4458. --- ```
  4459. --- To add the current directory use:
  4460. ---
  4461. --- ```vim
  4462. --- set path+=
  4463. --- ```
  4464. --- To use an environment variable, you probably need to replace the
  4465. --- separator. Here is an example to append $INCL, in which directory
  4466. --- names are separated with a semicolon:
  4467. ---
  4468. --- ```vim
  4469. --- let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
  4470. --- ```
  4471. --- Replace the ';' with a ':' or whatever separator is used. Note that
  4472. --- this doesn't work when $INCL contains a comma or white space.
  4473. ---
  4474. --- @type string
  4475. vim.o.path = ".,,"
  4476. vim.o.pa = vim.o.path
  4477. vim.bo.path = vim.o.path
  4478. vim.bo.pa = vim.bo.path
  4479. vim.go.path = vim.o.path
  4480. vim.go.pa = vim.go.path
  4481. --- When changing the indent of the current line, preserve as much of the
  4482. --- indent structure as possible. Normally the indent is replaced by a
  4483. --- series of tabs followed by spaces as required (unless `'expandtab'` is
  4484. --- enabled, in which case only spaces are used). Enabling this option
  4485. --- means the indent will preserve as many existing characters as possible
  4486. --- for indenting, and only add additional tabs or spaces as required.
  4487. --- 'expandtab' does not apply to the preserved white space, a Tab remains
  4488. --- a Tab.
  4489. --- NOTE: When using ">>" multiple times the resulting indent is a mix of
  4490. --- tabs and spaces. You might not like this.
  4491. --- Also see 'copyindent'.
  4492. --- Use `:retab` to clean up white space.
  4493. ---
  4494. --- @type boolean
  4495. vim.o.preserveindent = false
  4496. vim.o.pi = vim.o.preserveindent
  4497. vim.bo.preserveindent = vim.o.preserveindent
  4498. vim.bo.pi = vim.bo.preserveindent
  4499. --- Default height for a preview window. Used for `:ptag` and associated
  4500. --- commands. Used for `CTRL-W_}` when no count is given.
  4501. ---
  4502. --- @type integer
  4503. vim.o.previewheight = 12
  4504. vim.o.pvh = vim.o.previewheight
  4505. vim.go.previewheight = vim.o.previewheight
  4506. vim.go.pvh = vim.go.previewheight
  4507. --- Identifies the preview window. Only one window can have this option
  4508. --- set. It's normally not set directly, but by using one of the commands
  4509. --- `:ptag`, `:pedit`, etc.
  4510. ---
  4511. --- @type boolean
  4512. vim.o.previewwindow = false
  4513. vim.o.pvw = vim.o.previewwindow
  4514. vim.wo.previewwindow = vim.o.previewwindow
  4515. vim.wo.pvw = vim.wo.previewwindow
  4516. --- Enables pseudo-transparency for the `popup-menu`. Valid values are in
  4517. --- the range of 0 for fully opaque popupmenu (disabled) to 100 for fully
  4518. --- transparent background. Values between 0-30 are typically most useful.
  4519. ---
  4520. --- It is possible to override the level for individual highlights within
  4521. --- the popupmenu using `highlight-blend`. For instance, to enable
  4522. --- transparency but force the current selected element to be fully opaque:
  4523. ---
  4524. --- ```vim
  4525. ---
  4526. --- set pumblend=15
  4527. --- hi PmenuSel blend=0
  4528. --- ```
  4529. ---
  4530. --- UI-dependent. Works best with RGB colors. 'termguicolors'
  4531. ---
  4532. --- @type integer
  4533. vim.o.pumblend = 0
  4534. vim.o.pb = vim.o.pumblend
  4535. vim.go.pumblend = vim.o.pumblend
  4536. vim.go.pb = vim.go.pumblend
  4537. --- Maximum number of items to show in the popup menu
  4538. --- (`ins-completion-menu`). Zero means "use available screen space".
  4539. ---
  4540. --- @type integer
  4541. vim.o.pumheight = 0
  4542. vim.o.ph = vim.o.pumheight
  4543. vim.go.pumheight = vim.o.pumheight
  4544. vim.go.ph = vim.go.pumheight
  4545. --- Minimum width for the popup menu (`ins-completion-menu`). If the
  4546. --- cursor column + 'pumwidth' exceeds screen width, the popup menu is
  4547. --- nudged to fit on the screen.
  4548. ---
  4549. --- @type integer
  4550. vim.o.pumwidth = 15
  4551. vim.o.pw = vim.o.pumwidth
  4552. vim.go.pumwidth = vim.o.pumwidth
  4553. vim.go.pw = vim.go.pumwidth
  4554. --- Specifies the python version used for pyx* functions and commands
  4555. --- `python_x`. As only Python 3 is supported, this always has the value
  4556. --- `3`. Setting any other value is an error.
  4557. ---
  4558. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4559. --- security reasons.
  4560. ---
  4561. --- @type integer
  4562. vim.o.pyxversion = 3
  4563. vim.o.pyx = vim.o.pyxversion
  4564. vim.go.pyxversion = vim.o.pyxversion
  4565. vim.go.pyx = vim.go.pyxversion
  4566. --- This option specifies a function to be used to get the text to display
  4567. --- in the quickfix and location list windows. This can be used to
  4568. --- customize the information displayed in the quickfix or location window
  4569. --- for each entry in the corresponding quickfix or location list. See
  4570. --- `quickfix-window-function` for an explanation of how to write the
  4571. --- function and an example. The value can be the name of a function, a
  4572. --- `lambda` or a `Funcref`. See `option-value-function` for more
  4573. --- information.
  4574. ---
  4575. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  4576. --- security reasons.
  4577. ---
  4578. --- @type string
  4579. vim.o.quickfixtextfunc = ""
  4580. vim.o.qftf = vim.o.quickfixtextfunc
  4581. vim.go.quickfixtextfunc = vim.o.quickfixtextfunc
  4582. vim.go.qftf = vim.go.quickfixtextfunc
  4583. --- The characters that are used to escape quotes in a string. Used for
  4584. --- objects like a', a" and a` `a'`.
  4585. --- When one of the characters in this option is found inside a string,
  4586. --- the following character will be skipped. The default value makes the
  4587. --- text "foo\"bar\\" considered to be one string.
  4588. ---
  4589. --- @type string
  4590. vim.o.quoteescape = "\\"
  4591. vim.o.qe = vim.o.quoteescape
  4592. vim.bo.quoteescape = vim.o.quoteescape
  4593. vim.bo.qe = vim.bo.quoteescape
  4594. --- If on, writes fail unless you use a '!'. Protects you from
  4595. --- accidentally overwriting a file. Default on when Vim is started
  4596. --- in read-only mode ("vim -R") or when the executable is called "view".
  4597. --- When using ":w!" the 'readonly' option is reset for the current
  4598. --- buffer, unless the 'Z' flag is in 'cpoptions'.
  4599. --- When using the ":view" command the 'readonly' option is set for the
  4600. --- newly edited buffer.
  4601. --- See 'modifiable' for disallowing changes to the buffer.
  4602. ---
  4603. --- @type boolean
  4604. vim.o.readonly = false
  4605. vim.o.ro = vim.o.readonly
  4606. vim.bo.readonly = vim.o.readonly
  4607. vim.bo.ro = vim.bo.readonly
  4608. --- Flags to change the way redrawing works, for debugging purposes.
  4609. --- Most useful with 'writedelay' set to some reasonable value.
  4610. --- Supports the following flags:
  4611. --- compositor Indicate each redraw event handled by the compositor
  4612. --- by briefly flashing the redrawn regions in colors
  4613. --- indicating the redraw type. These are the highlight
  4614. --- groups used (and their default colors):
  4615. --- RedrawDebugNormal gui=reverse normal redraw passed through
  4616. --- RedrawDebugClear guibg=Yellow clear event passed through
  4617. --- RedrawDebugComposed guibg=Green redraw event modified by the
  4618. --- compositor (due to
  4619. --- overlapping grids, etc)
  4620. --- RedrawDebugRecompose guibg=Red redraw generated by the
  4621. --- compositor itself, due to a
  4622. --- grid being moved or deleted.
  4623. --- line introduce a delay after each line drawn on the screen.
  4624. --- When using the TUI or another single-grid UI, "compositor"
  4625. --- gives more information and should be preferred (every
  4626. --- line is processed as a separate event by the compositor)
  4627. --- flush introduce a delay after each "flush" event.
  4628. --- nothrottle Turn off throttling of the message grid. This is an
  4629. --- optimization that joins many small scrolls to one
  4630. --- larger scroll when drawing the message area (with
  4631. --- 'display' msgsep flag active).
  4632. --- invalid Enable stricter checking (abort) of inconsistencies
  4633. --- of the internal screen state. This is mostly
  4634. --- useful when running nvim inside a debugger (and
  4635. --- the test suite).
  4636. --- nodelta Send all internally redrawn cells to the UI, even if
  4637. --- they are unchanged from the already displayed state.
  4638. ---
  4639. --- @type string
  4640. vim.o.redrawdebug = ""
  4641. vim.o.rdb = vim.o.redrawdebug
  4642. vim.go.redrawdebug = vim.o.redrawdebug
  4643. vim.go.rdb = vim.go.redrawdebug
  4644. --- Time in milliseconds for redrawing the display. Applies to
  4645. --- 'hlsearch', 'inccommand', `:match` highlighting and syntax
  4646. --- highlighting.
  4647. --- When redrawing takes more than this many milliseconds no further
  4648. --- matches will be highlighted.
  4649. --- For syntax highlighting the time applies per window. When over the
  4650. --- limit syntax highlighting is disabled until `CTRL-L` is used.
  4651. --- This is used to avoid that Vim hangs when using a very complicated
  4652. --- pattern.
  4653. ---
  4654. --- @type integer
  4655. vim.o.redrawtime = 2000
  4656. vim.o.rdt = vim.o.redrawtime
  4657. vim.go.redrawtime = vim.o.redrawtime
  4658. vim.go.rdt = vim.go.redrawtime
  4659. --- This selects the default regexp engine. `two-engines`
  4660. --- The possible values are:
  4661. --- 0 automatic selection
  4662. --- 1 old engine
  4663. --- 2 NFA engine
  4664. --- Note that when using the NFA engine and the pattern contains something
  4665. --- that is not supported the pattern will not match. This is only useful
  4666. --- for debugging the regexp engine.
  4667. --- Using automatic selection enables Vim to switch the engine, if the
  4668. --- default engine becomes too costly. E.g., when the NFA engine uses too
  4669. --- many states. This should prevent Vim from hanging on a combination of
  4670. --- a complex pattern with long text.
  4671. ---
  4672. --- @type integer
  4673. vim.o.regexpengine = 0
  4674. vim.o.re = vim.o.regexpengine
  4675. vim.go.regexpengine = vim.o.regexpengine
  4676. vim.go.re = vim.go.regexpengine
  4677. --- Show the line number relative to the line with the cursor in front of
  4678. --- each line. Relative line numbers help you use the `count` you can
  4679. --- precede some vertical motion commands (e.g. j k + -) with, without
  4680. --- having to calculate it yourself. Especially useful in combination with
  4681. --- other commands (e.g. y d c < > gq gw =).
  4682. --- When the 'n' option is excluded from 'cpoptions' a wrapped
  4683. --- line will not use the column of line numbers.
  4684. --- The 'numberwidth' option can be used to set the room used for the line
  4685. --- number.
  4686. --- When a long, wrapped line doesn't start with the first character, '-'
  4687. --- characters are put before the number.
  4688. --- See `hl-LineNr` and `hl-CursorLineNr` for the highlighting used for
  4689. --- the number.
  4690. ---
  4691. --- The number in front of the cursor line also depends on the value of
  4692. --- 'number', see `number_relativenumber` for all combinations of the two
  4693. --- options.
  4694. ---
  4695. --- @type boolean
  4696. vim.o.relativenumber = false
  4697. vim.o.rnu = vim.o.relativenumber
  4698. vim.wo.relativenumber = vim.o.relativenumber
  4699. vim.wo.rnu = vim.wo.relativenumber
  4700. --- Threshold for reporting number of lines changed. When the number of
  4701. --- changed lines is more than 'report' a message will be given for most
  4702. --- ":" commands. If you want it always, set 'report' to 0.
  4703. --- For the ":substitute" command the number of substitutions is used
  4704. --- instead of the number of lines.
  4705. ---
  4706. --- @type integer
  4707. vim.o.report = 2
  4708. vim.go.report = vim.o.report
  4709. --- Inserting characters in Insert mode will work backwards. See "typing
  4710. --- backwards" `ins-reverse`. This option can be toggled with the CTRL-_
  4711. --- command in Insert mode, when 'allowrevins' is set.
  4712. ---
  4713. --- @type boolean
  4714. vim.o.revins = false
  4715. vim.o.ri = vim.o.revins
  4716. vim.go.revins = vim.o.revins
  4717. vim.go.ri = vim.go.revins
  4718. --- When on, display orientation becomes right-to-left, i.e., characters
  4719. --- that are stored in the file appear from the right to the left.
  4720. --- Using this option, it is possible to edit files for languages that
  4721. --- are written from the right to the left such as Hebrew and Arabic.
  4722. --- This option is per window, so it is possible to edit mixed files
  4723. --- simultaneously, or to view the same file in both ways (this is
  4724. --- useful whenever you have a mixed text file with both right-to-left
  4725. --- and left-to-right strings so that both sets are displayed properly
  4726. --- in different windows). Also see `rileft.txt`.
  4727. ---
  4728. --- @type boolean
  4729. vim.o.rightleft = false
  4730. vim.o.rl = vim.o.rightleft
  4731. vim.wo.rightleft = vim.o.rightleft
  4732. vim.wo.rl = vim.wo.rightleft
  4733. --- Each word in this option enables the command line editing to work in
  4734. --- right-to-left mode for a group of commands:
  4735. ---
  4736. --- search "/" and "?" commands
  4737. ---
  4738. --- This is useful for languages such as Hebrew, Arabic and Farsi.
  4739. --- The 'rightleft' option must be set for 'rightleftcmd' to take effect.
  4740. ---
  4741. --- @type string
  4742. vim.o.rightleftcmd = "search"
  4743. vim.o.rlc = vim.o.rightleftcmd
  4744. vim.wo.rightleftcmd = vim.o.rightleftcmd
  4745. vim.wo.rlc = vim.wo.rightleftcmd
  4746. --- Show the line and column number of the cursor position, separated by a
  4747. --- comma. When there is room, the relative position of the displayed
  4748. --- text in the file is shown on the far right:
  4749. --- Top first line is visible
  4750. --- Bot last line is visible
  4751. --- All first and last line are visible
  4752. --- 45% relative position in the file
  4753. --- If 'rulerformat' is set, it will determine the contents of the ruler.
  4754. --- Each window has its own ruler. If a window has a status line, the
  4755. --- ruler is shown there. If a window doesn't have a status line and
  4756. --- 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
  4757. --- the last line of the screen. If the statusline is given by
  4758. --- 'statusline' (i.e. not empty), this option takes precedence over
  4759. --- 'ruler' and 'rulerformat'.
  4760. --- If the number of characters displayed is different from the number of
  4761. --- bytes in the text (e.g., for a TAB or a multibyte character), both
  4762. --- the text column (byte number) and the screen column are shown,
  4763. --- separated with a dash.
  4764. --- For an empty line "0-1" is shown.
  4765. --- For an empty buffer the line number will also be zero: "0,0-1".
  4766. --- If you don't want to see the ruler all the time but want to know where
  4767. --- you are, use "g CTRL-G" `g_CTRL-G`.
  4768. ---
  4769. --- @type boolean
  4770. vim.o.ruler = true
  4771. vim.o.ru = vim.o.ruler
  4772. vim.go.ruler = vim.o.ruler
  4773. vim.go.ru = vim.go.ruler
  4774. --- When this option is not empty, it determines the content of the ruler
  4775. --- string, as displayed for the 'ruler' option.
  4776. --- The format of this option is like that of 'statusline'.
  4777. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  4778. ---
  4779. --- The default ruler width is 17 characters. To make the ruler 15
  4780. --- characters wide, put "%15(" at the start and "%)" at the end.
  4781. --- Example:
  4782. ---
  4783. --- ```vim
  4784. --- set rulerformat=%15(%c%V\ %p%%%)
  4785. --- ```
  4786. ---
  4787. ---
  4788. --- @type string
  4789. vim.o.rulerformat = ""
  4790. vim.o.ruf = vim.o.rulerformat
  4791. vim.go.rulerformat = vim.o.rulerformat
  4792. vim.go.ruf = vim.go.rulerformat
  4793. --- List of directories to be searched for these runtime files:
  4794. --- filetype.lua filetypes `new-filetype`
  4795. --- autoload/ automatically loaded scripts `autoload-functions`
  4796. --- colors/ color scheme files `:colorscheme`
  4797. --- compiler/ compiler files `:compiler`
  4798. --- doc/ documentation `write-local-help`
  4799. --- ftplugin/ filetype plugins `write-filetype-plugin`
  4800. --- indent/ indent scripts `indent-expression`
  4801. --- keymap/ key mapping files `mbyte-keymap`
  4802. --- lang/ menu translations `:menutrans`
  4803. --- lsp/ LSP client configurations `lsp-config`
  4804. --- lua/ `Lua` plugins
  4805. --- menu.vim GUI menus `menu.vim`
  4806. --- pack/ packages `:packadd`
  4807. --- parser/ `treesitter` syntax parsers
  4808. --- plugin/ plugin scripts `write-plugin`
  4809. --- queries/ `treesitter` queries
  4810. --- rplugin/ `remote-plugin` scripts
  4811. --- spell/ spell checking files `spell`
  4812. --- syntax/ syntax files `mysyntaxfile`
  4813. --- tutor/ tutorial files `:Tutor`
  4814. ---
  4815. --- And any other file searched for with the `:runtime` command.
  4816. ---
  4817. --- Defaults are setup to search these locations:
  4818. --- 1. Your home directory, for personal preferences.
  4819. --- Given by `stdpath("config")`. `$XDG_CONFIG_HOME`
  4820. --- 2. Directories which must contain configuration files according to
  4821. --- `xdg` ($XDG_CONFIG_DIRS, defaults to /etc/xdg). This also contains
  4822. --- preferences from system administrator.
  4823. --- 3. Data home directory, for plugins installed by user.
  4824. --- Given by `stdpath("data")/site`. `$XDG_DATA_HOME`
  4825. --- 4. nvim/site subdirectories for each directory in $XDG_DATA_DIRS.
  4826. --- This is for plugins which were installed by system administrator,
  4827. --- but are not part of the Nvim distribution. XDG_DATA_DIRS defaults
  4828. --- to /usr/local/share/:/usr/share/, so system administrators are
  4829. --- expected to install site plugins to /usr/share/nvim/site.
  4830. --- 5. Session state directory, for state data such as swap, backupdir,
  4831. --- viewdir, undodir, etc.
  4832. --- Given by `stdpath("state")`. `$XDG_STATE_HOME`
  4833. --- 6. $VIMRUNTIME, for files distributed with Nvim.
  4834. --- *after-directory*
  4835. --- 7, 8, 9, 10. In after/ subdirectories of 1, 2, 3 and 4, with reverse
  4836. --- ordering. This is for preferences to overrule or add to the
  4837. --- distributed defaults or system-wide settings (rarely needed).
  4838. ---
  4839. --- *packages-runtimepath*
  4840. --- "start" packages will also be searched (`runtime-search-path`) for
  4841. --- runtime files after these, though such packages are not explicitly
  4842. --- reported in &runtimepath. But "opt" packages are explicitly added to
  4843. --- &runtimepath by `:packadd`.
  4844. ---
  4845. --- Note that, unlike 'path', no wildcards like "**" are allowed. Normal
  4846. --- wildcards are allowed, but can significantly slow down searching for
  4847. --- runtime files. For speed, use as few items as possible and avoid
  4848. --- wildcards.
  4849. --- See `:runtime`.
  4850. --- Example:
  4851. ---
  4852. --- ```vim
  4853. --- set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
  4854. --- ```
  4855. --- This will use the directory "~/vimruntime" first (containing your
  4856. --- personal Nvim runtime files), then "/mygroup/vim", and finally
  4857. --- "$VIMRUNTIME" (the default runtime files).
  4858. --- You can put a directory before $VIMRUNTIME to find files which replace
  4859. --- distributed runtime files. You can put a directory after $VIMRUNTIME
  4860. --- to find files which add to distributed runtime files.
  4861. ---
  4862. --- With `--clean` the home directory entries are not included.
  4863. ---
  4864. --- @type string
  4865. vim.o.runtimepath = "..."
  4866. vim.o.rtp = vim.o.runtimepath
  4867. vim.go.runtimepath = vim.o.runtimepath
  4868. vim.go.rtp = vim.go.runtimepath
  4869. --- Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
  4870. --- set to half the number of lines in the window when the window size
  4871. --- changes. This may happen when enabling the `status-line` or
  4872. --- 'tabline' option after setting the 'scroll' option.
  4873. --- If you give a count to the CTRL-U or CTRL-D command it will
  4874. --- be used as the new value for 'scroll'. Reset to half the window
  4875. --- height with ":set scroll=0".
  4876. ---
  4877. --- @type integer
  4878. vim.o.scroll = 0
  4879. vim.o.scr = vim.o.scroll
  4880. vim.wo.scroll = vim.o.scroll
  4881. vim.wo.scr = vim.wo.scroll
  4882. --- Maximum number of lines kept beyond the visible screen. Lines at the
  4883. --- top are deleted if new lines exceed this limit.
  4884. --- Minimum is 1, maximum is 100000.
  4885. --- Only in `terminal` buffers.
  4886. ---
  4887. --- Note: Lines that are not visible and kept in scrollback are not
  4888. --- reflown when the terminal buffer is resized horizontally.
  4889. ---
  4890. --- @type integer
  4891. vim.o.scrollback = -1
  4892. vim.o.scbk = vim.o.scrollback
  4893. vim.bo.scrollback = vim.o.scrollback
  4894. vim.bo.scbk = vim.bo.scrollback
  4895. --- See also `scroll-binding`. When this option is set, scrolling the
  4896. --- current window also scrolls other scrollbind windows (windows that
  4897. --- also have this option set). This option is useful for viewing the
  4898. --- differences between two versions of a file, see 'diff'.
  4899. --- See `'scrollopt'` for options that determine how this option should be
  4900. --- interpreted.
  4901. --- This option is mostly reset when splitting a window to edit another
  4902. --- file. This means that ":split | edit file" results in two windows
  4903. --- with scroll-binding, but ":split file" does not.
  4904. ---
  4905. --- @type boolean
  4906. vim.o.scrollbind = false
  4907. vim.o.scb = vim.o.scrollbind
  4908. vim.wo.scrollbind = vim.o.scrollbind
  4909. vim.wo.scb = vim.wo.scrollbind
  4910. --- Minimal number of lines to scroll when the cursor gets off the
  4911. --- screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
  4912. --- CTRL-D). Useful if your terminal scrolls very slowly.
  4913. --- When set to a negative number from -1 to -100 this is used as the
  4914. --- percentage of the window height. Thus -50 scrolls half the window
  4915. --- height.
  4916. ---
  4917. --- @type integer
  4918. vim.o.scrolljump = 1
  4919. vim.o.sj = vim.o.scrolljump
  4920. vim.go.scrolljump = vim.o.scrolljump
  4921. vim.go.sj = vim.go.scrolljump
  4922. --- Minimal number of screen lines to keep above and below the cursor.
  4923. --- This will make some context visible around where you are working. If
  4924. --- you set it to a very large value (999) the cursor line will always be
  4925. --- in the middle of the window (except at the start or end of the file or
  4926. --- when long lines wrap).
  4927. --- After using the local value, go back the global value with one of
  4928. --- these two:
  4929. ---
  4930. --- ```vim
  4931. --- setlocal scrolloff<
  4932. --- setlocal scrolloff=-1
  4933. --- ```
  4934. --- For scrolling horizontally see 'sidescrolloff'.
  4935. ---
  4936. --- @type integer
  4937. vim.o.scrolloff = 0
  4938. vim.o.so = vim.o.scrolloff
  4939. vim.wo.scrolloff = vim.o.scrolloff
  4940. vim.wo.so = vim.wo.scrolloff
  4941. vim.go.scrolloff = vim.o.scrolloff
  4942. vim.go.so = vim.go.scrolloff
  4943. --- This is a comma-separated list of words that specifies how
  4944. --- 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
  4945. --- Options.
  4946. --- The following words are available:
  4947. --- ver Bind vertical scrolling for 'scrollbind' windows
  4948. --- hor Bind horizontal scrolling for 'scrollbind' windows
  4949. --- jump Applies to the offset between two windows for vertical
  4950. --- scrolling. This offset is the difference in the first
  4951. --- displayed line of the bound windows. When moving
  4952. --- around in a window, another 'scrollbind' window may
  4953. --- reach a position before the start or after the end of
  4954. --- the buffer. The offset is not changed though, when
  4955. --- moving back the 'scrollbind' window will try to scroll
  4956. --- to the desired position when possible.
  4957. --- When now making that window the current one, two
  4958. --- things can be done with the relative offset:
  4959. --- 1. When "jump" is not included, the relative offset is
  4960. --- adjusted for the scroll position in the new current
  4961. --- window. When going back to the other window, the
  4962. --- new relative offset will be used.
  4963. --- 2. When "jump" is included, the other windows are
  4964. --- scrolled to keep the same relative offset. When
  4965. --- going back to the other window, it still uses the
  4966. --- same relative offset.
  4967. --- Also see `scroll-binding`.
  4968. --- When 'diff' mode is active there always is vertical scroll binding,
  4969. --- even when "ver" isn't there.
  4970. ---
  4971. --- @type string
  4972. vim.o.scrollopt = "ver,jump"
  4973. vim.o.sbo = vim.o.scrollopt
  4974. vim.go.scrollopt = vim.o.scrollopt
  4975. vim.go.sbo = vim.go.scrollopt
  4976. --- Specifies the nroff macros that separate sections. These are pairs of
  4977. --- two letters (See `object-motions`). The default makes a section start
  4978. --- at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
  4979. ---
  4980. --- @type string
  4981. vim.o.sections = "SHNHH HUnhsh"
  4982. vim.o.sect = vim.o.sections
  4983. vim.go.sections = vim.o.sections
  4984. vim.go.sect = vim.go.sections
  4985. --- This option defines the behavior of the selection. It is only used
  4986. --- in Visual and Select mode.
  4987. --- Possible values:
  4988. --- value past line inclusive ~
  4989. --- old no yes
  4990. --- inclusive yes yes
  4991. --- exclusive yes no
  4992. --- "past line" means that the cursor is allowed to be positioned one
  4993. --- character past the line.
  4994. --- "inclusive" means that the last character of the selection is included
  4995. --- in an operation. For example, when "x" is used to delete the
  4996. --- selection.
  4997. --- When "old" is used and 'virtualedit' allows the cursor to move past
  4998. --- the end of line the line break still isn't included.
  4999. --- When "exclusive" is used, cursor position in visual mode will be
  5000. --- adjusted for inclusive motions `inclusive-motion-selection-exclusive`.
  5001. --- Note that when "exclusive" is used and selecting from the end
  5002. --- backwards, you cannot include the last character of a line, when
  5003. --- starting in Normal mode and 'virtualedit' empty.
  5004. ---
  5005. --- @type string
  5006. vim.o.selection = "inclusive"
  5007. vim.o.sel = vim.o.selection
  5008. vim.go.selection = vim.o.selection
  5009. vim.go.sel = vim.go.selection
  5010. --- This is a comma-separated list of words, which specifies when to start
  5011. --- Select mode instead of Visual mode, when a selection is started.
  5012. --- Possible values:
  5013. --- mouse when using the mouse
  5014. --- key when using shifted special keys
  5015. --- cmd when using "v", "V" or CTRL-V
  5016. --- See `Select-mode`.
  5017. ---
  5018. --- @type string
  5019. vim.o.selectmode = ""
  5020. vim.o.slm = vim.o.selectmode
  5021. vim.go.selectmode = vim.o.selectmode
  5022. vim.go.slm = vim.go.selectmode
  5023. --- Changes the effect of the `:mksession` command. It is a comma-
  5024. --- separated list of words. Each word enables saving and restoring
  5025. --- something:
  5026. --- word save and restore ~
  5027. --- blank empty windows
  5028. --- buffers hidden and unloaded buffers, not just those in windows
  5029. --- curdir the current directory
  5030. --- folds manually created folds, opened/closed folds and local
  5031. --- fold options
  5032. --- globals global variables that start with an uppercase letter
  5033. --- and contain at least one lowercase letter. Only
  5034. --- String and Number types are stored.
  5035. --- help the help window
  5036. --- localoptions options and mappings local to a window or buffer (not
  5037. --- global values for local options)
  5038. --- options all options and mappings (also global values for local
  5039. --- options)
  5040. --- skiprtp exclude 'runtimepath' and 'packpath' from the options
  5041. --- resize size of the Vim window: 'lines' and 'columns'
  5042. --- sesdir the directory in which the session file is located
  5043. --- will become the current directory (useful with
  5044. --- projects accessed over a network from different
  5045. --- systems)
  5046. --- tabpages all tab pages; without this only the current tab page
  5047. --- is restored, so that you can make a session for each
  5048. --- tab page separately
  5049. --- terminal include terminal windows where the command can be
  5050. --- restored
  5051. --- winpos position of the whole Vim window
  5052. --- winsize window sizes
  5053. --- slash `deprecated` Always enabled. Uses "/" in filenames.
  5054. --- unix `deprecated` Always enabled. Uses "\n" line endings.
  5055. ---
  5056. --- Don't include both "curdir" and "sesdir". When neither is included
  5057. --- filenames are stored as absolute paths.
  5058. --- If you leave out "options" many things won't work well after restoring
  5059. --- the session.
  5060. ---
  5061. --- @type string
  5062. vim.o.sessionoptions = "blank,buffers,curdir,folds,help,tabpages,winsize,terminal"
  5063. vim.o.ssop = vim.o.sessionoptions
  5064. vim.go.sessionoptions = vim.o.sessionoptions
  5065. vim.go.ssop = vim.go.sessionoptions
  5066. --- When non-empty, the shada file is read upon startup and written
  5067. --- when exiting Vim (see `shada-file`). The string should be a comma-
  5068. --- separated list of parameters, each consisting of a single character
  5069. --- identifying the particular parameter, followed by a number or string
  5070. --- which specifies the value of that parameter. If a particular
  5071. --- character is left out, then the default value is used for that
  5072. --- parameter. The following is a list of the identifying characters and
  5073. --- the effect of their value.
  5074. --- CHAR VALUE ~
  5075. --- *shada-!*
  5076. --- ! When included, save and restore global variables that start
  5077. --- with an uppercase letter, and don't contain a lowercase
  5078. --- letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
  5079. --- and "_K_L_M" are not. Nested List and Dict items may not be
  5080. --- read back correctly, you end up with an empty item.
  5081. --- *shada-quote*
  5082. --- " Maximum number of lines saved for each register. Old name of
  5083. --- the '<' item, with the disadvantage that you need to put a
  5084. --- backslash before the ", otherwise it will be recognized as the
  5085. --- start of a comment!
  5086. --- *shada-%*
  5087. --- % When included, save and restore the buffer list. If Vim is
  5088. --- started with a file name argument, the buffer list is not
  5089. --- restored. If Vim is started without a file name argument, the
  5090. --- buffer list is restored from the shada file. Quickfix
  5091. --- ('buftype'), unlisted ('buflisted'), unnamed and buffers on
  5092. --- removable media (`shada-r`) are not saved.
  5093. --- When followed by a number, the number specifies the maximum
  5094. --- number of buffers that are stored. Without a number all
  5095. --- buffers are stored.
  5096. --- *shada-'*
  5097. --- ' Maximum number of previously edited files for which the marks
  5098. --- are remembered. This parameter must always be included when
  5099. --- 'shada' is non-empty.
  5100. --- Including this item also means that the `jumplist` and the
  5101. --- `changelist` are stored in the shada file.
  5102. --- *shada-/*
  5103. --- / Maximum number of items in the search pattern history to be
  5104. --- saved. If non-zero, then the previous search and substitute
  5105. --- patterns are also saved. When not included, the value of
  5106. --- 'history' is used.
  5107. --- *shada-:*
  5108. --- : Maximum number of items in the command-line history to be
  5109. --- saved. When not included, the value of 'history' is used.
  5110. --- *shada-<*
  5111. --- \< Maximum number of lines saved for each register. If zero then
  5112. --- registers are not saved. When not included, all lines are
  5113. --- saved. '"' is the old name for this item.
  5114. --- Also see the 's' item below: limit specified in KiB.
  5115. --- *shada-@*
  5116. --- @ Maximum number of items in the input-line history to be
  5117. --- saved. When not included, the value of 'history' is used.
  5118. --- *shada-c*
  5119. --- c Dummy option, kept for compatibility reasons. Has no actual
  5120. --- effect: ShaDa always uses UTF-8 and 'encoding' value is fixed
  5121. --- to UTF-8 as well.
  5122. --- *shada-f*
  5123. --- f Whether file marks need to be stored. If zero, file marks ('0
  5124. --- to '9, 'A to 'Z) are not stored. When not present or when
  5125. --- non-zero, they are all stored. '0 is used for the current
  5126. --- cursor position (when exiting or when doing `:wshada`).
  5127. --- *shada-h*
  5128. --- h Disable the effect of 'hlsearch' when loading the shada
  5129. --- file. When not included, it depends on whether ":nohlsearch"
  5130. --- has been used since the last search command.
  5131. --- *shada-n*
  5132. --- n Name of the shada file. The name must immediately follow
  5133. --- the 'n'. Must be at the end of the option! If the
  5134. --- 'shadafile' option is set, that file name overrides the one
  5135. --- given here with 'shada'. Environment variables are
  5136. --- expanded when opening the file, not when setting the option.
  5137. --- *shada-r*
  5138. --- r Removable media. The argument is a string (up to the next
  5139. --- ','). This parameter can be given several times. Each
  5140. --- specifies the start of a path for which no marks will be
  5141. --- stored. This is to avoid removable media. For Windows you
  5142. --- could use "ra:,rb:". You can also use it for temp files,
  5143. --- e.g., for Unix: "r/tmp". Case is ignored.
  5144. --- *shada-s*
  5145. --- s Maximum size of an item contents in KiB. If zero then nothing
  5146. --- is saved. Unlike Vim this applies to all items, except for
  5147. --- the buffer list and header. Full item size is off by three
  5148. --- unsigned integers: with `s10` maximum item size may be 1 byte
  5149. --- (type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit
  5150. --- integer) + 3 bytes (item size: up to 16-bit integer because
  5151. --- 2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item
  5152. --- contents size) = 10253 bytes.
  5153. ---
  5154. --- Example:
  5155. ---
  5156. --- ```vim
  5157. --- set shada='50,<1000,s100,:0,n~/nvim/shada
  5158. --- ```
  5159. ---
  5160. --- '50 Marks will be remembered for the last 50 files you
  5161. --- edited.
  5162. --- <1000 Contents of registers (up to 1000 lines each) will be
  5163. --- remembered.
  5164. --- s100 Items with contents occupying more then 100 KiB are
  5165. --- skipped.
  5166. --- :0 Command-line history will not be saved.
  5167. --- n~/nvim/shada The name of the file to use is "~/nvim/shada".
  5168. --- no / Since '/' is not specified, the default will be used,
  5169. --- that is, save all of the search history, and also the
  5170. --- previous search and substitute patterns.
  5171. --- no % The buffer list will not be saved nor read back.
  5172. --- no h 'hlsearch' highlighting will be restored.
  5173. ---
  5174. --- When setting 'shada' from an empty value you can use `:rshada` to
  5175. --- load the contents of the file, this is not done automatically.
  5176. ---
  5177. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5178. --- security reasons.
  5179. ---
  5180. --- @type string
  5181. vim.o.shada = "!,'100,<50,s10,h"
  5182. vim.o.sd = vim.o.shada
  5183. vim.go.shada = vim.o.shada
  5184. vim.go.sd = vim.go.shada
  5185. --- When non-empty, overrides the file name used for `shada` (viminfo).
  5186. --- When equal to "NONE" no shada file will be read or written.
  5187. --- This option can be set with the `-i` command line flag. The `--clean`
  5188. --- command line flag sets it to "NONE".
  5189. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5190. --- security reasons.
  5191. ---
  5192. --- @type string
  5193. vim.o.shadafile = ""
  5194. vim.o.sdf = vim.o.shadafile
  5195. vim.go.shadafile = vim.o.shadafile
  5196. vim.go.sdf = vim.go.shadafile
  5197. --- Name of the shell to use for ! and :! commands. When changing the
  5198. --- value also check these options: 'shellpipe', 'shellslash'
  5199. --- 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
  5200. --- It is allowed to give an argument to the command, e.g. "csh -f".
  5201. --- See `option-backslash` about including spaces and backslashes.
  5202. --- Environment variables are expanded `:set_env`.
  5203. ---
  5204. --- If the name of the shell contains a space, you need to enclose it in
  5205. --- quotes. Example with quotes:
  5206. ---
  5207. --- ```vim
  5208. --- set shell=\"c:\program\ files\unix\sh.exe\"\ -f
  5209. --- ```
  5210. --- Note the backslash before each quote (to avoid starting a comment) and
  5211. --- each space (to avoid ending the option value), so better use `:let-&`
  5212. --- like this:
  5213. ---
  5214. --- ```vim
  5215. --- let &shell='"C:\Program Files\unix\sh.exe" -f'
  5216. --- ```
  5217. --- Also note that the "-f" is not inside the quotes, because it is not
  5218. --- part of the command name.
  5219. --- *shell-unquoting*
  5220. --- Rules regarding quotes:
  5221. --- 1. Option is split on space and tab characters that are not inside
  5222. --- quotes: "abc def" runs shell named "abc" with additional argument
  5223. --- "def", '"abc def"' runs shell named "abc def" with no additional
  5224. --- arguments (here and below: additional means “additional to
  5225. --- 'shellcmdflag'”).
  5226. --- 2. Quotes in option may be present in any position and any number:
  5227. --- '"abc"', '"a"bc', 'a"b"c', 'ab"c"' and '"a"b"c"' are all equivalent
  5228. --- to just "abc".
  5229. --- 3. Inside quotes backslash preceding backslash means one backslash.
  5230. --- Backslash preceding quote means one quote. Backslash preceding
  5231. --- anything else means backslash and next character literally:
  5232. --- '"a\\b"' is the same as "a\b", '"a\\"b"' runs shell named literally
  5233. --- 'a"b', '"a\b"' is the same as "a\b" again.
  5234. --- 4. Outside of quotes backslash always means itself, it cannot be used
  5235. --- to escape quote: 'a\"b"' is the same as "a\b".
  5236. --- Note that such processing is done after `:set` did its own round of
  5237. --- unescaping, so to keep yourself sane use `:let-&` like shown above.
  5238. --- *shell-powershell*
  5239. --- To use PowerShell:
  5240. ---
  5241. --- ```vim
  5242. --- let &shell = executable('pwsh') ? 'pwsh' : 'powershell'
  5243. --- 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;'
  5244. --- let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode'
  5245. --- let &shellpipe = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode'
  5246. --- set shellquote= shellxquote=
  5247. --- ```
  5248. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5249. --- security reasons.
  5250. ---
  5251. --- @type string
  5252. vim.o.shell = "sh"
  5253. vim.o.sh = vim.o.shell
  5254. vim.go.shell = vim.o.shell
  5255. vim.go.sh = vim.go.shell
  5256. --- Flag passed to the shell to execute "!" and ":!" commands; e.g.,
  5257. --- `bash.exe -c ls` or `cmd.exe /s /c "dir"`. For MS-Windows, the
  5258. --- default is set according to the value of 'shell', to reduce the need
  5259. --- to set this option by the user.
  5260. --- On Unix it can have more than one flag. Each white space separated
  5261. --- part is passed as an argument to the shell command.
  5262. --- See `option-backslash` about including spaces and backslashes.
  5263. --- See `shell-unquoting` which talks about separating this option into
  5264. --- multiple arguments.
  5265. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5266. --- security reasons.
  5267. ---
  5268. --- @type string
  5269. vim.o.shellcmdflag = "-c"
  5270. vim.o.shcf = vim.o.shellcmdflag
  5271. vim.go.shellcmdflag = vim.o.shellcmdflag
  5272. vim.go.shcf = vim.go.shellcmdflag
  5273. --- String to be used to put the output of the ":make" command in the
  5274. --- error file. See also `:make_makeprg`. See `option-backslash` about
  5275. --- including spaces and backslashes.
  5276. --- The name of the temporary file can be represented by "%s" if necessary
  5277. --- (the file name is appended automatically if no %s appears in the value
  5278. --- of this option).
  5279. --- For MS-Windows the default is "2>&1| tee". The stdout and stderr are
  5280. --- saved in a file and echoed to the screen.
  5281. --- For Unix the default is "| tee". The stdout of the compiler is saved
  5282. --- in a file and echoed to the screen. If the 'shell' option is "csh" or
  5283. --- "tcsh" after initializations, the default becomes "|& tee". If the
  5284. --- 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  5285. --- "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
  5286. --- means that stderr is also included. Before using the 'shell' option a
  5287. --- path is removed, thus "/bin/sh" uses "sh".
  5288. --- The initialization of this option is done after reading the vimrc
  5289. --- and the other initializations, so that when the 'shell' option is set
  5290. --- there, the 'shellpipe' option changes automatically, unless it was
  5291. --- explicitly set before.
  5292. --- When 'shellpipe' is set to an empty string, no redirection of the
  5293. --- ":make" output will be done. This is useful if you use a 'makeprg'
  5294. --- that writes to 'makeef' by itself. If you want no piping, but do
  5295. --- want to include the 'makeef', set 'shellpipe' to a single space.
  5296. --- Don't forget to precede the space with a backslash: ":set sp=\ ".
  5297. --- In the future pipes may be used for filtering and this option will
  5298. --- become obsolete (at least for Unix).
  5299. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5300. --- security reasons.
  5301. ---
  5302. --- @type string
  5303. vim.o.shellpipe = "| tee"
  5304. vim.o.sp = vim.o.shellpipe
  5305. vim.go.shellpipe = vim.o.shellpipe
  5306. vim.go.sp = vim.go.shellpipe
  5307. --- Quoting character(s), put around the command passed to the shell, for
  5308. --- the "!" and ":!" commands. The redirection is kept outside of the
  5309. --- quoting. See 'shellxquote' to include the redirection. It's
  5310. --- probably not useful to set both options.
  5311. --- This is an empty string by default. Only known to be useful for
  5312. --- third-party shells on Windows systems, such as the MKS Korn Shell
  5313. --- or bash, where it should be "\"". The default is adjusted according
  5314. --- the value of 'shell', to reduce the need to set this option by the
  5315. --- user.
  5316. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5317. --- security reasons.
  5318. ---
  5319. --- @type string
  5320. vim.o.shellquote = ""
  5321. vim.o.shq = vim.o.shellquote
  5322. vim.go.shellquote = vim.o.shellquote
  5323. vim.go.shq = vim.go.shellquote
  5324. --- String to be used to put the output of a filter command in a temporary
  5325. --- file. See also `:!`. See `option-backslash` about including spaces
  5326. --- and backslashes.
  5327. --- The name of the temporary file can be represented by "%s" if necessary
  5328. --- (the file name is appended automatically if no %s appears in the value
  5329. --- of this option).
  5330. --- The default is ">". For Unix, if the 'shell' option is "csh" or
  5331. --- "tcsh" during initializations, the default becomes ">&". If the
  5332. --- 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  5333. --- "bash" or "fish", the default becomes ">%s 2>&1". This means that
  5334. --- stderr is also included. For Win32, the Unix checks are done and
  5335. --- additionally "cmd" is checked for, which makes the default ">%s 2>&1".
  5336. --- Also, the same names with ".exe" appended are checked for.
  5337. --- The initialization of this option is done after reading the vimrc
  5338. --- and the other initializations, so that when the 'shell' option is set
  5339. --- there, the 'shellredir' option changes automatically unless it was
  5340. --- explicitly set before.
  5341. --- In the future pipes may be used for filtering and this option will
  5342. --- become obsolete (at least for Unix).
  5343. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5344. --- security reasons.
  5345. ---
  5346. --- @type string
  5347. vim.o.shellredir = ">"
  5348. vim.o.srr = vim.o.shellredir
  5349. vim.go.shellredir = vim.o.shellredir
  5350. vim.go.srr = vim.go.shellredir
  5351. --- only modifiable in MS-Windows
  5352. --- When set, a forward slash is used when expanding file names. This is
  5353. --- useful when a Unix-like shell is used instead of cmd.exe. Backward
  5354. --- slashes can still be typed, but they are changed to forward slashes by
  5355. --- Vim.
  5356. --- Note that setting or resetting this option has no effect for some
  5357. --- existing file names, thus this option needs to be set before opening
  5358. --- any file for best results. This might change in the future.
  5359. --- 'shellslash' only works when a backslash can be used as a path
  5360. --- separator. To test if this is so use:
  5361. ---
  5362. --- ```vim
  5363. --- if exists('+shellslash')
  5364. --- ```
  5365. --- Also see 'completeslash'.
  5366. ---
  5367. --- @type boolean
  5368. vim.o.shellslash = true
  5369. vim.o.ssl = vim.o.shellslash
  5370. vim.go.shellslash = vim.o.shellslash
  5371. vim.go.ssl = vim.go.shellslash
  5372. --- When on, use temp files for shell commands. When off use a pipe.
  5373. --- When using a pipe is not possible temp files are used anyway.
  5374. --- The advantage of using a pipe is that nobody can read the temp file
  5375. --- and the 'shell' command does not need to support redirection.
  5376. --- The advantage of using a temp file is that the file type and encoding
  5377. --- can be detected.
  5378. --- The `FilterReadPre`, `FilterReadPost` and `FilterWritePre|,
  5379. --- |FilterWritePost` autocommands event are not triggered when
  5380. --- 'shelltemp' is off.
  5381. --- `system()` does not respect this option, it always uses pipes.
  5382. ---
  5383. --- @type boolean
  5384. vim.o.shelltemp = true
  5385. vim.o.stmp = vim.o.shelltemp
  5386. vim.go.shelltemp = vim.o.shelltemp
  5387. vim.go.stmp = vim.go.shelltemp
  5388. --- When 'shellxquote' is set to "(" then the characters listed in this
  5389. --- option will be escaped with a '^' character. This makes it possible
  5390. --- to execute most external commands with cmd.exe.
  5391. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5392. --- security reasons.
  5393. ---
  5394. --- @type string
  5395. vim.o.shellxescape = ""
  5396. vim.o.sxe = vim.o.shellxescape
  5397. vim.go.shellxescape = vim.o.shellxescape
  5398. vim.go.sxe = vim.go.shellxescape
  5399. --- Quoting character(s), put around the command passed to the shell, for
  5400. --- the "!" and ":!" commands. Includes the redirection. See
  5401. --- 'shellquote' to exclude the redirection. It's probably not useful
  5402. --- to set both options.
  5403. --- When the value is '(' then ')' is appended. When the value is '"('
  5404. --- then ')"' is appended.
  5405. --- When the value is '(' then also see 'shellxescape'.
  5406. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5407. --- security reasons.
  5408. ---
  5409. --- @type string
  5410. vim.o.shellxquote = ""
  5411. vim.o.sxq = vim.o.shellxquote
  5412. vim.go.shellxquote = vim.o.shellxquote
  5413. vim.go.sxq = vim.go.shellxquote
  5414. --- Round indent to multiple of 'shiftwidth'. Applies to > and <
  5415. --- commands. CTRL-T and CTRL-D in Insert mode always round the indent to
  5416. --- a multiple of 'shiftwidth' (this is Vi compatible).
  5417. ---
  5418. --- @type boolean
  5419. vim.o.shiftround = false
  5420. vim.o.sr = vim.o.shiftround
  5421. vim.go.shiftround = vim.o.shiftround
  5422. vim.go.sr = vim.go.shiftround
  5423. --- Number of spaces to use for each step of (auto)indent. Used for
  5424. --- `'cindent'`, `>>`, `<<`, etc.
  5425. --- When zero the 'tabstop' value will be used. Use the `shiftwidth()`
  5426. --- function to get the effective shiftwidth value.
  5427. ---
  5428. --- @type integer
  5429. vim.o.shiftwidth = 8
  5430. vim.o.sw = vim.o.shiftwidth
  5431. vim.bo.shiftwidth = vim.o.shiftwidth
  5432. vim.bo.sw = vim.bo.shiftwidth
  5433. --- This option helps to avoid all the `hit-enter` prompts caused by file
  5434. --- messages, for example with CTRL-G, and to avoid some other messages.
  5435. --- It is a list of flags:
  5436. --- flag meaning when present ~
  5437. --- l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
  5438. --- m use "[+]" instead of "[Modified]" *shm-m*
  5439. --- r use "[RO]" instead of "[readonly]" *shm-r*
  5440. --- w use "[w]" instead of "written" for file write message *shm-w*
  5441. --- and "[a]" instead of "appended" for ':w >> file' command
  5442. --- a all of the above abbreviations *shm-a*
  5443. ---
  5444. --- o overwrite message for writing a file with subsequent *shm-o*
  5445. --- message for reading a file (useful for ":wn" or when
  5446. --- 'autowrite' on)
  5447. --- O message for reading a file overwrites any previous *shm-O*
  5448. --- message; also for quickfix message (e.g., ":cn")
  5449. --- s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
  5450. --- "search hit TOP, continuing at BOTTOM" messages; when using
  5451. --- the search count do not show "W" before the count message
  5452. --- (see `shm-S` below)
  5453. --- t truncate file message at the start if it is too long *shm-t*
  5454. --- to fit on the command-line, "<" will appear in the left most
  5455. --- column; ignored in Ex mode
  5456. --- T truncate other messages in the middle if they are too *shm-T*
  5457. --- long to fit on the command line; "..." will appear in the
  5458. --- middle; ignored in Ex mode
  5459. --- W don't give "written" or "[w]" when writing a file *shm-W*
  5460. --- A don't give the "ATTENTION" message when an existing *shm-A*
  5461. --- swap file is found
  5462. --- I don't give the intro message when starting Vim, *shm-I*
  5463. --- see `:intro`
  5464. --- c don't give `ins-completion-menu` messages; for *shm-c*
  5465. --- example, "-- XXX completion (YYY)", "match 1 of 2", "The only
  5466. --- match", "Pattern not found", "Back at original", etc.
  5467. --- C don't give messages while scanning for ins-completion *shm-C*
  5468. --- items, for instance "scanning tags"
  5469. --- q do not show "recording @a" when recording a macro *shm-q*
  5470. --- F don't give the file info when editing a file, like *shm-F*
  5471. --- `:silent` was used for the command; note that this also
  5472. --- affects messages from 'autoread' reloading
  5473. --- S do not show search count message when searching, e.g. *shm-S*
  5474. --- "[1/5]". When the "S" flag is not present (e.g. search count
  5475. --- is shown), the "search hit BOTTOM, continuing at TOP" and
  5476. --- "search hit TOP, continuing at BOTTOM" messages are only
  5477. --- indicated by a "W" (Mnemonic: Wrapped) letter before the
  5478. --- search count statistics.
  5479. ---
  5480. --- This gives you the opportunity to avoid that a change between buffers
  5481. --- requires you to hit <Enter>, but still gives as useful a message as
  5482. --- possible for the space available. To get the whole message that you
  5483. --- would have got with 'shm' empty, use ":file!"
  5484. --- Useful values:
  5485. --- shm= No abbreviation of message.
  5486. --- shm=a Abbreviation, but no loss of information.
  5487. --- shm=at Abbreviation, and truncate message when necessary.
  5488. ---
  5489. --- @type string
  5490. vim.o.shortmess = "ltToOCF"
  5491. vim.o.shm = vim.o.shortmess
  5492. vim.go.shortmess = vim.o.shortmess
  5493. vim.go.shm = vim.go.shortmess
  5494. --- String to put at the start of lines that have been wrapped. Useful
  5495. --- values are "> " or "+++ ":
  5496. ---
  5497. --- ```vim
  5498. --- let &showbreak = "> "
  5499. --- let &showbreak = '+++ '
  5500. --- ```
  5501. --- Only printable single-cell characters are allowed, excluding <Tab> and
  5502. --- comma (in a future version the comma might be used to separate the
  5503. --- part that is shown at the end and at the start of a line).
  5504. --- The `hl-NonText` highlight group determines the highlighting.
  5505. --- Note that tabs after the showbreak will be displayed differently.
  5506. --- If you want the 'showbreak' to appear in between line numbers, add the
  5507. --- "n" flag to 'cpoptions'.
  5508. --- A window-local value overrules a global value. If the global value is
  5509. --- set and you want no value in the current window use NONE:
  5510. ---
  5511. --- ```vim
  5512. --- setlocal showbreak=NONE
  5513. --- ```
  5514. ---
  5515. ---
  5516. --- @type string
  5517. vim.o.showbreak = ""
  5518. vim.o.sbr = vim.o.showbreak
  5519. vim.wo.showbreak = vim.o.showbreak
  5520. vim.wo.sbr = vim.wo.showbreak
  5521. vim.go.showbreak = vim.o.showbreak
  5522. vim.go.sbr = vim.go.showbreak
  5523. --- Show (partial) command in the last line of the screen. Set this
  5524. --- option off if your terminal is slow.
  5525. --- In Visual mode the size of the selected area is shown:
  5526. --- - When selecting characters within a line, the number of characters.
  5527. --- If the number of bytes is different it is also displayed: "2-6"
  5528. --- means two characters and six bytes.
  5529. --- - When selecting more than one line, the number of lines.
  5530. --- - When selecting a block, the size in screen characters:
  5531. --- {lines}x{columns}.
  5532. --- This information can be displayed in an alternative location using the
  5533. --- 'showcmdloc' option, useful when 'cmdheight' is 0.
  5534. ---
  5535. --- @type boolean
  5536. vim.o.showcmd = true
  5537. vim.o.sc = vim.o.showcmd
  5538. vim.go.showcmd = vim.o.showcmd
  5539. vim.go.sc = vim.go.showcmd
  5540. --- This option can be used to display the (partially) entered command in
  5541. --- another location. Possible values are:
  5542. --- last Last line of the screen (default).
  5543. --- statusline Status line of the current window.
  5544. --- tabline First line of the screen if 'showtabline' is enabled.
  5545. --- Setting this option to "statusline" or "tabline" means that these will
  5546. --- be redrawn whenever the command changes, which can be on every key
  5547. --- pressed.
  5548. --- The %S 'statusline' item can be used in 'statusline' or 'tabline' to
  5549. --- place the text. Without a custom 'statusline' or 'tabline' it will be
  5550. --- displayed in a convenient location.
  5551. ---
  5552. --- @type string
  5553. vim.o.showcmdloc = "last"
  5554. vim.o.sloc = vim.o.showcmdloc
  5555. vim.go.showcmdloc = vim.o.showcmdloc
  5556. vim.go.sloc = vim.go.showcmdloc
  5557. --- When completing a word in insert mode (see `ins-completion`) from the
  5558. --- tags file, show both the tag name and a tidied-up form of the search
  5559. --- pattern (if there is one) as possible matches. Thus, if you have
  5560. --- matched a C function, you can see a template for what arguments are
  5561. --- required (coding style permitting).
  5562. --- Note that this doesn't work well together with having "longest" in
  5563. --- 'completeopt', because the completion from the search pattern may not
  5564. --- match the typed text.
  5565. ---
  5566. --- @type boolean
  5567. vim.o.showfulltag = false
  5568. vim.o.sft = vim.o.showfulltag
  5569. vim.go.showfulltag = vim.o.showfulltag
  5570. vim.go.sft = vim.go.showfulltag
  5571. --- When a bracket is inserted, briefly jump to the matching one. The
  5572. --- jump is only done if the match can be seen on the screen. The time to
  5573. --- show the match can be set with 'matchtime'.
  5574. --- A Beep is given if there is no match (no matter if the match can be
  5575. --- seen or not).
  5576. --- When the 'm' flag is not included in 'cpoptions', typing a character
  5577. --- will immediately move the cursor back to where it belongs.
  5578. --- See the "sm" field in 'guicursor' for setting the cursor shape and
  5579. --- blinking when showing the match.
  5580. --- The 'matchpairs' option can be used to specify the characters to show
  5581. --- matches for. 'rightleft' and 'revins' are used to look for opposite
  5582. --- matches.
  5583. --- Also see the matchparen plugin for highlighting the match when moving
  5584. --- around `pi_paren.txt`.
  5585. --- Note: Use of the short form is rated PG.
  5586. ---
  5587. --- @type boolean
  5588. vim.o.showmatch = false
  5589. vim.o.sm = vim.o.showmatch
  5590. vim.go.showmatch = vim.o.showmatch
  5591. vim.go.sm = vim.go.showmatch
  5592. --- If in Insert, Replace or Visual mode put a message on the last line.
  5593. --- The `hl-ModeMsg` highlight group determines the highlighting.
  5594. --- The option has no effect when 'cmdheight' is zero.
  5595. ---
  5596. --- @type boolean
  5597. vim.o.showmode = true
  5598. vim.o.smd = vim.o.showmode
  5599. vim.go.showmode = vim.o.showmode
  5600. vim.go.smd = vim.go.showmode
  5601. --- The value of this option specifies when the line with tab page labels
  5602. --- will be displayed:
  5603. --- 0: never
  5604. --- 1: only if there are at least two tab pages
  5605. --- 2: always
  5606. --- This is both for the GUI and non-GUI implementation of the tab pages
  5607. --- line.
  5608. --- See `tab-page` for more information about tab pages.
  5609. ---
  5610. --- @type integer
  5611. vim.o.showtabline = 1
  5612. vim.o.stal = vim.o.showtabline
  5613. vim.go.showtabline = vim.o.showtabline
  5614. vim.go.stal = vim.go.showtabline
  5615. --- The minimal number of columns to scroll horizontally. Used only when
  5616. --- the 'wrap' option is off and the cursor is moved off of the screen.
  5617. --- When it is zero the cursor will be put in the middle of the screen.
  5618. --- When using a slow terminal set it to a large number or 0. Not used
  5619. --- for "zh" and "zl" commands.
  5620. ---
  5621. --- @type integer
  5622. vim.o.sidescroll = 1
  5623. vim.o.ss = vim.o.sidescroll
  5624. vim.go.sidescroll = vim.o.sidescroll
  5625. vim.go.ss = vim.go.sidescroll
  5626. --- The minimal number of screen columns to keep to the left and to the
  5627. --- right of the cursor if 'nowrap' is set. Setting this option to a
  5628. --- value greater than 0 while having `'sidescroll'` also at a non-zero
  5629. --- value makes some context visible in the line you are scrolling in
  5630. --- horizontally (except at beginning of the line). Setting this option
  5631. --- to a large value (like 999) has the effect of keeping the cursor
  5632. --- horizontally centered in the window, as long as one does not come too
  5633. --- close to the beginning of the line.
  5634. --- After using the local value, go back the global value with one of
  5635. --- these two:
  5636. ---
  5637. --- ```vim
  5638. --- setlocal sidescrolloff<
  5639. --- setlocal sidescrolloff=-1
  5640. --- ```
  5641. ---
  5642. --- Example: Try this together with 'sidescroll' and 'listchars' as
  5643. --- in the following example to never allow the cursor to move
  5644. --- onto the "extends" character:
  5645. ---
  5646. --- ```vim
  5647. ---
  5648. --- set nowrap sidescroll=1 listchars=extends:>,precedes:<
  5649. --- set sidescrolloff=1
  5650. --- ```
  5651. ---
  5652. ---
  5653. --- @type integer
  5654. vim.o.sidescrolloff = 0
  5655. vim.o.siso = vim.o.sidescrolloff
  5656. vim.wo.sidescrolloff = vim.o.sidescrolloff
  5657. vim.wo.siso = vim.wo.sidescrolloff
  5658. vim.go.sidescrolloff = vim.o.sidescrolloff
  5659. vim.go.siso = vim.go.sidescrolloff
  5660. --- When and how to draw the signcolumn. Valid values are:
  5661. --- "auto" only when there is a sign to display
  5662. --- "auto:[1-9]" resize to accommodate multiple signs up to the
  5663. --- given number (maximum 9), e.g. "auto:4"
  5664. --- "auto:[1-8]-[2-9]"
  5665. --- resize to accommodate multiple signs up to the
  5666. --- given maximum number (maximum 9) while keeping
  5667. --- at least the given minimum (maximum 8) fixed
  5668. --- space. The minimum number should always be less
  5669. --- than the maximum number, e.g. "auto:2-5"
  5670. --- "no" never
  5671. --- "yes" always
  5672. --- "yes:[1-9]" always, with fixed space for signs up to the given
  5673. --- number (maximum 9), e.g. "yes:3"
  5674. --- "number" display signs in the 'number' column. If the number
  5675. --- column is not present, then behaves like "auto".
  5676. ---
  5677. --- @type string
  5678. vim.o.signcolumn = "auto"
  5679. vim.o.scl = vim.o.signcolumn
  5680. vim.wo.signcolumn = vim.o.signcolumn
  5681. vim.wo.scl = vim.wo.signcolumn
  5682. --- Override the 'ignorecase' option if the search pattern contains upper
  5683. --- case characters. Only used when the search pattern is typed and
  5684. --- 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
  5685. --- ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
  5686. --- "*" and "#" you can make 'smartcase' used by doing a "/" command,
  5687. --- recalling the search pattern from history and hitting <Enter>.
  5688. ---
  5689. --- @type boolean
  5690. vim.o.smartcase = false
  5691. vim.o.scs = vim.o.smartcase
  5692. vim.go.smartcase = vim.o.smartcase
  5693. vim.go.scs = vim.go.smartcase
  5694. --- Do smart autoindenting when starting a new line. Works for C-like
  5695. --- programs, but can also be used for other languages. 'cindent' does
  5696. --- something like this, works better in most cases, but is more strict,
  5697. --- see `C-indenting`. When 'cindent' is on or 'indentexpr' is set,
  5698. --- setting 'si' has no effect. 'indentexpr' is a more advanced
  5699. --- alternative.
  5700. --- Normally 'autoindent' should also be on when using 'smartindent'.
  5701. --- An indent is automatically inserted:
  5702. --- - After a line ending in "{".
  5703. --- - After a line starting with a keyword from 'cinwords'.
  5704. --- - Before a line starting with "}" (only with the "O" command).
  5705. --- When typing '}' as the first character in a new line, that line is
  5706. --- given the same indent as the matching "{".
  5707. --- When typing '#' as the first character in a new line, the indent for
  5708. --- that line is removed, the '#' is put in the first column. The indent
  5709. --- is restored for the next line. If you don't want this, use this
  5710. --- mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
  5711. --- When using the ">>" command, lines starting with '#' are not shifted
  5712. --- right.
  5713. ---
  5714. --- @type boolean
  5715. vim.o.smartindent = false
  5716. vim.o.si = vim.o.smartindent
  5717. vim.bo.smartindent = vim.o.smartindent
  5718. vim.bo.si = vim.bo.smartindent
  5719. --- When on, a <Tab> in front of a line inserts blanks according to
  5720. --- 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
  5721. --- <BS> will delete a 'shiftwidth' worth of space at the start of the
  5722. --- line.
  5723. --- When off, a <Tab> always inserts blanks according to 'tabstop' or
  5724. --- 'softtabstop'. 'shiftwidth' is only used for shifting text left or
  5725. --- right `shift-left-right`.
  5726. --- What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
  5727. --- option. Also see `ins-expandtab`. When 'expandtab' is not set, the
  5728. --- number of spaces is minimized by using <Tab>s.
  5729. ---
  5730. --- @type boolean
  5731. vim.o.smarttab = true
  5732. vim.o.sta = vim.o.smarttab
  5733. vim.go.smarttab = vim.o.smarttab
  5734. vim.go.sta = vim.go.smarttab
  5735. --- Scrolling works with screen lines. When 'wrap' is set and the first
  5736. --- line in the window wraps part of it may not be visible, as if it is
  5737. --- above the window. "<<<" is displayed at the start of the first line,
  5738. --- highlighted with `hl-NonText`.
  5739. --- You may also want to add "lastline" to the 'display' option to show as
  5740. --- much of the last line as possible.
  5741. --- NOTE: partly implemented, doesn't work yet for `gj` and `gk`.
  5742. ---
  5743. --- @type boolean
  5744. vim.o.smoothscroll = false
  5745. vim.o.sms = vim.o.smoothscroll
  5746. vim.wo.smoothscroll = vim.o.smoothscroll
  5747. vim.wo.sms = vim.wo.smoothscroll
  5748. --- Number of spaces that a <Tab> counts for while performing editing
  5749. --- operations, like inserting a <Tab> or using <BS>. It "feels" like
  5750. --- <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
  5751. --- used. This is useful to keep the 'ts' setting at its standard value
  5752. --- of 8, while being able to edit like it is set to 'sts'. However,
  5753. --- commands like "x" still work on the actual characters.
  5754. --- When 'sts' is zero, this feature is off.
  5755. --- When 'sts' is negative, the value of 'shiftwidth' is used.
  5756. --- See also `ins-expandtab`. When 'expandtab' is not set, the number of
  5757. --- spaces is minimized by using <Tab>s.
  5758. --- The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
  5759. --- set.
  5760. ---
  5761. --- The value of 'softtabstop' will be ignored if `'varsofttabstop'` is set
  5762. --- to anything other than an empty string.
  5763. ---
  5764. --- @type integer
  5765. vim.o.softtabstop = 0
  5766. vim.o.sts = vim.o.softtabstop
  5767. vim.bo.softtabstop = vim.o.softtabstop
  5768. vim.bo.sts = vim.bo.softtabstop
  5769. --- When on spell checking will be done. See `spell`.
  5770. --- The languages are specified with 'spelllang'.
  5771. ---
  5772. --- @type boolean
  5773. vim.o.spell = false
  5774. vim.wo.spell = vim.o.spell
  5775. --- Pattern to locate the end of a sentence. The following word will be
  5776. --- checked to start with a capital letter. If not then it is highlighted
  5777. --- with SpellCap `hl-SpellCap` (unless the word is also badly spelled).
  5778. --- When this check is not wanted make this option empty.
  5779. --- Only used when 'spell' is set.
  5780. --- Be careful with special characters, see `option-backslash` about
  5781. --- including spaces and backslashes.
  5782. --- To set this option automatically depending on the language, see
  5783. --- `set-spc-auto`.
  5784. ---
  5785. --- @type string
  5786. vim.o.spellcapcheck = "[.?!]\\_[\\])'\"\\t ]\\+"
  5787. vim.o.spc = vim.o.spellcapcheck
  5788. vim.bo.spellcapcheck = vim.o.spellcapcheck
  5789. vim.bo.spc = vim.bo.spellcapcheck
  5790. --- Name of the word list file where words are added for the `zg` and `zw`
  5791. --- commands. It must end in ".{encoding}.add". You need to include the
  5792. --- path, otherwise the file is placed in the current directory.
  5793. --- The path may include characters from 'isfname', ' ', ',', '@' and ':'.
  5794. --- *E765*
  5795. --- It may also be a comma-separated list of names. A count before the
  5796. --- `zg` and `zw` commands can be used to access each. This allows using
  5797. --- a personal word list file and a project word list file.
  5798. --- When a word is added while this option is empty Vim will set it for
  5799. --- you: Using the first directory in 'runtimepath' that is writable. If
  5800. --- there is no "spell" directory yet it will be created. For the file
  5801. --- name the first language name that appears in 'spelllang' is used,
  5802. --- ignoring the region.
  5803. --- The resulting ".spl" file will be used for spell checking, it does not
  5804. --- have to appear in 'spelllang'.
  5805. --- Normally one file is used for all regions, but you can add the region
  5806. --- name if you want to. However, it will then only be used when
  5807. --- 'spellfile' is set to it, for entries in 'spelllang' only files
  5808. --- without region name will be found.
  5809. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5810. --- security reasons.
  5811. ---
  5812. --- @type string
  5813. vim.o.spellfile = ""
  5814. vim.o.spf = vim.o.spellfile
  5815. vim.bo.spellfile = vim.o.spellfile
  5816. vim.bo.spf = vim.bo.spellfile
  5817. --- A comma-separated list of word list names. When the 'spell' option is
  5818. --- on spellchecking will be done for these languages. Example:
  5819. ---
  5820. --- ```vim
  5821. --- set spelllang=en_us,nl,medical
  5822. --- ```
  5823. --- This means US English, Dutch and medical words are recognized. Words
  5824. --- that are not recognized will be highlighted.
  5825. --- The word list name must consist of alphanumeric characters, a dash or
  5826. --- an underscore. It should not include a comma or dot. Using a dash is
  5827. --- recommended to separate the two letter language name from a
  5828. --- specification. Thus "en-rare" is used for rare English words.
  5829. --- A region name must come last and have the form "_xx", where "xx" is
  5830. --- the two-letter, lower case region name. You can use more than one
  5831. --- region by listing them: "en_us,en_ca" supports both US and Canadian
  5832. --- English, but not words specific for Australia, New Zealand or Great
  5833. --- Britain. (Note: currently en_au and en_nz dictionaries are older than
  5834. --- en_ca, en_gb and en_us).
  5835. --- If the name "cjk" is included East Asian characters are excluded from
  5836. --- spell checking. This is useful when editing text that also has Asian
  5837. --- words.
  5838. --- Note that the "medical" dictionary does not exist, it is just an
  5839. --- example of a longer name.
  5840. --- *E757*
  5841. --- As a special case the name of a .spl file can be given as-is. The
  5842. --- first "_xx" in the name is removed and used as the region name
  5843. --- (_xx is an underscore, two letters and followed by a non-letter).
  5844. --- This is mainly for testing purposes. You must make sure the correct
  5845. --- encoding is used, Vim doesn't check it.
  5846. --- How the related spell files are found is explained here: `spell-load`.
  5847. ---
  5848. --- If the `spellfile.vim` plugin is active and you use a language name
  5849. --- for which Vim cannot find the .spl file in 'runtimepath' the plugin
  5850. --- will ask you if you want to download the file.
  5851. ---
  5852. --- After this option has been set successfully, Vim will source the files
  5853. --- "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
  5854. --- up to the first character that is not an ASCII letter or number and
  5855. --- not a dash. Also see `set-spc-auto`.
  5856. ---
  5857. --- @type string
  5858. vim.o.spelllang = "en"
  5859. vim.o.spl = vim.o.spelllang
  5860. vim.bo.spelllang = vim.o.spelllang
  5861. vim.bo.spl = vim.bo.spelllang
  5862. --- A comma-separated list of options for spell checking:
  5863. --- camel When a word is CamelCased, assume "Cased" is a
  5864. --- separate word: every upper-case character in a word
  5865. --- that comes after a lower case character indicates the
  5866. --- start of a new word.
  5867. --- noplainbuffer Only spellcheck a buffer when 'syntax' is enabled,
  5868. --- or when extmarks are set within the buffer. Only
  5869. --- designated regions of the buffer are spellchecked in
  5870. --- this case.
  5871. ---
  5872. --- @type string
  5873. vim.o.spelloptions = ""
  5874. vim.o.spo = vim.o.spelloptions
  5875. vim.bo.spelloptions = vim.o.spelloptions
  5876. vim.bo.spo = vim.bo.spelloptions
  5877. --- Methods used for spelling suggestions. Both for the `z=` command and
  5878. --- the `spellsuggest()` function. This is a comma-separated list of
  5879. --- items:
  5880. ---
  5881. --- best Internal method that works best for English. Finds
  5882. --- changes like "fast" and uses a bit of sound-a-like
  5883. --- scoring to improve the ordering.
  5884. ---
  5885. --- double Internal method that uses two methods and mixes the
  5886. --- results. The first method is "fast", the other method
  5887. --- computes how much the suggestion sounds like the bad
  5888. --- word. That only works when the language specifies
  5889. --- sound folding. Can be slow and doesn't always give
  5890. --- better results.
  5891. ---
  5892. --- fast Internal method that only checks for simple changes:
  5893. --- character inserts/deletes/swaps. Works well for
  5894. --- simple typing mistakes.
  5895. ---
  5896. --- {number} The maximum number of suggestions listed for `z=`.
  5897. --- Not used for `spellsuggest()`. The number of
  5898. --- suggestions is never more than the value of 'lines'
  5899. --- minus two.
  5900. ---
  5901. --- timeout:{millisec} Limit the time searching for suggestions to
  5902. --- {millisec} milliseconds. Applies to the following
  5903. --- methods. When omitted the limit is 5000. When
  5904. --- negative there is no limit.
  5905. ---
  5906. --- file:{filename} Read file {filename}, which must have two columns,
  5907. --- separated by a slash. The first column contains the
  5908. --- bad word, the second column the suggested good word.
  5909. --- Example:
  5910. --- theribal/terrible ~
  5911. --- Use this for common mistakes that do not appear at the
  5912. --- top of the suggestion list with the internal methods.
  5913. --- Lines without a slash are ignored, use this for
  5914. --- comments.
  5915. --- The word in the second column must be correct,
  5916. --- otherwise it will not be used. Add the word to an
  5917. --- ".add" file if it is currently flagged as a spelling
  5918. --- mistake.
  5919. --- The file is used for all languages.
  5920. ---
  5921. --- expr:{expr} Evaluate expression {expr}. Use a function to avoid
  5922. --- trouble with spaces. Best is to call a function
  5923. --- without arguments, see `expr-option-function|.
  5924. --- |v:val` holds the badly spelled word. The expression
  5925. --- must evaluate to a List of Lists, each with a
  5926. --- suggestion and a score.
  5927. --- Example:
  5928. --- [['the', 33], ['that', 44]] ~
  5929. --- Set 'verbose' and use `z=` to see the scores that the
  5930. --- internal methods use. A lower score is better.
  5931. --- This may invoke `spellsuggest()` if you temporarily
  5932. --- set 'spellsuggest' to exclude the "expr:" part.
  5933. --- Errors are silently ignored, unless you set the
  5934. --- 'verbose' option to a non-zero value.
  5935. ---
  5936. --- Only one of "best", "double" or "fast" may be used. The others may
  5937. --- appear several times in any order. Example:
  5938. ---
  5939. --- ```vim
  5940. --- set sps=file:~/.config/nvim/sugg,best,expr:MySuggest()
  5941. --- ```
  5942. ---
  5943. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  5944. --- security reasons.
  5945. ---
  5946. --- @type string
  5947. vim.o.spellsuggest = "best"
  5948. vim.o.sps = vim.o.spellsuggest
  5949. vim.go.spellsuggest = vim.o.spellsuggest
  5950. vim.go.sps = vim.go.spellsuggest
  5951. --- When on, splitting a window will put the new window below the current
  5952. --- one. `:split`
  5953. ---
  5954. --- @type boolean
  5955. vim.o.splitbelow = false
  5956. vim.o.sb = vim.o.splitbelow
  5957. vim.go.splitbelow = vim.o.splitbelow
  5958. vim.go.sb = vim.go.splitbelow
  5959. --- The value of this option determines the scroll behavior when opening,
  5960. --- closing or resizing horizontal splits.
  5961. ---
  5962. --- Possible values are:
  5963. --- cursor Keep the same relative cursor position.
  5964. --- screen Keep the text on the same screen line.
  5965. --- topline Keep the topline the same.
  5966. ---
  5967. --- For the "screen" and "topline" values, the cursor position will be
  5968. --- changed when necessary. In this case, the jumplist will be populated
  5969. --- with the previous cursor position. For "screen", the text cannot always
  5970. --- be kept on the same screen line when 'wrap' is enabled.
  5971. ---
  5972. --- @type string
  5973. vim.o.splitkeep = "cursor"
  5974. vim.o.spk = vim.o.splitkeep
  5975. vim.go.splitkeep = vim.o.splitkeep
  5976. vim.go.spk = vim.go.splitkeep
  5977. --- When on, splitting a window will put the new window right of the
  5978. --- current one. `:vsplit`
  5979. ---
  5980. --- @type boolean
  5981. vim.o.splitright = false
  5982. vim.o.spr = vim.o.splitright
  5983. vim.go.splitright = vim.o.splitright
  5984. vim.go.spr = vim.go.splitright
  5985. --- When "on" the commands listed below move the cursor to the first
  5986. --- non-blank of the line. When off the cursor is kept in the same column
  5987. --- (if possible). This applies to the commands:
  5988. --- - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
  5989. --- - "d", "<<", "==" and ">>" with a linewise operator
  5990. --- (`operator-resulting-pos`)
  5991. --- - "%" with a count
  5992. --- - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
  5993. --- - Ex commands that only have a line number, e.g., ":25" or ":+".
  5994. --- In case of buffer changing commands the cursor is placed at the column
  5995. --- where it was the last time the buffer was edited.
  5996. ---
  5997. --- @type boolean
  5998. vim.o.startofline = false
  5999. vim.o.sol = vim.o.startofline
  6000. vim.go.startofline = vim.o.startofline
  6001. vim.go.sol = vim.go.startofline
  6002. --- When non-empty, this option determines the content of the area to the
  6003. --- side of a window, normally containing the fold, sign and number columns.
  6004. --- The format of this option is like that of 'statusline'.
  6005. ---
  6006. --- Some of the items from the 'statusline' format are different for
  6007. --- 'statuscolumn':
  6008. ---
  6009. --- %l line number column for currently drawn line
  6010. --- %s sign column for currently drawn line
  6011. --- %C fold column for currently drawn line
  6012. ---
  6013. --- The 'statuscolumn' width follows that of the default columns and
  6014. --- adapts to the `'numberwidth'`, `'signcolumn'` and `'foldcolumn'` option
  6015. --- values (regardless of whether the sign and fold items are present).
  6016. --- Additionally, the 'statuscolumn' grows with the size of the evaluated
  6017. --- format string, up to a point (following the maximum size of the default
  6018. --- fold, sign and number columns). Shrinking only happens when the number
  6019. --- of lines in a buffer changes, or the 'statuscolumn' option is set.
  6020. ---
  6021. --- The `v:lnum` variable holds the line number to be drawn.
  6022. --- The `v:relnum` variable holds the relative line number to be drawn.
  6023. --- The `v:virtnum` variable is negative when drawing virtual lines, zero
  6024. --- when drawing the actual buffer line, and positive when
  6025. --- drawing the wrapped part of a buffer line.
  6026. ---
  6027. --- When using `v:relnum`, keep in mind that cursor movement by itself will
  6028. --- not cause the 'statuscolumn' to update unless `'relativenumber'` is set.
  6029. ---
  6030. --- NOTE: The %@ click execute function item is supported as well but the
  6031. --- specified function will be the same for each row in the same column.
  6032. --- It cannot be switched out through a dynamic 'statuscolumn' format, the
  6033. --- handler should be written with this in mind.
  6034. ---
  6035. --- Examples:
  6036. ---
  6037. --- ```vim
  6038. --- " Line number with bar separator and click handlers:
  6039. --- set statuscolumn=%@SignCb@%s%=%T%@NumCb@%l│%T
  6040. ---
  6041. --- " Line numbers in hexadecimal for non wrapped part of lines:
  6042. --- let &stc='%=%{v:virtnum>0?"":printf("%x",v:lnum)} '
  6043. ---
  6044. --- " Human readable line numbers with thousands separator:
  6045. --- let &stc='%{substitute(v:lnum,"\\d\\zs\\ze\\'
  6046. --- . '%(\\d\\d\\d\\)\\+$",",","g")}'
  6047. ---
  6048. --- " Both relative and absolute line numbers with different
  6049. --- " highlighting for odd and even relative numbers:
  6050. --- let &stc='%#NonText#%{&nu?v:lnum:""}' .
  6051. --- '%=%{&rnu&&(v:lnum%2)?"\ ".v:relnum:""}' .
  6052. --- '%#LineNr#%{&rnu&&!(v:lnum%2)?"\ ".v:relnum:""}'
  6053. --- ```
  6054. --- WARNING: this expression is evaluated for each screen line so defining
  6055. --- an expensive expression can negatively affect render performance.
  6056. ---
  6057. --- @type string
  6058. vim.o.statuscolumn = ""
  6059. vim.o.stc = vim.o.statuscolumn
  6060. vim.wo.statuscolumn = vim.o.statuscolumn
  6061. vim.wo.stc = vim.wo.statuscolumn
  6062. --- When non-empty, this option determines the content of the status line.
  6063. --- Also see `status-line`.
  6064. ---
  6065. --- The option consists of printf style '%' items interspersed with
  6066. --- normal text. Each status line item is of the form:
  6067. --- %-0{minwid}.{maxwid}{item}
  6068. --- All fields except the {item} are optional. A single percent sign can
  6069. --- be given as "%%".
  6070. ---
  6071. --- *stl-%!*
  6072. --- When the option starts with "%!" then it is used as an expression,
  6073. --- evaluated and the result is used as the option value. Example:
  6074. ---
  6075. --- ```vim
  6076. --- set statusline=%!MyStatusLine()
  6077. --- ```
  6078. --- The *g:statusline_winid* variable will be set to the `window-ID` of the
  6079. --- window that the status line belongs to.
  6080. --- The result can contain %{} items that will be evaluated too.
  6081. --- Note that the "%!" expression is evaluated in the context of the
  6082. --- current window and buffer, while %{} items are evaluated in the
  6083. --- context of the window that the statusline belongs to.
  6084. ---
  6085. --- When there is error while evaluating the option then it will be made
  6086. --- empty to avoid further errors. Otherwise screen updating would loop.
  6087. --- When the result contains unprintable characters the result is
  6088. --- unpredictable.
  6089. ---
  6090. --- Note that the only effect of 'ruler' when this option is set (and
  6091. --- 'laststatus' is 2 or 3) is controlling the output of `CTRL-G`.
  6092. ---
  6093. --- field meaning ~
  6094. --- - Left justify the item. The default is right justified
  6095. --- when minwid is larger than the length of the item.
  6096. --- 0 Leading zeroes in numeric items. Overridden by "-".
  6097. --- minwid Minimum width of the item, padding as set by "-" & "0".
  6098. --- Value must be 50 or less.
  6099. --- maxwid Maximum width of the item. Truncation occurs with a "<"
  6100. --- on the left for text items. Numeric items will be
  6101. --- shifted down to maxwid-2 digits followed by ">"number
  6102. --- where number is the amount of missing digits, much like
  6103. --- an exponential notation.
  6104. --- item A one letter code as described below.
  6105. ---
  6106. --- Following is a description of the possible statusline items. The
  6107. --- second character in "item" is the type:
  6108. --- N for number
  6109. --- S for string
  6110. --- F for flags as described below
  6111. --- - not applicable
  6112. ---
  6113. --- item meaning ~
  6114. --- f S Path to the file in the buffer, as typed or relative to current
  6115. --- directory.
  6116. --- F S Full path to the file in the buffer.
  6117. --- t S File name (tail) of file in the buffer.
  6118. --- m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
  6119. --- M F Modified flag, text is ",+" or ",-".
  6120. --- r F Readonly flag, text is "[RO]".
  6121. --- R F Readonly flag, text is ",RO".
  6122. --- h F Help buffer flag, text is "[help]".
  6123. --- H F Help buffer flag, text is ",HLP".
  6124. --- w F Preview window flag, text is "[Preview]".
  6125. --- W F Preview window flag, text is ",PRV".
  6126. --- y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
  6127. --- Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
  6128. --- q S "[Quickfix List]", "[Location List]" or empty.
  6129. --- k S Value of "b:keymap_name" or 'keymap' when `:lmap` mappings are
  6130. --- being used: "<keymap>"
  6131. --- n N Buffer number.
  6132. --- b N Value of character under cursor.
  6133. --- B N As above, in hexadecimal.
  6134. --- o N Byte number in file of byte under cursor, first byte is 1.
  6135. --- Mnemonic: Offset from start of file (with one added)
  6136. --- O N As above, in hexadecimal.
  6137. --- l N Line number.
  6138. --- L N Number of lines in buffer.
  6139. --- c N Column number (byte index).
  6140. --- v N Virtual column number (screen column).
  6141. --- V N Virtual column number as -{num}. Not displayed if equal to 'c'.
  6142. --- p N Percentage through file in lines as in `CTRL-G`.
  6143. --- P S Percentage through file of displayed window. This is like the
  6144. --- percentage described for 'ruler'. Always 3 in length, unless
  6145. --- translated.
  6146. --- S S 'showcmd' content, see 'showcmdloc'.
  6147. --- a S Argument list status as in default title. ({current} of {max})
  6148. --- Empty if the argument file count is zero or one.
  6149. --- { NF Evaluate expression between "%{" and "}" and substitute result.
  6150. --- Note that there is no "%" before the closing "}". The
  6151. --- expression cannot contain a "}" character, call a function to
  6152. --- work around that. See `stl-%{` below.
  6153. --- `{%` - This is almost same as "{" except the result of the expression is
  6154. --- re-evaluated as a statusline format string. Thus if the
  6155. --- return value of expr contains "%" items they will get expanded.
  6156. --- The expression can contain the "}" character, the end of
  6157. --- expression is denoted by "%}".
  6158. --- For example:
  6159. ---
  6160. --- ```vim
  6161. --- func! Stl_filename() abort
  6162. --- return "%t"
  6163. --- endfunc
  6164. --- ```
  6165. --- `stl=%{Stl_filename()}` results in `"%t"`
  6166. --- `stl=%{%Stl_filename()%}` results in `"Name of current file"`
  6167. --- %} - End of "{%" expression
  6168. --- ( - Start of item group. Can be used for setting the width and
  6169. --- alignment of a section. Must be followed by %) somewhere.
  6170. --- ) - End of item group. No width fields allowed.
  6171. --- T N For 'tabline': start of tab page N label. Use %T or %X to end
  6172. --- the label. Clicking this label with left mouse button switches
  6173. --- to the specified tab page, while clicking it with middle mouse
  6174. --- button closes the specified tab page.
  6175. --- X N For 'tabline': start of close tab N label. Use %X or %T to end
  6176. --- the label, e.g.: %3Xclose%X. Use %999X for a "close current
  6177. --- tab" label. Clicking this label with left mouse button closes
  6178. --- the specified tab page.
  6179. --- @ N Start of execute function label. Use %X or %T to end the label,
  6180. --- e.g.: %10@SwitchBuffer@foo.c%X. Clicking this label runs the
  6181. --- specified function: in the example when clicking once using left
  6182. --- mouse button on "foo.c", a `SwitchBuffer(10, 1, 'l', ' ')`
  6183. --- expression will be run. The specified function receives the
  6184. --- following arguments in order:
  6185. --- 1. minwid field value or zero if no N was specified
  6186. --- 2. number of mouse clicks to detect multiple clicks
  6187. --- 3. mouse button used: "l", "r" or "m" for left, right or middle
  6188. --- button respectively; one should not rely on third argument
  6189. --- being only "l", "r" or "m": any other non-empty string value
  6190. --- that contains only ASCII lower case letters may be expected
  6191. --- for other mouse buttons
  6192. --- 4. modifiers pressed: string which contains "s" if shift
  6193. --- modifier was pressed, "c" for control, "a" for alt and "m"
  6194. --- for meta; currently if modifier is not pressed string
  6195. --- contains space instead, but one should not rely on presence
  6196. --- of spaces or specific order of modifiers: use `stridx()` to
  6197. --- test whether some modifier is present; string is guaranteed
  6198. --- to contain only ASCII letters and spaces, one letter per
  6199. --- modifier; "?" modifier may also be present, but its presence
  6200. --- is a bug that denotes that new mouse button recognition was
  6201. --- added without modifying code that reacts on mouse clicks on
  6202. --- this label.
  6203. --- Use `getmousepos()`.winid in the specified function to get the
  6204. --- corresponding window id of the clicked item.
  6205. --- \< - Where to truncate line if too long. Default is at the start.
  6206. --- No width fields allowed.
  6207. --- = - Separation point between alignment sections. Each section will
  6208. --- be separated by an equal number of spaces. With one %= what
  6209. --- comes after it will be right-aligned. With two %= there is a
  6210. --- middle part, with white space left and right of it.
  6211. --- No width fields allowed.
  6212. --- # - Set highlight group. The name must follow and then a # again.
  6213. --- Thus use %#HLname# for highlight group HLname. The same
  6214. --- highlighting is used, also for the statusline of non-current
  6215. --- windows.
  6216. --- * - Set highlight group to User{N}, where {N} is taken from the
  6217. --- minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
  6218. --- The difference between User{N} and StatusLine will be applied to
  6219. --- StatusLineNC for the statusline of non-current windows.
  6220. --- The number N must be between 1 and 9. See `hl-User1..9`
  6221. ---
  6222. --- When displaying a flag, Vim removes the leading comma, if any, when
  6223. --- that flag comes right after plaintext. This will make a nice display
  6224. --- when flags are used like in the examples below.
  6225. ---
  6226. --- When all items in a group becomes an empty string (i.e. flags that are
  6227. --- not set) and a minwid is not set for the group, the whole group will
  6228. --- become empty. This will make a group like the following disappear
  6229. --- completely from the statusline when none of the flags are set.
  6230. ---
  6231. --- ```vim
  6232. --- set statusline=...%(\ [%M%R%H]%)...
  6233. --- ```
  6234. --- Beware that an expression is evaluated each and every time the status
  6235. --- line is displayed.
  6236. --- *stl-%{* *g:actual_curbuf* *g:actual_curwin*
  6237. --- While evaluating %{} the current buffer and current window will be set
  6238. --- temporarily to that of the window (and buffer) whose statusline is
  6239. --- currently being drawn. The expression will evaluate in this context.
  6240. --- The variable "g:actual_curbuf" is set to the `bufnr()` number of the
  6241. --- real current buffer and "g:actual_curwin" to the `window-ID` of the
  6242. --- real current window. These values are strings.
  6243. ---
  6244. --- The 'statusline' option will be evaluated in the `sandbox` if set from
  6245. --- a modeline, see `sandbox-option`.
  6246. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  6247. ---
  6248. --- It is not allowed to change text or jump to another window while
  6249. --- evaluating 'statusline' `textlock`.
  6250. ---
  6251. --- If the statusline is not updated when you want it (e.g., after setting
  6252. --- a variable that's used in an expression), you can force an update by
  6253. --- using `:redrawstatus`.
  6254. ---
  6255. --- A result of all digits is regarded a number for display purposes.
  6256. --- Otherwise the result is taken as flag text and applied to the rules
  6257. --- described above.
  6258. ---
  6259. --- Watch out for errors in expressions. They may render Vim unusable!
  6260. --- If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
  6261. --- edit your vimrc or whatever with "vim --clean" to get it right.
  6262. ---
  6263. --- Examples:
  6264. --- Emulate standard status line with 'ruler' set
  6265. ---
  6266. --- ```vim
  6267. --- set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
  6268. --- ```
  6269. --- Similar, but add ASCII value of char under the cursor (like "ga")
  6270. ---
  6271. --- ```vim
  6272. --- set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
  6273. --- ```
  6274. --- Display byte count and byte value, modified flag in red.
  6275. ---
  6276. --- ```vim
  6277. --- set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
  6278. --- hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
  6279. --- ```
  6280. --- Display a ,GZ flag if a compressed file is loaded
  6281. ---
  6282. --- ```vim
  6283. --- set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
  6284. --- ```
  6285. --- In the `:autocmd`'s:
  6286. ---
  6287. --- ```vim
  6288. --- let b:gzflag = 1
  6289. --- ```
  6290. --- And:
  6291. ---
  6292. --- ```vim
  6293. --- unlet b:gzflag
  6294. --- ```
  6295. --- And define this function:
  6296. ---
  6297. --- ```vim
  6298. --- function VarExists(var, val)
  6299. --- if exists(a:var) | return a:val | else | return '' | endif
  6300. --- endfunction
  6301. --- ```
  6302. ---
  6303. ---
  6304. --- @type string
  6305. vim.o.statusline = ""
  6306. vim.o.stl = vim.o.statusline
  6307. vim.wo.statusline = vim.o.statusline
  6308. vim.wo.stl = vim.wo.statusline
  6309. vim.go.statusline = vim.o.statusline
  6310. vim.go.stl = vim.go.statusline
  6311. --- Files with these suffixes get a lower priority when multiple files
  6312. --- match a wildcard. See `suffixes`. Commas can be used to separate the
  6313. --- suffixes. Spaces after the comma are ignored. A dot is also seen as
  6314. --- the start of a suffix. To avoid a dot or comma being recognized as a
  6315. --- separator, precede it with a backslash (see `option-backslash` about
  6316. --- including spaces and backslashes).
  6317. --- See 'wildignore' for completely ignoring files.
  6318. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  6319. --- suffixes from the list. This avoids problems when a future version
  6320. --- uses another default.
  6321. ---
  6322. --- @type string
  6323. vim.o.suffixes = ".bak,~,.o,.h,.info,.swp,.obj"
  6324. vim.o.su = vim.o.suffixes
  6325. vim.go.suffixes = vim.o.suffixes
  6326. vim.go.su = vim.go.suffixes
  6327. --- Comma-separated list of suffixes, which are used when searching for a
  6328. --- file for the "gf", "[I", etc. commands. Example:
  6329. ---
  6330. --- ```vim
  6331. --- set suffixesadd=.java
  6332. --- ```
  6333. ---
  6334. ---
  6335. --- @type string
  6336. vim.o.suffixesadd = ""
  6337. vim.o.sua = vim.o.suffixesadd
  6338. vim.bo.suffixesadd = vim.o.suffixesadd
  6339. vim.bo.sua = vim.bo.suffixesadd
  6340. --- Use a swapfile for the buffer. This option can be reset when a
  6341. --- swapfile is not wanted for a specific buffer. For example, with
  6342. --- confidential information that even root must not be able to access.
  6343. --- Careful: All text will be in memory:
  6344. --- - Don't use this for big files.
  6345. --- - Recovery will be impossible!
  6346. --- A swapfile will only be present when `'updatecount'` is non-zero and
  6347. --- 'swapfile' is set.
  6348. --- When 'swapfile' is reset, the swap file for the current buffer is
  6349. --- immediately deleted. When 'swapfile' is set, and 'updatecount' is
  6350. --- non-zero, a swap file is immediately created.
  6351. --- Also see `swap-file`.
  6352. --- If you want to open a new buffer without creating a swap file for it,
  6353. --- use the `:noswapfile` modifier.
  6354. --- See 'directory' for where the swap file is created.
  6355. ---
  6356. --- This option is used together with 'bufhidden' and 'buftype' to
  6357. --- specify special kinds of buffers. See `special-buffers`.
  6358. ---
  6359. --- @type boolean
  6360. vim.o.swapfile = true
  6361. vim.o.swf = vim.o.swapfile
  6362. vim.bo.swapfile = vim.o.swapfile
  6363. vim.bo.swf = vim.bo.swapfile
  6364. --- This option controls the behavior when switching between buffers.
  6365. --- This option is checked, when
  6366. --- - jumping to errors with the `quickfix` commands (`:cc`, `:cn`, `:cp`,
  6367. --- etc.).
  6368. --- - jumping to a tag using the `:stag` command.
  6369. --- - opening a file using the `CTRL-W_f` or `CTRL-W_F` command.
  6370. --- - jumping to a buffer using a buffer split command (e.g. `:sbuffer`,
  6371. --- `:sbnext`, or `:sbrewind`).
  6372. --- Possible values (comma-separated list):
  6373. --- useopen If included, jump to the first open window in the
  6374. --- current tab page that contains the specified buffer
  6375. --- (if there is one). Otherwise: Do not examine other
  6376. --- windows.
  6377. --- usetab Like "useopen", but also consider windows in other tab
  6378. --- pages.
  6379. --- split If included, split the current window before loading
  6380. --- a buffer for a `quickfix` command that display errors.
  6381. --- Otherwise: do not split, use current window (when used
  6382. --- in the quickfix window: the previously used window or
  6383. --- split if there is no other window).
  6384. --- vsplit Just like "split" but split vertically.
  6385. --- newtab Like "split", but open a new tab page. Overrules
  6386. --- "split" when both are present.
  6387. --- uselast If included, jump to the previously used window when
  6388. --- jumping to errors with `quickfix` commands.
  6389. --- If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
  6390. --- applied to the split window.
  6391. ---
  6392. --- @type string
  6393. vim.o.switchbuf = "uselast"
  6394. vim.o.swb = vim.o.switchbuf
  6395. vim.go.switchbuf = vim.o.switchbuf
  6396. vim.go.swb = vim.go.switchbuf
  6397. --- Maximum column in which to search for syntax items. In long lines the
  6398. --- text after this column is not highlighted and following lines may not
  6399. --- be highlighted correctly, because the syntax state is cleared.
  6400. --- This helps to avoid very slow redrawing for an XML file that is one
  6401. --- long line.
  6402. --- Set to zero to remove the limit.
  6403. ---
  6404. --- @type integer
  6405. vim.o.synmaxcol = 3000
  6406. vim.o.smc = vim.o.synmaxcol
  6407. vim.bo.synmaxcol = vim.o.synmaxcol
  6408. vim.bo.smc = vim.bo.synmaxcol
  6409. --- When this option is set, the syntax with this name is loaded, unless
  6410. --- syntax highlighting has been switched off with ":syntax off".
  6411. --- Otherwise this option does not always reflect the current syntax (the
  6412. --- b:current_syntax variable does).
  6413. --- This option is most useful in a modeline, for a file which syntax is
  6414. --- not automatically recognized. Example, in an IDL file: >c
  6415. --- /* vim: set syntax=idl : */
  6416. --- ```
  6417. --- When a dot appears in the value then this separates two filetype
  6418. --- names. Example: >c
  6419. --- /* vim: set syntax=c.doxygen : */
  6420. --- ```
  6421. --- This will use the "c" syntax first, then the "doxygen" syntax.
  6422. --- Note that the second one must be prepared to be loaded as an addition,
  6423. --- otherwise it will be skipped. More than one dot may appear.
  6424. --- To switch off syntax highlighting for the current file, use:
  6425. ---
  6426. --- ```vim
  6427. --- set syntax=OFF
  6428. --- ```
  6429. --- To switch syntax highlighting on according to the current value of the
  6430. --- 'filetype' option:
  6431. ---
  6432. --- ```vim
  6433. --- set syntax=ON
  6434. --- ```
  6435. --- What actually happens when setting the 'syntax' option is that the
  6436. --- Syntax autocommand event is triggered with the value as argument.
  6437. --- This option is not copied to another buffer, independent of the 's' or
  6438. --- 'S' flag in 'cpoptions'.
  6439. --- Only alphanumeric characters, '.', '-' and '_' can be used.
  6440. ---
  6441. --- @type string
  6442. vim.o.syntax = ""
  6443. vim.o.syn = vim.o.syntax
  6444. vim.bo.syntax = vim.o.syntax
  6445. vim.bo.syn = vim.bo.syntax
  6446. --- This option controls the behavior when closing tab pages (e.g., using
  6447. --- `:tabclose`). When empty Vim goes to the next (right) tab page.
  6448. ---
  6449. --- Possible values (comma-separated list):
  6450. --- left If included, go to the previous tab page instead of
  6451. --- the next one.
  6452. --- uselast If included, go to the previously used tab page if
  6453. --- possible. This option takes precedence over the
  6454. --- others.
  6455. ---
  6456. --- @type string
  6457. vim.o.tabclose = ""
  6458. vim.o.tcl = vim.o.tabclose
  6459. vim.go.tabclose = vim.o.tabclose
  6460. vim.go.tcl = vim.go.tabclose
  6461. --- When non-empty, this option determines the content of the tab pages
  6462. --- line at the top of the Vim window. When empty Vim will use a default
  6463. --- tab pages line. See `setting-tabline` for more info.
  6464. ---
  6465. --- The tab pages line only appears as specified with the 'showtabline'
  6466. --- option and only when there is no GUI tab line. When 'e' is in
  6467. --- 'guioptions' and the GUI supports a tab line 'guitablabel' is used
  6468. --- instead. Note that the two tab pages lines are very different.
  6469. ---
  6470. --- The value is evaluated like with 'statusline'. You can use
  6471. --- `tabpagenr()`, `tabpagewinnr()` and `tabpagebuflist()` to figure out
  6472. --- the text to be displayed. Use "%1T" for the first label, "%2T" for
  6473. --- the second one, etc. Use "%X" items for closing labels.
  6474. ---
  6475. --- When changing something that is used in 'tabline' that does not
  6476. --- trigger it to be updated, use `:redrawtabline`.
  6477. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  6478. ---
  6479. --- Keep in mind that only one of the tab pages is the current one, others
  6480. --- are invisible and you can't jump to their windows.
  6481. ---
  6482. --- @type string
  6483. vim.o.tabline = ""
  6484. vim.o.tal = vim.o.tabline
  6485. vim.go.tabline = vim.o.tabline
  6486. vim.go.tal = vim.go.tabline
  6487. --- Maximum number of tab pages to be opened by the `-p` command line
  6488. --- argument or the ":tab all" command. `tabpage`
  6489. ---
  6490. --- @type integer
  6491. vim.o.tabpagemax = 50
  6492. vim.o.tpm = vim.o.tabpagemax
  6493. vim.go.tabpagemax = vim.o.tabpagemax
  6494. vim.go.tpm = vim.go.tabpagemax
  6495. --- Number of spaces that a <Tab> in the file counts for. Also see
  6496. --- the `:retab` command, and the 'softtabstop' option.
  6497. ---
  6498. --- Note: Setting 'tabstop' to any other value than 8 can make your file
  6499. --- appear wrong in many places.
  6500. --- The value must be more than 0 and less than 10000.
  6501. ---
  6502. --- There are five main ways to use tabs in Vim:
  6503. --- 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
  6504. --- (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
  6505. --- will use a mix of tabs and spaces, but typing <Tab> and <BS> will
  6506. --- behave like a tab appears every 4 (or 3) characters.
  6507. --- This is the recommended way, the file will look the same with other
  6508. --- tools and when listing it in a terminal.
  6509. --- 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
  6510. --- 'expandtab'. This way you will always insert spaces. The
  6511. --- formatting will never be messed up when 'tabstop' is changed (leave
  6512. --- it at 8 just in case). The file will be a bit larger.
  6513. --- You do need to check if no Tabs exist in the file. You can get rid
  6514. --- of them by first setting 'expandtab' and using `%retab!`, making
  6515. --- sure the value of 'tabstop' is set correctly.
  6516. --- 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
  6517. --- 'expandtab'. This way you will always insert spaces. The
  6518. --- formatting will never be messed up when 'tabstop' is changed.
  6519. --- You do need to check if no Tabs exist in the file, just like in the
  6520. --- item just above.
  6521. --- 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
  6522. --- `modeline` to set these values when editing the file again. Only
  6523. --- works when using Vim to edit the file, other tools assume a tabstop
  6524. --- is worth 8 spaces.
  6525. --- 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
  6526. --- 'noexpandtab'. This should then work (for initial indents only)
  6527. --- for any tabstop setting that people use. It might be nice to have
  6528. --- tabs after the first non-blank inserted as spaces if you do this
  6529. --- though. Otherwise aligned comments will be wrong when 'tabstop' is
  6530. --- changed.
  6531. ---
  6532. --- The value of 'tabstop' will be ignored if `'vartabstop'` is set to
  6533. --- anything other than an empty string.
  6534. ---
  6535. --- @type integer
  6536. vim.o.tabstop = 8
  6537. vim.o.ts = vim.o.tabstop
  6538. vim.bo.tabstop = vim.o.tabstop
  6539. vim.bo.ts = vim.bo.tabstop
  6540. --- When searching for a tag (e.g., for the `:ta` command), Vim can either
  6541. --- use a binary search or a linear search in a tags file. Binary
  6542. --- searching makes searching for a tag a LOT faster, but a linear search
  6543. --- will find more tags if the tags file wasn't properly sorted.
  6544. --- Vim normally assumes that your tags files are sorted, or indicate that
  6545. --- they are not sorted. Only when this is not the case does the
  6546. --- 'tagbsearch' option need to be switched off.
  6547. ---
  6548. --- When 'tagbsearch' is on, binary searching is first used in the tags
  6549. --- files. In certain situations, Vim will do a linear search instead for
  6550. --- certain files, or retry all files with a linear search. When
  6551. --- 'tagbsearch' is off, only a linear search is done.
  6552. ---
  6553. --- Linear searching is done anyway, for one file, when Vim finds a line
  6554. --- at the start of the file indicating that it's not sorted:
  6555. --- ```
  6556. --- !_TAG_FILE_SORTED 0 /some comment/
  6557. --- ```
  6558. --- [The whitespace before and after the '0' must be a single <Tab>]
  6559. ---
  6560. --- When a binary search was done and no match was found in any of the
  6561. --- files listed in 'tags', and case is ignored or a pattern is used
  6562. --- instead of a normal tag name, a retry is done with a linear search.
  6563. --- Tags in unsorted tags files, and matches with different case will only
  6564. --- be found in the retry.
  6565. ---
  6566. --- If a tag file indicates that it is case-fold sorted, the second,
  6567. --- linear search can be avoided when case is ignored. Use a value of '2'
  6568. --- in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
  6569. --- sorted with the -f switch to "sort" in most unices, as in the command:
  6570. --- "sort -f -o tags tags". For Universal ctags and Exuberant ctags
  6571. --- version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
  6572. --- used for this as well. Note that case must be folded to uppercase for
  6573. --- this to work.
  6574. ---
  6575. --- By default, tag searches are case-sensitive. Case is ignored when
  6576. --- 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
  6577. --- "ignore".
  6578. --- Also when 'tagcase' is "followscs" and 'smartcase' is set, or
  6579. --- 'tagcase' is "smart", and the pattern contains only lowercase
  6580. --- characters.
  6581. ---
  6582. --- When 'tagbsearch' is off, tags searching is slower when a full match
  6583. --- exists, but faster when no full match exists. Tags in unsorted tags
  6584. --- files may only be found with 'tagbsearch' off.
  6585. --- When the tags file is not sorted, or sorted in a wrong way (not on
  6586. --- ASCII byte value), 'tagbsearch' should be off, or the line given above
  6587. --- must be included in the tags file.
  6588. --- This option doesn't affect commands that find all matching tags (e.g.,
  6589. --- command-line completion and ":help").
  6590. ---
  6591. --- @type boolean
  6592. vim.o.tagbsearch = true
  6593. vim.o.tbs = vim.o.tagbsearch
  6594. vim.go.tagbsearch = vim.o.tagbsearch
  6595. vim.go.tbs = vim.go.tagbsearch
  6596. --- This option specifies how case is handled when searching the tags
  6597. --- file:
  6598. --- followic Follow the 'ignorecase' option
  6599. --- followscs Follow the 'smartcase' and 'ignorecase' options
  6600. --- ignore Ignore case
  6601. --- match Match case
  6602. --- smart Ignore case unless an upper case letter is used
  6603. ---
  6604. --- @type string
  6605. vim.o.tagcase = "followic"
  6606. vim.o.tc = vim.o.tagcase
  6607. vim.bo.tagcase = vim.o.tagcase
  6608. vim.bo.tc = vim.bo.tagcase
  6609. vim.go.tagcase = vim.o.tagcase
  6610. vim.go.tc = vim.go.tagcase
  6611. --- This option specifies a function to be used to perform tag searches.
  6612. --- The function gets the tag pattern and should return a List of matching
  6613. --- tags. See `tag-function` for an explanation of how to write the
  6614. --- function and an example. The value can be the name of a function, a
  6615. --- `lambda` or a `Funcref`. See `option-value-function` for more
  6616. --- information.
  6617. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6618. --- security reasons.
  6619. ---
  6620. --- @type string
  6621. vim.o.tagfunc = ""
  6622. vim.o.tfu = vim.o.tagfunc
  6623. vim.bo.tagfunc = vim.o.tagfunc
  6624. vim.bo.tfu = vim.bo.tagfunc
  6625. --- If non-zero, tags are significant up to this number of characters.
  6626. ---
  6627. --- @type integer
  6628. vim.o.taglength = 0
  6629. vim.o.tl = vim.o.taglength
  6630. vim.go.taglength = vim.o.taglength
  6631. vim.go.tl = vim.go.taglength
  6632. --- If on and using a tags file in another directory, file names in that
  6633. --- tags file are relative to the directory where the tags file is.
  6634. ---
  6635. --- @type boolean
  6636. vim.o.tagrelative = true
  6637. vim.o.tr = vim.o.tagrelative
  6638. vim.go.tagrelative = vim.o.tagrelative
  6639. vim.go.tr = vim.go.tagrelative
  6640. --- Filenames for the tag command, separated by spaces or commas. To
  6641. --- include a space or comma in a file name, precede it with backslashes
  6642. --- (see `option-backslash` about including spaces/commas and backslashes).
  6643. --- When a file name starts with "./", the '.' is replaced with the path
  6644. --- of the current file. But only when the 'd' flag is not included in
  6645. --- 'cpoptions'. Environment variables are expanded `:set_env`. Also see
  6646. --- `tags-option`.
  6647. --- "*", "**" and other wildcards can be used to search for tags files in
  6648. --- a directory tree. See `file-searching`. E.g., "/lib/**/tags" will
  6649. --- find all files named "tags" below "/lib". The filename itself cannot
  6650. --- contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
  6651. --- files called "tags?".
  6652. --- The `tagfiles()` function can be used to get a list of the file names
  6653. --- actually used.
  6654. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  6655. --- file names from the list. This avoids problems when a future version
  6656. --- uses another default.
  6657. ---
  6658. --- @type string
  6659. vim.o.tags = "./tags;,tags"
  6660. vim.o.tag = vim.o.tags
  6661. vim.bo.tags = vim.o.tags
  6662. vim.bo.tag = vim.bo.tags
  6663. vim.go.tags = vim.o.tags
  6664. vim.go.tag = vim.go.tags
  6665. --- When on, the `tagstack` is used normally. When off, a ":tag" or
  6666. --- ":tselect" command with an argument will not push the tag onto the
  6667. --- tagstack. A following ":tag" without an argument, a ":pop" command or
  6668. --- any other command that uses the tagstack will use the unmodified
  6669. --- tagstack, but does change the pointer to the active entry.
  6670. --- Resetting this option is useful when using a ":tag" command in a
  6671. --- mapping which should not change the tagstack.
  6672. ---
  6673. --- @type boolean
  6674. vim.o.tagstack = true
  6675. vim.o.tgst = vim.o.tagstack
  6676. vim.go.tagstack = vim.o.tagstack
  6677. vim.go.tgst = vim.go.tagstack
  6678. --- The terminal is in charge of Bi-directionality of text (as specified
  6679. --- by Unicode). The terminal is also expected to do the required shaping
  6680. --- that some languages (such as Arabic) require.
  6681. --- Setting this option implies that 'rightleft' will not be set when
  6682. --- 'arabic' is set and the value of 'arabicshape' will be ignored.
  6683. --- Note that setting 'termbidi' has the immediate effect that
  6684. --- 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
  6685. --- For further details see `arabic.txt`.
  6686. ---
  6687. --- @type boolean
  6688. vim.o.termbidi = false
  6689. vim.o.tbidi = vim.o.termbidi
  6690. vim.go.termbidi = vim.o.termbidi
  6691. vim.go.tbidi = vim.go.termbidi
  6692. --- Enables 24-bit RGB color in the `TUI`. Uses "gui" `:highlight`
  6693. --- attributes instead of "cterm" attributes. `guifg`
  6694. --- Requires an ISO-8613-3 compatible terminal.
  6695. ---
  6696. --- Nvim will automatically attempt to determine if the host terminal
  6697. --- supports 24-bit color and will enable this option if it does
  6698. --- (unless explicitly disabled by the user).
  6699. ---
  6700. --- @type boolean
  6701. vim.o.termguicolors = false
  6702. vim.o.tgc = vim.o.termguicolors
  6703. vim.go.termguicolors = vim.o.termguicolors
  6704. vim.go.tgc = vim.go.termguicolors
  6705. --- A comma-separated list of options for specifying control characters
  6706. --- to be removed from the text pasted into the terminal window. The
  6707. --- supported values are:
  6708. ---
  6709. --- BS Backspace
  6710. ---
  6711. --- HT TAB
  6712. ---
  6713. --- FF Form feed
  6714. ---
  6715. --- ESC Escape
  6716. ---
  6717. --- DEL DEL
  6718. ---
  6719. --- C0 Other control characters, excluding Line feed and
  6720. --- Carriage return < ' '
  6721. ---
  6722. --- C1 Control characters 0x80...0x9F
  6723. ---
  6724. --- @type string
  6725. vim.o.termpastefilter = "BS,HT,ESC,DEL"
  6726. vim.o.tpf = vim.o.termpastefilter
  6727. vim.go.termpastefilter = vim.o.termpastefilter
  6728. vim.go.tpf = vim.go.termpastefilter
  6729. --- If the host terminal supports it, buffer all screen updates
  6730. --- made during a redraw cycle so that each screen is displayed in
  6731. --- the terminal all at once. This can prevent tearing or flickering
  6732. --- when the terminal updates faster than Nvim can redraw.
  6733. ---
  6734. --- @type boolean
  6735. vim.o.termsync = true
  6736. vim.go.termsync = vim.o.termsync
  6737. --- Maximum width of text that is being inserted. A longer line will be
  6738. --- broken after white space to get this width. A zero value disables
  6739. --- this.
  6740. --- When 'textwidth' is zero, 'wrapmargin' may be used. See also
  6741. --- 'formatoptions' and `ins-textwidth`.
  6742. --- When 'formatexpr' is set it will be used to break the line.
  6743. ---
  6744. --- @type integer
  6745. vim.o.textwidth = 0
  6746. vim.o.tw = vim.o.textwidth
  6747. vim.bo.textwidth = vim.o.textwidth
  6748. vim.bo.tw = vim.bo.textwidth
  6749. --- List of file names, separated by commas, that are used to lookup words
  6750. --- for thesaurus completion commands `i_CTRL-X_CTRL-T`. See
  6751. --- `compl-thesaurus`.
  6752. ---
  6753. --- This option is not used if 'thesaurusfunc' is set, either for the
  6754. --- buffer or globally.
  6755. ---
  6756. --- To include a comma in a file name precede it with a backslash. Spaces
  6757. --- after a comma are ignored, otherwise spaces are included in the file
  6758. --- name. See `option-backslash` about using backslashes. The use of
  6759. --- `:set+=` and `:set-=` is preferred when adding or removing directories
  6760. --- from the list. This avoids problems when a future version uses
  6761. --- another default. Backticks cannot be used in this option for security
  6762. --- reasons.
  6763. ---
  6764. --- @type string
  6765. vim.o.thesaurus = ""
  6766. vim.o.tsr = vim.o.thesaurus
  6767. vim.bo.thesaurus = vim.o.thesaurus
  6768. vim.bo.tsr = vim.bo.thesaurus
  6769. vim.go.thesaurus = vim.o.thesaurus
  6770. vim.go.tsr = vim.go.thesaurus
  6771. --- This option specifies a function to be used for thesaurus completion
  6772. --- with CTRL-X CTRL-T. `i_CTRL-X_CTRL-T` See `compl-thesaurusfunc`.
  6773. --- The value can be the name of a function, a `lambda` or a `Funcref`.
  6774. --- See `option-value-function` for more information.
  6775. ---
  6776. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6777. --- security reasons.
  6778. ---
  6779. --- @type string
  6780. vim.o.thesaurusfunc = ""
  6781. vim.o.tsrfu = vim.o.thesaurusfunc
  6782. vim.bo.thesaurusfunc = vim.o.thesaurusfunc
  6783. vim.bo.tsrfu = vim.bo.thesaurusfunc
  6784. vim.go.thesaurusfunc = vim.o.thesaurusfunc
  6785. vim.go.tsrfu = vim.go.thesaurusfunc
  6786. --- When on: The tilde command "~" behaves like an operator.
  6787. ---
  6788. --- @type boolean
  6789. vim.o.tildeop = false
  6790. vim.o.top = vim.o.tildeop
  6791. vim.go.tildeop = vim.o.tildeop
  6792. vim.go.top = vim.go.tildeop
  6793. --- This option and 'timeoutlen' determine the behavior when part of a
  6794. --- mapped key sequence has been received. For example, if <c-f> is
  6795. --- pressed and 'timeout' is set, Nvim will wait 'timeoutlen' milliseconds
  6796. --- for any key that can follow <c-f> in a mapping.
  6797. ---
  6798. --- @type boolean
  6799. vim.o.timeout = true
  6800. vim.o.to = vim.o.timeout
  6801. vim.go.timeout = vim.o.timeout
  6802. vim.go.to = vim.go.timeout
  6803. --- Time in milliseconds to wait for a mapped sequence to complete.
  6804. ---
  6805. --- @type integer
  6806. vim.o.timeoutlen = 1000
  6807. vim.o.tm = vim.o.timeoutlen
  6808. vim.go.timeoutlen = vim.o.timeoutlen
  6809. vim.go.tm = vim.go.timeoutlen
  6810. --- When on, the title of the window will be set to the value of
  6811. --- 'titlestring' (if it is not empty), or to:
  6812. --- filename [+=-] (path) - Nvim
  6813. --- Where:
  6814. --- filename the name of the file being edited
  6815. --- - indicates the file cannot be modified, 'ma' off
  6816. --- + indicates the file was modified
  6817. --- = indicates the file is read-only
  6818. --- =+ indicates the file is read-only and modified
  6819. --- (path) is the path of the file being edited
  6820. --- - Nvim the server name `v:servername` or "Nvim"
  6821. ---
  6822. --- @type boolean
  6823. vim.o.title = false
  6824. vim.go.title = vim.o.title
  6825. --- Gives the percentage of 'columns' to use for the length of the window
  6826. --- title. When the title is longer, only the end of the path name is
  6827. --- shown. A '<' character before the path name is used to indicate this.
  6828. --- Using a percentage makes this adapt to the width of the window. But
  6829. --- it won't work perfectly, because the actual number of characters
  6830. --- available also depends on the font used and other things in the title
  6831. --- bar. When 'titlelen' is zero the full path is used. Otherwise,
  6832. --- values from 1 to 30000 percent can be used.
  6833. --- 'titlelen' is also used for the 'titlestring' option.
  6834. ---
  6835. --- @type integer
  6836. vim.o.titlelen = 85
  6837. vim.go.titlelen = vim.o.titlelen
  6838. --- If not empty, this option will be used to set the window title when
  6839. --- exiting. Only if 'title' is enabled.
  6840. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6841. --- security reasons.
  6842. ---
  6843. --- @type string
  6844. vim.o.titleold = ""
  6845. vim.go.titleold = vim.o.titleold
  6846. --- When this option is not empty, it will be used for the title of the
  6847. --- window. This happens only when the 'title' option is on.
  6848. ---
  6849. --- When this option contains printf-style '%' items, they will be
  6850. --- expanded according to the rules used for 'statusline'. If it contains
  6851. --- an invalid '%' format, the value is used as-is and no error or warning
  6852. --- will be given when the value is set.
  6853. ---
  6854. --- The default behaviour is equivalent to:
  6855. ---
  6856. --- ```vim
  6857. --- set titlestring=%t%(\ %M%)%(\ \(%{expand(\"%:~:h\")}\)%)%a\ -\ Nvim
  6858. --- ```
  6859. ---
  6860. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  6861. ---
  6862. --- Example:
  6863. ---
  6864. --- ```vim
  6865. --- auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
  6866. --- set title titlestring=%<%F%=%l/%L-%P titlelen=70
  6867. --- ```
  6868. --- The value of 'titlelen' is used to align items in the middle or right
  6869. --- of the available space.
  6870. --- Some people prefer to have the file name first:
  6871. ---
  6872. --- ```vim
  6873. --- set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
  6874. --- ```
  6875. --- Note the use of "%{ }" and an expression to get the path of the file,
  6876. --- without the file name. The "%( %)" constructs are used to add a
  6877. --- separating space only when needed.
  6878. --- NOTE: Use of special characters in 'titlestring' may cause the display
  6879. --- to be garbled (e.g., when it contains a CR or NL character).
  6880. ---
  6881. --- @type string
  6882. vim.o.titlestring = ""
  6883. vim.go.titlestring = vim.o.titlestring
  6884. --- This option and 'ttimeoutlen' determine the behavior when part of a
  6885. --- key code sequence has been received by the `TUI`.
  6886. ---
  6887. --- For example if <Esc> (the \x1b byte) is received and 'ttimeout' is
  6888. --- set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to
  6889. --- complete a key code sequence. If no input arrives before the timeout,
  6890. --- a single <Esc> is assumed. Many TUI cursor key codes start with <Esc>.
  6891. ---
  6892. --- On very slow systems this may fail, causing cursor keys not to work
  6893. --- sometimes. If you discover this problem you can ":set ttimeoutlen=9999".
  6894. --- Nvim will wait for the next character to arrive after an <Esc>.
  6895. ---
  6896. --- @type boolean
  6897. vim.o.ttimeout = true
  6898. vim.go.ttimeout = vim.o.ttimeout
  6899. --- Time in milliseconds to wait for a key code sequence to complete. Also
  6900. --- used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has
  6901. --- been typed.
  6902. ---
  6903. --- @type integer
  6904. vim.o.ttimeoutlen = 50
  6905. vim.o.ttm = vim.o.ttimeoutlen
  6906. vim.go.ttimeoutlen = vim.o.ttimeoutlen
  6907. vim.go.ttm = vim.go.ttimeoutlen
  6908. --- List of directory names for undo files, separated with commas.
  6909. --- See 'backupdir' for details of the format.
  6910. --- "." means using the directory of the file. The undo file name for
  6911. --- "file.txt" is ".file.txt.un~".
  6912. --- For other directories the file name is the full path of the edited
  6913. --- file, with path separators replaced with "%".
  6914. --- When writing: The first directory that exists is used. "." always
  6915. --- works, no directories after "." will be used for writing. If none of
  6916. --- the directories exist Nvim will attempt to create the last directory in
  6917. --- the list.
  6918. --- When reading all entries are tried to find an undo file. The first
  6919. --- undo file that exists is used. When it cannot be read an error is
  6920. --- given, no further entry is used.
  6921. --- See `undo-persistence`.
  6922. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  6923. --- security reasons.
  6924. ---
  6925. --- Note that unlike 'directory' and 'backupdir', 'undodir' always acts as
  6926. --- though the trailing slashes are present (see 'backupdir' for what this
  6927. --- means).
  6928. ---
  6929. --- @type string
  6930. vim.o.undodir = "$XDG_STATE_HOME/nvim/undo//"
  6931. vim.o.udir = vim.o.undodir
  6932. vim.go.undodir = vim.o.undodir
  6933. vim.go.udir = vim.go.undodir
  6934. --- When on, Vim automatically saves undo history to an undo file when
  6935. --- writing a buffer to a file, and restores undo history from the same
  6936. --- file on buffer read.
  6937. --- The directory where the undo file is stored is specified by 'undodir'.
  6938. --- For more information about this feature see `undo-persistence`.
  6939. --- The undo file is not read when 'undoreload' causes the buffer from
  6940. --- before a reload to be saved for undo.
  6941. --- When 'undofile' is turned off the undo file is NOT deleted.
  6942. ---
  6943. --- @type boolean
  6944. vim.o.undofile = false
  6945. vim.o.udf = vim.o.undofile
  6946. vim.bo.undofile = vim.o.undofile
  6947. vim.bo.udf = vim.bo.undofile
  6948. --- Maximum number of changes that can be undone. Since undo information
  6949. --- is kept in memory, higher numbers will cause more memory to be used.
  6950. --- Nevertheless, a single change can already use a large amount of memory.
  6951. --- Set to 0 for Vi compatibility: One level of undo and "u" undoes
  6952. --- itself:
  6953. ---
  6954. --- ```vim
  6955. --- set ul=0
  6956. --- ```
  6957. --- But you can also get Vi compatibility by including the 'u' flag in
  6958. --- 'cpoptions', and still be able to use CTRL-R to repeat undo.
  6959. --- Also see `undo-two-ways`.
  6960. --- Set to -1 for no undo at all. You might want to do this only for the
  6961. --- current buffer:
  6962. ---
  6963. --- ```vim
  6964. --- setlocal ul=-1
  6965. --- ```
  6966. --- This helps when you run out of memory for a single change.
  6967. ---
  6968. --- The local value is set to -123456 when the global value is to be used.
  6969. ---
  6970. --- Also see `clear-undo`.
  6971. ---
  6972. --- @type integer
  6973. vim.o.undolevels = 1000
  6974. vim.o.ul = vim.o.undolevels
  6975. vim.bo.undolevels = vim.o.undolevels
  6976. vim.bo.ul = vim.bo.undolevels
  6977. vim.go.undolevels = vim.o.undolevels
  6978. vim.go.ul = vim.go.undolevels
  6979. --- Save the whole buffer for undo when reloading it. This applies to the
  6980. --- ":e!" command and reloading for when the buffer changed outside of
  6981. --- Vim. `FileChangedShell`
  6982. --- The save only happens when this option is negative or when the number
  6983. --- of lines is smaller than the value of this option.
  6984. --- Set this option to zero to disable undo for a reload.
  6985. ---
  6986. --- When saving undo for a reload, any undo file is not read.
  6987. ---
  6988. --- Note that this causes the whole buffer to be stored in memory. Set
  6989. --- this option to a lower value if you run out of memory.
  6990. ---
  6991. --- @type integer
  6992. vim.o.undoreload = 10000
  6993. vim.o.ur = vim.o.undoreload
  6994. vim.go.undoreload = vim.o.undoreload
  6995. vim.go.ur = vim.go.undoreload
  6996. --- After typing this many characters the swap file will be written to
  6997. --- disk. When zero, no swap file will be created at all (see chapter on
  6998. --- recovery `crash-recovery`). 'updatecount' is set to zero by starting
  6999. --- Vim with the "-n" option, see `startup`. When editing in readonly
  7000. --- mode this option will be initialized to 10000.
  7001. --- The swapfile can be disabled per buffer with `'swapfile'`.
  7002. --- When 'updatecount' is set from zero to non-zero, swap files are
  7003. --- created for all buffers that have 'swapfile' set. When 'updatecount'
  7004. --- is set to zero, existing swap files are not deleted.
  7005. --- This option has no meaning in buffers where `'buftype'` is "nofile"
  7006. --- or "nowrite".
  7007. ---
  7008. --- @type integer
  7009. vim.o.updatecount = 200
  7010. vim.o.uc = vim.o.updatecount
  7011. vim.go.updatecount = vim.o.updatecount
  7012. vim.go.uc = vim.go.updatecount
  7013. --- If this many milliseconds nothing is typed the swap file will be
  7014. --- written to disk (see `crash-recovery`). Also used for the
  7015. --- `CursorHold` autocommand event.
  7016. ---
  7017. --- @type integer
  7018. vim.o.updatetime = 4000
  7019. vim.o.ut = vim.o.updatetime
  7020. vim.go.updatetime = vim.o.updatetime
  7021. vim.go.ut = vim.go.updatetime
  7022. --- A list of the number of spaces that a <Tab> counts for while editing,
  7023. --- such as inserting a <Tab> or using <BS>. It "feels" like variable-
  7024. --- width <Tab>s are being inserted, while in fact a mixture of spaces
  7025. --- and <Tab>s is used. Tab widths are separated with commas, with the
  7026. --- final value applying to all subsequent tabs.
  7027. ---
  7028. --- For example, when editing assembly language files where statements
  7029. --- start in the 9th column and comments in the 41st, it may be useful
  7030. --- to use the following:
  7031. ---
  7032. --- ```vim
  7033. --- set varsofttabstop=8,32,8
  7034. --- ```
  7035. --- This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
  7036. --- for every column thereafter.
  7037. ---
  7038. --- Note that the value of `'softtabstop'` will be ignored while
  7039. --- 'varsofttabstop' is set.
  7040. ---
  7041. --- @type string
  7042. vim.o.varsofttabstop = ""
  7043. vim.o.vsts = vim.o.varsofttabstop
  7044. vim.bo.varsofttabstop = vim.o.varsofttabstop
  7045. vim.bo.vsts = vim.bo.varsofttabstop
  7046. --- A list of the number of spaces that a <Tab> in the file counts for,
  7047. --- separated by commas. Each value corresponds to one tab, with the
  7048. --- final value applying to all subsequent tabs. For example:
  7049. ---
  7050. --- ```vim
  7051. --- set vartabstop=4,20,10,8
  7052. --- ```
  7053. --- This will make the first tab 4 spaces wide, the second 20 spaces,
  7054. --- the third 10 spaces, and all following tabs 8 spaces.
  7055. ---
  7056. --- Note that the value of `'tabstop'` will be ignored while 'vartabstop'
  7057. --- is set.
  7058. ---
  7059. --- @type string
  7060. vim.o.vartabstop = ""
  7061. vim.o.vts = vim.o.vartabstop
  7062. vim.bo.vartabstop = vim.o.vartabstop
  7063. vim.bo.vts = vim.bo.vartabstop
  7064. --- Sets the verbosity level. Also set by `-V` and `:verbose`.
  7065. ---
  7066. --- Tracing of assignments to options, mappings, etc. in Lua scripts is
  7067. --- enabled at level 1; Lua scripts are not traced when 'verbose' is 0,
  7068. --- for performance.
  7069. ---
  7070. --- If greater than or equal to a given level, Nvim produces the following
  7071. --- messages:
  7072. ---
  7073. --- Level Messages ~
  7074. --- ----------------------------------------------------------------------
  7075. --- 1 Enables Lua tracing (see above). Does not produce messages.
  7076. --- 2 When a file is ":source"'ed, or `shada` file is read or written.
  7077. --- 3 UI info, terminal capabilities.
  7078. --- 4 Shell commands.
  7079. --- 5 Every searched tags file and include file.
  7080. --- 8 Files for which a group of autocommands is executed.
  7081. --- 9 Executed autocommands.
  7082. --- 11 Finding items in a path.
  7083. --- 12 Vimscript function calls.
  7084. --- 13 When an exception is thrown, caught, finished, or discarded.
  7085. --- 14 Anything pending in a ":finally" clause.
  7086. --- 15 Ex commands from a script (truncated at 200 characters).
  7087. --- 16 Ex commands.
  7088. ---
  7089. --- If 'verbosefile' is set then the verbose messages are not displayed.
  7090. ---
  7091. --- @type integer
  7092. vim.o.verbose = 0
  7093. vim.o.vbs = vim.o.verbose
  7094. vim.go.verbose = vim.o.verbose
  7095. vim.go.vbs = vim.go.verbose
  7096. --- When not empty all messages are written in a file with this name.
  7097. --- When the file exists messages are appended.
  7098. --- Writing to the file ends when Vim exits or when 'verbosefile' is made
  7099. --- empty. Writes are buffered, thus may not show up for some time.
  7100. --- Setting 'verbosefile' to a new value is like making it empty first.
  7101. --- The difference with `:redir` is that verbose messages are not
  7102. --- displayed when 'verbosefile' is set.
  7103. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  7104. --- security reasons.
  7105. ---
  7106. --- @type string
  7107. vim.o.verbosefile = ""
  7108. vim.o.vfile = vim.o.verbosefile
  7109. vim.go.verbosefile = vim.o.verbosefile
  7110. vim.go.vfile = vim.go.verbosefile
  7111. --- Name of the directory where to store files for `:mkview`.
  7112. --- This option cannot be set from a `modeline` or in the `sandbox`, for
  7113. --- security reasons.
  7114. ---
  7115. --- @type string
  7116. vim.o.viewdir = "$XDG_STATE_HOME/nvim/view//"
  7117. vim.o.vdir = vim.o.viewdir
  7118. vim.go.viewdir = vim.o.viewdir
  7119. vim.go.vdir = vim.go.viewdir
  7120. --- Changes the effect of the `:mkview` command. It is a comma-separated
  7121. --- list of words. Each word enables saving and restoring something:
  7122. --- word save and restore ~
  7123. --- cursor cursor position in file and in window
  7124. --- curdir local current directory, if set with `:lcd`
  7125. --- folds manually created folds, opened/closed folds and local
  7126. --- fold options
  7127. --- options options and mappings local to a window or buffer (not
  7128. --- global values for local options)
  7129. --- localoptions same as "options"
  7130. --- slash `deprecated` Always enabled. Uses "/" in filenames.
  7131. --- unix `deprecated` Always enabled. Uses "\n" line endings.
  7132. ---
  7133. --- @type string
  7134. vim.o.viewoptions = "folds,cursor,curdir"
  7135. vim.o.vop = vim.o.viewoptions
  7136. vim.go.viewoptions = vim.o.viewoptions
  7137. vim.go.vop = vim.go.viewoptions
  7138. --- A comma-separated list of these words:
  7139. --- block Allow virtual editing in Visual block mode.
  7140. --- insert Allow virtual editing in Insert mode.
  7141. --- all Allow virtual editing in all modes.
  7142. --- onemore Allow the cursor to move just past the end of the line
  7143. --- none When used as the local value, do not allow virtual
  7144. --- editing even when the global value is set. When used
  7145. --- as the global value, "none" is the same as "".
  7146. --- NONE Alternative spelling of "none".
  7147. ---
  7148. --- Virtual editing means that the cursor can be positioned where there is
  7149. --- no actual character. This can be halfway into a tab or beyond the end
  7150. --- of the line. Useful for selecting a rectangle in Visual mode and
  7151. --- editing a table.
  7152. --- "onemore" is not the same, it will only allow moving the cursor just
  7153. --- after the last character of the line. This makes some commands more
  7154. --- consistent. Previously the cursor was always past the end of the line
  7155. --- if the line was empty. But it is far from Vi compatible. It may also
  7156. --- break some plugins or Vim scripts. For example because `l` can move
  7157. --- the cursor after the last character. Use with care!
  7158. --- Using the `$` command will move to the last character in the line, not
  7159. --- past it. This may actually move the cursor to the left!
  7160. --- The `g$` command will move to the end of the screen line.
  7161. --- It doesn't make sense to combine "all" with "onemore", but you will
  7162. --- not get a warning for it.
  7163. --- When combined with other words, "none" is ignored.
  7164. ---
  7165. --- @type string
  7166. vim.o.virtualedit = ""
  7167. vim.o.ve = vim.o.virtualedit
  7168. vim.wo.virtualedit = vim.o.virtualedit
  7169. vim.wo.ve = vim.wo.virtualedit
  7170. vim.go.virtualedit = vim.o.virtualedit
  7171. vim.go.ve = vim.go.virtualedit
  7172. --- Use visual bell instead of beeping. Also see 'errorbells'.
  7173. ---
  7174. --- @type boolean
  7175. vim.o.visualbell = false
  7176. vim.o.vb = vim.o.visualbell
  7177. vim.go.visualbell = vim.o.visualbell
  7178. vim.go.vb = vim.go.visualbell
  7179. --- Give a warning message when a shell command is used while the buffer
  7180. --- has been changed.
  7181. ---
  7182. --- @type boolean
  7183. vim.o.warn = true
  7184. vim.go.warn = vim.o.warn
  7185. --- Allow specified keys that move the cursor left/right to move to the
  7186. --- previous/next line when the cursor is on the first/last character in
  7187. --- the line. Concatenate characters to allow this for these keys:
  7188. --- char key mode ~
  7189. --- b <BS> Normal and Visual
  7190. --- s <Space> Normal and Visual
  7191. --- h "h" Normal and Visual (not recommended)
  7192. --- l "l" Normal and Visual (not recommended)
  7193. --- < <Left> Normal and Visual
  7194. --- > <Right> Normal and Visual
  7195. --- ~ "~" Normal
  7196. --- [ <Left> Insert and Replace
  7197. --- ] <Right> Insert and Replace
  7198. --- For example:
  7199. ---
  7200. --- ```vim
  7201. --- set ww=<,>,[,]
  7202. --- ```
  7203. --- allows wrap only when cursor keys are used.
  7204. --- When the movement keys are used in combination with a delete or change
  7205. --- operator, the <EOL> also counts for a character. This makes "3h"
  7206. --- different from "3dh" when the cursor crosses the end of a line. This
  7207. --- is also true for "x" and "X", because they do the same as "dl" and
  7208. --- "dh". If you use this, you may also want to use the mapping
  7209. --- ":map <BS> X" to make backspace delete the character in front of the
  7210. --- cursor.
  7211. --- When 'l' is included and it is used after an operator at the end of a
  7212. --- line (not an empty line) then it will not move to the next line. This
  7213. --- makes "dl", "cl", "yl" etc. work normally.
  7214. ---
  7215. --- @type string
  7216. vim.o.whichwrap = "b,s"
  7217. vim.o.ww = vim.o.whichwrap
  7218. vim.go.whichwrap = vim.o.whichwrap
  7219. vim.go.ww = vim.go.whichwrap
  7220. --- Character you have to type to start wildcard expansion in the
  7221. --- command-line, as specified with 'wildmode'.
  7222. --- More info here: `cmdline-completion`.
  7223. --- The character is not recognized when used inside a macro. See
  7224. --- 'wildcharm' for that.
  7225. --- Some keys will not work, such as CTRL-C, <CR> and Enter.
  7226. --- <Esc> can be used, but hitting it twice in a row will still exit
  7227. --- command-line as a failsafe measure.
  7228. --- Although 'wc' is a number option, it can be specified as a number, a
  7229. --- single character, a `key-notation` (e.g. <Up>, <C-F>) or a letter
  7230. --- preceded with a caret (e.g. `^F` is CTRL-F):
  7231. ---
  7232. --- ```vim
  7233. --- :set wc=27
  7234. --- :set wc=X
  7235. --- :set wc=^I
  7236. --- set wc=<Tab>
  7237. --- ```
  7238. ---
  7239. ---
  7240. --- @type integer
  7241. vim.o.wildchar = 9
  7242. vim.o.wc = vim.o.wildchar
  7243. vim.go.wildchar = vim.o.wildchar
  7244. vim.go.wc = vim.go.wildchar
  7245. --- 'wildcharm' works exactly like 'wildchar', except that it is
  7246. --- recognized when used inside a macro. You can find "spare" command-line
  7247. --- keys suitable for this option by looking at `ex-edit-index`. Normally
  7248. --- you'll never actually type 'wildcharm', just use it in mappings that
  7249. --- automatically invoke completion mode, e.g.:
  7250. ---
  7251. --- ```vim
  7252. --- set wcm=<C-Z>
  7253. --- cnoremap ss so $vim/sessions/*.vim<C-Z>
  7254. --- ```
  7255. --- Then after typing :ss you can use CTRL-P & CTRL-N.
  7256. ---
  7257. --- @type integer
  7258. vim.o.wildcharm = 0
  7259. vim.o.wcm = vim.o.wildcharm
  7260. vim.go.wildcharm = vim.o.wildcharm
  7261. vim.go.wcm = vim.go.wildcharm
  7262. --- A list of file patterns. A file that matches with one of these
  7263. --- patterns is ignored when expanding `wildcards`, completing file or
  7264. --- directory names, and influences the result of `expand()`, `glob()` and
  7265. --- `globpath()` unless a flag is passed to disable this.
  7266. --- The pattern is used like with `:autocmd`, see `autocmd-pattern`.
  7267. --- Also see 'suffixes'.
  7268. --- Example:
  7269. ---
  7270. --- ```vim
  7271. --- set wildignore=*.o,*.obj
  7272. --- ```
  7273. --- The use of `:set+=` and `:set-=` is preferred when adding or removing
  7274. --- a pattern from the list. This avoids problems when a future version
  7275. --- uses another default.
  7276. ---
  7277. --- @type string
  7278. vim.o.wildignore = ""
  7279. vim.o.wig = vim.o.wildignore
  7280. vim.go.wildignore = vim.o.wildignore
  7281. vim.go.wig = vim.go.wildignore
  7282. --- When set case is ignored when completing file names and directories.
  7283. --- Has no effect when 'fileignorecase' is set.
  7284. --- Does not apply when the shell is used to expand wildcards, which
  7285. --- happens when there are special characters.
  7286. ---
  7287. --- @type boolean
  7288. vim.o.wildignorecase = false
  7289. vim.o.wic = vim.o.wildignorecase
  7290. vim.go.wildignorecase = vim.o.wildignorecase
  7291. vim.go.wic = vim.go.wildignorecase
  7292. --- When 'wildmenu' is on, command-line completion operates in an enhanced
  7293. --- mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
  7294. --- the possible matches are shown.
  7295. --- When 'wildoptions' contains "pum", then the completion matches are
  7296. --- shown in a popup menu. Otherwise they are displayed just above the
  7297. --- command line, with the first match highlighted (overwriting the status
  7298. --- line, if there is one).
  7299. --- Keys that show the previous/next match, such as <Tab> or
  7300. --- CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
  7301. --- 'wildmode' must specify "full": "longest" and "list" do not start
  7302. --- 'wildmenu' mode. You can check the current mode with `wildmenumode()`.
  7303. --- The menu is cancelled when a key is hit that is not used for selecting
  7304. --- a completion.
  7305. ---
  7306. --- While the menu is active these keys have special meanings:
  7307. --- CTRL-P - go to the previous entry
  7308. --- CTRL-N - go to the next entry
  7309. --- <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
  7310. --- <PageUp> - select a match several entries back
  7311. --- <PageDown> - select a match several entries further
  7312. --- <Up> - in filename/menu name completion: move up into
  7313. --- parent directory or parent menu.
  7314. --- <Down> - in filename/menu name completion: move into a
  7315. --- subdirectory or submenu.
  7316. --- <CR> - in menu completion, when the cursor is just after a
  7317. --- dot: move into a submenu.
  7318. --- CTRL-E - end completion, go back to what was there before
  7319. --- selecting a match.
  7320. --- CTRL-Y - accept the currently selected match and stop
  7321. --- completion.
  7322. ---
  7323. --- If you want <Left> and <Right> to move the cursor instead of selecting
  7324. --- a different match, use this:
  7325. ---
  7326. --- ```vim
  7327. --- cnoremap <Left> <Space><BS><Left>
  7328. --- cnoremap <Right> <Space><BS><Right>
  7329. --- ```
  7330. ---
  7331. --- `hl-WildMenu` highlights the current match.
  7332. ---
  7333. --- @type boolean
  7334. vim.o.wildmenu = true
  7335. vim.o.wmnu = vim.o.wildmenu
  7336. vim.go.wildmenu = vim.o.wildmenu
  7337. vim.go.wmnu = vim.go.wildmenu
  7338. --- Completion mode that is used for the character specified with
  7339. --- 'wildchar'. It is a comma-separated list of up to four parts. Each
  7340. --- part specifies what to do for each consecutive use of 'wildchar'. The
  7341. --- first part specifies the behavior for the first use of 'wildchar',
  7342. --- The second part for the second use, etc.
  7343. ---
  7344. --- Each part consists of a colon separated list consisting of the
  7345. --- following possible values:
  7346. --- "" Complete only the first match.
  7347. --- "full" Complete the next full match. After the last match,
  7348. --- the original string is used and then the first match
  7349. --- again. Will also start 'wildmenu' if it is enabled.
  7350. --- "longest" Complete till longest common string. If this doesn't
  7351. --- result in a longer string, use the next part.
  7352. --- "list" When more than one match, list all matches.
  7353. --- "lastused" When completing buffer names and more than one buffer
  7354. --- matches, sort buffers by time last used (other than
  7355. --- the current buffer).
  7356. --- When there is only a single match, it is fully completed in all cases.
  7357. ---
  7358. --- Examples of useful colon-separated values:
  7359. --- "longest:full" Like "longest", but also start 'wildmenu' if it is
  7360. --- enabled. Will not complete to the next full match.
  7361. --- "list:full" When more than one match, list all matches and
  7362. --- complete first match.
  7363. --- "list:longest" When more than one match, list all matches and
  7364. --- complete till longest common string.
  7365. --- "list:lastused" When more than one buffer matches, list all matches
  7366. --- and sort buffers by time last used (other than the
  7367. --- current buffer).
  7368. ---
  7369. --- Examples:
  7370. ---
  7371. --- ```vim
  7372. --- set wildmode=full
  7373. --- ```
  7374. --- Complete first full match, next match, etc. (the default)
  7375. ---
  7376. --- ```vim
  7377. --- set wildmode=longest,full
  7378. --- ```
  7379. --- Complete longest common string, then each full match
  7380. ---
  7381. --- ```vim
  7382. --- set wildmode=list:full
  7383. --- ```
  7384. --- List all matches and complete each full match
  7385. ---
  7386. --- ```vim
  7387. --- set wildmode=list,full
  7388. --- ```
  7389. --- List all matches without completing, then each full match
  7390. ---
  7391. --- ```vim
  7392. --- set wildmode=longest,list
  7393. --- ```
  7394. --- Complete longest common string, then list alternatives.
  7395. --- More info here: `cmdline-completion`.
  7396. ---
  7397. --- @type string
  7398. vim.o.wildmode = "full"
  7399. vim.o.wim = vim.o.wildmode
  7400. vim.go.wildmode = vim.o.wildmode
  7401. vim.go.wim = vim.go.wildmode
  7402. --- A list of words that change how `cmdline-completion` is done.
  7403. --- The following values are supported:
  7404. --- fuzzy Use `fuzzy-matching` to find completion matches. When
  7405. --- this value is specified, wildcard expansion will not
  7406. --- be used for completion. The matches will be sorted by
  7407. --- the "best match" rather than alphabetically sorted.
  7408. --- This will find more matches than the wildcard
  7409. --- expansion. Currently fuzzy matching based completion
  7410. --- is not supported for file and directory names and
  7411. --- instead wildcard expansion is used.
  7412. --- pum Display the completion matches using the popup menu
  7413. --- in the same style as the `ins-completion-menu`.
  7414. --- tagfile When using CTRL-D to list matching tags, the kind of
  7415. --- tag and the file of the tag is listed. Only one match
  7416. --- is displayed per line. Often used tag kinds are:
  7417. --- d #define
  7418. --- f function
  7419. ---
  7420. --- @type string
  7421. vim.o.wildoptions = "pum,tagfile"
  7422. vim.o.wop = vim.o.wildoptions
  7423. vim.go.wildoptions = vim.o.wildoptions
  7424. vim.go.wop = vim.go.wildoptions
  7425. --- only used in Win32
  7426. --- Some GUI versions allow the access to menu entries by using the ALT
  7427. --- key in combination with a character that appears underlined in the
  7428. --- menu. This conflicts with the use of the ALT key for mappings and
  7429. --- entering special characters. This option tells what to do:
  7430. --- no Don't use ALT keys for menus. ALT key combinations can be
  7431. --- mapped, but there is no automatic handling.
  7432. --- yes ALT key handling is done by the windowing system. ALT key
  7433. --- combinations cannot be mapped.
  7434. --- menu Using ALT in combination with a character that is a menu
  7435. --- shortcut key, will be handled by the windowing system. Other
  7436. --- keys can be mapped.
  7437. --- If the menu is disabled by excluding 'm' from 'guioptions', the ALT
  7438. --- key is never used for the menu.
  7439. --- This option is not used for <F10>; on Win32.
  7440. ---
  7441. --- @type string
  7442. vim.o.winaltkeys = "menu"
  7443. vim.o.wak = vim.o.winaltkeys
  7444. vim.go.winaltkeys = vim.o.winaltkeys
  7445. vim.go.wak = vim.go.winaltkeys
  7446. --- When non-empty, this option enables the window bar and determines its
  7447. --- contents. The window bar is a bar that's shown at the top of every
  7448. --- window with it enabled. The value of 'winbar' is evaluated like with
  7449. --- 'statusline'.
  7450. ---
  7451. --- When changing something that is used in 'winbar' that does not trigger
  7452. --- it to be updated, use `:redrawstatus`.
  7453. ---
  7454. --- Floating windows do not use the global value of 'winbar'. The
  7455. --- window-local value of 'winbar' must be set for a floating window to
  7456. --- have a window bar.
  7457. ---
  7458. --- This option cannot be set in a modeline when 'modelineexpr' is off.
  7459. ---
  7460. --- @type string
  7461. vim.o.winbar = ""
  7462. vim.o.wbr = vim.o.winbar
  7463. vim.wo.winbar = vim.o.winbar
  7464. vim.wo.wbr = vim.wo.winbar
  7465. vim.go.winbar = vim.o.winbar
  7466. vim.go.wbr = vim.go.winbar
  7467. --- Enables pseudo-transparency for a floating window. Valid values are in
  7468. --- the range of 0 for fully opaque window (disabled) to 100 for fully
  7469. --- transparent background. Values between 0-30 are typically most useful.
  7470. ---
  7471. --- UI-dependent. Works best with RGB colors. 'termguicolors'
  7472. ---
  7473. --- @type integer
  7474. vim.o.winblend = 0
  7475. vim.o.winbl = vim.o.winblend
  7476. vim.wo.winblend = vim.o.winblend
  7477. vim.wo.winbl = vim.wo.winblend
  7478. --- Window height used for `CTRL-F` and `CTRL-B` when there is only one
  7479. --- window and the value is smaller than 'lines' minus one. The screen
  7480. --- will scroll 'window' minus two lines, with a minimum of one.
  7481. --- When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
  7482. --- in a much smarter way, taking care of wrapping lines.
  7483. --- When resizing the Vim window, and the value is smaller than 1 or more
  7484. --- than or equal to 'lines' it will be set to 'lines' minus 1.
  7485. --- Note: Do not confuse this with the height of the Vim window, use
  7486. --- 'lines' for that.
  7487. ---
  7488. --- @type integer
  7489. vim.o.window = 0
  7490. vim.o.wi = vim.o.window
  7491. vim.go.window = vim.o.window
  7492. vim.go.wi = vim.go.window
  7493. --- If enabled, the window and the buffer it is displaying are paired.
  7494. --- For example, attempting to change the buffer with `:edit` will fail.
  7495. --- Other commands which change a window's buffer such as `:cnext` will
  7496. --- also skip any window with 'winfixbuf' enabled. However if an Ex
  7497. --- command has a "!" modifier, it can force switching buffers.
  7498. ---
  7499. --- @type boolean
  7500. vim.o.winfixbuf = false
  7501. vim.o.wfb = vim.o.winfixbuf
  7502. vim.wo.winfixbuf = vim.o.winfixbuf
  7503. vim.wo.wfb = vim.wo.winfixbuf
  7504. --- Keep the window height when windows are opened or closed and
  7505. --- 'equalalways' is set. Also for `CTRL-W_=`. Set by default for the
  7506. --- `preview-window` and `quickfix-window`.
  7507. --- The height may be changed anyway when running out of room.
  7508. ---
  7509. --- @type boolean
  7510. vim.o.winfixheight = false
  7511. vim.o.wfh = vim.o.winfixheight
  7512. vim.wo.winfixheight = vim.o.winfixheight
  7513. vim.wo.wfh = vim.wo.winfixheight
  7514. --- Keep the window width when windows are opened or closed and
  7515. --- 'equalalways' is set. Also for `CTRL-W_=`.
  7516. --- The width may be changed anyway when running out of room.
  7517. ---
  7518. --- @type boolean
  7519. vim.o.winfixwidth = false
  7520. vim.o.wfw = vim.o.winfixwidth
  7521. vim.wo.winfixwidth = vim.o.winfixwidth
  7522. vim.wo.wfw = vim.wo.winfixwidth
  7523. --- Minimal number of lines for the current window. This is not a hard
  7524. --- minimum, Vim will use fewer lines if there is not enough room. If the
  7525. --- focus goes to a window that is smaller, its size is increased, at the
  7526. --- cost of the height of other windows.
  7527. --- Set 'winheight' to a small number for normal editing.
  7528. --- Set it to 999 to make the current window fill most of the screen.
  7529. --- Other windows will be only 'winminheight' high. This has the drawback
  7530. --- that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
  7531. --- to create only two windows, set the option after startup is done,
  7532. --- using the `VimEnter` event:
  7533. ---
  7534. --- ```vim
  7535. --- au VimEnter * set winheight=999
  7536. --- ```
  7537. --- Minimum value is 1.
  7538. --- The height is not adjusted after one of the commands that change the
  7539. --- height of the current window.
  7540. --- 'winheight' applies to the current window. Use 'winminheight' to set
  7541. --- the minimal height for other windows.
  7542. ---
  7543. --- @type integer
  7544. vim.o.winheight = 1
  7545. vim.o.wh = vim.o.winheight
  7546. vim.go.winheight = vim.o.winheight
  7547. vim.go.wh = vim.go.winheight
  7548. --- Window-local highlights. Comma-delimited list of highlight
  7549. --- `group-name` pairs "{hl-from}:{hl-to},..." where each {hl-from} is
  7550. --- a `highlight-groups` item to be overridden by {hl-to} group in
  7551. --- the window.
  7552. ---
  7553. --- Note: highlight namespaces take precedence over 'winhighlight'.
  7554. --- See `nvim_win_set_hl_ns()` and `nvim_set_hl()`.
  7555. ---
  7556. --- Highlights of vertical separators are determined by the window to the
  7557. --- left of the separator. The 'tabline' highlight of a tabpage is
  7558. --- decided by the last-focused window of the tabpage. Highlights of
  7559. --- the popupmenu are determined by the current window. Highlights in the
  7560. --- message area cannot be overridden.
  7561. ---
  7562. --- Example: show a different color for non-current windows:
  7563. ---
  7564. --- ```vim
  7565. --- set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC
  7566. --- ```
  7567. ---
  7568. ---
  7569. --- @type string
  7570. vim.o.winhighlight = ""
  7571. vim.o.winhl = vim.o.winhighlight
  7572. vim.wo.winhighlight = vim.o.winhighlight
  7573. vim.wo.winhl = vim.wo.winhighlight
  7574. --- The minimal height of a window, when it's not the current window.
  7575. --- This is a hard minimum, windows will never become smaller.
  7576. --- When set to zero, windows may be "squashed" to zero lines (i.e. just a
  7577. --- status bar) if necessary. They will return to at least one line when
  7578. --- they become active (since the cursor has to have somewhere to go.)
  7579. --- Use 'winheight' to set the minimal height of the current window.
  7580. --- This option is only checked when making a window smaller. Don't use a
  7581. --- large number, it will cause errors when opening more than a few
  7582. --- windows. A value of 0 to 3 is reasonable.
  7583. ---
  7584. --- @type integer
  7585. vim.o.winminheight = 1
  7586. vim.o.wmh = vim.o.winminheight
  7587. vim.go.winminheight = vim.o.winminheight
  7588. vim.go.wmh = vim.go.winminheight
  7589. --- The minimal width of a window, when it's not the current window.
  7590. --- This is a hard minimum, windows will never become smaller.
  7591. --- When set to zero, windows may be "squashed" to zero columns (i.e. just
  7592. --- a vertical separator) if necessary. They will return to at least one
  7593. --- line when they become active (since the cursor has to have somewhere
  7594. --- to go.)
  7595. --- Use 'winwidth' to set the minimal width of the current window.
  7596. --- This option is only checked when making a window smaller. Don't use a
  7597. --- large number, it will cause errors when opening more than a few
  7598. --- windows. A value of 0 to 12 is reasonable.
  7599. ---
  7600. --- @type integer
  7601. vim.o.winminwidth = 1
  7602. vim.o.wmw = vim.o.winminwidth
  7603. vim.go.winminwidth = vim.o.winminwidth
  7604. vim.go.wmw = vim.go.winminwidth
  7605. --- Minimal number of columns for the current window. This is not a hard
  7606. --- minimum, Vim will use fewer columns if there is not enough room. If
  7607. --- the current window is smaller, its size is increased, at the cost of
  7608. --- the width of other windows. Set it to 999 to make the current window
  7609. --- always fill the screen. Set it to a small number for normal editing.
  7610. --- The width is not adjusted after one of the commands to change the
  7611. --- width of the current window.
  7612. --- 'winwidth' applies to the current window. Use 'winminwidth' to set
  7613. --- the minimal width for other windows.
  7614. ---
  7615. --- @type integer
  7616. vim.o.winwidth = 20
  7617. vim.o.wiw = vim.o.winwidth
  7618. vim.go.winwidth = vim.o.winwidth
  7619. vim.go.wiw = vim.go.winwidth
  7620. --- This option changes how text is displayed. It doesn't change the text
  7621. --- in the buffer, see 'textwidth' for that.
  7622. --- When on, lines longer than the width of the window will wrap and
  7623. --- displaying continues on the next line. When off lines will not wrap
  7624. --- and only part of long lines will be displayed. When the cursor is
  7625. --- moved to a part that is not shown, the screen will scroll
  7626. --- horizontally.
  7627. --- The line will be broken in the middle of a word if necessary. See
  7628. --- 'linebreak' to get the break at a word boundary.
  7629. --- To make scrolling horizontally a bit more useful, try this:
  7630. ---
  7631. --- ```vim
  7632. --- set sidescroll=5
  7633. --- set listchars+=precedes:<,extends:>
  7634. --- ```
  7635. --- See 'sidescroll', 'listchars' and `wrap-off`.
  7636. --- This option can't be set from a `modeline` when the 'diff' option is
  7637. --- on.
  7638. ---
  7639. --- @type boolean
  7640. vim.o.wrap = true
  7641. vim.wo.wrap = vim.o.wrap
  7642. --- Number of characters from the right window border where wrapping
  7643. --- starts. When typing text beyond this limit, an <EOL> will be inserted
  7644. --- and inserting continues on the next line.
  7645. --- Options that add a margin, such as 'number' and 'foldcolumn', cause
  7646. --- the text width to be further reduced.
  7647. --- When 'textwidth' is non-zero, this option is not used.
  7648. --- See also 'formatoptions' and `ins-textwidth`.
  7649. ---
  7650. --- @type integer
  7651. vim.o.wrapmargin = 0
  7652. vim.o.wm = vim.o.wrapmargin
  7653. vim.bo.wrapmargin = vim.o.wrapmargin
  7654. vim.bo.wm = vim.bo.wrapmargin
  7655. --- Searches wrap around the end of the file. Also applies to `]s` and
  7656. --- `[s`, searching for spelling mistakes.
  7657. ---
  7658. --- @type boolean
  7659. vim.o.wrapscan = true
  7660. vim.o.ws = vim.o.wrapscan
  7661. vim.go.wrapscan = vim.o.wrapscan
  7662. vim.go.ws = vim.go.wrapscan
  7663. --- Allows writing files. When not set, writing a file is not allowed.
  7664. --- Can be used for a view-only mode, where modifications to the text are
  7665. --- still allowed. Can be reset with the `-m` or `-M` command line
  7666. --- argument. Filtering text is still possible, even though this requires
  7667. --- writing a temporary file.
  7668. ---
  7669. --- @type boolean
  7670. vim.o.write = true
  7671. vim.go.write = vim.o.write
  7672. --- Allows writing to any file with no need for "!" override.
  7673. ---
  7674. --- @type boolean
  7675. vim.o.writeany = false
  7676. vim.o.wa = vim.o.writeany
  7677. vim.go.writeany = vim.o.writeany
  7678. vim.go.wa = vim.go.writeany
  7679. --- Make a backup before overwriting a file. The backup is removed after
  7680. --- the file was successfully written, unless the 'backup' option is
  7681. --- also on.
  7682. --- WARNING: Switching this option off means that when Vim fails to write
  7683. --- your buffer correctly and then, for whatever reason, Vim exits, you
  7684. --- lose both the original file and what you were writing. Only reset
  7685. --- this option if your file system is almost full and it makes the write
  7686. --- fail (and make sure not to exit Vim until the write was successful).
  7687. --- See `backup-table` for another explanation.
  7688. --- When the 'backupskip' pattern matches, a backup is not made anyway.
  7689. --- Depending on 'backupcopy' the backup is a new file or the original
  7690. --- file renamed (and a new file is written).
  7691. ---
  7692. --- @type boolean
  7693. vim.o.writebackup = true
  7694. vim.o.wb = vim.o.writebackup
  7695. vim.go.writebackup = vim.o.writebackup
  7696. vim.go.wb = vim.go.writebackup
  7697. --- Only takes effect together with 'redrawdebug'.
  7698. --- The number of milliseconds to wait after each line or each flush
  7699. ---
  7700. --- @type integer
  7701. vim.o.writedelay = 0
  7702. vim.o.wd = vim.o.writedelay
  7703. vim.go.writedelay = vim.o.writedelay
  7704. vim.go.wd = vim.go.writedelay