options.txt 317 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329
  1. *options.txt* Nvim
  2. VIM REFERENCE MANUAL by Bram Moolenaar
  3. Options *options*
  4. For an overview of options see quickref.txt |option-list|.
  5. Vim has a number of internal variables and switches which can be set to
  6. achieve special effects. These options come in three forms:
  7. boolean can only be on or off *boolean* *toggle*
  8. number has a numeric value
  9. string has a string value
  10. Type |gO| to see the table of contents.
  11. ==============================================================================
  12. 1. Setting options *set-option* *E764*
  13. *:se* *:set*
  14. :se[t][!] Show all options that differ from their default value.
  15. When [!] is present every option is on a separate
  16. line.
  17. :se[t][!] all Show all options.
  18. When [!] is present every option is on a separate
  19. line.
  20. *E518* *E519*
  21. :se[t] {option}? Show value of {option}.
  22. NOTE: some legacy options were removed. |nvim-removed|
  23. :se[t] {option} Toggle option: set, switch it on.
  24. Number option: show value.
  25. String option: show value.
  26. :se[t] no{option} Toggle option: Reset, switch it off.
  27. *:set-!* *:set-inv*
  28. :se[t] {option}! or
  29. :se[t] inv{option} Toggle option: Invert value.
  30. *:set-default* *:set-&* *:set-&vi* *:set-&vim*
  31. :se[t] {option}& Reset option to its default value.
  32. :se[t] {option}&vi Reset option to its Vi default value.
  33. :se[t] {option}&vim Reset option to its Vim default value.
  34. :se[t] all& Set all options to their default value. The values of
  35. these options are not changed:
  36. 'columns'
  37. 'lines'
  38. Warning: This may have a lot of side effects.
  39. *:set-args* *:set=* *E487* *E521*
  40. :se[t] {option}={value} or
  41. :se[t] {option}:{value}
  42. Set string or number option to {value}.
  43. For numeric options the value can be given in decimal,
  44. hex (preceded with 0x) or octal (preceded with '0' or
  45. '0o').
  46. The old value can be inserted by typing 'wildchar' (by
  47. default this is a <Tab>). Many string options with
  48. fixed syntax also support completing known values.
  49. See |cmdline-completion| and |complete-set-option|.
  50. White space between {option} and '=' is allowed and
  51. will be ignored. White space between '=' and {value}
  52. is not allowed.
  53. See |option-backslash| for using white space and
  54. backslashes in {value}.
  55. :se[t] {option}+={value} *:set+=*
  56. Add the {value} to a number option, or append the
  57. {value} to a string option. When the option is a
  58. comma-separated list, a comma is added, unless the
  59. value was empty.
  60. If the option is a list of flags, superfluous flags
  61. are removed. When adding a flag that was already
  62. present the option value doesn't change.
  63. Also see |:set-args| above.
  64. :se[t] {option}^={value} *:set^=*
  65. Multiply the {value} to a number option, or prepend
  66. the {value} to a string option. When the option is a
  67. comma-separated list, a comma is added, unless the
  68. value was empty.
  69. Also see |:set-args| above.
  70. :se[t] {option}-={value} *:set-=*
  71. Subtract the {value} from a number option, or remove
  72. the {value} from a string option, if it is there.
  73. If the {value} is not found in a string option, there
  74. is no error or warning. When the option is a comma-
  75. separated list, a comma is deleted, unless the option
  76. becomes empty.
  77. When the option is a list of flags, {value} must be
  78. exactly as they appear in the option. Remove flags
  79. one by one to avoid problems.
  80. The individual values from a comma separated list or
  81. list of flags can be inserted by typing 'wildchar'.
  82. See |complete-set-option|.
  83. Also see |:set-args| above.
  84. The {option} arguments to ":set" may be repeated. For example: >
  85. :set ai nosi sw=3 ts=3
  86. If you make an error in one of the arguments, an error message will be given
  87. and the following arguments will be ignored.
  88. *:set-verbose*
  89. When 'verbose' is non-zero, displaying an option value will also tell where it
  90. was last set. Example: >
  91. :verbose set shiftwidth cindent?
  92. < shiftwidth=4 ~
  93. Last set from modeline line 1 ~
  94. cindent ~
  95. Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
  96. This is only done when specific option values are requested, not for ":verbose
  97. set all" or ":verbose set" without an argument.
  98. When the option was set by hand there is no "Last set" message.
  99. When the option was set while executing a function, user command or
  100. autocommand, the script in which it was defined is reported.
  101. A few special texts:
  102. Last set from modeline line 1 ~
  103. Option was set in a |modeline|.
  104. Last set from --cmd argument ~
  105. Option was set with command line argument |--cmd| or +.
  106. Last set from -c argument ~
  107. Option was set with command line argument |-c|, +, |-S| or
  108. |-q|.
  109. Last set from environment variable ~
  110. Option was set from $VIMINIT.
  111. Last set from error handler ~
  112. Option was cleared when evaluating it resulted in an error.
  113. *option-backslash*
  114. To include white space in a string option value it has to be preceded with a
  115. backslash. To include a backslash you have to use two. Effectively this
  116. means that the number of backslashes in an option value is halved (rounded
  117. down).
  118. In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
  119. backslashes instead because they can be separated by either commas or spaces.
  120. Comma-separated options like 'backupdir' and 'tags' will also require commas
  121. to be escaped with two backslashes, whereas this is not needed for
  122. non-comma-separated ones like 'makeprg'.
  123. When setting options using |:let| and |literal-string|, you need to use one
  124. fewer layer of backslash.
  125. A few examples: >
  126. :set makeprg=make\ file results in "make file"
  127. :let &makeprg='make file' (same as above)
  128. :set makeprg=make\\\ file results in "make\ file"
  129. :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
  130. :set tags=tags\\\ file results in "tags file"
  131. :let &tags='tags\ file' (same as above)
  132. :set makeprg=make,file results in "make,file"
  133. :set makeprg=make\\,file results in "make\,file"
  134. :set tags=tags,file results in "tags" and "file"
  135. :set tags=tags\\,file results in "tags,file"
  136. :let &tags='tags\,file' (same as above)
  137. The "|" character separates a ":set" command from a following command. To
  138. include the "|" in the option value, use "\|" instead. This example sets the
  139. 'titlestring' option to "hi|there": >
  140. :set titlestring=hi\|there
  141. This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
  142. :set titlestring=hi|set iconstring=there
  143. Similarly, the double quote character starts a comment. To include the '"' in
  144. the option value, use '\"' instead. This example sets the 'titlestring'
  145. option to "hi "there"": >
  146. :set titlestring=hi\ \"there\"
  147. For Win32 backslashes in file names are mostly not removed. More precise: For
  148. options that expect a file name (those where environment variables are
  149. expanded) a backslash before a normal file name character is not removed. But
  150. a backslash before a special character (space, backslash, comma, etc.) is used
  151. like explained above.
  152. There is one special situation, when the value starts with "\\": >
  153. :set dir=\\machine\path results in "\\machine\path"
  154. :set dir=\\\\machine\\path results in "\\machine\path"
  155. :set dir=\\path\\file results in "\\path\file" (wrong!)
  156. For the first one the start is kept, but for the second one the backslashes
  157. are halved. This makes sure it works both when you expect backslashes to be
  158. halved and when you expect the backslashes to be kept. The third gives a
  159. result which is probably not what you want. Avoid it.
  160. *add-option-flags* *remove-option-flags*
  161. *E539*
  162. Some options are a list of flags. When you want to add a flag to such an
  163. option, without changing the existing ones, you can do it like this: >
  164. :set guioptions+=a
  165. Remove a flag from an option like this: >
  166. :set guioptions-=a
  167. This removes the 'a' flag from 'guioptions'.
  168. Note that you should add or remove one flag at a time. If 'guioptions' has
  169. the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
  170. doesn't appear.
  171. *:set_env* *expand-env* *expand-environment-var*
  172. Environment variables in specific string options will be expanded. If the
  173. environment variable exists the '$' and the following environment variable
  174. name is replaced with its value. If it does not exist the '$' and the name
  175. are not modified. Any non-id character (not a letter, digit or '_') may
  176. follow the environment variable name. That character and what follows is
  177. appended to the value of the environment variable. Examples: >
  178. :set term=$TERM.new
  179. :set path=/usr/$INCLUDE,$HOME/include,.
  180. When adding or removing a string from an option with ":set opt-=val" or ":set
  181. opt+=val" the expansion is done before the adding or removing.
  182. Handling of local options *local-options*
  183. Note: The following also applies to |global-local| options.
  184. Some of the options only apply to a window or buffer. Each window or buffer
  185. has its own copy of this option, thus each can have its own value. This
  186. allows you to set 'list' in one window but not in another. And set
  187. 'shiftwidth' to 3 in one buffer and 4 in another.
  188. The following explains what happens to these local options in specific
  189. situations. You don't really need to know all of this, since Vim mostly uses
  190. the option values you would expect. Unfortunately, doing what the user
  191. expects is a bit complicated...
  192. When splitting a window, the local options are copied to the new window. Thus
  193. right after the split the contents of the two windows look the same.
  194. When editing a new buffer, its local option values must be initialized. Since
  195. the local options of the current buffer might be specifically for that buffer,
  196. these are not used. Instead, for each buffer-local option there also is a
  197. global value, which is used for new buffers. With ":set" both the local and
  198. global value is changed. With "setlocal" only the local value is changed,
  199. thus this value is not used when editing a new buffer.
  200. When editing a buffer that has been edited before, the options from the window
  201. that was last closed are used again. If this buffer has been edited in this
  202. window, the values from back then are used. Otherwise the values from the
  203. last closed window where the buffer was edited last are used.
  204. It's possible to set a local window option specifically for a type of buffer.
  205. When you edit another buffer in the same window, you don't want to keep
  206. using these local window options. Therefore Vim keeps a global value of the
  207. local window options, which is used when editing another buffer. Each window
  208. has its own copy of these values. Thus these are local to the window, but
  209. global to all buffers in the window. With this you can do: >
  210. :e one
  211. :set list
  212. :e two
  213. Now the 'list' option will also be set in "two", since with the ":set list"
  214. command you have also set the global value. >
  215. :set nolist
  216. :e one
  217. :setlocal list
  218. :e two
  219. Now the 'list' option is not set, because ":set nolist" resets the global
  220. value, ":setlocal list" only changes the local value and ":e two" gets the
  221. global value. Note that if you do this next: >
  222. :e one
  223. You will get back the 'list' value as it was the last time you edited "one".
  224. The options local to a window are remembered for each buffer. This also
  225. happens when the buffer is not loaded, but they are lost when the buffer is
  226. wiped out |:bwipe|.
  227. Special local window options *local-noglobal*
  228. The following local window options won't be copied over when new windows are
  229. created, thus they behave slightly differently:
  230. Option Reason ~
  231. 'previewwindow' there can only be a single one
  232. 'scroll' specific to existing window
  233. 'winfixbuf' specific to existing window
  234. 'winfixheight' specific to existing window
  235. 'winfixwidth' specific to existing window
  236. Special local buffer options
  237. The following local buffer options won't be copied over when new buffers are
  238. created, thus they behave slightly differently:
  239. Option Reason ~
  240. 'filetype' explicitly set by autocommands
  241. 'syntax' explicitly set by autocommands
  242. 'bufhidden' denote |special-buffers|
  243. 'buftype' denote |special-buffers|
  244. 'readonly' will be detected automatically
  245. 'modified' will be detected automatically
  246. *:setl* *:setlocal*
  247. :setl[ocal][!] ... Like ":set" but set only the value local to the
  248. current buffer or window. Not all options have a
  249. local value. If the option does not have a local
  250. value the global value is set.
  251. With the "all" argument: display local values for all
  252. local options.
  253. Without argument: Display local values for all local
  254. options which are different from the default.
  255. When displaying a specific local option, show the
  256. local value. For a global/local boolean option, when
  257. the global value is being used, "--" is displayed
  258. before the option name.
  259. For a global option the global value is
  260. shown (but that might change in the future).
  261. :se[t] {option}< Set the effective value of {option} to its global
  262. value.
  263. For |global-local| options, the local value is removed,
  264. so that the global value will be used.
  265. For all other options, the global value is copied to
  266. the local value.
  267. :setl[ocal] {option}< Set the effective value of {option} to its global
  268. value by copying the global value to the local value.
  269. Note that the behaviour for |global-local| options is slightly different
  270. between string and number-based options.
  271. *:setg* *:setglobal*
  272. :setg[lobal][!] ... Like ":set" but set only the global value for a local
  273. option without changing the local value.
  274. When displaying an option, the global value is shown.
  275. With the "all" argument: display global values for all
  276. local options.
  277. Without argument: display global values for all local
  278. options which are different from the default.
  279. For buffer-local and window-local options:
  280. Command global value local value condition ~
  281. :set option=value set set
  282. :setlocal option=value - set
  283. :setglobal option=value set -
  284. :set option? - display local value is set
  285. :set option? display - local value is not set
  286. :setlocal option? - display
  287. :setglobal option? display -
  288. Global options with a local value *global-local*
  289. Options are global when you mostly use one value for all buffers and windows.
  290. For some global options it's useful to sometimes have a different local value.
  291. You can set the local value with ":setlocal". That buffer or window will then
  292. use the local value, while other buffers and windows continue using the global
  293. value.
  294. For example, you have two windows, both on C source code. They use the global
  295. 'makeprg' option. If you do this in one of the two windows: >
  296. :set makeprg=gmake
  297. then the other window will switch to the same value. There is no need to set
  298. the 'makeprg' option in the other C source window too.
  299. However, if you start editing a Perl file in a new window, you want to use
  300. another 'makeprg' for it, without changing the value used for the C source
  301. files. You use this command: >
  302. :setlocal makeprg=perlmake
  303. You can switch back to using the global value by making the local value empty: >
  304. :setlocal makeprg=
  305. This only works for a string option. For a number or boolean option you need
  306. to use the "<" flag, like this: >
  307. :setlocal autoread<
  308. Note that for non-boolean and non-number options using "<" copies the global
  309. value to the local value, it doesn't switch back to using the global value
  310. (that matters when the global value changes later). You can also use: >
  311. :set path<
  312. This will make the local value of 'path' empty, so that the global value is
  313. used. Thus it does the same as: >
  314. :setlocal path=
  315. Note: In the future more global options can be made |global-local|. Using
  316. ":setlocal" on a global option might work differently then.
  317. *option-value-function*
  318. Some options ('completefunc', 'findfunc', 'omnifunc', 'operatorfunc',
  319. 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to a function name
  320. or a function reference or a lambda function. When using a lambda it will be
  321. converted to the name, e.g. "<lambda>123".
  322. Examples:
  323. >
  324. set opfunc=MyOpFunc
  325. set opfunc=function('MyOpFunc')
  326. set opfunc=funcref('MyOpFunc')
  327. set opfunc={a\ ->\ MyOpFunc(a)}
  328. Set to a script-local function: >
  329. set opfunc=s:MyLocalFunc
  330. set opfunc=<SID>MyLocalFunc
  331. Set using a funcref variable: >
  332. let Fn = function('MyTagFunc')
  333. let &tagfunc = Fn
  334. Set using a lambda expression: >
  335. let &tagfunc = {t -> MyTagFunc(t)}
  336. Set using a variable with lambda expression: >
  337. let L = {a, b, c -> MyTagFunc(a, b , c)}
  338. let &tagfunc = L
  339. Calling a function in an expr option *expr-option-function*
  340. The value of a few options, such as 'foldexpr', is an expression that is
  341. evaluated to get a value. The evaluation can have quite a bit of overhead.
  342. One way to minimize the overhead, and also to keep the option value very
  343. simple, is to define a function and set the option to call it without
  344. arguments. A |v:lua-call| can also be used. Example: >vim
  345. lua << EOF
  346. function _G.MyFoldFunc()
  347. -- ... compute fold level for line v:lnum
  348. return level
  349. end
  350. EOF
  351. set foldexpr=v:lua.MyFoldFunc()
  352. Setting the filetype
  353. :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
  354. Set the 'filetype' option to {filetype}, but only if
  355. not done yet in a sequence of (nested) autocommands.
  356. This is short for: >
  357. :if !did_filetype()
  358. : setlocal filetype={filetype}
  359. :endif
  360. < This command is used in a filetype.vim file to avoid
  361. setting the 'filetype' option twice, causing different
  362. settings and syntax files to be loaded.
  363. When the optional FALLBACK argument is present, a
  364. later :setfiletype command will override the
  365. 'filetype'. This is to be used for filetype
  366. detections that are just a guess. |did_filetype()|
  367. will return false after this command.
  368. *option-window* *optwin*
  369. :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
  370. :opt[ions] Open a window for viewing and setting all options.
  371. Options are grouped by function.
  372. Offers short help for each option. Hit <CR> on the
  373. short help to open a help window with more help for
  374. the option.
  375. Modify the value of the option and hit <CR> on the
  376. "set" line to set the new value. For window and
  377. buffer specific options, the last accessed window is
  378. used to set the option value in, unless this is a help
  379. window, in which case the window below help window is
  380. used (skipping the option-window).
  381. *$HOME*
  382. Using "~" is like using "$HOME", but it is only recognized at the start of an
  383. option and after a space or comma.
  384. On Unix systems "~user" can be used too. It is replaced by the home directory
  385. of user "user". Example: >
  386. :set path=~mool/include,/usr/include,.
  387. On Unix systems the form "${HOME}" can be used too. The name between {} can
  388. contain non-id characters then. Note that if you want to use this for the
  389. "gf" command, you need to add the '{' and '}' characters to 'isfname'.
  390. NOTE: expanding environment variables and "~/" is only done with the ":set"
  391. command, not when assigning a value to an option with ":let".
  392. *$HOME-windows*
  393. On MS-Windows, if $HOME is not defined as an environment variable, then
  394. at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
  395. If $HOMEDRIVE is not set then $USERPROFILE is used.
  396. This expanded value is not exported to the environment, this matters when
  397. running an external command: >
  398. :echo system('set | findstr ^HOME=')
  399. and >
  400. :echo luaeval('os.getenv("HOME")')
  401. should echo nothing (an empty string) despite exists('$HOME') being true.
  402. When setting $HOME to a non-empty string it will be exported to the
  403. subprocesses.
  404. Note the maximum length of an expanded option is limited. How much depends on
  405. the system, mostly it is something like 256 or 1024 characters.
  406. ==============================================================================
  407. 2. Automatically setting options *auto-setting*
  408. Besides changing options with the ":set" command, you can set options
  409. automatically in various ways:
  410. 1. With a |config| file or a |startup| argument. You can create an
  411. initialization file with |:mkvimrc|, |:mkview| and |:mksession|.
  412. 2. |autocommand|s executed when you edit a file.
  413. 3. ".nvim.lua" files in the current directory, if 'exrc' is enabled.
  414. 4. |editorconfig| in the current buffer's directory or ancestors.
  415. 5. 'modeline' settings found at the beginning or end of the file. See below.
  416. *modeline* *vim:* *vi:* *ex:* *E520*
  417. There are two forms of modelines. The first form:
  418. [text{white}]{vi:|vim:|ex:}[white]{options}
  419. [text{white}] empty or any text followed by at least one blank
  420. character (<Space> or <Tab>); "ex:" always requires at
  421. least one blank character
  422. {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
  423. [white] optional white space
  424. {options} a list of option settings, separated with white space
  425. or ':', where each part between ':' is the argument
  426. for a ":set" command (can be empty)
  427. Examples:
  428. vi:noai:sw=3 ts=6 ~
  429. vim: tw=77 ~
  430. The second form (this is compatible with some versions of Vi):
  431. [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
  432. [text{white}] empty or any text followed by at least one blank
  433. character (<Space> or <Tab>); "ex:" always requires at
  434. least one blank character
  435. {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
  436. [white] optional white space
  437. se[t] the string "set " or "se " (note the space); When
  438. "Vim" is used it must be "set".
  439. {options} a list of options, separated with white space, which
  440. is the argument for a ":set" command
  441. : a colon
  442. [text] any text or empty
  443. Examples: >
  444. /* vim: set ai tw=75: */
  445. /* Vim: set ai tw=75: */
  446. The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
  447. chance that a normal word like "lex:" is caught. There is one exception:
  448. "vi:" and "vim:" can also be at the start of the line (for compatibility with
  449. version 3.0). Using "ex:" at the start of the line will be ignored (this
  450. could be short for "example:").
  451. If the modeline is disabled within a modeline, subsequent modelines will be
  452. ignored. This is to allow turning off modeline on a per-file basis. This is
  453. useful when a line looks like a modeline but isn't. For example, it would be
  454. good to start a YAML file containing strings like "vim:" with
  455. # vim: nomodeline ~
  456. so as to avoid modeline misdetection. Following options on the same line
  457. after modeline deactivation, if any, are still evaluated (but you would
  458. normally not have any).
  459. *modeline-local*
  460. The options are set like with ":setlocal": The new value only applies to the
  461. buffer and window that contain the file. Although it's possible to set global
  462. options from a modeline, this is unusual. If you have two windows open and
  463. the files in it set the same global option to a different value, the result
  464. depends on which one was opened last.
  465. When editing a file that was already loaded, only the window-local options
  466. from the modeline are used. Thus if you manually changed a buffer-local
  467. option after opening the file, it won't be changed if you edit the same buffer
  468. in another window. But window-local options will be set.
  469. *modeline-version*
  470. If the modeline is only to be used for some versions of Vim, the version
  471. number can be specified where "vim:" or "Vim:" is used:
  472. vim{vers}: version {vers} or later
  473. vim<{vers}: version before {vers}
  474. vim={vers}: version {vers}
  475. vim>{vers}: version after {vers}
  476. {vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
  477. For example, to use a modeline only for Vim 7.0: >
  478. /* vim700: set foldmethod=marker */
  479. To use a modeline for Vim after version 7.2: >
  480. /* vim>702: set cole=2: */
  481. There can be no blanks between "vim" and the ":".
  482. The modeline is ignored if {vers} does not fit in an integer.
  483. The number of lines that are checked can be set with the 'modelines' option.
  484. If 'modeline' is off or 'modelines' is 0 no lines are checked.
  485. Note that for the first form all of the rest of the line is used, thus a line
  486. like: >
  487. /* vi:ts=4: */
  488. will give an error message for the trailing "*/". This line is OK: >
  489. /* vi:set ts=4: */
  490. If an error is detected the rest of the line is skipped.
  491. If you want to include a ':' in a set command precede it with a '\'. The
  492. backslash in front of the ':' will be removed. Example: >
  493. /* vi:set fillchars=stl\:^,vert\:\|: */
  494. This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
  495. before the ':' is removed. Thus to include "\:" you have to specify "\\:".
  496. *E992*
  497. No other commands than "set" are supported, for security reasons (somebody
  498. might create a Trojan horse text file with modelines). And not all options
  499. can be set. For some options a flag is set, so that when the value is used
  500. the |sandbox| is effective. Some options can only be set from the modeline
  501. when 'modelineexpr' is set (the default is off).
  502. Still, there is always a small risk that a modeline causes trouble. E.g.,
  503. when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
  504. So disable modelines before editing untrusted text. The mail ftplugin does
  505. this, for example.
  506. Hint: If you would like to do something else than setting an option, you could
  507. define an autocommand that checks the file for a specific string. For
  508. example: >
  509. au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
  510. And define a function SetVar() that does something with the line containing
  511. "VAR".
  512. ==============================================================================
  513. 3. Options summary *option-summary*
  514. In the list below all the options are mentioned with their full name and with
  515. an abbreviation if there is one. Both forms may be used.
  516. In this document when a boolean option is "set" that means that ":set option"
  517. is entered. When an option is "reset", ":set nooption" is used.
  518. Most options are the same in all windows and buffers. There are a few that
  519. are specific to how the text is presented in a window. These can be set to a
  520. different value in each window. For example the 'list' option can be set in
  521. one window and reset in another for the same text, giving both types of view
  522. at the same time. There are a few options that are specific to a certain
  523. file. These can have a different value for each file or buffer. For example
  524. the 'textwidth' option can be 78 for a normal text file and 0 for a C
  525. program.
  526. global one option for all buffers and windows
  527. local to window each window has its own copy of this option
  528. local to buffer each buffer has its own copy of this option
  529. When creating a new window the option values from the currently active window
  530. are used as a default value for the window-specific options. For the
  531. buffer-specific options this depends on the 's' and 'S' flags in the
  532. 'cpoptions' option. If 's' is included (which is the default) the values for
  533. buffer options are copied from the currently active buffer when a buffer is
  534. first entered. If 'S' is present the options are copied each time the buffer
  535. is entered, this is almost like having global options. If 's' and 'S' are not
  536. present, the options are copied from the currently active buffer when the
  537. buffer is created.
  538. Hidden options *hidden-options*
  539. Not all options are supported in all versions. This depends on the supported
  540. features and sometimes on the system. A remark about this is in curly braces
  541. below. When an option is not supported, it is called a hidden option. Trying
  542. to get the value of a hidden option will not give an error, it will return the
  543. default value for that option instead. You can't change the value of a hidden
  544. option.
  545. To test if "foo" is a valid option name, use something like this: >
  546. if exists('&foo')
  547. This also returns true for a hidden option. To test if option "foo" is really
  548. supported use something like this: >
  549. if exists('+foo')
  550. <
  551. *E355*
  552. A jump table for the options with a short description can be found at |Q_op|.
  553. *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
  554. 'allowrevins' 'ari' boolean (default off)
  555. global
  556. Allow CTRL-_ in Insert mode. This is default off, to avoid that users
  557. that accidentally type CTRL-_ instead of SHIFT-_ get into reverse
  558. Insert mode, and don't know how to get out. See 'revins'.
  559. *'ambiwidth'* *'ambw'*
  560. 'ambiwidth' 'ambw' string (default "single")
  561. global
  562. Tells Vim what to do with characters with East Asian Width Class
  563. Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
  564. letters, Cyrillic letters).
  565. There are currently two possible values:
  566. "single": Use the same width as characters in US-ASCII. This is
  567. expected by most users.
  568. "double": Use twice the width of ASCII characters.
  569. *E834* *E835*
  570. The value "double" cannot be used if 'listchars' or 'fillchars'
  571. contains a character that would be double width. These errors may
  572. also be given when calling setcellwidths().
  573. The values are overruled for characters specified with
  574. |setcellwidths()|.
  575. There are a number of CJK fonts for which the width of glyphs for
  576. those characters are solely based on how many octets they take in
  577. legacy/traditional CJK encodings. In those encodings, Euro,
  578. Registered sign, Greek/Cyrillic letters are represented by two octets,
  579. therefore those fonts have "wide" glyphs for them. This is also
  580. true of some line drawing characters used to make tables in text
  581. file. Therefore, when a CJK font is used for GUI Vim or
  582. Vim is running inside a terminal (emulators) that uses a CJK font
  583. (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
  584. this option should be set to "double" to match the width perceived
  585. by Vim with the width of glyphs in the font. Perhaps it also has
  586. to be set to "double" under CJK MS-Windows when the system locale is
  587. set to one of CJK locales. See Unicode Standard Annex #11
  588. (https://www.unicode.org/reports/tr11).
  589. *'arabic'* *'arab'* *'noarabic'* *'noarab'*
  590. 'arabic' 'arab' boolean (default off)
  591. local to window
  592. This option can be set to start editing Arabic text.
  593. Setting this option will:
  594. - Set the 'rightleft' option, unless 'termbidi' is set.
  595. - Set the 'arabicshape' option, unless 'termbidi' is set.
  596. - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
  597. between typing English and Arabic key mapping.
  598. - Set the 'delcombine' option
  599. Resetting this option will:
  600. - Reset the 'rightleft' option.
  601. - Disable the use of 'keymap' (without changing its value).
  602. Note that 'arabicshape' and 'delcombine' are not reset (it is a global
  603. option).
  604. Also see |arabic.txt|.
  605. *'arabicshape'* *'arshape'* *'noarabicshape'* *'noarshape'*
  606. 'arabicshape' 'arshape' boolean (default on)
  607. global
  608. When on and 'termbidi' is off, the required visual character
  609. corrections that need to take place for displaying the Arabic language
  610. take effect. Shaping, in essence, gets enabled; the term is a broad
  611. one which encompasses:
  612. a) the changing/morphing of characters based on their location
  613. within a word (initial, medial, final and stand-alone).
  614. b) the enabling of the ability to compose characters
  615. c) the enabling of the required combining of some characters
  616. When disabled the display shows each character's true stand-alone
  617. form.
  618. Arabic is a complex language which requires other settings, for
  619. further details see |arabic.txt|.
  620. *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
  621. 'autochdir' 'acd' boolean (default off)
  622. global
  623. When on, Vim will change the current working directory whenever you
  624. open a file, switch buffers, delete a buffer or open/close a window.
  625. It will change to the directory containing the file which was opened
  626. or selected. When a buffer has no name it also has no directory, thus
  627. the current directory won't change when navigating to it.
  628. Note: When this option is on some plugins may not work.
  629. *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
  630. 'autoindent' 'ai' boolean (default on)
  631. local to buffer
  632. Copy indent from current line when starting a new line (typing <CR>
  633. in Insert mode or when using the "o" or "O" command). If you do not
  634. type anything on the new line except <BS> or CTRL-D and then type
  635. <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
  636. to another line has the same effect, unless the 'I' flag is included
  637. in 'cpoptions'.
  638. When autoindent is on, formatting (with the "gq" command or when you
  639. reach 'textwidth' in Insert mode) uses the indentation of the first
  640. line.
  641. When 'smartindent' or 'cindent' is on the indent is changed in
  642. a different way.
  643. *'autoread'* *'ar'* *'noautoread'* *'noar'*
  644. 'autoread' 'ar' boolean (default on)
  645. global or local to buffer |global-local|
  646. When a file has been detected to have been changed outside of Vim and
  647. it has not been changed inside of Vim, automatically read it again.
  648. When the file has been deleted this is not done, so you have the text
  649. from before it was deleted. When it appears again then it is read.
  650. |timestamp|
  651. If this option has a local value, use this command to switch back to
  652. using the global value: >vim
  653. set autoread<
  654. <
  655. *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
  656. 'autowrite' 'aw' boolean (default off)
  657. global
  658. Write the contents of the file, if it has been modified, on each
  659. `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
  660. `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
  661. a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
  662. to another file.
  663. A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
  664. set to "hide" and `:next` is used.
  665. Note that for some commands the 'autowrite' option is not used, see
  666. 'autowriteall' for that.
  667. Some buffers will not be written, specifically when 'buftype' is
  668. "nowrite", "nofile", "terminal" or "prompt".
  669. USE WITH CARE: If you make temporary changes to a buffer that you
  670. don't want to be saved this option may cause it to be saved anyway.
  671. Renaming the buffer with ":file {name}" may help avoid this.
  672. *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
  673. 'autowriteall' 'awa' boolean (default off)
  674. global
  675. Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
  676. ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
  677. Setting this option also implies that Vim behaves like 'autowrite' has
  678. been set.
  679. *'background'* *'bg'*
  680. 'background' 'bg' string (default "dark")
  681. global
  682. When set to "dark" or "light", adjusts the default color groups for
  683. that background type. The |TUI| or other UI sets this on startup
  684. (triggering |OptionSet|) if it can detect the background color.
  685. This option does NOT change the background color, it tells Nvim what
  686. the "inherited" (terminal/GUI) background looks like.
  687. See |:hi-normal| if you want to set the background color explicitly.
  688. *g:colors_name*
  689. When a color scheme is loaded (the "g:colors_name" variable is set)
  690. changing 'background' will cause the color scheme to be reloaded. If
  691. the color scheme adjusts to the value of 'background' this will work.
  692. However, if the color scheme sets 'background' itself the effect may
  693. be undone. First delete the "g:colors_name" variable when needed.
  694. Normally this option would be set in the vimrc file. Possibly
  695. depending on the terminal name. Example: >vim
  696. if $TERM ==# "xterm"
  697. set background=dark
  698. endif
  699. < When this option is changed, the default settings for the highlight groups
  700. will change. To use other settings, place ":highlight" commands AFTER
  701. the setting of the 'background' option.
  702. *'backspace'* *'bs'*
  703. 'backspace' 'bs' string (default "indent,eol,start")
  704. global
  705. Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
  706. mode. This is a list of items, separated by commas. Each item allows
  707. a way to backspace over something:
  708. value effect ~
  709. indent allow backspacing over autoindent
  710. eol allow backspacing over line breaks (join lines)
  711. start allow backspacing over the start of insert; CTRL-W and CTRL-U
  712. stop once at the start of insert.
  713. nostop like start, except CTRL-W and CTRL-U do not stop at the start of
  714. insert.
  715. When the value is empty, Vi compatible backspacing is used, none of
  716. the ways mentioned for the items above are possible.
  717. *'backup'* *'bk'* *'nobackup'* *'nobk'*
  718. 'backup' 'bk' boolean (default off)
  719. global
  720. Make a backup before overwriting a file. Leave it around after the
  721. file has been successfully written. If you do not want to keep the
  722. backup file, but you do want a backup while the file is being
  723. written, reset this option and set the 'writebackup' option (this is
  724. the default). If you do not want a backup file at all reset both
  725. options (use this if your file system is almost full). See the
  726. |backup-table| for more explanations.
  727. When the 'backupskip' pattern matches, a backup is not made anyway.
  728. When 'patchmode' is set, the backup may be renamed to become the
  729. oldest version of a file.
  730. *'backupcopy'* *'bkc'*
  731. 'backupcopy' 'bkc' string (default "auto")
  732. global or local to buffer |global-local|
  733. When writing a file and a backup is made, this option tells how it's
  734. done. This is a comma-separated list of words.
  735. The main values are:
  736. "yes" make a copy of the file and overwrite the original one
  737. "no" rename the file and write a new one
  738. "auto" one of the previous, what works best
  739. Extra values that can be combined with the ones above are:
  740. "breaksymlink" always break symlinks when writing
  741. "breakhardlink" always break hardlinks when writing
  742. Making a copy and overwriting the original file:
  743. - Takes extra time to copy the file.
  744. + When the file has special attributes, is a (hard/symbolic) link or
  745. has a resource fork, all this is preserved.
  746. - When the file is a link the backup will have the name of the link,
  747. not of the real file.
  748. Renaming the file and writing a new one:
  749. + It's fast.
  750. - Sometimes not all attributes of the file can be copied to the new
  751. file.
  752. - When the file is a link the new file will not be a link.
  753. The "auto" value is the middle way: When Vim sees that renaming the
  754. file is possible without side effects (the attributes can be passed on
  755. and the file is not a link) that is used. When problems are expected,
  756. a copy will be made.
  757. The "breaksymlink" and "breakhardlink" values can be used in
  758. combination with any of "yes", "no" and "auto". When included, they
  759. force Vim to always break either symbolic or hard links by doing
  760. exactly what the "no" option does, renaming the original file to
  761. become the backup and writing a new file in its place. This can be
  762. useful for example in source trees where all the files are symbolic or
  763. hard links and any changes should stay in the local source tree, not
  764. be propagated back to the original source.
  765. *crontab*
  766. One situation where "no" and "auto" will cause problems: A program
  767. that opens a file, invokes Vim to edit that file, and then tests if
  768. the open file was changed (through the file descriptor) will check the
  769. backup file instead of the newly created file. "crontab -e" is an
  770. example, as are several |file-watcher| daemons like inotify. In that
  771. case you probably want to switch this option.
  772. When a copy is made, the original file is truncated and then filled
  773. with the new text. This means that protection bits, owner and
  774. symbolic links of the original file are unmodified. The backup file,
  775. however, is a new file, owned by the user who edited the file. The
  776. group of the backup is set to the group of the original file. If this
  777. fails, the protection bits for the group are made the same as for
  778. others.
  779. When the file is renamed, this is the other way around: The backup has
  780. the same attributes of the original file, and the newly written file
  781. is owned by the current user. When the file was a (hard/symbolic)
  782. link, the new file will not! That's why the "auto" value doesn't
  783. rename when the file is a link. The owner and group of the newly
  784. written file will be set to the same ones as the original file, but
  785. the system may refuse to do this. In that case the "auto" value will
  786. again not rename the file.
  787. *'backupdir'* *'bdir'*
  788. 'backupdir' 'bdir' string (default ".,$XDG_STATE_HOME/nvim/backup//")
  789. global
  790. List of directories for the backup file, separated with commas.
  791. - The backup file will be created in the first directory in the list
  792. where this is possible. If none of the directories exist Nvim will
  793. attempt to create the last directory in the list.
  794. - Empty means that no backup file will be created ('patchmode' is
  795. impossible!). Writing may fail because of this.
  796. - A directory "." means to put the backup file in the same directory
  797. as the edited file.
  798. - A directory starting with "./" (or ".\" for MS-Windows) means to put
  799. the backup file relative to where the edited file is. The leading
  800. "." is replaced with the path name of the edited file.
  801. ("." inside a directory name has no special meaning).
  802. - Spaces after the comma are ignored, other spaces are considered part
  803. of the directory name. To have a space at the start of a directory
  804. name, precede it with a backslash.
  805. - To include a comma in a directory name precede it with a backslash.
  806. - A directory name may end in an '/'.
  807. - For Unix and Win32, if a directory ends in two path separators "//",
  808. the swap file name will be built from the complete path to the file
  809. with all path separators changed to percent '%' signs. This will
  810. ensure file name uniqueness in the backup directory.
  811. On Win32, it is also possible to end with "\\". However, When a
  812. separating comma is following, you must use "//", since "\\" will
  813. include the comma in the file name. Therefore it is recommended to
  814. use '//', instead of '\\'.
  815. - Environment variables are expanded |:set_env|.
  816. - Careful with '\' characters, type one before a space, type two to
  817. get one in the option (see |option-backslash|), for example: >vim
  818. set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  819. <
  820. See also 'backup' and 'writebackup' options.
  821. If you want to hide your backup files on Unix, consider this value: >vim
  822. set backupdir=./.backup,~/.backup,.,/tmp
  823. < You must create a ".backup" directory in each directory and in your
  824. home directory for this to work properly.
  825. The use of |:set+=| and |:set-=| is preferred when adding or removing
  826. directories from the list. This avoids problems when a future version
  827. uses another default.
  828. This option cannot be set from a |modeline| or in the |sandbox|, for
  829. security reasons.
  830. *'backupext'* *'bex'* *E589*
  831. 'backupext' 'bex' string (default "~")
  832. global
  833. String which is appended to a file name to make the name of the
  834. backup file. The default is quite unusual, because this avoids
  835. accidentally overwriting existing files with a backup file. You might
  836. prefer using ".bak", but make sure that you don't have files with
  837. ".bak" that you want to keep.
  838. Only normal file name characters can be used; `/\*?[|<>` are illegal.
  839. If you like to keep a lot of backups, you could use a BufWritePre
  840. autocommand to change 'backupext' just before writing the file to
  841. include a timestamp. >vim
  842. au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
  843. < Use 'backupdir' to put the backup in a different directory.
  844. *'backupskip'* *'bsk'*
  845. 'backupskip' 'bsk' string (default "$TMPDIR/*,$TMP/*,$TEMP/*"
  846. Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
  847. Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
  848. global
  849. A list of file patterns. When one of the patterns matches with the
  850. name of the file which is written, no backup file is created. Both
  851. the specified file name and the full path name of the file are used.
  852. The pattern is used like with |:autocmd|, see |autocmd-pattern|.
  853. Watch out for special characters, see |option-backslash|.
  854. When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
  855. default value. "/tmp/*" is only used for Unix.
  856. WARNING: Not having a backup file means that when Vim fails to write
  857. your buffer correctly and then, for whatever reason, Vim exits, you
  858. lose both the original file and what you were writing. Only disable
  859. backups if you don't care about losing the file.
  860. Note that environment variables are not expanded. If you want to use
  861. $HOME you must expand it explicitly, e.g.: >vim
  862. let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
  863. < Note that the default also makes sure that "crontab -e" works (when a
  864. backup would be made by renaming the original file crontab won't see
  865. the newly created file). Also see 'backupcopy' and |crontab|.
  866. *'belloff'* *'bo'*
  867. 'belloff' 'bo' string (default "all")
  868. global
  869. Specifies for which events the bell will not be rung. It is a comma-
  870. separated list of items. For each item that is present, the bell
  871. will be silenced. This is most useful to specify specific events in
  872. insert mode to be silenced.
  873. You can also make it flash by using 'visualbell'.
  874. item meaning when present ~
  875. all All events.
  876. backspace When hitting <BS> or <Del> and deleting results in an
  877. error.
  878. cursor Fail to move around using the cursor keys or
  879. <PageUp>/<PageDown> in |Insert-mode|.
  880. complete Error occurred when using |i_CTRL-X_CTRL-K| or
  881. |i_CTRL-X_CTRL-T|.
  882. copy Cannot copy char from insert mode using |i_CTRL-Y| or
  883. |i_CTRL-E|.
  884. ctrlg Unknown Char after <C-G> in Insert mode.
  885. error Other Error occurred (e.g. try to join last line)
  886. (mostly used in |Normal-mode| or |Cmdline-mode|).
  887. esc hitting <Esc> in |Normal-mode|.
  888. hangul Ignored.
  889. lang Calling the beep module for Lua/Mzscheme/TCL.
  890. mess No output available for |g<|.
  891. showmatch Error occurred for 'showmatch' function.
  892. operator Empty region error |cpo-E|.
  893. register Unknown register after <C-R> in |Insert-mode|.
  894. shell Bell from shell output |:!|.
  895. spell Error happened on spell suggest.
  896. term Bell from |:terminal| output.
  897. wildmode More matches in |cmdline-completion| available
  898. (depends on the 'wildmode' setting).
  899. This is most useful to fine tune when in Insert mode the bell should
  900. be rung. For Normal mode and Ex commands, the bell is often rung to
  901. indicate that an error occurred. It can be silenced by adding the
  902. "error" keyword.
  903. *'binary'* *'bin'* *'nobinary'* *'nobin'*
  904. 'binary' 'bin' boolean (default off)
  905. local to buffer
  906. This option should be set before editing a binary file. You can also
  907. use the |-b| Vim argument. When this option is switched on a few
  908. options will be changed (also when it already was on):
  909. 'textwidth' will be set to 0
  910. 'wrapmargin' will be set to 0
  911. 'modeline' will be off
  912. 'expandtab' will be off
  913. Also, 'fileformat' and 'fileformats' options will not be used, the
  914. file is read and written like 'fileformat' was "unix" (a single <NL>
  915. separates lines).
  916. The 'fileencoding' and 'fileencodings' options will not be used, the
  917. file is read without conversion.
  918. NOTE: When you start editing a(nother) file while the 'bin' option is
  919. on, settings from autocommands may change the settings again (e.g.,
  920. 'textwidth'), causing trouble when editing. You might want to set
  921. 'bin' again when the file has been loaded.
  922. The previous values of these options are remembered and restored when
  923. 'bin' is switched from on to off. Each buffer has its own set of
  924. saved option values.
  925. To edit a file with 'binary' set you can use the |++bin| argument.
  926. This avoids you have to do ":set bin", which would have effect for all
  927. files you edit.
  928. When writing a file the <EOL> for the last line is only written if
  929. there was one in the original file (normally Vim appends an <EOL> to
  930. the last line if there is none; this would make the file longer). See
  931. the 'endofline' option.
  932. *'bomb'* *'nobomb'*
  933. 'bomb' boolean (default off)
  934. local to buffer
  935. When writing a file and the following conditions are met, a BOM (Byte
  936. Order Mark) is prepended to the file:
  937. - this option is on
  938. - the 'binary' option is off
  939. - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
  940. endian variants.
  941. Some applications use the BOM to recognize the encoding of the file.
  942. Often used for UCS-2 files on MS-Windows. For other applications it
  943. causes trouble, for example: "cat file1 file2" makes the BOM of file2
  944. appear halfway through the resulting file. Gcc doesn't accept a BOM.
  945. When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
  946. check for the presence of the BOM is done and 'bomb' set accordingly.
  947. Unless 'binary' is set, it is removed from the first line, so that you
  948. don't see it when editing. When you don't change the options, the BOM
  949. will be restored when writing the file.
  950. *'breakat'* *'brk'*
  951. 'breakat' 'brk' string (default " ^I!@*-+;:,./?")
  952. global
  953. This option lets you choose which characters might cause a line
  954. break if 'linebreak' is on. Only works for ASCII characters.
  955. *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
  956. 'breakindent' 'bri' boolean (default off)
  957. local to window
  958. Every wrapped line will continue visually indented (same amount of
  959. space as the beginning of that line), thus preserving horizontal blocks
  960. of text.
  961. *'breakindentopt'* *'briopt'*
  962. 'breakindentopt' 'briopt' string (default "")
  963. local to window
  964. Settings for 'breakindent'. It can consist of the following optional
  965. items and must be separated by a comma:
  966. min:{n} Minimum text width that will be kept after
  967. applying 'breakindent', even if the resulting
  968. text should normally be narrower. This prevents
  969. text indented almost to the right window border
  970. occupying lots of vertical space when broken.
  971. (default: 20)
  972. shift:{n} After applying 'breakindent', the wrapped line's
  973. beginning will be shifted by the given number of
  974. characters. It permits dynamic French paragraph
  975. indentation (negative) or emphasizing the line
  976. continuation (positive).
  977. (default: 0)
  978. sbr Display the 'showbreak' value before applying the
  979. additional indent.
  980. (default: off)
  981. list:{n} Adds an additional indent for lines that match a
  982. numbered or bulleted list (using the
  983. 'formatlistpat' setting).
  984. (default: 0)
  985. list:-1 Uses the width of a match with 'formatlistpat' for
  986. indentation.
  987. column:{n} Indent at column {n}. Will overrule the other
  988. sub-options. Note: an additional indent may be
  989. added for the 'showbreak' setting.
  990. (default: off)
  991. *'bufhidden'* *'bh'*
  992. 'bufhidden' 'bh' string (default "")
  993. local to buffer |local-noglobal|
  994. This option specifies what happens when a buffer is no longer
  995. displayed in a window:
  996. <empty> follow the global 'hidden' option
  997. hide hide the buffer (don't unload it), even if 'hidden' is
  998. not set
  999. unload unload the buffer, even if 'hidden' is set; the
  1000. |:hide| command will also unload the buffer
  1001. delete delete the buffer from the buffer list, even if
  1002. 'hidden' is set; the |:hide| command will also delete
  1003. the buffer, making it behave like |:bdelete|
  1004. wipe wipe the buffer from the buffer list, even if
  1005. 'hidden' is set; the |:hide| command will also wipe
  1006. out the buffer, making it behave like |:bwipeout|
  1007. CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
  1008. are lost without a warning. Also, these values may break autocommands
  1009. that switch between buffers temporarily.
  1010. This option is used together with 'buftype' and 'swapfile' to specify
  1011. special kinds of buffers. See |special-buffers|.
  1012. *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
  1013. 'buflisted' 'bl' boolean (default on)
  1014. local to buffer
  1015. When this option is set, the buffer shows up in the buffer list. If
  1016. it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
  1017. This option is reset by Vim for buffers that are only used to remember
  1018. a file name or marks. Vim sets it when starting to edit a buffer.
  1019. But not when moving to a buffer with ":buffer".
  1020. *'buftype'* *'bt'* *E382*
  1021. 'buftype' 'bt' string (default "")
  1022. local to buffer |local-noglobal|
  1023. The value of this option specifies the type of a buffer:
  1024. <empty> normal buffer
  1025. acwrite buffer will always be written with |BufWriteCmd|s
  1026. help help buffer (do not set this manually)
  1027. nofile buffer is not related to a file, will not be written
  1028. nowrite buffer will not be written
  1029. quickfix list of errors |:cwindow| or locations |:lwindow|
  1030. terminal |terminal-emulator| buffer
  1031. prompt buffer where only the last line can be edited, meant
  1032. to be used by a plugin, see |prompt-buffer|
  1033. This option is used together with 'bufhidden' and 'swapfile' to
  1034. specify special kinds of buffers. See |special-buffers|.
  1035. Also see |win_gettype()|, which returns the type of the window.
  1036. Be careful with changing this option, it can have many side effects!
  1037. One such effect is that Vim will not check the timestamp of the file,
  1038. if the file is changed by another program this will not be noticed.
  1039. A "quickfix" buffer is only used for the error list and the location
  1040. list. This value is set by the |:cwindow| and |:lwindow| commands and
  1041. you are not supposed to change it.
  1042. "nofile" and "nowrite" buffers are similar:
  1043. both: The buffer is not to be written to disk, ":w" doesn't
  1044. work (":w filename" does work though).
  1045. both: The buffer is never considered to be |'modified'|.
  1046. There is no warning when the changes will be lost, for
  1047. example when you quit Vim.
  1048. both: A swap file is only created when using too much memory
  1049. (when 'swapfile' has been reset there is never a swap
  1050. file).
  1051. nofile only: The buffer name is fixed, it is not handled like a
  1052. file name. It is not modified in response to a |:cd|
  1053. command.
  1054. both: When using ":e bufname" and already editing "bufname"
  1055. the buffer is made empty and autocommands are
  1056. triggered as usual for |:edit|.
  1057. *E676*
  1058. "acwrite" implies that the buffer name is not related to a file, like
  1059. "nofile", but it will be written. Thus, in contrast to "nofile" and
  1060. "nowrite", ":w" does work and a modified buffer can't be abandoned
  1061. without saving. For writing there must be matching |BufWriteCmd|,
  1062. |FileWriteCmd| or |FileAppendCmd| autocommands.
  1063. *'casemap'* *'cmp'*
  1064. 'casemap' 'cmp' string (default "internal,keepascii")
  1065. global
  1066. Specifies details about changing the case of letters. It may contain
  1067. these words, separated by a comma:
  1068. internal Use internal case mapping functions, the current
  1069. locale does not change the case mapping. When
  1070. "internal" is omitted, the towupper() and towlower()
  1071. system library functions are used when available.
  1072. keepascii For the ASCII characters (0x00 to 0x7f) use the US
  1073. case mapping, the current locale is not effective.
  1074. This probably only matters for Turkish.
  1075. *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
  1076. 'cdhome' 'cdh' boolean (default off)
  1077. global
  1078. When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
  1079. current working directory to the |$HOME| directory like in Unix.
  1080. When off, those commands just print the current directory name.
  1081. On Unix this option has no effect.
  1082. This option cannot be set from a |modeline| or in the |sandbox|, for
  1083. security reasons.
  1084. *'cdpath'* *'cd'* *E344* *E346*
  1085. 'cdpath' 'cd' string (default equivalent to $CDPATH or ",,")
  1086. global
  1087. This is a list of directories which will be searched when using the
  1088. |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
  1089. searched for has a relative path, not an absolute part starting with
  1090. "/", "./" or "../", the 'cdpath' option is not used then.
  1091. The 'cdpath' option's value has the same form and semantics as
  1092. |'path'|. Also see |file-searching|.
  1093. The default value is taken from $CDPATH, with a "," prepended to look
  1094. in the current directory first.
  1095. If the default value taken from $CDPATH is not what you want, include
  1096. a modified version of the following command in your vimrc file to
  1097. override it: >vim
  1098. let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
  1099. < This option cannot be set from a |modeline| or in the |sandbox|, for
  1100. security reasons.
  1101. (parts of 'cdpath' can be passed to the shell to expand file names).
  1102. *'cedit'*
  1103. 'cedit' string (default CTRL-F)
  1104. global
  1105. The key used in Command-line Mode to open the command-line window.
  1106. Only non-printable keys are allowed.
  1107. The key can be specified as a single character, but it is difficult to
  1108. type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
  1109. a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >vim
  1110. set cedit=^Y
  1111. set cedit=<Esc>
  1112. < |Nvi| also has this option, but it only uses the first character.
  1113. See |cmdwin|.
  1114. *'channel'*
  1115. 'channel' number (default 0)
  1116. local to buffer
  1117. |channel| connected to the buffer, or 0 if no channel is connected.
  1118. In a |:terminal| buffer this is the terminal channel.
  1119. Read-only.
  1120. *'charconvert'* *'ccv'* *E202* *E214* *E513*
  1121. 'charconvert' 'ccv' string (default "")
  1122. global
  1123. An expression that is used for character encoding conversion. It is
  1124. evaluated when a file that is to be read or has been written has a
  1125. different encoding from what is desired.
  1126. 'charconvert' is not used when the internal iconv() function is
  1127. supported and is able to do the conversion. Using iconv() is
  1128. preferred, because it is much faster.
  1129. 'charconvert' is not used when reading stdin |--|, because there is no
  1130. file to convert from. You will have to save the text in a file first.
  1131. The expression must return zero, false or an empty string for success,
  1132. non-zero or true for failure.
  1133. See |encoding-names| for possible encoding names.
  1134. Additionally, names given in 'fileencodings' and 'fileencoding' are
  1135. used.
  1136. Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
  1137. is done internally by Vim, 'charconvert' is not used for this.
  1138. Also used for Unicode conversion.
  1139. Example: >vim
  1140. set charconvert=CharConvert()
  1141. fun CharConvert()
  1142. system("recode "
  1143. \ .. v:charconvert_from .. ".." .. v:charconvert_to
  1144. \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
  1145. return v:shell_error
  1146. endfun
  1147. < The related Vim variables are:
  1148. v:charconvert_from name of the current encoding
  1149. v:charconvert_to name of the desired encoding
  1150. v:fname_in name of the input file
  1151. v:fname_out name of the output file
  1152. Note that v:fname_in and v:fname_out will never be the same.
  1153. The advantage of using a function call without arguments is that it is
  1154. faster, see |expr-option-function|.
  1155. If the 'charconvert' expression starts with s: or |<SID>|, then it is
  1156. replaced with the script ID (|local-function|). Example: >vim
  1157. set charconvert=s:MyConvert()
  1158. set charconvert=<SID>SomeConvert()
  1159. < Otherwise the expression is evaluated in the context of the script
  1160. where the option was set, thus script-local items are available.
  1161. This option cannot be set from a |modeline| or in the |sandbox|, for
  1162. security reasons.
  1163. *'cindent'* *'cin'* *'nocindent'* *'nocin'*
  1164. 'cindent' 'cin' boolean (default off)
  1165. local to buffer
  1166. Enables automatic C program indenting. See 'cinkeys' to set the keys
  1167. that trigger reindenting in insert mode and 'cinoptions' to set your
  1168. preferred indent style.
  1169. If 'indentexpr' is not empty, it overrules 'cindent'.
  1170. If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
  1171. the "=" operator indents using this algorithm rather than calling an
  1172. external program.
  1173. See |C-indenting|.
  1174. When you don't like the way 'cindent' works, try the 'smartindent'
  1175. option or 'indentexpr'.
  1176. *'cinkeys'* *'cink'*
  1177. 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
  1178. local to buffer
  1179. A list of keys that, when typed in Insert mode, cause reindenting of
  1180. the current line. Only used if 'cindent' is on and 'indentexpr' is
  1181. empty.
  1182. For the format of this option see |cinkeys-format|.
  1183. See |C-indenting|.
  1184. *'cinoptions'* *'cino'*
  1185. 'cinoptions' 'cino' string (default "")
  1186. local to buffer
  1187. The 'cinoptions' affect the way 'cindent' reindents lines in a C
  1188. program. See |cinoptions-values| for the values of this option, and
  1189. |C-indenting| for info on C indenting in general.
  1190. *'cinscopedecls'* *'cinsd'*
  1191. 'cinscopedecls' 'cinsd' string (default "public,protected,private")
  1192. local to buffer
  1193. Keywords that are interpreted as a C++ scope declaration by |cino-g|.
  1194. Useful e.g. for working with the Qt framework that defines additional
  1195. scope declarations "signals", "public slots" and "private slots": >vim
  1196. set cinscopedecls+=signals,public\ slots,private\ slots
  1197. <
  1198. *'cinwords'* *'cinw'*
  1199. 'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
  1200. local to buffer
  1201. These keywords start an extra indent in the next line when
  1202. 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
  1203. an appropriate place (inside {}).
  1204. Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
  1205. matter, include the keyword both the uppercase and lowercase:
  1206. "if,If,IF".
  1207. *'clipboard'* *'cb'*
  1208. 'clipboard' 'cb' string (default "")
  1209. global
  1210. This option is a list of comma-separated names.
  1211. These names are recognized:
  1212. *clipboard-unnamed*
  1213. unnamed When included, Vim will use the clipboard register "*"
  1214. for all yank, delete, change and put operations which
  1215. would normally go to the unnamed register. When a
  1216. register is explicitly specified, it will always be
  1217. used regardless of whether "unnamed" is in 'clipboard'
  1218. or not. The clipboard register can always be
  1219. explicitly accessed using the "* notation. Also see
  1220. |clipboard|.
  1221. *clipboard-unnamedplus*
  1222. unnamedplus A variant of the "unnamed" flag which uses the
  1223. clipboard register "+" (|quoteplus|) instead of
  1224. register "*" for all yank, delete, change and put
  1225. operations which would normally go to the unnamed
  1226. register. When "unnamed" is also included to the
  1227. option, yank and delete operations (but not put)
  1228. will additionally copy the text into register
  1229. "*". See |clipboard|.
  1230. *'cmdheight'* *'ch'*
  1231. 'cmdheight' 'ch' number (default 1)
  1232. global or local to tab page
  1233. Number of screen lines to use for the command-line. Helps avoiding
  1234. |hit-enter| prompts.
  1235. The value of this option is stored with the tab page, so that each tab
  1236. page can have a different value.
  1237. When 'cmdheight' is zero, there is no command-line unless it is being
  1238. used. The command-line will cover the last line of the screen when
  1239. shown.
  1240. WARNING: `cmdheight=0` is EXPERIMENTAL. Expect some unwanted behaviour.
  1241. Some 'shortmess' flags and similar mechanism might fail to take effect,
  1242. causing unwanted hit-enter prompts. Some informative messages, both
  1243. from Nvim itself and plugins, will not be displayed.
  1244. *'cmdwinheight'* *'cwh'*
  1245. 'cmdwinheight' 'cwh' number (default 7)
  1246. global
  1247. Number of screen lines to use for the command-line window. |cmdwin|
  1248. *'colorcolumn'* *'cc'*
  1249. 'colorcolumn' 'cc' string (default "")
  1250. local to window
  1251. 'colorcolumn' is a comma-separated list of screen columns that are
  1252. highlighted with ColorColumn |hl-ColorColumn|. Useful to align
  1253. text. Will make screen redrawing slower.
  1254. The screen column can be an absolute number, or a number preceded with
  1255. '+' or '-', which is added to or subtracted from 'textwidth'. >vim
  1256. set cc=+1 " highlight column after 'textwidth'
  1257. set cc=+1,+2,+3 " highlight three columns after 'textwidth'
  1258. hi ColorColumn ctermbg=lightgrey guibg=lightgrey
  1259. <
  1260. When 'textwidth' is zero then the items with '-' and '+' are not used.
  1261. A maximum of 256 columns are highlighted.
  1262. *'columns'* *'co'* *E594*
  1263. 'columns' 'co' number (default 80 or terminal width)
  1264. global
  1265. Number of columns of the screen. Normally this is set by the terminal
  1266. initialization and does not have to be set by hand.
  1267. When Vim is running in the GUI or in a resizable window, setting this
  1268. option will cause the window size to be changed. When you only want
  1269. to use the size for the GUI, put the command in your |ginit.vim| file.
  1270. When you set this option and Vim is unable to change the physical
  1271. number of columns of the display, the display may be messed up. For
  1272. the GUI it is always possible and Vim limits the number of columns to
  1273. what fits on the screen. You can use this command to get the widest
  1274. window possible: >vim
  1275. set columns=9999
  1276. < Minimum value is 12, maximum value is 10000.
  1277. *'comments'* *'com'* *E524* *E525*
  1278. 'comments' 'com' string (default "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-,fb:•")
  1279. local to buffer
  1280. A comma-separated list of strings that can start a comment line. See
  1281. |format-comments|. See |option-backslash| about using backslashes to
  1282. insert a space.
  1283. *'commentstring'* *'cms'* *E537*
  1284. 'commentstring' 'cms' string (default "")
  1285. local to buffer
  1286. A template for a comment. The "%s" in the value is replaced with the
  1287. comment text, and should be padded with a space when possible.
  1288. Used for |commenting| and to add markers for folding, see |fold-marker|.
  1289. *'complete'* *'cpt'* *E535*
  1290. 'complete' 'cpt' string (default ".,w,b,u,t")
  1291. local to buffer
  1292. This option specifies how keyword completion |ins-completion| works
  1293. when CTRL-P or CTRL-N are used. It is also used for whole-line
  1294. completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
  1295. and the places to scan. It is a comma-separated list of flags:
  1296. . scan the current buffer ('wrapscan' is ignored)
  1297. w scan buffers from other windows
  1298. b scan other loaded buffers that are in the buffer list
  1299. u scan the unloaded buffers that are in the buffer list
  1300. U scan the buffers that are not in the buffer list
  1301. k scan the files given with the 'dictionary' option
  1302. kspell use the currently active spell checking |spell|
  1303. k{dict} scan the file {dict}. Several "k" flags can be given,
  1304. patterns are valid too. For example: >vim
  1305. set cpt=k/usr/dict/*,k~/spanish
  1306. < s scan the files given with the 'thesaurus' option
  1307. s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
  1308. are valid too.
  1309. i scan current and included files
  1310. d scan current and included files for defined name or macro
  1311. |i_CTRL-X_CTRL-D|
  1312. ] tag completion
  1313. t same as "]"
  1314. f scan the buffer names (as opposed to buffer contents)
  1315. Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
  1316. not executed, this may lead to unexpected completions from some files
  1317. (gzipped files for example). Unloaded buffers are not scanned for
  1318. whole-line completion.
  1319. As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
  1320. based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
  1321. |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
  1322. *'completefunc'* *'cfu'*
  1323. 'completefunc' 'cfu' string (default "")
  1324. local to buffer
  1325. This option specifies a function to be used for Insert mode completion
  1326. with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
  1327. See |complete-functions| for an explanation of how the function is
  1328. invoked and what it should return. The value can be the name of a
  1329. function, a |lambda| or a |Funcref|. See |option-value-function| for
  1330. more information.
  1331. This option cannot be set from a |modeline| or in the |sandbox|, for
  1332. security reasons.
  1333. *'completeitemalign'* *'cia'*
  1334. 'completeitemalign' 'cia' string (default "abbr,kind,menu")
  1335. global
  1336. A comma-separated list of |complete-items| that controls the alignment
  1337. and display order of items in the popup menu during Insert mode
  1338. completion. The supported values are abbr, kind, and menu. These
  1339. options allow to customize how the completion items are shown in the
  1340. popup menu. Note: must always contain those three values in any
  1341. order.
  1342. *'completeopt'* *'cot'*
  1343. 'completeopt' 'cot' string (default "menu,preview")
  1344. global or local to buffer |global-local|
  1345. A comma-separated list of options for Insert mode completion
  1346. |ins-completion|. The supported values are:
  1347. menu Use a popup menu to show the possible completions. The
  1348. menu is only shown when there is more than one match and
  1349. sufficient colors are available. |ins-completion-menu|
  1350. menuone Use the popup menu also when there is only one match.
  1351. Useful when there is additional information about the
  1352. match, e.g., what file it comes from.
  1353. longest Only insert the longest common text of the matches. If
  1354. the menu is displayed you can use CTRL-L to add more
  1355. characters. Whether case is ignored depends on the kind
  1356. of completion. For buffer text the 'ignorecase' option is
  1357. used.
  1358. preview Show extra information about the currently selected
  1359. completion in the preview window. Only works in
  1360. combination with "menu" or "menuone".
  1361. popup Show extra information about the currently selected
  1362. completion in a popup window. Only works in combination
  1363. with "menu" or "menuone". Overrides "preview".
  1364. noinsert Do not insert any text for a match until the user selects
  1365. a match from the menu. Only works in combination with
  1366. "menu" or "menuone". No effect if "longest" is present.
  1367. noselect Same as "noinsert", except that no menu item is
  1368. pre-selected. If both "noinsert" and "noselect" are
  1369. present, "noselect" has precedence.
  1370. fuzzy Enable |fuzzy-matching| for completion candidates. This
  1371. allows for more flexible and intuitive matching, where
  1372. characters can be skipped and matches can be found even
  1373. if the exact sequence is not typed. Only makes a
  1374. difference how completion candidates are reduced from the
  1375. list of alternatives, but not how the candidates are
  1376. collected (using different completion types).
  1377. nosort Disable sorting of completion candidates based on fuzzy
  1378. scores when "fuzzy" is enabled. Candidates will appear
  1379. in their original order.
  1380. preinsert
  1381. Preinsert the portion of the first candidate word that is
  1382. not part of the current completion leader and using the
  1383. |hl-ComplMatchIns| highlight group. Does not work when
  1384. "fuzzy" is also included.
  1385. *'completeslash'* *'csl'*
  1386. 'completeslash' 'csl' string (default "")
  1387. local to buffer
  1388. only modifiable in MS-Windows
  1389. When this option is set it overrules 'shellslash' for completion:
  1390. - When this option is set to "slash", a forward slash is used for path
  1391. completion in insert mode. This is useful when editing HTML tag, or
  1392. Makefile with 'noshellslash' on MS-Windows.
  1393. - When this option is set to "backslash", backslash is used. This is
  1394. useful when editing a batch file with 'shellslash' set on MS-Windows.
  1395. - When this option is empty, same character is used as for
  1396. 'shellslash'.
  1397. For Insert mode completion the buffer-local value is used. For
  1398. command line completion the global value is used.
  1399. *'concealcursor'* *'cocu'*
  1400. 'concealcursor' 'cocu' string (default "")
  1401. local to window
  1402. Sets the modes in which text in the cursor line can also be concealed.
  1403. When the current mode is listed then concealing happens just like in
  1404. other lines.
  1405. n Normal mode
  1406. v Visual mode
  1407. i Insert mode
  1408. c Command line editing, for 'incsearch'
  1409. 'v' applies to all lines in the Visual area, not only the cursor.
  1410. A useful value is "nc". This is used in help files. So long as you
  1411. are moving around text is concealed, but when starting to insert text
  1412. or selecting a Visual area the concealed text is displayed, so that
  1413. you can see what you are doing.
  1414. Keep in mind that the cursor position is not always where it's
  1415. displayed. E.g., when moving vertically it may change column.
  1416. *'conceallevel'* *'cole'*
  1417. 'conceallevel' 'cole' number (default 0)
  1418. local to window
  1419. Determine how text with the "conceal" syntax attribute |:syn-conceal|
  1420. is shown:
  1421. Value Effect ~
  1422. 0 Text is shown normally
  1423. 1 Each block of concealed text is replaced with one
  1424. character. If the syntax item does not have a custom
  1425. replacement character defined (see |:syn-cchar|) the
  1426. character defined in 'listchars' is used.
  1427. It is highlighted with the "Conceal" highlight group.
  1428. 2 Concealed text is completely hidden unless it has a
  1429. custom replacement character defined (see
  1430. |:syn-cchar|).
  1431. 3 Concealed text is completely hidden.
  1432. Note: in the cursor line concealed text is not hidden, so that you can
  1433. edit and copy the text. This can be changed with the 'concealcursor'
  1434. option.
  1435. *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
  1436. 'confirm' 'cf' boolean (default off)
  1437. global
  1438. When 'confirm' is on, certain operations that would normally
  1439. fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
  1440. instead raise a dialog asking if you wish to save the current
  1441. file(s). You can still use a ! to unconditionally |abandon| a buffer.
  1442. If 'confirm' is off you can still activate confirmation for one
  1443. command only (this is most useful in mappings) with the |:confirm|
  1444. command.
  1445. Also see the |confirm()| function and the 'v' flag in 'guioptions'.
  1446. *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
  1447. 'copyindent' 'ci' boolean (default off)
  1448. local to buffer
  1449. Copy the structure of the existing lines indent when autoindenting a
  1450. new line. Normally the new indent is reconstructed by a series of
  1451. tabs followed by spaces as required (unless |'expandtab'| is enabled,
  1452. in which case only spaces are used). Enabling this option makes the
  1453. new line copy whatever characters were used for indenting on the
  1454. existing line. 'expandtab' has no effect on these characters, a Tab
  1455. remains a Tab. If the new indent is greater than on the existing
  1456. line, the remaining space is filled in the normal manner.
  1457. See 'preserveindent'.
  1458. *'cpoptions'* *'cpo'* *cpo*
  1459. 'cpoptions' 'cpo' string (default "aABceFs_")
  1460. global
  1461. A sequence of single character flags. When a character is present
  1462. this indicates Vi-compatible behavior. This is used for things where
  1463. not being Vi-compatible is mostly or sometimes preferred.
  1464. 'cpoptions' stands for "compatible-options".
  1465. Commas can be added for readability.
  1466. To avoid problems with flags that are added in the future, use the
  1467. "+=" and "-=" feature of ":set" |add-option-flags|.
  1468. contains behavior ~
  1469. *cpo-a*
  1470. a When included, a ":read" command with a file name
  1471. argument will set the alternate file name for the
  1472. current window.
  1473. *cpo-A*
  1474. A When included, a ":write" command with a file name
  1475. argument will set the alternate file name for the
  1476. current window.
  1477. *cpo-b*
  1478. b "\|" in a ":map" command is recognized as the end of
  1479. the map command. The '\' is included in the mapping,
  1480. the text after the '|' is interpreted as the next
  1481. command. Use a CTRL-V instead of a backslash to
  1482. include the '|' in the mapping. Applies to all
  1483. mapping, abbreviation, menu and autocmd commands.
  1484. See also |map_bar|.
  1485. *cpo-B*
  1486. B A backslash has no special meaning in mappings,
  1487. abbreviations, user commands and the "to" part of the
  1488. menu commands. Remove this flag to be able to use a
  1489. backslash like a CTRL-V. For example, the command
  1490. ":map X \<Esc>" results in X being mapped to:
  1491. 'B' included: "\^[" (^[ is a real <Esc>)
  1492. 'B' excluded: "<Esc>" (5 characters)
  1493. *cpo-c*
  1494. c Searching continues at the end of any match at the
  1495. cursor position, but not further than the start of the
  1496. next line. When not present searching continues
  1497. one character from the cursor position. With 'c'
  1498. "abababababab" only gets three matches when repeating
  1499. "/abab", without 'c' there are five matches.
  1500. *cpo-C*
  1501. C Do not concatenate sourced lines that start with a
  1502. backslash. See |line-continuation|.
  1503. *cpo-d*
  1504. d Using "./" in the 'tags' option doesn't mean to use
  1505. the tags file relative to the current file, but the
  1506. tags file in the current directory.
  1507. *cpo-D*
  1508. D Can't use CTRL-K to enter a digraph after Normal mode
  1509. commands with a character argument, like |r|, |f| and
  1510. |t|.
  1511. *cpo-e*
  1512. e When executing a register with ":@r", always add a
  1513. <CR> to the last line, also when the register is not
  1514. linewise. If this flag is not present, the register
  1515. is not linewise and the last line does not end in a
  1516. <CR>, then the last line is put on the command-line
  1517. and can be edited before hitting <CR>.
  1518. *cpo-E*
  1519. E It is an error when using "y", "d", "c", "g~", "gu" or
  1520. "gU" on an Empty region. The operators only work when
  1521. at least one character is to be operated on. Example:
  1522. This makes "y0" fail in the first column.
  1523. *cpo-f*
  1524. f When included, a ":read" command with a file name
  1525. argument will set the file name for the current buffer,
  1526. if the current buffer doesn't have a file name yet.
  1527. *cpo-F*
  1528. F When included, a ":write" command with a file name
  1529. argument will set the file name for the current
  1530. buffer, if the current buffer doesn't have a file name
  1531. yet. Also see |cpo-P|.
  1532. *cpo-i*
  1533. i When included, interrupting the reading of a file will
  1534. leave it modified.
  1535. *cpo-I*
  1536. I When moving the cursor up or down just after inserting
  1537. indent for 'autoindent', do not delete the indent.
  1538. *cpo-J*
  1539. J A |sentence| has to be followed by two spaces after
  1540. the '.', '!' or '?'. A <Tab> is not recognized as
  1541. white space.
  1542. *cpo-K*
  1543. K Don't wait for a key code to complete when it is
  1544. halfway through a mapping. This breaks mapping
  1545. <F1><F1> when only part of the second <F1> has been
  1546. read. It enables cancelling the mapping by typing
  1547. <F1><Esc>.
  1548. *cpo-l*
  1549. l Backslash in a [] range in a search pattern is taken
  1550. literally, only "\]", "\^", "\-" and "\\" are special.
  1551. See |/[]|
  1552. 'l' included: "/[ \t]" finds <Space>, '\' and 't'
  1553. 'l' excluded: "/[ \t]" finds <Space> and <Tab>
  1554. *cpo-L*
  1555. L When the 'list' option is set, 'wrapmargin',
  1556. 'textwidth', 'softtabstop' and Virtual Replace mode
  1557. (see |gR|) count a <Tab> as two characters, instead of
  1558. the normal behavior of a <Tab>.
  1559. *cpo-m*
  1560. m When included, a showmatch will always wait half a
  1561. second. When not included, a showmatch will wait half
  1562. a second or until a character is typed. |'showmatch'|
  1563. *cpo-M*
  1564. M When excluded, "%" matching will take backslashes into
  1565. account. Thus in "( \( )" and "\( ( \)" the outer
  1566. parenthesis match. When included "%" ignores
  1567. backslashes, which is Vi compatible.
  1568. *cpo-n*
  1569. n When included, the column used for 'number' and
  1570. 'relativenumber' will also be used for text of wrapped
  1571. lines.
  1572. *cpo-o*
  1573. o Line offset to search command is not remembered for
  1574. next search.
  1575. *cpo-O*
  1576. O Don't complain if a file is being overwritten, even
  1577. when it didn't exist when editing it. This is a
  1578. protection against a file unexpectedly created by
  1579. someone else. Vi didn't complain about this.
  1580. *cpo-P*
  1581. P When included, a ":write" command that appends to a
  1582. file will set the file name for the current buffer, if
  1583. the current buffer doesn't have a file name yet and
  1584. the 'F' flag is also included |cpo-F|.
  1585. *cpo-q*
  1586. q When joining multiple lines leave the cursor at the
  1587. position where it would be when joining two lines.
  1588. *cpo-r*
  1589. r Redo ("." command) uses "/" to repeat a search
  1590. command, instead of the actually used search string.
  1591. *cpo-R*
  1592. R Remove marks from filtered lines. Without this flag
  1593. marks are kept like |:keepmarks| was used.
  1594. *cpo-s*
  1595. s Set buffer options when entering the buffer for the
  1596. first time. This is like it is in Vim version 3.0.
  1597. And it is the default. If not present the options are
  1598. set when the buffer is created.
  1599. *cpo-S*
  1600. S Set buffer options always when entering a buffer
  1601. (except 'readonly', 'fileformat', 'filetype' and
  1602. 'syntax'). This is the (most) Vi compatible setting.
  1603. The options are set to the values in the current
  1604. buffer. When you change an option and go to another
  1605. buffer, the value is copied. Effectively makes the
  1606. buffer options global to all buffers.
  1607. 's' 'S' copy buffer options
  1608. no no when buffer created
  1609. yes no when buffer first entered (default)
  1610. X yes each time when buffer entered (vi comp.)
  1611. *cpo-t*
  1612. t Search pattern for the tag command is remembered for
  1613. "n" command. Otherwise Vim only puts the pattern in
  1614. the history for search pattern, but doesn't change the
  1615. last used search pattern.
  1616. *cpo-u*
  1617. u Undo is Vi compatible. See |undo-two-ways|.
  1618. *cpo-v*
  1619. v Backspaced characters remain visible on the screen in
  1620. Insert mode. Without this flag the characters are
  1621. erased from the screen right away. With this flag the
  1622. screen newly typed text overwrites backspaced
  1623. characters.
  1624. *cpo-W*
  1625. W Don't overwrite a readonly file. When omitted, ":w!"
  1626. overwrites a readonly file, if possible.
  1627. *cpo-x*
  1628. x <Esc> on the command-line executes the command-line.
  1629. The default in Vim is to abandon the command-line,
  1630. because <Esc> normally aborts a command. |c_<Esc>|
  1631. *cpo-X*
  1632. X When using a count with "R" the replaced text is
  1633. deleted only once. Also when repeating "R" with "."
  1634. and a count.
  1635. *cpo-y*
  1636. y A yank command can be redone with ".". Think twice if
  1637. you really want to use this, it may break some
  1638. plugins, since most people expect "." to only repeat a
  1639. change.
  1640. *cpo-Z*
  1641. Z When using "w!" while the 'readonly' option is set,
  1642. don't reset 'readonly'.
  1643. *cpo-!*
  1644. ! When redoing a filter command, use the last used
  1645. external command, whatever it was. Otherwise the last
  1646. used -filter- command is used.
  1647. *cpo-$*
  1648. $ When making a change to one line, don't redisplay the
  1649. line, but put a '$' at the end of the changed text.
  1650. The changed text will be overwritten when you type the
  1651. new text. The line is redisplayed if you type any
  1652. command that moves the cursor from the insertion
  1653. point.
  1654. *cpo-%*
  1655. % Vi-compatible matching is done for the "%" command.
  1656. Does not recognize "#if", "#endif", etc.
  1657. Does not recognize "/*" and "*/".
  1658. Parens inside single and double quotes are also
  1659. counted, causing a string that contains a paren to
  1660. disturb the matching. For example, in a line like
  1661. "if (strcmp("foo(", s))" the first paren does not
  1662. match the last one. When this flag is not included,
  1663. parens inside single and double quotes are treated
  1664. specially. When matching a paren outside of quotes,
  1665. everything inside quotes is ignored. When matching a
  1666. paren inside quotes, it will find the matching one (if
  1667. there is one). This works very well for C programs.
  1668. This flag is also used for other features, such as
  1669. C-indenting.
  1670. *cpo-+*
  1671. + When included, a ":write file" command will reset the
  1672. 'modified' flag of the buffer, even though the buffer
  1673. itself may still be different from its file.
  1674. *cpo->*
  1675. > When appending to a register, put a line break before
  1676. the appended text.
  1677. *cpo-;*
  1678. ; When using |,| or |;| to repeat the last |t| search
  1679. and the cursor is right in front of the searched
  1680. character, the cursor won't move. When not included,
  1681. the cursor would skip over it and jump to the
  1682. following occurrence.
  1683. *cpo-_*
  1684. _ When using |cw| on a word, do not include the
  1685. whitespace following the word in the motion.
  1686. *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
  1687. 'cursorbind' 'crb' boolean (default off)
  1688. local to window
  1689. When this option is set, as the cursor in the current
  1690. window moves other cursorbound windows (windows that also have
  1691. this option set) move their cursors to the corresponding line and
  1692. column. This option is useful for viewing the
  1693. differences between two versions of a file (see 'diff'); in diff mode,
  1694. inserted and deleted lines (though not characters within a line) are
  1695. taken into account.
  1696. *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
  1697. 'cursorcolumn' 'cuc' boolean (default off)
  1698. local to window
  1699. Highlight the screen column of the cursor with CursorColumn
  1700. |hl-CursorColumn|. Useful to align text. Will make screen redrawing
  1701. slower.
  1702. If you only want the highlighting in the current window you can use
  1703. these autocommands: >vim
  1704. au WinLeave * set nocursorline nocursorcolumn
  1705. au WinEnter * set cursorline cursorcolumn
  1706. <
  1707. *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
  1708. 'cursorline' 'cul' boolean (default off)
  1709. local to window
  1710. Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
  1711. Useful to easily spot the cursor. Will make screen redrawing slower.
  1712. When Visual mode is active the highlighting isn't used to make it
  1713. easier to see the selected text.
  1714. *'cursorlineopt'* *'culopt'*
  1715. 'cursorlineopt' 'culopt' string (default "both")
  1716. local to window
  1717. Comma-separated list of settings for how 'cursorline' is displayed.
  1718. Valid values:
  1719. "line" Highlight the text line of the cursor with
  1720. CursorLine |hl-CursorLine|.
  1721. "screenline" Highlight only the screen line of the cursor with
  1722. CursorLine |hl-CursorLine|.
  1723. "number" Highlight the line number of the cursor with
  1724. CursorLineNr |hl-CursorLineNr|.
  1725. Special value:
  1726. "both" Alias for the values "line,number".
  1727. "line" and "screenline" cannot be used together.
  1728. *'debug'*
  1729. 'debug' string (default "")
  1730. global
  1731. These values can be used:
  1732. msg Error messages that would otherwise be omitted will be given
  1733. anyway.
  1734. throw Error messages that would otherwise be omitted will be given
  1735. anyway and also throw an exception and set |v:errmsg|.
  1736. beep A message will be given when otherwise only a beep would be
  1737. produced.
  1738. The values can be combined, separated by a comma.
  1739. "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
  1740. 'indentexpr'.
  1741. *'define'* *'def'*
  1742. 'define' 'def' string (default "")
  1743. global or local to buffer |global-local|
  1744. Pattern to be used to find a macro definition. It is a search
  1745. pattern, just like for the "/" command. This option is used for the
  1746. commands like "[i" and "[d" |include-search|. The 'isident' option is
  1747. used to recognize the defined name after the match: >
  1748. {match with 'define'}{non-ID chars}{defined name}{non-ID char}
  1749. < See |option-backslash| about inserting backslashes to include a space
  1750. or backslash.
  1751. For C++ this value would be useful, to include const type declarations: >
  1752. ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
  1753. < You can also use "\ze" just before the name and continue the pattern
  1754. to check what is following. E.g. for Javascript, if a function is
  1755. defined with `func_name = function(args)`: >
  1756. ^\s*\ze\i\+\s*=\s*function(
  1757. < If the function is defined with `func_name : function() {...`: >
  1758. ^\s*\ze\i\+\s*[:]\s*(*function\s*(
  1759. < When using the ":set" command, you need to double the backslashes!
  1760. To avoid that use `:let` with a single quote string: >vim
  1761. let &l:define = '^\s*\ze\k\+\s*=\s*function('
  1762. <
  1763. *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
  1764. 'delcombine' 'deco' boolean (default off)
  1765. global
  1766. If editing Unicode and this option is set, backspace and Normal mode
  1767. "x" delete each combining character on its own. When it is off (the
  1768. default) the character along with its combining characters are
  1769. deleted.
  1770. Note: When 'delcombine' is set "xx" may work differently from "2x"!
  1771. This is useful for Arabic, Hebrew and many other languages where one
  1772. may have combining characters overtop of base characters, and want
  1773. to remove only the combining ones.
  1774. *'dictionary'* *'dict'*
  1775. 'dictionary' 'dict' string (default "")
  1776. global or local to buffer |global-local|
  1777. List of file names, separated by commas, that are used to lookup words
  1778. for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
  1779. contain a list of words. This can be one word per line, or several
  1780. words per line, separated by non-keyword characters (white space is
  1781. preferred). Maximum line length is 510 bytes.
  1782. When this option is empty or an entry "spell" is present, and spell
  1783. checking is enabled, words in the word lists for the currently active
  1784. 'spelllang' are used. See |spell|.
  1785. To include a comma in a file name precede it with a backslash. Spaces
  1786. after a comma are ignored, otherwise spaces are included in the file
  1787. name. See |option-backslash| about using backslashes.
  1788. This has nothing to do with the |Dictionary| variable type.
  1789. Where to find a list of words?
  1790. - BSD/macOS include the "/usr/share/dict/words" file.
  1791. - Try "apt install spell" to get the "/usr/share/dict/words" file on
  1792. apt-managed systems (Debian/Ubuntu).
  1793. The use of |:set+=| and |:set-=| is preferred when adding or removing
  1794. directories from the list. This avoids problems when a future version
  1795. uses another default.
  1796. Backticks cannot be used in this option for security reasons.
  1797. *'diff'* *'nodiff'*
  1798. 'diff' boolean (default off)
  1799. local to window
  1800. Join the current window in the group of windows that shows differences
  1801. between files. See |diff-mode|.
  1802. *'diffexpr'* *'dex'*
  1803. 'diffexpr' 'dex' string (default "")
  1804. global
  1805. Expression which is evaluated to obtain a diff file (either ed-style
  1806. or unified-style) from two versions of a file. See |diff-diffexpr|.
  1807. This option cannot be set from a |modeline| or in the |sandbox|, for
  1808. security reasons.
  1809. *'diffopt'* *'dip'*
  1810. 'diffopt' 'dip' string (default "internal,filler,closeoff")
  1811. global
  1812. Option settings for diff mode. It can consist of the following items.
  1813. All are optional. Items must be separated by a comma.
  1814. filler Show filler lines, to keep the text
  1815. synchronized with a window that has inserted
  1816. lines at the same position. Mostly useful
  1817. when windows are side-by-side and 'scrollbind'
  1818. is set.
  1819. context:{n} Use a context of {n} lines between a change
  1820. and a fold that contains unchanged lines.
  1821. When omitted a context of six lines is used.
  1822. When using zero the context is actually one,
  1823. since folds require a line in between, also
  1824. for a deleted line. Set it to a very large
  1825. value (999999) to disable folding completely.
  1826. See |fold-diff|.
  1827. iblank Ignore changes where lines are all blank. Adds
  1828. the "-B" flag to the "diff" command if
  1829. 'diffexpr' is empty. Check the documentation
  1830. of the "diff" command for what this does
  1831. exactly.
  1832. NOTE: the diff windows will get out of sync,
  1833. because no differences between blank lines are
  1834. taken into account.
  1835. icase Ignore changes in case of text. "a" and "A"
  1836. are considered the same. Adds the "-i" flag
  1837. to the "diff" command if 'diffexpr' is empty.
  1838. iwhite Ignore changes in amount of white space. Adds
  1839. the "-b" flag to the "diff" command if
  1840. 'diffexpr' is empty. Check the documentation
  1841. of the "diff" command for what this does
  1842. exactly. It should ignore adding trailing
  1843. white space, but not leading white space.
  1844. iwhiteall Ignore all white space changes. Adds
  1845. the "-w" flag to the "diff" command if
  1846. 'diffexpr' is empty. Check the documentation
  1847. of the "diff" command for what this does
  1848. exactly.
  1849. iwhiteeol Ignore white space changes at end of line.
  1850. Adds the "-Z" flag to the "diff" command if
  1851. 'diffexpr' is empty. Check the documentation
  1852. of the "diff" command for what this does
  1853. exactly.
  1854. horizontal Start diff mode with horizontal splits (unless
  1855. explicitly specified otherwise).
  1856. vertical Start diff mode with vertical splits (unless
  1857. explicitly specified otherwise).
  1858. closeoff When a window is closed where 'diff' is set
  1859. and there is only one window remaining in the
  1860. same tab page with 'diff' set, execute
  1861. `:diffoff` in that window. This undoes a
  1862. `:diffsplit` command.
  1863. hiddenoff Do not use diff mode for a buffer when it
  1864. becomes hidden.
  1865. foldcolumn:{n} Set the 'foldcolumn' option to {n} when
  1866. starting diff mode. Without this 2 is used.
  1867. followwrap Follow the 'wrap' option and leave as it is.
  1868. internal Use the internal diff library. This is
  1869. ignored when 'diffexpr' is set. *E960*
  1870. When running out of memory when writing a
  1871. buffer this item will be ignored for diffs
  1872. involving that buffer. Set the 'verbose'
  1873. option to see when this happens.
  1874. indent-heuristic
  1875. Use the indent heuristic for the internal
  1876. diff library.
  1877. linematch:{n} Enable a second stage diff on each generated
  1878. hunk in order to align lines. When the total
  1879. number of lines in a hunk exceeds {n}, the
  1880. second stage diff will not be performed as
  1881. very large hunks can cause noticeable lag. A
  1882. recommended setting is "linematch:60", as this
  1883. will enable alignment for a 2 buffer diff with
  1884. hunks of up to 30 lines each, or a 3 buffer
  1885. diff with hunks of up to 20 lines each.
  1886. algorithm:{text} Use the specified diff algorithm with the
  1887. internal diff engine. Currently supported
  1888. algorithms are:
  1889. myers the default algorithm
  1890. minimal spend extra time to generate the
  1891. smallest possible diff
  1892. patience patience diff algorithm
  1893. histogram histogram diff algorithm
  1894. Examples: >vim
  1895. set diffopt=internal,filler,context:4
  1896. set diffopt=
  1897. set diffopt=internal,filler,foldcolumn:3
  1898. set diffopt-=internal " do NOT use the internal diff parser
  1899. <
  1900. *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
  1901. 'digraph' 'dg' boolean (default off)
  1902. global
  1903. Enable the entering of digraphs in Insert mode with {char1} <BS>
  1904. {char2}. See |digraphs|.
  1905. *'directory'* *'dir'*
  1906. 'directory' 'dir' string (default "$XDG_STATE_HOME/nvim/swap//")
  1907. global
  1908. List of directory names for the swap file, separated with commas.
  1909. Possible items:
  1910. - The swap file will be created in the first directory where this is
  1911. possible. If it is not possible in any directory, but last
  1912. directory listed in the option does not exist, it is created.
  1913. - Empty means that no swap file will be used (recovery is
  1914. impossible!) and no |E303| error will be given.
  1915. - A directory "." means to put the swap file in the same directory as
  1916. the edited file. On Unix, a dot is prepended to the file name, so
  1917. it doesn't show in a directory listing. On MS-Windows the "hidden"
  1918. attribute is set and a dot prepended if possible.
  1919. - A directory starting with "./" (or ".\" for MS-Windows) means to put
  1920. the swap file relative to where the edited file is. The leading "."
  1921. is replaced with the path name of the edited file.
  1922. - For Unix and Win32, if a directory ends in two path separators "//",
  1923. the swap file name will be built from the complete path to the file
  1924. with all path separators replaced by percent '%' signs (including
  1925. the colon following the drive letter on Win32). This will ensure
  1926. file name uniqueness in the preserve directory.
  1927. On Win32, it is also possible to end with "\\". However, When a
  1928. separating comma is following, you must use "//", since "\\" will
  1929. include the comma in the file name. Therefore it is recommended to
  1930. use '//', instead of '\\'.
  1931. - Spaces after the comma are ignored, other spaces are considered part
  1932. of the directory name. To have a space at the start of a directory
  1933. name, precede it with a backslash.
  1934. - To include a comma in a directory name precede it with a backslash.
  1935. - A directory name may end in an ':' or '/'.
  1936. - Environment variables are expanded |:set_env|.
  1937. - Careful with '\' characters, type one before a space, type two to
  1938. get one in the option (see |option-backslash|), for example: >vim
  1939. set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  1940. <
  1941. Editing the same file twice will result in a warning. Using "/tmp" on
  1942. is discouraged: if the system crashes you lose the swap file. And
  1943. others on the computer may be able to see the files.
  1944. Use |:set+=| and |:set-=| when adding or removing directories from the
  1945. list, this avoids problems if the Nvim default is changed.
  1946. This option cannot be set from a |modeline| or in the |sandbox|, for
  1947. security reasons.
  1948. *'display'* *'dy'*
  1949. 'display' 'dy' string (default "lastline")
  1950. global
  1951. Change the way text is displayed. This is a comma-separated list of
  1952. flags:
  1953. lastline When included, as much as possible of the last line
  1954. in a window will be displayed. "@@@" is put in the
  1955. last columns of the last screen line to indicate the
  1956. rest of the line is not displayed.
  1957. truncate Like "lastline", but "@@@" is displayed in the first
  1958. column of the last screen line. Overrules "lastline".
  1959. uhex Show unprintable characters hexadecimal as <xx>
  1960. instead of using ^C and ~C.
  1961. msgsep Obsolete flag. Allowed but takes no effect. |msgsep|
  1962. When neither "lastline" nor "truncate" is included, a last line that
  1963. doesn't fit is replaced with "@" lines.
  1964. The "@" character can be changed by setting the "lastline" item in
  1965. 'fillchars'. The character is highlighted with |hl-NonText|.
  1966. *'eadirection'* *'ead'*
  1967. 'eadirection' 'ead' string (default "both")
  1968. global
  1969. Tells when the 'equalalways' option applies:
  1970. ver vertically, width of windows is not affected
  1971. hor horizontally, height of windows is not affected
  1972. both width and height of windows is affected
  1973. *'emoji'* *'emo'* *'noemoji'* *'noemo'*
  1974. 'emoji' 'emo' boolean (default on)
  1975. global
  1976. When on all Unicode emoji characters are considered to be full width.
  1977. This excludes "text emoji" characters, which are normally displayed as
  1978. single width. However, such "text emoji" are treated as full-width
  1979. emoji if they are followed by the U+FE0F variant selector.
  1980. Unfortunately there is no good specification for this and it has been
  1981. determined on trial-and-error basis. Use the |setcellwidths()|
  1982. function to change the behavior.
  1983. *'encoding'* *'enc'*
  1984. 'encoding' 'enc' string (default "utf-8")
  1985. global
  1986. String-encoding used internally and for |RPC| communication.
  1987. Always UTF-8.
  1988. See 'fileencoding' to control file-content encoding.
  1989. *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
  1990. 'endoffile' 'eof' boolean (default off)
  1991. local to buffer
  1992. Indicates that a CTRL-Z character was found at the end of the file
  1993. when reading it. Normally only happens when 'fileformat' is "dos".
  1994. When writing a file and this option is off and the 'binary' option
  1995. is on, or 'fixeol' option is off, no CTRL-Z will be written at the
  1996. end of the file.
  1997. See |eol-and-eof| for example settings.
  1998. *'endofline'* *'eol'* *'noendofline'* *'noeol'*
  1999. 'endofline' 'eol' boolean (default on)
  2000. local to buffer
  2001. When writing a file and this option is off and the 'binary' option
  2002. is on, or 'fixeol' option is off, no <EOL> will be written for the
  2003. last line in the file. This option is automatically set or reset when
  2004. starting to edit a new file, depending on whether file has an <EOL>
  2005. for the last line in the file. Normally you don't have to set or
  2006. reset this option.
  2007. When 'binary' is off and 'fixeol' is on the value is not used when
  2008. writing the file. When 'binary' is on or 'fixeol' is off it is used
  2009. to remember the presence of a <EOL> for the last line in the file, so
  2010. that when you write the file the situation from the original file can
  2011. be kept. But you can change it if you want to.
  2012. See |eol-and-eof| for example settings.
  2013. *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
  2014. 'equalalways' 'ea' boolean (default on)
  2015. global
  2016. When on, all the windows are automatically made the same size after
  2017. splitting or closing a window. This also happens the moment the
  2018. option is switched on. When off, splitting a window will reduce the
  2019. size of the current window and leave the other windows the same. When
  2020. closing a window the extra lines are given to the window next to it
  2021. (depending on 'splitbelow' and 'splitright').
  2022. When mixing vertically and horizontally split windows, a minimal size
  2023. is computed and some windows may be larger if there is room. The
  2024. 'eadirection' option tells in which direction the size is affected.
  2025. Changing the height and width of a window can be avoided by setting
  2026. 'winfixheight' and 'winfixwidth', respectively.
  2027. If a window size is specified when creating a new window sizes are
  2028. currently not equalized (it's complicated, but may be implemented in
  2029. the future).
  2030. *'equalprg'* *'ep'*
  2031. 'equalprg' 'ep' string (default "")
  2032. global or local to buffer |global-local|
  2033. External program to use for "=" command. When this option is empty
  2034. the internal formatting functions are used; either 'lisp', 'cindent'
  2035. or 'indentexpr'.
  2036. Environment variables are expanded |:set_env|. See |option-backslash|
  2037. about including spaces and backslashes.
  2038. This option cannot be set from a |modeline| or in the |sandbox|, for
  2039. security reasons.
  2040. *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
  2041. 'errorbells' 'eb' boolean (default off)
  2042. global
  2043. Ring the bell (beep or screen flash) for error messages. This only
  2044. makes a difference for error messages, the bell will be used always
  2045. for a lot of errors without a message (e.g., hitting <Esc> in Normal
  2046. mode). See 'visualbell' to make the bell behave like a screen flash
  2047. or do nothing. See 'belloff' to finetune when to ring the bell.
  2048. *'errorfile'* *'ef'*
  2049. 'errorfile' 'ef' string (default "errors.err")
  2050. global
  2051. Name of the errorfile for the QuickFix mode (see |:cf|).
  2052. When the "-q" command-line argument is used, 'errorfile' is set to the
  2053. following argument. See |-q|.
  2054. NOT used for the ":make" command. See 'makeef' for that.
  2055. Environment variables are expanded |:set_env|.
  2056. See |option-backslash| about including spaces and backslashes.
  2057. This option cannot be set from a |modeline| or in the |sandbox|, for
  2058. security reasons.
  2059. *'errorformat'* *'efm'*
  2060. 'errorformat' 'efm' string (default is very long)
  2061. global or local to buffer |global-local|
  2062. Scanf-like description of the format for the lines in the error file
  2063. (see |errorformat|).
  2064. *'eventignore'* *'ei'*
  2065. 'eventignore' 'ei' string (default "")
  2066. global
  2067. A list of autocommand event names, which are to be ignored.
  2068. When set to "all" or when "all" is one of the items, all autocommand
  2069. events are ignored, autocommands will not be executed.
  2070. Otherwise this is a comma-separated list of event names. Example: >vim
  2071. set ei=WinEnter,WinLeave
  2072. <
  2073. *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
  2074. 'expandtab' 'et' boolean (default off)
  2075. local to buffer
  2076. In Insert mode: Use the appropriate number of spaces to insert a
  2077. <Tab>. Spaces are used in indents with the '>' and '<' commands and
  2078. when 'autoindent' is on. To insert a real tab when 'expandtab' is
  2079. on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
  2080. *'exrc'* *'ex'* *'noexrc'* *'noex'*
  2081. 'exrc' 'ex' boolean (default off)
  2082. global
  2083. Automatically execute .nvim.lua, .nvimrc, and .exrc files in the
  2084. current directory, if the file is in the |trust| list. Use |:trust| to
  2085. manage trusted files. See also |vim.secure.read()|.
  2086. Compare 'exrc' to |editorconfig|:
  2087. - 'exrc' can execute any code; editorconfig only specifies settings.
  2088. - 'exrc' is Nvim-specific; editorconfig works in other editors.
  2089. This option cannot be set from a |modeline| or in the |sandbox|, for
  2090. security reasons.
  2091. *'fileencoding'* *'fenc'* *E213*
  2092. 'fileencoding' 'fenc' string (default "")
  2093. local to buffer
  2094. File-content encoding for the current buffer. Conversion is done with
  2095. iconv() or as specified with 'charconvert'.
  2096. When 'fileencoding' is not UTF-8, conversion will be done when
  2097. writing the file. For reading see below.
  2098. When 'fileencoding' is empty, the file will be saved with UTF-8
  2099. encoding (no conversion when reading or writing a file).
  2100. WARNING: Conversion to a non-Unicode encoding can cause loss of
  2101. information!
  2102. See |encoding-names| for the possible values. Additionally, values may be
  2103. specified that can be handled by the converter, see
  2104. |mbyte-conversion|.
  2105. When reading a file 'fileencoding' will be set from 'fileencodings'.
  2106. To read a file in a certain encoding it won't work by setting
  2107. 'fileencoding', use the |++enc| argument. One exception: when
  2108. 'fileencodings' is empty the value of 'fileencoding' is used.
  2109. For a new file the global value of 'fileencoding' is used.
  2110. Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
  2111. When the option is set, the value is converted to lowercase. Thus
  2112. you can set it with uppercase values too. '_' characters are
  2113. replaced with '-'. If a name is recognized from the list at
  2114. |encoding-names|, it is replaced by the standard name. For example
  2115. "ISO8859-2" becomes "iso-8859-2".
  2116. When this option is set, after starting to edit a file, the 'modified'
  2117. option is set, because the file would be different when written.
  2118. Keep in mind that changing 'fenc' from a modeline happens
  2119. AFTER the text has been read, thus it applies to when the file will be
  2120. written. If you do set 'fenc' in a modeline, you might want to set
  2121. 'nomodified' to avoid not being able to ":q".
  2122. This option cannot be changed when 'modifiable' is off.
  2123. *'fileencodings'* *'fencs'*
  2124. 'fileencodings' 'fencs' string (default "ucs-bom,utf-8,default,latin1")
  2125. global
  2126. This is a list of character encodings considered when starting to edit
  2127. an existing file. When a file is read, Vim tries to use the first
  2128. mentioned character encoding. If an error is detected, the next one
  2129. in the list is tried. When an encoding is found that works,
  2130. 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
  2131. an empty string, which means that UTF-8 is used.
  2132. WARNING: Conversion can cause loss of information! You can use
  2133. the |++bad| argument to specify what is done with characters
  2134. that can't be converted.
  2135. For an empty file or a file with only ASCII characters most encodings
  2136. will work and the first entry of 'fileencodings' will be used (except
  2137. "ucs-bom", which requires the BOM to be present). If you prefer
  2138. another encoding use an BufReadPost autocommand event to test if your
  2139. preferred encoding is to be used. Example: >vim
  2140. au BufReadPost * if search('\S', 'w') == 0 |
  2141. \ set fenc=iso-2022-jp | endif
  2142. < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
  2143. non-blank characters.
  2144. When the |++enc| argument is used then the value of 'fileencodings' is
  2145. not used.
  2146. Note that 'fileencodings' is not used for a new file, the global value
  2147. of 'fileencoding' is used instead. You can set it with: >vim
  2148. setglobal fenc=iso-8859-2
  2149. < This means that a non-existing file may get a different encoding than
  2150. an empty file.
  2151. The special value "ucs-bom" can be used to check for a Unicode BOM
  2152. (Byte Order Mark) at the start of the file. It must not be preceded
  2153. by "utf-8" or another Unicode encoding for this to work properly.
  2154. An entry for an 8-bit encoding (e.g., "latin1") should be the last,
  2155. because Vim cannot detect an error, thus the encoding is always
  2156. accepted.
  2157. The special value "default" can be used for the encoding from the
  2158. environment. It is useful when your environment uses a non-latin1
  2159. encoding, such as Russian.
  2160. When a file contains an illegal UTF-8 byte sequence it won't be
  2161. recognized as "utf-8". You can use the |8g8| command to find the
  2162. illegal byte sequence.
  2163. WRONG VALUES: WHAT'S WRONG:
  2164. latin1,utf-8 "latin1" will always be used
  2165. utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
  2166. file
  2167. cp1250,latin1 "cp1250" will always be used
  2168. If 'fileencodings' is empty, 'fileencoding' is not modified.
  2169. See 'fileencoding' for the possible values.
  2170. Setting this option does not have an effect until the next time a file
  2171. is read.
  2172. *'fileformat'* *'ff'*
  2173. 'fileformat' 'ff' string (default Windows: "dos", Unix: "unix")
  2174. local to buffer
  2175. This gives the <EOL> of the current buffer, which is used for
  2176. reading/writing the buffer from/to a file:
  2177. dos <CR><NL>
  2178. unix <NL>
  2179. mac <CR>
  2180. When "dos" is used, CTRL-Z at the end of a file is ignored.
  2181. See |file-formats| and |file-read|.
  2182. For the character encoding of the file see 'fileencoding'.
  2183. When 'binary' is set, the value of 'fileformat' is ignored, file I/O
  2184. works like it was set to "unix".
  2185. This option is set automatically when starting to edit a file and
  2186. 'fileformats' is not empty and 'binary' is off.
  2187. When this option is set, after starting to edit a file, the 'modified'
  2188. option is set, because the file would be different when written.
  2189. This option cannot be changed when 'modifiable' is off.
  2190. *'fileformats'* *'ffs'*
  2191. 'fileformats' 'ffs' string (default Windows: "dos,unix", Unix: "unix,dos")
  2192. global
  2193. This gives the end-of-line (<EOL>) formats that will be tried when
  2194. starting to edit a new buffer and when reading a file into an existing
  2195. buffer:
  2196. - When empty, the format defined with 'fileformat' will be used
  2197. always. It is not set automatically.
  2198. - When set to one name, that format will be used whenever a new buffer
  2199. is opened. 'fileformat' is set accordingly for that buffer. The
  2200. 'fileformats' name will be used when a file is read into an existing
  2201. buffer, no matter what 'fileformat' for that buffer is set to.
  2202. - When more than one name is present, separated by commas, automatic
  2203. <EOL> detection will be done when reading a file. When starting to
  2204. edit a file, a check is done for the <EOL>:
  2205. 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
  2206. 'fileformat' is set to "dos".
  2207. 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
  2208. is set to "unix". Note that when a <NL> is found without a
  2209. preceding <CR>, "unix" is preferred over "dos".
  2210. 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
  2211. if 'fileformats' includes "mac", 'fileformat' is set to "mac".
  2212. This means that "mac" is only chosen when:
  2213. "unix" is not present or no <NL> is found in the file, and
  2214. "dos" is not present or no <CR><NL> is found in the file.
  2215. Except: if "unix" was chosen, but there is a <CR> before
  2216. the first <NL>, and there appear to be more <CR>s than <NL>s in
  2217. the first few lines, "mac" is used.
  2218. 4. If 'fileformat' is still not set, the first name from
  2219. 'fileformats' is used.
  2220. When reading a file into an existing buffer, the same is done, but
  2221. this happens like 'fileformat' has been set appropriately for that
  2222. file only, the option is not changed.
  2223. When 'binary' is set, the value of 'fileformats' is not used.
  2224. When Vim starts up with an empty buffer the first item is used. You
  2225. can overrule this by setting 'fileformat' in your .vimrc.
  2226. For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
  2227. are ":source"ed and for vimrc files, automatic <EOL> detection may be
  2228. done:
  2229. - When 'fileformats' is empty, there is no automatic detection. Dos
  2230. format will be used.
  2231. - When 'fileformats' is set to one or more names, automatic detection
  2232. is done. This is based on the first <NL> in the file: If there is a
  2233. <CR> in front of it, Dos format is used, otherwise Unix format is
  2234. used.
  2235. Also see |file-formats|.
  2236. *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
  2237. 'fileignorecase' 'fic' boolean (default on for systems where case in file
  2238. names is normally ignored)
  2239. global
  2240. When set case is ignored when using file names and directories.
  2241. See 'wildignorecase' for only ignoring case when doing completion.
  2242. *'filetype'* *'ft'*
  2243. 'filetype' 'ft' string (default "")
  2244. local to buffer |local-noglobal|
  2245. When this option is set, the FileType autocommand event is triggered.
  2246. All autocommands that match with the value of this option will be
  2247. executed. Thus the value of 'filetype' is used in place of the file
  2248. name.
  2249. Otherwise this option does not always reflect the current file type.
  2250. This option is normally set when the file type is detected. To enable
  2251. this use the ":filetype on" command. |:filetype|
  2252. Setting this option to a different value is most useful in a modeline,
  2253. for a file for which the file type is not automatically recognized.
  2254. Example, for in an IDL file: >c
  2255. /* vim: set filetype=idl : */
  2256. < |FileType| |filetypes|
  2257. When a dot appears in the value then this separates two filetype
  2258. names, it should therefore not be used for a filetype. Example: >c
  2259. /* vim: set filetype=c.doxygen : */
  2260. < This will use the "c" filetype first, then the "doxygen" filetype.
  2261. This works both for filetype plugins and for syntax files. More than
  2262. one dot may appear.
  2263. This option is not copied to another buffer, independent of the 's' or
  2264. 'S' flag in 'cpoptions'.
  2265. Only alphanumeric characters, '-' and '_' can be used.
  2266. *'fillchars'* *'fcs'*
  2267. 'fillchars' 'fcs' string (default "")
  2268. global or local to window |global-local|
  2269. Characters to fill the statuslines, vertical separators and special
  2270. lines in the window.
  2271. It is a comma-separated list of items. Each item has a name, a colon
  2272. and the value of that item: |E1511|
  2273. item default Used for ~
  2274. stl ' ' statusline of the current window
  2275. stlnc ' ' statusline of the non-current windows
  2276. wbr ' ' window bar
  2277. horiz '─' or '-' horizontal separators |:split|
  2278. horizup '┴' or '-' upwards facing horizontal separator
  2279. horizdown '┬' or '-' downwards facing horizontal separator
  2280. vert '│' or '|' vertical separators |:vsplit|
  2281. vertleft '┤' or '|' left facing vertical separator
  2282. vertright '├' or '|' right facing vertical separator
  2283. verthoriz '┼' or '+' overlapping vertical and horizontal
  2284. separator
  2285. fold '·' or '-' filling 'foldtext'
  2286. foldopen '-' mark the beginning of a fold
  2287. foldclose '+' show a closed fold
  2288. foldsep '│' or '|' open fold middle marker
  2289. diff '-' deleted lines of the 'diff' option
  2290. msgsep ' ' message separator 'display'
  2291. eob '~' empty lines at the end of a buffer
  2292. lastline '@' 'display' contains lastline/truncate
  2293. Any one that is omitted will fall back to the default.
  2294. Note that "horiz", "horizup", "horizdown", "vertleft", "vertright" and
  2295. "verthoriz" are only used when 'laststatus' is 3, since only vertical
  2296. window separators are used otherwise.
  2297. If 'ambiwidth' is "double" then "horiz", "horizup", "horizdown",
  2298. "vert", "vertleft", "vertright", "verthoriz", "foldsep" and "fold"
  2299. default to single-byte alternatives.
  2300. Example: >vim
  2301. set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
  2302. <
  2303. For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
  2304. single-byte and multibyte characters are supported. But double-width
  2305. characters are not supported. |E1512|
  2306. The highlighting used for these items:
  2307. item highlight group ~
  2308. stl StatusLine |hl-StatusLine|
  2309. stlnc StatusLineNC |hl-StatusLineNC|
  2310. wbr WinBar |hl-WinBar| or |hl-WinBarNC|
  2311. horiz WinSeparator |hl-WinSeparator|
  2312. horizup WinSeparator |hl-WinSeparator|
  2313. horizdown WinSeparator |hl-WinSeparator|
  2314. vert WinSeparator |hl-WinSeparator|
  2315. vertleft WinSeparator |hl-WinSeparator|
  2316. vertright WinSeparator |hl-WinSeparator|
  2317. verthoriz WinSeparator |hl-WinSeparator|
  2318. fold Folded |hl-Folded|
  2319. diff DiffDelete |hl-DiffDelete|
  2320. eob EndOfBuffer |hl-EndOfBuffer|
  2321. lastline NonText |hl-NonText|
  2322. *'findfunc'* *'ffu'* *E1514*
  2323. 'findfunc' 'ffu' string (default "")
  2324. global or local to buffer |global-local|
  2325. Function that is called to obtain the filename(s) for the |:find|
  2326. command. When this option is empty, the internal |file-searching|
  2327. mechanism is used.
  2328. The value can be the name of a function, a |lambda| or a |Funcref|.
  2329. See |option-value-function| for more information.
  2330. The function is called with two arguments. The first argument is a
  2331. |String| and is the |:find| command argument. The second argument is
  2332. a |Boolean| and is set to |v:true| when the function is called to get
  2333. a List of command-line completion matches for the |:find| command.
  2334. The function should return a List of strings.
  2335. The function is called only once per |:find| command invocation.
  2336. The function can process all the directories specified in 'path'.
  2337. If a match is found, the function should return a |List| containing
  2338. one or more file names. If a match is not found, the function
  2339. should return an empty List.
  2340. If any errors are encountered during the function invocation, an
  2341. empty List is used as the return value.
  2342. It is not allowed to change text or jump to another window while
  2343. executing the 'findfunc' |textlock|.
  2344. This option cannot be set from a |modeline| or in the |sandbox|, for
  2345. security reasons.
  2346. Examples:
  2347. >vim
  2348. " Use glob()
  2349. func FindFuncGlob(cmdarg, cmdcomplete)
  2350. let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
  2351. return glob(pat, v:false, v:true)
  2352. endfunc
  2353. set findfunc=FindFuncGlob
  2354. " Use the 'git ls-files' output
  2355. func FindGitFiles(cmdarg, cmdcomplete)
  2356. let fnames = systemlist('git ls-files')
  2357. return fnames->filter('v:val =~? a:cmdarg')
  2358. endfunc
  2359. set findfunc=FindGitFiles
  2360. <
  2361. *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
  2362. 'fixendofline' 'fixeol' boolean (default on)
  2363. local to buffer
  2364. When writing a file and this option is on, <EOL> at the end of file
  2365. will be restored if missing. Turn this option off if you want to
  2366. preserve the situation from the original file.
  2367. When the 'binary' option is set the value of this option doesn't
  2368. matter.
  2369. See the 'endofline' option.
  2370. See |eol-and-eof| for example settings.
  2371. *'foldclose'* *'fcl'*
  2372. 'foldclose' 'fcl' string (default "")
  2373. global
  2374. When set to "all", a fold is closed when the cursor isn't in it and
  2375. its level is higher than 'foldlevel'. Useful if you want folds to
  2376. automatically close when moving out of them.
  2377. *'foldcolumn'* *'fdc'*
  2378. 'foldcolumn' 'fdc' string (default "0")
  2379. local to window
  2380. When and how to draw the foldcolumn. Valid values are:
  2381. "auto": resize to the minimum amount of folds to display.
  2382. "auto:[1-9]": resize to accommodate multiple folds up to the
  2383. selected level
  2384. "0": to disable foldcolumn
  2385. "[1-9]": to display a fixed number of columns
  2386. See |folding|.
  2387. *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
  2388. 'foldenable' 'fen' boolean (default on)
  2389. local to window
  2390. When off, all folds are open. This option can be used to quickly
  2391. switch between showing all text unfolded and viewing the text with
  2392. folds (including manually opened or closed folds). It can be toggled
  2393. with the |zi| command. The 'foldcolumn' will remain blank when
  2394. 'foldenable' is off.
  2395. This option is set by commands that create a new fold or close a fold.
  2396. See |folding|.
  2397. *'foldexpr'* *'fde'*
  2398. 'foldexpr' 'fde' string (default "0")
  2399. local to window
  2400. The expression used for when 'foldmethod' is "expr". It is evaluated
  2401. for each line to obtain its fold level. The context is set to the
  2402. script where 'foldexpr' was set, script-local items can be accessed.
  2403. See |fold-expr| for the usage.
  2404. The expression will be evaluated in the |sandbox| if set from a
  2405. modeline, see |sandbox-option|.
  2406. This option can't be set from a |modeline| when the 'diff' option is
  2407. on or the 'modelineexpr' option is off.
  2408. It is not allowed to change text or jump to another window while
  2409. evaluating 'foldexpr' |textlock|.
  2410. *'foldignore'* *'fdi'*
  2411. 'foldignore' 'fdi' string (default "#")
  2412. local to window
  2413. Used only when 'foldmethod' is "indent". Lines starting with
  2414. characters in 'foldignore' will get their fold level from surrounding
  2415. lines. White space is skipped before checking for this character.
  2416. The default "#" works well for C programs. See |fold-indent|.
  2417. *'foldlevel'* *'fdl'*
  2418. 'foldlevel' 'fdl' number (default 0)
  2419. local to window
  2420. Sets the fold level: Folds with a higher level will be closed.
  2421. Setting this option to zero will close all folds. Higher numbers will
  2422. close fewer folds.
  2423. This option is set by commands like |zm|, |zM| and |zR|.
  2424. See |fold-foldlevel|.
  2425. *'foldlevelstart'* *'fdls'*
  2426. 'foldlevelstart' 'fdls' number (default -1)
  2427. global
  2428. Sets 'foldlevel' when starting to edit another buffer in a window.
  2429. Useful to always start editing with all folds closed (value zero),
  2430. some folds closed (one) or no folds closed (99).
  2431. This is done before reading any modeline, thus a setting in a modeline
  2432. overrules this option. Starting to edit a file for |diff-mode| also
  2433. ignores this option and closes all folds.
  2434. It is also done before BufReadPre autocommands, to allow an autocmd to
  2435. overrule the 'foldlevel' value for specific files.
  2436. When the value is negative, it is not used.
  2437. *'foldmarker'* *'fmr'* *E536*
  2438. 'foldmarker' 'fmr' string (default "{{{,}}}")
  2439. local to window
  2440. The start and end marker used when 'foldmethod' is "marker". There
  2441. must be one comma, which separates the start and end marker. The
  2442. marker is a literal string (a regular expression would be too slow).
  2443. See |fold-marker|.
  2444. *'foldmethod'* *'fdm'*
  2445. 'foldmethod' 'fdm' string (default "manual")
  2446. local to window
  2447. The kind of folding used for the current window. Possible values:
  2448. |fold-manual| manual Folds are created manually.
  2449. |fold-indent| indent Lines with equal indent form a fold.
  2450. |fold-expr| expr 'foldexpr' gives the fold level of a line.
  2451. |fold-marker| marker Markers are used to specify folds.
  2452. |fold-syntax| syntax Syntax highlighting items specify folds.
  2453. |fold-diff| diff Fold text that is not changed.
  2454. *'foldminlines'* *'fml'*
  2455. 'foldminlines' 'fml' number (default 1)
  2456. local to window
  2457. Sets the number of screen lines above which a fold can be displayed
  2458. closed. Also for manually closed folds. With the default value of
  2459. one a fold can only be closed if it takes up two or more screen lines.
  2460. Set to zero to be able to close folds of just one screen line.
  2461. Note that this only has an effect on what is displayed. After using
  2462. "zc" to close a fold, which is displayed open because it's smaller
  2463. than 'foldminlines', a following "zc" may close a containing fold.
  2464. *'foldnestmax'* *'fdn'*
  2465. 'foldnestmax' 'fdn' number (default 20)
  2466. local to window
  2467. Sets the maximum nesting of folds for the "indent" and "syntax"
  2468. methods. This avoids that too many folds will be created. Using more
  2469. than 20 doesn't work, because the internal limit is 20.
  2470. *'foldopen'* *'fdo'*
  2471. 'foldopen' 'fdo' string (default "block,hor,mark,percent,quickfix,search,tag,undo")
  2472. global
  2473. Specifies for which type of commands folds will be opened, if the
  2474. command moves the cursor into a closed fold. It is a comma-separated
  2475. list of items.
  2476. NOTE: When the command is part of a mapping this option is not used.
  2477. Add the |zv| command to the mapping to get the same effect.
  2478. (rationale: the mapping may want to control opening folds itself)
  2479. item commands ~
  2480. all any
  2481. block (, {, [[, [{, etc.
  2482. hor horizontal movements: "l", "w", "fx", etc.
  2483. insert any command in Insert mode
  2484. jump far jumps: "G", "gg", etc.
  2485. mark jumping to a mark: "'m", CTRL-O, etc.
  2486. percent "%"
  2487. quickfix ":cn", ":crew", ":make", etc.
  2488. search search for a pattern: "/", "n", "*", "gd", etc.
  2489. (not for a search pattern in a ":" command)
  2490. Also for |[s| and |]s|.
  2491. tag jumping to a tag: ":ta", CTRL-T, etc.
  2492. undo undo or redo: "u" and CTRL-R
  2493. When a movement command is used for an operator (e.g., "dl" or "y%")
  2494. this option is not used. This means the operator will include the
  2495. whole closed fold.
  2496. Note that vertical movements are not here, because it would make it
  2497. very difficult to move onto a closed fold.
  2498. In insert mode the folds containing the cursor will always be open
  2499. when text is inserted.
  2500. To close folds you can re-apply 'foldlevel' with the |zx| command or
  2501. set the 'foldclose' option to "all".
  2502. *'foldtext'* *'fdt'*
  2503. 'foldtext' 'fdt' string (default "foldtext()")
  2504. local to window
  2505. An expression which is used to specify the text displayed for a closed
  2506. fold. The context is set to the script where 'foldexpr' was set,
  2507. script-local items can be accessed. See |fold-foldtext| for the
  2508. usage.
  2509. The expression will be evaluated in the |sandbox| if set from a
  2510. modeline, see |sandbox-option|.
  2511. This option cannot be set in a modeline when 'modelineexpr' is off.
  2512. It is not allowed to change text or jump to another window while
  2513. evaluating 'foldtext' |textlock|.
  2514. When set to an empty string, foldtext is disabled, and the line
  2515. is displayed normally with highlighting and no line wrapping.
  2516. *'formatexpr'* *'fex'*
  2517. 'formatexpr' 'fex' string (default "")
  2518. local to buffer
  2519. Expression which is evaluated to format a range of lines for the |gq|
  2520. operator or automatic formatting (see 'formatoptions'). When this
  2521. option is empty 'formatprg' is used.
  2522. The |v:lnum| variable holds the first line to be formatted.
  2523. The |v:count| variable holds the number of lines to be formatted.
  2524. The |v:char| variable holds the character that is going to be
  2525. inserted if the expression is being evaluated due to
  2526. automatic formatting. This can be empty. Don't insert
  2527. it yet!
  2528. Example: >vim
  2529. set formatexpr=mylang#Format()
  2530. < This will invoke the mylang#Format() function in the
  2531. autoload/mylang.vim file in 'runtimepath'. |autoload|
  2532. The advantage of using a function call without arguments is that it is
  2533. faster, see |expr-option-function|.
  2534. The expression is also evaluated when 'textwidth' is set and adding
  2535. text beyond that limit. This happens under the same conditions as
  2536. when internal formatting is used. Make sure the cursor is kept in the
  2537. same spot relative to the text then! The |mode()| function will
  2538. return "i" or "R" in this situation.
  2539. When the expression evaluates to non-zero Vim will fall back to using
  2540. the internal format mechanism.
  2541. If the expression starts with s: or |<SID>|, then it is replaced with
  2542. the script ID (|local-function|). Example: >vim
  2543. set formatexpr=s:MyFormatExpr()
  2544. set formatexpr=<SID>SomeFormatExpr()
  2545. < Otherwise, the expression is evaluated in the context of the script
  2546. where the option was set, thus script-local items are available.
  2547. The expression will be evaluated in the |sandbox| when set from a
  2548. modeline, see |sandbox-option|. That stops the option from working,
  2549. since changing the buffer text is not allowed.
  2550. This option cannot be set in a modeline when 'modelineexpr' is off.
  2551. NOTE: This option is set to "" when 'compatible' is set.
  2552. *'formatlistpat'* *'flp'*
  2553. 'formatlistpat' 'flp' string (default "^\s*\d\+[\]:.)}\t ]\s*")
  2554. local to buffer
  2555. A pattern that is used to recognize a list header. This is used for
  2556. the "n" flag in 'formatoptions'.
  2557. The pattern must match exactly the text that will be the indent for
  2558. the line below it. You can use |/\ze| to mark the end of the match
  2559. while still checking more characters. There must be a character
  2560. following the pattern, when it matches the whole line it is handled
  2561. like there is no match.
  2562. The default recognizes a number, followed by an optional punctuation
  2563. character and white space.
  2564. *'formatoptions'* *'fo'*
  2565. 'formatoptions' 'fo' string (default "tcqj")
  2566. local to buffer
  2567. This is a sequence of letters which describes how automatic
  2568. formatting is to be done.
  2569. See |fo-table| for possible values and |gq| for how to format text.
  2570. Commas can be inserted for readability.
  2571. To avoid problems with flags that are added in the future, use the
  2572. "+=" and "-=" feature of ":set" |add-option-flags|.
  2573. *'formatprg'* *'fp'*
  2574. 'formatprg' 'fp' string (default "")
  2575. global or local to buffer |global-local|
  2576. The name of an external program that will be used to format the lines
  2577. selected with the |gq| operator. The program must take the input on
  2578. stdin and produce the output on stdout. The Unix program "fmt" is
  2579. such a program.
  2580. If the 'formatexpr' option is not empty it will be used instead.
  2581. Otherwise, if 'formatprg' option is an empty string, the internal
  2582. format function will be used |C-indenting|.
  2583. Environment variables are expanded |:set_env|. See |option-backslash|
  2584. about including spaces and backslashes.
  2585. This option cannot be set from a |modeline| or in the |sandbox|, for
  2586. security reasons.
  2587. *'fsync'* *'fs'* *'nofsync'* *'nofs'*
  2588. 'fsync' 'fs' boolean (default on)
  2589. global
  2590. When on, the OS function fsync() will be called after saving a file
  2591. (|:write|, |writefile()|, …), |swap-file|, |undo-persistence| and |shada-file|.
  2592. This flushes the file to disk, ensuring that it is safely written.
  2593. Slow on some systems: writing buffers, quitting Nvim, and other
  2594. operations may sometimes take a few seconds.
  2595. Files are ALWAYS flushed ('fsync' is ignored) when:
  2596. - |CursorHold| event is triggered
  2597. - |:preserve| is called
  2598. - system signals low battery life
  2599. - Nvim exits abnormally
  2600. This option cannot be set from a |modeline| or in the |sandbox|, for
  2601. security reasons.
  2602. *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
  2603. 'gdefault' 'gd' boolean (default off)
  2604. global
  2605. When on, the ":substitute" flag 'g' is default on. This means that
  2606. all matches in a line are substituted instead of one. When a 'g' flag
  2607. is given to a ":substitute" command, this will toggle the substitution
  2608. of all or one match. See |complex-change|.
  2609. command 'gdefault' on 'gdefault' off ~
  2610. :s/// subst. all subst. one
  2611. :s///g subst. one subst. all
  2612. :s///gg subst. all subst. one
  2613. NOTE: Setting this option may break plugins that rely on the default
  2614. behavior of the 'g' flag. This will also make the 'g' flag have the
  2615. opposite effect of that documented in |:s_g|.
  2616. *'grepformat'* *'gfm'*
  2617. 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
  2618. global
  2619. Format to recognize for the ":grep" command output.
  2620. This is a scanf-like string that uses the same format as the
  2621. 'errorformat' option: see |errorformat|.
  2622. If ripgrep ('grepprg') is available, this option defaults to `%f:%l:%c:%m`.
  2623. *'grepprg'* *'gp'*
  2624. 'grepprg' 'gp' string (default see below)
  2625. global or local to buffer |global-local|
  2626. Program to use for the |:grep| command. This option may contain '%'
  2627. and '#' characters, which are expanded like when used in a command-
  2628. line. The placeholder "$*" is allowed to specify where the arguments
  2629. will be included. Environment variables are expanded |:set_env|. See
  2630. |option-backslash| about including spaces and backslashes.
  2631. Special value: When 'grepprg' is set to "internal" the |:grep| command
  2632. works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
  2633. |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
  2634. See also the section |:make_makeprg|, since most of the comments there
  2635. apply equally to 'grepprg'.
  2636. This option cannot be set from a |modeline| or in the |sandbox|, for
  2637. security reasons.
  2638. This option defaults to:
  2639. - `rg --vimgrep -uu ` if ripgrep is available (|:checkhealth|),
  2640. - `grep -HIn $* /dev/null` on Unix,
  2641. - `findstr /n $* nul` on Windows.
  2642. Ripgrep can perform additional filtering such as using .gitignore rules
  2643. and skipping hidden files. This is disabled by default (see the -u option)
  2644. to more closely match the behaviour of standard grep.
  2645. You can make ripgrep match Vim's case handling using the
  2646. -i/--ignore-case and -S/--smart-case options.
  2647. An |OptionSet| autocmd can be used to set it up to match automatically.
  2648. *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
  2649. 'guicursor' 'gcr' string (default "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20,t:block-blinkon500-blinkoff500-TermCursor")
  2650. global
  2651. Configures the cursor style for each mode. Works in the GUI and many
  2652. terminals. See |tui-cursor-shape|.
  2653. To disable cursor-styling, reset the option: >vim
  2654. set guicursor=
  2655. < To enable mode shapes, "Cursor" highlight, and blinking: >vim
  2656. set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50
  2657. \,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor
  2658. \,sm:block-blinkwait175-blinkoff150-blinkon175
  2659. < The option is a comma-separated list of parts. Each part consists of a
  2660. mode-list and an argument-list:
  2661. mode-list:argument-list,mode-list:argument-list,..
  2662. The mode-list is a dash separated list of these modes:
  2663. n Normal mode
  2664. v Visual mode
  2665. ve Visual mode with 'selection' "exclusive" (same as 'v',
  2666. if not specified)
  2667. o Operator-pending mode
  2668. i Insert mode
  2669. r Replace mode
  2670. c Command-line Normal (append) mode
  2671. ci Command-line Insert mode
  2672. cr Command-line Replace mode
  2673. sm showmatch in Insert mode
  2674. t Terminal mode
  2675. a all modes
  2676. The argument-list is a dash separated list of these arguments:
  2677. hor{N} horizontal bar, {N} percent of the character height
  2678. ver{N} vertical bar, {N} percent of the character width
  2679. block block cursor, fills the whole character
  2680. - Only one of the above three should be present.
  2681. - Default is "block" for each mode.
  2682. blinkwait{N} *cursor-blinking*
  2683. blinkon{N}
  2684. blinkoff{N}
  2685. blink times for cursor: blinkwait is the delay before
  2686. the cursor starts blinking, blinkon is the time that
  2687. the cursor is shown and blinkoff is the time that the
  2688. cursor is not shown. Times are in msec. When one of
  2689. the numbers is zero, there is no blinking. E.g.: >vim
  2690. set guicursor=n:blinkon0
  2691. <
  2692. Default is "blinkon0" for each mode.
  2693. {group-name}
  2694. Highlight group that decides the color and font of the
  2695. cursor.
  2696. In the |TUI|:
  2697. - |inverse|/reverse and no group-name are interpreted
  2698. as "host-terminal default cursor colors" which
  2699. typically means "inverted bg and fg colors".
  2700. - |ctermfg| and |guifg| are ignored.
  2701. {group-name}/{group-name}
  2702. Two highlight group names, the first is used when
  2703. no language mappings are used, the other when they
  2704. are. |language-mapping|
  2705. Examples of parts:
  2706. n-c-v:block-nCursor In Normal, Command-line and Visual mode, use a
  2707. block cursor with colors from the "nCursor"
  2708. highlight group
  2709. n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20
  2710. In Normal et al. modes, use a block cursor
  2711. with the default colors defined by the host
  2712. terminal. In Insert-like modes, use
  2713. a vertical bar cursor with colors from
  2714. "Cursor" highlight group. In Replace-like
  2715. modes, use an underline cursor with
  2716. default colors.
  2717. i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
  2718. In Insert and Command-line Insert mode, use a
  2719. 30% vertical bar cursor with colors from the
  2720. "iCursor" highlight group. Blink a bit
  2721. faster.
  2722. The 'a' mode is different. It will set the given argument-list for
  2723. all modes. It does not reset anything to defaults. This can be used
  2724. to do a common setting for all modes. For example, to switch off
  2725. blinking: "a:blinkon0"
  2726. Examples of cursor highlighting: >vim
  2727. highlight Cursor gui=reverse guifg=NONE guibg=NONE
  2728. highlight Cursor gui=NONE guifg=bg guibg=fg
  2729. <
  2730. *'guifont'* *'gfn'* *E235* *E596*
  2731. 'guifont' 'gfn' string (default "")
  2732. global
  2733. This is a list of fonts which will be used for the GUI version of Vim.
  2734. In its simplest form the value is just one font name. When
  2735. the font cannot be found you will get an error message. To try other
  2736. font names a list can be specified, font names separated with commas.
  2737. The first valid font is used.
  2738. Spaces after a comma are ignored. To include a comma in a font name
  2739. precede it with a backslash. Setting an option requires an extra
  2740. backslash before a space and a backslash. See also
  2741. |option-backslash|. For example: >vim
  2742. set guifont=Screen15,\ 7x13,font\\,with\\,commas
  2743. < will make Vim try to use the font "Screen15" first, and if it fails it
  2744. will try to use "7x13" and then "font,with,commas" instead.
  2745. If none of the fonts can be loaded, Vim will keep the current setting.
  2746. If an empty font list is given, Vim will try using other resource
  2747. settings (for X, it will use the Vim.font resource), and finally it
  2748. will try some builtin default which should always be there ("7x13" in
  2749. the case of X). The font names given should be "normal" fonts. Vim
  2750. will try to find the related bold and italic fonts.
  2751. For Win32 and Mac OS: >vim
  2752. set guifont=*
  2753. < will bring up a font requester, where you can pick the font you want.
  2754. The font name depends on the GUI used.
  2755. For Mac OSX you can use something like this: >vim
  2756. set guifont=Monaco:h10
  2757. < *E236*
  2758. Note that the fonts must be mono-spaced (all characters have the same
  2759. width).
  2760. To preview a font on X11, you might be able to use the "xfontsel"
  2761. program. The "xlsfonts" program gives a list of all available fonts.
  2762. For the Win32 GUI *E244* *E245*
  2763. - takes these options in the font name:
  2764. hXX - height is XX (points, can be floating-point)
  2765. wXX - width is XX (points, can be floating-point)
  2766. b - bold
  2767. i - italic
  2768. u - underline
  2769. s - strikeout
  2770. cXX - character set XX. Valid charsets are: ANSI, ARABIC,
  2771. BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
  2772. HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
  2773. SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
  2774. Normally you would use "cDEFAULT".
  2775. Use a ':' to separate the options.
  2776. - A '_' can be used in the place of a space, so you don't need to use
  2777. backslashes to escape the spaces.
  2778. - Examples: >vim
  2779. set guifont=courier_new:h12:w5:b:cRUSSIAN
  2780. set guifont=Andale_Mono:h7.5:w4.5
  2781. <
  2782. *'guifontwide'* *'gfw'* *E231* *E533* *E534*
  2783. 'guifontwide' 'gfw' string (default "")
  2784. global
  2785. Comma-separated list of fonts to be used for double-width characters.
  2786. The first font that can be loaded is used.
  2787. Note: The size of these fonts must be exactly twice as wide as the one
  2788. specified with 'guifont' and the same height.
  2789. When 'guifont' has a valid font and 'guifontwide' is empty Vim will
  2790. attempt to set 'guifontwide' to a matching double-width font.
  2791. *'helpfile'* *'hf'*
  2792. 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
  2793. (others) "$VIMRUNTIME/doc/help.txt")
  2794. global
  2795. Name of the main help file. All distributed help files should be
  2796. placed together in one directory. Additionally, all "doc" directories
  2797. in 'runtimepath' will be used.
  2798. Environment variables are expanded |:set_env|. For example:
  2799. "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
  2800. tried. Also see |$VIMRUNTIME| and |option-backslash| about including
  2801. spaces and backslashes.
  2802. This option cannot be set from a |modeline| or in the |sandbox|, for
  2803. security reasons.
  2804. *'helpheight'* *'hh'*
  2805. 'helpheight' 'hh' number (default 20)
  2806. global
  2807. Minimal initial height of the help window when it is opened with the
  2808. ":help" command. The initial height of the help window is half of the
  2809. current window, or (when the 'ea' option is on) the same as other
  2810. windows. When the height is less than 'helpheight', the height is
  2811. set to 'helpheight'. Set to zero to disable.
  2812. *'helplang'* *'hlg'*
  2813. 'helplang' 'hlg' string (default messages language or empty)
  2814. global
  2815. Comma-separated list of languages. Vim will use the first language
  2816. for which the desired help can be found. The English help will always
  2817. be used as a last resort. You can add "en" to prefer English over
  2818. another language, but that will only find tags that exist in that
  2819. language and not in the English help.
  2820. Example: >vim
  2821. set helplang=de,it
  2822. < This will first search German, then Italian and finally English help
  2823. files.
  2824. When using |CTRL-]| and ":help!" in a non-English help file Vim will
  2825. try to find the tag in the current language before using this option.
  2826. See |help-translated|.
  2827. *'hidden'* *'hid'* *'nohidden'* *'nohid'*
  2828. 'hidden' 'hid' boolean (default on)
  2829. global
  2830. When off a buffer is unloaded (including loss of undo information)
  2831. when it is |abandon|ed. When on a buffer becomes hidden when it is
  2832. |abandon|ed. A buffer displayed in another window does not become
  2833. hidden, of course.
  2834. Commands that move through the buffer list sometimes hide a buffer
  2835. although the 'hidden' option is off when these three are true:
  2836. - the buffer is modified
  2837. - 'autowrite' is off or writing is not possible
  2838. - the '!' flag was used
  2839. Also see |windows|.
  2840. To hide a specific buffer use the 'bufhidden' option.
  2841. 'hidden' is set for one command with ":hide {command}" |:hide|.
  2842. *'history'* *'hi'*
  2843. 'history' 'hi' number (default 10000)
  2844. global
  2845. A history of ":" commands, and a history of previous search patterns
  2846. is remembered. This option decides how many entries may be stored in
  2847. each of these histories (see |cmdline-editing| and 'messagesopt' for
  2848. the number of messages to remember).
  2849. The maximum value is 10000.
  2850. *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
  2851. 'hlsearch' 'hls' boolean (default on)
  2852. global
  2853. When there is a previous search pattern, highlight all its matches.
  2854. The |hl-Search| highlight group determines the highlighting for all
  2855. matches not under the cursor while the |hl-CurSearch| highlight group
  2856. (if defined) determines the highlighting for the match under the
  2857. cursor. If |hl-CurSearch| is not defined, then |hl-Search| is used for
  2858. both. Note that only the matching text is highlighted, any offsets
  2859. are not applied.
  2860. See also: 'incsearch' and |:match|.
  2861. When you get bored looking at the highlighted matches, you can turn it
  2862. off with |:nohlsearch|. This does not change the option value, as
  2863. soon as you use a search command, the highlighting comes back.
  2864. 'redrawtime' specifies the maximum time spent on finding matches.
  2865. When the search pattern can match an end-of-line, Vim will try to
  2866. highlight all of the matched text. However, this depends on where the
  2867. search starts. This will be the first line in the window or the first
  2868. line below a closed fold. A match in a previous line which is not
  2869. drawn may not continue in a newly drawn line.
  2870. You can specify whether the highlight status is restored on startup
  2871. with the 'h' flag in 'shada' |shada-h|.
  2872. *'icon'* *'noicon'*
  2873. 'icon' boolean (default off, on when title can be restored)
  2874. global
  2875. When on, the icon text of the window will be set to the value of
  2876. 'iconstring' (if it is not empty), or to the name of the file
  2877. currently being edited. Only the last part of the name is used.
  2878. Overridden by the 'iconstring' option.
  2879. Only works if the terminal supports setting window icons.
  2880. *'iconstring'*
  2881. 'iconstring' string (default "")
  2882. global
  2883. When this option is not empty, it will be used for the icon text of
  2884. the window. This happens only when the 'icon' option is on.
  2885. Only works if the terminal supports setting window icon text
  2886. When this option contains printf-style '%' items, they will be
  2887. expanded according to the rules used for 'statusline'. See
  2888. 'titlestring' for example settings.
  2889. This option cannot be set in a modeline when 'modelineexpr' is off.
  2890. *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
  2891. 'ignorecase' 'ic' boolean (default off)
  2892. global
  2893. Ignore case in search patterns, |cmdline-completion|, when
  2894. searching in the tags file, and |expr-==|.
  2895. Also see 'smartcase' and 'tagcase'.
  2896. Can be overruled by using "\c" or "\C" in the pattern, see
  2897. |/ignorecase|.
  2898. *'iminsert'* *'imi'*
  2899. 'iminsert' 'imi' number (default 0)
  2900. local to buffer
  2901. Specifies whether :lmap or an Input Method (IM) is to be used in
  2902. Insert mode. Valid values:
  2903. 0 :lmap is off and IM is off
  2904. 1 :lmap is ON and IM is off
  2905. 2 :lmap is off and IM is ON
  2906. To always reset the option to zero when leaving Insert mode with <Esc>
  2907. this can be used: >vim
  2908. inoremap <ESC> <ESC>:set iminsert=0<CR>
  2909. < This makes :lmap and IM turn off automatically when leaving Insert
  2910. mode.
  2911. Note that this option changes when using CTRL-^ in Insert mode
  2912. |i_CTRL-^|.
  2913. The value is set to 1 when setting 'keymap' to a valid keymap name.
  2914. It is also used for the argument of commands like "r" and "f".
  2915. *'imsearch'* *'ims'*
  2916. 'imsearch' 'ims' number (default -1)
  2917. local to buffer
  2918. Specifies whether :lmap or an Input Method (IM) is to be used when
  2919. entering a search pattern. Valid values:
  2920. -1 the value of 'iminsert' is used, makes it look like
  2921. 'iminsert' is also used when typing a search pattern
  2922. 0 :lmap is off and IM is off
  2923. 1 :lmap is ON and IM is off
  2924. 2 :lmap is off and IM is ON
  2925. Note that this option changes when using CTRL-^ in Command-line mode
  2926. |c_CTRL-^|.
  2927. The value is set to 1 when it is not -1 and setting the 'keymap'
  2928. option to a valid keymap name.
  2929. *'inccommand'* *'icm'*
  2930. 'inccommand' 'icm' string (default "nosplit")
  2931. global
  2932. When nonempty, shows the effects of |:substitute|, |:smagic|,
  2933. |:snomagic| and user commands with the |:command-preview| flag as you
  2934. type.
  2935. Possible values:
  2936. nosplit Shows the effects of a command incrementally in the
  2937. buffer.
  2938. split Like "nosplit", but also shows partial off-screen
  2939. results in a preview window.
  2940. If the preview for built-in commands is too slow (exceeds
  2941. 'redrawtime') then 'inccommand' is automatically disabled until
  2942. |Command-line-mode| is done.
  2943. *'include'* *'inc'*
  2944. 'include' 'inc' string (default "")
  2945. global or local to buffer |global-local|
  2946. Pattern to be used to find an include command. It is a search
  2947. pattern, just like for the "/" command (See |pattern|). This option
  2948. is used for the commands "[i", "]I", "[d", etc.
  2949. Normally the 'isfname' option is used to recognize the file name that
  2950. comes after the matched pattern. But if "\zs" appears in the pattern
  2951. then the text matched from "\zs" to the end, or until "\ze" if it
  2952. appears, is used as the file name. Use this to include characters
  2953. that are not in 'isfname', such as a space. You can then use
  2954. 'includeexpr' to process the matched text.
  2955. See |option-backslash| about including spaces and backslashes.
  2956. *'includeexpr'* *'inex'*
  2957. 'includeexpr' 'inex' string (default "")
  2958. local to buffer
  2959. Expression to be used to transform the string found with the 'include'
  2960. option to a file name. Mostly useful to change "." to "/" for Java: >vim
  2961. setlocal includeexpr=substitute(v:fname,'\\.','/','g')
  2962. < The "v:fname" variable will be set to the file name that was detected.
  2963. Note the double backslash: the `:set` command first halves them, then
  2964. one remains in the value, where "\." matches a dot literally. For
  2965. simple character replacements `tr()` avoids the need for escaping: >vim
  2966. setlocal includeexpr=tr(v:fname,'.','/')
  2967. <
  2968. Also used for the |gf| command if an unmodified file name can't be
  2969. found. Allows doing "gf" on the name after an 'include' statement.
  2970. Also used for |<cfile>|.
  2971. If the expression starts with s: or |<SID>|, then it is replaced with
  2972. the script ID (|local-function|). Example: >vim
  2973. setlocal includeexpr=s:MyIncludeExpr()
  2974. setlocal includeexpr=<SID>SomeIncludeExpr()
  2975. < Otherwise, the expression is evaluated in the context of the script
  2976. where the option was set, thus script-local items are available.
  2977. It is more efficient if the value is just a function call without
  2978. arguments, see |expr-option-function|.
  2979. The expression will be evaluated in the |sandbox| when set from a
  2980. modeline, see |sandbox-option|.
  2981. This option cannot be set in a modeline when 'modelineexpr' is off.
  2982. It is not allowed to change text or jump to another window while
  2983. evaluating 'includeexpr' |textlock|.
  2984. *'incsearch'* *'is'* *'noincsearch'* *'nois'*
  2985. 'incsearch' 'is' boolean (default on)
  2986. global
  2987. While typing a search command, show where the pattern, as it was typed
  2988. so far, matches. The matched string is highlighted. If the pattern
  2989. is invalid or not found, nothing is shown. The screen will be updated
  2990. often, this is only useful on fast terminals.
  2991. Note that the match will be shown, but the cursor will return to its
  2992. original position when no match is found and when pressing <Esc>. You
  2993. still need to finish the search command with <Enter> to move the
  2994. cursor to the match.
  2995. You can use the CTRL-G and CTRL-T keys to move to the next and
  2996. previous match. |c_CTRL-G| |c_CTRL-T|
  2997. Vim only searches for about half a second. With a complicated
  2998. pattern and/or a lot of text the match may not be found. This is to
  2999. avoid that Vim hangs while you are typing the pattern.
  3000. The |hl-IncSearch| highlight group determines the highlighting.
  3001. When 'hlsearch' is on, all matched strings are highlighted too while
  3002. typing a search command. See also: 'hlsearch'.
  3003. If you don't want to turn 'hlsearch' on, but want to highlight all
  3004. matches while searching, you can turn on and off 'hlsearch' with
  3005. autocmd. Example: >vim
  3006. augroup vimrc-incsearch-highlight
  3007. autocmd!
  3008. autocmd CmdlineEnter /,\? :set hlsearch
  3009. autocmd CmdlineLeave /,\? :set nohlsearch
  3010. augroup END
  3011. <
  3012. CTRL-L can be used to add one character from after the current match
  3013. to the command line. If 'ignorecase' and 'smartcase' are set and the
  3014. command line has no uppercase characters, the added character is
  3015. converted to lowercase.
  3016. CTRL-R CTRL-W can be used to add the word at the end of the current
  3017. match, excluding the characters that were already typed.
  3018. *'indentexpr'* *'inde'*
  3019. 'indentexpr' 'inde' string (default "")
  3020. local to buffer
  3021. Expression which is evaluated to obtain the proper indent for a line.
  3022. It is used when a new line is created, for the |=| operator and
  3023. in Insert mode as specified with the 'indentkeys' option.
  3024. When this option is not empty, it overrules the 'cindent' and
  3025. 'smartindent' indenting. When 'lisp' is set, this option is
  3026. only used when 'lispoptions' contains "expr:1".
  3027. The expression is evaluated with |v:lnum| set to the line number for
  3028. which the indent is to be computed. The cursor is also in this line
  3029. when the expression is evaluated (but it may be moved around).
  3030. If the expression starts with s: or |<SID>|, then it is replaced with
  3031. the script ID (|local-function|). Example: >vim
  3032. set indentexpr=s:MyIndentExpr()
  3033. set indentexpr=<SID>SomeIndentExpr()
  3034. < Otherwise, the expression is evaluated in the context of the script
  3035. where the option was set, thus script-local items are available.
  3036. The advantage of using a function call without arguments is that it is
  3037. faster, see |expr-option-function|.
  3038. The expression must return the number of spaces worth of indent. It
  3039. can return "-1" to keep the current indent (this means 'autoindent' is
  3040. used for the indent).
  3041. Functions useful for computing the indent are |indent()|, |cindent()|
  3042. and |lispindent()|.
  3043. The evaluation of the expression must not have side effects! It must
  3044. not change the text, jump to another window, etc. Afterwards the
  3045. cursor position is always restored, thus the cursor may be moved.
  3046. Normally this option would be set to call a function: >vim
  3047. set indentexpr=GetMyIndent()
  3048. < Error messages will be suppressed, unless the 'debug' option contains
  3049. "msg".
  3050. See |indent-expression|.
  3051. The expression will be evaluated in the |sandbox| when set from a
  3052. modeline, see |sandbox-option|.
  3053. This option cannot be set in a modeline when 'modelineexpr' is off.
  3054. It is not allowed to change text or jump to another window while
  3055. evaluating 'indentexpr' |textlock|.
  3056. *'indentkeys'* *'indk'*
  3057. 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
  3058. local to buffer
  3059. A list of keys that, when typed in Insert mode, cause reindenting of
  3060. the current line. Only happens if 'indentexpr' isn't empty.
  3061. The format is identical to 'cinkeys', see |indentkeys-format|.
  3062. See |C-indenting| and |indent-expression|.
  3063. *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
  3064. 'infercase' 'inf' boolean (default off)
  3065. local to buffer
  3066. When doing keyword completion in insert mode |ins-completion|, and
  3067. 'ignorecase' is also on, the case of the match is adjusted depending
  3068. on the typed text. If the typed text contains a lowercase letter
  3069. where the match has an upper case letter, the completed part is made
  3070. lowercase. If the typed text has no lowercase letters and the match
  3071. has a lowercase letter where the typed text has an uppercase letter,
  3072. and there is a letter before it, the completed part is made uppercase.
  3073. With 'noinfercase' the match is used as-is.
  3074. *'isfname'* *'isf'*
  3075. 'isfname' 'isf' string (default for Windows:
  3076. "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],@-@,!,~,="
  3077. otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
  3078. global
  3079. The characters specified by this option are included in file names and
  3080. path names. Filenames are used for commands like "gf", "[i" and in
  3081. the tags file. It is also used for "\f" in a |pattern|.
  3082. Multi-byte characters 256 and above are always included, only the
  3083. characters up to 255 are specified with this option.
  3084. For UTF-8 the characters 0xa0 to 0xff are included as well.
  3085. Think twice before adding white space to this option. Although a
  3086. space may appear inside a file name, the effect will be that Vim
  3087. doesn't know where a file name starts or ends when doing completion.
  3088. It most likely works better without a space in 'isfname'.
  3089. Note that on systems using a backslash as path separator, Vim tries to
  3090. do its best to make it work as you would expect. That is a bit
  3091. tricky, since Vi originally used the backslash to escape special
  3092. characters. Vim will not remove a backslash in front of a normal file
  3093. name character on these systems, but it will on Unix and alikes. The
  3094. '&' and '^' are not included by default, because these are special for
  3095. cmd.exe.
  3096. The format of this option is a list of parts, separated with commas.
  3097. Each part can be a single character number or a range. A range is two
  3098. character numbers with '-' in between. A character number can be a
  3099. decimal number between 0 and 255 or the ASCII character itself (does
  3100. not work for digits). Example:
  3101. "_,-,128-140,#-43" (include '_' and '-' and the range
  3102. 128 to 140 and '#' to 43)
  3103. If a part starts with '^', the following character number or range
  3104. will be excluded from the option. The option is interpreted from left
  3105. to right. Put the excluded character after the range where it is
  3106. included. To include '^' itself use it as the last character of the
  3107. option or the end of a range. Example:
  3108. "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
  3109. If the character is '@', all characters where isalpha() returns TRUE
  3110. are included. Normally these are the characters a to z and A to Z,
  3111. plus accented characters. To include '@' itself use "@-@". Examples:
  3112. "@,^a-z" All alphabetic characters, excluding lower
  3113. case ASCII letters.
  3114. "a-z,A-Z,@-@" All letters plus the '@' character.
  3115. A comma can be included by using it where a character number is
  3116. expected. Example:
  3117. "48-57,,,_" Digits, comma and underscore.
  3118. A comma can be excluded by prepending a '^'. Example:
  3119. " -~,^,,9" All characters from space to '~', excluding
  3120. comma, plus <Tab>.
  3121. See |option-backslash| about including spaces and backslashes.
  3122. *'isident'* *'isi'*
  3123. 'isident' 'isi' string (default for Windows:
  3124. "@,48-57,_,128-167,224-235"
  3125. otherwise: "@,48-57,_,192-255")
  3126. global
  3127. The characters given by this option are included in identifiers.
  3128. Identifiers are used in recognizing environment variables and after a
  3129. match of the 'define' option. It is also used for "\i" in a
  3130. |pattern|. See 'isfname' for a description of the format of this
  3131. option. For '@' only characters up to 255 are used.
  3132. Careful: If you change this option, it might break expanding
  3133. environment variables. E.g., when '/' is included and Vim tries to
  3134. expand "$HOME/.local/state/nvim/shada/main.shada". Maybe you should
  3135. change 'iskeyword' instead.
  3136. *'iskeyword'* *'isk'*
  3137. 'iskeyword' 'isk' string (default "@,48-57,_,192-255")
  3138. local to buffer
  3139. Keywords are used in searching and recognizing with many commands:
  3140. "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
  3141. 'isfname' for a description of the format of this option. For '@'
  3142. characters above 255 check the "word" character class (any character
  3143. that is not white space or punctuation).
  3144. For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
  3145. For a help file it is set to all non-blank printable characters except
  3146. "*", '"' and '|' (so that CTRL-] on a command finds the help for that
  3147. command).
  3148. When the 'lisp' option is on the '-' character is always included.
  3149. This option also influences syntax highlighting, unless the syntax
  3150. uses |:syn-iskeyword|.
  3151. *'isprint'* *'isp'*
  3152. 'isprint' 'isp' string (default "@,161-255")
  3153. global
  3154. The characters given by this option are displayed directly on the
  3155. screen. It is also used for "\p" in a |pattern|. The characters from
  3156. space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
  3157. even when they are not included in 'isprint' or excluded. See
  3158. 'isfname' for a description of the format of this option.
  3159. Non-printable characters are displayed with two characters:
  3160. 0 - 31 "^@" - "^_"
  3161. 32 - 126 always single characters
  3162. 127 "^?"
  3163. 128 - 159 "~@" - "~_"
  3164. 160 - 254 "| " - "|~"
  3165. 255 "~?"
  3166. Illegal bytes from 128 to 255 (invalid UTF-8) are
  3167. displayed as <xx>, with the hexadecimal value of the byte.
  3168. When 'display' contains "uhex" all unprintable characters are
  3169. displayed as <xx>.
  3170. The SpecialKey highlighting will be used for unprintable characters.
  3171. |hl-SpecialKey|
  3172. Multi-byte characters 256 and above are always included, only the
  3173. characters up to 255 are specified with this option. When a character
  3174. is printable but it is not available in the current font, a
  3175. replacement character will be shown.
  3176. Unprintable and zero-width Unicode characters are displayed as <xxxx>.
  3177. There is no option to specify these characters.
  3178. *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
  3179. 'joinspaces' 'js' boolean (default off)
  3180. global
  3181. Insert two spaces after a '.', '?' and '!' with a join command.
  3182. Otherwise only one space is inserted.
  3183. *'jumpoptions'* *'jop'*
  3184. 'jumpoptions' 'jop' string (default "clean")
  3185. global
  3186. List of words that change the behavior of the |jumplist|.
  3187. stack Make the jumplist behave like the tagstack.
  3188. Relative location of entries in the jumplist is
  3189. preserved at the cost of discarding subsequent entries
  3190. when navigating backwards in the jumplist and then
  3191. jumping to a location. |jumplist-stack|
  3192. view When moving through the jumplist, |changelist|,
  3193. |alternate-file| or using |mark-motions| try to
  3194. restore the |mark-view| in which the action occurred.
  3195. clean Remove unloaded buffers from the jumplist.
  3196. EXPERIMENTAL: this flag may change in the future.
  3197. *'keymap'* *'kmp'*
  3198. 'keymap' 'kmp' string (default "")
  3199. local to buffer
  3200. Name of a keyboard mapping. See |mbyte-keymap|.
  3201. Setting this option to a valid keymap name has the side effect of
  3202. setting 'iminsert' to one, so that the keymap becomes effective.
  3203. 'imsearch' is also set to one, unless it was -1
  3204. Only alphanumeric characters, '.', '-' and '_' can be used.
  3205. *'keymodel'* *'km'*
  3206. 'keymodel' 'km' string (default "")
  3207. global
  3208. List of comma-separated words, which enable special things that keys
  3209. can do. These values can be used:
  3210. startsel Using a shifted special key starts selection (either
  3211. Select mode or Visual mode, depending on "key" being
  3212. present in 'selectmode').
  3213. stopsel Using a not-shifted special key stops selection.
  3214. Special keys in this context are the cursor keys, <End>, <Home>,
  3215. <PageUp> and <PageDown>.
  3216. *'keywordprg'* *'kp'*
  3217. 'keywordprg' 'kp' string (default ":Man", Windows: ":help")
  3218. global or local to buffer |global-local|
  3219. Program to use for the |K| command. Environment variables are
  3220. expanded |:set_env|. ":help" may be used to access the Vim internal
  3221. help. (Note that previously setting the global option to the empty
  3222. value did this, which is now deprecated.)
  3223. When the first character is ":", the command is invoked as a Vim
  3224. Ex command prefixed with [count].
  3225. When "man" or "man -s" is used, Vim will automatically translate
  3226. a [count] for the "K" command to a section number.
  3227. See |option-backslash| about including spaces and backslashes.
  3228. Example: >vim
  3229. set keywordprg=man\ -s
  3230. set keywordprg=:Man
  3231. < This option cannot be set from a |modeline| or in the |sandbox|, for
  3232. security reasons.
  3233. *'langmap'* *'lmap'* *E357* *E358*
  3234. 'langmap' 'lmap' string (default "")
  3235. global
  3236. This option allows switching your keyboard into a special language
  3237. mode. When you are typing text in Insert mode the characters are
  3238. inserted directly. When in Normal mode the 'langmap' option takes
  3239. care of translating these special characters to the original meaning
  3240. of the key. This means you don't have to change the keyboard mode to
  3241. be able to execute Normal mode commands.
  3242. This is the opposite of the 'keymap' option, where characters are
  3243. mapped in Insert mode.
  3244. Also consider setting 'langremap' to off, to prevent 'langmap' from
  3245. applying to characters resulting from a mapping.
  3246. This option cannot be set from a |modeline| or in the |sandbox|, for
  3247. security reasons.
  3248. Example (for Greek, in UTF-8): *greek* >vim
  3249. 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
  3250. < Example (exchanges meaning of z and y for commands): >vim
  3251. set langmap=zy,yz,ZY,YZ
  3252. <
  3253. The 'langmap' option is a list of parts, separated with commas. Each
  3254. part can be in one of two forms:
  3255. 1. A list of pairs. Each pair is a "from" character immediately
  3256. followed by the "to" character. Examples: "aA", "aAbBcC".
  3257. 2. A list of "from" characters, a semicolon and a list of "to"
  3258. characters. Example: "abc;ABC"
  3259. Example: "aA,fgh;FGH,cCdDeE"
  3260. Special characters need to be preceded with a backslash. These are
  3261. ";", ',', '"', '|' and backslash itself.
  3262. This will allow you to activate vim actions without having to switch
  3263. back and forth between the languages. Your language characters will
  3264. be understood as normal vim English characters (according to the
  3265. langmap mappings) in the following cases:
  3266. o Normal/Visual mode (commands, buffer/register names, user mappings)
  3267. o Insert/Replace Mode: Register names after CTRL-R
  3268. o Insert/Replace Mode: Mappings
  3269. Characters entered in Command-line mode will NOT be affected by
  3270. this option. Note that this option can be changed at any time
  3271. allowing to switch between mappings for different languages/encodings.
  3272. Use a mapping to avoid having to type it each time!
  3273. *'langmenu'* *'lm'*
  3274. 'langmenu' 'lm' string (default "")
  3275. global
  3276. Language to use for menu translation. Tells which file is loaded
  3277. from the "lang" directory in 'runtimepath': >vim
  3278. "lang/menu_" .. &langmenu .. ".vim"
  3279. < (without the spaces). For example, to always use the Dutch menus, no
  3280. matter what $LANG is set to: >vim
  3281. set langmenu=nl_NL.ISO_8859-1
  3282. < When 'langmenu' is empty, |v:lang| is used.
  3283. Only normal file name characters can be used, `/\*?[|<>` are illegal.
  3284. If your $LANG is set to a non-English language but you do want to use
  3285. the English menus: >vim
  3286. set langmenu=none
  3287. < This option must be set before loading menus, switching on filetype
  3288. detection or syntax highlighting. Once the menus are defined setting
  3289. this option has no effect. But you could do this: >vim
  3290. source $VIMRUNTIME/delmenu.vim
  3291. set langmenu=de_DE.ISO_8859-1
  3292. source $VIMRUNTIME/menu.vim
  3293. < Warning: This deletes all menus that you defined yourself!
  3294. *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
  3295. 'langremap' 'lrm' boolean (default off)
  3296. global
  3297. When off, setting 'langmap' does not apply to characters resulting from
  3298. a mapping. If setting 'langmap' disables some of your mappings, make
  3299. sure this option is off.
  3300. *'laststatus'* *'ls'*
  3301. 'laststatus' 'ls' number (default 2)
  3302. global
  3303. The value of this option influences when the last window will have a
  3304. status line:
  3305. 0: never
  3306. 1: only if there are at least two windows
  3307. 2: always
  3308. 3: always and ONLY the last window
  3309. The screen looks nicer with a status line if you have several
  3310. windows, but it takes another screen line. |status-line|
  3311. *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
  3312. 'lazyredraw' 'lz' boolean (default off)
  3313. global
  3314. When this option is set, the screen will not be redrawn while
  3315. executing macros, registers and other commands that have not been
  3316. typed. Also, updating the window title is postponed. To force an
  3317. update use |:redraw|.
  3318. This may occasionally cause display errors. It is only meant to be set
  3319. temporarily when performing an operation where redrawing may cause
  3320. flickering or cause a slowdown.
  3321. *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
  3322. 'linebreak' 'lbr' boolean (default off)
  3323. local to window
  3324. If on, Vim will wrap long lines at a character in 'breakat' rather
  3325. than at the last character that fits on the screen. Unlike
  3326. 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
  3327. it only affects the way the file is displayed, not its contents.
  3328. If 'breakindent' is set, line is visually indented. Then, the value
  3329. of 'showbreak' is used to put in front of wrapped lines. This option
  3330. is not used when the 'wrap' option is off.
  3331. Note that <Tab> characters after an <EOL> are mostly not displayed
  3332. with the right amount of white space.
  3333. *'lines'* *E593*
  3334. 'lines' number (default 24 or terminal height)
  3335. global
  3336. Number of lines of the Vim window.
  3337. Normally you don't need to set this. It is done automatically by the
  3338. terminal initialization code.
  3339. When Vim is running in the GUI or in a resizable window, setting this
  3340. option will cause the window size to be changed. When you only want
  3341. to use the size for the GUI, put the command in your |gvimrc| file.
  3342. Vim limits the number of lines to what fits on the screen. You can
  3343. use this command to get the tallest window possible: >vim
  3344. set lines=999
  3345. < Minimum value is 2, maximum value is 1000.
  3346. *'linespace'* *'lsp'*
  3347. 'linespace' 'lsp' number (default 0)
  3348. global
  3349. only in the GUI
  3350. Number of pixel lines inserted between characters. Useful if the font
  3351. uses the full character cell height, making lines touch each other.
  3352. When non-zero there is room for underlining.
  3353. With some fonts there can be too much room between lines (to have
  3354. space for ascents and descents). Then it makes sense to set
  3355. 'linespace' to a negative value. This may cause display problems
  3356. though!
  3357. *'lisp'* *'nolisp'*
  3358. 'lisp' boolean (default off)
  3359. local to buffer
  3360. Lisp mode: When <Enter> is typed in insert mode set the indent for
  3361. the next line to Lisp standards (well, sort of). Also happens with
  3362. "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
  3363. flag in 'cpoptions' changes the method of indenting: Vi compatible or
  3364. better. Also see 'lispwords'.
  3365. The '-' character is included in keyword characters. Redefines the
  3366. "=" operator to use this same indentation algorithm rather than
  3367. calling an external program if 'equalprg' is empty.
  3368. *'lispoptions'* *'lop'*
  3369. 'lispoptions' 'lop' string (default "")
  3370. local to buffer
  3371. Comma-separated list of items that influence the Lisp indenting when
  3372. enabled with the |'lisp'| option. Currently only one item is
  3373. supported:
  3374. expr:1 use 'indentexpr' for Lisp indenting when it is set
  3375. expr:0 do not use 'indentexpr' for Lisp indenting (default)
  3376. Note that when using 'indentexpr' the `=` operator indents all the
  3377. lines, otherwise the first line is not indented (Vi-compatible).
  3378. *'lispwords'* *'lw'*
  3379. 'lispwords' 'lw' string (default is very long)
  3380. global or local to buffer |global-local|
  3381. Comma-separated list of words that influence the Lisp indenting when
  3382. enabled with the |'lisp'| option.
  3383. *'list'* *'nolist'*
  3384. 'list' boolean (default off)
  3385. local to window
  3386. List mode: By default, show tabs as ">", trailing spaces as "-", and
  3387. non-breakable space characters as "+". Useful to see the difference
  3388. between tabs and spaces and for trailing blanks. Further changed by
  3389. the 'listchars' option.
  3390. When 'listchars' does not contain "tab" field, tabs are shown as "^I"
  3391. or "<09>", like how unprintable characters are displayed.
  3392. The cursor is displayed at the start of the space a Tab character
  3393. occupies, not at the end as usual in Normal mode. To get this cursor
  3394. position while displaying Tabs with spaces, use: >vim
  3395. set list lcs=tab:\ \
  3396. <
  3397. Note that list mode will also affect formatting (set with 'textwidth'
  3398. or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
  3399. changing the way tabs are displayed.
  3400. *'listchars'* *'lcs'*
  3401. 'listchars' 'lcs' string (default "tab:> ,trail:-,nbsp:+")
  3402. global or local to window |global-local|
  3403. Strings to use in 'list' mode and for the |:list| command. It is a
  3404. comma-separated list of string settings. *E1511*
  3405. *lcs-eol*
  3406. eol:c Character to show at the end of each line. When
  3407. omitted, there is no extra character at the end of the
  3408. line.
  3409. *lcs-tab*
  3410. tab:xy[z] Two or three characters to be used to show a tab.
  3411. The third character is optional.
  3412. tab:xy The 'x' is always used, then 'y' as many times as will
  3413. fit. Thus "tab:>-" displays: >
  3414. >
  3415. >-
  3416. >--
  3417. etc.
  3418. <
  3419. tab:xyz The 'z' is always used, then 'x' is prepended, and
  3420. then 'y' is used as many times as will fit. Thus
  3421. "tab:<->" displays: >
  3422. >
  3423. <>
  3424. <->
  3425. <-->
  3426. etc.
  3427. <
  3428. When "tab:" is omitted, a tab is shown as ^I.
  3429. *lcs-space*
  3430. space:c Character to show for a space. When omitted, spaces
  3431. are left blank.
  3432. *lcs-multispace*
  3433. multispace:c...
  3434. One or more characters to use cyclically to show for
  3435. multiple consecutive spaces. Overrides the "space"
  3436. setting, except for single spaces. When omitted, the
  3437. "space" setting is used. For example,
  3438. `:set listchars=multispace:---+` shows ten consecutive
  3439. spaces as: >
  3440. ---+---+--
  3441. <
  3442. *lcs-lead*
  3443. lead:c Character to show for leading spaces. When omitted,
  3444. leading spaces are blank. Overrides the "space" and
  3445. "multispace" settings for leading spaces. You can
  3446. combine it with "tab:", for example: >vim
  3447. set listchars+=tab:>-,lead:.
  3448. <
  3449. *lcs-leadmultispace*
  3450. leadmultispace:c...
  3451. Like the |lcs-multispace| value, but for leading
  3452. spaces only. Also overrides |lcs-lead| for leading
  3453. multiple spaces.
  3454. `:set listchars=leadmultispace:---+` shows ten
  3455. consecutive leading spaces as: >
  3456. ---+---+--XXX
  3457. <
  3458. Where "XXX" denotes the first non-blank characters in
  3459. the line.
  3460. *lcs-trail*
  3461. trail:c Character to show for trailing spaces. When omitted,
  3462. trailing spaces are blank. Overrides the "space" and
  3463. "multispace" settings for trailing spaces.
  3464. *lcs-extends*
  3465. extends:c Character to show in the last column, when 'wrap' is
  3466. off and the line continues beyond the right of the
  3467. screen.
  3468. *lcs-precedes*
  3469. precedes:c Character to show in the first visible column of the
  3470. physical line, when there is text preceding the
  3471. character visible in the first column.
  3472. *lcs-conceal*
  3473. conceal:c Character to show in place of concealed text, when
  3474. 'conceallevel' is set to 1. A space when omitted.
  3475. *lcs-nbsp*
  3476. nbsp:c Character to show for a non-breakable space character
  3477. (0xA0 (160 decimal) and U+202F). Left blank when
  3478. omitted.
  3479. The characters ':' and ',' should not be used. UTF-8 characters can
  3480. be used. All characters must be single width. *E1512*
  3481. Each character can be specified as hex: >vim
  3482. set listchars=eol:\\x24
  3483. set listchars=eol:\\u21b5
  3484. set listchars=eol:\\U000021b5
  3485. < Note that a double backslash is used. The number of hex characters
  3486. must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
  3487. Examples: >vim
  3488. set lcs=tab:>-,trail:-
  3489. set lcs=tab:>-,eol:<,nbsp:%
  3490. set lcs=extends:>,precedes:<
  3491. < |hl-NonText| highlighting will be used for "eol", "extends" and
  3492. "precedes". |hl-Whitespace| for "nbsp", "space", "tab", "multispace",
  3493. "lead" and "trail".
  3494. *'loadplugins'* *'lpl'* *'noloadplugins'* *'nolpl'*
  3495. 'loadplugins' 'lpl' boolean (default on)
  3496. global
  3497. When on the plugin scripts are loaded when starting up |load-plugins|.
  3498. This option can be reset in your |vimrc| file to disable the loading
  3499. of plugins.
  3500. Note that using the "-u NONE" and "--noplugin" command line arguments
  3501. reset this option. |-u| |--noplugin|
  3502. *'magic'* *'nomagic'*
  3503. 'magic' boolean (default on)
  3504. global
  3505. Changes the special characters that can be used in search patterns.
  3506. See |pattern|.
  3507. WARNING: Switching this option off most likely breaks plugins! That
  3508. is because many patterns assume it's on and will fail when it's off.
  3509. Only switch it off when working with old Vi scripts. In any other
  3510. situation write patterns that work when 'magic' is on. Include "\M"
  3511. when you want to |/\M|.
  3512. *'makeef'* *'mef'*
  3513. 'makeef' 'mef' string (default "")
  3514. global
  3515. Name of the errorfile for the |:make| command (see |:make_makeprg|)
  3516. and the |:grep| command.
  3517. When it is empty, an internally generated temp file will be used.
  3518. When "##" is included, it is replaced by a number to make the name
  3519. unique. This makes sure that the ":make" command doesn't overwrite an
  3520. existing file.
  3521. NOT used for the ":cf" command. See 'errorfile' for that.
  3522. Environment variables are expanded |:set_env|.
  3523. See |option-backslash| about including spaces and backslashes.
  3524. This option cannot be set from a |modeline| or in the |sandbox|, for
  3525. security reasons.
  3526. *'makeencoding'* *'menc'*
  3527. 'makeencoding' 'menc' string (default "")
  3528. global or local to buffer |global-local|
  3529. Encoding used for reading the output of external commands. When empty,
  3530. encoding is not converted.
  3531. This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
  3532. `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
  3533. and `:laddfile`.
  3534. This would be mostly useful when you use MS-Windows. If iconv is
  3535. enabled, setting 'makeencoding' to "char" has the same effect as
  3536. setting to the system locale encoding. Example: >vim
  3537. set makeencoding=char " system locale is used
  3538. <
  3539. *'makeprg'* *'mp'*
  3540. 'makeprg' 'mp' string (default "make")
  3541. global or local to buffer |global-local|
  3542. Program to use for the ":make" command. See |:make_makeprg|.
  3543. This option may contain '%' and '#' characters (see |:_%| and |:_#|),
  3544. which are expanded to the current and alternate file name. Use |::S|
  3545. to escape file names in case they contain special characters.
  3546. Environment variables are expanded |:set_env|. See |option-backslash|
  3547. about including spaces and backslashes.
  3548. Note that a '|' must be escaped twice: once for ":set" and once for
  3549. the interpretation of a command. When you use a filter called
  3550. "myfilter" do it like this: >vim
  3551. set makeprg=gmake\ \\\|\ myfilter
  3552. < The placeholder "$*" can be given (even multiple times) to specify
  3553. where the arguments will be included, for example: >vim
  3554. set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  3555. < This option cannot be set from a |modeline| or in the |sandbox|, for
  3556. security reasons.
  3557. *'matchpairs'* *'mps'*
  3558. 'matchpairs' 'mps' string (default "(:),{:},[:]")
  3559. local to buffer
  3560. Characters that form pairs. The |%| command jumps from one to the
  3561. other.
  3562. Only character pairs are allowed that are different, thus you cannot
  3563. jump between two double quotes.
  3564. The characters must be separated by a colon.
  3565. The pairs must be separated by a comma. Example for including '<' and
  3566. '>' (for HTML): >vim
  3567. set mps+=<:>
  3568. < A more exotic example, to jump between the '=' and ';' in an
  3569. assignment, useful for languages like C and Java: >vim
  3570. au FileType c,cpp,java set mps+==:;
  3571. < For a more advanced way of using "%", see the matchit.vim plugin in
  3572. the $VIMRUNTIME/plugin directory. |add-local-help|
  3573. *'matchtime'* *'mat'*
  3574. 'matchtime' 'mat' number (default 5)
  3575. global
  3576. Tenths of a second to show the matching paren, when 'showmatch' is
  3577. set. Note that this is not in milliseconds, like other options that
  3578. set a time. This is to be compatible with Nvi.
  3579. *'maxfuncdepth'* *'mfd'*
  3580. 'maxfuncdepth' 'mfd' number (default 100)
  3581. global
  3582. Maximum depth of function calls for user functions. This normally
  3583. catches endless recursion. When using a recursive function with
  3584. more depth, set 'maxfuncdepth' to a bigger number. But this will use
  3585. more memory, there is the danger of failing when memory is exhausted.
  3586. Increasing this limit above 200 also changes the maximum for Ex
  3587. command recursion, see |E169|.
  3588. See also |:function|.
  3589. Also used for maximum depth of callback functions.
  3590. *'maxmapdepth'* *'mmd'* *E223*
  3591. 'maxmapdepth' 'mmd' number (default 1000)
  3592. global
  3593. Maximum number of times a mapping is done without resulting in a
  3594. character to be used. This normally catches endless mappings, like
  3595. ":map x y" with ":map y x". It still does not catch ":map g wg",
  3596. because the 'w' is used before the next mapping is done. See also
  3597. |key-mapping|.
  3598. *'maxmempattern'* *'mmp'*
  3599. 'maxmempattern' 'mmp' number (default 1000)
  3600. global
  3601. Maximum amount of memory (in Kbyte) to use for pattern matching.
  3602. The maximum value is about 2000000. Use this to work without a limit.
  3603. *E363*
  3604. When Vim runs into the limit it gives an error message and mostly
  3605. behaves like CTRL-C was typed.
  3606. Running into the limit often means that the pattern is very
  3607. inefficient or too complex. This may already happen with the pattern
  3608. "\(.\)*" on a very long line. ".*" works much better.
  3609. Might also happen on redraw, when syntax rules try to match a complex
  3610. text structure.
  3611. Vim may run out of memory before hitting the 'maxmempattern' limit, in
  3612. which case you get an "Out of memory" error instead.
  3613. *'menuitems'* *'mis'*
  3614. 'menuitems' 'mis' number (default 25)
  3615. global
  3616. Maximum number of items to use in a menu. Used for menus that are
  3617. generated from a list of items, e.g., the Buffers menu. Changing this
  3618. option has no direct effect, the menu must be refreshed first.
  3619. *'messagesopt'* *'mopt'*
  3620. 'messagesopt' 'mopt' string (default "hit-enter,history:500")
  3621. global
  3622. Option settings for outputting messages. It can consist of the
  3623. following items. Items must be separated by a comma.
  3624. hit-enter Use a |hit-enter| prompt when the message is longer than
  3625. 'cmdheight' size.
  3626. wait:{n} Instead of using a |hit-enter| prompt, simply wait for
  3627. {n} milliseconds so that the user has a chance to read
  3628. the message. The maximum value of {n} is 10000. Use
  3629. 0 to disable the wait (but then the user may miss an
  3630. important message).
  3631. This item is ignored when "hit-enter" is present, but
  3632. required when "hit-enter" is not present.
  3633. history:{n} Determines how many entries are remembered in the
  3634. |:messages| history. The maximum value is 10000.
  3635. Setting it to zero clears the message history.
  3636. This item must always be present.
  3637. *'mkspellmem'* *'msm'*
  3638. 'mkspellmem' 'msm' string (default "460000,2000,500")
  3639. global
  3640. Parameters for |:mkspell|. This tunes when to start compressing the
  3641. word tree. Compression can be slow when there are many words, but
  3642. it's needed to avoid running out of memory. The amount of memory used
  3643. per word depends very much on how similar the words are, that's why
  3644. this tuning is complicated.
  3645. There are three numbers, separated by commas: >
  3646. {start},{inc},{added}
  3647. <
  3648. For most languages the uncompressed word tree fits in memory. {start}
  3649. gives the amount of memory in Kbyte that can be used before any
  3650. compression is done. It should be a bit smaller than the amount of
  3651. memory that is available to Vim.
  3652. When going over the {start} limit the {inc} number specifies the
  3653. amount of memory in Kbyte that can be allocated before another
  3654. compression is done. A low number means compression is done after
  3655. less words are added, which is slow. A high number means more memory
  3656. will be allocated.
  3657. After doing compression, {added} times 1024 words can be added before
  3658. the {inc} limit is ignored and compression is done when any extra
  3659. amount of memory is needed. A low number means there is a smaller
  3660. chance of hitting the {inc} limit, less memory is used but it's
  3661. slower.
  3662. The languages for which these numbers are important are Italian and
  3663. Hungarian. The default works for when you have about 512 Mbyte. If
  3664. you have 1 Gbyte you could use: >vim
  3665. set mkspellmem=900000,3000,800
  3666. < If you have less than 512 Mbyte |:mkspell| may fail for some
  3667. languages, no matter what you set 'mkspellmem' to.
  3668. This option cannot be set from a |modeline| or in the |sandbox|, for
  3669. security reasons.
  3670. *'modeline'* *'ml'* *'nomodeline'* *'noml'*
  3671. 'modeline' 'ml' boolean (default on (off for root))
  3672. local to buffer
  3673. If 'modeline' is on 'modelines' gives the number of lines that is
  3674. checked for set commands. If 'modeline' is off or 'modelines' is zero
  3675. no lines are checked. See |modeline|.
  3676. *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
  3677. 'modelineexpr' 'mle' boolean (default off)
  3678. global
  3679. When on allow some options that are an expression to be set in the
  3680. modeline. Check the option for whether it is affected by
  3681. 'modelineexpr'. Also see |modeline|.
  3682. This option cannot be set from a |modeline| or in the |sandbox|, for
  3683. security reasons.
  3684. *'modelines'* *'mls'*
  3685. 'modelines' 'mls' number (default 5)
  3686. global
  3687. If 'modeline' is on 'modelines' gives the number of lines that is
  3688. checked for set commands. If 'modeline' is off or 'modelines' is zero
  3689. no lines are checked. See |modeline|.
  3690. *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* *E21*
  3691. 'modifiable' 'ma' boolean (default on)
  3692. local to buffer
  3693. When off the buffer contents cannot be changed. The 'fileformat' and
  3694. 'fileencoding' options also can't be changed.
  3695. Can be reset on startup with the |-M| command line argument.
  3696. *'modified'* *'mod'* *'nomodified'* *'nomod'*
  3697. 'modified' 'mod' boolean (default off)
  3698. local to buffer |local-noglobal|
  3699. When on, the buffer is considered to be modified. This option is set
  3700. when:
  3701. 1. A change was made to the text since it was last written. Using the
  3702. |undo| command to go back to the original text will reset the
  3703. option. But undoing changes that were made before writing the
  3704. buffer will set the option again, since the text is different from
  3705. when it was written.
  3706. 2. 'fileformat' or 'fileencoding' is different from its original
  3707. value. The original value is set when the buffer is read or
  3708. written. A ":set nomodified" command also resets the original
  3709. values to the current values and the 'modified' option will be
  3710. reset.
  3711. Similarly for 'eol' and 'bomb'.
  3712. This option is not set when a change is made to the buffer as the
  3713. result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
  3714. FileAppendPost or VimLeave autocommand event. See |gzip-example| for
  3715. an explanation.
  3716. When 'buftype' is "nowrite" or "nofile" this option may be set, but
  3717. will be ignored.
  3718. Note that the text may actually be the same, e.g. 'modified' is set
  3719. when using "rA" on an "A".
  3720. *'more'* *'nomore'*
  3721. 'more' boolean (default on)
  3722. global
  3723. When on, listings pause when the whole screen is filled. You will get
  3724. the |more-prompt|. When this option is off there are no pauses, the
  3725. listing continues until finished.
  3726. *'mouse'*
  3727. 'mouse' string (default "nvi")
  3728. global
  3729. Enables mouse support. For example, to enable the mouse in Normal mode
  3730. and Visual mode: >vim
  3731. set mouse=nv
  3732. <
  3733. To temporarily disable mouse support, hold the shift key while using
  3734. the mouse.
  3735. Mouse support can be enabled for different modes:
  3736. n Normal mode
  3737. v Visual mode
  3738. i Insert mode
  3739. c Command-line mode
  3740. h all previous modes when editing a help file
  3741. a all previous modes
  3742. r for |hit-enter| and |more-prompt| prompt
  3743. Left-click anywhere in a text buffer to place the cursor there. This
  3744. works with operators too, e.g. type |d| then left-click to delete text
  3745. from the current cursor position to the position where you clicked.
  3746. Drag the |status-line| or vertical separator of a window to resize it.
  3747. If enabled for "v" (Visual mode) then double-click selects word-wise,
  3748. triple-click makes it line-wise, and quadruple-click makes it
  3749. rectangular block-wise.
  3750. For scrolling with a mouse wheel see |scroll-mouse-wheel|.
  3751. Note: When enabling the mouse in a terminal, copy/paste will use the
  3752. "* register if possible. See also 'clipboard'.
  3753. Related options:
  3754. 'mousefocus' window focus follows mouse pointer
  3755. 'mousemodel' what mouse button does which action
  3756. 'mousehide' hide mouse pointer while typing text
  3757. 'selectmode' whether to start Select mode or Visual mode
  3758. *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
  3759. 'mousefocus' 'mousef' boolean (default off)
  3760. global
  3761. The window that the mouse pointer is on is automatically activated.
  3762. When changing the window layout or window focus in another way, the
  3763. mouse pointer is moved to the window with keyboard focus. Off is the
  3764. default because it makes using the pull down menus a little goofy, as
  3765. a pointer transit may activate a window unintentionally.
  3766. *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
  3767. 'mousehide' 'mh' boolean (default on)
  3768. global
  3769. only in the GUI
  3770. When on, the mouse pointer is hidden when characters are typed.
  3771. The mouse pointer is restored when the mouse is moved.
  3772. *'mousemodel'* *'mousem'*
  3773. 'mousemodel' 'mousem' string (default "popup_setpos")
  3774. global
  3775. Sets the model to use for the mouse. The name mostly specifies what
  3776. the right mouse button is used for:
  3777. extend Right mouse button extends a selection. This works
  3778. like in an xterm.
  3779. popup Right mouse button pops up a menu. The shifted left
  3780. mouse button extends a selection. This works like
  3781. with Microsoft Windows.
  3782. popup_setpos Like "popup", but the cursor will be moved to the
  3783. position where the mouse was clicked, and thus the
  3784. selected operation will act upon the clicked object.
  3785. If clicking inside a selection, that selection will
  3786. be acted upon, i.e. no cursor move. This implies of
  3787. course, that right clicking outside a selection will
  3788. end Visual mode.
  3789. Overview of what button does what for each model:
  3790. mouse extend popup(_setpos) ~
  3791. left click place cursor place cursor
  3792. left drag start selection start selection
  3793. shift-left search word extend selection
  3794. right click extend selection popup menu (place cursor)
  3795. right drag extend selection -
  3796. middle click paste paste
  3797. In the "popup" model the right mouse button produces a pop-up menu.
  3798. Nvim creates a default |popup-menu| but you can redefine it.
  3799. Note that you can further refine the meaning of buttons with mappings.
  3800. See |mouse-overview|. But mappings are NOT used for modeless selection.
  3801. Example: >vim
  3802. map <S-LeftMouse> <RightMouse>
  3803. map <S-LeftDrag> <RightDrag>
  3804. map <S-LeftRelease> <RightRelease>
  3805. map <2-S-LeftMouse> <2-RightMouse>
  3806. map <2-S-LeftDrag> <2-RightDrag>
  3807. map <2-S-LeftRelease> <2-RightRelease>
  3808. map <3-S-LeftMouse> <3-RightMouse>
  3809. map <3-S-LeftDrag> <3-RightDrag>
  3810. map <3-S-LeftRelease> <3-RightRelease>
  3811. map <4-S-LeftMouse> <4-RightMouse>
  3812. map <4-S-LeftDrag> <4-RightDrag>
  3813. map <4-S-LeftRelease> <4-RightRelease>
  3814. <
  3815. Mouse commands requiring the CTRL modifier can be simulated by typing
  3816. the "g" key before using the mouse:
  3817. "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click)
  3818. "g<RightMouse>" is "<C-RightMouse> ("CTRL-T")
  3819. *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
  3820. 'mousemoveevent' 'mousemev' boolean (default off)
  3821. global
  3822. When on, mouse move events are delivered to the input queue and are
  3823. available for mapping. The default, off, avoids the mouse movement
  3824. overhead except when needed.
  3825. Warning: Setting this option can make pending mappings to be aborted
  3826. when the mouse is moved.
  3827. *'mousescroll'* *E5080*
  3828. 'mousescroll' string (default "ver:3,hor:6")
  3829. global
  3830. This option controls the number of lines / columns to scroll by when
  3831. scrolling with a mouse wheel (|scroll-mouse-wheel|). The option is
  3832. a comma-separated list. Each part consists of a direction and a count
  3833. as follows:
  3834. direction:count,direction:count
  3835. Direction is one of either "hor" or "ver". "hor" controls horizontal
  3836. scrolling and "ver" controls vertical scrolling. Count sets the amount
  3837. to scroll by for the given direction, it should be a non negative
  3838. integer. Each direction should be set at most once. If a direction
  3839. is omitted, a default value is used (6 for horizontal scrolling and 3
  3840. for vertical scrolling). You can disable mouse scrolling by using
  3841. a count of 0.
  3842. Example: >vim
  3843. set mousescroll=ver:5,hor:2
  3844. < Will make Nvim scroll 5 lines at a time when scrolling vertically, and
  3845. scroll 2 columns at a time when scrolling horizontally.
  3846. *'mousetime'* *'mouset'*
  3847. 'mousetime' 'mouset' number (default 500)
  3848. global
  3849. Defines the maximum time in msec between two mouse clicks for the
  3850. second click to be recognized as a multi click.
  3851. *'nrformats'* *'nf'*
  3852. 'nrformats' 'nf' string (default "bin,hex")
  3853. local to buffer
  3854. This defines what bases Vim will consider for numbers when using the
  3855. CTRL-A and CTRL-X commands for adding to and subtracting from a number
  3856. respectively; see |CTRL-A| for more info on these commands.
  3857. alpha If included, single alphabetical characters will be
  3858. incremented or decremented. This is useful for a list with a
  3859. letter index a), b), etc. *octal-nrformats*
  3860. octal If included, numbers that start with a zero will be considered
  3861. to be octal. Example: Using CTRL-A on "007" results in "010".
  3862. hex If included, numbers starting with "0x" or "0X" will be
  3863. considered to be hexadecimal. Example: Using CTRL-X on
  3864. "0x100" results in "0x0ff".
  3865. bin If included, numbers starting with "0b" or "0B" will be
  3866. considered to be binary. Example: Using CTRL-X on
  3867. "0b1000" subtracts one, resulting in "0b0111".
  3868. unsigned If included, numbers are recognized as unsigned. Thus a
  3869. leading dash or negative sign won't be considered as part of
  3870. the number. Examples:
  3871. Using CTRL-X on "2020" in "9-2020" results in "9-2019"
  3872. (without "unsigned" it would become "9-2021").
  3873. Using CTRL-A on "2020" in "9-2020" results in "9-2021"
  3874. (without "unsigned" it would become "9-2019").
  3875. Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
  3876. (2^64 - 1) has no effect, overflow is prevented.
  3877. blank If included, treat numbers as signed or unsigned based on
  3878. preceding whitespace. If a number with a leading dash has its
  3879. dash immediately preceded by a non-whitespace character (i.e.,
  3880. not a tab or a " "), the negative sign won't be considered as
  3881. part of the number. For example:
  3882. Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
  3883. (without "blank" it would become "Carbon-13").
  3884. Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
  3885. (because -8 is preceded by whitespace. If "unsigned" was
  3886. set, it would result in "Carbon -7").
  3887. If this format is included, overflow is prevented as if
  3888. "unsigned" were set. If both this format and "unsigned" are
  3889. included, "unsigned" will take precedence.
  3890. Numbers which simply begin with a digit in the range 1-9 are always
  3891. considered decimal. This also happens for numbers that are not
  3892. recognized as octal or hex.
  3893. *'number'* *'nu'* *'nonumber'* *'nonu'*
  3894. 'number' 'nu' boolean (default off)
  3895. local to window
  3896. Print the line number in front of each line. When the 'n' option is
  3897. excluded from 'cpoptions' a wrapped line will not use the column of
  3898. line numbers.
  3899. Use the 'numberwidth' option to adjust the room for the line number.
  3900. When a long, wrapped line doesn't start with the first character, '-'
  3901. characters are put before the number.
  3902. For highlighting see |hl-LineNr|, |hl-CursorLineNr|, and the
  3903. |:sign-define| "numhl" argument.
  3904. *number_relativenumber*
  3905. The 'relativenumber' option changes the displayed number to be
  3906. relative to the cursor. Together with 'number' there are these
  3907. four combinations (cursor in line 3):
  3908. 'nonu' 'nu' 'nonu' 'nu'
  3909. 'nornu' 'nornu' 'rnu' 'rnu'
  3910. >
  3911. |apple | 1 apple | 2 apple | 2 apple
  3912. |pear | 2 pear | 1 pear | 1 pear
  3913. |nobody | 3 nobody | 0 nobody |3 nobody
  3914. |there | 4 there | 1 there | 1 there
  3915. <
  3916. *'numberwidth'* *'nuw'*
  3917. 'numberwidth' 'nuw' number (default 4)
  3918. local to window
  3919. Minimal number of columns to use for the line number. Only relevant
  3920. when the 'number' or 'relativenumber' option is set or printing lines
  3921. with a line number. Since one space is always between the number and
  3922. the text, there is one less character for the number itself.
  3923. The value is the minimum width. A bigger width is used when needed to
  3924. fit the highest line number in the buffer respectively the number of
  3925. rows in the window, depending on whether 'number' or 'relativenumber'
  3926. is set. Thus with the Vim default of 4 there is room for a line number
  3927. up to 999. When the buffer has 1000 lines five columns will be used.
  3928. The minimum value is 1, the maximum value is 20.
  3929. *'omnifunc'* *'ofu'*
  3930. 'omnifunc' 'ofu' string (default "")
  3931. local to buffer
  3932. This option specifies a function to be used for Insert mode omni
  3933. completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
  3934. See |complete-functions| for an explanation of how the function is
  3935. invoked and what it should return. The value can be the name of a
  3936. function, a |lambda| or a |Funcref|. See |option-value-function| for
  3937. more information.
  3938. This option is usually set by a filetype plugin:
  3939. |:filetype-plugin-on|
  3940. This option cannot be set from a |modeline| or in the |sandbox|, for
  3941. security reasons.
  3942. *'operatorfunc'* *'opfunc'*
  3943. 'operatorfunc' 'opfunc' string (default "")
  3944. global
  3945. This option specifies a function to be called by the |g@| operator.
  3946. See |:map-operator| for more info and an example. The value can be
  3947. the name of a function, a |lambda| or a |Funcref|. See
  3948. |option-value-function| for more information.
  3949. This option cannot be set from a |modeline| or in the |sandbox|, for
  3950. security reasons.
  3951. *'packpath'* *'pp'*
  3952. 'packpath' 'pp' string (default see 'runtimepath')
  3953. global
  3954. Directories used to find packages.
  3955. See |packages| and |packages-runtimepath|.
  3956. This option cannot be set from a |modeline| or in the |sandbox|, for
  3957. security reasons.
  3958. *'paragraphs'* *'para'*
  3959. 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
  3960. global
  3961. Specifies the nroff macros that separate paragraphs. These are pairs
  3962. of two letters (see |object-motions|).
  3963. *'patchexpr'* *'pex'*
  3964. 'patchexpr' 'pex' string (default "")
  3965. global
  3966. Expression which is evaluated to apply a patch to a file and generate
  3967. the resulting new version of the file. See |diff-patchexpr|.
  3968. This option cannot be set from a |modeline| or in the |sandbox|, for
  3969. security reasons.
  3970. *'patchmode'* *'pm'* *E205* *E206*
  3971. 'patchmode' 'pm' string (default "")
  3972. global
  3973. When non-empty the oldest version of a file is kept. This can be used
  3974. to keep the original version of a file if you are changing files in a
  3975. source distribution. Only the first time that a file is written a
  3976. copy of the original file will be kept. The name of the copy is the
  3977. name of the original file with the string in the 'patchmode' option
  3978. appended. This option should start with a dot. Use a string like
  3979. ".orig" or ".org". 'backupdir' must not be empty for this to work
  3980. (Detail: The backup file is renamed to the patchmode file after the
  3981. new file has been successfully written, that's why it must be possible
  3982. to write a backup file). If there was no file to be backed up, an
  3983. empty file is created.
  3984. When the 'backupskip' pattern matches, a patchmode file is not made.
  3985. Using 'patchmode' for compressed files appends the extension at the
  3986. end (e.g., "file.gz.orig"), thus the resulting name isn't always
  3987. recognized as a compressed file.
  3988. Only normal file name characters can be used, `/\*?[|<>` are illegal.
  3989. *'path'* *'pa'* *E343* *E345* *E347* *E854*
  3990. 'path' 'pa' string (default ".,,")
  3991. global or local to buffer |global-local|
  3992. This is a list of directories which will be searched when using the
  3993. |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
  3994. provided that the file being searched for has a relative path (not
  3995. starting with "/", "./" or "../"). The directories in the 'path'
  3996. option may be relative or absolute.
  3997. - Use commas to separate directory names: >vim
  3998. set path=.,/usr/local/include,/usr/include
  3999. < - Spaces can also be used to separate directory names. To have a
  4000. space in a directory name, precede it with an extra backslash, and
  4001. escape the space: >vim
  4002. set path=.,/dir/with\\\ space
  4003. < - To include a comma in a directory name precede it with an extra
  4004. backslash: >vim
  4005. set path=.,/dir/with\\,comma
  4006. < - To search relative to the directory of the current file, use: >vim
  4007. set path=.
  4008. < - To search in the current directory use an empty string between two
  4009. commas: >vim
  4010. set path=,,
  4011. < - A directory name may end in a ':' or '/'.
  4012. - Environment variables are expanded |:set_env|.
  4013. - When using |netrw.vim| URLs can be used. For example, adding
  4014. "https://www.vim.org" will make ":find index.html" work.
  4015. - Search upwards and downwards in a directory tree using "*", "**" and
  4016. ";". See |file-searching| for info and syntax.
  4017. - Careful with '\' characters, type two to get one in the option: >vim
  4018. set path=.,c:\\include
  4019. < Or just use '/' instead: >vim
  4020. set path=.,c:/include
  4021. < Don't forget "." or files won't even be found in the same directory as
  4022. the file!
  4023. The maximum length is limited. How much depends on the system, mostly
  4024. it is something like 256 or 1024 characters.
  4025. You can check if all the include files are found, using the value of
  4026. 'path', see |:checkpath|.
  4027. The use of |:set+=| and |:set-=| is preferred when adding or removing
  4028. directories from the list. This avoids problems when a future version
  4029. uses another default. To remove the current directory use: >vim
  4030. set path-=
  4031. < To add the current directory use: >vim
  4032. set path+=
  4033. < To use an environment variable, you probably need to replace the
  4034. separator. Here is an example to append $INCL, in which directory
  4035. names are separated with a semicolon: >vim
  4036. let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
  4037. < Replace the ';' with a ':' or whatever separator is used. Note that
  4038. this doesn't work when $INCL contains a comma or white space.
  4039. *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
  4040. 'preserveindent' 'pi' boolean (default off)
  4041. local to buffer
  4042. When changing the indent of the current line, preserve as much of the
  4043. indent structure as possible. Normally the indent is replaced by a
  4044. series of tabs followed by spaces as required (unless |'expandtab'| is
  4045. enabled, in which case only spaces are used). Enabling this option
  4046. means the indent will preserve as many existing characters as possible
  4047. for indenting, and only add additional tabs or spaces as required.
  4048. 'expandtab' does not apply to the preserved white space, a Tab remains
  4049. a Tab.
  4050. NOTE: When using ">>" multiple times the resulting indent is a mix of
  4051. tabs and spaces. You might not like this.
  4052. Also see 'copyindent'.
  4053. Use |:retab| to clean up white space.
  4054. *'previewheight'* *'pvh'*
  4055. 'previewheight' 'pvh' number (default 12)
  4056. global
  4057. Default height for a preview window. Used for |:ptag| and associated
  4058. commands. Used for |CTRL-W_}| when no count is given.
  4059. *'previewwindow'* *'pvw'* *'nopreviewwindow'* *'nopvw'* *E590*
  4060. 'previewwindow' 'pvw' boolean (default off)
  4061. local to window |local-noglobal|
  4062. Identifies the preview window. Only one window can have this option
  4063. set. It's normally not set directly, but by using one of the commands
  4064. |:ptag|, |:pedit|, etc.
  4065. *'pumblend'* *'pb'*
  4066. 'pumblend' 'pb' number (default 0)
  4067. global
  4068. Enables pseudo-transparency for the |popup-menu|. Valid values are in
  4069. the range of 0 for fully opaque popupmenu (disabled) to 100 for fully
  4070. transparent background. Values between 0-30 are typically most useful.
  4071. It is possible to override the level for individual highlights within
  4072. the popupmenu using |highlight-blend|. For instance, to enable
  4073. transparency but force the current selected element to be fully opaque: >vim
  4074. set pumblend=15
  4075. hi PmenuSel blend=0
  4076. <
  4077. UI-dependent. Works best with RGB colors. 'termguicolors'
  4078. *'pumheight'* *'ph'*
  4079. 'pumheight' 'ph' number (default 0)
  4080. global
  4081. Maximum number of items to show in the popup menu
  4082. (|ins-completion-menu|). Zero means "use available screen space".
  4083. *'pumwidth'* *'pw'*
  4084. 'pumwidth' 'pw' number (default 15)
  4085. global
  4086. Minimum width for the popup menu (|ins-completion-menu|). If the
  4087. cursor column + 'pumwidth' exceeds screen width, the popup menu is
  4088. nudged to fit on the screen.
  4089. *'pyxversion'* *'pyx'*
  4090. 'pyxversion' 'pyx' number (default 3)
  4091. global
  4092. Specifies the python version used for pyx* functions and commands
  4093. |python_x|. As only Python 3 is supported, this always has the value
  4094. `3`. Setting any other value is an error.
  4095. This option cannot be set from a |modeline| or in the |sandbox|, for
  4096. security reasons.
  4097. *'quickfixtextfunc'* *'qftf'*
  4098. 'quickfixtextfunc' 'qftf' string (default "")
  4099. global
  4100. This option specifies a function to be used to get the text to display
  4101. in the quickfix and location list windows. This can be used to
  4102. customize the information displayed in the quickfix or location window
  4103. for each entry in the corresponding quickfix or location list. See
  4104. |quickfix-window-function| for an explanation of how to write the
  4105. function and an example. The value can be the name of a function, a
  4106. |lambda| or a |Funcref|. See |option-value-function| for more
  4107. information.
  4108. This option cannot be set from a |modeline| or in the |sandbox|, for
  4109. security reasons.
  4110. *'quoteescape'* *'qe'*
  4111. 'quoteescape' 'qe' string (default "\")
  4112. local to buffer
  4113. The characters that are used to escape quotes in a string. Used for
  4114. objects like a', a" and a` |a'|.
  4115. When one of the characters in this option is found inside a string,
  4116. the following character will be skipped. The default value makes the
  4117. text "foo\"bar\\" considered to be one string.
  4118. *'readonly'* *'ro'* *'noreadonly'* *'noro'*
  4119. 'readonly' 'ro' boolean (default off)
  4120. local to buffer |local-noglobal|
  4121. If on, writes fail unless you use a '!'. Protects you from
  4122. accidentally overwriting a file. Default on when Vim is started
  4123. in read-only mode ("vim -R") or when the executable is called "view".
  4124. When using ":w!" the 'readonly' option is reset for the current
  4125. buffer, unless the 'Z' flag is in 'cpoptions'.
  4126. When using the ":view" command the 'readonly' option is set for the
  4127. newly edited buffer.
  4128. See 'modifiable' for disallowing changes to the buffer.
  4129. *'redrawdebug'* *'rdb'*
  4130. 'redrawdebug' 'rdb' string (default "")
  4131. global
  4132. Flags to change the way redrawing works, for debugging purposes.
  4133. Most useful with 'writedelay' set to some reasonable value.
  4134. Supports the following flags:
  4135. compositor Indicate each redraw event handled by the compositor
  4136. by briefly flashing the redrawn regions in colors
  4137. indicating the redraw type. These are the highlight
  4138. groups used (and their default colors):
  4139. RedrawDebugNormal gui=reverse normal redraw passed through
  4140. RedrawDebugClear guibg=Yellow clear event passed through
  4141. RedrawDebugComposed guibg=Green redraw event modified by the
  4142. compositor (due to
  4143. overlapping grids, etc)
  4144. RedrawDebugRecompose guibg=Red redraw generated by the
  4145. compositor itself, due to a
  4146. grid being moved or deleted.
  4147. line introduce a delay after each line drawn on the screen.
  4148. When using the TUI or another single-grid UI, "compositor"
  4149. gives more information and should be preferred (every
  4150. line is processed as a separate event by the compositor)
  4151. flush introduce a delay after each "flush" event.
  4152. nothrottle Turn off throttling of the message grid. This is an
  4153. optimization that joins many small scrolls to one
  4154. larger scroll when drawing the message area (with
  4155. 'display' msgsep flag active).
  4156. invalid Enable stricter checking (abort) of inconsistencies
  4157. of the internal screen state. This is mostly
  4158. useful when running nvim inside a debugger (and
  4159. the test suite).
  4160. nodelta Send all internally redrawn cells to the UI, even if
  4161. they are unchanged from the already displayed state.
  4162. *'redrawtime'* *'rdt'*
  4163. 'redrawtime' 'rdt' number (default 2000)
  4164. global
  4165. Time in milliseconds for redrawing the display. Applies to
  4166. 'hlsearch', 'inccommand', |:match| highlighting, syntax highlighting,
  4167. and async |LanguageTree:parse()|.
  4168. When redrawing takes more than this many milliseconds no further
  4169. matches will be highlighted.
  4170. For syntax highlighting the time applies per window. When over the
  4171. limit syntax highlighting is disabled until |CTRL-L| is used.
  4172. This is used to avoid that Vim hangs when using a very complicated
  4173. pattern.
  4174. *'regexpengine'* *'re'*
  4175. 'regexpengine' 're' number (default 0)
  4176. global
  4177. This selects the default regexp engine. |two-engines|
  4178. The possible values are:
  4179. 0 automatic selection
  4180. 1 old engine
  4181. 2 NFA engine
  4182. Note that when using the NFA engine and the pattern contains something
  4183. that is not supported the pattern will not match. This is only useful
  4184. for debugging the regexp engine.
  4185. Using automatic selection enables Vim to switch the engine, if the
  4186. default engine becomes too costly. E.g., when the NFA engine uses too
  4187. many states. This should prevent Vim from hanging on a combination of
  4188. a complex pattern with long text.
  4189. *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
  4190. 'relativenumber' 'rnu' boolean (default off)
  4191. local to window
  4192. Show the line number relative to the line with the cursor in front of
  4193. each line. Relative line numbers help you use the |count| you can
  4194. precede some vertical motion commands (e.g. j k + -) with, without
  4195. having to calculate it yourself. Especially useful in combination with
  4196. other commands (e.g. y d c < > gq gw =).
  4197. When the 'n' option is excluded from 'cpoptions' a wrapped
  4198. line will not use the column of line numbers.
  4199. The 'numberwidth' option can be used to set the room used for the line
  4200. number.
  4201. When a long, wrapped line doesn't start with the first character, '-'
  4202. characters are put before the number.
  4203. See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
  4204. the number.
  4205. The number in front of the cursor line also depends on the value of
  4206. 'number', see |number_relativenumber| for all combinations of the two
  4207. options.
  4208. *'report'*
  4209. 'report' number (default 2)
  4210. global
  4211. Threshold for reporting number of lines changed. When the number of
  4212. changed lines is more than 'report' a message will be given for most
  4213. ":" commands. If you want it always, set 'report' to 0.
  4214. For the ":substitute" command the number of substitutions is used
  4215. instead of the number of lines.
  4216. *'revins'* *'ri'* *'norevins'* *'nori'*
  4217. 'revins' 'ri' boolean (default off)
  4218. global
  4219. Inserting characters in Insert mode will work backwards. See "typing
  4220. backwards" |ins-reverse|. This option can be toggled with the CTRL-_
  4221. command in Insert mode, when 'allowrevins' is set.
  4222. *'rightleft'* *'rl'* *'norightleft'* *'norl'*
  4223. 'rightleft' 'rl' boolean (default off)
  4224. local to window
  4225. When on, display orientation becomes right-to-left, i.e., characters
  4226. that are stored in the file appear from the right to the left.
  4227. Using this option, it is possible to edit files for languages that
  4228. are written from the right to the left such as Hebrew and Arabic.
  4229. This option is per window, so it is possible to edit mixed files
  4230. simultaneously, or to view the same file in both ways (this is
  4231. useful whenever you have a mixed text file with both right-to-left
  4232. and left-to-right strings so that both sets are displayed properly
  4233. in different windows). Also see |rileft.txt|.
  4234. *'rightleftcmd'* *'rlc'*
  4235. 'rightleftcmd' 'rlc' string (default "search")
  4236. local to window
  4237. Each word in this option enables the command line editing to work in
  4238. right-to-left mode for a group of commands:
  4239. search "/" and "?" commands
  4240. This is useful for languages such as Hebrew, Arabic and Farsi.
  4241. The 'rightleft' option must be set for 'rightleftcmd' to take effect.
  4242. *'ruler'* *'ru'* *'noruler'* *'noru'*
  4243. 'ruler' 'ru' boolean (default on)
  4244. global
  4245. Show the line and column number of the cursor position, separated by a
  4246. comma. When there is room, the relative position of the displayed
  4247. text in the file is shown on the far right:
  4248. Top first line is visible
  4249. Bot last line is visible
  4250. All first and last line are visible
  4251. 45% relative position in the file
  4252. If 'rulerformat' is set, it will determine the contents of the ruler.
  4253. Each window has its own ruler. If a window has a status line, the
  4254. ruler is shown there. If a window doesn't have a status line and
  4255. 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
  4256. the last line of the screen. If the statusline is given by
  4257. 'statusline' (i.e. not empty), this option takes precedence over
  4258. 'ruler' and 'rulerformat'.
  4259. If the number of characters displayed is different from the number of
  4260. bytes in the text (e.g., for a TAB or a multibyte character), both
  4261. the text column (byte number) and the screen column are shown,
  4262. separated with a dash.
  4263. For an empty line "0-1" is shown.
  4264. For an empty buffer the line number will also be zero: "0,0-1".
  4265. If you don't want to see the ruler all the time but want to know where
  4266. you are, use "g CTRL-G" |g_CTRL-G|.
  4267. *'rulerformat'* *'ruf'*
  4268. 'rulerformat' 'ruf' string (default "")
  4269. global
  4270. When this option is not empty, it determines the content of the ruler
  4271. string, as displayed for the 'ruler' option.
  4272. The format of this option is like that of 'statusline'.
  4273. This option cannot be set in a modeline when 'modelineexpr' is off.
  4274. The default ruler width is 17 characters. To make the ruler 15
  4275. characters wide, put "%15(" at the start and "%)" at the end.
  4276. Example: >vim
  4277. set rulerformat=%15(%c%V\ %p%%%)
  4278. <
  4279. *'runtimepath'* *'rtp'* *vimfiles*
  4280. 'runtimepath' 'rtp' string (default "$XDG_CONFIG_HOME/nvim,
  4281. $XDG_CONFIG_DIRS[1]/nvim,
  4282. $XDG_CONFIG_DIRS[2]/nvim,
  4283. $XDG_DATA_HOME/nvim[-data]/site,
  4284. $XDG_DATA_DIRS[1]/nvim/site,
  4285. $XDG_DATA_DIRS[2]/nvim/site,
  4286. $VIMRUNTIME,
  4287. $XDG_DATA_DIRS[2]/nvim/site/after,
  4288. $XDG_DATA_DIRS[1]/nvim/site/after,
  4289. $XDG_DATA_HOME/nvim[-data]/site/after,
  4290. $XDG_CONFIG_DIRS[2]/nvim/after,
  4291. $XDG_CONFIG_DIRS[1]/nvim/after,
  4292. $XDG_CONFIG_HOME/nvim/after")
  4293. global
  4294. List of directories to be searched for these runtime files:
  4295. filetype.lua filetypes |new-filetype|
  4296. autoload/ automatically loaded scripts |autoload-functions|
  4297. colors/ color scheme files |:colorscheme|
  4298. compiler/ compiler files |:compiler|
  4299. doc/ documentation |write-local-help|
  4300. ftplugin/ filetype plugins |write-filetype-plugin|
  4301. indent/ indent scripts |indent-expression|
  4302. keymap/ key mapping files |mbyte-keymap|
  4303. lang/ menu translations |:menutrans|
  4304. lsp/ LSP client configurations |lsp-config|
  4305. lua/ |Lua| plugins
  4306. menu.vim GUI menus |menu.vim|
  4307. pack/ packages |:packadd|
  4308. parser/ |treesitter| syntax parsers
  4309. plugin/ plugin scripts |write-plugin|
  4310. queries/ |treesitter| queries
  4311. rplugin/ |remote-plugin| scripts
  4312. spell/ spell checking files |spell|
  4313. syntax/ syntax files |mysyntaxfile|
  4314. tutor/ tutorial files |:Tutor|
  4315. And any other file searched for with the |:runtime| command.
  4316. Defaults are setup to search these locations:
  4317. 1. Your home directory, for personal preferences.
  4318. Given by `stdpath("config")`. |$XDG_CONFIG_HOME|
  4319. 2. Directories which must contain configuration files according to
  4320. |xdg| ($XDG_CONFIG_DIRS, defaults to /etc/xdg). This also contains
  4321. preferences from system administrator.
  4322. 3. Data home directory, for plugins installed by user.
  4323. Given by `stdpath("data")/site`. |$XDG_DATA_HOME|
  4324. 4. nvim/site subdirectories for each directory in $XDG_DATA_DIRS.
  4325. This is for plugins which were installed by system administrator,
  4326. but are not part of the Nvim distribution. XDG_DATA_DIRS defaults
  4327. to /usr/local/share/:/usr/share/, so system administrators are
  4328. expected to install site plugins to /usr/share/nvim/site.
  4329. 5. Session state directory, for state data such as swap, backupdir,
  4330. viewdir, undodir, etc.
  4331. Given by `stdpath("state")`. |$XDG_STATE_HOME|
  4332. 6. $VIMRUNTIME, for files distributed with Nvim.
  4333. *after-directory*
  4334. 7, 8, 9, 10. In after/ subdirectories of 1, 2, 3 and 4, with reverse
  4335. ordering. This is for preferences to overrule or add to the
  4336. distributed defaults or system-wide settings (rarely needed).
  4337. *packages-runtimepath*
  4338. "start" packages will also be searched (|runtime-search-path|) for
  4339. runtime files after these, though such packages are not explicitly
  4340. reported in &runtimepath. But "opt" packages are explicitly added to
  4341. &runtimepath by |:packadd|.
  4342. Note that, unlike 'path', no wildcards like "**" are allowed. Normal
  4343. wildcards are allowed, but can significantly slow down searching for
  4344. runtime files. For speed, use as few items as possible and avoid
  4345. wildcards.
  4346. See |:runtime|.
  4347. Example: >vim
  4348. set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
  4349. < This will use the directory "~/vimruntime" first (containing your
  4350. personal Nvim runtime files), then "/mygroup/vim", and finally
  4351. "$VIMRUNTIME" (the default runtime files).
  4352. You can put a directory before $VIMRUNTIME to find files which replace
  4353. distributed runtime files. You can put a directory after $VIMRUNTIME
  4354. to find files which add to distributed runtime files.
  4355. With |--clean| the home directory entries are not included.
  4356. *'scroll'* *'scr'*
  4357. 'scroll' 'scr' number (default half the window height)
  4358. local to window |local-noglobal|
  4359. Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
  4360. set to half the number of lines in the window when the window size
  4361. changes. This may happen when enabling the |status-line| or
  4362. 'tabline' option after setting the 'scroll' option.
  4363. If you give a count to the CTRL-U or CTRL-D command it will
  4364. be used as the new value for 'scroll'. Reset to half the window
  4365. height with ":set scroll=0".
  4366. *'scrollback'* *'scbk'*
  4367. 'scrollback' 'scbk' number (default 10000)
  4368. local to buffer
  4369. Maximum number of lines kept beyond the visible screen. Lines at the
  4370. top are deleted if new lines exceed this limit.
  4371. Minimum is 1, maximum is 100000.
  4372. Only in |terminal| buffers.
  4373. Note: Lines that are not visible and kept in scrollback are not
  4374. reflown when the terminal buffer is resized horizontally.
  4375. *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
  4376. 'scrollbind' 'scb' boolean (default off)
  4377. local to window
  4378. See also |scroll-binding|. When this option is set, scrolling the
  4379. current window also scrolls other scrollbind windows (windows that
  4380. also have this option set). This option is useful for viewing the
  4381. differences between two versions of a file, see 'diff'.
  4382. See |'scrollopt'| for options that determine how this option should be
  4383. interpreted.
  4384. This option is mostly reset when splitting a window to edit another
  4385. file. This means that ":split | edit file" results in two windows
  4386. with scroll-binding, but ":split file" does not.
  4387. *'scrolljump'* *'sj'*
  4388. 'scrolljump' 'sj' number (default 1)
  4389. global
  4390. Minimal number of lines to scroll when the cursor gets off the
  4391. screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
  4392. CTRL-D). Useful if your terminal scrolls very slowly.
  4393. When set to a negative number from -1 to -100 this is used as the
  4394. percentage of the window height. Thus -50 scrolls half the window
  4395. height.
  4396. *'scrolloff'* *'so'*
  4397. 'scrolloff' 'so' number (default 0)
  4398. global or local to window |global-local|
  4399. Minimal number of screen lines to keep above and below the cursor.
  4400. This will make some context visible around where you are working. If
  4401. you set it to a very large value (999) the cursor line will always be
  4402. in the middle of the window (except at the start or end of the file or
  4403. when long lines wrap).
  4404. After using the local value, go back the global value with one of
  4405. these two: >vim
  4406. setlocal scrolloff<
  4407. setlocal scrolloff=-1
  4408. < For scrolling horizontally see 'sidescrolloff'.
  4409. *'scrollopt'* *'sbo'*
  4410. 'scrollopt' 'sbo' string (default "ver,jump")
  4411. global
  4412. This is a comma-separated list of words that specifies how
  4413. 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
  4414. Options.
  4415. The following words are available:
  4416. ver Bind vertical scrolling for 'scrollbind' windows
  4417. hor Bind horizontal scrolling for 'scrollbind' windows
  4418. jump Applies to the offset between two windows for vertical
  4419. scrolling. This offset is the difference in the first
  4420. displayed line of the bound windows. When moving
  4421. around in a window, another 'scrollbind' window may
  4422. reach a position before the start or after the end of
  4423. the buffer. The offset is not changed though, when
  4424. moving back the 'scrollbind' window will try to scroll
  4425. to the desired position when possible.
  4426. When now making that window the current one, two
  4427. things can be done with the relative offset:
  4428. 1. When "jump" is not included, the relative offset is
  4429. adjusted for the scroll position in the new current
  4430. window. When going back to the other window, the
  4431. new relative offset will be used.
  4432. 2. When "jump" is included, the other windows are
  4433. scrolled to keep the same relative offset. When
  4434. going back to the other window, it still uses the
  4435. same relative offset.
  4436. Also see |scroll-binding|.
  4437. When 'diff' mode is active there always is vertical scroll binding,
  4438. even when "ver" isn't there.
  4439. *'sections'* *'sect'*
  4440. 'sections' 'sect' string (default "SHNHH HUnhsh")
  4441. global
  4442. Specifies the nroff macros that separate sections. These are pairs of
  4443. two letters (See |object-motions|). The default makes a section start
  4444. at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
  4445. *'selection'* *'sel'*
  4446. 'selection' 'sel' string (default "inclusive")
  4447. global
  4448. This option defines the behavior of the selection. It is only used
  4449. in Visual and Select mode.
  4450. Possible values:
  4451. value past line inclusive ~
  4452. old no yes
  4453. inclusive yes yes
  4454. exclusive yes no
  4455. "past line" means that the cursor is allowed to be positioned one
  4456. character past the line.
  4457. "inclusive" means that the last character of the selection is included
  4458. in an operation. For example, when "x" is used to delete the
  4459. selection.
  4460. When "old" is used and 'virtualedit' allows the cursor to move past
  4461. the end of line the line break still isn't included.
  4462. When "exclusive" is used, cursor position in visual mode will be
  4463. adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
  4464. Note that when "exclusive" is used and selecting from the end
  4465. backwards, you cannot include the last character of a line, when
  4466. starting in Normal mode and 'virtualedit' empty.
  4467. *'selectmode'* *'slm'*
  4468. 'selectmode' 'slm' string (default "")
  4469. global
  4470. This is a comma-separated list of words, which specifies when to start
  4471. Select mode instead of Visual mode, when a selection is started.
  4472. Possible values:
  4473. mouse when using the mouse
  4474. key when using shifted special keys
  4475. cmd when using "v", "V" or CTRL-V
  4476. See |Select-mode|.
  4477. *'sessionoptions'* *'ssop'*
  4478. 'sessionoptions' 'ssop' string (default "blank,buffers,curdir,folds,help,tabpages,winsize,terminal")
  4479. global
  4480. Changes the effect of the |:mksession| command. It is a comma-
  4481. separated list of words. Each word enables saving and restoring
  4482. something:
  4483. word save and restore ~
  4484. blank empty windows
  4485. buffers hidden and unloaded buffers, not just those in windows
  4486. curdir the current directory
  4487. folds manually created folds, opened/closed folds and local
  4488. fold options
  4489. globals global variables that start with an uppercase letter
  4490. and contain at least one lowercase letter. Only
  4491. String and Number types are stored.
  4492. help the help window
  4493. localoptions options and mappings local to a window or buffer (not
  4494. global values for local options)
  4495. options all options and mappings (also global values for local
  4496. options)
  4497. skiprtp exclude 'runtimepath' and 'packpath' from the options
  4498. resize size of the Vim window: 'lines' and 'columns'
  4499. sesdir the directory in which the session file is located
  4500. will become the current directory (useful with
  4501. projects accessed over a network from different
  4502. systems)
  4503. tabpages all tab pages; without this only the current tab page
  4504. is restored, so that you can make a session for each
  4505. tab page separately
  4506. terminal include terminal windows where the command can be
  4507. restored
  4508. winpos position of the whole Vim window
  4509. winsize window sizes
  4510. slash |deprecated| Always enabled. Uses "/" in filenames.
  4511. unix |deprecated| Always enabled. Uses "\n" line endings.
  4512. Don't include both "curdir" and "sesdir". When neither is included
  4513. filenames are stored as absolute paths.
  4514. If you leave out "options" many things won't work well after restoring
  4515. the session.
  4516. *'shada'* *'sd'* *E526* *E527* *E528*
  4517. 'shada' 'sd' string (default for
  4518. Win32: !,'100,<50,s10,h,rA:,rB:
  4519. others: !,'100,<50,s10,h)
  4520. global
  4521. When non-empty, the shada file is read upon startup and written
  4522. when exiting Vim (see |shada-file|). The string should be a comma-
  4523. separated list of parameters, each consisting of a single character
  4524. identifying the particular parameter, followed by a number or string
  4525. which specifies the value of that parameter. If a particular
  4526. character is left out, then the default value is used for that
  4527. parameter. The following is a list of the identifying characters and
  4528. the effect of their value.
  4529. CHAR VALUE ~
  4530. *shada-!*
  4531. ! When included, save and restore global variables that start
  4532. with an uppercase letter, and don't contain a lowercase
  4533. letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
  4534. and "_K_L_M" are not. Nested List and Dict items may not be
  4535. read back correctly, you end up with an empty item.
  4536. *shada-quote*
  4537. " Maximum number of lines saved for each register. Old name of
  4538. the '<' item, with the disadvantage that you need to put a
  4539. backslash before the ", otherwise it will be recognized as the
  4540. start of a comment!
  4541. *shada-%*
  4542. % When included, save and restore the buffer list. If Vim is
  4543. started with a file name argument, the buffer list is not
  4544. restored. If Vim is started without a file name argument, the
  4545. buffer list is restored from the shada file. Quickfix
  4546. ('buftype'), unlisted ('buflisted'), unnamed and buffers on
  4547. removable media (|shada-r|) are not saved.
  4548. When followed by a number, the number specifies the maximum
  4549. number of buffers that are stored. Without a number all
  4550. buffers are stored.
  4551. *shada-'*
  4552. ' Maximum number of previously edited files for which the marks
  4553. are remembered. This parameter must always be included when
  4554. 'shada' is non-empty.
  4555. Including this item also means that the |jumplist| and the
  4556. |changelist| are stored in the shada file.
  4557. *shada-/*
  4558. / Maximum number of items in the search pattern history to be
  4559. saved. If non-zero, then the previous search and substitute
  4560. patterns are also saved. When not included, the value of
  4561. 'history' is used.
  4562. *shada-:*
  4563. : Maximum number of items in the command-line history to be
  4564. saved. When not included, the value of 'history' is used.
  4565. *shada-<*
  4566. < Maximum number of lines saved for each register. If zero then
  4567. registers are not saved. When not included, all lines are
  4568. saved. '"' is the old name for this item.
  4569. Also see the 's' item below: limit specified in KiB.
  4570. *shada-@*
  4571. @ Maximum number of items in the input-line history to be
  4572. saved. When not included, the value of 'history' is used.
  4573. *shada-c*
  4574. c Dummy option, kept for compatibility reasons. Has no actual
  4575. effect: ShaDa always uses UTF-8 and 'encoding' value is fixed
  4576. to UTF-8 as well.
  4577. *shada-f*
  4578. f Whether file marks need to be stored. If zero, file marks ('0
  4579. to '9, 'A to 'Z) are not stored. When not present or when
  4580. non-zero, they are all stored. '0 is used for the current
  4581. cursor position (when exiting or when doing |:wshada|).
  4582. *shada-h*
  4583. h Disable the effect of 'hlsearch' when loading the shada
  4584. file. When not included, it depends on whether ":nohlsearch"
  4585. has been used since the last search command.
  4586. *shada-n*
  4587. n Name of the shada file. The name must immediately follow
  4588. the 'n'. Must be at the end of the option! If the
  4589. 'shadafile' option is set, that file name overrides the one
  4590. given here with 'shada'. Environment variables are
  4591. expanded when opening the file, not when setting the option.
  4592. *shada-r*
  4593. r Removable media. The argument is a string (up to the next
  4594. ','). This parameter can be given several times. Each
  4595. specifies the start of a path for which no marks will be
  4596. stored. This is to avoid removable media. For Windows you
  4597. could use "ra:,rb:". You can also use it for temp files,
  4598. e.g., for Unix: "r/tmp". Case is ignored.
  4599. *shada-s*
  4600. s Maximum size of an item contents in KiB. If zero then nothing
  4601. is saved. Unlike Vim this applies to all items, except for
  4602. the buffer list and header. Full item size is off by three
  4603. unsigned integers: with `s10` maximum item size may be 1 byte
  4604. (type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit
  4605. integer) + 3 bytes (item size: up to 16-bit integer because
  4606. 2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item
  4607. contents size) = 10253 bytes.
  4608. Example: >vim
  4609. set shada='50,<1000,s100,:0,n~/nvim/shada
  4610. <
  4611. '50 Marks will be remembered for the last 50 files you
  4612. edited.
  4613. <1000 Contents of registers (up to 1000 lines each) will be
  4614. remembered.
  4615. s100 Items with contents occupying more then 100 KiB are
  4616. skipped.
  4617. :0 Command-line history will not be saved.
  4618. n~/nvim/shada The name of the file to use is "~/nvim/shada".
  4619. no / Since '/' is not specified, the default will be used,
  4620. that is, save all of the search history, and also the
  4621. previous search and substitute patterns.
  4622. no % The buffer list will not be saved nor read back.
  4623. no h 'hlsearch' highlighting will be restored.
  4624. When setting 'shada' from an empty value you can use |:rshada| to
  4625. load the contents of the file, this is not done automatically.
  4626. This option cannot be set from a |modeline| or in the |sandbox|, for
  4627. security reasons.
  4628. *'shadafile'* *'sdf'*
  4629. 'shadafile' 'sdf' string (default "")
  4630. global
  4631. When non-empty, overrides the file name used for |shada| (viminfo).
  4632. When equal to "NONE" no shada file will be read or written.
  4633. This option can be set with the |-i| command line flag. The |--clean|
  4634. command line flag sets it to "NONE".
  4635. This option cannot be set from a |modeline| or in the |sandbox|, for
  4636. security reasons.
  4637. *'shell'* *'sh'* *E91*
  4638. 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
  4639. global
  4640. Name of the shell to use for ! and :! commands. When changing the
  4641. value also check these options: 'shellpipe', 'shellslash'
  4642. 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
  4643. It is allowed to give an argument to the command, e.g. "csh -f".
  4644. See |option-backslash| about including spaces and backslashes.
  4645. Environment variables are expanded |:set_env|.
  4646. If the name of the shell contains a space, you need to enclose it in
  4647. quotes. Example with quotes: >vim
  4648. set shell=\"c:\program\ files\unix\sh.exe\"\ -f
  4649. < Note the backslash before each quote (to avoid starting a comment) and
  4650. each space (to avoid ending the option value), so better use |:let-&|
  4651. like this: >vim
  4652. let &shell='"C:\Program Files\unix\sh.exe" -f'
  4653. < Also note that the "-f" is not inside the quotes, because it is not
  4654. part of the command name.
  4655. *shell-unquoting*
  4656. Rules regarding quotes:
  4657. 1. Option is split on space and tab characters that are not inside
  4658. quotes: "abc def" runs shell named "abc" with additional argument
  4659. "def", '"abc def"' runs shell named "abc def" with no additional
  4660. arguments (here and below: additional means “additional to
  4661. 'shellcmdflag'”).
  4662. 2. Quotes in option may be present in any position and any number:
  4663. '"abc"', '"a"bc', 'a"b"c', 'ab"c"' and '"a"b"c"' are all equivalent
  4664. to just "abc".
  4665. 3. Inside quotes backslash preceding backslash means one backslash.
  4666. Backslash preceding quote means one quote. Backslash preceding
  4667. anything else means backslash and next character literally:
  4668. '"a\\b"' is the same as "a\b", '"a\\"b"' runs shell named literally
  4669. 'a"b', '"a\b"' is the same as "a\b" again.
  4670. 4. Outside of quotes backslash always means itself, it cannot be used
  4671. to escape quote: 'a\"b"' is the same as "a\b".
  4672. Note that such processing is done after |:set| did its own round of
  4673. unescaping, so to keep yourself sane use |:let-&| like shown above.
  4674. *shell-powershell*
  4675. To use PowerShell: >vim
  4676. let &shell = executable('pwsh') ? 'pwsh' : 'powershell'
  4677. 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;'
  4678. let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode'
  4679. let &shellpipe = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode'
  4680. set shellquote= shellxquote=
  4681. < This option cannot be set from a |modeline| or in the |sandbox|, for
  4682. security reasons.
  4683. *'shellcmdflag'* *'shcf'*
  4684. 'shellcmdflag' 'shcf' string (default "-c"; Windows: "/s /c")
  4685. global
  4686. Flag passed to the shell to execute "!" and ":!" commands; e.g.,
  4687. `bash.exe -c ls` or `cmd.exe /s /c "dir"`. For MS-Windows, the
  4688. default is set according to the value of 'shell', to reduce the need
  4689. to set this option by the user.
  4690. On Unix it can have more than one flag. Each white space separated
  4691. part is passed as an argument to the shell command.
  4692. See |option-backslash| about including spaces and backslashes.
  4693. See |shell-unquoting| which talks about separating this option into
  4694. multiple arguments.
  4695. This option cannot be set from a |modeline| or in the |sandbox|, for
  4696. security reasons.
  4697. *'shellpipe'* *'sp'*
  4698. 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
  4699. global
  4700. String to be used to put the output of the ":make" command in the
  4701. error file. See also |:make_makeprg|. See |option-backslash| about
  4702. including spaces and backslashes.
  4703. The name of the temporary file can be represented by "%s" if necessary
  4704. (the file name is appended automatically if no %s appears in the value
  4705. of this option).
  4706. For MS-Windows the default is "2>&1| tee". The stdout and stderr are
  4707. saved in a file and echoed to the screen.
  4708. For Unix the default is "| tee". The stdout of the compiler is saved
  4709. in a file and echoed to the screen. If the 'shell' option is "csh" or
  4710. "tcsh" after initializations, the default becomes "|& tee". If the
  4711. 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  4712. "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
  4713. means that stderr is also included. Before using the 'shell' option a
  4714. path is removed, thus "/bin/sh" uses "sh".
  4715. The initialization of this option is done after reading the vimrc
  4716. and the other initializations, so that when the 'shell' option is set
  4717. there, the 'shellpipe' option changes automatically, unless it was
  4718. explicitly set before.
  4719. When 'shellpipe' is set to an empty string, no redirection of the
  4720. ":make" output will be done. This is useful if you use a 'makeprg'
  4721. that writes to 'makeef' by itself. If you want no piping, but do
  4722. want to include the 'makeef', set 'shellpipe' to a single space.
  4723. Don't forget to precede the space with a backslash: ":set sp=\ ".
  4724. In the future pipes may be used for filtering and this option will
  4725. become obsolete (at least for Unix).
  4726. This option cannot be set from a |modeline| or in the |sandbox|, for
  4727. security reasons.
  4728. *'shellquote'* *'shq'*
  4729. 'shellquote' 'shq' string (default ""; Windows, when 'shell'
  4730. contains "sh" somewhere: "\"")
  4731. global
  4732. Quoting character(s), put around the command passed to the shell, for
  4733. the "!" and ":!" commands. The redirection is kept outside of the
  4734. quoting. See 'shellxquote' to include the redirection. It's
  4735. probably not useful to set both options.
  4736. This is an empty string by default. Only known to be useful for
  4737. third-party shells on Windows systems, such as the MKS Korn Shell
  4738. or bash, where it should be "\"". The default is adjusted according
  4739. the value of 'shell', to reduce the need to set this option by the
  4740. user.
  4741. This option cannot be set from a |modeline| or in the |sandbox|, for
  4742. security reasons.
  4743. *'shellredir'* *'srr'*
  4744. 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
  4745. global
  4746. String to be used to put the output of a filter command in a temporary
  4747. file. See also |:!|. See |option-backslash| about including spaces
  4748. and backslashes.
  4749. The name of the temporary file can be represented by "%s" if necessary
  4750. (the file name is appended automatically if no %s appears in the value
  4751. of this option).
  4752. The default is ">". For Unix, if the 'shell' option is "csh" or
  4753. "tcsh" during initializations, the default becomes ">&". If the
  4754. 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  4755. "bash" or "fish", the default becomes ">%s 2>&1". This means that
  4756. stderr is also included. For Win32, the Unix checks are done and
  4757. additionally "cmd" is checked for, which makes the default ">%s 2>&1".
  4758. Also, the same names with ".exe" appended are checked for.
  4759. The initialization of this option is done after reading the vimrc
  4760. and the other initializations, so that when the 'shell' option is set
  4761. there, the 'shellredir' option changes automatically unless it was
  4762. explicitly set before.
  4763. In the future pipes may be used for filtering and this option will
  4764. become obsolete (at least for Unix).
  4765. This option cannot be set from a |modeline| or in the |sandbox|, for
  4766. security reasons.
  4767. *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
  4768. 'shellslash' 'ssl' boolean (default on, Windows: off)
  4769. global
  4770. only modifiable in MS-Windows
  4771. When set, a forward slash is used when expanding file names. This is
  4772. useful when a Unix-like shell is used instead of cmd.exe. Backward
  4773. slashes can still be typed, but they are changed to forward slashes by
  4774. Vim.
  4775. Note that setting or resetting this option has no effect for some
  4776. existing file names, thus this option needs to be set before opening
  4777. any file for best results. This might change in the future.
  4778. 'shellslash' only works when a backslash can be used as a path
  4779. separator. To test if this is so use: >vim
  4780. if exists('+shellslash')
  4781. < Also see 'completeslash'.
  4782. *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
  4783. 'shelltemp' 'stmp' boolean (default on)
  4784. global
  4785. When on, use temp files for shell commands. When off use a pipe.
  4786. When using a pipe is not possible temp files are used anyway.
  4787. The advantage of using a pipe is that nobody can read the temp file
  4788. and the 'shell' command does not need to support redirection.
  4789. The advantage of using a temp file is that the file type and encoding
  4790. can be detected.
  4791. The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
  4792. |FilterWritePost| autocommands event are not triggered when
  4793. 'shelltemp' is off.
  4794. |system()| does not respect this option, it always uses pipes.
  4795. *'shellxescape'* *'sxe'*
  4796. 'shellxescape' 'sxe' string (default "")
  4797. global
  4798. When 'shellxquote' is set to "(" then the characters listed in this
  4799. option will be escaped with a '^' character. This makes it possible
  4800. to execute most external commands with cmd.exe.
  4801. This option cannot be set from a |modeline| or in the |sandbox|, for
  4802. security reasons.
  4803. *'shellxquote'* *'sxq'*
  4804. 'shellxquote' 'sxq' string (default "", Windows: "\"")
  4805. global
  4806. Quoting character(s), put around the command passed to the shell, for
  4807. the "!" and ":!" commands. Includes the redirection. See
  4808. 'shellquote' to exclude the redirection. It's probably not useful
  4809. to set both options.
  4810. When the value is '(' then ')' is appended. When the value is '"('
  4811. then ')"' is appended.
  4812. When the value is '(' then also see 'shellxescape'.
  4813. This option cannot be set from a |modeline| or in the |sandbox|, for
  4814. security reasons.
  4815. *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
  4816. 'shiftround' 'sr' boolean (default off)
  4817. global
  4818. Round indent to multiple of 'shiftwidth'. Applies to > and <
  4819. commands. CTRL-T and CTRL-D in Insert mode always round the indent to
  4820. a multiple of 'shiftwidth' (this is Vi compatible).
  4821. *'shiftwidth'* *'sw'*
  4822. 'shiftwidth' 'sw' number (default 8)
  4823. local to buffer
  4824. Number of spaces to use for each step of (auto)indent. Used for
  4825. |'cindent'|, |>>|, |<<|, etc.
  4826. When zero the 'tabstop' value will be used. Use the |shiftwidth()|
  4827. function to get the effective shiftwidth value.
  4828. *'shortmess'* *'shm'* *E1336*
  4829. 'shortmess' 'shm' string (default "ltToOCF")
  4830. global
  4831. This option helps to avoid all the |hit-enter| prompts caused by file
  4832. messages, for example with CTRL-G, and to avoid some other messages.
  4833. It is a list of flags:
  4834. flag meaning when present ~
  4835. l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
  4836. m use "[+]" instead of "[Modified]" *shm-m*
  4837. r use "[RO]" instead of "[readonly]" *shm-r*
  4838. w use "[w]" instead of "written" for file write message *shm-w*
  4839. and "[a]" instead of "appended" for ':w >> file' command
  4840. a all of the above abbreviations *shm-a*
  4841. o overwrite message for writing a file with subsequent *shm-o*
  4842. message for reading a file (useful for ":wn" or when
  4843. 'autowrite' on)
  4844. O message for reading a file overwrites any previous *shm-O*
  4845. message; also for quickfix message (e.g., ":cn")
  4846. s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
  4847. "search hit TOP, continuing at BOTTOM" messages; when using
  4848. the search count do not show "W" before the count message
  4849. (see |shm-S| below)
  4850. t truncate file message at the start if it is too long *shm-t*
  4851. to fit on the command-line, "<" will appear in the left most
  4852. column; ignored in Ex mode
  4853. T truncate other messages in the middle if they are too *shm-T*
  4854. long to fit on the command line; "..." will appear in the
  4855. middle; ignored in Ex mode
  4856. W don't give "written" or "[w]" when writing a file *shm-W*
  4857. A don't give the "ATTENTION" message when an existing *shm-A*
  4858. swap file is found
  4859. I don't give the intro message when starting Vim, *shm-I*
  4860. see |:intro|
  4861. c don't give |ins-completion-menu| messages; for *shm-c*
  4862. example, "-- XXX completion (YYY)", "match 1 of 2", "The only
  4863. match", "Pattern not found", "Back at original", etc.
  4864. C don't give messages while scanning for ins-completion *shm-C*
  4865. items, for instance "scanning tags"
  4866. q do not show "recording @a" when recording a macro *shm-q*
  4867. F don't give the file info when editing a file, like *shm-F*
  4868. `:silent` was used for the command; note that this also
  4869. affects messages from 'autoread' reloading
  4870. S do not show search count message when searching, e.g. *shm-S*
  4871. "[1/5]". When the "S" flag is not present (e.g. search count
  4872. is shown), the "search hit BOTTOM, continuing at TOP" and
  4873. "search hit TOP, continuing at BOTTOM" messages are only
  4874. indicated by a "W" (Mnemonic: Wrapped) letter before the
  4875. search count statistics.
  4876. This gives you the opportunity to avoid that a change between buffers
  4877. requires you to hit <Enter>, but still gives as useful a message as
  4878. possible for the space available. To get the whole message that you
  4879. would have got with 'shm' empty, use ":file!"
  4880. Useful values:
  4881. shm= No abbreviation of message.
  4882. shm=a Abbreviation, but no loss of information.
  4883. shm=at Abbreviation, and truncate message when necessary.
  4884. *'showbreak'* *'sbr'* *E595*
  4885. 'showbreak' 'sbr' string (default "")
  4886. global or local to window |global-local|
  4887. String to put at the start of lines that have been wrapped. Useful
  4888. values are "> " or "+++ ": >vim
  4889. let &showbreak = "> "
  4890. let &showbreak = '+++ '
  4891. < Only printable single-cell characters are allowed, excluding <Tab> and
  4892. comma (in a future version the comma might be used to separate the
  4893. part that is shown at the end and at the start of a line).
  4894. The |hl-NonText| highlight group determines the highlighting.
  4895. Note that tabs after the showbreak will be displayed differently.
  4896. If you want the 'showbreak' to appear in between line numbers, add the
  4897. "n" flag to 'cpoptions'.
  4898. A window-local value overrules a global value. If the global value is
  4899. set and you want no value in the current window use NONE: >vim
  4900. setlocal showbreak=NONE
  4901. <
  4902. *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
  4903. 'showcmd' 'sc' boolean (default on)
  4904. global
  4905. Show (partial) command in the last line of the screen. Set this
  4906. option off if your terminal is slow.
  4907. In Visual mode the size of the selected area is shown:
  4908. - When selecting characters within a line, the number of characters.
  4909. If the number of bytes is different it is also displayed: "2-6"
  4910. means two characters and six bytes.
  4911. - When selecting more than one line, the number of lines.
  4912. - When selecting a block, the size in screen characters:
  4913. {lines}x{columns}.
  4914. This information can be displayed in an alternative location using the
  4915. 'showcmdloc' option, useful when 'cmdheight' is 0.
  4916. *'showcmdloc'* *'sloc'*
  4917. 'showcmdloc' 'sloc' string (default "last")
  4918. global
  4919. This option can be used to display the (partially) entered command in
  4920. another location. Possible values are:
  4921. last Last line of the screen (default).
  4922. statusline Status line of the current window.
  4923. tabline First line of the screen if 'showtabline' is enabled.
  4924. Setting this option to "statusline" or "tabline" means that these will
  4925. be redrawn whenever the command changes, which can be on every key
  4926. pressed.
  4927. The %S 'statusline' item can be used in 'statusline' or 'tabline' to
  4928. place the text. Without a custom 'statusline' or 'tabline' it will be
  4929. displayed in a convenient location.
  4930. *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
  4931. 'showfulltag' 'sft' boolean (default off)
  4932. global
  4933. When completing a word in insert mode (see |ins-completion|) from the
  4934. tags file, show both the tag name and a tidied-up form of the search
  4935. pattern (if there is one) as possible matches. Thus, if you have
  4936. matched a C function, you can see a template for what arguments are
  4937. required (coding style permitting).
  4938. Note that this doesn't work well together with having "longest" in
  4939. 'completeopt', because the completion from the search pattern may not
  4940. match the typed text.
  4941. *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
  4942. 'showmatch' 'sm' boolean (default off)
  4943. global
  4944. When a bracket is inserted, briefly jump to the matching one. The
  4945. jump is only done if the match can be seen on the screen. The time to
  4946. show the match can be set with 'matchtime'.
  4947. A Beep is given if there is no match (no matter if the match can be
  4948. seen or not).
  4949. When the 'm' flag is not included in 'cpoptions', typing a character
  4950. will immediately move the cursor back to where it belongs.
  4951. See the "sm" field in 'guicursor' for setting the cursor shape and
  4952. blinking when showing the match.
  4953. The 'matchpairs' option can be used to specify the characters to show
  4954. matches for. 'rightleft' and 'revins' are used to look for opposite
  4955. matches.
  4956. Also see the matchparen plugin for highlighting the match when moving
  4957. around |pi_paren.txt|.
  4958. Note: Use of the short form is rated PG.
  4959. *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
  4960. 'showmode' 'smd' boolean (default on)
  4961. global
  4962. If in Insert, Replace or Visual mode put a message on the last line.
  4963. The |hl-ModeMsg| highlight group determines the highlighting.
  4964. The option has no effect when 'cmdheight' is zero.
  4965. *'showtabline'* *'stal'*
  4966. 'showtabline' 'stal' number (default 1)
  4967. global
  4968. The value of this option specifies when the line with tab page labels
  4969. will be displayed:
  4970. 0: never
  4971. 1: only if there are at least two tab pages
  4972. 2: always
  4973. This is both for the GUI and non-GUI implementation of the tab pages
  4974. line.
  4975. See |tab-page| for more information about tab pages.
  4976. *'sidescroll'* *'ss'*
  4977. 'sidescroll' 'ss' number (default 1)
  4978. global
  4979. The minimal number of columns to scroll horizontally. Used only when
  4980. the 'wrap' option is off and the cursor is moved off of the screen.
  4981. When it is zero the cursor will be put in the middle of the screen.
  4982. When using a slow terminal set it to a large number or 0. Not used
  4983. for "zh" and "zl" commands.
  4984. *'sidescrolloff'* *'siso'*
  4985. 'sidescrolloff' 'siso' number (default 0)
  4986. global or local to window |global-local|
  4987. The minimal number of screen columns to keep to the left and to the
  4988. right of the cursor if 'nowrap' is set. Setting this option to a
  4989. value greater than 0 while having |'sidescroll'| also at a non-zero
  4990. value makes some context visible in the line you are scrolling in
  4991. horizontally (except at beginning of the line). Setting this option
  4992. to a large value (like 999) has the effect of keeping the cursor
  4993. horizontally centered in the window, as long as one does not come too
  4994. close to the beginning of the line.
  4995. After using the local value, go back the global value with one of
  4996. these two: >vim
  4997. setlocal sidescrolloff<
  4998. setlocal sidescrolloff=-1
  4999. <
  5000. Example: Try this together with 'sidescroll' and 'listchars' as
  5001. in the following example to never allow the cursor to move
  5002. onto the "extends" character: >vim
  5003. set nowrap sidescroll=1 listchars=extends:>,precedes:<
  5004. set sidescrolloff=1
  5005. <
  5006. *'signcolumn'* *'scl'*
  5007. 'signcolumn' 'scl' string (default "auto")
  5008. local to window
  5009. When and how to draw the signcolumn. Valid values are:
  5010. "auto" only when there is a sign to display
  5011. "auto:[1-9]" resize to accommodate multiple signs up to the
  5012. given number (maximum 9), e.g. "auto:4"
  5013. "auto:[1-8]-[2-9]"
  5014. resize to accommodate multiple signs up to the
  5015. given maximum number (maximum 9) while keeping
  5016. at least the given minimum (maximum 8) fixed
  5017. space. The minimum number should always be less
  5018. than the maximum number, e.g. "auto:2-5"
  5019. "no" never
  5020. "yes" always
  5021. "yes:[1-9]" always, with fixed space for signs up to the given
  5022. number (maximum 9), e.g. "yes:3"
  5023. "number" display signs in the 'number' column. If the number
  5024. column is not present, then behaves like "auto".
  5025. *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
  5026. 'smartcase' 'scs' boolean (default off)
  5027. global
  5028. Override the 'ignorecase' option if the search pattern contains upper
  5029. case characters. Only used when the search pattern is typed and
  5030. 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
  5031. ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
  5032. "*" and "#" you can make 'smartcase' used by doing a "/" command,
  5033. recalling the search pattern from history and hitting <Enter>.
  5034. *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
  5035. 'smartindent' 'si' boolean (default off)
  5036. local to buffer
  5037. Do smart autoindenting when starting a new line. Works for C-like
  5038. programs, but can also be used for other languages. 'cindent' does
  5039. something like this, works better in most cases, but is more strict,
  5040. see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
  5041. setting 'si' has no effect. 'indentexpr' is a more advanced
  5042. alternative.
  5043. Normally 'autoindent' should also be on when using 'smartindent'.
  5044. An indent is automatically inserted:
  5045. - After a line ending in "{".
  5046. - After a line starting with a keyword from 'cinwords'.
  5047. - Before a line starting with "}" (only with the "O" command).
  5048. When typing '}' as the first character in a new line, that line is
  5049. given the same indent as the matching "{".
  5050. When typing '#' as the first character in a new line, the indent for
  5051. that line is removed, the '#' is put in the first column. The indent
  5052. is restored for the next line. If you don't want this, use this
  5053. mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
  5054. When using the ">>" command, lines starting with '#' are not shifted
  5055. right.
  5056. *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
  5057. 'smarttab' 'sta' boolean (default on)
  5058. global
  5059. When on, a <Tab> in front of a line inserts blanks according to
  5060. 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
  5061. <BS> will delete a 'shiftwidth' worth of space at the start of the
  5062. line.
  5063. When off, a <Tab> always inserts blanks according to 'tabstop' or
  5064. 'softtabstop'. 'shiftwidth' is only used for shifting text left or
  5065. right |shift-left-right|.
  5066. What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
  5067. option. Also see |ins-expandtab|. When 'expandtab' is not set, the
  5068. number of spaces is minimized by using <Tab>s.
  5069. *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
  5070. 'smoothscroll' 'sms' boolean (default off)
  5071. local to window
  5072. Scrolling works with screen lines. When 'wrap' is set and the first
  5073. line in the window wraps part of it may not be visible, as if it is
  5074. above the window. "<<<" is displayed at the start of the first line,
  5075. highlighted with |hl-NonText|.
  5076. You may also want to add "lastline" to the 'display' option to show as
  5077. much of the last line as possible.
  5078. NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
  5079. *'softtabstop'* *'sts'*
  5080. 'softtabstop' 'sts' number (default 0)
  5081. local to buffer
  5082. Number of spaces that a <Tab> counts for while performing editing
  5083. operations, like inserting a <Tab> or using <BS>. It "feels" like
  5084. <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
  5085. used. This is useful to keep the 'ts' setting at its standard value
  5086. of 8, while being able to edit like it is set to 'sts'. However,
  5087. commands like "x" still work on the actual characters.
  5088. When 'sts' is zero, this feature is off.
  5089. When 'sts' is negative, the value of 'shiftwidth' is used.
  5090. See also |ins-expandtab|. When 'expandtab' is not set, the number of
  5091. spaces is minimized by using <Tab>s.
  5092. The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
  5093. set.
  5094. The value of 'softtabstop' will be ignored if |'varsofttabstop'| is set
  5095. to anything other than an empty string.
  5096. *'spell'* *'nospell'*
  5097. 'spell' boolean (default off)
  5098. local to window
  5099. When on spell checking will be done. See |spell|.
  5100. The languages are specified with 'spelllang'.
  5101. *'spellcapcheck'* *'spc'*
  5102. 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'"\t ]\+")
  5103. local to buffer
  5104. Pattern to locate the end of a sentence. The following word will be
  5105. checked to start with a capital letter. If not then it is highlighted
  5106. with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
  5107. When this check is not wanted make this option empty.
  5108. Only used when 'spell' is set.
  5109. Be careful with special characters, see |option-backslash| about
  5110. including spaces and backslashes.
  5111. To set this option automatically depending on the language, see
  5112. |set-spc-auto|.
  5113. *'spellfile'* *'spf'*
  5114. 'spellfile' 'spf' string (default "")
  5115. local to buffer
  5116. Name of the word list file where words are added for the |zg| and |zw|
  5117. commands. It must end in ".{encoding}.add". You need to include the
  5118. path, otherwise the file is placed in the current directory.
  5119. The path may include characters from 'isfname', ' ', ',', '@' and ':'.
  5120. *E765*
  5121. It may also be a comma-separated list of names. A count before the
  5122. |zg| and |zw| commands can be used to access each. This allows using
  5123. a personal word list file and a project word list file.
  5124. When a word is added while this option is empty Vim will set it for
  5125. you: Using the first directory in 'runtimepath' that is writable. If
  5126. there is no "spell" directory yet it will be created. For the file
  5127. name the first language name that appears in 'spelllang' is used,
  5128. ignoring the region.
  5129. The resulting ".spl" file will be used for spell checking, it does not
  5130. have to appear in 'spelllang'.
  5131. Normally one file is used for all regions, but you can add the region
  5132. name if you want to. However, it will then only be used when
  5133. 'spellfile' is set to it, for entries in 'spelllang' only files
  5134. without region name will be found.
  5135. This option cannot be set from a |modeline| or in the |sandbox|, for
  5136. security reasons.
  5137. *'spelllang'* *'spl'*
  5138. 'spelllang' 'spl' string (default "en")
  5139. local to buffer
  5140. A comma-separated list of word list names. When the 'spell' option is
  5141. on spellchecking will be done for these languages. Example: >vim
  5142. set spelllang=en_us,nl,medical
  5143. < This means US English, Dutch and medical words are recognized. Words
  5144. that are not recognized will be highlighted.
  5145. The word list name must consist of alphanumeric characters, a dash or
  5146. an underscore. It should not include a comma or dot. Using a dash is
  5147. recommended to separate the two letter language name from a
  5148. specification. Thus "en-rare" is used for rare English words.
  5149. A region name must come last and have the form "_xx", where "xx" is
  5150. the two-letter, lower case region name. You can use more than one
  5151. region by listing them: "en_us,en_ca" supports both US and Canadian
  5152. English, but not words specific for Australia, New Zealand or Great
  5153. Britain. (Note: currently en_au and en_nz dictionaries are older than
  5154. en_ca, en_gb and en_us).
  5155. If the name "cjk" is included East Asian characters are excluded from
  5156. spell checking. This is useful when editing text that also has Asian
  5157. words.
  5158. Note that the "medical" dictionary does not exist, it is just an
  5159. example of a longer name.
  5160. *E757*
  5161. As a special case the name of a .spl file can be given as-is. The
  5162. first "_xx" in the name is removed and used as the region name
  5163. (_xx is an underscore, two letters and followed by a non-letter).
  5164. This is mainly for testing purposes. You must make sure the correct
  5165. encoding is used, Vim doesn't check it.
  5166. How the related spell files are found is explained here: |spell-load|.
  5167. If the |spellfile.vim| plugin is active and you use a language name
  5168. for which Vim cannot find the .spl file in 'runtimepath' the plugin
  5169. will ask you if you want to download the file.
  5170. After this option has been set successfully, Vim will source the files
  5171. "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
  5172. up to the first character that is not an ASCII letter or number and
  5173. not a dash. Also see |set-spc-auto|.
  5174. *'spelloptions'* *'spo'*
  5175. 'spelloptions' 'spo' string (default "")
  5176. local to buffer
  5177. A comma-separated list of options for spell checking:
  5178. camel When a word is CamelCased, assume "Cased" is a
  5179. separate word: every upper-case character in a word
  5180. that comes after a lower case character indicates the
  5181. start of a new word.
  5182. noplainbuffer Only spellcheck a buffer when 'syntax' is enabled,
  5183. or when extmarks are set within the buffer. Only
  5184. designated regions of the buffer are spellchecked in
  5185. this case.
  5186. *'spellsuggest'* *'sps'*
  5187. 'spellsuggest' 'sps' string (default "best")
  5188. global
  5189. Methods used for spelling suggestions. Both for the |z=| command and
  5190. the |spellsuggest()| function. This is a comma-separated list of
  5191. items:
  5192. best Internal method that works best for English. Finds
  5193. changes like "fast" and uses a bit of sound-a-like
  5194. scoring to improve the ordering.
  5195. double Internal method that uses two methods and mixes the
  5196. results. The first method is "fast", the other method
  5197. computes how much the suggestion sounds like the bad
  5198. word. That only works when the language specifies
  5199. sound folding. Can be slow and doesn't always give
  5200. better results.
  5201. fast Internal method that only checks for simple changes:
  5202. character inserts/deletes/swaps. Works well for
  5203. simple typing mistakes.
  5204. {number} The maximum number of suggestions listed for |z=|.
  5205. Not used for |spellsuggest()|. The number of
  5206. suggestions is never more than the value of 'lines'
  5207. minus two.
  5208. timeout:{millisec} Limit the time searching for suggestions to
  5209. {millisec} milliseconds. Applies to the following
  5210. methods. When omitted the limit is 5000. When
  5211. negative there is no limit.
  5212. file:{filename} Read file {filename}, which must have two columns,
  5213. separated by a slash. The first column contains the
  5214. bad word, the second column the suggested good word.
  5215. Example:
  5216. theribal/terrible ~
  5217. Use this for common mistakes that do not appear at the
  5218. top of the suggestion list with the internal methods.
  5219. Lines without a slash are ignored, use this for
  5220. comments.
  5221. The word in the second column must be correct,
  5222. otherwise it will not be used. Add the word to an
  5223. ".add" file if it is currently flagged as a spelling
  5224. mistake.
  5225. The file is used for all languages.
  5226. expr:{expr} Evaluate expression {expr}. Use a function to avoid
  5227. trouble with spaces. Best is to call a function
  5228. without arguments, see |expr-option-function|.
  5229. |v:val| holds the badly spelled word. The expression
  5230. must evaluate to a List of Lists, each with a
  5231. suggestion and a score.
  5232. Example:
  5233. [['the', 33], ['that', 44]] ~
  5234. Set 'verbose' and use |z=| to see the scores that the
  5235. internal methods use. A lower score is better.
  5236. This may invoke |spellsuggest()| if you temporarily
  5237. set 'spellsuggest' to exclude the "expr:" part.
  5238. Errors are silently ignored, unless you set the
  5239. 'verbose' option to a non-zero value.
  5240. Only one of "best", "double" or "fast" may be used. The others may
  5241. appear several times in any order. Example: >vim
  5242. set sps=file:~/.config/nvim/sugg,best,expr:MySuggest()
  5243. <
  5244. This option cannot be set from a |modeline| or in the |sandbox|, for
  5245. security reasons.
  5246. *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
  5247. 'splitbelow' 'sb' boolean (default off)
  5248. global
  5249. When on, splitting a window will put the new window below the current
  5250. one. |:split|
  5251. *'splitkeep'* *'spk'*
  5252. 'splitkeep' 'spk' string (default "cursor")
  5253. global
  5254. The value of this option determines the scroll behavior when opening,
  5255. closing or resizing horizontal splits.
  5256. Possible values are:
  5257. cursor Keep the same relative cursor position.
  5258. screen Keep the text on the same screen line.
  5259. topline Keep the topline the same.
  5260. For the "screen" and "topline" values, the cursor position will be
  5261. changed when necessary. In this case, the jumplist will be populated
  5262. with the previous cursor position. For "screen", the text cannot always
  5263. be kept on the same screen line when 'wrap' is enabled.
  5264. *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
  5265. 'splitright' 'spr' boolean (default off)
  5266. global
  5267. When on, splitting a window will put the new window right of the
  5268. current one. |:vsplit|
  5269. *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
  5270. 'startofline' 'sol' boolean (default off)
  5271. global
  5272. When "on" the commands listed below move the cursor to the first
  5273. non-blank of the line. When off the cursor is kept in the same column
  5274. (if possible). This applies to the commands:
  5275. - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
  5276. - "d", "<<", "==" and ">>" with a linewise operator
  5277. (|operator-resulting-pos|)
  5278. - "%" with a count
  5279. - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
  5280. - Ex commands that only have a line number, e.g., ":25" or ":+".
  5281. In case of buffer changing commands the cursor is placed at the column
  5282. where it was the last time the buffer was edited.
  5283. *'statuscolumn'* *'stc'*
  5284. 'statuscolumn' 'stc' string (default "")
  5285. local to window
  5286. When non-empty, this option determines the content of the area to the
  5287. side of a window, normally containing the fold, sign and number columns.
  5288. The format of this option is like that of 'statusline'.
  5289. Some of the items from the 'statusline' format are different for
  5290. 'statuscolumn':
  5291. %l line number column for currently drawn line
  5292. %s sign column for currently drawn line
  5293. %C fold column for currently drawn line
  5294. The 'statuscolumn' width follows that of the default columns and
  5295. adapts to the |'numberwidth'|, |'signcolumn'| and |'foldcolumn'| option
  5296. values (regardless of whether the sign and fold items are present).
  5297. Additionally, the 'statuscolumn' grows with the size of the evaluated
  5298. format string, up to a point (following the maximum size of the default
  5299. fold, sign and number columns). Shrinking only happens when the number
  5300. of lines in a buffer changes, or the 'statuscolumn' option is set.
  5301. The |v:lnum| variable holds the line number to be drawn.
  5302. The |v:relnum| variable holds the relative line number to be drawn.
  5303. The |v:virtnum| variable is negative when drawing virtual lines, zero
  5304. when drawing the actual buffer line, and positive when
  5305. drawing the wrapped part of a buffer line.
  5306. When using |v:relnum|, keep in mind that cursor movement by itself will
  5307. not cause the 'statuscolumn' to update unless |'relativenumber'| is set.
  5308. NOTE: The %@ click execute function item is supported as well but the
  5309. specified function will be the same for each row in the same column.
  5310. It cannot be switched out through a dynamic 'statuscolumn' format, the
  5311. handler should be written with this in mind.
  5312. Examples: >vim
  5313. " Line number with bar separator and click handlers:
  5314. set statuscolumn=%@SignCb@%s%=%T%@NumCb@%l│%T
  5315. " Line numbers in hexadecimal for non wrapped part of lines:
  5316. let &stc='%=%{v:virtnum>0?"":printf("%x",v:lnum)} '
  5317. " Human readable line numbers with thousands separator:
  5318. let &stc='%{substitute(v:lnum,"\\d\\zs\\ze\\'
  5319. . '%(\\d\\d\\d\\)\\+$",",","g")}'
  5320. " Both relative and absolute line numbers with different
  5321. " highlighting for odd and even relative numbers:
  5322. let &stc='%#NonText#%{&nu?v:lnum:""}' .
  5323. '%=%{&rnu&&(v:lnum%2)?"\ ".v:relnum:""}' .
  5324. '%#LineNr#%{&rnu&&!(v:lnum%2)?"\ ".v:relnum:""}'
  5325. < WARNING: this expression is evaluated for each screen line so defining
  5326. an expensive expression can negatively affect render performance.
  5327. *'statusline'* *'stl'* *E540* *E542*
  5328. 'statusline' 'stl' string (default "")
  5329. global or local to window |global-local|
  5330. When non-empty, this option determines the content of the status line.
  5331. Also see |status-line|.
  5332. The option consists of printf style '%' items interspersed with
  5333. normal text. Each status line item is of the form:
  5334. %-0{minwid}.{maxwid}{item}
  5335. All fields except the {item} are optional. A single percent sign can
  5336. be given as "%%".
  5337. *stl-%!*
  5338. When the option starts with "%!" then it is used as an expression,
  5339. evaluated and the result is used as the option value. Example: >vim
  5340. set statusline=%!MyStatusLine()
  5341. < The *g:statusline_winid* variable will be set to the |window-ID| of the
  5342. window that the status line belongs to.
  5343. The result can contain %{} items that will be evaluated too.
  5344. Note that the "%!" expression is evaluated in the context of the
  5345. current window and buffer, while %{} items are evaluated in the
  5346. context of the window that the statusline belongs to.
  5347. When there is error while evaluating the option then it will be made
  5348. empty to avoid further errors. Otherwise screen updating would loop.
  5349. When the result contains unprintable characters the result is
  5350. unpredictable.
  5351. Note that the only effect of 'ruler' when this option is set (and
  5352. 'laststatus' is 2 or 3) is controlling the output of |CTRL-G|.
  5353. field meaning ~
  5354. - Left justify the item. The default is right justified
  5355. when minwid is larger than the length of the item.
  5356. 0 Leading zeroes in numeric items. Overridden by "-".
  5357. minwid Minimum width of the item, padding as set by "-" & "0".
  5358. Value must be 50 or less.
  5359. maxwid Maximum width of the item. Truncation occurs with a "<"
  5360. on the left for text items. Numeric items will be
  5361. shifted down to maxwid-2 digits followed by ">"number
  5362. where number is the amount of missing digits, much like
  5363. an exponential notation.
  5364. item A one letter code as described below.
  5365. Following is a description of the possible statusline items. The
  5366. second character in "item" is the type:
  5367. N for number
  5368. S for string
  5369. F for flags as described below
  5370. - not applicable
  5371. item meaning ~
  5372. f S Path to the file in the buffer, as typed or relative to current
  5373. directory.
  5374. F S Full path to the file in the buffer.
  5375. t S File name (tail) of file in the buffer.
  5376. m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
  5377. M F Modified flag, text is ",+" or ",-".
  5378. r F Readonly flag, text is "[RO]".
  5379. R F Readonly flag, text is ",RO".
  5380. h F Help buffer flag, text is "[help]".
  5381. H F Help buffer flag, text is ",HLP".
  5382. w F Preview window flag, text is "[Preview]".
  5383. W F Preview window flag, text is ",PRV".
  5384. y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
  5385. Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
  5386. q S "[Quickfix List]", "[Location List]" or empty.
  5387. k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
  5388. being used: "<keymap>"
  5389. n N Buffer number.
  5390. b N Value of character under cursor.
  5391. B N As above, in hexadecimal.
  5392. o N Byte number in file of byte under cursor, first byte is 1.
  5393. Mnemonic: Offset from start of file (with one added)
  5394. O N As above, in hexadecimal.
  5395. l N Line number.
  5396. L N Number of lines in buffer.
  5397. c N Column number (byte index).
  5398. v N Virtual column number (screen column).
  5399. V N Virtual column number as -{num}. Not displayed if equal to 'c'.
  5400. p N Percentage through file in lines as in |CTRL-G|.
  5401. P S Percentage through file of displayed window. This is like the
  5402. percentage described for 'ruler'. Always 3 in length, unless
  5403. translated.
  5404. S S 'showcmd' content, see 'showcmdloc'.
  5405. a S Argument list status as in default title. ({current} of {max})
  5406. Empty if the argument file count is zero or one.
  5407. { NF Evaluate expression between "%{" and "}" and substitute result.
  5408. Note that there is no "%" before the closing "}". The
  5409. expression cannot contain a "}" character, call a function to
  5410. work around that. See |stl-%{| below.
  5411. `{%` - This is almost same as "{" except the result of the expression is
  5412. re-evaluated as a statusline format string. Thus if the
  5413. return value of expr contains "%" items they will get expanded.
  5414. The expression can contain the "}" character, the end of
  5415. expression is denoted by "%}".
  5416. For example: >vim
  5417. func! Stl_filename() abort
  5418. return "%t"
  5419. endfunc
  5420. < `stl=%{Stl_filename()}` results in `"%t"`
  5421. `stl=%{%Stl_filename()%}` results in `"Name of current file"`
  5422. %} - End of "{%" expression
  5423. ( - Start of item group. Can be used for setting the width and
  5424. alignment of a section. Must be followed by %) somewhere.
  5425. ) - End of item group. No width fields allowed.
  5426. T N For 'tabline': start of tab page N label. Use %T or %X to end
  5427. the label. Clicking this label with left mouse button switches
  5428. to the specified tab page, while clicking it with middle mouse
  5429. button closes the specified tab page.
  5430. X N For 'tabline': start of close tab N label. Use %X or %T to end
  5431. the label, e.g.: %3Xclose%X. Use %999X for a "close current
  5432. tab" label. Clicking this label with left mouse button closes
  5433. the specified tab page.
  5434. @ N Start of execute function label. Use %X or %T to end the label,
  5435. e.g.: %10@SwitchBuffer@foo.c%X. Clicking this label runs the
  5436. specified function: in the example when clicking once using left
  5437. mouse button on "foo.c", a `SwitchBuffer(10, 1, 'l', ' ')`
  5438. expression will be run. The specified function receives the
  5439. following arguments in order:
  5440. 1. minwid field value or zero if no N was specified
  5441. 2. number of mouse clicks to detect multiple clicks
  5442. 3. mouse button used: "l", "r" or "m" for left, right or middle
  5443. button respectively; one should not rely on third argument
  5444. being only "l", "r" or "m": any other non-empty string value
  5445. that contains only ASCII lower case letters may be expected
  5446. for other mouse buttons
  5447. 4. modifiers pressed: string which contains "s" if shift
  5448. modifier was pressed, "c" for control, "a" for alt and "m"
  5449. for meta; currently if modifier is not pressed string
  5450. contains space instead, but one should not rely on presence
  5451. of spaces or specific order of modifiers: use |stridx()| to
  5452. test whether some modifier is present; string is guaranteed
  5453. to contain only ASCII letters and spaces, one letter per
  5454. modifier; "?" modifier may also be present, but its presence
  5455. is a bug that denotes that new mouse button recognition was
  5456. added without modifying code that reacts on mouse clicks on
  5457. this label.
  5458. Use |getmousepos()|.winid in the specified function to get the
  5459. corresponding window id of the clicked item.
  5460. < - Where to truncate line if too long. Default is at the start.
  5461. No width fields allowed.
  5462. = - Separation point between alignment sections. Each section will
  5463. be separated by an equal number of spaces. With one %= what
  5464. comes after it will be right-aligned. With two %= there is a
  5465. middle part, with white space left and right of it.
  5466. No width fields allowed.
  5467. # - Set highlight group. The name must follow and then a # again.
  5468. Thus use %#HLname# for highlight group HLname. The same
  5469. highlighting is used, also for the statusline of non-current
  5470. windows.
  5471. * - Set highlight group to User{N}, where {N} is taken from the
  5472. minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
  5473. The difference between User{N} and StatusLine will be applied to
  5474. StatusLineNC for the statusline of non-current windows.
  5475. The number N must be between 1 and 9. See |hl-User1..9|
  5476. When displaying a flag, Vim removes the leading comma, if any, when
  5477. that flag comes right after plaintext. This will make a nice display
  5478. when flags are used like in the examples below.
  5479. When all items in a group becomes an empty string (i.e. flags that are
  5480. not set) and a minwid is not set for the group, the whole group will
  5481. become empty. This will make a group like the following disappear
  5482. completely from the statusline when none of the flags are set. >vim
  5483. set statusline=...%(\ [%M%R%H]%)...
  5484. < Beware that an expression is evaluated each and every time the status
  5485. line is displayed.
  5486. *stl-%{* *g:actual_curbuf* *g:actual_curwin*
  5487. While evaluating %{} the current buffer and current window will be set
  5488. temporarily to that of the window (and buffer) whose statusline is
  5489. currently being drawn. The expression will evaluate in this context.
  5490. The variable "g:actual_curbuf" is set to the `bufnr()` number of the
  5491. real current buffer and "g:actual_curwin" to the |window-ID| of the
  5492. real current window. These values are strings.
  5493. The 'statusline' option will be evaluated in the |sandbox| if set from
  5494. a modeline, see |sandbox-option|.
  5495. This option cannot be set in a modeline when 'modelineexpr' is off.
  5496. It is not allowed to change text or jump to another window while
  5497. evaluating 'statusline' |textlock|.
  5498. If the statusline is not updated when you want it (e.g., after setting
  5499. a variable that's used in an expression), you can force an update by
  5500. using `:redrawstatus`.
  5501. A result of all digits is regarded a number for display purposes.
  5502. Otherwise the result is taken as flag text and applied to the rules
  5503. described above.
  5504. Watch out for errors in expressions. They may render Vim unusable!
  5505. If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
  5506. edit your vimrc or whatever with "vim --clean" to get it right.
  5507. Examples:
  5508. Emulate standard status line with 'ruler' set >vim
  5509. set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
  5510. < Similar, but add ASCII value of char under the cursor (like "ga") >vim
  5511. set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
  5512. < Display byte count and byte value, modified flag in red. >vim
  5513. set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
  5514. hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
  5515. < Display a ,GZ flag if a compressed file is loaded >vim
  5516. set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
  5517. < In the |:autocmd|'s: >vim
  5518. let b:gzflag = 1
  5519. < And: >vim
  5520. unlet b:gzflag
  5521. < And define this function: >vim
  5522. function VarExists(var, val)
  5523. if exists(a:var) | return a:val | else | return '' | endif
  5524. endfunction
  5525. <
  5526. *'suffixes'* *'su'*
  5527. 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
  5528. global
  5529. Files with these suffixes get a lower priority when multiple files
  5530. match a wildcard. See |suffixes|. Commas can be used to separate the
  5531. suffixes. Spaces after the comma are ignored. A dot is also seen as
  5532. the start of a suffix. To avoid a dot or comma being recognized as a
  5533. separator, precede it with a backslash (see |option-backslash| about
  5534. including spaces and backslashes).
  5535. See 'wildignore' for completely ignoring files.
  5536. The use of |:set+=| and |:set-=| is preferred when adding or removing
  5537. suffixes from the list. This avoids problems when a future version
  5538. uses another default.
  5539. *'suffixesadd'* *'sua'*
  5540. 'suffixesadd' 'sua' string (default "")
  5541. local to buffer
  5542. Comma-separated list of suffixes, which are used when searching for a
  5543. file for the "gf", "[I", etc. commands. Example: >vim
  5544. set suffixesadd=.java
  5545. <
  5546. *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
  5547. 'swapfile' 'swf' boolean (default on)
  5548. local to buffer
  5549. Use a swapfile for the buffer. This option can be reset when a
  5550. swapfile is not wanted for a specific buffer. For example, with
  5551. confidential information that even root must not be able to access.
  5552. Careful: All text will be in memory:
  5553. - Don't use this for big files.
  5554. - Recovery will be impossible!
  5555. A swapfile will only be present when |'updatecount'| is non-zero and
  5556. 'swapfile' is set.
  5557. When 'swapfile' is reset, the swap file for the current buffer is
  5558. immediately deleted. When 'swapfile' is set, and 'updatecount' is
  5559. non-zero, a swap file is immediately created.
  5560. Also see |swap-file|.
  5561. If you want to open a new buffer without creating a swap file for it,
  5562. use the |:noswapfile| modifier.
  5563. See 'directory' for where the swap file is created.
  5564. This option is used together with 'bufhidden' and 'buftype' to
  5565. specify special kinds of buffers. See |special-buffers|.
  5566. *'switchbuf'* *'swb'*
  5567. 'switchbuf' 'swb' string (default "uselast")
  5568. global
  5569. This option controls the behavior when switching between buffers.
  5570. This option is checked, when
  5571. - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
  5572. etc.).
  5573. - jumping to a tag using the |:stag| command.
  5574. - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
  5575. - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
  5576. |:sbnext|, or |:sbrewind|).
  5577. Possible values (comma-separated list):
  5578. useopen If included, jump to the first open window in the
  5579. current tab page that contains the specified buffer
  5580. (if there is one). Otherwise: Do not examine other
  5581. windows.
  5582. usetab Like "useopen", but also consider windows in other tab
  5583. pages.
  5584. split If included, split the current window before loading
  5585. a buffer for a |quickfix| command that display errors.
  5586. Otherwise: do not split, use current window (when used
  5587. in the quickfix window: the previously used window or
  5588. split if there is no other window).
  5589. vsplit Just like "split" but split vertically.
  5590. newtab Like "split", but open a new tab page. Overrules
  5591. "split" when both are present.
  5592. uselast If included, jump to the previously used window when
  5593. jumping to errors with |quickfix| commands.
  5594. If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
  5595. applied to the split window.
  5596. *'synmaxcol'* *'smc'*
  5597. 'synmaxcol' 'smc' number (default 3000)
  5598. local to buffer
  5599. Maximum column in which to search for syntax items. In long lines the
  5600. text after this column is not highlighted and following lines may not
  5601. be highlighted correctly, because the syntax state is cleared.
  5602. This helps to avoid very slow redrawing for an XML file that is one
  5603. long line.
  5604. Set to zero to remove the limit.
  5605. *'syntax'* *'syn'*
  5606. 'syntax' 'syn' string (default "")
  5607. local to buffer |local-noglobal|
  5608. When this option is set, the syntax with this name is loaded, unless
  5609. syntax highlighting has been switched off with ":syntax off".
  5610. Otherwise this option does not always reflect the current syntax (the
  5611. b:current_syntax variable does).
  5612. This option is most useful in a modeline, for a file which syntax is
  5613. not automatically recognized. Example, in an IDL file: >c
  5614. /* vim: set syntax=idl : */
  5615. < When a dot appears in the value then this separates two filetype
  5616. names. Example: >c
  5617. /* vim: set syntax=c.doxygen : */
  5618. < This will use the "c" syntax first, then the "doxygen" syntax.
  5619. Note that the second one must be prepared to be loaded as an addition,
  5620. otherwise it will be skipped. More than one dot may appear.
  5621. To switch off syntax highlighting for the current file, use: >vim
  5622. set syntax=OFF
  5623. < To switch syntax highlighting on according to the current value of the
  5624. 'filetype' option: >vim
  5625. set syntax=ON
  5626. < What actually happens when setting the 'syntax' option is that the
  5627. Syntax autocommand event is triggered with the value as argument.
  5628. This option is not copied to another buffer, independent of the 's' or
  5629. 'S' flag in 'cpoptions'.
  5630. Only alphanumeric characters, '.', '-' and '_' can be used.
  5631. *'tabclose'* *'tcl'*
  5632. 'tabclose' 'tcl' string (default "")
  5633. global
  5634. This option controls the behavior when closing tab pages (e.g., using
  5635. |:tabclose|). When empty Vim goes to the next (right) tab page.
  5636. Possible values (comma-separated list):
  5637. left If included, go to the previous tab page instead of
  5638. the next one.
  5639. uselast If included, go to the previously used tab page if
  5640. possible. This option takes precedence over the
  5641. others.
  5642. *'tabline'* *'tal'*
  5643. 'tabline' 'tal' string (default "")
  5644. global
  5645. When non-empty, this option determines the content of the tab pages
  5646. line at the top of the Vim window. When empty Vim will use a default
  5647. tab pages line. See |setting-tabline| for more info.
  5648. The tab pages line only appears as specified with the 'showtabline'
  5649. option and only when there is no GUI tab line. When 'e' is in
  5650. 'guioptions' and the GUI supports a tab line 'guitablabel' is used
  5651. instead. Note that the two tab pages lines are very different.
  5652. The value is evaluated like with 'statusline'. You can use
  5653. |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
  5654. the text to be displayed. Use "%1T" for the first label, "%2T" for
  5655. the second one, etc. Use "%X" items for closing labels.
  5656. When changing something that is used in 'tabline' that does not
  5657. trigger it to be updated, use |:redrawtabline|.
  5658. This option cannot be set in a modeline when 'modelineexpr' is off.
  5659. Keep in mind that only one of the tab pages is the current one, others
  5660. are invisible and you can't jump to their windows.
  5661. *'tabpagemax'* *'tpm'*
  5662. 'tabpagemax' 'tpm' number (default 50)
  5663. global
  5664. Maximum number of tab pages to be opened by the |-p| command line
  5665. argument or the ":tab all" command. |tabpage|
  5666. *'tabstop'* *'ts'*
  5667. 'tabstop' 'ts' number (default 8)
  5668. local to buffer
  5669. Number of spaces that a <Tab> in the file counts for. Also see
  5670. the |:retab| command, and the 'softtabstop' option.
  5671. Note: Setting 'tabstop' to any other value than 8 can make your file
  5672. appear wrong in many places.
  5673. The value must be more than 0 and less than 10000.
  5674. There are five main ways to use tabs in Vim:
  5675. 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
  5676. (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
  5677. will use a mix of tabs and spaces, but typing <Tab> and <BS> will
  5678. behave like a tab appears every 4 (or 3) characters.
  5679. This is the recommended way, the file will look the same with other
  5680. tools and when listing it in a terminal.
  5681. 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
  5682. 'expandtab'. This way you will always insert spaces. The
  5683. formatting will never be messed up when 'tabstop' is changed (leave
  5684. it at 8 just in case). The file will be a bit larger.
  5685. You do need to check if no Tabs exist in the file. You can get rid
  5686. of them by first setting 'expandtab' and using `%retab!`, making
  5687. sure the value of 'tabstop' is set correctly.
  5688. 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
  5689. 'expandtab'. This way you will always insert spaces. The
  5690. formatting will never be messed up when 'tabstop' is changed.
  5691. You do need to check if no Tabs exist in the file, just like in the
  5692. item just above.
  5693. 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
  5694. |modeline| to set these values when editing the file again. Only
  5695. works when using Vim to edit the file, other tools assume a tabstop
  5696. is worth 8 spaces.
  5697. 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
  5698. 'noexpandtab'. This should then work (for initial indents only)
  5699. for any tabstop setting that people use. It might be nice to have
  5700. tabs after the first non-blank inserted as spaces if you do this
  5701. though. Otherwise aligned comments will be wrong when 'tabstop' is
  5702. changed.
  5703. The value of 'tabstop' will be ignored if |'vartabstop'| is set to
  5704. anything other than an empty string.
  5705. *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
  5706. 'tagbsearch' 'tbs' boolean (default on)
  5707. global
  5708. When searching for a tag (e.g., for the |:ta| command), Vim can either
  5709. use a binary search or a linear search in a tags file. Binary
  5710. searching makes searching for a tag a LOT faster, but a linear search
  5711. will find more tags if the tags file wasn't properly sorted.
  5712. Vim normally assumes that your tags files are sorted, or indicate that
  5713. they are not sorted. Only when this is not the case does the
  5714. 'tagbsearch' option need to be switched off.
  5715. When 'tagbsearch' is on, binary searching is first used in the tags
  5716. files. In certain situations, Vim will do a linear search instead for
  5717. certain files, or retry all files with a linear search. When
  5718. 'tagbsearch' is off, only a linear search is done.
  5719. Linear searching is done anyway, for one file, when Vim finds a line
  5720. at the start of the file indicating that it's not sorted: >
  5721. !_TAG_FILE_SORTED 0 /some comment/
  5722. < [The whitespace before and after the '0' must be a single <Tab>]
  5723. When a binary search was done and no match was found in any of the
  5724. files listed in 'tags', and case is ignored or a pattern is used
  5725. instead of a normal tag name, a retry is done with a linear search.
  5726. Tags in unsorted tags files, and matches with different case will only
  5727. be found in the retry.
  5728. If a tag file indicates that it is case-fold sorted, the second,
  5729. linear search can be avoided when case is ignored. Use a value of '2'
  5730. in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
  5731. sorted with the -f switch to "sort" in most unices, as in the command:
  5732. "sort -f -o tags tags". For Universal ctags and Exuberant ctags
  5733. version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
  5734. used for this as well. Note that case must be folded to uppercase for
  5735. this to work.
  5736. By default, tag searches are case-sensitive. Case is ignored when
  5737. 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
  5738. "ignore".
  5739. Also when 'tagcase' is "followscs" and 'smartcase' is set, or
  5740. 'tagcase' is "smart", and the pattern contains only lowercase
  5741. characters.
  5742. When 'tagbsearch' is off, tags searching is slower when a full match
  5743. exists, but faster when no full match exists. Tags in unsorted tags
  5744. files may only be found with 'tagbsearch' off.
  5745. When the tags file is not sorted, or sorted in a wrong way (not on
  5746. ASCII byte value), 'tagbsearch' should be off, or the line given above
  5747. must be included in the tags file.
  5748. This option doesn't affect commands that find all matching tags (e.g.,
  5749. command-line completion and ":help").
  5750. *'tagcase'* *'tc'*
  5751. 'tagcase' 'tc' string (default "followic")
  5752. global or local to buffer |global-local|
  5753. This option specifies how case is handled when searching the tags
  5754. file:
  5755. followic Follow the 'ignorecase' option
  5756. followscs Follow the 'smartcase' and 'ignorecase' options
  5757. ignore Ignore case
  5758. match Match case
  5759. smart Ignore case unless an upper case letter is used
  5760. *'tagfunc'* *'tfu'*
  5761. 'tagfunc' 'tfu' string (default "")
  5762. local to buffer
  5763. This option specifies a function to be used to perform tag searches.
  5764. The function gets the tag pattern and should return a List of matching
  5765. tags. See |tag-function| for an explanation of how to write the
  5766. function and an example. The value can be the name of a function, a
  5767. |lambda| or a |Funcref|. See |option-value-function| for more
  5768. information.
  5769. This option cannot be set from a |modeline| or in the |sandbox|, for
  5770. security reasons.
  5771. *'taglength'* *'tl'*
  5772. 'taglength' 'tl' number (default 0)
  5773. global
  5774. If non-zero, tags are significant up to this number of characters.
  5775. *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
  5776. 'tagrelative' 'tr' boolean (default on)
  5777. global
  5778. If on and using a tags file in another directory, file names in that
  5779. tags file are relative to the directory where the tags file is.
  5780. *'tags'* *'tag'* *E433*
  5781. 'tags' 'tag' string (default "./tags;,tags")
  5782. global or local to buffer |global-local|
  5783. Filenames for the tag command, separated by spaces or commas. To
  5784. include a space or comma in a file name, precede it with backslashes
  5785. (see |option-backslash| about including spaces/commas and backslashes).
  5786. When a file name starts with "./", the '.' is replaced with the path
  5787. of the current file. But only when the 'd' flag is not included in
  5788. 'cpoptions'. Environment variables are expanded |:set_env|. Also see
  5789. |tags-option|.
  5790. "*", "**" and other wildcards can be used to search for tags files in
  5791. a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
  5792. find all files named "tags" below "/lib". The filename itself cannot
  5793. contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
  5794. files called "tags?".
  5795. The |tagfiles()| function can be used to get a list of the file names
  5796. actually used.
  5797. The use of |:set+=| and |:set-=| is preferred when adding or removing
  5798. file names from the list. This avoids problems when a future version
  5799. uses another default.
  5800. *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
  5801. 'tagstack' 'tgst' boolean (default on)
  5802. global
  5803. When on, the |tagstack| is used normally. When off, a ":tag" or
  5804. ":tselect" command with an argument will not push the tag onto the
  5805. tagstack. A following ":tag" without an argument, a ":pop" command or
  5806. any other command that uses the tagstack will use the unmodified
  5807. tagstack, but does change the pointer to the active entry.
  5808. Resetting this option is useful when using a ":tag" command in a
  5809. mapping which should not change the tagstack.
  5810. *'termbidi'* *'tbidi'* *'notermbidi'* *'notbidi'*
  5811. 'termbidi' 'tbidi' boolean (default off)
  5812. global
  5813. The terminal is in charge of Bi-directionality of text (as specified
  5814. by Unicode). The terminal is also expected to do the required shaping
  5815. that some languages (such as Arabic) require.
  5816. Setting this option implies that 'rightleft' will not be set when
  5817. 'arabic' is set and the value of 'arabicshape' will be ignored.
  5818. Note that setting 'termbidi' has the immediate effect that
  5819. 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
  5820. For further details see |arabic.txt|.
  5821. *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'*
  5822. 'termguicolors' 'tgc' boolean (default off)
  5823. global
  5824. Enables 24-bit RGB color in the |TUI|. Uses "gui" |:highlight|
  5825. attributes instead of "cterm" attributes. |guifg|
  5826. Requires an ISO-8613-3 compatible terminal.
  5827. Nvim will automatically attempt to determine if the host terminal
  5828. supports 24-bit color and will enable this option if it does
  5829. (unless explicitly disabled by the user).
  5830. *'termpastefilter'* *'tpf'*
  5831. 'termpastefilter' 'tpf' string (default "BS,HT,ESC,DEL")
  5832. global
  5833. A comma-separated list of options for specifying control characters
  5834. to be removed from the text pasted into the terminal window. The
  5835. supported values are:
  5836. BS Backspace
  5837. HT TAB
  5838. FF Form feed
  5839. ESC Escape
  5840. DEL DEL
  5841. C0 Other control characters, excluding Line feed and
  5842. Carriage return < ' '
  5843. C1 Control characters 0x80...0x9F
  5844. *'termsync'* *'notermsync'*
  5845. 'termsync' boolean (default on)
  5846. global
  5847. If the host terminal supports it, buffer all screen updates
  5848. made during a redraw cycle so that each screen is displayed in
  5849. the terminal all at once. This can prevent tearing or flickering
  5850. when the terminal updates faster than Nvim can redraw.
  5851. *'textwidth'* *'tw'*
  5852. 'textwidth' 'tw' number (default 0)
  5853. local to buffer
  5854. Maximum width of text that is being inserted. A longer line will be
  5855. broken after white space to get this width. A zero value disables
  5856. this.
  5857. When 'textwidth' is zero, 'wrapmargin' may be used. See also
  5858. 'formatoptions' and |ins-textwidth|.
  5859. When 'formatexpr' is set it will be used to break the line.
  5860. *'thesaurus'* *'tsr'*
  5861. 'thesaurus' 'tsr' string (default "")
  5862. global or local to buffer |global-local|
  5863. List of file names, separated by commas, that are used to lookup words
  5864. for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
  5865. |compl-thesaurus|.
  5866. This option is not used if 'thesaurusfunc' is set, either for the
  5867. buffer or globally.
  5868. To include a comma in a file name precede it with a backslash. Spaces
  5869. after a comma are ignored, otherwise spaces are included in the file
  5870. name. See |option-backslash| about using backslashes. The use of
  5871. |:set+=| and |:set-=| is preferred when adding or removing directories
  5872. from the list. This avoids problems when a future version uses
  5873. another default. Backticks cannot be used in this option for security
  5874. reasons.
  5875. *'thesaurusfunc'* *'tsrfu'*
  5876. 'thesaurusfunc' 'tsrfu' string (default "")
  5877. global or local to buffer |global-local|
  5878. This option specifies a function to be used for thesaurus completion
  5879. with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
  5880. The value can be the name of a function, a |lambda| or a |Funcref|.
  5881. See |option-value-function| for more information.
  5882. This option cannot be set from a |modeline| or in the |sandbox|, for
  5883. security reasons.
  5884. *'tildeop'* *'top'* *'notildeop'* *'notop'*
  5885. 'tildeop' 'top' boolean (default off)
  5886. global
  5887. When on: The tilde command "~" behaves like an operator.
  5888. *'timeout'* *'to'* *'notimeout'* *'noto'*
  5889. 'timeout' 'to' boolean (default on)
  5890. global
  5891. This option and 'timeoutlen' determine the behavior when part of a
  5892. mapped key sequence has been received. For example, if <c-f> is
  5893. pressed and 'timeout' is set, Nvim will wait 'timeoutlen' milliseconds
  5894. for any key that can follow <c-f> in a mapping.
  5895. *'timeoutlen'* *'tm'*
  5896. 'timeoutlen' 'tm' number (default 1000)
  5897. global
  5898. Time in milliseconds to wait for a mapped sequence to complete.
  5899. *'title'* *'notitle'*
  5900. 'title' boolean (default off)
  5901. global
  5902. When on, the title of the window will be set to the value of
  5903. 'titlestring' (if it is not empty), or to:
  5904. filename [+=-] (path) - Nvim
  5905. Where:
  5906. filename the name of the file being edited
  5907. - indicates the file cannot be modified, 'ma' off
  5908. + indicates the file was modified
  5909. = indicates the file is read-only
  5910. =+ indicates the file is read-only and modified
  5911. (path) is the path of the file being edited
  5912. - Nvim the server name |v:servername| or "Nvim"
  5913. *'titlelen'*
  5914. 'titlelen' number (default 85)
  5915. global
  5916. Gives the percentage of 'columns' to use for the length of the window
  5917. title. When the title is longer, only the end of the path name is
  5918. shown. A '<' character before the path name is used to indicate this.
  5919. Using a percentage makes this adapt to the width of the window. But
  5920. it won't work perfectly, because the actual number of characters
  5921. available also depends on the font used and other things in the title
  5922. bar. When 'titlelen' is zero the full path is used. Otherwise,
  5923. values from 1 to 30000 percent can be used.
  5924. 'titlelen' is also used for the 'titlestring' option.
  5925. *'titleold'*
  5926. 'titleold' string (default "")
  5927. global
  5928. If not empty, this option will be used to set the window title when
  5929. exiting. Only if 'title' is enabled.
  5930. This option cannot be set from a |modeline| or in the |sandbox|, for
  5931. security reasons.
  5932. *'titlestring'*
  5933. 'titlestring' string (default "")
  5934. global
  5935. When this option is not empty, it will be used for the title of the
  5936. window. This happens only when the 'title' option is on.
  5937. When this option contains printf-style '%' items, they will be
  5938. expanded according to the rules used for 'statusline'. If it contains
  5939. an invalid '%' format, the value is used as-is and no error or warning
  5940. will be given when the value is set.
  5941. The default behaviour is equivalent to: >vim
  5942. set titlestring=%t%(\ %M%)%(\ \(%{expand(\"%:~:h\")}\)%)%a\ -\ Nvim
  5943. <
  5944. This option cannot be set in a modeline when 'modelineexpr' is off.
  5945. Example: >vim
  5946. auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
  5947. set title titlestring=%<%F%=%l/%L-%P titlelen=70
  5948. < The value of 'titlelen' is used to align items in the middle or right
  5949. of the available space.
  5950. Some people prefer to have the file name first: >vim
  5951. set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
  5952. < Note the use of "%{ }" and an expression to get the path of the file,
  5953. without the file name. The "%( %)" constructs are used to add a
  5954. separating space only when needed.
  5955. NOTE: Use of special characters in 'titlestring' may cause the display
  5956. to be garbled (e.g., when it contains a CR or NL character).
  5957. *'ttimeout'* *'nottimeout'*
  5958. 'ttimeout' boolean (default on)
  5959. global
  5960. This option and 'ttimeoutlen' determine the behavior when part of a
  5961. key code sequence has been received by the |TUI|.
  5962. For example if <Esc> (the \x1b byte) is received and 'ttimeout' is
  5963. set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to
  5964. complete a key code sequence. If no input arrives before the timeout,
  5965. a single <Esc> is assumed. Many TUI cursor key codes start with <Esc>.
  5966. On very slow systems this may fail, causing cursor keys not to work
  5967. sometimes. If you discover this problem you can ":set ttimeoutlen=9999".
  5968. Nvim will wait for the next character to arrive after an <Esc>.
  5969. *'ttimeoutlen'* *'ttm'*
  5970. 'ttimeoutlen' 'ttm' number (default 50)
  5971. global
  5972. Time in milliseconds to wait for a key code sequence to complete. Also
  5973. used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has
  5974. been typed.
  5975. *'undodir'* *'udir'* *E5003*
  5976. 'undodir' 'udir' string (default "$XDG_STATE_HOME/nvim/undo//")
  5977. global
  5978. List of directory names for undo files, separated with commas.
  5979. See 'backupdir' for details of the format.
  5980. "." means using the directory of the file. The undo file name for
  5981. "file.txt" is ".file.txt.un~".
  5982. For other directories the file name is the full path of the edited
  5983. file, with path separators replaced with "%".
  5984. When writing: The first directory that exists is used. "." always
  5985. works, no directories after "." will be used for writing. If none of
  5986. the directories exist Nvim will attempt to create the last directory in
  5987. the list.
  5988. When reading all entries are tried to find an undo file. The first
  5989. undo file that exists is used. When it cannot be read an error is
  5990. given, no further entry is used.
  5991. See |undo-persistence|.
  5992. This option cannot be set from a |modeline| or in the |sandbox|, for
  5993. security reasons.
  5994. Note that unlike 'directory' and 'backupdir', 'undodir' always acts as
  5995. though the trailing slashes are present (see 'backupdir' for what this
  5996. means).
  5997. *'undofile'* *'udf'* *'noundofile'* *'noudf'*
  5998. 'undofile' 'udf' boolean (default off)
  5999. local to buffer
  6000. When on, Vim automatically saves undo history to an undo file when
  6001. writing a buffer to a file, and restores undo history from the same
  6002. file on buffer read.
  6003. The directory where the undo file is stored is specified by 'undodir'.
  6004. For more information about this feature see |undo-persistence|.
  6005. The undo file is not read when 'undoreload' causes the buffer from
  6006. before a reload to be saved for undo.
  6007. When 'undofile' is turned off the undo file is NOT deleted.
  6008. *'undolevels'* *'ul'*
  6009. 'undolevels' 'ul' number (default 1000)
  6010. global or local to buffer |global-local|
  6011. Maximum number of changes that can be undone. Since undo information
  6012. is kept in memory, higher numbers will cause more memory to be used.
  6013. Nevertheless, a single change can already use a large amount of memory.
  6014. Set to 0 for Vi compatibility: One level of undo and "u" undoes
  6015. itself: >vim
  6016. set ul=0
  6017. < But you can also get Vi compatibility by including the 'u' flag in
  6018. 'cpoptions', and still be able to use CTRL-R to repeat undo.
  6019. Also see |undo-two-ways|.
  6020. Set to -1 for no undo at all. You might want to do this only for the
  6021. current buffer: >vim
  6022. setlocal ul=-1
  6023. < This helps when you run out of memory for a single change.
  6024. The local value is set to -123456 when the global value is to be used.
  6025. Also see |clear-undo|.
  6026. *'undoreload'* *'ur'*
  6027. 'undoreload' 'ur' number (default 10000)
  6028. global
  6029. Save the whole buffer for undo when reloading it. This applies to the
  6030. ":e!" command and reloading for when the buffer changed outside of
  6031. Vim. |FileChangedShell|
  6032. The save only happens when this option is negative or when the number
  6033. of lines is smaller than the value of this option.
  6034. Set this option to zero to disable undo for a reload.
  6035. When saving undo for a reload, any undo file is not read.
  6036. Note that this causes the whole buffer to be stored in memory. Set
  6037. this option to a lower value if you run out of memory.
  6038. *'updatecount'* *'uc'*
  6039. 'updatecount' 'uc' number (default 200)
  6040. global
  6041. After typing this many characters the swap file will be written to
  6042. disk. When zero, no swap file will be created at all (see chapter on
  6043. recovery |crash-recovery|). 'updatecount' is set to zero by starting
  6044. Vim with the "-n" option, see |startup|. When editing in readonly
  6045. mode this option will be initialized to 10000.
  6046. The swapfile can be disabled per buffer with |'swapfile'|.
  6047. When 'updatecount' is set from zero to non-zero, swap files are
  6048. created for all buffers that have 'swapfile' set. When 'updatecount'
  6049. is set to zero, existing swap files are not deleted.
  6050. This option has no meaning in buffers where |'buftype'| is "nofile"
  6051. or "nowrite".
  6052. *'updatetime'* *'ut'*
  6053. 'updatetime' 'ut' number (default 4000)
  6054. global
  6055. If this many milliseconds nothing is typed the swap file will be
  6056. written to disk (see |crash-recovery|). Also used for the
  6057. |CursorHold| autocommand event.
  6058. *'varsofttabstop'* *'vsts'*
  6059. 'varsofttabstop' 'vsts' string (default "")
  6060. local to buffer
  6061. A list of the number of spaces that a <Tab> counts for while editing,
  6062. such as inserting a <Tab> or using <BS>. It "feels" like variable-
  6063. width <Tab>s are being inserted, while in fact a mixture of spaces
  6064. and <Tab>s is used. Tab widths are separated with commas, with the
  6065. final value applying to all subsequent tabs.
  6066. For example, when editing assembly language files where statements
  6067. start in the 9th column and comments in the 41st, it may be useful
  6068. to use the following: >vim
  6069. set varsofttabstop=8,32,8
  6070. < This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
  6071. for every column thereafter.
  6072. Note that the value of |'softtabstop'| will be ignored while
  6073. 'varsofttabstop' is set.
  6074. *'vartabstop'* *'vts'*
  6075. 'vartabstop' 'vts' string (default "")
  6076. local to buffer
  6077. A list of the number of spaces that a <Tab> in the file counts for,
  6078. separated by commas. Each value corresponds to one tab, with the
  6079. final value applying to all subsequent tabs. For example: >vim
  6080. set vartabstop=4,20,10,8
  6081. < This will make the first tab 4 spaces wide, the second 20 spaces,
  6082. the third 10 spaces, and all following tabs 8 spaces.
  6083. Note that the value of |'tabstop'| will be ignored while 'vartabstop'
  6084. is set.
  6085. *'verbose'* *'vbs'*
  6086. 'verbose' 'vbs' number (default 0)
  6087. global
  6088. Sets the verbosity level. Also set by |-V| and |:verbose|.
  6089. Tracing of assignments to options, mappings, etc. in Lua scripts is
  6090. enabled at level 1; Lua scripts are not traced when 'verbose' is 0,
  6091. for performance.
  6092. If greater than or equal to a given level, Nvim produces the following
  6093. messages:
  6094. Level Messages ~
  6095. ----------------------------------------------------------------------
  6096. 1 Enables Lua tracing (see above). Does not produce messages.
  6097. 2 When a file is ":source"'ed, or |shada| file is read or written.
  6098. 3 UI info, terminal capabilities.
  6099. 4 Shell commands.
  6100. 5 Every searched tags file and include file.
  6101. 8 Files for which a group of autocommands is executed.
  6102. 9 Executed autocommands.
  6103. 11 Finding items in a path.
  6104. 12 Vimscript function calls.
  6105. 13 When an exception is thrown, caught, finished, or discarded.
  6106. 14 Anything pending in a ":finally" clause.
  6107. 15 Ex commands from a script (truncated at 200 characters).
  6108. 16 Ex commands.
  6109. If 'verbosefile' is set then the verbose messages are not displayed.
  6110. *'verbosefile'* *'vfile'*
  6111. 'verbosefile' 'vfile' string (default "")
  6112. global
  6113. When not empty all messages are written in a file with this name.
  6114. When the file exists messages are appended.
  6115. Writing to the file ends when Vim exits or when 'verbosefile' is made
  6116. empty. Writes are buffered, thus may not show up for some time.
  6117. Setting 'verbosefile' to a new value is like making it empty first.
  6118. The difference with |:redir| is that verbose messages are not
  6119. displayed when 'verbosefile' is set.
  6120. This option cannot be set from a |modeline| or in the |sandbox|, for
  6121. security reasons.
  6122. *'viewdir'* *'vdir'*
  6123. 'viewdir' 'vdir' string (default "$XDG_STATE_HOME/nvim/view//")
  6124. global
  6125. Name of the directory where to store files for |:mkview|.
  6126. This option cannot be set from a |modeline| or in the |sandbox|, for
  6127. security reasons.
  6128. *'viewoptions'* *'vop'*
  6129. 'viewoptions' 'vop' string (default "folds,cursor,curdir")
  6130. global
  6131. Changes the effect of the |:mkview| command. It is a comma-separated
  6132. list of words. Each word enables saving and restoring something:
  6133. word save and restore ~
  6134. cursor cursor position in file and in window
  6135. curdir local current directory, if set with |:lcd|
  6136. folds manually created folds, opened/closed folds and local
  6137. fold options
  6138. options options and mappings local to a window or buffer (not
  6139. global values for local options)
  6140. localoptions same as "options"
  6141. slash |deprecated| Always enabled. Uses "/" in filenames.
  6142. unix |deprecated| Always enabled. Uses "\n" line endings.
  6143. *'virtualedit'* *'ve'*
  6144. 'virtualedit' 've' string (default "")
  6145. global or local to window |global-local|
  6146. A comma-separated list of these words:
  6147. block Allow virtual editing in Visual block mode.
  6148. insert Allow virtual editing in Insert mode.
  6149. all Allow virtual editing in all modes.
  6150. onemore Allow the cursor to move just past the end of the line
  6151. none When used as the local value, do not allow virtual
  6152. editing even when the global value is set. When used
  6153. as the global value, "none" is the same as "".
  6154. NONE Alternative spelling of "none".
  6155. Virtual editing means that the cursor can be positioned where there is
  6156. no actual character. This can be halfway into a tab or beyond the end
  6157. of the line. Useful for selecting a rectangle in Visual mode and
  6158. editing a table.
  6159. "onemore" is not the same, it will only allow moving the cursor just
  6160. after the last character of the line. This makes some commands more
  6161. consistent. Previously the cursor was always past the end of the line
  6162. if the line was empty. But it is far from Vi compatible. It may also
  6163. break some plugins or Vim scripts. For example because |l| can move
  6164. the cursor after the last character. Use with care!
  6165. Using the `$` command will move to the last character in the line, not
  6166. past it. This may actually move the cursor to the left!
  6167. The `g$` command will move to the end of the screen line.
  6168. It doesn't make sense to combine "all" with "onemore", but you will
  6169. not get a warning for it.
  6170. When combined with other words, "none" is ignored.
  6171. *'visualbell'* *'vb'* *'novisualbell'* *'novb'*
  6172. 'visualbell' 'vb' boolean (default off)
  6173. global
  6174. Use visual bell instead of beeping. Also see 'errorbells'.
  6175. *'warn'* *'nowarn'*
  6176. 'warn' boolean (default on)
  6177. global
  6178. Give a warning message when a shell command is used while the buffer
  6179. has been changed.
  6180. *'whichwrap'* *'ww'*
  6181. 'whichwrap' 'ww' string (default "b,s")
  6182. global
  6183. Allow specified keys that move the cursor left/right to move to the
  6184. previous/next line when the cursor is on the first/last character in
  6185. the line. Concatenate characters to allow this for these keys:
  6186. char key mode ~
  6187. b <BS> Normal and Visual
  6188. s <Space> Normal and Visual
  6189. h "h" Normal and Visual (not recommended)
  6190. l "l" Normal and Visual (not recommended)
  6191. < <Left> Normal and Visual
  6192. > <Right> Normal and Visual
  6193. ~ "~" Normal
  6194. [ <Left> Insert and Replace
  6195. ] <Right> Insert and Replace
  6196. For example: >vim
  6197. set ww=<,>,[,]
  6198. < allows wrap only when cursor keys are used.
  6199. When the movement keys are used in combination with a delete or change
  6200. operator, the <EOL> also counts for a character. This makes "3h"
  6201. different from "3dh" when the cursor crosses the end of a line. This
  6202. is also true for "x" and "X", because they do the same as "dl" and
  6203. "dh". If you use this, you may also want to use the mapping
  6204. ":map <BS> X" to make backspace delete the character in front of the
  6205. cursor.
  6206. When 'l' is included and it is used after an operator at the end of a
  6207. line (not an empty line) then it will not move to the next line. This
  6208. makes "dl", "cl", "yl" etc. work normally.
  6209. *'wildchar'* *'wc'*
  6210. 'wildchar' 'wc' number (default <Tab>)
  6211. global
  6212. Character you have to type to start wildcard expansion in the
  6213. command-line, as specified with 'wildmode'.
  6214. More info here: |cmdline-completion|.
  6215. The character is not recognized when used inside a macro. See
  6216. 'wildcharm' for that.
  6217. Some keys will not work, such as CTRL-C, <CR> and Enter.
  6218. <Esc> can be used, but hitting it twice in a row will still exit
  6219. command-line as a failsafe measure.
  6220. Although 'wc' is a number option, it can be specified as a number, a
  6221. single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
  6222. preceded with a caret (e.g. `^F` is CTRL-F): >vim
  6223. :set wc=27
  6224. :set wc=X
  6225. :set wc=^I
  6226. set wc=<Tab>
  6227. <
  6228. *'wildcharm'* *'wcm'*
  6229. 'wildcharm' 'wcm' number (default 0)
  6230. global
  6231. 'wildcharm' works exactly like 'wildchar', except that it is
  6232. recognized when used inside a macro. You can find "spare" command-line
  6233. keys suitable for this option by looking at |ex-edit-index|. Normally
  6234. you'll never actually type 'wildcharm', just use it in mappings that
  6235. automatically invoke completion mode, e.g.: >vim
  6236. set wcm=<C-Z>
  6237. cnoremap ss so $vim/sessions/*.vim<C-Z>
  6238. < Then after typing :ss you can use CTRL-P & CTRL-N.
  6239. *'wildignore'* *'wig'*
  6240. 'wildignore' 'wig' string (default "")
  6241. global
  6242. A list of file patterns. A file that matches with one of these
  6243. patterns is ignored when expanding |wildcards|, completing file or
  6244. directory names, and influences the result of |expand()|, |glob()| and
  6245. |globpath()| unless a flag is passed to disable this.
  6246. The pattern is used like with |:autocmd|, see |autocmd-pattern|.
  6247. Also see 'suffixes'.
  6248. Example: >vim
  6249. set wildignore=*.o,*.obj
  6250. < The use of |:set+=| and |:set-=| is preferred when adding or removing
  6251. a pattern from the list. This avoids problems when a future version
  6252. uses another default.
  6253. *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
  6254. 'wildignorecase' 'wic' boolean (default off)
  6255. global
  6256. When set case is ignored when completing file names and directories.
  6257. Has no effect when 'fileignorecase' is set.
  6258. Does not apply when the shell is used to expand wildcards, which
  6259. happens when there are special characters.
  6260. *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
  6261. 'wildmenu' 'wmnu' boolean (default on)
  6262. global
  6263. When 'wildmenu' is on, command-line completion operates in an enhanced
  6264. mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
  6265. the possible matches are shown.
  6266. When 'wildoptions' contains "pum", then the completion matches are
  6267. shown in a popup menu. Otherwise they are displayed just above the
  6268. command line, with the first match highlighted (overwriting the status
  6269. line, if there is one).
  6270. Keys that show the previous/next match, such as <Tab> or
  6271. CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
  6272. 'wildmode' must specify "full": "longest" and "list" do not start
  6273. 'wildmenu' mode. You can check the current mode with |wildmenumode()|.
  6274. The menu is cancelled when a key is hit that is not used for selecting
  6275. a completion.
  6276. While the menu is active these keys have special meanings:
  6277. CTRL-P - go to the previous entry
  6278. CTRL-N - go to the next entry
  6279. <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
  6280. <PageUp> - select a match several entries back
  6281. <PageDown> - select a match several entries further
  6282. <Up> - in filename/menu name completion: move up into
  6283. parent directory or parent menu.
  6284. <Down> - in filename/menu name completion: move into a
  6285. subdirectory or submenu.
  6286. <CR> - in menu completion, when the cursor is just after a
  6287. dot: move into a submenu.
  6288. CTRL-E - end completion, go back to what was there before
  6289. selecting a match.
  6290. CTRL-Y - accept the currently selected match and stop
  6291. completion.
  6292. If you want <Left> and <Right> to move the cursor instead of selecting
  6293. a different match, use this: >vim
  6294. cnoremap <Left> <Space><BS><Left>
  6295. cnoremap <Right> <Space><BS><Right>
  6296. <
  6297. |hl-WildMenu| highlights the current match.
  6298. *'wildmode'* *'wim'*
  6299. 'wildmode' 'wim' string (default "full")
  6300. global
  6301. Completion mode that is used for the character specified with
  6302. 'wildchar'. It is a comma-separated list of up to four parts. Each
  6303. part specifies what to do for each consecutive use of 'wildchar'. The
  6304. first part specifies the behavior for the first use of 'wildchar',
  6305. The second part for the second use, etc.
  6306. Each part consists of a colon separated list consisting of the
  6307. following possible values:
  6308. "" Complete only the first match.
  6309. "full" Complete the next full match. After the last match,
  6310. the original string is used and then the first match
  6311. again. Will also start 'wildmenu' if it is enabled.
  6312. "longest" Complete till longest common string. If this doesn't
  6313. result in a longer string, use the next part.
  6314. "list" When more than one match, list all matches.
  6315. "lastused" When completing buffer names and more than one buffer
  6316. matches, sort buffers by time last used (other than
  6317. the current buffer).
  6318. When there is only a single match, it is fully completed in all cases.
  6319. Examples of useful colon-separated values:
  6320. "longest:full" Like "longest", but also start 'wildmenu' if it is
  6321. enabled. Will not complete to the next full match.
  6322. "list:full" When more than one match, list all matches and
  6323. complete first match.
  6324. "list:longest" When more than one match, list all matches and
  6325. complete till longest common string.
  6326. "list:lastused" When more than one buffer matches, list all matches
  6327. and sort buffers by time last used (other than the
  6328. current buffer).
  6329. Examples: >vim
  6330. set wildmode=full
  6331. < Complete first full match, next match, etc. (the default) >vim
  6332. set wildmode=longest,full
  6333. < Complete longest common string, then each full match >vim
  6334. set wildmode=list:full
  6335. < List all matches and complete each full match >vim
  6336. set wildmode=list,full
  6337. < List all matches without completing, then each full match >vim
  6338. set wildmode=longest,list
  6339. < Complete longest common string, then list alternatives.
  6340. More info here: |cmdline-completion|.
  6341. *'wildoptions'* *'wop'*
  6342. 'wildoptions' 'wop' string (default "pum,tagfile")
  6343. global
  6344. A list of words that change how |cmdline-completion| is done.
  6345. The following values are supported:
  6346. fuzzy Use |fuzzy-matching| to find completion matches. When
  6347. this value is specified, wildcard expansion will not
  6348. be used for completion. The matches will be sorted by
  6349. the "best match" rather than alphabetically sorted.
  6350. This will find more matches than the wildcard
  6351. expansion. Currently fuzzy matching based completion
  6352. is not supported for file and directory names and
  6353. instead wildcard expansion is used.
  6354. pum Display the completion matches using the popup menu
  6355. in the same style as the |ins-completion-menu|.
  6356. tagfile When using CTRL-D to list matching tags, the kind of
  6357. tag and the file of the tag is listed. Only one match
  6358. is displayed per line. Often used tag kinds are:
  6359. d #define
  6360. f function
  6361. *'winaltkeys'* *'wak'*
  6362. 'winaltkeys' 'wak' string (default "menu")
  6363. global
  6364. only used in Win32
  6365. Some GUI versions allow the access to menu entries by using the ALT
  6366. key in combination with a character that appears underlined in the
  6367. menu. This conflicts with the use of the ALT key for mappings and
  6368. entering special characters. This option tells what to do:
  6369. no Don't use ALT keys for menus. ALT key combinations can be
  6370. mapped, but there is no automatic handling.
  6371. yes ALT key handling is done by the windowing system. ALT key
  6372. combinations cannot be mapped.
  6373. menu Using ALT in combination with a character that is a menu
  6374. shortcut key, will be handled by the windowing system. Other
  6375. keys can be mapped.
  6376. If the menu is disabled by excluding 'm' from 'guioptions', the ALT
  6377. key is never used for the menu.
  6378. This option is not used for <F10>; on Win32.
  6379. *'winbar'* *'wbr'*
  6380. 'winbar' 'wbr' string (default "")
  6381. global or local to window |global-local|
  6382. When non-empty, this option enables the window bar and determines its
  6383. contents. The window bar is a bar that's shown at the top of every
  6384. window with it enabled. The value of 'winbar' is evaluated like with
  6385. 'statusline'.
  6386. When changing something that is used in 'winbar' that does not trigger
  6387. it to be updated, use |:redrawstatus|.
  6388. Floating windows do not use the global value of 'winbar'. The
  6389. window-local value of 'winbar' must be set for a floating window to
  6390. have a window bar.
  6391. This option cannot be set in a modeline when 'modelineexpr' is off.
  6392. *'winblend'* *'winbl'*
  6393. 'winblend' 'winbl' number (default 0)
  6394. local to window
  6395. Enables pseudo-transparency for a floating window. Valid values are in
  6396. the range of 0 for fully opaque window (disabled) to 100 for fully
  6397. transparent background. Values between 0-30 are typically most useful.
  6398. UI-dependent. Works best with RGB colors. 'termguicolors'
  6399. *'window'* *'wi'*
  6400. 'window' 'wi' number (default screen height - 1)
  6401. global
  6402. Window height used for |CTRL-F| and |CTRL-B| when there is only one
  6403. window and the value is smaller than 'lines' minus one. The screen
  6404. will scroll 'window' minus two lines, with a minimum of one.
  6405. When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
  6406. in a much smarter way, taking care of wrapping lines.
  6407. When resizing the Vim window, and the value is smaller than 1 or more
  6408. than or equal to 'lines' it will be set to 'lines' minus 1.
  6409. Note: Do not confuse this with the height of the Vim window, use
  6410. 'lines' for that.
  6411. *'winfixbuf'* *'wfb'* *'nowinfixbuf'* *'nowfb'*
  6412. 'winfixbuf' 'wfb' boolean (default off)
  6413. local to window
  6414. If enabled, the window and the buffer it is displaying are paired.
  6415. For example, attempting to change the buffer with |:edit| will fail.
  6416. Other commands which change a window's buffer such as |:cnext| will
  6417. also skip any window with 'winfixbuf' enabled. However if an Ex
  6418. command has a "!" modifier, it can force switching buffers.
  6419. *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
  6420. 'winfixheight' 'wfh' boolean (default off)
  6421. local to window |local-noglobal|
  6422. Keep the window height when windows are opened or closed and
  6423. 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
  6424. |preview-window| and |quickfix-window|.
  6425. The height may be changed anyway when running out of room.
  6426. *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
  6427. 'winfixwidth' 'wfw' boolean (default off)
  6428. local to window |local-noglobal|
  6429. Keep the window width when windows are opened or closed and
  6430. 'equalalways' is set. Also for |CTRL-W_=|.
  6431. The width may be changed anyway when running out of room.
  6432. *'winheight'* *'wh'* *E591*
  6433. 'winheight' 'wh' number (default 1)
  6434. global
  6435. Minimal number of lines for the current window. This is not a hard
  6436. minimum, Vim will use fewer lines if there is not enough room. If the
  6437. focus goes to a window that is smaller, its size is increased, at the
  6438. cost of the height of other windows.
  6439. Set 'winheight' to a small number for normal editing.
  6440. Set it to 999 to make the current window fill most of the screen.
  6441. Other windows will be only 'winminheight' high. This has the drawback
  6442. that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
  6443. to create only two windows, set the option after startup is done,
  6444. using the |VimEnter| event: >vim
  6445. au VimEnter * set winheight=999
  6446. < Minimum value is 1.
  6447. The height is not adjusted after one of the commands that change the
  6448. height of the current window.
  6449. 'winheight' applies to the current window. Use 'winminheight' to set
  6450. the minimal height for other windows.
  6451. *'winhighlight'* *'winhl'*
  6452. 'winhighlight' 'winhl' string (default "")
  6453. local to window
  6454. Window-local highlights. Comma-delimited list of highlight
  6455. |group-name| pairs "{hl-from}:{hl-to},..." where each {hl-from} is
  6456. a |highlight-groups| item to be overridden by {hl-to} group in
  6457. the window.
  6458. Note: highlight namespaces take precedence over 'winhighlight'.
  6459. See |nvim_win_set_hl_ns()| and |nvim_set_hl()|.
  6460. Highlights of vertical separators are determined by the window to the
  6461. left of the separator. The 'tabline' highlight of a tabpage is
  6462. decided by the last-focused window of the tabpage. Highlights of
  6463. the popupmenu are determined by the current window. Highlights in the
  6464. message area cannot be overridden.
  6465. Example: show a different color for non-current windows: >vim
  6466. set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC
  6467. <
  6468. *'winminheight'* *'wmh'*
  6469. 'winminheight' 'wmh' number (default 1)
  6470. global
  6471. The minimal height of a window, when it's not the current window.
  6472. This is a hard minimum, windows will never become smaller.
  6473. When set to zero, windows may be "squashed" to zero lines (i.e. just a
  6474. status bar) if necessary. They will return to at least one line when
  6475. they become active (since the cursor has to have somewhere to go.)
  6476. Use 'winheight' to set the minimal height of the current window.
  6477. This option is only checked when making a window smaller. Don't use a
  6478. large number, it will cause errors when opening more than a few
  6479. windows. A value of 0 to 3 is reasonable.
  6480. *'winminwidth'* *'wmw'*
  6481. 'winminwidth' 'wmw' number (default 1)
  6482. global
  6483. The minimal width of a window, when it's not the current window.
  6484. This is a hard minimum, windows will never become smaller.
  6485. When set to zero, windows may be "squashed" to zero columns (i.e. just
  6486. a vertical separator) if necessary. They will return to at least one
  6487. line when they become active (since the cursor has to have somewhere
  6488. to go.)
  6489. Use 'winwidth' to set the minimal width of the current window.
  6490. This option is only checked when making a window smaller. Don't use a
  6491. large number, it will cause errors when opening more than a few
  6492. windows. A value of 0 to 12 is reasonable.
  6493. *'winwidth'* *'wiw'* *E592*
  6494. 'winwidth' 'wiw' number (default 20)
  6495. global
  6496. Minimal number of columns for the current window. This is not a hard
  6497. minimum, Vim will use fewer columns if there is not enough room. If
  6498. the current window is smaller, its size is increased, at the cost of
  6499. the width of other windows. Set it to 999 to make the current window
  6500. always fill the screen. Set it to a small number for normal editing.
  6501. The width is not adjusted after one of the commands to change the
  6502. width of the current window.
  6503. 'winwidth' applies to the current window. Use 'winminwidth' to set
  6504. the minimal width for other windows.
  6505. *'wrap'* *'nowrap'*
  6506. 'wrap' boolean (default on)
  6507. local to window
  6508. This option changes how text is displayed. It doesn't change the text
  6509. in the buffer, see 'textwidth' for that.
  6510. When on, lines longer than the width of the window will wrap and
  6511. displaying continues on the next line. When off lines will not wrap
  6512. and only part of long lines will be displayed. When the cursor is
  6513. moved to a part that is not shown, the screen will scroll
  6514. horizontally.
  6515. The line will be broken in the middle of a word if necessary. See
  6516. 'linebreak' to get the break at a word boundary.
  6517. To make scrolling horizontally a bit more useful, try this: >vim
  6518. set sidescroll=5
  6519. set listchars+=precedes:<,extends:>
  6520. < See 'sidescroll', 'listchars' and |wrap-off|.
  6521. This option can't be set from a |modeline| when the 'diff' option is
  6522. on.
  6523. *'wrapmargin'* *'wm'*
  6524. 'wrapmargin' 'wm' number (default 0)
  6525. local to buffer
  6526. Number of characters from the right window border where wrapping
  6527. starts. When typing text beyond this limit, an <EOL> will be inserted
  6528. and inserting continues on the next line.
  6529. Options that add a margin, such as 'number' and 'foldcolumn', cause
  6530. the text width to be further reduced.
  6531. When 'textwidth' is non-zero, this option is not used.
  6532. See also 'formatoptions' and |ins-textwidth|.
  6533. *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* *E384* *E385*
  6534. 'wrapscan' 'ws' boolean (default on)
  6535. global
  6536. Searches wrap around the end of the file. Also applies to |]s| and
  6537. |[s|, searching for spelling mistakes.
  6538. *'write'* *'nowrite'*
  6539. 'write' boolean (default on)
  6540. global
  6541. Allows writing files. When not set, writing a file is not allowed.
  6542. Can be used for a view-only mode, where modifications to the text are
  6543. still allowed. Can be reset with the |-m| or |-M| command line
  6544. argument. Filtering text is still possible, even though this requires
  6545. writing a temporary file.
  6546. *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
  6547. 'writeany' 'wa' boolean (default off)
  6548. global
  6549. Allows writing to any file with no need for "!" override.
  6550. *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
  6551. 'writebackup' 'wb' boolean (default on)
  6552. global
  6553. Make a backup before overwriting a file. The backup is removed after
  6554. the file was successfully written, unless the 'backup' option is
  6555. also on.
  6556. WARNING: Switching this option off means that when Vim fails to write
  6557. your buffer correctly and then, for whatever reason, Vim exits, you
  6558. lose both the original file and what you were writing. Only reset
  6559. this option if your file system is almost full and it makes the write
  6560. fail (and make sure not to exit Vim until the write was successful).
  6561. See |backup-table| for another explanation.
  6562. When the 'backupskip' pattern matches, a backup is not made anyway.
  6563. Depending on 'backupcopy' the backup is a new file or the original
  6564. file renamed (and a new file is written).
  6565. *'writedelay'* *'wd'*
  6566. 'writedelay' 'wd' number (default 0)
  6567. global
  6568. Only takes effect together with 'redrawdebug'.
  6569. The number of milliseconds to wait after each line or each flush
  6570. vim:tw=78:ts=8:noet:ft=help:norl: