options.txt 403 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525
  1. *options.txt* For Vim version 9.0. Last change: 2022 Dec 09
  2. VIM REFERENCE MANUAL by Bram Moolenaar
  3. Options *options*
  4. 1. Setting options |set-option|
  5. 2. Automatically setting options |auto-setting|
  6. 3. Options summary |option-summary|
  7. For an overview of options see quickref.txt |option-list|.
  8. Vim has a number of internal variables and switches which can be set to
  9. achieve special effects. These options come in three forms:
  10. boolean can only be on or off *boolean* *toggle*
  11. number has a numeric value
  12. string has a string value
  13. ==============================================================================
  14. 1. Setting options *set-option* *E764*
  15. *:se* *:set*
  16. :se[t][!] Show all options that differ from their default value.
  17. When [!] is present every option is on a separate
  18. line.
  19. :se[t][!] all Show all but terminal options.
  20. When [!] is present every option is on a separate
  21. line.
  22. :se[t] termcap Show all terminal options. Note that in the GUI the
  23. key codes are not shown, because they are generated
  24. internally and can't be changed. Changing the terminal
  25. codes in the GUI is not useful either...
  26. :se[t]! termcap Idem, but don't use multiple columns.
  27. *E518* *E519*
  28. :se[t] {option}? Show value of {option}.
  29. :se[t] {option} Toggle option: set, switch it on.
  30. Number option: show value.
  31. String option: show value.
  32. :se[t] no{option} Toggle option: Reset, switch it off.
  33. *:set-!* *:set-inv*
  34. :se[t] {option}! or
  35. :se[t] inv{option} Toggle option: Invert value.
  36. *:set-default* *:set-&* *:set-&vi* *:set-&vim*
  37. :se[t] {option}& Reset option to its default value. May depend on the
  38. current value of 'compatible'.
  39. :se[t] {option}&vi Reset option to its Vi default value.
  40. :se[t] {option}&vim Reset option to its Vim default value.
  41. :se[t] all& Set all options to their default value. The values of
  42. these options are not changed:
  43. all terminal options, starting with t_
  44. 'columns'
  45. 'cryptmethod'
  46. 'encoding'
  47. 'key'
  48. 'lines'
  49. 'term'
  50. 'ttymouse'
  51. 'ttytype'
  52. Warning: This may have a lot of side effects.
  53. *:set-args* *E487* *E521*
  54. :se[t] {option}={value} or
  55. :se[t] {option}:{value}
  56. Set string or number option to {value}.
  57. For numeric options the value can be given in decimal,
  58. hex (preceded with 0x) or octal (preceded with '0').
  59. The old value can be inserted by typing 'wildchar' (by
  60. default this is a <Tab> or CTRL-E if 'compatible' is
  61. set). See |cmdline-completion|.
  62. White space between {option} and '=' is allowed and
  63. will be ignored. White space between '=' and {value}
  64. is not allowed.
  65. See |option-backslash| for using white space and
  66. backslashes in {value}.
  67. :se[t] {option}+={value} *:set+=*
  68. Add the {value} to a number option, or append the
  69. {value} to a string option. When the option is a
  70. comma-separated list, a comma is added, unless the
  71. value was empty.
  72. If the option is a list of flags, superfluous flags
  73. are removed. When adding a flag that was already
  74. present the option value doesn't change.
  75. Also see |:set-args| above.
  76. :se[t] {option}^={value} *:set^=*
  77. Multiply the {value} to a number option, or prepend
  78. the {value} to a string option. When the option is a
  79. comma-separated list, a comma is added, unless the
  80. value was empty.
  81. Also see |:set-args| above.
  82. :se[t] {option}-={value} *:set-=*
  83. Subtract the {value} from a number option, or remove
  84. the {value} from a string option, if it is there.
  85. If the {value} is not found in a string option, there
  86. is no error or warning. When the option is a comma
  87. separated list, a comma is deleted, unless the option
  88. becomes empty.
  89. When the option is a list of flags, {value} must be
  90. exactly as they appear in the option. Remove flags
  91. one by one to avoid problems.
  92. Also see |:set-args| above.
  93. The {option} arguments to ":set" may be repeated. For example: >
  94. :set ai nosi sw=3 ts=3
  95. If you make an error in one of the arguments, an error message will be given
  96. and the following arguments will be ignored.
  97. *:set-verbose*
  98. When 'verbose' is non-zero, displaying an option value will also tell where it
  99. was last set. Example: >
  100. :verbose set shiftwidth cindent?
  101. < shiftwidth=4 ~
  102. Last set from modeline line 1 ~
  103. cindent ~
  104. Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
  105. This is only done when specific option values are requested, not for ":verbose
  106. set all" or ":verbose set" without an argument.
  107. When the option was set by hand there is no "Last set" message.
  108. When the option was set while executing a function, user command or
  109. autocommand, the script in which it was defined is reported.
  110. Note that an option may also have been set as a side effect of setting
  111. 'compatible'.
  112. A few special texts:
  113. Last set from modeline line 1 ~
  114. Option was set in a |modeline|.
  115. Last set from --cmd argument ~
  116. Option was set with command line argument |--cmd| or +.
  117. Last set from -c argument ~
  118. Option was set with command line argument |-c|, +, |-S| or
  119. |-q|.
  120. Last set from environment variable ~
  121. Option was set from an environment variable, $VIMINIT,
  122. $GVIMINIT or $EXINIT.
  123. Last set from error handler ~
  124. Option was cleared when evaluating it resulted in an error.
  125. {not available when compiled without the |+eval| feature}
  126. *:set-termcap* *E522*
  127. For {option} the form "t_xx" may be used to set a terminal option. This will
  128. override the value from the termcap. You can then use it in a mapping. If
  129. the "xx" part contains special characters, use the <t_xx> form: >
  130. :set <t_#4>=^[Ot
  131. This can also be used to translate a special code for a normal key. For
  132. example, if Alt-b produces <Esc>b, use this: >
  133. :set <M-b>=^[b
  134. (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
  135. The advantage over a mapping is that it works in all situations.
  136. You can define any key codes, e.g.: >
  137. :set t_xy=^[foo;
  138. There is no warning for using a name that isn't recognized. You can map these
  139. codes as you like: >
  140. :map <t_xy> something
  141. < *E846*
  142. When a key code is not set, it's like it does not exist. Trying to get its
  143. value will result in an error: >
  144. :set t_kb=
  145. :set t_kb
  146. < E846: Key code not set: t_kb ~
  147. The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
  148. security reasons.
  149. The listing from ":set" looks different from Vi. Long string options are put
  150. at the end of the list. The number of options is quite large. The output of
  151. "set all" probably does not fit on the screen, causing Vim to give the
  152. |more-prompt|.
  153. *option-backslash*
  154. To include white space in a string option value it has to be preceded with a
  155. backslash. To include a backslash you have to use two. Effectively this
  156. means that the number of backslashes in an option value is halved (rounded
  157. down).
  158. A few examples: >
  159. :set tags=tags\ /usr/tags results in "tags /usr/tags"
  160. :set tags=tags\\,file results in "tags\,file"
  161. :set tags=tags\\\ file results in "tags\ file"
  162. The "|" character separates a ":set" command from a following command. To
  163. include the "|" in the option value, use "\|" instead. This example sets the
  164. 'titlestring' option to "hi|there": >
  165. :set titlestring=hi\|there
  166. This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
  167. :set titlestring=hi|set iconstring=there
  168. Similarly, in legacy script the double quote character starts a comment. To
  169. include the '"' in the option value, use '\"' instead. This example sets the
  170. 'titlestring' option to 'hi "there"': >
  171. :set titlestring=hi\ \"there\"
  172. In |Vim9| script it's simpler, comments start with a '#' character, and only
  173. when preceded by white space. A backslash is needed less often: >
  174. vim9script
  175. set titlestring=hi\ "there"
  176. set titlestring=hi#there#
  177. set titlestring=hi\ \#there#
  178. For Win32 backslashes in file names are mostly not removed. More precise: For
  179. options that expect a file name (those where environment variables are
  180. expanded) a backslash before a normal file name character is not removed. But
  181. a backslash before a special character (space, backslash, comma, etc.) is used
  182. like explained above.
  183. There is one special situation, when the value starts with "\\": >
  184. :set dir=\\machine\path results in "\\machine\path"
  185. :set dir=\\\\machine\\path results in "\\machine\path"
  186. :set dir=\\path\\file results in "\\path\file" (wrong!)
  187. For the first one the start is kept, but for the second one the backslashes
  188. are halved. This makes sure it works both when you expect backslashes to be
  189. halved and when you expect the backslashes to be kept. The third gives a
  190. result which is probably not what you want. Avoid it.
  191. *add-option-flags* *remove-option-flags*
  192. *E539* *E550* *E551* *E552*
  193. Some options are a list of flags. When you want to add a flag to such an
  194. option, without changing the existing ones, you can do it like this: >
  195. :set guioptions+=a
  196. Remove a flag from an option like this: >
  197. :set guioptions-=a
  198. This removes the 'a' flag from 'guioptions'.
  199. Note that you should add or remove one flag at a time. If 'guioptions' has
  200. the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
  201. doesn't appear.
  202. *:set_env* *expand-env* *expand-environment-var*
  203. Environment variables in specific string options will be expanded. If the
  204. environment variable exists the '$' and the following environment variable
  205. name is replaced with its value. If it does not exist the '$' and the name
  206. are not modified. Any non-id character (not a letter, digit or '_') may
  207. follow the environment variable name. That character and what follows is
  208. appended to the value of the environment variable. Examples: >
  209. :set term=$TERM.new
  210. :set path=/usr/$INCLUDE,$HOME/include,.
  211. When adding or removing a string from an option with ":set opt-=val" or ":set
  212. opt+=val" the expansion is done before the adding or removing.
  213. Handling of local options *local-options*
  214. Some of the options only apply to a window or buffer. Each window or buffer
  215. has its own copy of this option, thus each can have its own value. This
  216. allows you to set 'list' in one window but not in another. And set
  217. 'shiftwidth' to 3 in one buffer and 4 in another.
  218. The following explains what happens to these local options in specific
  219. situations. You don't really need to know all of this, since Vim mostly uses
  220. the option values you would expect. Unfortunately, doing what the user
  221. expects is a bit complicated...
  222. When splitting a window, the local options are copied to the new window. Thus
  223. right after the split the contents of the two windows look the same.
  224. When editing a new buffer, its local option values must be initialized. Since
  225. the local options of the current buffer might be specifically for that buffer,
  226. these are not used. Instead, for each buffer-local option there also is a
  227. global value, which is used for new buffers. With ":set" both the local and
  228. global value is changed. With "setlocal" only the local value is changed,
  229. thus this value is not used when editing a new buffer.
  230. When editing a buffer that has been edited before, the options from the window
  231. that was last closed are used again. If this buffer has been edited in this
  232. window, the values from back then are used. Otherwise the values from the
  233. last closed window where the buffer was edited last are used.
  234. It's possible to set a local window option specifically for a type of buffer.
  235. When you edit another buffer in the same window, you don't want to keep
  236. using these local window options. Therefore Vim keeps a global value of the
  237. local window options, which is used when editing another buffer. Each window
  238. has its own copy of these values. Thus these are local to the window, but
  239. global to all buffers in the window. With this you can do: >
  240. :e one
  241. :set list
  242. :e two
  243. Now the 'list' option will also be set in "two", since with the ":set list"
  244. command you have also set the global value. >
  245. :set nolist
  246. :e one
  247. :setlocal list
  248. :e two
  249. Now the 'list' option is not set, because ":set nolist" resets the global
  250. value, ":setlocal list" only changes the local value and ":e two" gets the
  251. global value. Note that if you do this next: >
  252. :e one
  253. You will get back the 'list' value as it was the last time you edited "one".
  254. The options local to a window are remembered for each buffer. This also
  255. happens when the buffer is not loaded, but they are lost when the buffer is
  256. wiped out |:bwipe|.
  257. *:setl* *:setlocal*
  258. :setl[ocal][!] ... Like ":set" but set only the value local to the
  259. current buffer or window. Not all options have a
  260. local value. If the option does not have a local
  261. value the global value is set.
  262. With the "all" argument: display local values for all
  263. local options.
  264. Without argument: Display local values for all local
  265. options which are different from the default.
  266. When displaying a specific local option, show the
  267. local value. For a global/local boolean option, when
  268. the global value is being used, "--" is displayed
  269. before the option name.
  270. For a global option the global value is
  271. shown (but that might change in the future).
  272. :setl[ocal] {option}< Set the local value of {option} to its global value by
  273. copying the value.
  274. :se[t] {option}< For |global-local| options: Remove the local value of
  275. {option}, so that the global value will be used.
  276. *:setg* *:setglobal*
  277. :setg[lobal][!] ... Like ":set" but set only the global value for a local
  278. option without changing the local value.
  279. When displaying an option, the global value is shown.
  280. With the "all" argument: display global values for all
  281. local options.
  282. Without argument: display global values for all local
  283. options which are different from the default.
  284. For buffer-local and window-local options:
  285. Command global value local value ~
  286. :set option=value set set
  287. :setlocal option=value - set
  288. :setglobal option=value set -
  289. :set option? - display
  290. :setlocal option? - display
  291. :setglobal option? display -
  292. Global options with a local value *global-local*
  293. Options are global when you mostly use one value for all buffers and windows.
  294. For some global options it's useful to sometimes have a different local value.
  295. You can set the local value with ":setlocal". That buffer or window will then
  296. use the local value, while other buffers and windows continue using the global
  297. value.
  298. For example, you have two windows, both on C source code. They use the global
  299. 'makeprg' option. If you do this in one of the two windows: >
  300. :set makeprg=gmake
  301. then the other window will switch to the same value. There is no need to set
  302. the 'makeprg' option in the other C source window too.
  303. However, if you start editing a Perl file in a new window, you want to use
  304. another 'makeprg' for it, without changing the value used for the C source
  305. files. You use this command: >
  306. :setlocal makeprg=perlmake
  307. You can switch back to using the global value by making the local value empty: >
  308. :setlocal makeprg=
  309. This only works for a string option. For a number or boolean option you need
  310. to use the "<" flag, like this: >
  311. :setlocal autoread<
  312. Note that for non-boolean and non-number options using "<" copies the global
  313. value to the local value, it doesn't switch back to using the global value
  314. (that matters when the global value changes later). You can also use: >
  315. :set path<
  316. This will make the local value of 'path' empty, so that the global value is
  317. used. Thus it does the same as: >
  318. :setlocal path=
  319. Note: In the future more global options can be made |global-local|. Using
  320. ":setlocal" on a global option might work differently then.
  321. *option-value-function*
  322. Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
  323. 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
  324. a function name or a function reference or a lambda function. When using a
  325. lambda it will be converted to the name, e.g. "<lambda>123". Examples:
  326. >
  327. set opfunc=MyOpFunc
  328. set opfunc=function('MyOpFunc')
  329. set opfunc=funcref('MyOpFunc')
  330. set opfunc={a\ ->\ MyOpFunc(a)}
  331. Set to a script-local function: >
  332. set opfunc=s:MyLocalFunc
  333. set opfunc=<SID>MyLocalFunc
  334. In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
  335. the script: >
  336. set opfunc=MyLocalFunc
  337. Set using a funcref variable: >
  338. let Fn = function('MyTagFunc')
  339. let &tagfunc = Fn
  340. Set using a lambda expression: >
  341. let &tagfunc = {t -> MyTagFunc(t)}
  342. Set using a variable with lambda expression: >
  343. let L = {a, b, c -> MyTagFunc(a, b , c)}
  344. let &tagfunc = L
  345. In Vim9 script, in a compiled function, you can use a lambda, but a
  346. closured does not work, because the function will be called without the
  347. context of where it was defined.
  348. Setting the filetype
  349. :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
  350. Set the 'filetype' option to {filetype}, but only if
  351. not done yet in a sequence of (nested) autocommands.
  352. This is short for: >
  353. :if !did_filetype()
  354. : setlocal filetype={filetype}
  355. :endif
  356. < This command is used in a filetype.vim file to avoid
  357. setting the 'filetype' option twice, causing different
  358. settings and syntax files to be loaded.
  359. When the optional FALLBACK argument is present, a
  360. later :setfiletype command will override the
  361. 'filetype'. This is to be used for filetype
  362. detections that are just a guess. |did_filetype()|
  363. will return false after this command.
  364. *option-window* *optwin*
  365. :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
  366. :opt[ions] Open a window for viewing and setting all options.
  367. Options are grouped by function.
  368. Offers short help for each option. Hit <CR> on the
  369. short help to open a help window with more help for
  370. the option.
  371. Modify the value of the option and hit <CR> on the
  372. "set" line to set the new value. For window and
  373. buffer specific options, the last accessed window is
  374. used to set the option value in, unless this is a help
  375. window, in which case the window below help window is
  376. used (skipping the option-window).
  377. {not available when compiled without the |+eval|
  378. feature}
  379. *$HOME*
  380. Using "~" is like using "$HOME", but it is only recognized at the start of an
  381. option and after a space or comma.
  382. On Unix systems "~user" can be used too. It is replaced by the home directory
  383. of user "user". Example: >
  384. :set path=~mool/include,/usr/include,.
  385. On Unix systems the form "${HOME}" can be used too. The name between {} can
  386. contain non-id characters then. Note that if you want to use this for the
  387. "gf" command, you need to add the '{' and '}' characters to 'isfname'.
  388. NOTE: expanding environment variables and "~/" is only done with the ":set"
  389. command, not when assigning a value to an option with ":let".
  390. *$HOME-windows*
  391. On MS-Windows, if $HOME is not defined as an environment variable, then
  392. at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
  393. If $HOMEDRIVE is not set then $USERPROFILE is used.
  394. This expanded value is not exported to the environment, this matters when
  395. running an external command: >
  396. :echo system('set | findstr ^HOME=')
  397. and >
  398. :echo luaeval('os.getenv("HOME")')
  399. should echo nothing (an empty string) despite exists('$HOME') being true.
  400. When setting $HOME to a non-empty string it will be exported to the
  401. subprocesses.
  402. Note the maximum length of an expanded option is limited. How much depends on
  403. the system, mostly it is something like 256 or 1024 characters.
  404. *:fix* *:fixdel*
  405. :fix[del] Set the value of 't_kD':
  406. 't_kb' is 't_kD' becomes ~
  407. CTRL-? CTRL-H
  408. not CTRL-? CTRL-?
  409. (CTRL-? is 0o177 octal, 0x7f hex)
  410. If your delete key terminal code is wrong, but the
  411. code for backspace is alright, you can put this in
  412. your .vimrc: >
  413. :fixdel
  414. < This works no matter what the actual code for
  415. backspace is.
  416. If the backspace key terminal code is wrong you can
  417. use this: >
  418. :if &term == "termname"
  419. : set t_kb=^V<BS>
  420. : fixdel
  421. :endif
  422. < Where "^V" is CTRL-V and "<BS>" is the backspace key
  423. (don't type four characters!). Replace "termname"
  424. with your terminal name.
  425. If your <Delete> key sends a strange key sequence (not
  426. CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
  427. :if &term == "termname"
  428. : set t_kD=^V<Delete>
  429. :endif
  430. < Where "^V" is CTRL-V and "<Delete>" is the delete key
  431. (don't type eight characters!). Replace "termname"
  432. with your terminal name.
  433. *Linux-backspace*
  434. Note about Linux: By default the backspace key
  435. produces CTRL-?, which is wrong. You can fix it by
  436. putting this line in your rc.local: >
  437. echo "keycode 14 = BackSpace" | loadkeys
  438. <
  439. *NetBSD-backspace*
  440. Note about NetBSD: If your backspace doesn't produce
  441. the right code, try this: >
  442. xmodmap -e "keycode 22 = BackSpace"
  443. < If this works, add this in your .Xmodmap file: >
  444. keysym 22 = BackSpace
  445. < You need to restart for this to take effect.
  446. ==============================================================================
  447. 2. Automatically setting options *auto-setting*
  448. Besides changing options with the ":set" command, there are three alternatives
  449. to set options automatically for one or more files:
  450. 1. When starting Vim initializations are read from various places. See
  451. |initialization|. Most of them are performed for all editing sessions,
  452. and some of them depend on the directory where Vim is started.
  453. You can create an initialization file with |:mkvimrc|, |:mkview| and
  454. |:mksession|.
  455. 2. If you start editing a new file, the automatic commands are executed.
  456. This can be used to set options for files matching a particular pattern and
  457. many other things. See |autocommand|.
  458. 3. If you start editing a new file, and the 'modeline' option is on, a
  459. number of lines at the beginning and end of the file are checked for
  460. modelines. This is explained here.
  461. *modeline* *vim:* *vi:* *ex:* *E520*
  462. There are two forms of modelines. The first form:
  463. [text{white}]{vi:|vim:|ex:}[white]{options}
  464. [text{white}] empty or any text followed by at least one blank
  465. character (<Space> or <Tab>); "ex:" always requires at
  466. least one blank character
  467. {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
  468. [white] optional white space
  469. {options} a list of option settings, separated with white space
  470. or ':', where each part between ':' is the argument
  471. for a ":set" command (can be empty)
  472. Examples:
  473. vi:noai:sw=3 ts=6 ~
  474. vim: tw=77 ~
  475. The second form (this is compatible with some versions of Vi):
  476. [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
  477. [text{white}] empty or any text followed by at least one blank
  478. character (<Space> or <Tab>); "ex:" always requires at
  479. least one blank character
  480. {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
  481. [white] optional white space
  482. se[t] the string "set " or "se " (note the space); When
  483. "Vim" is used it must be "set".
  484. {options} a list of options, separated with white space, which
  485. is the argument for a ":set" command
  486. : a colon
  487. [text] any text or empty
  488. Examples:
  489. /* vim: set ai tw=75: */ ~
  490. /* Vim: set ai tw=75: */ ~
  491. The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
  492. chance that a normal word like "lex:" is caught. There is one exception:
  493. "vi:" and "vim:" can also be at the start of the line (for compatibility with
  494. version 3.0). Using "ex:" at the start of the line will be ignored (this
  495. could be short for "example:").
  496. If the modeline is disabled within a modeline, subsequent modelines will be
  497. ignored. This is to allow turning off modeline on a per-file basis. This is
  498. useful when a line looks like a modeline but isn't. For example, it would be
  499. good to start a YAML file containing strings like "vim:" with
  500. # vim: nomodeline ~
  501. so as to avoid modeline misdetection. Following options on the same line
  502. after modeline deactivation, if any, are still evaluated (but you would
  503. normally not have any).
  504. *modeline-local*
  505. The options are set like with ":setlocal": The new value only applies to the
  506. buffer and window that contain the file. Although it's possible to set global
  507. options from a modeline, this is unusual. If you have two windows open and
  508. the files in it set the same global option to a different value, the result
  509. depends on which one was opened last.
  510. When editing a file that was already loaded, only the window-local options
  511. from the modeline are used. Thus if you manually changed a buffer-local
  512. option after opening the file, it won't be changed if you edit the same buffer
  513. in another window. But window-local options will be set.
  514. *modeline-version*
  515. If the modeline is only to be used for some versions of Vim, the version
  516. number can be specified where "vim:" or "Vim:" is used:
  517. vim{vers}: version {vers} or later
  518. vim<{vers}: version before {vers}
  519. vim={vers}: version {vers}
  520. vim>{vers}: version after {vers}
  521. {vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
  522. For example, to use a modeline only for Vim 7.0:
  523. /* vim700: set foldmethod=marker */ ~
  524. To use a modeline for Vim after version 7.2:
  525. /* vim>702: set cole=2: */ ~
  526. There can be no blanks between "vim" and the ":".
  527. The number of lines that are checked can be set with the 'modelines' option.
  528. If 'modeline' is off or 'modelines' is 0 no lines are checked.
  529. Note that for the first form all of the rest of the line is used, thus a line
  530. like:
  531. /* vi:ts=4: */ ~
  532. will give an error message for the trailing "*/". This line is OK:
  533. /* vi:set ts=4: */ ~
  534. If an error is detected the rest of the line is skipped.
  535. If you want to include a ':' in a set command precede it with a '\'. The
  536. backslash in front of the ':' will be removed. Example:
  537. /* vi:set fillchars=stl\:^,vert\:\|: */ ~
  538. This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
  539. before the ':' is removed. Thus to include "\:" you have to specify "\\:".
  540. *E992*
  541. No other commands than "set" are supported, for security reasons (somebody
  542. might create a Trojan horse text file with modelines). And not all options
  543. can be set. For some options a flag is set, so that when the value is used
  544. the |sandbox| is effective. Some options can only be set from the modeline
  545. when 'modelineexpr' is set (the default is off).
  546. Still, there is always a small risk that a modeline causes trouble. E.g.,
  547. when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
  548. So disable modelines before editing untrusted text. The mail ftplugin does
  549. this, for example.
  550. Hint: If you would like to do something else than setting an option, you could
  551. define an autocommand that checks the file for a specific string. For
  552. example: >
  553. au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
  554. And define a function SetVar() that does something with the line containing
  555. "VAR".
  556. ==============================================================================
  557. 3. Options summary *option-summary*
  558. In the list below all the options are mentioned with their full name and with
  559. an abbreviation if there is one. Both forms may be used.
  560. In this document when a boolean option is "set" that means that ":set option"
  561. is entered. When an option is "reset", ":set nooption" is used.
  562. For some options there are two default values: The "Vim default", which is
  563. used when 'compatible' is not set, and the "Vi default", which is used when
  564. 'compatible' is set.
  565. Most options are the same in all windows and buffers. There are a few that
  566. are specific to how the text is presented in a window. These can be set to a
  567. different value in each window. For example the 'list' option can be set in
  568. one window and reset in another for the same text, giving both types of view
  569. at the same time. There are a few options that are specific to a certain
  570. file. These can have a different value for each file or buffer. For example
  571. the 'textwidth' option can be 78 for a normal text file and 0 for a C
  572. program.
  573. global one option for all buffers and windows
  574. local to window each window has its own copy of this option
  575. local to buffer each buffer has its own copy of this option
  576. When creating a new window the option values from the currently active window
  577. are used as a default value for the window-specific options. For the
  578. buffer-specific options this depends on the 's' and 'S' flags in the
  579. 'cpoptions' option. If 's' is included (which is the default) the values for
  580. buffer options are copied from the currently active buffer when a buffer is
  581. first entered. If 'S' is present the options are copied each time the buffer
  582. is entered, this is almost like having global options. If 's' and 'S' are not
  583. present, the options are copied from the currently active buffer when the
  584. buffer is created.
  585. Hidden options *hidden-options*
  586. Not all options are supported in all versions. This depends on the supported
  587. features and sometimes on the system. A remark about this is in curly braces
  588. below. When an option is not supported it may still be set without getting an
  589. error, this is called a hidden option. You can't get the value of a hidden
  590. option though, it is not stored.
  591. To test if option "foo" can be used with ":set" use something like this: >
  592. if exists('&foo')
  593. This also returns true for a hidden option. To test if option "foo" is really
  594. supported use something like this: >
  595. if exists('+foo')
  596. <
  597. *E355*
  598. A jump table for the options with a short description can be found at |Q_op|.
  599. *'aleph'* *'al'* *aleph* *Aleph*
  600. 'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
  601. global
  602. {only available when compiled with the |+rightleft|
  603. feature}
  604. The ASCII code for the first letter of the Hebrew alphabet. The
  605. routine that maps the keyboard in Hebrew mode, both in Insert mode
  606. (when hkmap is set) and on the command-line (when hitting CTRL-_)
  607. outputs the Hebrew characters in the range [aleph..aleph+26].
  608. aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
  609. See |rileft.txt|.
  610. *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
  611. 'allowrevins' 'ari' boolean (default off)
  612. global
  613. {only available when compiled with the |+rightleft|
  614. feature}
  615. Allow CTRL-_ in Insert and Command-line mode. This is default off, to
  616. avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
  617. into reverse Insert mode, and don't know how to get out. See
  618. 'revins'.
  619. NOTE: This option is reset when 'compatible' is set.
  620. *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
  621. 'altkeymap' 'akm' boolean (default off)
  622. global
  623. {only available when compiled with the |+farsi|
  624. feature}
  625. This option was for using Farsi, which has been removed. See
  626. |farsi.txt|.
  627. *'ambiwidth'* *'ambw'*
  628. 'ambiwidth' 'ambw' string (default: "single")
  629. global
  630. Only effective when 'encoding' is "utf-8" or another Unicode encoding.
  631. Tells Vim what to do with characters with East Asian Width Class
  632. Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
  633. letters, Cyrillic letters).
  634. There are currently two possible values:
  635. "single": Use the same width as characters in US-ASCII. This is
  636. expected by most users.
  637. "double": Use twice the width of ASCII characters.
  638. *E834* *E835*
  639. The value "double" cannot be used if 'listchars' or 'fillchars'
  640. contains a character that would be double width. These errors may
  641. also be given when calling setcellwidths().
  642. The values are overruled for characters specified with
  643. |setcellwidths()|.
  644. There are a number of CJK fonts for which the width of glyphs for
  645. those characters are solely based on how many octets they take in
  646. legacy/traditional CJK encodings. In those encodings, Euro,
  647. Registered sign, Greek/Cyrillic letters are represented by two octets,
  648. therefore those fonts have "wide" glyphs for them. This is also
  649. true of some line drawing characters used to make tables in text
  650. file. Therefore, when a CJK font is used for GUI Vim or
  651. Vim is running inside a terminal (emulators) that uses a CJK font
  652. (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
  653. this option should be set to "double" to match the width perceived
  654. by Vim with the width of glyphs in the font. Perhaps it also has
  655. to be set to "double" under CJK MS-Windows when the system locale is
  656. set to one of CJK locales. See Unicode Standard Annex #11
  657. (http://www.unicode.org/reports/tr11).
  658. Vim may set this option automatically at startup time when Vim is
  659. compiled with the |+termresponse| feature and if |t_u7| is set to the
  660. escape sequence to request cursor position report. The response can
  661. be found in |v:termu7resp|.
  662. *'antialias'* *'anti'* *'noantialias'* *'noanti'*
  663. 'antialias' 'anti' boolean (default: off)
  664. global
  665. {only available when compiled with GUI enabled
  666. on macOS}
  667. This option only has an effect in the GUI version of Vim on macOS
  668. v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
  669. which can be easier to read at certain sizes on certain displays.
  670. Setting this option can sometimes cause problems if 'guifont' is set
  671. to its default (empty string).
  672. NOTE: This option is reset when 'compatible' is set.
  673. *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
  674. 'autochdir' 'acd' boolean (default off)
  675. global
  676. {only available when compiled with it, use
  677. exists("+autochdir") to check}
  678. When on, Vim will change the current working directory whenever you
  679. open a file, switch buffers, delete a buffer or open/close a window.
  680. It will change to the directory containing the file which was opened
  681. or selected. When a buffer has no name it also has no directory, thus
  682. the current directory won't change when navigating to it.
  683. Note: When this option is on some plugins may not work.
  684. *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
  685. 'autoshelldir' 'asd' boolean (default off)
  686. global
  687. When on, Vim will change the current working directory whenever you
  688. change the directory of the shell running in a terminal window. You
  689. need proper setting-up, so whenever the shell's pwd changes an OSC 7
  690. escape sequence will be emitted. For example, on Linux, you can
  691. source /etc/profile.d/vte.sh in your shell profile if you use bash or
  692. zsh. For bash this should work (put it in a bash init file): >
  693. if [[ -n "$VIM_TERMINAL" ]]; then
  694. PROMPT_COMMAND='_vim_sync_PWD'
  695. function _vim_sync_PWD() {
  696. printf '\033]7;file://%s\033\\' "$PWD"
  697. }
  698. fi
  699. <
  700. Or, in a zsh init file: >
  701. if [[ -n "$VIM_TERMINAL" ]]; then
  702. autoload -Uz add-zsh-hook
  703. add-zsh-hook -Uz chpwd _vim_sync_PWD
  704. function _vim_sync_PWD() {
  705. printf '\033]7;file://%s\033\\' "$PWD"
  706. }
  707. fi
  708. <
  709. In a fish init file: >
  710. if test -n "$VIM_TERMINAL"
  711. function _vim_sync_PWD --on-variable=PWD
  712. printf '\033]7;file://%s\033\\' "$PWD"
  713. end
  714. end
  715. <
  716. You can find an alternative method at |terminal-autoshelldir|.
  717. When the parsing of the OSC sequence fails you get *E1179* .
  718. *'arabic'* *'arab'* *'noarabic'* *'noarab'*
  719. 'arabic' 'arab' boolean (default off)
  720. local to window
  721. {only available when compiled with the |+arabic|
  722. feature}
  723. This option can be set to start editing Arabic text.
  724. Setting this option will:
  725. - Set the 'rightleft' option, unless 'termbidi' is set.
  726. - Set the 'arabicshape' option, unless 'termbidi' is set.
  727. - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
  728. between typing English and Arabic key mapping.
  729. - Set the 'delcombine' option
  730. Note that 'encoding' must be "utf-8" for working with Arabic text.
  731. Resetting this option will:
  732. - Reset the 'rightleft' option.
  733. - Disable the use of 'keymap' (without changing its value).
  734. Note that 'arabicshape' and 'delcombine' are not reset (it is a global
  735. option).
  736. NOTE: This option is reset when 'compatible' is set.
  737. Also see |arabic.txt|.
  738. *'arabicshape'* *'arshape'*
  739. *'noarabicshape'* *'noarshape'*
  740. 'arabicshape' 'arshape' boolean (default on)
  741. global
  742. {only available when compiled with the |+arabic|
  743. feature}
  744. When on and 'termbidi' is off, the required visual character
  745. corrections that need to take place for displaying the Arabic language
  746. take effect. Shaping, in essence, gets enabled; the term is a broad
  747. one which encompasses:
  748. a) the changing/morphing of characters based on their location
  749. within a word (initial, medial, final and stand-alone).
  750. b) the enabling of the ability to compose characters
  751. c) the enabling of the required combining of some characters
  752. When disabled the display shows each character's true stand-alone
  753. form.
  754. Arabic is a complex language which requires other settings, for
  755. further details see |arabic.txt|.
  756. NOTE: This option is set when 'compatible' is set.
  757. *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
  758. 'autoindent' 'ai' boolean (default off)
  759. local to buffer
  760. Copy indent from current line when starting a new line (typing <CR>
  761. in Insert mode or when using the "o" or "O" command). If you do not
  762. type anything on the new line except <BS> or CTRL-D and then type
  763. <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
  764. to another line has the same effect, unless the 'I' flag is included
  765. in 'cpoptions'.
  766. When autoindent is on, formatting (with the "gq" command or when you
  767. reach 'textwidth' in Insert mode) uses the indentation of the first
  768. line.
  769. When 'smartindent' or 'cindent' is on the indent is changed in
  770. a different way.
  771. The 'autoindent' option is reset when the 'paste' option is set and
  772. restored when 'paste' is reset.
  773. *'autoread'* *'ar'* *'noautoread'* *'noar'*
  774. 'autoread' 'ar' boolean (default off)
  775. global or local to buffer |global-local|
  776. When a file has been detected to have been changed outside of Vim and
  777. it has not been changed inside of Vim, automatically read it again.
  778. When the file has been deleted this is not done, so you have the text
  779. from before it was deleted. When it appears again then it is read.
  780. |timestamp|
  781. If this option has a local value, use this command to switch back to
  782. using the global value: >
  783. :set autoread<
  784. <
  785. *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
  786. 'autowrite' 'aw' boolean (default off)
  787. global
  788. Write the contents of the file, if it has been modified, on each
  789. `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
  790. `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
  791. a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
  792. to another file.
  793. A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
  794. set to "hide" and `:next` is used.
  795. Note that for some commands the 'autowrite' option is not used, see
  796. 'autowriteall' for that.
  797. Some buffers will not be written, specifically when 'buftype' is
  798. "nowrite", "nofile", "terminal" or "prompt".
  799. *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
  800. 'autowriteall' 'awa' boolean (default off)
  801. global
  802. Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
  803. ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
  804. Setting this option also implies that Vim behaves like 'autowrite' has
  805. been set.
  806. *'background'* *'bg'*
  807. 'background' 'bg' string (default "dark" or "light", see below)
  808. global
  809. When set to "dark", Vim will try to use colors that look good on a
  810. dark background. When set to "light", Vim will try to use colors that
  811. look good on a light background. Any other value is illegal.
  812. Vim tries to set the default value according to the terminal used.
  813. This will not always be correct.
  814. Setting this option does not change the background color, it tells Vim
  815. what the background color looks like. For changing the background
  816. color, see |:hi-normal|.
  817. When 'background' is set Vim will adjust the default color groups for
  818. the new value. But the colors used for syntax highlighting will not
  819. change. *g:colors_name*
  820. When a color scheme is loaded (the "g:colors_name" variable is set)
  821. setting 'background' will cause the color scheme to be reloaded. If
  822. the color scheme adjusts to the value of 'background' this will work.
  823. However, if the color scheme sets 'background' itself the effect may
  824. be undone. First delete the "g:colors_name" variable when needed.
  825. When setting 'background' to the default value with: >
  826. :set background&
  827. < Vim will guess the value. In the GUI this should work correctly,
  828. in other cases Vim might not be able to guess the right value.
  829. If the GUI supports a dark theme, you can use the "d" flag in
  830. 'guioptions', see 'go-d'.
  831. When the |t_RB| option is set, Vim will use it to request the background
  832. color from the terminal. If the returned RGB value is dark/light and
  833. 'background' is not dark/light, 'background' will be set and the
  834. screen is redrawn. This may have side effects, make t_BG empty in
  835. your .vimrc if you suspect this problem. The response to |t_RB| can
  836. be found in |v:termrbgresp|.
  837. When starting the GUI, the default value for 'background' will be
  838. "light". When the value is not set in the .gvimrc, and Vim detects
  839. that the background is actually quite dark, 'background' is set to
  840. "dark". But this happens only AFTER the .gvimrc file has been read
  841. (because the window needs to be opened to find the actual background
  842. color). To get around this, force the GUI window to be opened by
  843. putting a ":gui" command in the .gvimrc file, before where the value
  844. of 'background' is used (e.g., before ":syntax on").
  845. For MS-Windows the default is "dark".
  846. For other systems "dark" is used when 'term' is "linux",
  847. "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
  848. background. Otherwise the default is "light".
  849. The |:terminal| command and the |term_start()| function use the
  850. 'background' value to decide whether the terminal window will start
  851. with a white or black background.
  852. Normally this option would be set in the .vimrc file. Possibly
  853. depending on the terminal name. Example: >
  854. :if &term == "pcterm"
  855. : set background=dark
  856. :endif
  857. < When this option is set, the default settings for the highlight groups
  858. will change. To use other settings, place ":highlight" commands AFTER
  859. the setting of the 'background' option.
  860. This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
  861. to select the colors for syntax highlighting. After changing this
  862. option, you must load syntax.vim again to see the result. This can be
  863. done with ":syntax on".
  864. *'backspace'* *'bs'*
  865. 'backspace' 'bs' string (default "", set to "indent,eol,start"
  866. in |defaults.vim|)
  867. global
  868. Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
  869. mode. This is a list of items, separated by commas. Each item allows
  870. a way to backspace over something:
  871. value effect ~
  872. indent allow backspacing over autoindent
  873. eol allow backspacing over line breaks (join lines)
  874. start allow backspacing over the start of insert; CTRL-W and CTRL-U
  875. stop once at the start of insert.
  876. nostop like start, except CTRL-W and CTRL-U do not stop at the start of
  877. insert.
  878. When the value is empty, Vi compatible backspacing is used, none of
  879. the ways mentioned for the items above are possible.
  880. For backwards compatibility with version 5.4 and earlier:
  881. value effect ~
  882. 0 same as ":set backspace=" (Vi compatible)
  883. 1 same as ":set backspace=indent,eol"
  884. 2 same as ":set backspace=indent,eol,start"
  885. 3 same as ":set backspace=indent,eol,nostop"
  886. See |:fixdel| if your <BS> or <Del> key does not do what you want.
  887. NOTE: This option is set to "" when 'compatible' is set.
  888. *'backup'* *'bk'* *'nobackup'* *'nobk'*
  889. 'backup' 'bk' boolean (default off)
  890. global
  891. Make a backup before overwriting a file. Leave it around after the
  892. file has been successfully written. If you do not want to keep the
  893. backup file, but you do want a backup while the file is being
  894. written, reset this option and set the 'writebackup' option (this is
  895. the default). If you do not want a backup file at all reset both
  896. options (use this if your file system is almost full). See the
  897. |backup-table| for more explanations.
  898. When the 'backupskip' pattern matches, a backup is not made anyway.
  899. When 'patchmode' is set, the backup may be renamed to become the
  900. oldest version of a file.
  901. NOTE: This option is reset when 'compatible' is set.
  902. *'backupcopy'* *'bkc'*
  903. 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
  904. global or local to buffer |global-local|
  905. When writing a file and a backup is made, this option tells how it's
  906. done. This is a comma-separated list of words.
  907. The main values are:
  908. "yes" make a copy of the file and overwrite the original one
  909. "no" rename the file and write a new one
  910. "auto" one of the previous, what works best
  911. Extra values that can be combined with the ones above are:
  912. "breaksymlink" always break symlinks when writing
  913. "breakhardlink" always break hardlinks when writing
  914. Making a copy and overwriting the original file:
  915. - Takes extra time to copy the file.
  916. + When the file has special attributes, is a (hard/symbolic) link or
  917. has a resource fork, all this is preserved.
  918. - When the file is a link the backup will have the name of the link,
  919. not of the real file.
  920. Renaming the file and writing a new one:
  921. + It's fast.
  922. - Sometimes not all attributes of the file can be copied to the new
  923. file.
  924. - When the file is a link the new file will not be a link.
  925. The "auto" value is the middle way: When Vim sees that renaming the
  926. file is possible without side effects (the attributes can be passed on
  927. and the file is not a link) that is used. When problems are expected,
  928. a copy will be made.
  929. The "breaksymlink" and "breakhardlink" values can be used in
  930. combination with any of "yes", "no" and "auto". When included, they
  931. force Vim to always break either symbolic or hard links by doing
  932. exactly what the "no" option does, renaming the original file to
  933. become the backup and writing a new file in its place. This can be
  934. useful for example in source trees where all the files are symbolic or
  935. hard links and any changes should stay in the local source tree, not
  936. be propagated back to the original source.
  937. *crontab*
  938. One situation where "no" and "auto" will cause problems: A program
  939. that opens a file, invokes Vim to edit that file, and then tests if
  940. the open file was changed (through the file descriptor) will check the
  941. backup file instead of the newly created file. "crontab -e" is an
  942. example.
  943. When a copy is made, the original file is truncated and then filled
  944. with the new text. This means that protection bits, owner and
  945. symbolic links of the original file are unmodified. The backup file,
  946. however, is a new file, owned by the user who edited the file. The
  947. group of the backup is set to the group of the original file. If this
  948. fails, the protection bits for the group are made the same as for
  949. others.
  950. When the file is renamed, this is the other way around: The backup has
  951. the same attributes of the original file, and the newly written file
  952. is owned by the current user. When the file was a (hard/symbolic)
  953. link, the new file will not! That's why the "auto" value doesn't
  954. rename when the file is a link. The owner and group of the newly
  955. written file will be set to the same ones as the original file, but
  956. the system may refuse to do this. In that case the "auto" value will
  957. again not rename the file.
  958. NOTE: This option is set to the Vi default value when 'compatible' is
  959. set and to the Vim default value when 'compatible' is reset.
  960. *'backupdir'* *'bdir'*
  961. 'backupdir' 'bdir' string (default for Amiga: ".,t:",
  962. for Win32: ".,$TEMP,c:/tmp,c:/temp"
  963. for Unix: ".,~/tmp,~/")
  964. global
  965. List of directories for the backup file, separated with commas.
  966. - The backup file will be created in the first directory in the list
  967. where this is possible. The directory must exist, Vim will not
  968. create it for you.
  969. - Empty means that no backup file will be created ('patchmode' is
  970. impossible!). Writing may fail because of this.
  971. - A directory "." means to put the backup file in the same directory
  972. as the edited file.
  973. - A directory starting with "./" (or ".\" for MS-Windows) means to put
  974. the backup file relative to where the edited file is. The leading
  975. "." is replaced with the path name of the edited file.
  976. ("." inside a directory name has no special meaning).
  977. - Spaces after the comma are ignored, other spaces are considered part
  978. of the directory name. To have a space at the start of a directory
  979. name, precede it with a backslash.
  980. - To include a comma in a directory name precede it with a backslash.
  981. - A directory name may end in an '/'.
  982. - For Unix and Win32, if a directory ends in two path separators "//",
  983. the backup file name will be built from the complete path to the
  984. file with all path separators changed to percent '%' signs. This
  985. will ensure file name uniqueness in the backup directory.
  986. On Win32, it is also possible to end with "\\". However, When a
  987. separating comma is following, you must use "//", since "\\" will
  988. include the comma in the file name. Therefore it is recommended to
  989. use '//', instead of '\\'.
  990. - Environment variables are expanded |:set_env|.
  991. - Careful with '\' characters, type one before a space, type two to
  992. get one in the option (see |option-backslash|), for example: >
  993. :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  994. < - For backwards compatibility with Vim version 3.0 a '>' at the start
  995. of the option is removed.
  996. See also 'backup' and 'writebackup' options.
  997. If you want to hide your backup files on Unix, consider this value: >
  998. :set backupdir=./.backup,~/.backup,.,/tmp
  999. < You must create a ".backup" directory in each directory and in your
  1000. home directory for this to work properly.
  1001. The use of |:set+=| and |:set-=| is preferred when adding or removing
  1002. directories from the list. This avoids problems when a future version
  1003. uses another default.
  1004. This option cannot be set from a |modeline| or in the |sandbox|, for
  1005. security reasons.
  1006. *'backupext'* *'bex'* *E589*
  1007. 'backupext' 'bex' string (default "~", for VMS: "_")
  1008. global
  1009. String which is appended to a file name to make the name of the
  1010. backup file. The default is quite unusual, because this avoids
  1011. accidentally overwriting existing files with a backup file. You might
  1012. prefer using ".bak", but make sure that you don't have files with
  1013. ".bak" that you want to keep.
  1014. Only normal file name characters can be used; "/\*?[|<>" are illegal.
  1015. If you like to keep a lot of backups, you could use a BufWritePre
  1016. autocommand to change 'backupext' just before writing the file to
  1017. include a timestamp. >
  1018. :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
  1019. < Use 'backupdir' to put the backup in a different directory.
  1020. *'backupskip'* *'bsk'*
  1021. 'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
  1022. Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
  1023. Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
  1024. global
  1025. A list of file patterns. When one of the patterns matches with the
  1026. name of the file which is written, no backup file is created. Both
  1027. the specified file name and the full path name of the file are used.
  1028. The pattern is used like with |:autocmd|, see |autocmd-patterns|.
  1029. Watch out for special characters, see |option-backslash|.
  1030. When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
  1031. default value. "/tmp/*" is only used for Unix.
  1032. WARNING: Not having a backup file means that when Vim fails to write
  1033. your buffer correctly and then, for whatever reason, Vim exits, you
  1034. lose both the original file and what you were writing. Only disable
  1035. backups if you don't care about losing the file.
  1036. Note that environment variables are not expanded. If you want to use
  1037. $HOME you must expand it explicitly, e.g.: >
  1038. :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
  1039. < Note that the default also makes sure that "crontab -e" works (when a
  1040. backup would be made by renaming the original file crontab won't see
  1041. the newly created file). Also see 'backupcopy' and |crontab|.
  1042. *'balloondelay'* *'bdlay'*
  1043. 'balloondelay' 'bdlay' number (default: 600)
  1044. global
  1045. {only available when compiled with the |+balloon_eval|
  1046. feature}
  1047. Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
  1048. *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
  1049. 'ballooneval' 'beval' boolean (default off)
  1050. global
  1051. {only available when compiled with the |+balloon_eval|
  1052. feature}
  1053. Switch on the |balloon-eval| functionality for the GUI.
  1054. *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
  1055. *'nobevalterm'*
  1056. 'balloonevalterm' 'bevalterm' boolean (default off)
  1057. global
  1058. {only available when compiled with the
  1059. |+balloon_eval_term| feature}
  1060. Switch on the |balloon-eval| functionality for the terminal.
  1061. *'balloonexpr'* *'bexpr'*
  1062. 'balloonexpr' 'bexpr' string (default "")
  1063. global or local to buffer |global-local|
  1064. {only available when compiled with the |+balloon_eval|
  1065. feature}
  1066. Expression for text to show in evaluation balloon. It is only used
  1067. when 'ballooneval' or 'balloonevalterm' is on. These variables can be
  1068. used:
  1069. v:beval_bufnr number of the buffer in which balloon is going to show
  1070. v:beval_winnr number of the window
  1071. v:beval_winid ID of the window
  1072. v:beval_lnum line number
  1073. v:beval_col column number (byte index)
  1074. v:beval_text word under or after the mouse pointer
  1075. Instead of showing a balloon, which is limited to plain text, consider
  1076. using a popup window, see |popup_beval_example|. A popup window can
  1077. use highlighting and show a border.
  1078. The evaluation of the expression must not have side effects!
  1079. Example: >
  1080. function MyBalloonExpr()
  1081. return 'Cursor is at line ' .. v:beval_lnum ..
  1082. \ ', column ' .. v:beval_col ..
  1083. \ ' of file ' .. bufname(v:beval_bufnr) ..
  1084. \ ' on word "' .. v:beval_text .. '"'
  1085. endfunction
  1086. set bexpr=MyBalloonExpr()
  1087. set ballooneval
  1088. <
  1089. Also see |balloon_show()|, it can be used if the content of the balloon
  1090. is to be fetched asynchronously. In that case evaluating
  1091. 'balloonexpr' should result in an empty string. If you get a balloon
  1092. with only "0" you probably didn't return anything from your function.
  1093. NOTE: The balloon is displayed only if the cursor is on a text
  1094. character. If the result of evaluating 'balloonexpr' is not empty,
  1095. Vim does not try to send a message to an external debugger (Netbeans
  1096. or Sun Workshop).
  1097. If the expression starts with s: or |<SID>|, then it is replaced with
  1098. the script ID (|local-function|). Example: >
  1099. set bexpr=s:MyBalloonExpr()
  1100. set bexpr=<SID>SomeBalloonExpr()
  1101. < Otherwise, the expression is evaluated in the context of the script
  1102. where the option was set, thus script-local items are available.
  1103. The expression will be evaluated in the |sandbox| when set from a
  1104. modeline, see |sandbox-option|.
  1105. This option cannot be set in a modeline when 'modelineexpr' is off.
  1106. It is not allowed to change text or jump to another window while
  1107. evaluating 'balloonexpr', see |textlock|.
  1108. To check whether line breaks in the balloon text work use this check: >
  1109. if has("balloon_multiline")
  1110. < When they are supported "\n" characters will start a new line. If the
  1111. expression evaluates to a |List| this is equal to using each List item
  1112. as a string and putting "\n" in between them.
  1113. NOTE: This option is set to "" when 'compatible' is set.
  1114. *'belloff'* *'bo'*
  1115. 'belloff' 'bo' string (default "")
  1116. global
  1117. Specifies for which events the bell will not be rung. It is a comma
  1118. separated list of items. For each item that is present, the bell
  1119. will be silenced. This is most useful to specify specific events in
  1120. insert mode to be silenced.
  1121. You can also make it flash by using 'visualbell'.
  1122. item meaning when present ~
  1123. all All events.
  1124. backspace When hitting <BS> or <Del> and deleting results in an
  1125. error.
  1126. cursor Fail to move around using the cursor keys or
  1127. <PageUp>/<PageDown> in |Insert-mode|.
  1128. complete Error occurred when using |i_CTRL-X_CTRL-K| or
  1129. |i_CTRL-X_CTRL-T|.
  1130. copy Cannot copy char from insert mode using |i_CTRL-Y| or
  1131. |i_CTRL-E|.
  1132. ctrlg Unknown Char after <C-G> in Insert mode.
  1133. error Other Error occurred (e.g. try to join last line)
  1134. (mostly used in |Normal-mode| or |Cmdline-mode|).
  1135. esc hitting <Esc> in |Normal-mode|.
  1136. ex In |Visual-mode|, hitting |Q| results in an error.
  1137. hangul Ignored.
  1138. insertmode Pressing <Esc> in 'insertmode'.
  1139. lang Calling the beep module for Lua/Mzscheme/TCL.
  1140. mess No output available for |g<|.
  1141. showmatch Error occurred for 'showmatch' function.
  1142. operator Empty region error |cpo-E|.
  1143. register Unknown register after <C-R> in |Insert-mode|.
  1144. shell Bell from shell output |:!|.
  1145. spell Error happened on spell suggest.
  1146. term Bell from |:terminal| output.
  1147. wildmode More matches in |cmdline-completion| available
  1148. (depends on the 'wildmode' setting).
  1149. This is most useful to fine tune when in Insert mode the bell should
  1150. be rung. For Normal mode and Ex commands, the bell is often rung to
  1151. indicate that an error occurred. It can be silenced by adding the
  1152. "error" keyword.
  1153. *'binary'* *'bin'* *'nobinary'* *'nobin'*
  1154. 'binary' 'bin' boolean (default off)
  1155. local to buffer
  1156. This option should be set before editing a binary file. You can also
  1157. use the |-b| Vim argument. When this option is switched on a few
  1158. options will be changed (also when it already was on):
  1159. 'textwidth' will be set to 0
  1160. 'wrapmargin' will be set to 0
  1161. 'modeline' will be off
  1162. 'expandtab' will be off
  1163. Also, 'fileformat' and 'fileformats' options will not be used, the
  1164. file is read and written like 'fileformat' was "unix" (a single <NL>
  1165. separates lines).
  1166. The 'fileencoding' and 'fileencodings' options will not be used, the
  1167. file is read without conversion.
  1168. NOTE: When you start editing a(nother) file while the 'bin' option is
  1169. on, settings from autocommands may change the settings again (e.g.,
  1170. 'textwidth'), causing trouble when editing. You might want to set
  1171. 'bin' again when the file has been loaded.
  1172. The previous values of these options are remembered and restored when
  1173. 'bin' is switched from on to off. Each buffer has its own set of
  1174. saved option values.
  1175. To edit a file with 'binary' set you can use the |++bin| argument.
  1176. This avoids you have to do ":set bin", which would have effect for all
  1177. files you edit.
  1178. When writing a file the <EOL> for the last line is only written if
  1179. there was one in the original file (normally Vim appends an <EOL> to
  1180. the last line if there is none; this would make the file longer). See
  1181. the 'endofline' option.
  1182. *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
  1183. 'bioskey' 'biosk' boolean (default on)
  1184. global
  1185. {only for MS-DOS}
  1186. This was for MS-DOS and is no longer supported.
  1187. *'bomb'* *'nobomb'*
  1188. 'bomb' boolean (default off)
  1189. local to buffer
  1190. When writing a file and the following conditions are met, a BOM (Byte
  1191. Order Mark) is prepended to the file:
  1192. - this option is on
  1193. - the 'binary' option is off
  1194. - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
  1195. endian variants.
  1196. Some applications use the BOM to recognize the encoding of the file.
  1197. Often used for UCS-2 files on MS-Windows. For other applications it
  1198. causes trouble, for example: "cat file1 file2" makes the BOM of file2
  1199. appear halfway the resulting file. Gcc doesn't accept a BOM.
  1200. When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
  1201. check for the presence of the BOM is done and 'bomb' set accordingly.
  1202. Unless 'binary' is set, it is removed from the first line, so that you
  1203. don't see it when editing. When you don't change the options, the BOM
  1204. will be restored when writing the file.
  1205. *'breakat'* *'brk'*
  1206. 'breakat' 'brk' string (default " ^I!@*-+;:,./?")
  1207. global
  1208. {not available when compiled without the |+linebreak|
  1209. feature}
  1210. This option lets you choose which characters might cause a line
  1211. break if 'linebreak' is on. Only works for ASCII and also for 8-bit
  1212. characters when 'encoding' is an 8-bit encoding.
  1213. *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
  1214. 'breakindent' 'bri' boolean (default off)
  1215. local to window
  1216. {not available when compiled without the |+linebreak|
  1217. feature}
  1218. Every wrapped line will continue visually indented (same amount of
  1219. space as the beginning of that line), thus preserving horizontal blocks
  1220. of text.
  1221. NOTE: This option is reset when 'compatible' is set.
  1222. *'breakindentopt'* *'briopt'*
  1223. 'breakindentopt' 'briopt' string (default empty)
  1224. local to window
  1225. {not available when compiled without the |+linebreak|
  1226. feature}
  1227. Settings for 'breakindent'. It can consist of the following optional
  1228. items and must be separated by a comma:
  1229. min:{n} Minimum text width that will be kept after
  1230. applying 'breakindent', even if the resulting
  1231. text should normally be narrower. This prevents
  1232. text indented almost to the right window border
  1233. occupying lot of vertical space when broken.
  1234. (default: 20)
  1235. shift:{n} After applying 'breakindent', the wrapped line's
  1236. beginning will be shifted by the given number of
  1237. characters. It permits dynamic French paragraph
  1238. indentation (negative) or emphasizing the line
  1239. continuation (positive).
  1240. (default: 0)
  1241. sbr Display the 'showbreak' value before applying the
  1242. additional indent.
  1243. (default: off)
  1244. list:{n} Adds an additional indent for lines that match a
  1245. numbered or bulleted list (using the
  1246. 'formatlistpat' setting).
  1247. list:-1 Uses the length of a match with 'formatlistpat'
  1248. for indentation.
  1249. (default: 0)
  1250. column:{n} Indent at column {n}. Will overrule the other
  1251. sub-options. Note: an additional indent may be
  1252. added for the 'showbreak' setting.
  1253. (default: off)
  1254. *'browsedir'* *'bsdir'*
  1255. 'browsedir' 'bsdir' string (default: "last")
  1256. global
  1257. {only for Motif, GTK, Mac and Win32 GUI}
  1258. Which directory to use for the file browser:
  1259. last Use same directory as with last file browser, where a
  1260. file was opened or saved.
  1261. buffer Use the directory of the related buffer.
  1262. current Use the current directory.
  1263. {path} Use the specified directory
  1264. *'bufhidden'* *'bh'*
  1265. 'bufhidden' 'bh' string (default: "")
  1266. local to buffer
  1267. This option specifies what happens when a buffer is no longer
  1268. displayed in a window:
  1269. <empty> follow the global 'hidden' option
  1270. hide hide the buffer (don't unload it), even if 'hidden' is
  1271. not set
  1272. unload unload the buffer, even if 'hidden' is set; the
  1273. |:hide| command will also unload the buffer
  1274. delete delete the buffer from the buffer list, even if
  1275. 'hidden' is set; the |:hide| command will also delete
  1276. the buffer, making it behave like |:bdelete|
  1277. wipe wipe the buffer from the buffer list, even if
  1278. 'hidden' is set; the |:hide| command will also wipe
  1279. out the buffer, making it behave like |:bwipeout|
  1280. CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
  1281. are lost without a warning. Also, these values may break autocommands
  1282. that switch between buffers temporarily.
  1283. This option is used together with 'buftype' and 'swapfile' to specify
  1284. special kinds of buffers. See |special-buffers|.
  1285. *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
  1286. 'buflisted' 'bl' boolean (default: on)
  1287. local to buffer
  1288. When this option is set, the buffer shows up in the buffer list. If
  1289. it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
  1290. This option is reset by Vim for buffers that are only used to remember
  1291. a file name or marks. Vim sets it when starting to edit a buffer.
  1292. But not when moving to a buffer with ":buffer".
  1293. *'buftype'* *'bt'* *E382*
  1294. 'buftype' 'bt' string (default: "")
  1295. local to buffer
  1296. The value of this option specifies the type of a buffer:
  1297. <empty> normal buffer
  1298. nofile buffer which is not related to a file and will not be
  1299. written
  1300. nowrite buffer which will not be written
  1301. acwrite buffer which will always be written with BufWriteCmd
  1302. autocommands.
  1303. quickfix quickfix buffer, contains list of errors |:cwindow|
  1304. or list of locations |:lwindow|
  1305. help help buffer (you are not supposed to set this
  1306. manually)
  1307. terminal buffer for a |terminal| (you are not supposed to set
  1308. this manually)
  1309. prompt buffer where only the last line can be edited, meant
  1310. to be used by a plugin, see |prompt-buffer|
  1311. {only when compiled with the |+channel| feature}
  1312. popup buffer used in a popup window, see |popup|.
  1313. {only when compiled with the |+textprop| feature}
  1314. This option is used together with 'bufhidden' and 'swapfile' to
  1315. specify special kinds of buffers. See |special-buffers|.
  1316. Also see |win_gettype()|, which returns the type of the window.
  1317. Be careful with changing this option, it can have many side effects!
  1318. One such effect is that Vim will not check the timestamp of the file,
  1319. if the file is changed by another program this will not be noticed.
  1320. A "quickfix" buffer is only used for the error list and the location
  1321. list. This value is set by the |:cwindow| and |:lwindow| commands and
  1322. you are not supposed to change it.
  1323. "nofile" and "nowrite" buffers are similar:
  1324. both: The buffer is not to be written to disk, ":w" doesn't
  1325. work (":w filename" does work though).
  1326. both: The buffer is never considered to be |'modified'|.
  1327. There is no warning when the changes will be lost, for
  1328. example when you quit Vim.
  1329. both: A swap file is only created when using too much memory
  1330. (when 'swapfile' has been reset there is never a swap
  1331. file).
  1332. nofile only: The buffer name is fixed, it is not handled like a
  1333. file name. It is not modified in response to a |:cd|
  1334. command.
  1335. both: When using ":e bufname" and already editing "bufname"
  1336. the buffer is made empty and autocommands are
  1337. triggered as usual for |:edit|.
  1338. *E676*
  1339. "acwrite" implies that the buffer name is not related to a file, like
  1340. "nofile", but it will be written. Thus, in contrast to "nofile" and
  1341. "nowrite", ":w" does work and a modified buffer can't be abandoned
  1342. without saving. For writing there must be matching |BufWriteCmd|,
  1343. |FileWriteCmd| or |FileAppendCmd| autocommands.
  1344. *'casemap'* *'cmp'*
  1345. 'casemap' 'cmp' string (default: "internal,keepascii")
  1346. global
  1347. Specifies details about changing the case of letters. It may contain
  1348. these words, separated by a comma:
  1349. internal Use internal case mapping functions, the current
  1350. locale does not change the case mapping. This only
  1351. matters when 'encoding' is a Unicode encoding,
  1352. "latin1" or "iso-8859-15". When "internal" is
  1353. omitted, the towupper() and towlower() system library
  1354. functions are used when available.
  1355. keepascii For the ASCII characters (0x00 to 0x7f) use the US
  1356. case mapping, the current locale is not effective.
  1357. This probably only matters for Turkish.
  1358. *'cdhome'* *'cdh'*
  1359. 'cdhome' 'cdh' boolean (default: off)
  1360. global
  1361. When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
  1362. current working directory to the |$HOME| directory like in Unix.
  1363. When off, those commands just print the current directory name.
  1364. On Unix this option has no effect.
  1365. NOTE: This option is reset when 'compatible' is set.
  1366. *'cdpath'* *'cd'* *E344* *E346*
  1367. 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
  1368. global
  1369. This is a list of directories which will be searched when using the
  1370. |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
  1371. searched for has a relative path, not an absolute part starting with
  1372. "/", "./" or "../", the 'cdpath' option is not used then.
  1373. The 'cdpath' option's value has the same form and semantics as
  1374. |'path'|. Also see |file-searching|.
  1375. The default value is taken from $CDPATH, with a "," prepended to look
  1376. in the current directory first.
  1377. If the default value taken from $CDPATH is not what you want, include
  1378. a modified version of the following command in your vimrc file to
  1379. override it: >
  1380. :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
  1381. < This option cannot be set from a |modeline| or in the |sandbox|, for
  1382. security reasons.
  1383. (parts of 'cdpath' can be passed to the shell to expand file names).
  1384. *'cedit'*
  1385. 'cedit' string (Vi default: "", Vim default: CTRL-F)
  1386. global
  1387. The key used in Command-line Mode to open the command-line window.
  1388. The default is CTRL-F when 'compatible' is off.
  1389. Only non-printable keys are allowed.
  1390. The key can be specified as a single character, but it is difficult to
  1391. type. The preferred way is to use the <> notation. Examples: >
  1392. :exe "set cedit=\<C-Y>"
  1393. :exe "set cedit=\<Esc>"
  1394. < |Nvi| also has this option, but it only uses the first character.
  1395. See |cmdwin|.
  1396. NOTE: This option is set to the Vim default value when 'compatible'
  1397. is reset.
  1398. *'charconvert'* *'ccv'* *E202* *E214* *E513*
  1399. 'charconvert' 'ccv' string (default "")
  1400. global
  1401. {only available when compiled with the |+eval| feature}
  1402. An expression that is used for character encoding conversion. It is
  1403. evaluated when a file that is to be read or has been written has a
  1404. different encoding from what is desired.
  1405. 'charconvert' is not used when the internal iconv() function is
  1406. supported and is able to do the conversion. Using iconv() is
  1407. preferred, because it is much faster.
  1408. 'charconvert' is not used when reading stdin |--|, because there is no
  1409. file to convert from. You will have to save the text in a file first.
  1410. The expression must return zero, false or an empty string for success,
  1411. non-zero or true for failure.
  1412. The possible encoding names encountered are in 'encoding'.
  1413. Additionally, names given in 'fileencodings' and 'fileencoding' are
  1414. used.
  1415. Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
  1416. is done internally by Vim, 'charconvert' is not used for this.
  1417. 'charconvert' is also used to convert the viminfo file, if the 'c'
  1418. flag is present in 'viminfo'. Also used for Unicode conversion.
  1419. Example: >
  1420. set charconvert=CharConvert()
  1421. fun CharConvert()
  1422. system("recode "
  1423. \ .. v:charconvert_from .. ".." .. v:charconvert_to
  1424. \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
  1425. return v:shell_error
  1426. endfun
  1427. < The related Vim variables are:
  1428. v:charconvert_from name of the current encoding
  1429. v:charconvert_to name of the desired encoding
  1430. v:fname_in name of the input file
  1431. v:fname_out name of the output file
  1432. Note that v:fname_in and v:fname_out will never be the same.
  1433. Note that v:charconvert_from and v:charconvert_to may be different
  1434. from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
  1435. The advantage of using a function call without arguments is that it is
  1436. faster, see |expr-option-function|.
  1437. Encryption is not done by Vim when using 'charconvert'. If you want
  1438. to encrypt the file after conversion, 'charconvert' should take care
  1439. of this.
  1440. If the 'charconvert' expression starts with s: or |<SID>|, then it is
  1441. replaced with the script ID (|local-function|). Example: >
  1442. set charconvert=s:MyConvert()
  1443. set charconvert=<SID>SomeConvert()
  1444. < Otherwise the expression is evaluated in the context of the script
  1445. where the option was set, thus script-local items are available.
  1446. This option cannot be set from a |modeline| or in the |sandbox|, for
  1447. security reasons.
  1448. *'cindent'* *'cin'* *'nocindent'* *'nocin'*
  1449. 'cindent' 'cin' boolean (default off)
  1450. local to buffer
  1451. Enables automatic C program indenting. See 'cinkeys' to set the keys
  1452. that trigger reindenting in insert mode and 'cinoptions' to set your
  1453. preferred indent style.
  1454. If 'indentexpr' is not empty, it overrules 'cindent'.
  1455. If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
  1456. the "=" operator indents using this algorithm rather than calling an
  1457. external program.
  1458. See |C-indenting|.
  1459. When you don't like the way 'cindent' works, try the 'smartindent'
  1460. option or 'indentexpr'.
  1461. This option is not used when 'paste' is set.
  1462. NOTE: This option is reset when 'compatible' is set.
  1463. *'cinkeys'* *'cink'*
  1464. 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
  1465. local to buffer
  1466. A list of keys that, when typed in Insert mode, cause reindenting of
  1467. the current line. Only used if 'cindent' is on and 'indentexpr' is
  1468. empty.
  1469. For the format of this option see |cinkeys-format|.
  1470. See |C-indenting|.
  1471. *'cinoptions'* *'cino'*
  1472. 'cinoptions' 'cino' string (default "")
  1473. local to buffer
  1474. The 'cinoptions' affect the way 'cindent' reindents lines in a C
  1475. program. See |cinoptions-values| for the values of this option, and
  1476. |C-indenting| for info on C indenting in general.
  1477. *'cinwords'* *'cinw'*
  1478. 'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
  1479. local to buffer
  1480. These keywords start an extra indent in the next line when
  1481. 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
  1482. an appropriate place (inside {}).
  1483. Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
  1484. matter, include the keyword both the uppercase and lowercase:
  1485. "if,If,IF".
  1486. *'cinscopedecls'* *'cinsd'*
  1487. 'cinscopedecls' 'cinsd' string (default "public,protected,private")
  1488. local to buffer
  1489. Keywords that are interpreted as a C++ scope declaration by |cino-g|.
  1490. Useful e.g. for working with the Qt framework that defines additional
  1491. scope declarations "signals", "public slots" and "private slots": >
  1492. set cinscopedecls+=signals,public\ slots,private\ slots
  1493. < *'clipboard'* *'cb'*
  1494. 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
  1495. for X-windows, "" otherwise)
  1496. global
  1497. {only in GUI versions or when the |+xterm_clipboard|
  1498. feature is included}
  1499. This option is a list of comma-separated names.
  1500. Note: if one of the items is "exclude:", then you can't add an item
  1501. after that. Therefore do not append an item with += but use ^= to
  1502. prepend, e.g.: >
  1503. set clipboard^=unnamed
  1504. < When using the GUI see |'go-A'|.
  1505. These names are recognized:
  1506. *clipboard-unnamed*
  1507. unnamed When included, Vim will use the clipboard register '*'
  1508. for all yank, delete, change and put operations which
  1509. would normally go to the unnamed register. When a
  1510. register is explicitly specified, it will always be
  1511. used regardless of whether "unnamed" is in 'clipboard'
  1512. or not. The clipboard register can always be
  1513. explicitly accessed using the "* notation. Also see
  1514. |gui-clipboard|.
  1515. *clipboard-unnamedplus*
  1516. unnamedplus A variant of the "unnamed" flag which uses the
  1517. clipboard register '+' (|quoteplus|) instead of
  1518. register '*' for all yank, delete, change and put
  1519. operations which would normally go to the unnamed
  1520. register. When "unnamed" is also included to the
  1521. option, yank operations (but not delete, change or
  1522. put) will additionally copy the text into register
  1523. '*'.
  1524. Only available with the |+X11| feature.
  1525. Availability can be checked with: >
  1526. if has('unnamedplus')
  1527. <
  1528. *clipboard-autoselect*
  1529. autoselect Works like the 'a' flag in 'guioptions': If present,
  1530. then whenever Visual mode is started, or the Visual
  1531. area extended, Vim tries to become the owner of the
  1532. windowing system's global selection or put the
  1533. selected text on the clipboard used by the selection
  1534. register "*. See |'go-a'| and |quotestar| for details.
  1535. When the GUI is active, the 'a' flag in 'guioptions'
  1536. is used, when the GUI is not active, this "autoselect"
  1537. flag is used.
  1538. Also applies to the modeless selection.
  1539. *clipboard-autoselectplus*
  1540. autoselectplus Like "autoselect" but using the + register instead of
  1541. the * register. Compare to the 'P' flag in
  1542. 'guioptions'.
  1543. *clipboard-autoselectml*
  1544. autoselectml Like "autoselect", but for the modeless selection
  1545. only. Compare to the 'A' flag in 'guioptions'.
  1546. *clipboard-html*
  1547. html When the clipboard contains HTML, use this when
  1548. pasting. When putting text on the clipboard, mark it
  1549. as HTML. This works to copy rendered HTML from
  1550. Firefox, paste it as raw HTML in Vim, select the HTML
  1551. in Vim and paste it in a rich edit box in Firefox.
  1552. You probably want to add this only temporarily,
  1553. possibly use BufEnter autocommands.
  1554. Only supported for GTK version 2 and later.
  1555. *clipboard-exclude*
  1556. exclude:{pattern}
  1557. Defines a pattern that is matched against the name of
  1558. the terminal 'term'. If there is a match, no
  1559. connection will be made to the X server. This is
  1560. useful in this situation:
  1561. - Running Vim in a console.
  1562. - $DISPLAY is set to start applications on another
  1563. display.
  1564. - You do not want to connect to the X server in the
  1565. console, but do want this in a terminal emulator.
  1566. To never connect to the X server use: >
  1567. exclude:.*
  1568. < This has the same effect as using the |-X| argument.
  1569. Note that when there is no connection to the X server
  1570. the window title won't be restored and the clipboard
  1571. cannot be accessed.
  1572. The value of 'magic' is ignored, {pattern} is
  1573. interpreted as if 'magic' was on.
  1574. The rest of the option value will be used for
  1575. {pattern}, this must be the last entry.
  1576. *'cmdheight'* *'ch'*
  1577. 'cmdheight' 'ch' number (default 1)
  1578. global or local to tab page
  1579. Number of screen lines to use for the command-line. A larger value
  1580. helps avoiding |hit-enter| prompts.
  1581. The value of this option is stored with the tab page, so that each tab
  1582. page can have a different value.
  1583. *'cmdwinheight'* *'cwh'*
  1584. 'cmdwinheight' 'cwh' number (default 7)
  1585. global
  1586. Number of screen lines to use for the command-line window. |cmdwin|
  1587. *'colorcolumn'* *'cc'*
  1588. 'colorcolumn' 'cc' string (default "")
  1589. local to window
  1590. {not available when compiled without the |+syntax|
  1591. feature}
  1592. 'colorcolumn' is a comma-separated list of screen columns that are
  1593. highlighted with ColorColumn |hl-ColorColumn|. Useful to align
  1594. text. Will make screen redrawing slower.
  1595. The screen column can be an absolute number, or a number preceded with
  1596. '+' or '-', which is added to or subtracted from 'textwidth'. >
  1597. :set cc=+1 " highlight column after 'textwidth'
  1598. :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
  1599. :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
  1600. <
  1601. When 'textwidth' is zero then the items with '-' and '+' are not used.
  1602. A maximum of 256 columns are highlighted.
  1603. *'columns'* *'co'* *E594*
  1604. 'columns' 'co' number (default 80 or terminal width)
  1605. global
  1606. Number of columns of the screen. Normally this is set by the terminal
  1607. initialization and does not have to be set by hand. Also see
  1608. |posix-screen-size|.
  1609. When Vim is running in the GUI or in a resizable window, setting this
  1610. option will cause the window size to be changed. When you only want
  1611. to use the size for the GUI, put the command in your |gvimrc| file.
  1612. When you set this option and Vim is unable to change the physical
  1613. number of columns of the display, the display may be messed up. For
  1614. the GUI it is always possible and Vim limits the number of columns to
  1615. what fits on the screen. You can use this command to get the widest
  1616. window possible: >
  1617. :set columns=9999
  1618. < Minimum value is 12, maximum value is 10000.
  1619. *'comments'* *'com'* *E524* *E525*
  1620. 'comments' 'com' string (default
  1621. "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
  1622. local to buffer
  1623. A comma-separated list of strings that can start a comment line. See
  1624. |format-comments|. See |option-backslash| about using backslashes to
  1625. insert a space.
  1626. *'commentstring'* *'cms'* *E537*
  1627. 'commentstring' 'cms' string (default "/*%s*/")
  1628. local to buffer
  1629. {not available when compiled without the |+folding|
  1630. feature}
  1631. A template for a comment. The "%s" in the value is replaced with the
  1632. comment text. Currently only used to add markers for folding, see
  1633. |fold-marker|.
  1634. *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
  1635. 'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
  1636. file is found, reset in |defaults.vim|)
  1637. global
  1638. This option has the effect of making Vim either more Vi-compatible, or
  1639. make Vim behave in a more useful way.
  1640. This is a special kind of option, because when it's set or reset,
  1641. other options are also changed as a side effect.
  1642. NOTE: Setting or resetting this option can have a lot of unexpected
  1643. effects: Mappings are interpreted in another way, undo behaves
  1644. differently, etc. If you set this option in your vimrc file, you
  1645. should probably put it at the very start.
  1646. By default this option is on and the Vi defaults are used for the
  1647. options. This default was chosen for those people who want to use Vim
  1648. just like Vi, and don't even (want to) know about the 'compatible'
  1649. option.
  1650. When a |vimrc| or |gvimrc| file is found while Vim is starting up,
  1651. this option is switched off, and all options that have not been
  1652. modified will be set to the Vim defaults. Effectively, this means
  1653. that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
  1654. defaults, otherwise it will use the Vi defaults. (Note: This doesn't
  1655. happen for the system-wide vimrc or gvimrc file, nor for a file given
  1656. with the |-u| argument). Also see |compatible-default| and
  1657. |posix-compliance|.
  1658. You can also set this option with the "-C" argument, and reset it with
  1659. "-N". See |-C| and |-N|.
  1660. See 'cpoptions' for more fine tuning of Vi compatibility.
  1661. When this option is set, numerous other options are set to make Vim as
  1662. Vi-compatible as possible. When this option is unset, various options
  1663. are set to make Vim more useful. The table below lists all the
  1664. options affected.
  1665. The {?} column indicates when the options are affected:
  1666. + Means that the option is set to the value given in {set value} when
  1667. 'compatible' is set.
  1668. & Means that the option is set to the value given in {set value} when
  1669. 'compatible' is set AND is set to its Vim default value when
  1670. 'compatible' is unset.
  1671. - Means the option is NOT changed when setting 'compatible' but IS
  1672. set to its Vim default when 'compatible' is unset.
  1673. The {effect} column summarises the change when 'compatible' is set.
  1674. option ? set value effect ~
  1675. 'allowrevins' + off no CTRL-_ command
  1676. 'antialias' + off don't use antialiased fonts
  1677. 'arabic' + off reset arabic-related options
  1678. 'arabicshape' + on correct character shapes
  1679. 'backspace' + "" normal backspace
  1680. 'backup' + off no backup file
  1681. 'backupcopy' & Unix: "yes" backup file is a copy
  1682. else: "auto" copy or rename backup file
  1683. 'balloonexpr' + "" text to show in evaluation balloon
  1684. 'breakindent' + off don't indent when wrapping lines
  1685. 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
  1686. 'cdhome' + off ":cd" don't chdir to home on non-Unix
  1687. 'cindent' + off no C code indentation
  1688. 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
  1689. 'copyindent' + off don't copy indent structure
  1690. 'cpoptions' & (all flags) Vi-compatible flags
  1691. 'cscopepathcomp'+ 0 don't show directories in tags list
  1692. 'cscoperelative'+ off don't use basename of path as prefix
  1693. 'cscopetag' + off don't use cscope for ":tag"
  1694. 'cscopetagorder'+ 0 see |cscopetagorder|
  1695. 'cscopeverbose' + off see |cscopeverbose|
  1696. 'delcombine' + off unicode: delete whole char combination
  1697. 'digraph' + off no digraphs
  1698. 'esckeys' & off no <Esc>-keys in Insert mode
  1699. 'expandtab' + off tabs not expanded to spaces
  1700. 'fileformats' & "" no automatic file format detection,
  1701. "dos,unix" except for MS-Windows
  1702. 'formatexpr' + "" use 'formatprg' for auto-formatting
  1703. 'formatoptions' & "vt" Vi compatible formatting
  1704. 'gdefault' + off no default 'g' flag for ":s"
  1705. 'history' & 0 no commandline history
  1706. 'hkmap' + off no Hebrew keyboard mapping
  1707. 'hkmapp' + off no phonetic Hebrew keyboard mapping
  1708. 'hlsearch' + off no highlighting of search matches
  1709. 'incsearch' + off no incremental searching
  1710. 'indentexpr' + "" no indenting by expression
  1711. 'insertmode' + off do not start in Insert mode
  1712. 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
  1713. characters and '_'
  1714. 'joinspaces' + on insert 2 spaces after period
  1715. 'modeline' & off no modelines
  1716. 'more' & off no pauses in listings
  1717. 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
  1718. 'numberwidth' & 8 min number of columns for line number
  1719. 'preserveindent'+ off don't preserve current indent structure
  1720. when changing it
  1721. 'revins' + off no reverse insert
  1722. 'ruler' + off no ruler
  1723. 'scrolljump' + 1 no jump scroll
  1724. 'scrolloff' + 0 no scroll offset
  1725. 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
  1726. 'shiftround' + off indent not rounded to shiftwidth
  1727. 'shortmess' & "S" no shortening of messages
  1728. 'showcmd' & off command characters not shown
  1729. 'showmode' & off current mode not shown
  1730. 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
  1731. 'smartcase' + off no automatic ignore case switch
  1732. 'smartindent' + off no smart indentation
  1733. 'smarttab' + off no smart tab size
  1734. 'softtabstop' + 0 tabs are always 'tabstop' positions
  1735. 'startofline' + on goto startofline with some commands
  1736. 'tagcase' & "followic" 'ignorecase' when searching tags file
  1737. 'tagrelative' & off tag file names are not relative
  1738. 'termguicolors' + off don't use highlight-(guifg|guibg)
  1739. 'textauto' & off no automatic textmode detection
  1740. 'textwidth' + 0 no automatic line wrap
  1741. 'tildeop' + off tilde is not an operator
  1742. 'ttimeout' + off no terminal timeout
  1743. 'undofile' + off don't use an undo file
  1744. 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
  1745. 'virtualedit' + "" cursor can only be placed on characters
  1746. 'whichwrap' & "" left-right movements don't wrap
  1747. 'wildchar' & CTRL-E only when the current value is <Tab>
  1748. use CTRL-E for cmdline completion
  1749. 'writebackup' + on or off depends on the |+writebackup| feature
  1750. *'complete'* *'cpt'* *E535*
  1751. 'complete' 'cpt' string (default: ".,w,b,u,t,i")
  1752. local to buffer
  1753. This option specifies how keyword completion |ins-completion| works
  1754. when CTRL-P or CTRL-N are used. It is also used for whole-line
  1755. completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
  1756. and the places to scan. It is a comma-separated list of flags:
  1757. . scan the current buffer ('wrapscan' is ignored)
  1758. w scan buffers from other windows
  1759. b scan other loaded buffers that are in the buffer list
  1760. u scan the unloaded buffers that are in the buffer list
  1761. U scan the buffers that are not in the buffer list
  1762. k scan the files given with the 'dictionary' option
  1763. kspell use the currently active spell checking |spell|
  1764. k{dict} scan the file {dict}. Several "k" flags can be given,
  1765. patterns are valid too. For example: >
  1766. :set cpt=k/usr/dict/*,k~/spanish
  1767. < s scan the files given with the 'thesaurus' option
  1768. s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
  1769. are valid too.
  1770. i scan current and included files
  1771. d scan current and included files for defined name or macro
  1772. |i_CTRL-X_CTRL-D|
  1773. ] tag completion
  1774. t same as "]"
  1775. Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
  1776. not executed, this may lead to unexpected completions from some files
  1777. (gzipped files for example). Unloaded buffers are not scanned for
  1778. whole-line completion.
  1779. The default is ".,w,b,u,t,i", which means to scan:
  1780. 1. the current buffer
  1781. 2. buffers in other windows
  1782. 3. other loaded buffers
  1783. 4. unloaded buffers
  1784. 5. tags
  1785. 6. included files
  1786. As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
  1787. based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
  1788. |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
  1789. *'completefunc'* *'cfu'*
  1790. 'completefunc' 'cfu' string (default: empty)
  1791. local to buffer
  1792. {not available when compiled without the |+eval|
  1793. feature}
  1794. This option specifies a function to be used for Insert mode completion
  1795. with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
  1796. See |complete-functions| for an explanation of how the function is
  1797. invoked and what it should return. The value can be the name of a
  1798. function, a |lambda| or a |Funcref|. See |option-value-function| for
  1799. more information.
  1800. This option cannot be set from a |modeline| or in the |sandbox|, for
  1801. security reasons.
  1802. *'completeslash'* *'csl'*
  1803. 'completeslash' 'csl' string (default: "")
  1804. local to buffer
  1805. {only for MS-Windows}
  1806. When this option is set it overrules 'shellslash' for completion:
  1807. - When this option is set to "slash", a forward slash is used for path
  1808. completion in insert mode. This is useful when editing HTML tag, or
  1809. Makefile with 'noshellslash' on MS-Windows.
  1810. - When this option is set to "backslash", backslash is used. This is
  1811. useful when editing a batch file with 'shellslash' set on MS-Windows.
  1812. - When this option is empty, same character is used as for
  1813. 'shellslash'.
  1814. For Insert mode completion the buffer-local value is used. For
  1815. command line completion the global value is used.
  1816. *'completeopt'* *'cot'*
  1817. 'completeopt' 'cot' string (default: "menu,preview")
  1818. global
  1819. A comma-separated list of options for Insert mode completion
  1820. |ins-completion|. The supported values are:
  1821. menu Use a popup menu to show the possible completions. The
  1822. menu is only shown when there is more than one match and
  1823. sufficient colors are available. |ins-completion-menu|
  1824. menuone Use the popup menu also when there is only one match.
  1825. Useful when there is additional information about the
  1826. match, e.g., what file it comes from.
  1827. longest Only insert the longest common text of the matches. If
  1828. the menu is displayed you can use CTRL-L to add more
  1829. characters. Whether case is ignored depends on the kind
  1830. of completion. For buffer text the 'ignorecase' option is
  1831. used.
  1832. preview Show extra information about the currently selected
  1833. completion in the preview window. Only works in
  1834. combination with "menu" or "menuone".
  1835. popup Show extra information about the currently selected
  1836. completion in a popup window. Only works in combination
  1837. with "menu" or "menuone". Overrides "preview".
  1838. See |'completepopup'| for specifying properties.
  1839. {only works when compiled with the |+textprop| feature}
  1840. popuphidden
  1841. Just like "popup" but initially hide the popup. Use a
  1842. |CompleteChanged| autocommand to fetch the info and call
  1843. |popup_show()| once the popup has been filled.
  1844. See the example at |complete-popuphidden|.
  1845. {only works when compiled with the |+textprop| feature}
  1846. noinsert Do not insert any text for a match until the user selects
  1847. a match from the menu. Only works in combination with
  1848. "menu" or "menuone". No effect if "longest" is present.
  1849. noselect Do not select a match in the menu, force the user to
  1850. select one from the menu. Only works in combination with
  1851. "menu" or "menuone".
  1852. *'completepopup'* *'cpp'*
  1853. 'completepopup' 'cpp' string (default empty)
  1854. global
  1855. {not available when compiled without the |+textprop|
  1856. or |+quickfix| feature}
  1857. When 'completeopt' contains "popup" then this option is used for the
  1858. properties of the info popup when it is created. If an info popup
  1859. window already exists it is closed, so that the option value is
  1860. applied when it is created again.
  1861. You can also use |popup_findinfo()| and then set properties for an
  1862. existing info popup with |popup_setoptions()|. See |complete-popup|.
  1863. *'concealcursor'* *'cocu'*
  1864. 'concealcursor' 'cocu' string (default: "")
  1865. local to window
  1866. {not available when compiled without the |+conceal|
  1867. feature}
  1868. Sets the modes in which text in the cursor line can also be concealed.
  1869. When the current mode is listed then concealing happens just like in
  1870. other lines.
  1871. n Normal mode
  1872. v Visual mode
  1873. i Insert mode
  1874. c Command line editing, for 'incsearch'
  1875. 'v' applies to all lines in the Visual area, not only the cursor.
  1876. A useful value is "nc". This is used in help files. So long as you
  1877. are moving around text is concealed, but when starting to insert text
  1878. or selecting a Visual area the concealed text is displayed, so that
  1879. you can see what you are doing.
  1880. Keep in mind that the cursor position is not always where it's
  1881. displayed. E.g., when moving vertically it may change column.
  1882. *'conceallevel'* *'cole'*
  1883. 'conceallevel' 'cole' number (default 0)
  1884. local to window
  1885. {not available when compiled without the |+conceal|
  1886. feature}
  1887. Determine how text with the "conceal" syntax attribute |:syn-conceal|
  1888. is shown:
  1889. Value Effect ~
  1890. 0 Text is shown normally
  1891. 1 Each block of concealed text is replaced with one
  1892. character. If the syntax item does not have a custom
  1893. replacement character defined (see |:syn-cchar|) the
  1894. character defined in 'listchars' is used (default is a
  1895. space).
  1896. It is highlighted with the "Conceal" highlight group.
  1897. 2 Concealed text is completely hidden unless it has a
  1898. custom replacement character defined (see
  1899. |:syn-cchar|).
  1900. 3 Concealed text is completely hidden.
  1901. Note: in the cursor line concealed text is not hidden, so that you can
  1902. edit and copy the text. This can be changed with the 'concealcursor'
  1903. option.
  1904. *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
  1905. 'confirm' 'cf' boolean (default off)
  1906. global
  1907. When 'confirm' is on, certain operations that would normally
  1908. fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
  1909. instead raise a |dialog| asking if you wish to save the current
  1910. file(s). You can still use a ! to unconditionally |abandon| a buffer.
  1911. If 'confirm' is off you can still activate confirmation for one
  1912. command only (this is most useful in mappings) with the |:confirm|
  1913. command.
  1914. Also see the |confirm()| function and the 'v' flag in 'guioptions'.
  1915. *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
  1916. 'conskey' 'consk' boolean (default off)
  1917. global
  1918. This was for MS-DOS and is no longer supported.
  1919. *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
  1920. 'copyindent' 'ci' boolean (default off)
  1921. local to buffer
  1922. Copy the structure of the existing lines indent when autoindenting a
  1923. new line. Normally the new indent is reconstructed by a series of
  1924. tabs followed by spaces as required (unless |'expandtab'| is enabled,
  1925. in which case only spaces are used). Enabling this option makes the
  1926. new line copy whatever characters were used for indenting on the
  1927. existing line. 'expandtab' has no effect on these characters, a Tab
  1928. remains a Tab. If the new indent is greater than on the existing
  1929. line, the remaining space is filled in the normal manner.
  1930. NOTE: This option is reset when 'compatible' is set.
  1931. Also see 'preserveindent'.
  1932. *'cpoptions'* *'cpo'* *cpo*
  1933. 'cpoptions' 'cpo' string (Vim default: "aABceFs",
  1934. Vi default: all flags)
  1935. global
  1936. A sequence of single character flags. When a character is present
  1937. this indicates Vi-compatible behavior. This is used for things where
  1938. not being Vi-compatible is mostly or sometimes preferred.
  1939. 'cpoptions' stands for "compatible-options".
  1940. Commas can be added for readability.
  1941. To avoid problems with flags that are added in the future, use the
  1942. "+=" and "-=" feature of ":set" |add-option-flags|.
  1943. NOTE: This option is set to the Vi default value when 'compatible' is
  1944. set and to the Vim default value when 'compatible' is reset.
  1945. NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
  1946. is saved, 'cpoptions' is set to the Vim default, and the saved value
  1947. is restored at the end of the script. Changes to the value of
  1948. 'cpoptions' will be applied to the saved value, but keep in mind that
  1949. removing a flag that is not present when 'cpoptions' is changed has no
  1950. effect. In the |.vimrc| file the value is not restored, thus using
  1951. `vim9script` in the |.vimrc| file results in using the Vim default.
  1952. NOTE: This option is set to the POSIX default value at startup when
  1953. the Vi default value would be used and the $VIM_POSIX environment
  1954. variable exists |posix|. This means Vim tries to behave like the
  1955. POSIX specification.
  1956. contains behavior ~
  1957. *cpo-a*
  1958. a When included, a ":read" command with a file name
  1959. argument will set the alternate file name for the
  1960. current window.
  1961. *cpo-A*
  1962. A When included, a ":write" command with a file name
  1963. argument will set the alternate file name for the
  1964. current window.
  1965. *cpo-b*
  1966. b "\|" in a ":map" command is recognized as the end of
  1967. the map command. The '\' is included in the mapping,
  1968. the text after the '|' is interpreted as the next
  1969. command. Use a CTRL-V instead of a backslash to
  1970. include the '|' in the mapping. Applies to all
  1971. mapping, abbreviation, menu and autocmd commands.
  1972. See also |map_bar|.
  1973. *cpo-B*
  1974. B A backslash has no special meaning in mappings,
  1975. abbreviations, user commands and the "to" part of the
  1976. menu commands. Remove this flag to be able to use a
  1977. backslash like a CTRL-V. For example, the command
  1978. ":map X \<Esc>" results in X being mapped to:
  1979. 'B' included: "\^[" (^[ is a real <Esc>)
  1980. 'B' excluded: "<Esc>" (5 characters)
  1981. ('<' excluded in both cases)
  1982. *cpo-c*
  1983. c Searching continues at the end of any match at the
  1984. cursor position, but not further than the start of the
  1985. next line. When not present searching continues
  1986. one character from the cursor position. With 'c'
  1987. "abababababab" only gets three matches when repeating
  1988. "/abab", without 'c' there are five matches.
  1989. *cpo-C*
  1990. C Do not concatenate sourced lines that start with a
  1991. backslash. See |line-continuation|.
  1992. *cpo-d*
  1993. d Using "./" in the 'tags' option doesn't mean to use
  1994. the tags file relative to the current file, but the
  1995. tags file in the current directory.
  1996. *cpo-D*
  1997. D Can't use CTRL-K to enter a digraph after Normal mode
  1998. commands with a character argument, like |r|, |f| and
  1999. |t|.
  2000. *cpo-e*
  2001. e When executing a register with ":@r", always add a
  2002. <CR> to the last line, also when the register is not
  2003. linewise. If this flag is not present, the register
  2004. is not linewise and the last line does not end in a
  2005. <CR>, then the last line is put on the command-line
  2006. and can be edited before hitting <CR>.
  2007. *cpo-E*
  2008. E It is an error when using "y", "d", "c", "g~", "gu" or
  2009. "gU" on an Empty region. The operators only work when
  2010. at least one character is to be operated on. Example:
  2011. This makes "y0" fail in the first column.
  2012. *cpo-f*
  2013. f When included, a ":read" command with a file name
  2014. argument will set the file name for the current buffer,
  2015. if the current buffer doesn't have a file name yet.
  2016. *cpo-F*
  2017. F When included, a ":write" command with a file name
  2018. argument will set the file name for the current
  2019. buffer, if the current buffer doesn't have a file name
  2020. yet. Also see |cpo-P|.
  2021. *cpo-g*
  2022. g Goto line 1 when using ":edit" without argument.
  2023. *cpo-H*
  2024. H When using "I" on a line with only blanks, insert
  2025. before the last blank. Without this flag insert after
  2026. the last blank.
  2027. *cpo-i*
  2028. i When included, interrupting the reading of a file will
  2029. leave it modified.
  2030. *cpo-I*
  2031. I When moving the cursor up or down just after inserting
  2032. indent for 'autoindent', do not delete the indent.
  2033. *cpo-j*
  2034. j When joining lines, only add two spaces after a '.',
  2035. not after '!' or '?'. Also see 'joinspaces'.
  2036. *cpo-J*
  2037. J A |sentence| has to be followed by two spaces after
  2038. the '.', '!' or '?'. A <Tab> is not recognized as
  2039. white space.
  2040. *cpo-k*
  2041. k Disable the recognition of raw key codes in
  2042. mappings, abbreviations, and the "to" part of menu
  2043. commands. For example, if <Key> sends ^[OA (where ^[
  2044. is <Esc>), the command ":map X ^[OA" results in X
  2045. being mapped to:
  2046. 'k' included: "^[OA" (3 characters)
  2047. 'k' excluded: "<Key>" (one key code)
  2048. Also see the '<' flag below.
  2049. *cpo-K*
  2050. K Don't wait for a key code to complete when it is
  2051. halfway a mapping. This breaks mapping <F1><F1> when
  2052. only part of the second <F1> has been read. It
  2053. enables cancelling the mapping by typing <F1><Esc>.
  2054. *cpo-l*
  2055. l Backslash in a [] range in a search pattern is taken
  2056. literally, only "\]", "\^", "\-" and "\\" are special.
  2057. See |/[]|
  2058. 'l' included: "/[ \t]" finds <Space>, '\' and 't'
  2059. 'l' excluded: "/[ \t]" finds <Space> and <Tab>
  2060. Also see |cpo-\|.
  2061. *cpo-L*
  2062. L When the 'list' option is set, 'wrapmargin',
  2063. 'textwidth', 'softtabstop' and Virtual Replace mode
  2064. (see |gR|) count a <Tab> as two characters, instead of
  2065. the normal behavior of a <Tab>.
  2066. *cpo-m*
  2067. m When included, a showmatch will always wait half a
  2068. second. When not included, a showmatch will wait half
  2069. a second or until a character is typed. |'showmatch'|
  2070. *cpo-M*
  2071. M When excluded, "%" matching will take backslashes into
  2072. account. Thus in "( \( )" and "\( ( \)" the outer
  2073. parenthesis match. When included "%" ignores
  2074. backslashes, which is Vi compatible.
  2075. *cpo-n*
  2076. n When included, the column used for 'number' and
  2077. 'relativenumber' will also be used for text of wrapped
  2078. lines.
  2079. *cpo-o*
  2080. o Line offset to search command is not remembered for
  2081. next search.
  2082. *cpo-O*
  2083. O Don't complain if a file is being overwritten, even
  2084. when it didn't exist when editing it. This is a
  2085. protection against a file unexpectedly created by
  2086. someone else. Vi didn't complain about this.
  2087. *cpo-p*
  2088. p Vi compatible Lisp indenting. When not present, a
  2089. slightly better algorithm is used.
  2090. *cpo-P*
  2091. P When included, a ":write" command that appends to a
  2092. file will set the file name for the current buffer, if
  2093. the current buffer doesn't have a file name yet and
  2094. the 'F' flag is also included |cpo-F|.
  2095. *cpo-q*
  2096. q When joining multiple lines leave the cursor at the
  2097. position where it would be when joining two lines.
  2098. *cpo-r*
  2099. r Redo ("." command) uses "/" to repeat a search
  2100. command, instead of the actually used search string.
  2101. *cpo-R*
  2102. R Remove marks from filtered lines. Without this flag
  2103. marks are kept like |:keepmarks| was used.
  2104. *cpo-s*
  2105. s Set buffer options when entering the buffer for the
  2106. first time. This is like it is in Vim version 3.0.
  2107. And it is the default. If not present the options are
  2108. set when the buffer is created.
  2109. *cpo-S*
  2110. S Set buffer options always when entering a buffer
  2111. (except 'readonly', 'fileformat', 'filetype' and
  2112. 'syntax'). This is the (most) Vi compatible setting.
  2113. The options are set to the values in the current
  2114. buffer. When you change an option and go to another
  2115. buffer, the value is copied. Effectively makes the
  2116. buffer options global to all buffers.
  2117. 's' 'S' copy buffer options
  2118. no no when buffer created
  2119. yes no when buffer first entered (default)
  2120. X yes each time when buffer entered (vi comp.)
  2121. *cpo-t*
  2122. t Search pattern for the tag command is remembered for
  2123. "n" command. Otherwise Vim only puts the pattern in
  2124. the history for search pattern, but doesn't change the
  2125. last used search pattern.
  2126. *cpo-u*
  2127. u Undo is Vi compatible. See |undo-two-ways|.
  2128. *cpo-v*
  2129. v Backspaced characters remain visible on the screen in
  2130. Insert mode. Without this flag the characters are
  2131. erased from the screen right away. With this flag the
  2132. screen newly typed text overwrites backspaced
  2133. characters.
  2134. *cpo-w*
  2135. w When using "cw" on a blank character, only change one
  2136. character and not all blanks until the start of the
  2137. next word.
  2138. *cpo-W*
  2139. W Don't overwrite a readonly file. When omitted, ":w!"
  2140. overwrites a readonly file, if possible.
  2141. *cpo-x*
  2142. x <Esc> on the command-line executes the command-line.
  2143. The default in Vim is to abandon the command-line,
  2144. because <Esc> normally aborts a command. |c_<Esc>|
  2145. *cpo-X*
  2146. X When using a count with "R" the replaced text is
  2147. deleted only once. Also when repeating "R" with "."
  2148. and a count.
  2149. *cpo-y*
  2150. y A yank command can be redone with ".". Think twice if
  2151. you really want to use this, it may break some
  2152. plugins, since most people expect "." to only repeat a
  2153. change.
  2154. *cpo-Z*
  2155. Z When using "w!" while the 'readonly' option is set,
  2156. don't reset 'readonly'.
  2157. *cpo-!*
  2158. ! When redoing a filter command, use the last used
  2159. external command, whatever it was. Otherwise the last
  2160. used -filter- command is used.
  2161. *cpo-$*
  2162. $ When making a change to one line, don't redisplay the
  2163. line, but put a '$' at the end of the changed text.
  2164. The changed text will be overwritten when you type the
  2165. new text. The line is redisplayed if you type any
  2166. command that moves the cursor from the insertion
  2167. point.
  2168. *cpo-%*
  2169. % Vi-compatible matching is done for the "%" command.
  2170. Does not recognize "#if", "#endif", etc.
  2171. Does not recognize "/*" and "*/".
  2172. Parens inside single and double quotes are also
  2173. counted, causing a string that contains a paren to
  2174. disturb the matching. For example, in a line like
  2175. "if (strcmp("foo(", s))" the first paren does not
  2176. match the last one. When this flag is not included,
  2177. parens inside single and double quotes are treated
  2178. specially. When matching a paren outside of quotes,
  2179. everything inside quotes is ignored. When matching a
  2180. paren inside quotes, it will find the matching one (if
  2181. there is one). This works very well for C programs.
  2182. This flag is also used for other features, such as
  2183. C-indenting.
  2184. *cpo--*
  2185. - When included, a vertical movement command fails when
  2186. it would go above the first line or below the last
  2187. line. Without it the cursor moves to the first or
  2188. last line, unless it already was in that line.
  2189. Applies to the commands "-", "k", CTRL-P, "+", "j",
  2190. CTRL-N, CTRL-J and ":1234".
  2191. *cpo-+*
  2192. + When included, a ":write file" command will reset the
  2193. 'modified' flag of the buffer, even though the buffer
  2194. itself may still be different from its file.
  2195. *cpo-star*
  2196. * Use ":*" in the same way as ":@". When not included,
  2197. ":*" is an alias for ":'<,'>", select the Visual area.
  2198. *cpo-<*
  2199. < Disable the recognition of special key codes in |<>|
  2200. form in mappings, abbreviations, and the "to" part of
  2201. menu commands. For example, the command
  2202. ":map X <Tab>" results in X being mapped to:
  2203. '<' included: "<Tab>" (5 characters)
  2204. '<' excluded: "^I" (^I is a real <Tab>)
  2205. Also see the 'k' flag above.
  2206. *cpo->*
  2207. > When appending to a register, put a line break before
  2208. the appended text.
  2209. *cpo-;*
  2210. ; When using |,| or |;| to repeat the last |t| search
  2211. and the cursor is right in front of the searched
  2212. character, the cursor won't move. When not included,
  2213. the cursor would skip over it and jump to the
  2214. following occurrence.
  2215. POSIX flags. These are not included in the Vi default value, except
  2216. when $VIM_POSIX was set on startup. |posix|
  2217. contains behavior ~
  2218. *cpo-#*
  2219. # A count before "D", "o" and "O" has no effect.
  2220. *cpo-&*
  2221. & When ":preserve" was used keep the swap file when
  2222. exiting normally while this buffer is still loaded.
  2223. This flag is tested when exiting.
  2224. *cpo-\*
  2225. \ Backslash in a [] range in a search pattern is taken
  2226. literally, only "\]" is special See |/[]|
  2227. '\' included: "/[ \-]" finds <Space>, '\' and '-'
  2228. '\' excluded: "/[ \-]" finds <Space> and '-'
  2229. Also see |cpo-l|.
  2230. *cpo-/*
  2231. / When "%" is used as the replacement string in a |:s|
  2232. command, use the previous replacement string. |:s%|
  2233. *cpo-{*
  2234. { The |{| and |}| commands also stop at a "{" character
  2235. at the start of a line.
  2236. *cpo-.*
  2237. . The ":chdir" and ":cd" commands fail if the current
  2238. buffer is modified, unless ! is used. Vim doesn't
  2239. need this, since it remembers the full path of an
  2240. opened file.
  2241. *cpo-bar*
  2242. | The value of the $LINES and $COLUMNS environment
  2243. variables overrule the terminal size values obtained
  2244. with system specific functions.
  2245. *'cryptmethod'* *'cm'*
  2246. 'cryptmethod' 'cm' string (default "blowfish2")
  2247. global or local to buffer |global-local|
  2248. Method used for encryption when the buffer is written to a file:
  2249. *pkzip*
  2250. zip PkZip compatible method. A weak kind of encryption.
  2251. Backwards compatible with Vim 7.2 and older.
  2252. *blowfish*
  2253. blowfish Blowfish method. Medium strong encryption but it has
  2254. an implementation flaw. Requires Vim 7.3 or later,
  2255. files can NOT be read by Vim 7.2 and older. This adds
  2256. a "seed" to the file, every time you write the file
  2257. the encrypted bytes will be different.
  2258. *blowfish2*
  2259. blowfish2 Blowfish method. Medium strong encryption. Requires
  2260. Vim 7.4.401 or later, files can NOT be read by Vim 7.3
  2261. and older. This adds a "seed" to the file, every time
  2262. you write the file the encrypted bytes will be
  2263. different. The whole undo file is encrypted, not just
  2264. the pieces of text.
  2265. *E1193* *E1194* *E1195* *E1196* *E1230*
  2266. *E1197* *E1198* *E1199* *E1200* *E1201*
  2267. xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
  2268. Code. Medium strong till strong encryption.
  2269. Encryption is provided by the libsodium library, it
  2270. requires Vim to be built with |+sodium|.
  2271. It adds a seed and a message authentication code (MAC)
  2272. to the file. This needs at least a Vim 8.2.3022 to
  2273. read the encrypted file.
  2274. Encryption of swap files is not supported, therefore
  2275. no swap file will be used when xchacha20 encryption is
  2276. enabled.
  2277. Encryption of undo files is not yet supported,
  2278. therefore no undo file will currently be written.
  2279. CURRENTLY EXPERIMENTAL: Files written with this method
  2280. might have to be read back with the same version of
  2281. Vim if the binary format changes later.
  2282. You should use "blowfish2", also to re-encrypt older files.
  2283. When reading an encrypted file 'cryptmethod' will be set automatically
  2284. to the detected method of the file being read. Thus if you write it
  2285. without changing 'cryptmethod' the same method will be used.
  2286. Changing 'cryptmethod' does not mark the file as modified, you have to
  2287. explicitly write it, you don't get a warning unless there are other
  2288. modifications. Also see |:X|.
  2289. When setting the global value to an empty string, it will end up with
  2290. the value "blowfish2". When setting the local value to an empty
  2291. string the buffer will use the global value.
  2292. When a new encryption method is added in a later version of Vim, and
  2293. the current version does not recognize it, you will get *E821* .
  2294. You need to edit this file with the later version of Vim.
  2295. *'cscopepathcomp'* *'cspc'*
  2296. 'cscopepathcomp' 'cspc' number (default 0)
  2297. global
  2298. {not available when compiled without the |+cscope|
  2299. feature}
  2300. Determines how many components of the path to show in a list of tags.
  2301. See |cscopepathcomp|.
  2302. NOTE: This option is set to 0 when 'compatible' is set.
  2303. *'cscopeprg'* *'csprg'*
  2304. 'cscopeprg' 'csprg' string (default "cscope")
  2305. global
  2306. {not available when compiled without the |+cscope|
  2307. feature}
  2308. Specifies the command to execute cscope. See |cscopeprg|.
  2309. This option cannot be set from a |modeline| or in the |sandbox|, for
  2310. security reasons.
  2311. *'cscopequickfix'* *'csqf'*
  2312. 'cscopequickfix' 'csqf' string (default "")
  2313. global
  2314. {not available when compiled without the |+cscope|
  2315. or |+quickfix| features}
  2316. Specifies whether to use quickfix window to show cscope results.
  2317. See |cscopequickfix|.
  2318. *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
  2319. 'cscoperelative' 'csre' boolean (default off)
  2320. global
  2321. {not available when compiled without the |+cscope|
  2322. feature}
  2323. In the absence of a prefix (-P) for cscope. setting this option enables
  2324. to use the basename of cscope.out path as the prefix.
  2325. See |cscoperelative|.
  2326. NOTE: This option is reset when 'compatible' is set.
  2327. *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
  2328. 'cscopetag' 'cst' boolean (default off)
  2329. global
  2330. {not available when compiled without the |+cscope|
  2331. feature}
  2332. Use cscope for tag commands. See |cscope-options|.
  2333. NOTE: This option is reset when 'compatible' is set.
  2334. *'cscopetagorder'* *'csto'*
  2335. 'cscopetagorder' 'csto' number (default 0)
  2336. global
  2337. {not available when compiled without the |+cscope|
  2338. feature}
  2339. Determines the order in which ":cstag" performs a search. See
  2340. |cscopetagorder|.
  2341. NOTE: This option is set to 0 when 'compatible' is set.
  2342. *'cscopeverbose'* *'csverb'*
  2343. *'nocscopeverbose'* *'nocsverb'*
  2344. 'cscopeverbose' 'csverb' boolean (default off)
  2345. global
  2346. {not available when compiled without the |+cscope|
  2347. feature}
  2348. Give messages when adding a cscope database. See |cscopeverbose|.
  2349. NOTE: This option is reset when 'compatible' is set.
  2350. *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
  2351. 'cursorbind' 'crb' boolean (default off)
  2352. local to window
  2353. When this option is set, as the cursor in the current
  2354. window moves other cursorbound windows (windows that also have
  2355. this option set) move their cursors to the corresponding line and
  2356. column. This option is useful for viewing the
  2357. differences between two versions of a file (see 'diff'); in diff mode,
  2358. inserted and deleted lines (though not characters within a line) are
  2359. taken into account.
  2360. *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
  2361. 'cursorcolumn' 'cuc' boolean (default off)
  2362. local to window
  2363. {not available when compiled without the |+syntax|
  2364. feature}
  2365. Highlight the screen column of the cursor with CursorColumn
  2366. |hl-CursorColumn|. Useful to align text. Will make screen redrawing
  2367. slower.
  2368. If you only want the highlighting in the current window you can use
  2369. these autocommands: >
  2370. au WinLeave * set nocursorline nocursorcolumn
  2371. au WinEnter * set cursorline cursorcolumn
  2372. <
  2373. *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
  2374. 'cursorline' 'cul' boolean (default off)
  2375. local to window
  2376. {not available when compiled without the |+syntax|
  2377. feature}
  2378. Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
  2379. Useful to easily spot the cursor. Will make screen redrawing slower.
  2380. When Visual mode is active the highlighting isn't used to make it
  2381. easier to see the selected text.
  2382. *'cursorlineopt'* *'culopt'*
  2383. 'cursorlineopt' 'culopt' string (default: "number,line")
  2384. local to window
  2385. {not available when compiled without the |+syntax|
  2386. feature}
  2387. Comma-separated list of settings for how 'cursorline' is displayed.
  2388. Valid values:
  2389. "line" Highlight the text line of the cursor with
  2390. CursorLine |hl-CursorLine|.
  2391. "screenline" Highlight only the screen line of the cursor with
  2392. CursorLine |hl-CursorLine|.
  2393. "number" Highlight the line number of the cursor with
  2394. CursorLineNr |hl-CursorLineNr|.
  2395. Special value:
  2396. "both" Alias for the values "line,number".
  2397. "line" and "screenline" cannot be used together.
  2398. *'debug'*
  2399. 'debug' string (default "")
  2400. global
  2401. These values can be used:
  2402. msg Error messages that would otherwise be omitted will be given
  2403. anyway.
  2404. throw Error messages that would otherwise be omitted will be given
  2405. anyway and also throw an exception and set |v:errmsg|.
  2406. beep A message will be given when otherwise only a beep would be
  2407. produced.
  2408. The values can be combined, separated by a comma.
  2409. "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
  2410. 'indentexpr'.
  2411. *'define'* *'def'*
  2412. 'define' 'def' string (default "^\s*#\s*define")
  2413. global or local to buffer |global-local|
  2414. Pattern to be used to find a macro definition. It is a search
  2415. pattern, just like for the "/" command. This option is used for the
  2416. commands like "[i" and "[d" |include-search|. The 'isident' option is
  2417. used to recognize the defined name after the match:
  2418. {match with 'define'}{non-ID chars}{defined name}{non-ID char}
  2419. See |option-backslash| about inserting backslashes to include a space
  2420. or backslash.
  2421. The default value is for C programs. For C++ this value would be
  2422. useful, to include const type declarations: >
  2423. ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
  2424. < You can also use "\ze" just before the name and continue the pattern
  2425. to check what is following. E.g. for Javascript, if a function is
  2426. defined with "func_name = function(args)": >
  2427. ^\s*\ze\i\+\s*=\s*function(
  2428. < If the function is defined with "func_name : function() {...": >
  2429. ^\s*\ze\i\+\s*[:]\s*(*function\s*(
  2430. < When using the ":set" command, you need to double the backslashes!
  2431. To avoid that use `:let` with a single quote string: >
  2432. let &l:define = '^\s*\ze\k\+\s*=\s*function('
  2433. <
  2434. *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
  2435. 'delcombine' 'deco' boolean (default off)
  2436. global
  2437. If editing Unicode and this option is set, backspace and Normal mode
  2438. "x" delete each combining character on its own. When it is off (the
  2439. default) the character along with its combining characters are
  2440. deleted.
  2441. Note: When 'delcombine' is set "xx" may work differently from "2x"!
  2442. This is useful for Arabic, Hebrew and many other languages where one
  2443. may have combining characters overtop of base characters, and want
  2444. to remove only the combining ones.
  2445. NOTE: This option is reset when 'compatible' is set.
  2446. *'dictionary'* *'dict'*
  2447. 'dictionary' 'dict' string (default "")
  2448. global or local to buffer |global-local|
  2449. List of file names, separated by commas, that are used to lookup words
  2450. for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
  2451. contain a list of words. This can be one word per line, or several
  2452. words per line, separated by non-keyword characters (white space is
  2453. preferred). Maximum line length is 510 bytes.
  2454. When this option is empty or an entry "spell" is present, and spell
  2455. checking is enabled, words in the word lists for the currently active
  2456. 'spelllang' are used. See |spell|.
  2457. To include a comma in a file name precede it with a backslash. Spaces
  2458. after a comma are ignored, otherwise spaces are included in the file
  2459. name. See |option-backslash| about using backslashes.
  2460. This has nothing to do with the |Dictionary| variable type.
  2461. Where to find a list of words?
  2462. - On FreeBSD, there is the file "/usr/share/dict/words".
  2463. - In the Simtel archive, look in the "msdos/linguist" directory.
  2464. - In "miscfiles" of the GNU collection.
  2465. The use of |:set+=| and |:set-=| is preferred when adding or removing
  2466. directories from the list. This avoids problems when a future version
  2467. uses another default.
  2468. Backticks cannot be used in this option for security reasons.
  2469. *'diff'* *'nodiff'*
  2470. 'diff' boolean (default off)
  2471. local to window
  2472. {not available when compiled without the |+diff|
  2473. feature}
  2474. Join the current window in the group of windows that shows differences
  2475. between files. See |vimdiff|.
  2476. *'dex'* *'diffexpr'*
  2477. 'diffexpr' 'dex' string (default "")
  2478. global
  2479. {not available when compiled without the |+diff|
  2480. feature}
  2481. Expression which is evaluated to obtain a diff file (either ed-style
  2482. or unified-style) from two versions of a file. See |diff-diffexpr|.
  2483. This option cannot be set from a |modeline| or in the |sandbox|, for
  2484. security reasons.
  2485. *'dip'* *'diffopt'*
  2486. 'diffopt' 'dip' string (default "internal,filler,closeoff")
  2487. global
  2488. {not available when compiled without the |+diff|
  2489. feature}
  2490. Option settings for diff mode. It can consist of the following items.
  2491. All are optional. Items must be separated by a comma.
  2492. filler Show filler lines, to keep the text
  2493. synchronized with a window that has inserted
  2494. lines at the same position. Mostly useful
  2495. when windows are side-by-side and 'scrollbind'
  2496. is set.
  2497. context:{n} Use a context of {n} lines between a change
  2498. and a fold that contains unchanged lines.
  2499. When omitted a context of six lines is used.
  2500. When using zero the context is actually one,
  2501. since folds require a line in between, also
  2502. for a deleted line.
  2503. See |fold-diff|.
  2504. iblank Ignore changes where lines are all blank. Adds
  2505. the "-B" flag to the "diff" command if
  2506. 'diffexpr' is empty. Check the documentation
  2507. of the "diff" command for what this does
  2508. exactly.
  2509. NOTE: the diff windows will get out of sync,
  2510. because no differences between blank lines are
  2511. taken into account.
  2512. icase Ignore changes in case of text. "a" and "A"
  2513. are considered the same. Adds the "-i" flag
  2514. to the "diff" command if 'diffexpr' is empty.
  2515. iwhite Ignore changes in amount of white space. Adds
  2516. the "-b" flag to the "diff" command if
  2517. 'diffexpr' is empty. Check the documentation
  2518. of the "diff" command for what this does
  2519. exactly. It should ignore adding trailing
  2520. white space, but not leading white space.
  2521. iwhiteall Ignore all white space changes. Adds
  2522. the "-w" flag to the "diff" command if
  2523. 'diffexpr' is empty. Check the documentation
  2524. of the "diff" command for what this does
  2525. exactly.
  2526. iwhiteeol Ignore white space changes at end of line.
  2527. Adds the "-Z" flag to the "diff" command if
  2528. 'diffexpr' is empty. Check the documentation
  2529. of the "diff" command for what this does
  2530. exactly.
  2531. horizontal Start diff mode with horizontal splits (unless
  2532. explicitly specified otherwise).
  2533. vertical Start diff mode with vertical splits (unless
  2534. explicitly specified otherwise).
  2535. closeoff When a window is closed where 'diff' is set
  2536. and there is only one window remaining in the
  2537. same tab page with 'diff' set, execute
  2538. `:diffoff` in that window. This undoes a
  2539. `:diffsplit` command.
  2540. hiddenoff Do not use diff mode for a buffer when it
  2541. becomes hidden.
  2542. foldcolumn:{n} Set the 'foldcolumn' option to {n} when
  2543. starting diff mode. Without this 2 is used.
  2544. followwrap Follow the 'wrap' option and leave as it is.
  2545. internal Use the internal diff library. This is
  2546. ignored when 'diffexpr' is set. *E960*
  2547. When running out of memory when writing a
  2548. buffer this item will be ignored for diffs
  2549. involving that buffer. Set the 'verbose'
  2550. option to see when this happens.
  2551. indent-heuristic
  2552. Use the indent heuristic for the internal
  2553. diff library.
  2554. algorithm:{text} Use the specified diff algorithm with the
  2555. internal diff engine. Currently supported
  2556. algorithms are:
  2557. myers the default algorithm
  2558. minimal spend extra time to generate the
  2559. smallest possible diff
  2560. patience patience diff algorithm
  2561. histogram histogram diff algorithm
  2562. Examples: >
  2563. :set diffopt=internal,filler,context:4
  2564. :set diffopt=
  2565. :set diffopt=internal,filler,foldcolumn:3
  2566. :set diffopt-=internal " do NOT use the internal diff parser
  2567. <
  2568. *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
  2569. 'digraph' 'dg' boolean (default off)
  2570. global
  2571. {not available when compiled without the |+digraphs|
  2572. feature}
  2573. Enable the entering of digraphs in Insert mode with {char1} <BS>
  2574. {char2}. See |digraphs|.
  2575. NOTE: This option is reset when 'compatible' is set.
  2576. *'directory'* *'dir'*
  2577. 'directory' 'dir' string (default for Amiga: ".,t:",
  2578. for Win32: ".,$TEMP,c:\tmp,c:\temp"
  2579. for Unix: ".,~/tmp,/var/tmp,/tmp")
  2580. global
  2581. List of directory names for the swap file, separated with commas.
  2582. Recommended value: ".,~/vimswap//" - this will put the swap file next
  2583. to the edited file if possible, and in your personal swap directory
  2584. otherwise. Make sure "~/vimswap//" is only readable for you.
  2585. Possible items:
  2586. - The swap file will be created in the first directory where this is
  2587. possible.
  2588. - Empty means that no swap file will be used (recovery is
  2589. impossible!) and no |E303| error will be given.
  2590. - A directory "." means to put the swap file in the same directory as
  2591. the edited file. On Unix, a dot is prepended to the file name, so
  2592. it doesn't show in a directory listing. On MS-Windows the "hidden"
  2593. attribute is set and a dot prepended if possible.
  2594. - A directory starting with "./" (or ".\" for MS-Windows) means to put
  2595. the swap file relative to where the edited file is. The leading "."
  2596. is replaced with the path name of the edited file.
  2597. - For Unix and Win32, if a directory ends in two path separators "//",
  2598. the swap file name will be built from the complete path to the file
  2599. with all path separators replaced by percent '%' signs (including
  2600. the colon following the drive letter on Win32). This will ensure
  2601. file name uniqueness in the preserve directory.
  2602. On Win32, it is also possible to end with "\\". However, When a
  2603. separating comma is following, you must use "//", since "\\" will
  2604. include the comma in the file name. Therefore it is recommended to
  2605. use '//', instead of '\\'.
  2606. - Spaces after the comma are ignored, other spaces are considered part
  2607. of the directory name. To have a space at the start of a directory
  2608. name, precede it with a backslash.
  2609. - To include a comma in a directory name precede it with a backslash.
  2610. - A directory name may end in an ':' or '/'.
  2611. - Environment variables are expanded |:set_env|.
  2612. - Careful with '\' characters, type one before a space, type two to
  2613. get one in the option (see |option-backslash|), for example: >
  2614. :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  2615. < - For backwards compatibility with Vim version 3.0 a '>' at the start
  2616. of the option is removed.
  2617. Using "." first in the list is recommended. This means that editing
  2618. the same file twice will result in a warning. Using "/tmp" on Unix is
  2619. discouraged: When the system crashes you lose the swap file.
  2620. "/var/tmp" is often not cleared when rebooting, thus is a better
  2621. choice than "/tmp". But others on the computer may be able to see the
  2622. files, and it can contain a lot of files, your swap files get lost in
  2623. the crowd. That is why a "tmp" directory in your home directory is
  2624. tried first.
  2625. The use of |:set+=| and |:set-=| is preferred when adding or removing
  2626. directories from the list. This avoids problems when a future version
  2627. uses another default.
  2628. This option cannot be set from a |modeline| or in the |sandbox|, for
  2629. security reasons.
  2630. *'display'* *'dy'*
  2631. 'display' 'dy' string (default "", set to "truncate" in
  2632. |defaults.vim|)
  2633. global
  2634. Change the way text is displayed. This is a comma-separated list of
  2635. flags:
  2636. lastline When included, as much as possible of the last line
  2637. in a window will be displayed. "@@@" is put in the
  2638. last columns of the last screen line to indicate the
  2639. rest of the line is not displayed.
  2640. truncate Like "lastline", but "@@@" is displayed in the first
  2641. column of the last screen line. Overrules "lastline".
  2642. uhex Show unprintable characters hexadecimal as <xx>
  2643. instead of using ^C and ~C.
  2644. When neither "lastline" nor "truncate" is included, a last line that
  2645. doesn't fit is replaced with "@" lines.
  2646. The "@" character can be changed by setting the "lastline" item in
  2647. 'fillchars'. The character is highlighted with |hl-NonText|.
  2648. *'eadirection'* *'ead'*
  2649. 'eadirection' 'ead' string (default "both")
  2650. global
  2651. Tells when the 'equalalways' option applies:
  2652. ver vertically, width of windows is not affected
  2653. hor horizontally, height of windows is not affected
  2654. both width and height of windows is affected
  2655. *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
  2656. 'edcompatible' 'ed' boolean (default off)
  2657. global
  2658. Makes the 'g' and 'c' flags of the ":substitute" command to be
  2659. toggled each time the flag is given. See |complex-change|. See
  2660. also 'gdefault' option.
  2661. Switching this option on may break plugins!
  2662. This option is not used in |Vim9| script.
  2663. *'emoji'* *'emo'* *'noemoji'* *'noemo'*
  2664. 'emoji' 'emo' boolean (default: on)
  2665. global
  2666. When on all Unicode emoji characters are considered to be full width.
  2667. This excludes "text emoji" characters, which are normally displayed as
  2668. single width. Unfortunately there is no good specification for this
  2669. and it has been determined on trial-and-error basis. Use the
  2670. |setcellwidths()| function to change the behavior.
  2671. *'encoding'* *'enc'* *E543*
  2672. 'encoding' 'enc' string (default for MS-Windows: "utf-8",
  2673. otherwise: value from $LANG or "latin1")
  2674. global
  2675. Sets the character encoding used inside Vim. It applies to text in
  2676. the buffers, registers, Strings in expressions, text stored in the
  2677. viminfo file, etc. It sets the kind of characters which Vim can work
  2678. with. See |encoding-names| for the possible values.
  2679. NOTE: Changing this option will not change the encoding of the
  2680. existing text in Vim. It may cause non-ASCII text to become invalid.
  2681. It should normally be kept at its default value, or set when Vim
  2682. starts up. See |multibyte|. To reload the menus see |:menutrans|.
  2683. This option cannot be set from a |modeline|. It would most likely
  2684. corrupt the text.
  2685. NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
  2686. to "utf-8". Although care has been taken to allow different values of
  2687. 'encoding', "utf-8" is the natural choice for the environment and
  2688. avoids unnecessary conversion overhead. "utf-8" has not been made
  2689. the default to prevent different behavior of the GUI and terminal
  2690. versions, and to avoid changing the encoding of newly created files
  2691. without your knowledge (in case 'fileencodings' is empty).
  2692. The character encoding of files can be different from 'encoding'.
  2693. This is specified with 'fileencoding'. The conversion is done with
  2694. iconv() or as specified with 'charconvert'.
  2695. If you need to know whether 'encoding' is a multibyte encoding, you
  2696. can use: >
  2697. if has("multi_byte_encoding")
  2698. <
  2699. Normally 'encoding' will be equal to your current locale. This will
  2700. be the default if Vim recognizes your environment settings. If
  2701. 'encoding' is not set to the current locale, 'termencoding' must be
  2702. set to convert typed and displayed text. See |encoding-table|.
  2703. When you set this option, it fires the |EncodingChanged| autocommand
  2704. event so that you can set up fonts if necessary.
  2705. When the option is set, the value is converted to lowercase. Thus
  2706. you can set it with uppercase values too. Underscores are translated
  2707. to '-' signs.
  2708. When the encoding is recognized, it is changed to the standard name.
  2709. For example "Latin-1" becomes "latin1", "ISO_88592" becomes
  2710. "iso-8859-2" and "utf8" becomes "utf-8".
  2711. Note: "latin1" is also used when the encoding could not be detected.
  2712. This only works when editing files in the same encoding! When the
  2713. actual character set is not latin1, make sure 'fileencoding' and
  2714. 'fileencodings' are empty. When conversion is needed, switch to using
  2715. utf-8.
  2716. When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
  2717. You don't notice this while editing, but it does matter for the
  2718. |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
  2719. setting 'encoding' to one of these values instead of utf-8 only has
  2720. effect for encoding used for files when 'fileencoding' is empty.
  2721. When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
  2722. not set yet, the default for 'fileencodings' is changed.
  2723. *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
  2724. 'endoffile' 'eof' boolean (default off)
  2725. local to buffer
  2726. Indicates that a CTRL-Z character was found at the end of the file
  2727. when reading it. Normally only happens when 'fileformat' is "dos".
  2728. When writing a file and this option is off and the 'binary' option
  2729. is on, or 'fixeol' option is off, no CTRL-Z will be written at the
  2730. end of the file.
  2731. See |eol-and-eof| for example settings.
  2732. *'endofline'* *'eol'* *'noendofline'* *'noeol'*
  2733. 'endofline' 'eol' boolean (default on)
  2734. local to buffer
  2735. When writing a file and this option is off and the 'binary' option
  2736. is on, or 'fixeol' option is off, no <EOL> will be written for the
  2737. last line in the file. This option is automatically set or reset when
  2738. starting to edit a new file, depending on whether file has an <EOL>
  2739. for the last line in the file. Normally you don't have to set or
  2740. reset this option.
  2741. When 'binary' is off and 'fixeol' is on the value is not used when
  2742. writing the file. When 'binary' is on or 'fixeol' is off it is used
  2743. to remember the presence of a <EOL> for the last line in the file, so
  2744. that when you write the file the situation from the original file can
  2745. be kept. But you can change it if you want to.
  2746. See |eol-and-eof| for example settings.
  2747. *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
  2748. 'equalalways' 'ea' boolean (default on)
  2749. global
  2750. When on, all the windows are automatically made the same size after
  2751. splitting or closing a window. This also happens the moment the
  2752. option is switched on. When off, splitting a window will reduce the
  2753. size of the current window and leave the other windows the same. When
  2754. closing a window the extra lines are given to the window next to it
  2755. (depending on 'splitbelow' and 'splitright').
  2756. When mixing vertically and horizontally split windows, a minimal size
  2757. is computed and some windows may be larger if there is room. The
  2758. 'eadirection' option tells in which direction the size is affected.
  2759. Changing the height and width of a window can be avoided by setting
  2760. 'winfixheight' and 'winfixwidth', respectively.
  2761. If a window size is specified when creating a new window sizes are
  2762. currently not equalized (it's complicated, but may be implemented in
  2763. the future).
  2764. *'equalprg'* *'ep'*
  2765. 'equalprg' 'ep' string (default "")
  2766. global or local to buffer |global-local|
  2767. External program to use for "=" command. When this option is empty
  2768. the internal formatting functions are used; either 'lisp', 'cindent'
  2769. or 'indentexpr'. When Vim was compiled without internal formatting,
  2770. the "indent" program is used.
  2771. Environment variables are expanded |:set_env|. See |option-backslash|
  2772. about including spaces and backslashes.
  2773. This option cannot be set from a |modeline| or in the |sandbox|, for
  2774. security reasons.
  2775. *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
  2776. 'errorbells' 'eb' boolean (default off)
  2777. global
  2778. Ring the bell (beep or screen flash) for error messages. This only
  2779. makes a difference for error messages, the bell will be used always
  2780. for a lot of errors without a message (e.g., hitting <Esc> in Normal
  2781. mode). See 'visualbell' on how to make the bell behave like a beep,
  2782. screen flash or do nothing. See 'belloff' to finetune when to ring the
  2783. bell.
  2784. *'errorfile'* *'ef'*
  2785. 'errorfile' 'ef' string (Amiga default: "AztecC.Err",
  2786. others: "errors.err")
  2787. global
  2788. {not available when compiled without the |+quickfix|
  2789. feature}
  2790. Name of the errorfile for the QuickFix mode (see |:cf|).
  2791. When the "-q" command-line argument is used, 'errorfile' is set to the
  2792. following argument. See |-q|.
  2793. NOT used for the ":make" command. See 'makeef' for that.
  2794. Environment variables are expanded |:set_env|.
  2795. See |option-backslash| about including spaces and backslashes.
  2796. This option cannot be set from a |modeline| or in the |sandbox|, for
  2797. security reasons.
  2798. *'errorformat'* *'efm'*
  2799. 'errorformat' 'efm' string (default is very long)
  2800. global or local to buffer |global-local|
  2801. {not available when compiled without the |+quickfix|
  2802. feature}
  2803. Scanf-like description of the format for the lines in the error file
  2804. (see |errorformat|).
  2805. *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
  2806. 'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
  2807. global
  2808. Function keys that start with an <Esc> are recognized in Insert
  2809. mode. When this option is off, the cursor and function keys cannot be
  2810. used in Insert mode if they start with an <Esc>. The advantage of
  2811. this is that the single <Esc> is recognized immediately, instead of
  2812. after one second. Instead of resetting this option, you might want to
  2813. try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
  2814. when 'esckeys' is off, you can still map anything, but the cursor keys
  2815. won't work by default.
  2816. NOTE: This option is set to the Vi default value when 'compatible' is
  2817. set and to the Vim default value when 'compatible' is reset.
  2818. NOTE: when this option is off then the |modifyOtherKeys| functionality
  2819. is disabled while in Insert mode to avoid ending Insert mode with any
  2820. key that has a modifier.
  2821. *'eventignore'* *'ei'*
  2822. 'eventignore' 'ei' string (default "")
  2823. global
  2824. A list of autocommand event names, which are to be ignored.
  2825. When set to "all" or when "all" is one of the items, all autocommand
  2826. events are ignored, autocommands will not be executed.
  2827. Otherwise this is a comma-separated list of event names. Example: >
  2828. :set ei=WinEnter,WinLeave
  2829. <
  2830. *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
  2831. 'expandtab' 'et' boolean (default off)
  2832. local to buffer
  2833. In Insert mode: Use the appropriate number of spaces to insert a
  2834. <Tab>. Spaces are used in indents with the '>' and '<' commands and
  2835. when 'autoindent' is on. To insert a real tab when 'expandtab' is
  2836. on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
  2837. This option is reset when the 'paste' option is set and restored when
  2838. the 'paste' option is reset.
  2839. NOTE: This option is reset when 'compatible' is set.
  2840. *'exrc'* *'ex'* *'noexrc'* *'noex'*
  2841. 'exrc' 'ex' boolean (default off)
  2842. global
  2843. Enables the reading of .vimrc, .exrc and .gvimrc in the current
  2844. directory.
  2845. Setting this option is a potential security leak. E.g., consider
  2846. unpacking a package or fetching files from github, a .vimrc in there
  2847. might be a trojan horse. BETTER NOT SET THIS OPTION!
  2848. Instead, define an autocommand in your .vimrc to set options for a
  2849. matching directory.
  2850. If you do switch this option on you should also consider setting the
  2851. 'secure' option (see |initialization|).
  2852. Also see |.vimrc| and |gui-init|.
  2853. This option cannot be set from a |modeline| or in the |sandbox|, for
  2854. security reasons.
  2855. *'fileencoding'* *'fenc'* *E213*
  2856. 'fileencoding' 'fenc' string (default: "")
  2857. local to buffer
  2858. Sets the character encoding for the file of this buffer.
  2859. When 'fileencoding' is different from 'encoding', conversion will be
  2860. done when writing the file. For reading see below.
  2861. When 'fileencoding' is empty, the same value as 'encoding' will be
  2862. used (no conversion when reading or writing a file).
  2863. No error will be given when the value is set, only when it is used,
  2864. only when writing a file.
  2865. Conversion will also be done when 'encoding' and 'fileencoding' are
  2866. both a Unicode encoding and 'fileencoding' is not utf-8. That's
  2867. because internally Unicode is always stored as utf-8.
  2868. WARNING: Conversion can cause loss of information! When
  2869. 'encoding' is "utf-8" or another Unicode encoding, conversion
  2870. is most likely done in a way that the reverse conversion
  2871. results in the same text. When 'encoding' is not "utf-8" some
  2872. characters may be lost!
  2873. See 'encoding' for the possible values. Additionally, values may be
  2874. specified that can be handled by the converter, see
  2875. |mbyte-conversion|.
  2876. When reading a file 'fileencoding' will be set from 'fileencodings'.
  2877. To read a file in a certain encoding it won't work by setting
  2878. 'fileencoding', use the |++enc| argument. One exception: when
  2879. 'fileencodings' is empty the value of 'fileencoding' is used.
  2880. For a new file the global value of 'fileencoding' is used.
  2881. Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
  2882. When the option is set, the value is converted to lowercase. Thus
  2883. you can set it with uppercase values too. '_' characters are
  2884. replaced with '-'. If a name is recognized from the list for
  2885. 'encoding', it is replaced by the standard name. For example
  2886. "ISO8859-2" becomes "iso-8859-2".
  2887. When this option is set, after starting to edit a file, the 'modified'
  2888. option is set, because the file would be different when written.
  2889. Keep in mind that changing 'fenc' from a modeline happens
  2890. AFTER the text has been read, thus it applies to when the file will be
  2891. written. If you do set 'fenc' in a modeline, you might want to set
  2892. 'nomodified' to avoid not being able to ":q".
  2893. This option can not be changed when 'modifiable' is off.
  2894. *'fe'*
  2895. NOTE: Before version 6.0 this option specified the encoding for the
  2896. whole of Vim, this was a mistake. Now use 'encoding' instead. The
  2897. old short name was 'fe', which is no longer used.
  2898. *'fileencodings'* *'fencs'*
  2899. 'fileencodings' 'fencs' string (default: "ucs-bom",
  2900. "ucs-bom,utf-8,default,latin1" when
  2901. 'encoding' is set to a Unicode value)
  2902. global
  2903. This is a list of character encodings considered when starting to edit
  2904. an existing file. When a file is read, Vim tries to use the first
  2905. mentioned character encoding. If an error is detected, the next one
  2906. in the list is tried. When an encoding is found that works,
  2907. 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
  2908. an empty string, which means the value of 'encoding' is used.
  2909. WARNING: Conversion can cause loss of information! When
  2910. 'encoding' is "utf-8" (or one of the other Unicode variants)
  2911. conversion is most likely done in a way that the reverse
  2912. conversion results in the same text. When 'encoding' is not
  2913. "utf-8" some non-ASCII characters may be lost! You can use
  2914. the |++bad| argument to specify what is done with characters
  2915. that can't be converted.
  2916. For an empty file or a file with only ASCII characters most encodings
  2917. will work and the first entry of 'fileencodings' will be used (except
  2918. "ucs-bom", which requires the BOM to be present). If you prefer
  2919. another encoding use an BufReadPost autocommand event to test if your
  2920. preferred encoding is to be used. Example: >
  2921. au BufReadPost * if search('\S', 'w') == 0 |
  2922. \ set fenc=iso-2022-jp | endif
  2923. < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
  2924. non-blank characters.
  2925. When the |++enc| argument is used then the value of 'fileencodings' is
  2926. not used.
  2927. Note that 'fileencodings' is not used for a new file, the global value
  2928. of 'fileencoding' is used instead. You can set it with: >
  2929. :setglobal fenc=iso-8859-2
  2930. < This means that a non-existing file may get a different encoding than
  2931. an empty file.
  2932. The special value "ucs-bom" can be used to check for a Unicode BOM
  2933. (Byte Order Mark) at the start of the file. It must not be preceded
  2934. by "utf-8" or another Unicode encoding for this to work properly.
  2935. An entry for an 8-bit encoding (e.g., "latin1") should be the last,
  2936. because Vim cannot detect an error, thus the encoding is always
  2937. accepted.
  2938. The special value "default" can be used for the encoding from the
  2939. environment. On MS-Windows this is the system encoding. Otherwise
  2940. this is the default value for 'encoding'. It is useful when
  2941. 'encoding' is set to "utf-8" and your environment uses a non-latin1
  2942. encoding, such as Russian.
  2943. When 'encoding' is "utf-8" and a file contains an illegal byte
  2944. sequence it won't be recognized as UTF-8. You can use the |8g8|
  2945. command to find the illegal byte sequence.
  2946. WRONG VALUES: WHAT'S WRONG:
  2947. latin1,utf-8 "latin1" will always be used
  2948. utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
  2949. file
  2950. cp1250,latin1 "cp1250" will always be used
  2951. If 'fileencodings' is empty, 'fileencoding' is not modified.
  2952. See 'fileencoding' for the possible values.
  2953. Setting this option does not have an effect until the next time a file
  2954. is read.
  2955. *'fileformat'* *'ff'*
  2956. 'fileformat' 'ff' string (MS-Windows default: "dos",
  2957. Unix, macOS default: "unix")
  2958. local to buffer
  2959. This gives the <EOL> of the current buffer, which is used for
  2960. reading/writing the buffer from/to a file:
  2961. dos <CR><NL>
  2962. unix <NL>
  2963. mac <CR>
  2964. When "dos" is used, CTRL-Z at the end of a file is ignored.
  2965. See |file-formats| and |file-read|.
  2966. For the character encoding of the file see 'fileencoding'.
  2967. When 'binary' is set, the value of 'fileformat' is ignored, file I/O
  2968. works like it was set to "unix".
  2969. This option is set automatically when starting to edit a file and
  2970. 'fileformats' is not empty and 'binary' is off.
  2971. When this option is set, after starting to edit a file, the 'modified'
  2972. option is set, because the file would be different when written.
  2973. This option can not be changed when 'modifiable' is off.
  2974. For backwards compatibility: When this option is set to "dos",
  2975. 'textmode' is set, otherwise 'textmode' is reset.
  2976. *'fileformats'* *'ffs'*
  2977. 'fileformats' 'ffs' string (default:
  2978. Vim+Vi MS-Windows: "dos,unix",
  2979. Vim Unix, macOS: "unix,dos",
  2980. Vi Cygwin: "unix,dos",
  2981. Vi others: "")
  2982. global
  2983. This gives the end-of-line (<EOL>) formats that will be tried when
  2984. starting to edit a new buffer and when reading a file into an existing
  2985. buffer:
  2986. - When empty, the format defined with 'fileformat' will be used
  2987. always. It is not set automatically.
  2988. - When set to one name, that format will be used whenever a new buffer
  2989. is opened. 'fileformat' is set accordingly for that buffer. The
  2990. 'fileformats' name will be used when a file is read into an existing
  2991. buffer, no matter what 'fileformat' for that buffer is set to.
  2992. - When more than one name is present, separated by commas, automatic
  2993. <EOL> detection will be done when reading a file. When starting to
  2994. edit a file, a check is done for the <EOL>:
  2995. 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
  2996. 'fileformat' is set to "dos".
  2997. 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
  2998. is set to "unix". Note that when a <NL> is found without a
  2999. preceding <CR>, "unix" is preferred over "dos".
  3000. 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
  3001. if 'fileformats' includes "mac", 'fileformat' is set to "mac".
  3002. This means that "mac" is only chosen when:
  3003. "unix" is not present or no <NL> is found in the file, and
  3004. "dos" is not present or no <CR><NL> is found in the file.
  3005. Except: if "unix" was chosen, but there is a <CR> before
  3006. the first <NL>, and there appear to be more <CR>s than <NL>s in
  3007. the first few lines, "mac" is used.
  3008. 4. If 'fileformat' is still not set, the first name from
  3009. 'fileformats' is used.
  3010. When reading a file into an existing buffer, the same is done, but
  3011. this happens like 'fileformat' has been set appropriately for that
  3012. file only, the option is not changed.
  3013. When 'binary' is set, the value of 'fileformats' is not used.
  3014. When Vim starts up with an empty buffer the first item is used. You
  3015. can overrule this by setting 'fileformat' in your .vimrc.
  3016. For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
  3017. are ":source"ed and for vimrc files, automatic <EOL> detection may be
  3018. done:
  3019. - When 'fileformats' is empty, there is no automatic detection. Dos
  3020. format will be used.
  3021. - When 'fileformats' is set to one or more names, automatic detection
  3022. is done. This is based on the first <NL> in the file: If there is a
  3023. <CR> in front of it, Dos format is used, otherwise Unix format is
  3024. used.
  3025. Also see |file-formats|.
  3026. For backwards compatibility: When this option is set to an empty
  3027. string or one format (no comma is included), 'textauto' is reset,
  3028. otherwise 'textauto' is set.
  3029. NOTE: This option is set to the Vi default value when 'compatible' is
  3030. set and to the Vim default value when 'compatible' is reset.
  3031. *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
  3032. 'fileignorecase' 'fic' boolean (default on for systems where case in file
  3033. names is normally ignored)
  3034. global
  3035. When set case is ignored when using file names and directories.
  3036. See 'wildignorecase' for only ignoring case when doing completion.
  3037. *'filetype'* *'ft'*
  3038. 'filetype' 'ft' string (default: "")
  3039. local to buffer
  3040. When this option is set, the FileType autocommand event is triggered.
  3041. All autocommands that match with the value of this option will be
  3042. executed. Thus the value of 'filetype' is used in place of the file
  3043. name.
  3044. Otherwise this option does not always reflect the current file type.
  3045. This option is normally set when the file type is detected. To enable
  3046. this use the ":filetype on" command. |:filetype|
  3047. Setting this option to a different value is most useful in a modeline,
  3048. for a file for which the file type is not automatically recognized.
  3049. Example, for in an IDL file:
  3050. /* vim: set filetype=idl : */ ~
  3051. |FileType| |filetypes|
  3052. When a dot appears in the value then this separates two filetype
  3053. names. Example:
  3054. /* vim: set filetype=c.doxygen : */ ~
  3055. This will use the "c" filetype first, then the "doxygen" filetype.
  3056. This works both for filetype plugins and for syntax files. More than
  3057. one dot may appear.
  3058. This option is not copied to another buffer, independent of the 's' or
  3059. 'S' flag in 'cpoptions'.
  3060. Only normal file name characters can be used, "/\*?[|<>" are illegal.
  3061. *'fillchars'* *'fcs'*
  3062. 'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
  3063. global or local to window |global-local|
  3064. {not available when compiled without the |+folding|
  3065. feature}
  3066. Characters to fill the statuslines, vertical separators and special
  3067. lines in the window.
  3068. It is a comma-separated list of items. Each item has a name, a colon
  3069. and the value of that item:
  3070. item name default Used for ~
  3071. stl ' ' or '^' statusline of the current window
  3072. stlnc ' ' or '=' statusline of the non-current windows
  3073. vert '|' vertical separators |:vsplit|
  3074. fold '-' filling 'foldtext'
  3075. foldopen '-' mark the beginning of a fold
  3076. foldclose '+' show a closed fold
  3077. foldsep '|' open fold middle character
  3078. diff '-' deleted lines of the 'diff' option
  3079. eob '~' empty lines below the end of a buffer
  3080. lastline '@' 'display' contains lastline/truncate
  3081. Any one that is omitted will fall back to the default. For "stl" and
  3082. "stlnc" the space will be used when there is highlighting, '^' or '='
  3083. otherwise.
  3084. Example: >
  3085. :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
  3086. < This is similar to the default, except that these characters will also
  3087. be used when there is highlighting.
  3088. For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
  3089. single-byte and multibyte characters are supported. But double-width
  3090. characters are not supported.
  3091. The highlighting used for these items:
  3092. item name highlight group ~
  3093. stl StatusLine |hl-StatusLine|
  3094. stlnc StatusLineNC |hl-StatusLineNC|
  3095. vert VertSplit |hl-VertSplit|
  3096. fold Folded |hl-Folded|
  3097. diff DiffDelete |hl-DiffDelete|
  3098. eob EndOfBuffer |hl-EndOfBuffer|
  3099. lastline NonText |hl-NonText|
  3100. *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
  3101. 'fixendofline' 'fixeol' boolean (default on)
  3102. local to buffer
  3103. When writing a file and this option is on, <EOL> at the end of file
  3104. will be restored if missing. Turn this option off if you want to
  3105. preserve the situation from the original file.
  3106. When the 'binary' option is set the value of this option doesn't
  3107. matter.
  3108. See the 'endofline' option.
  3109. See |eol-and-eof| for example settings.
  3110. *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
  3111. 'fkmap' 'fk' boolean (default off)
  3112. global
  3113. {only available when compiled with the |+rightleft|
  3114. feature}
  3115. This option was for using Farsi, which has been removed. See
  3116. |farsi.txt|.
  3117. *'foldclose'* *'fcl'*
  3118. 'foldclose' 'fcl' string (default "")
  3119. global
  3120. {not available when compiled without the |+folding|
  3121. feature}
  3122. When set to "all", a fold is closed when the cursor isn't in it and
  3123. its level is higher than 'foldlevel'. Useful if you want folds to
  3124. automatically close when moving out of them.
  3125. *'foldcolumn'* *'fdc'*
  3126. 'foldcolumn' 'fdc' number (default 0)
  3127. local to window
  3128. {not available when compiled without the |+folding|
  3129. feature}
  3130. When non-zero, a column with the specified width is shown at the side
  3131. of the window which indicates open and closed folds. The maximum
  3132. value is 12.
  3133. See |folding|.
  3134. *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
  3135. 'foldenable' 'fen' boolean (default on)
  3136. local to window
  3137. {not available when compiled without the |+folding|
  3138. feature}
  3139. When off, all folds are open. This option can be used to quickly
  3140. switch between showing all text unfolded and viewing the text with
  3141. folds (including manually opened or closed folds). It can be toggled
  3142. with the |zi| command. The 'foldcolumn' will remain blank when
  3143. 'foldenable' is off.
  3144. This option is set by commands that create a new fold or close a fold.
  3145. See |folding|.
  3146. *'foldexpr'* *'fde'*
  3147. 'foldexpr' 'fde' string (default: "0")
  3148. local to window
  3149. {not available when compiled without the |+folding|
  3150. or |+eval| features}
  3151. The expression used for when 'foldmethod' is "expr". It is evaluated
  3152. for each line to obtain its fold level. The context is set to the
  3153. script where 'foldexpr' was set, script-local items can be accessed.
  3154. See |fold-expr| for the usage.
  3155. The expression will be evaluated in the |sandbox| if set from a
  3156. modeline, see |sandbox-option|.
  3157. This option can't be set from a |modeline| when the 'diff' option is
  3158. on or the 'modelineexpr' option is off.
  3159. It is not allowed to change text or jump to another window while
  3160. evaluating 'foldexpr' |textlock|.
  3161. *'foldignore'* *'fdi'*
  3162. 'foldignore' 'fdi' string (default: "#")
  3163. local to window
  3164. {not available when compiled without the |+folding|
  3165. feature}
  3166. Used only when 'foldmethod' is "indent". Lines starting with
  3167. characters in 'foldignore' will get their fold level from surrounding
  3168. lines. White space is skipped before checking for this character.
  3169. The default "#" works well for C programs. See |fold-indent|.
  3170. *'foldlevel'* *'fdl'*
  3171. 'foldlevel' 'fdl' number (default: 0)
  3172. local to window
  3173. {not available when compiled without the |+folding|
  3174. feature}
  3175. Sets the fold level: Folds with a higher level will be closed.
  3176. Setting this option to zero will close all folds. Higher numbers will
  3177. close fewer folds.
  3178. This option is set by commands like |zm|, |zM| and |zR|.
  3179. See |fold-foldlevel|.
  3180. *'foldlevelstart'* *'fdls'*
  3181. 'foldlevelstart' 'fdls' number (default: -1)
  3182. global
  3183. {not available when compiled without the |+folding|
  3184. feature}
  3185. Sets 'foldlevel' when starting to edit another buffer in a window.
  3186. Useful to always start editing with all folds closed (value zero),
  3187. some folds closed (one) or no folds closed (99).
  3188. This is done before reading any modeline, thus a setting in a modeline
  3189. overrules this option. Starting to edit a file for |diff-mode| also
  3190. ignores this option and closes all folds.
  3191. It is also done before BufReadPre autocommands, to allow an autocmd to
  3192. overrule the 'foldlevel' value for specific files.
  3193. When the value is negative, it is not used.
  3194. *'foldmarker'* *'fmr'* *E536*
  3195. 'foldmarker' 'fmr' string (default: "{{{,}}}")
  3196. local to window
  3197. {not available when compiled without the |+folding|
  3198. feature}
  3199. The start and end marker used when 'foldmethod' is "marker". There
  3200. must be one comma, which separates the start and end marker. The
  3201. marker is a literal string (a regular expression would be too slow).
  3202. See |fold-marker|.
  3203. *'foldmethod'* *'fdm'*
  3204. 'foldmethod' 'fdm' string (default: "manual")
  3205. local to window
  3206. {not available when compiled without the |+folding|
  3207. feature}
  3208. The kind of folding used for the current window. Possible values:
  3209. |fold-manual| manual Folds are created manually.
  3210. |fold-indent| indent Lines with equal indent form a fold.
  3211. |fold-expr| expr 'foldexpr' gives the fold level of a line.
  3212. |fold-marker| marker Markers are used to specify folds.
  3213. |fold-syntax| syntax Syntax highlighting items specify folds.
  3214. |fold-diff| diff Fold text that is not changed.
  3215. *'foldminlines'* *'fml'*
  3216. 'foldminlines' 'fml' number (default: 1)
  3217. local to window
  3218. {not available when compiled without the |+folding|
  3219. feature}
  3220. Sets the number of screen lines above which a fold can be displayed
  3221. closed. Also for manually closed folds. With the default value of
  3222. one a fold can only be closed if it takes up two or more screen lines.
  3223. Set to zero to be able to close folds of just one screen line.
  3224. Note that this only has an effect on what is displayed. After using
  3225. "zc" to close a fold, which is displayed open because it's smaller
  3226. than 'foldminlines', a following "zc" may close a containing fold.
  3227. *'foldnestmax'* *'fdn'*
  3228. 'foldnestmax' 'fdn' number (default: 20)
  3229. local to window
  3230. {not available when compiled without the |+folding|
  3231. feature}
  3232. Sets the maximum nesting of folds for the "indent" and "syntax"
  3233. methods. This avoids that too many folds will be created. Using more
  3234. than 20 doesn't work, because the internal limit is 20.
  3235. *'foldopen'* *'fdo'*
  3236. 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
  3237. search,tag,undo")
  3238. global
  3239. {not available when compiled without the |+folding|
  3240. feature}
  3241. Specifies for which type of commands folds will be opened, if the
  3242. command moves the cursor into a closed fold. It is a comma-separated
  3243. list of items.
  3244. NOTE: When the command is part of a mapping this option is not used.
  3245. Add the |zv| command to the mapping to get the same effect.
  3246. (rationale: the mapping may want to control opening folds itself)
  3247. item commands ~
  3248. all any
  3249. block "(", "{", "[[", "[{", etc.
  3250. hor horizontal movements: "l", "w", "fx", etc.
  3251. insert any command in Insert mode
  3252. jump far jumps: "G", "gg", etc.
  3253. mark jumping to a mark: "'m", CTRL-O, etc.
  3254. percent "%"
  3255. quickfix ":cn", ":crew", ":make", etc.
  3256. search search for a pattern: "/", "n", "*", "gd", etc.
  3257. (not for a search pattern in a ":" command)
  3258. Also for |[s| and |]s|.
  3259. tag jumping to a tag: ":ta", CTRL-T, etc.
  3260. undo undo or redo: "u" and CTRL-R
  3261. When a movement command is used for an operator (e.g., "dl" or "y%")
  3262. this option is not used. This means the operator will include the
  3263. whole closed fold.
  3264. Note that vertical movements are not here, because it would make it
  3265. very difficult to move onto a closed fold.
  3266. In insert mode the folds containing the cursor will always be open
  3267. when text is inserted.
  3268. To close folds you can re-apply 'foldlevel' with the |zx| command or
  3269. set the 'foldclose' option to "all".
  3270. *'foldtext'* *'fdt'*
  3271. 'foldtext' 'fdt' string (default: "foldtext()")
  3272. local to window
  3273. {not available when compiled without the |+folding|
  3274. feature}
  3275. An expression which is used to specify the text displayed for a closed
  3276. fold. The context is set to the script where 'foldexpr' was set,
  3277. script-local items can be accessed. See |fold-foldtext| for the
  3278. usage.
  3279. The expression will be evaluated in the |sandbox| if set from a
  3280. modeline, see |sandbox-option|.
  3281. This option cannot be set in a modeline when 'modelineexpr' is off.
  3282. It is not allowed to change text or jump to another window while
  3283. evaluating 'foldtext' |textlock|.
  3284. *'formatexpr'* *'fex'*
  3285. 'formatexpr' 'fex' string (default "")
  3286. local to buffer
  3287. {not available when compiled without the |+eval|
  3288. feature}
  3289. Expression which is evaluated to format a range of lines for the |gq|
  3290. operator or automatic formatting (see 'formatoptions'). When this
  3291. option is empty 'formatprg' is used.
  3292. The |v:lnum| variable holds the first line to be formatted.
  3293. The |v:count| variable holds the number of lines to be formatted.
  3294. The |v:char| variable holds the character that is going to be
  3295. inserted if the expression is being evaluated due to
  3296. automatic formatting. This can be empty. Don't insert
  3297. it yet!
  3298. Example: >
  3299. :set formatexpr=mylang#Format()
  3300. < This will invoke the mylang#Format() function in the
  3301. autoload/mylang.vim file in 'runtimepath'. |autoload|
  3302. The advantage of using a function call without arguments is that it is
  3303. faster, see |expr-option-function|.
  3304. The expression is also evaluated when 'textwidth' is set and adding
  3305. text beyond that limit. This happens under the same conditions as
  3306. when internal formatting is used. Make sure the cursor is kept in the
  3307. same spot relative to the text then! The |mode()| function will
  3308. return "i" or "R" in this situation.
  3309. When the expression evaluates to non-zero Vim will fall back to using
  3310. the internal format mechanism.
  3311. If the expression starts with s: or |<SID>|, then it is replaced with
  3312. the script ID (|local-function|). Example: >
  3313. set formatexpr=s:MyFormatExpr()
  3314. set formatexpr=<SID>SomeFormatExpr()
  3315. < Otherwise, the expression is evaluated in the context of the script
  3316. where the option was set, thus script-local items are available.
  3317. The expression will be evaluated in the |sandbox| when set from a
  3318. modeline, see |sandbox-option|. That stops the option from working,
  3319. since changing the buffer text is not allowed.
  3320. This option cannot be set in a modeline when 'modelineexpr' is off.
  3321. NOTE: This option is set to "" when 'compatible' is set.
  3322. *'formatlistpat'* *'flp'*
  3323. 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
  3324. local to buffer
  3325. A pattern that is used to recognize a list header. This is used for
  3326. the "n" flag in 'formatoptions'.
  3327. The pattern must match exactly the text that will be the indent for
  3328. the line below it. You can use |/\ze| to mark the end of the match
  3329. while still checking more characters. There must be a character
  3330. following the pattern, when it matches the whole line it is handled
  3331. like there is no match.
  3332. The default recognizes a number, followed by an optional punctuation
  3333. character and white space.
  3334. *'formatoptions'* *'fo'*
  3335. 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
  3336. local to buffer
  3337. This is a sequence of letters which describes how automatic
  3338. formatting is to be done. See |fo-table|. When the 'paste' option is
  3339. on, no formatting is done (like 'formatoptions' is empty). Commas can
  3340. be inserted for readability.
  3341. To avoid problems with flags that are added in the future, use the
  3342. "+=" and "-=" feature of ":set" |add-option-flags|.
  3343. NOTE: This option is set to the Vi default value when 'compatible' is
  3344. set and to the Vim default value when 'compatible' is reset.
  3345. *'formatprg'* *'fp'*
  3346. 'formatprg' 'fp' string (default "")
  3347. global or local to buffer |global-local|
  3348. The name of an external program that will be used to format the lines
  3349. selected with the |gq| operator. The program must take the input on
  3350. stdin and produce the output on stdout. The Unix program "fmt" is
  3351. such a program.
  3352. If the 'formatexpr' option is not empty it will be used instead.
  3353. Otherwise, if 'formatprg' option is an empty string, the internal
  3354. format function will be used |C-indenting|.
  3355. Environment variables are expanded |:set_env|. See |option-backslash|
  3356. about including spaces and backslashes.
  3357. This option cannot be set from a |modeline| or in the |sandbox|, for
  3358. security reasons.
  3359. *'fsync'* *'fs'* *'nofsync'* *'nofs'*
  3360. 'fsync' 'fs' boolean (default on)
  3361. global
  3362. When on, the library function fsync() will be called after writing a
  3363. file. This will flush a file to disk, ensuring that it is safely
  3364. written even on filesystems which do metadata-only journaling. This
  3365. will force the harddrive to spin up on Linux systems running in laptop
  3366. mode, so it may be undesirable in some situations. Be warned that
  3367. turning this off increases the chances of data loss after a crash. On
  3368. systems without an fsync() implementation, this variable is always
  3369. off.
  3370. Also see 'swapsync' for controlling fsync() on swap files.
  3371. 'fsync' also applies to |writefile()| (unless a flag is used to
  3372. overrule it) and when writing undo files (see |undo-persistence|).
  3373. This option cannot be set from a |modeline| or in the |sandbox|, for
  3374. security reasons.
  3375. *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
  3376. 'gdefault' 'gd' boolean (default off)
  3377. global
  3378. When on, the ":substitute" flag 'g' is default on. This means that
  3379. all matches in a line are substituted instead of one. When a 'g' flag
  3380. is given to a ":substitute" command, this will toggle the substitution
  3381. of all or one match. See |complex-change|.
  3382. command 'gdefault' on 'gdefault' off ~
  3383. :s/// subst. all subst. one
  3384. :s///g subst. one subst. all
  3385. :s///gg subst. all subst. one
  3386. NOTE: This option is reset when 'compatible' is set.
  3387. DEPRECATED: Setting this option may break plugins that are not aware
  3388. of this option. Also, many users get confused that adding the /g flag
  3389. has the opposite effect of that it normally does.
  3390. This option is not used in |Vim9| script.
  3391. *'grepformat'* *'gfm'*
  3392. 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
  3393. global
  3394. Format to recognize for the ":grep" command output.
  3395. This is a scanf-like string that uses the same format as the
  3396. 'errorformat' option: see |errorformat|.
  3397. *'grepprg'* *'gp'*
  3398. 'grepprg' 'gp' string (default "grep -n ",
  3399. Unix: "grep -n $* /dev/null",
  3400. Win32: "findstr /n" or "grep -n",
  3401. VMS: "SEARCH/NUMBERS ")
  3402. global or local to buffer |global-local|
  3403. Program to use for the |:grep| command. This option may contain '%'
  3404. and '#' characters, which are expanded like when used in a command-
  3405. line. The placeholder "$*" is allowed to specify where the arguments
  3406. will be included. Environment variables are expanded |:set_env|. See
  3407. |option-backslash| about including spaces and backslashes.
  3408. When your "grep" accepts the "-H" argument, use this to make ":grep"
  3409. also work well with a single file: >
  3410. :set grepprg=grep\ -nH
  3411. < Special value: When 'grepprg' is set to "internal" the |:grep| command
  3412. works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
  3413. |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
  3414. See also the section |:make_makeprg|, since most of the comments there
  3415. apply equally to 'grepprg'.
  3416. For Win32, the default is "findstr /n" if "findstr.exe" can be found,
  3417. otherwise it's "grep -n".
  3418. This option cannot be set from a |modeline| or in the |sandbox|, for
  3419. security reasons.
  3420. *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
  3421. 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
  3422. ve:ver35-Cursor,
  3423. o:hor50-Cursor,
  3424. i-ci:ver25-Cursor/lCursor,
  3425. r-cr:hor20-Cursor/lCursor,
  3426. sm:block-Cursor
  3427. -blinkwait175-blinkoff150-blinkon175",
  3428. for Win32 console:
  3429. "n-v-c:block,o:hor50,i-ci:hor15,
  3430. r-cr:hor30,sm:block")
  3431. global
  3432. {only available when compiled with GUI enabled, and
  3433. for Win32 console}
  3434. This option tells Vim what the cursor should look like in different
  3435. modes. It fully works in the GUI. In a Win32 console, only the
  3436. height of the cursor can be changed. This can be done by specifying a
  3437. block cursor, or a percentage for a vertical or horizontal cursor.
  3438. For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
  3439. used.
  3440. The option is a comma-separated list of parts. Each part consist of a
  3441. mode-list and an argument-list:
  3442. mode-list:argument-list,mode-list:argument-list,..
  3443. The mode-list is a dash separated list of these modes:
  3444. n Normal mode
  3445. v Visual mode
  3446. ve Visual mode with 'selection' "exclusive" (same as 'v',
  3447. if not specified)
  3448. o Operator-pending mode
  3449. i Insert mode
  3450. r Replace mode
  3451. c Command-line Normal (append) mode
  3452. ci Command-line Insert mode
  3453. cr Command-line Replace mode
  3454. sm showmatch in Insert mode
  3455. a all modes
  3456. The argument-list is a dash separated list of these arguments:
  3457. hor{N} horizontal bar, {N} percent of the character height
  3458. ver{N} vertical bar, {N} percent of the character width
  3459. block block cursor, fills the whole character
  3460. [only one of the above three should be present]
  3461. blinkwait{N} *cursor-blinking*
  3462. blinkon{N}
  3463. blinkoff{N}
  3464. blink times for cursor: blinkwait is the delay before
  3465. the cursor starts blinking, blinkon is the time that
  3466. the cursor is shown and blinkoff is the time that the
  3467. cursor is not shown. The times are in msec. When one
  3468. of the numbers is zero, there is no blinking. The
  3469. default is: "blinkwait700-blinkon400-blinkoff250".
  3470. These numbers are used for a missing entry. This
  3471. means that blinking is enabled by default. To switch
  3472. blinking off you can use "blinkon0". The cursor only
  3473. blinks when Vim is waiting for input, not while
  3474. executing a command.
  3475. To make the cursor blink in an xterm, see
  3476. |xterm-blink|.
  3477. {group-name}
  3478. a highlight group name, that sets the color and font
  3479. for the cursor
  3480. {group-name}/{group-name}
  3481. Two highlight group names, the first is used when
  3482. no language mappings are used, the other when they
  3483. are. |language-mapping|
  3484. Examples of parts:
  3485. n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
  3486. block cursor with colors from the "nCursor"
  3487. highlight group
  3488. i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
  3489. In Insert and Command-line Insert mode, use a
  3490. 30% vertical bar cursor with colors from the
  3491. "iCursor" highlight group. Blink a bit
  3492. faster.
  3493. The 'a' mode is different. It will set the given argument-list for
  3494. all modes. It does not reset anything to defaults. This can be used
  3495. to do a common setting for all modes. For example, to switch off
  3496. blinking: "a:blinkon0"
  3497. Examples of cursor highlighting: >
  3498. :highlight Cursor gui=reverse guifg=NONE guibg=NONE
  3499. :highlight Cursor gui=NONE guifg=bg guibg=fg
  3500. <
  3501. *'guifont'* *'gfn'*
  3502. *E235* *E596*
  3503. 'guifont' 'gfn' string (default "")
  3504. global
  3505. {only available when compiled with GUI enabled}
  3506. This is a list of fonts which will be used for the GUI version of Vim.
  3507. In its simplest form the value is just one font name.
  3508. See |gui-font| for the details.
  3509. *'guifontset'* *'gfs'*
  3510. *E250* *E252* *E234* *E597* *E598*
  3511. 'guifontset' 'gfs' string (default "")
  3512. global
  3513. {only available when compiled with GUI enabled and
  3514. with the |+xfontset| feature}
  3515. {not available in the GTK+ GUI}
  3516. When not empty, specifies two (or more) fonts to be used. The first
  3517. one for normal English, the second one for your special language. See
  3518. |xfontset|.
  3519. *'guifontwide'* *'gfw'* *E231* *E533* *E534*
  3520. 'guifontwide' 'gfw' string (default "")
  3521. global
  3522. {only available when compiled with GUI enabled}
  3523. When not empty, specifies a comma-separated list of fonts to be used
  3524. for double-width characters. The first font that can be loaded is
  3525. used. See |gui-fontwide|.
  3526. *'guiheadroom'* *'ghr'*
  3527. 'guiheadroom' 'ghr' number (default 50)
  3528. global
  3529. {only for GTK and X11 GUI}
  3530. The number of pixels subtracted from the screen height when fitting
  3531. the GUI window on the screen. Set this before the GUI is started,
  3532. e.g., in your |gvimrc| file. When zero, the whole screen height will
  3533. be used by the window. When positive, the specified number of pixel
  3534. lines will be left for window decorations and other items on the
  3535. screen. Set it to a negative value to allow windows taller than the
  3536. screen.
  3537. *'guiligatures'* *'gli'* *E1243*
  3538. 'guiligatures' 'gli' string (default "")
  3539. global
  3540. {only for GTK GUI}
  3541. List of ASCII characters that, when combined together, can create more
  3542. complex shapes. Each character must be a printable ASCII character
  3543. with a value in the 32-127 range.
  3544. Example: >
  3545. :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
  3546. < Changing this option updates screen output immediately. Set it to an
  3547. empty string to disable ligatures.
  3548. *'guioptions'* *'go'*
  3549. 'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
  3550. "t" is removed in |defaults.vim|),
  3551. "aegimrLtT" (GTK and Motif),
  3552. )
  3553. global
  3554. {only available when compiled with GUI enabled}
  3555. This option only has an effect in the GUI version of Vim. It is a
  3556. sequence of letters which describes what components and options of the
  3557. GUI should be used.
  3558. To avoid problems with flags that are added in the future, use the
  3559. "+=" and "-=" feature of ":set" |add-option-flags|.
  3560. Valid characters are as follows:
  3561. *'go-!'*
  3562. '!' External commands are executed in a terminal window. Without
  3563. this flag the MS-Windows GUI will open a console window to
  3564. execute the command. The Unix GUI will simulate a dumb
  3565. terminal to list the command output.
  3566. The terminal window will be positioned at the bottom, and grow
  3567. upwards as needed.
  3568. *'go-a'*
  3569. 'a' Autoselect: If present, then whenever VISUAL mode is started,
  3570. or the Visual area extended, Vim tries to become the owner of
  3571. the windowing system's global selection. This means that the
  3572. Visually highlighted text is available for pasting into other
  3573. applications as well as into Vim itself. When the Visual mode
  3574. ends, possibly due to an operation on the text, or when an
  3575. application wants to paste the selection, the highlighted text
  3576. is automatically yanked into the "* selection register.
  3577. Thus the selection is still available for pasting into other
  3578. applications after the VISUAL mode has ended.
  3579. If not present, then Vim won't become the owner of the
  3580. windowing system's global selection unless explicitly told to
  3581. by a yank or delete operation for the "* register.
  3582. The same applies to the modeless selection.
  3583. *'go-P'*
  3584. 'P' Like autoselect but using the "+ register instead of the "*
  3585. register.
  3586. *'go-A'*
  3587. 'A' Autoselect for the modeless selection. Like 'a', but only
  3588. applies to the modeless selection.
  3589. 'guioptions' autoselect Visual autoselect modeless ~
  3590. "" - -
  3591. "a" yes yes
  3592. "A" - yes
  3593. "aA" yes yes
  3594. When using a terminal see the 'clipboard' option.
  3595. *'go-c'*
  3596. 'c' Use console dialogs instead of popup dialogs for simple
  3597. choices.
  3598. *'go-d'*
  3599. 'd' Use dark theme variant if available. Currently only works for
  3600. GTK+ GUI.
  3601. *'go-e'*
  3602. 'e' Add tab pages when indicated with 'showtabline'.
  3603. 'guitablabel' can be used to change the text in the labels.
  3604. When 'e' is missing a non-GUI tab pages line may be used.
  3605. The GUI tabs are only supported on some systems, currently
  3606. GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
  3607. *'go-f'*
  3608. 'f' Foreground: Don't use fork() to detach the GUI from the shell
  3609. where it was started. Use this for programs that wait for the
  3610. editor to finish (e.g., an e-mail program). Alternatively you
  3611. can use "gvim -f" or ":gui -f" to start the GUI in the
  3612. foreground. |gui-fork|
  3613. Note: Set this option in the vimrc file. The forking may have
  3614. happened already when the |gvimrc| file is read.
  3615. *'go-i'*
  3616. 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
  3617. corner of the window. It's black&white on non-GTK, because of
  3618. limitations of X11. For a color icon, see |X11-icon|.
  3619. *'go-m'*
  3620. 'm' Menu bar is present.
  3621. *'go-M'*
  3622. 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
  3623. that this flag must be added in the .vimrc file, before
  3624. switching on syntax or filetype recognition (when the |gvimrc|
  3625. file is sourced the system menu has already been loaded; the
  3626. `:syntax on` and `:filetype on` commands load the menu too).
  3627. *'go-g'*
  3628. 'g' Grey menu items: Make menu items that are not active grey. If
  3629. 'g' is not included inactive menu items are not shown at all.
  3630. *'go-t'*
  3631. 't' Include tearoff menu items. Currently only works for Win32,
  3632. GTK+, and Motif 1.2 GUI.
  3633. *'go-T'*
  3634. 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
  3635. Photon GUIs.
  3636. *'go-r'*
  3637. 'r' Right-hand scrollbar is always present.
  3638. *'go-R'*
  3639. 'R' Right-hand scrollbar is present when there is a vertically
  3640. split window.
  3641. *'go-l'*
  3642. 'l' Left-hand scrollbar is always present.
  3643. *'go-L'*
  3644. 'L' Left-hand scrollbar is present when there is a vertically
  3645. split window.
  3646. *'go-b'*
  3647. 'b' Bottom (horizontal) scrollbar is present. Its size depends on
  3648. the longest visible line, or on the cursor line if the 'h'
  3649. flag is included. |gui-horiz-scroll|
  3650. *'go-h'*
  3651. 'h' Limit horizontal scrollbar size to the length of the cursor
  3652. line. Reduces computations. |gui-horiz-scroll|
  3653. And yes, you may even have scrollbars on the left AND the right if
  3654. you really want to :-). See |gui-scrollbars| for more information.
  3655. *'go-v'*
  3656. 'v' Use a vertical button layout for dialogs. When not included,
  3657. a horizontal layout is preferred, but when it doesn't fit a
  3658. vertical layout is used anyway. Not supported in GTK 3.
  3659. *'go-p'*
  3660. 'p' Use Pointer callbacks for X11 GUI. This is required for some
  3661. window managers. If the cursor is not blinking or hollow at
  3662. the right moment, try adding this flag. This must be done
  3663. before starting the GUI. Set it in your |gvimrc|. Adding or
  3664. removing it after the GUI has started has no effect.
  3665. *'go-F'*
  3666. 'F' Add a footer. Only for Motif. See |gui-footer|.
  3667. *'go-k'*
  3668. 'k' Keep the GUI window size when adding/removing a scrollbar, or
  3669. toolbar, tabline, etc. Instead, the behavior is similar to
  3670. when the window is maximized and will adjust 'lines' and
  3671. 'columns' to fit to the window. Without the 'k' flag Vim will
  3672. try to keep 'lines' and 'columns' the same when adding and
  3673. removing GUI components.
  3674. *'guipty'* *'noguipty'*
  3675. 'guipty' boolean (default on)
  3676. global
  3677. {only available when compiled with GUI enabled}
  3678. Only in the GUI: If on, an attempt is made to open a pseudo-tty for
  3679. I/O to/from shell commands. See |gui-pty|.
  3680. *'guitablabel'* *'gtl'*
  3681. 'guitablabel' 'gtl' string (default empty)
  3682. global
  3683. {only available when compiled with GUI enabled}
  3684. When non-empty describes the text to use in a label of the GUI tab
  3685. pages line. When empty and when the result is empty Vim will use a
  3686. default label. See |setting-guitablabel| for more info.
  3687. The format of this option is like that of 'statusline'.
  3688. 'guitabtooltip' is used for the tooltip, see below.
  3689. The expression will be evaluated in the |sandbox| when set from a
  3690. modeline, see |sandbox-option|.
  3691. This option cannot be set in a modeline when 'modelineexpr' is off.
  3692. Only used when the GUI tab pages line is displayed. 'e' must be
  3693. present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
  3694. used.
  3695. *'guitabtooltip'* *'gtt'*
  3696. 'guitabtooltip' 'gtt' string (default empty)
  3697. global
  3698. {only available when compiled with GUI enabled}
  3699. When non-empty describes the text to use in a tooltip for the GUI tab
  3700. pages line. When empty Vim will use a default tooltip.
  3701. This option is otherwise just like 'guitablabel' above.
  3702. You can include a line break. Simplest method is to use |:let|: >
  3703. :let &guitabtooltip = "line one\nline two"
  3704. <
  3705. *'helpfile'* *'hf'*
  3706. 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
  3707. (others) "$VIMRUNTIME/doc/help.txt")
  3708. global
  3709. Name of the main help file. All distributed help files should be
  3710. placed together in one directory. Additionally, all "doc" directories
  3711. in 'runtimepath' will be used.
  3712. Environment variables are expanded |:set_env|. For example:
  3713. "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
  3714. tried. Also see |$VIMRUNTIME| and |option-backslash| about including
  3715. spaces and backslashes.
  3716. This option cannot be set from a |modeline| or in the |sandbox|, for
  3717. security reasons.
  3718. *'helpheight'* *'hh'*
  3719. 'helpheight' 'hh' number (default 20)
  3720. global
  3721. Minimal initial height of the help window when it is opened with the
  3722. ":help" command. The initial height of the help window is half of the
  3723. current window, or (when the 'ea' option is on) the same as other
  3724. windows. When the height is less than 'helpheight', the height is
  3725. set to 'helpheight'. Set to zero to disable.
  3726. *'helplang'* *'hlg'*
  3727. 'helplang' 'hlg' string (default: messages language or empty)
  3728. global
  3729. {only available when compiled with the |+multi_lang|
  3730. feature}
  3731. Comma-separated list of languages. Vim will use the first language
  3732. for which the desired help can be found. The English help will always
  3733. be used as a last resort. You can add "en" to prefer English over
  3734. another language, but that will only find tags that exist in that
  3735. language and not in the English help.
  3736. Example: >
  3737. :set helplang=de,it
  3738. < This will first search German, then Italian and finally English help
  3739. files.
  3740. When using |CTRL-]| and ":help!" in a non-English help file Vim will
  3741. try to find the tag in the current language before using this option.
  3742. See |help-translated|.
  3743. *'hidden'* *'hid'* *'nohidden'* *'nohid'*
  3744. 'hidden' 'hid' boolean (default off)
  3745. global
  3746. When off a buffer is unloaded when it is |abandon|ed. When on a
  3747. buffer becomes hidden when it is |abandon|ed. If the buffer is still
  3748. displayed in another window, it does not become hidden, of course.
  3749. The commands that move through the buffer list sometimes make a buffer
  3750. hidden even if the 'hidden' option is off when these three are true:
  3751. - the buffer is modified
  3752. - 'autowrite' is off or writing is not possible
  3753. - the '!' flag was used
  3754. Also see |windows.txt|.
  3755. To only make one buffer hidden use the 'bufhidden' option.
  3756. This option is set for one command with ":hide {command}" |:hide|.
  3757. WARNING: It's easy to forget that you have changes in hidden buffers.
  3758. Think twice when using ":q!" or ":qa!".
  3759. *'highlight'* *'hl'*
  3760. 'highlight' 'hl' string (default (as a single string):
  3761. "8:SpecialKey,~:EndOfBuffer,@:NonText,
  3762. d:Directory,e:ErrorMsg,i:IncSearch,
  3763. l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
  3764. a:LineNrAbove,b:LineNrBelow,
  3765. N:CursorLineNr,r:Question,s:StatusLine,
  3766. S:StatusLineNC,c:VertSplit,t:Title,
  3767. v:Visual,V:VisualNOS,w:WarningMsg,
  3768. W:WildMenu,f:Folded,F:FoldColumn,
  3769. A:DiffAdd,C:DiffChange,D:DiffDelete,
  3770. T:DiffText,>:SignColumn,-:Conceal,
  3771. B:SpellBad,P:SpellCap,R:SpellRare,
  3772. L:SpellLocal,+:Pmenu,=:PmenuSel,
  3773. x:PmenuSbar,X:PmenuThumb,*:TabLine,
  3774. #:TabLineSel,_:TabLineFill,!:CursorColumn,
  3775. .:CursorLine,o:ColorColumn,q:QuickFixLine,
  3776. z:StatusLineTerm,Z:StatusLineTermNC")
  3777. global
  3778. This option can be used to set highlighting mode for various
  3779. occasions. It is a comma-separated list of character pairs. The
  3780. first character in a pair gives the occasion, the second the mode to
  3781. use for that occasion. The occasions are:
  3782. |hl-SpecialKey| 8 Meta and special keys listed with ":map"
  3783. |hl-EndOfBuffer| ~ lines after the last line in the buffer
  3784. |hl-NonText| @ '@' at the end of the window and
  3785. characters from 'showbreak'
  3786. |hl-Directory| d directories in CTRL-D listing and other special
  3787. things in listings
  3788. |hl-ErrorMsg| e error messages
  3789. h (obsolete, ignored)
  3790. |hl-IncSearch| i 'incsearch' highlighting
  3791. |hl-CurSearch| y current instance of last search pattern
  3792. |hl-Search| l last search pattern highlighting (see 'hlsearch')
  3793. |hl-MoreMsg| m |more-prompt|
  3794. |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
  3795. |hl-LineNr| n line number for ":number" and ":#" commands, and
  3796. when 'number' or 'relativenumber' option is set.
  3797. |hl-LineNrAbove| a line number above the cursor for when the
  3798. 'relativenumber' option is set.
  3799. |hl-LineNrBelow| b line number below the cursor for when the
  3800. 'relativenumber' option is set.
  3801. |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
  3802. set.
  3803. |hl-Question| r |hit-enter| prompt and yes/no questions
  3804. |hl-StatusLine| s status line of current window |status-line|
  3805. |hl-StatusLineNC| S status lines of not-current windows
  3806. |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
  3807. |hl-VertSplit| c column used to separate vertically split windows
  3808. |hl-Visual| v Visual mode
  3809. |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
  3810. Selection" Only X11 Gui's |gui-x11| and
  3811. |xterm-clipboard|.
  3812. |hl-WarningMsg| w warning messages
  3813. |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
  3814. |hl-Folded| f line used for closed folds
  3815. |hl-FoldColumn| F 'foldcolumn'
  3816. |hl-DiffAdd| A added line in diff mode
  3817. |hl-DiffChange| C changed line in diff mode
  3818. |hl-DiffDelete| D deleted line in diff mode
  3819. |hl-DiffText| T inserted text in diff mode
  3820. |hl-SignColumn| > column used for |signs|
  3821. |hl-Conceal| - the placeholders used for concealed characters
  3822. (see 'conceallevel')
  3823. |hl-SpellBad| B misspelled word |spell|
  3824. |hl-SpellCap| P word that should start with capital |spell|
  3825. |hl-SpellRare| R rare word |spell|
  3826. |hl-SpellLocal| L word from other region |spell|
  3827. |hl-Pmenu| + popup menu normal line
  3828. |hl-PmenuSel| = popup menu selected line
  3829. |hl-PmenuSbar| x popup menu scrollbar
  3830. |hl-PmenuThumb| X popup menu scrollbar thumb
  3831. The display modes are:
  3832. r reverse (termcap entry "mr" and "me")
  3833. i italic (termcap entry "ZH" and "ZR")
  3834. b bold (termcap entry "md" and "me")
  3835. s standout (termcap entry "so" and "se")
  3836. u underline (termcap entry "us" and "ue")
  3837. c undercurl (termcap entry "Us" and "Ce")
  3838. 2 double underline (termcap entry "Ds" and "Ce")
  3839. d dotted underline (termcap entry "ds" and "Ce")
  3840. = dashed underline (termcap entry "Ds" and "Ce")
  3841. t strikethrough (termcap entry "Ts" and "Te")
  3842. n no highlighting
  3843. - no highlighting
  3844. : use a highlight group
  3845. The default is used for occasions that are not included.
  3846. If you want to change what the display modes do, see |dos-colors|
  3847. for an example.
  3848. When using the ':' display mode, this must be followed by the name of
  3849. a highlight group. A highlight group can be used to define any type
  3850. of highlighting, including using color. See |:highlight| on how to
  3851. define one. The default uses a different group for each occasion.
  3852. See |highlight-default| for the default highlight groups.
  3853. *'history'* *'hi'*
  3854. 'history' 'hi' number (Vim default: 50, Vi default: 0,
  3855. set to 200 in |defaults.vim|)
  3856. global
  3857. A history of ":" commands, and a history of previous search patterns
  3858. is remembered. This option decides how many entries may be stored in
  3859. each of these histories (see |cmdline-editing|).
  3860. The maximum value is 10000.
  3861. NOTE: This option is set to the Vi default value when 'compatible' is
  3862. set and to the Vim default value when 'compatible' is reset.
  3863. *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
  3864. 'hkmap' 'hk' boolean (default off)
  3865. global
  3866. {only available when compiled with the |+rightleft|
  3867. feature}
  3868. When on, the keyboard is mapped for the Hebrew character set.
  3869. Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
  3870. toggle this option. See |rileft.txt|.
  3871. NOTE: This option is reset when 'compatible' is set.
  3872. *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
  3873. 'hkmapp' 'hkp' boolean (default off)
  3874. global
  3875. {only available when compiled with the |+rightleft|
  3876. feature}
  3877. When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
  3878. This is useful if you have a non-Hebrew keyboard.
  3879. See |rileft.txt|.
  3880. NOTE: This option is reset when 'compatible' is set.
  3881. *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
  3882. 'hlsearch' 'hls' boolean (default off)
  3883. global
  3884. {not available when compiled without the
  3885. |+extra_search| feature}
  3886. When there is a previous search pattern, highlight all its matches.
  3887. The type of highlighting used can be set with the 'l' occasion in the
  3888. 'highlight' option. This uses the "Search" highlight group by
  3889. default. Note that only the matching text is highlighted, any offsets
  3890. are not applied. If the "CurSearch" highlight group is set then the
  3891. current match is highlighted with that.
  3892. See also: 'incsearch' and |:match|.
  3893. When you get bored looking at the highlighted matches, you can turn it
  3894. off with |:nohlsearch|. This does not change the option value, as
  3895. soon as you use a search command, the highlighting comes back.
  3896. 'redrawtime' specifies the maximum time spent on finding matches.
  3897. When the search pattern can match an end-of-line, Vim will try to
  3898. highlight all of the matched text. However, this depends on where the
  3899. search starts. This will be the first line in the window or the first
  3900. line below a closed fold. A match in a previous line which is not
  3901. drawn may not continue in a newly drawn line.
  3902. You can specify whether the highlight status is restored on startup
  3903. with the 'h' flag in 'viminfo' |viminfo-h|.
  3904. NOTE: This option is reset when 'compatible' is set.
  3905. *'icon'* *'noicon'*
  3906. 'icon' boolean (default off, on when title can be restored)
  3907. global
  3908. When on, the icon text of the window will be set to the value of
  3909. 'iconstring' (if it is not empty), or to the name of the file
  3910. currently being edited. Only the last part of the name is used.
  3911. Overridden by the 'iconstring' option.
  3912. Only works if the terminal supports setting window icons (currently
  3913. only X11 GUI and terminals with a non-empty 't_IS' option - these are
  3914. Unix xterm and iris-ansi by default, where 't_IS' is taken from the
  3915. builtin termcap).
  3916. When Vim was compiled with HAVE_X11 defined, the original icon will be
  3917. restored if possible |X11|. See |X11-icon| for changing the icon on
  3918. X11.
  3919. For MS-Windows the icon can be changed, see |windows-icon|.
  3920. *'iconstring'*
  3921. 'iconstring' string (default "")
  3922. global
  3923. When this option is not empty, it will be used for the icon text of
  3924. the window. This happens only when the 'icon' option is on.
  3925. Only works if the terminal supports setting window icon text
  3926. (currently only X11 GUI and terminals with a non-empty 't_IS' option).
  3927. Does not work for MS-Windows.
  3928. When Vim was compiled with HAVE_X11 defined, the original icon will be
  3929. restored if possible |X11|.
  3930. When this option contains printf-style '%' items, they will be
  3931. expanded according to the rules used for 'statusline'. See
  3932. 'titlestring' for example settings.
  3933. This option cannot be set in a modeline when 'modelineexpr' is off.
  3934. {not available when compiled without the |+statusline| feature}
  3935. *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
  3936. 'ignorecase' 'ic' boolean (default off)
  3937. global
  3938. Ignore case in search patterns. Also used when searching in the tags
  3939. file.
  3940. Also see 'smartcase' and 'tagcase'.
  3941. Can be overruled by using "\c" or "\C" in the pattern, see
  3942. |/ignorecase|.
  3943. *'imactivatefunc'* *'imaf'*
  3944. 'imactivatefunc' 'imaf' string (default "")
  3945. global
  3946. This option specifies a function that will be called to
  3947. activate or deactivate the Input Method. The value can be the name of
  3948. a function, a |lambda| or a |Funcref|. See |option-value-function| for
  3949. more information.
  3950. It is not used in the MS-Windows GUI version.
  3951. The expression will be evaluated in the |sandbox| when set from a
  3952. modeline, see |sandbox-option|.
  3953. Example: >
  3954. function ImActivateFunc(active)
  3955. if a:active
  3956. ... do something
  3957. else
  3958. ... do something
  3959. endif
  3960. " return value is not used
  3961. endfunction
  3962. set imactivatefunc=ImActivateFunc
  3963. <
  3964. *'imactivatekey'* *'imak'*
  3965. 'imactivatekey' 'imak' string (default "")
  3966. global
  3967. {only available when compiled with |+xim| and
  3968. |+GUI_GTK|} *E599*
  3969. Specifies the key that your Input Method in X-Windows uses for
  3970. activation. When this is specified correctly, vim can fully control
  3971. IM with 'imcmdline', 'iminsert' and 'imsearch'.
  3972. You can't use this option to change the activation key, the option
  3973. tells Vim what the key is.
  3974. Format:
  3975. [MODIFIER_FLAG-]KEY_STRING
  3976. These characters can be used for MODIFIER_FLAG (case is ignored):
  3977. S Shift key
  3978. L Lock key
  3979. C Control key
  3980. 1 Mod1 key
  3981. 2 Mod2 key
  3982. 3 Mod3 key
  3983. 4 Mod4 key
  3984. 5 Mod5 key
  3985. Combinations are allowed, for example "S-C-space" or "SC-space" are
  3986. both shift+ctrl+space.
  3987. See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
  3988. Example: >
  3989. :set imactivatekey=S-space
  3990. < "S-space" means shift+space. This is the activation key for kinput2 +
  3991. canna (Japanese), and ami (Korean).
  3992. *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
  3993. 'imcmdline' 'imc' boolean (default off)
  3994. global
  3995. When set the Input Method is always on when starting to edit a command
  3996. line, unless entering a search pattern (see 'imsearch' for that).
  3997. Setting this option is useful when your input method allows entering
  3998. English characters directly, e.g., when it's used to type accented
  3999. characters with dead keys.
  4000. *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
  4001. 'imdisable' 'imd' boolean (default off, on for some systems (SGI))
  4002. global
  4003. When set the Input Method is never used. This is useful to disable
  4004. the IM when it doesn't work properly.
  4005. Currently this option is on by default for SGI/IRIX machines. This
  4006. may change in later releases.
  4007. *'iminsert'* *'imi'*
  4008. 'iminsert' 'imi' number (default 0)
  4009. local to buffer
  4010. Specifies whether :lmap or an Input Method (IM) is to be used in
  4011. Insert mode. Valid values:
  4012. 0 :lmap is off and IM is off
  4013. 1 :lmap is ON and IM is off
  4014. 2 :lmap is off and IM is ON
  4015. To always reset the option to zero when leaving Insert mode with <Esc>
  4016. this can be used: >
  4017. :inoremap <ESC> <ESC>:set iminsert=0<CR>
  4018. < This makes :lmap and IM turn off automatically when leaving Insert
  4019. mode.
  4020. Note that this option changes when using CTRL-^ in Insert mode
  4021. |i_CTRL-^|.
  4022. The value is set to 1 when setting 'keymap' to a valid keymap name.
  4023. It is also used for the argument of commands like "r" and "f".
  4024. The value 0 may not work correctly with Motif with some XIM
  4025. methods. Use 'imdisable' to disable XIM then.
  4026. You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
  4027. via external command if Vim is not compiled with the |+xim|,
  4028. |+multi_byte_ime| or |global-ime|.
  4029. *'imsearch'* *'ims'*
  4030. 'imsearch' 'ims' number (default -1)
  4031. local to buffer
  4032. Specifies whether :lmap or an Input Method (IM) is to be used when
  4033. entering a search pattern. Valid values:
  4034. -1 the value of 'iminsert' is used, makes it look like
  4035. 'iminsert' is also used when typing a search pattern
  4036. 0 :lmap is off and IM is off
  4037. 1 :lmap is ON and IM is off
  4038. 2 :lmap is off and IM is ON
  4039. Note that this option changes when using CTRL-^ in Command-line mode
  4040. |c_CTRL-^|.
  4041. The value is set to 1 when it is not -1 and setting the 'keymap'
  4042. option to a valid keymap name.
  4043. The value 0 may not work correctly with Motif with some XIM
  4044. methods. Use 'imdisable' to disable XIM then.
  4045. *'imstatusfunc'* *'imsf'*
  4046. 'imstatusfunc' 'imsf' string (default "")
  4047. global
  4048. This option specifies a function that is called to obtain the status
  4049. of Input Method. It must return a positive number when IME is active.
  4050. The value can be the name of a function, a |lambda| or a |Funcref|.
  4051. See |option-value-function| for more information.
  4052. It is not used in the MS-Windows GUI version.
  4053. Example: >
  4054. function ImStatusFunc()
  4055. let is_active = ...do something
  4056. return is_active ? 1 : 0
  4057. endfunction
  4058. set imstatusfunc=ImStatusFunc
  4059. <
  4060. NOTE: This function is invoked very often. Keep it fast.
  4061. The expression will be evaluated in the |sandbox| when set from a
  4062. modeline, see |sandbox-option|.
  4063. *'imstyle'* *'imst'*
  4064. 'imstyle' 'imst' number (default 1)
  4065. global
  4066. {only available when compiled with |+xim| and
  4067. |+GUI_GTK|}
  4068. This option specifies the input style of Input Method:
  4069. 0 use on-the-spot style
  4070. 1 over-the-spot style
  4071. See: |xim-input-style|
  4072. For a long time on-the-spot style had been used in the GTK version of
  4073. vim, however, it is known that it causes troubles when using mappings,
  4074. |single-repeat|, etc. Therefore over-the-spot style becomes the
  4075. default now. This should work fine for most people, however if you
  4076. have any problem with it, try using on-the-spot style.
  4077. The expression will be evaluated in the |sandbox| when set from a
  4078. modeline, see |sandbox-option|.
  4079. *'include'* *'inc'*
  4080. 'include' 'inc' string (default "^\s*#\s*include")
  4081. global or local to buffer |global-local|
  4082. {not available when compiled without the
  4083. |+find_in_path| feature}
  4084. Pattern to be used to find an include command. It is a search
  4085. pattern, just like for the "/" command (See |pattern|). The default
  4086. value is for C programs. This option is used for the commands "[i",
  4087. "]I", "[d", etc.
  4088. Normally the 'isfname' option is used to recognize the file name that
  4089. comes after the matched pattern. But if "\zs" appears in the pattern
  4090. then the text matched from "\zs" to the end, or until "\ze" if it
  4091. appears, is used as the file name. Use this to include characters
  4092. that are not in 'isfname', such as a space. You can then use
  4093. 'includeexpr' to process the matched text.
  4094. See |option-backslash| about including spaces and backslashes.
  4095. *'includeexpr'* *'inex'*
  4096. 'includeexpr' 'inex' string (default "")
  4097. local to buffer
  4098. {not available when compiled without the
  4099. |+find_in_path| or |+eval| features}
  4100. Expression to be used to transform the string found with the 'include'
  4101. option to a file name. Mostly useful to change "." to "/" for Java: >
  4102. :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
  4103. < The "v:fname" variable will be set to the file name that was detected.
  4104. Note the double backslash: the `:set` command first halves them, then
  4105. one remains it the value, where "\." matches a dot literally. For
  4106. simple character replacements `tr()` avoids the need for escaping: >
  4107. :setlocal includeexpr=tr(v:fname,'.','/')
  4108. <
  4109. Also used for the |gf| command if an unmodified file name can't be
  4110. found. Allows doing "gf" on the name after an 'include' statement.
  4111. Also used for |<cfile>|.
  4112. If the expression starts with s: or |<SID>|, then it is replaced with
  4113. the script ID (|local-function|). Example: >
  4114. setlocal includeexpr=s:MyIncludeExpr()
  4115. setlocal includeexpr=<SID>SomeIncludeExpr()
  4116. < Otherwise, the expression is evaluated in the context of the script
  4117. where the option was set, thus script-local items are available.
  4118. It is more efficient if the value is just a function call without
  4119. arguments, see |expr-option-function|.
  4120. The expression will be evaluated in the |sandbox| when set from a
  4121. modeline, see |sandbox-option|.
  4122. This option cannot be set in a modeline when 'modelineexpr' is off.
  4123. It is not allowed to change text or jump to another window while
  4124. evaluating 'includeexpr' |textlock|.
  4125. *'incsearch'* *'is'* *'noincsearch'* *'nois'*
  4126. 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
  4127. |+reltime| feature is supported)
  4128. global
  4129. {not available when compiled without the
  4130. |+extra_search| features}
  4131. While typing a search command, show where the pattern, as it was typed
  4132. so far, matches. The matched string is highlighted. If the pattern
  4133. is invalid or not found, nothing is shown. The screen will be updated
  4134. often, this is only useful on fast terminals.
  4135. Also applies to the pattern in commands: >
  4136. :global
  4137. :lvimgrep
  4138. :lvimgrepadd
  4139. :smagic
  4140. :snomagic
  4141. :sort
  4142. :substitute
  4143. :vglobal
  4144. :vimgrep
  4145. :vimgrepadd
  4146. < Note that the match will be shown, but the cursor will return to its
  4147. original position when no match is found and when pressing <Esc>. You
  4148. still need to finish the search command with <Enter> to move the
  4149. cursor to the match.
  4150. You can use the CTRL-G and CTRL-T keys to move to the next and
  4151. previous match. |c_CTRL-G| |c_CTRL-T|
  4152. When compiled with the |+reltime| feature Vim only searches for about
  4153. half a second. With a complicated pattern and/or a lot of text the
  4154. match may not be found. This is to avoid that Vim hangs while you
  4155. are typing the pattern.
  4156. The highlighting can be set with the 'i' flag in 'highlight'.
  4157. When 'hlsearch' is on, all matched strings are highlighted too while
  4158. typing a search command. See also: 'hlsearch'.
  4159. If you don't want to turn 'hlsearch' on, but want to highlight all
  4160. matches while searching, you can turn on and off 'hlsearch' with
  4161. autocmd. Example: >
  4162. augroup vimrc-incsearch-highlight
  4163. autocmd!
  4164. autocmd CmdlineEnter /,\? :set hlsearch
  4165. autocmd CmdlineLeave /,\? :set nohlsearch
  4166. augroup END
  4167. <
  4168. CTRL-L can be used to add one character from after the current match
  4169. to the command line. If 'ignorecase' and 'smartcase' are set and the
  4170. command line has no uppercase characters, the added character is
  4171. converted to lowercase.
  4172. CTRL-R CTRL-W can be used to add the word at the end of the current
  4173. match, excluding the characters that were already typed.
  4174. NOTE: This option is reset when 'compatible' is set.
  4175. *'indentexpr'* *'inde'*
  4176. 'indentexpr' 'inde' string (default "")
  4177. local to buffer
  4178. {not available when compiled without the |+eval|
  4179. feature}
  4180. Expression which is evaluated to obtain the proper indent for a line.
  4181. It is used when a new line is created, for the |=| operator and
  4182. in Insert mode as specified with the 'indentkeys' option.
  4183. When this option is not empty, it overrules the 'cindent' and
  4184. 'smartindent' indenting. When 'lisp' is set, this option is
  4185. is only used when 'lispoptions' contains "expr:1".
  4186. When 'paste' is set this option is not used for indenting.
  4187. The expression is evaluated with |v:lnum| set to the line number for
  4188. which the indent is to be computed. The cursor is also in this line
  4189. when the expression is evaluated (but it may be moved around).
  4190. If the expression starts with s: or |<SID>|, then it is replaced with
  4191. the script ID (|local-function|). Example: >
  4192. set indentexpr=s:MyIndentExpr()
  4193. set indentexpr=<SID>SomeIndentExpr()
  4194. < Otherwise, the expression is evaluated in the context of the script
  4195. where the option was set, thus script-local items are available.
  4196. The advantage of using a function call without arguments is that it is
  4197. faster, see |expr-option-function|.
  4198. The expression must return the number of spaces worth of indent. It
  4199. can return "-1" to keep the current indent (this means 'autoindent' is
  4200. used for the indent).
  4201. Functions useful for computing the indent are |indent()|, |cindent()|
  4202. and |lispindent()|.
  4203. The evaluation of the expression must not have side effects! It must
  4204. not change the text, jump to another window, etc. Afterwards the
  4205. cursor position is always restored, thus the cursor may be moved.
  4206. Normally this option would be set to call a function: >
  4207. :set indentexpr=GetMyIndent()
  4208. < Error messages will be suppressed, unless the 'debug' option contains
  4209. "msg".
  4210. See |indent-expression|.
  4211. NOTE: This option is set to "" when 'compatible' is set.
  4212. The expression will be evaluated in the |sandbox| when set from a
  4213. modeline, see |sandbox-option|.
  4214. This option cannot be set in a modeline when 'modelineexpr' is off.
  4215. It is not allowed to change text or jump to another window while
  4216. evaluating 'indentexpr' |textlock|.
  4217. *'indentkeys'* *'indk'*
  4218. 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
  4219. local to buffer
  4220. A list of keys that, when typed in Insert mode, cause reindenting of
  4221. the current line. Only happens if 'indentexpr' isn't empty.
  4222. The format is identical to 'cinkeys', see |indentkeys-format|.
  4223. See |C-indenting| and |indent-expression|.
  4224. *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
  4225. 'infercase' 'inf' boolean (default off)
  4226. local to buffer
  4227. When doing keyword completion in insert mode |ins-completion|, and
  4228. 'ignorecase' is also on, the case of the match is adjusted depending
  4229. on the typed text. If the typed text contains a lowercase letter
  4230. where the match has an upper case letter, the completed part is made
  4231. lowercase. If the typed text has no lowercase letters and the match
  4232. has a lowercase letter where the typed text has an uppercase letter,
  4233. and there is a letter before it, the completed part is made uppercase.
  4234. With 'noinfercase' the match is used as-is.
  4235. *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
  4236. 'insertmode' 'im' boolean (default off)
  4237. global
  4238. Makes Vim work in a way that Insert mode is the default mode. Useful
  4239. if you want to use Vim as a modeless editor. Used for |evim|.
  4240. These Insert mode commands will be useful:
  4241. - Use the cursor keys to move around.
  4242. - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
  4243. this is a mapping, it is executed as if 'insertmode' was off.
  4244. Normal mode remains active until the mapping is finished.
  4245. - Use CTRL-L to execute a number of Normal mode commands, then use
  4246. <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
  4247. left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
  4248. These items change when 'insertmode' is set:
  4249. - when starting to edit of a file, Vim goes to Insert mode.
  4250. - <Esc> in Insert mode is a no-op and beeps.
  4251. - <Esc> in Normal mode makes Vim go to Insert mode.
  4252. - CTRL-L in Insert mode is a command, it is not inserted.
  4253. - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
  4254. However, when <Esc> is used inside a mapping, it behaves like
  4255. 'insertmode' was not set. This was done to be able to use the same
  4256. mappings with 'insertmode' set or not set.
  4257. When executing commands with |:normal| 'insertmode' is not used.
  4258. NOTE: This option is reset when 'compatible' is set.
  4259. *'isfname'* *'isf'*
  4260. 'isfname' 'isf' string (default for Win32:
  4261. "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
  4262. for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
  4263. for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
  4264. for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
  4265. otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
  4266. global
  4267. The characters specified by this option are included in file names and
  4268. path names. Filenames are used for commands like "gf", "[i" and in
  4269. the tags file. It is also used for "\f" in a |pattern|.
  4270. Multi-byte characters 256 and above are always included, only the
  4271. characters up to 255 are specified with this option.
  4272. For UTF-8 the characters 0xa0 to 0xff are included as well.
  4273. Think twice before adding white space to this option. Although a
  4274. space may appear inside a file name, the effect will be that Vim
  4275. doesn't know where a file name starts or ends when doing completion.
  4276. It most likely works better without a space in 'isfname'.
  4277. Note that on systems using a backslash as path separator, Vim tries to
  4278. do its best to make it work as you would expect. That is a bit
  4279. tricky, since Vi originally used the backslash to escape special
  4280. characters. Vim will not remove a backslash in front of a normal file
  4281. name character on these systems, but it will on Unix and alikes. The
  4282. '&' and '^' are not included by default, because these are special for
  4283. cmd.exe.
  4284. The format of this option is a list of parts, separated with commas.
  4285. Each part can be a single character number or a range. A range is two
  4286. character numbers with '-' in between. A character number can be a
  4287. decimal number between 0 and 255 or the ASCII character itself (does
  4288. not work for digits). Example:
  4289. "_,-,128-140,#-43" (include '_' and '-' and the range
  4290. 128 to 140 and '#' to 43)
  4291. If a part starts with '^', the following character number or range
  4292. will be excluded from the option. The option is interpreted from left
  4293. to right. Put the excluded character after the range where it is
  4294. included. To include '^' itself use it as the last character of the
  4295. option or the end of a range. Example:
  4296. "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
  4297. If the character is '@', all characters where isalpha() returns TRUE
  4298. are included. Normally these are the characters a to z and A to Z,
  4299. plus accented characters. To include '@' itself use "@-@". Examples:
  4300. "@,^a-z" All alphabetic characters, excluding lower
  4301. case ASCII letters.
  4302. "a-z,A-Z,@-@" All letters plus the '@' character.
  4303. A comma can be included by using it where a character number is
  4304. expected. Example:
  4305. "48-57,,,_" Digits, comma and underscore.
  4306. A comma can be excluded by prepending a '^'. Example:
  4307. " -~,^,,9" All characters from space to '~', excluding
  4308. comma, plus <Tab>.
  4309. See |option-backslash| about including spaces and backslashes.
  4310. *'isident'* *'isi'*
  4311. 'isident' 'isi' string (default for Win32:
  4312. "@,48-57,_,128-167,224-235"
  4313. otherwise: "@,48-57,_,192-255")
  4314. global
  4315. The characters given by this option are included in identifiers.
  4316. Identifiers are used in recognizing environment variables and after a
  4317. match of the 'define' option. It is also used for "\i" in a
  4318. |pattern|. See 'isfname' for a description of the format of this
  4319. option. For '@' only characters up to 255 are used.
  4320. Careful: If you change this option, it might break expanding
  4321. environment variables. E.g., when '/' is included and Vim tries to
  4322. expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
  4323. *'iskeyword'* *'isk'*
  4324. 'iskeyword' 'isk' string (Vim default for Win32:
  4325. "@,48-57,_,128-167,224-235"
  4326. otherwise: "@,48-57,_,192-255"
  4327. Vi default: "@,48-57,_")
  4328. local to buffer
  4329. Keywords are used in searching and recognizing with many commands:
  4330. "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
  4331. 'isfname' for a description of the format of this option. For '@'
  4332. characters above 255 check the "word" character class (any character
  4333. that is not white space or punctuation).
  4334. For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
  4335. For a help file it is set to all non-blank printable characters except
  4336. '*', '"' and '|' (so that CTRL-] on a command finds the help for that
  4337. command).
  4338. When the 'lisp' option is on the '-' character is always included.
  4339. This option also influences syntax highlighting, unless the syntax
  4340. uses |:syn-iskeyword|.
  4341. NOTE: This option is set to the Vi default value when 'compatible' is
  4342. set and to the Vim default value when 'compatible' is reset.
  4343. *'isprint'* *'isp'*
  4344. 'isprint' 'isp' string (default for Win32 and macOS:
  4345. "@,~-255"; otherwise: "@,161-255")
  4346. global
  4347. The characters given by this option are displayed directly on the
  4348. screen. It is also used for "\p" in a |pattern|. The characters from
  4349. space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
  4350. even when they are not included in 'isprint' or excluded. See
  4351. 'isfname' for a description of the format of this option.
  4352. Non-printable characters are displayed with two characters:
  4353. 0 - 31 "^@" - "^_"
  4354. 32 - 126 always single characters
  4355. 127 "^?"
  4356. 128 - 159 "~@" - "~_"
  4357. 160 - 254 "| " - "|~"
  4358. 255 "~?"
  4359. When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
  4360. displayed as <xx>, with the hexadecimal value of the byte.
  4361. When 'display' contains "uhex" all unprintable characters are
  4362. displayed as <xx>.
  4363. The SpecialKey highlighting will be used for unprintable characters.
  4364. |hl-SpecialKey|
  4365. Multi-byte characters 256 and above are always included, only the
  4366. characters up to 255 are specified with this option. When a character
  4367. is printable but it is not available in the current font, a
  4368. replacement character will be shown.
  4369. Unprintable and zero-width Unicode characters are displayed as <xxxx>.
  4370. There is no option to specify these characters.
  4371. *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
  4372. 'joinspaces' 'js' boolean (default on)
  4373. global
  4374. Insert two spaces after a '.', '?' and '!' with a join command.
  4375. When 'cpoptions' includes the 'j' flag, only do this after a '.'.
  4376. Otherwise only one space is inserted.
  4377. NOTE: This option is set when 'compatible' is set.
  4378. *'key'*
  4379. 'key' string (default "")
  4380. local to buffer
  4381. {only available when compiled with the |+cryptv|
  4382. feature}
  4383. The key that is used for encrypting and decrypting the current buffer.
  4384. See |encryption| and 'cryptmethod'.
  4385. Careful: Do not set the key value by hand, someone might see the typed
  4386. key. Use the |:X| command. But you can make 'key' empty: >
  4387. :set key=
  4388. < It is not possible to get the value of this option with ":set key" or
  4389. "echo &key". This is to avoid showing it to someone who shouldn't
  4390. know. It also means you cannot see it yourself once you have set it,
  4391. be careful not to make a typing error!
  4392. You can use "&key" in an expression to detect whether encryption is
  4393. enabled. When 'key' is set it returns "*****" (five stars).
  4394. *'keymap'* *'kmp'* *E544*
  4395. 'keymap' 'kmp' string (default "")
  4396. local to buffer
  4397. {only available when compiled with the |+keymap|
  4398. feature}
  4399. Name of a keyboard mapping. See |mbyte-keymap|.
  4400. Setting this option to a valid keymap name has the side effect of
  4401. setting 'iminsert' to one, so that the keymap becomes effective.
  4402. 'imsearch' is also set to one, unless it was -1
  4403. Only normal file name characters can be used, "/\*?[|<>" are illegal.
  4404. *'keymodel'* *'km'*
  4405. 'keymodel' 'km' string (default "")
  4406. global
  4407. List of comma-separated words, which enable special things that keys
  4408. can do. These values can be used:
  4409. startsel Using a shifted special key starts selection (either
  4410. Select mode or Visual mode, depending on "key" being
  4411. present in 'selectmode').
  4412. stopsel Using a not-shifted special key stops selection.
  4413. Special keys in this context are the cursor keys, <End>, <Home>,
  4414. <PageUp> and <PageDown>.
  4415. The 'keymodel' option is set by the |:behave| command.
  4416. *'keyprotocol'* *'kpc'*
  4417. 'keyprotocol' 'kpc' string (default: see below)
  4418. global
  4419. Specifies what keyboard protocol to use depending on the value of
  4420. 'term'. The supported keyboard protocols names are:
  4421. none whatever the terminal uses
  4422. mok2 modifyOtherKeys level 2, as supported by xterm
  4423. kitty Kitty keyboard protocol, as supported by Kitty
  4424. The option value is a list of comma separated items. Each item has
  4425. a pattern that is matched against the 'term' option, a colon and the
  4426. protocol name to be used. To illustrate this, the default value would
  4427. be set with: >
  4428. set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
  4429. < This means that when 'term' contains "kitty, "foot" or "wezterm"
  4430. somewhere then the "kitty" protocol is used. When 'term' contains
  4431. "xterm" somewhere, then the "mok2" protocol is used.
  4432. The first match is used, thus if you want to have "kitty" use the
  4433. kitty protocol, but "badkitty" not, then you should match "badkitty"
  4434. first and use the "none" value: >
  4435. set keyprotocol=badkitty:none,kitty:kitty
  4436. <
  4437. The option is used after 'term' has been changed. First the termcap
  4438. entries are set, possibly using the builtin list, see |builtin-terms|.
  4439. Then this option is inspected and if there is a match and a protocol
  4440. is specified the following happens:
  4441. none Nothing, the regular t_TE and t_TI values remain
  4442. mok2 The t_TE value is changed to:
  4443. CSI >4;m disables modifyOtherKeys
  4444. The t_TI value is changed to:
  4445. CSI >4;2m enables modifyOtherKeys
  4446. CSI ?4m request the modifyOtherKeys state
  4447. kitty The t_TE value is changed to:
  4448. CSI >4;m disables modifyOtherKeys
  4449. CSI =0;1u disables the kitty keyboard protocol
  4450. The t_TI value is changed to:
  4451. CSI =1;1u enables the kitty keyboard protocol
  4452. CSI ?u request kitty keyboard protocol state
  4453. CSI >c request the termresponse
  4454. *'keywordprg'* *'kp'*
  4455. 'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
  4456. VMS: "help")
  4457. global or local to buffer |global-local|
  4458. Program to use for the |K| command. Environment variables are
  4459. expanded |:set_env|. ":help" may be used to access the Vim internal
  4460. help. (Note that previously setting the global option to the empty
  4461. value did this, which is now deprecated.)
  4462. When the first character is ":", the command is invoked as a Vim
  4463. Ex command with [count] added as an argument if it is not zero.
  4464. When "man", "man -s" or an Ex command is used, Vim will automatically
  4465. translate a count for the "K" command and pass it as the first
  4466. argument. For "man -s" the "-s" is removed when there is no count.
  4467. See |option-backslash| about including spaces and backslashes.
  4468. Example: >
  4469. :set keywordprg=man\ -s
  4470. < This option cannot be set from a |modeline| or in the |sandbox|, for
  4471. security reasons.
  4472. *'langmap'* *'lmap'* *E357* *E358*
  4473. 'langmap' 'lmap' string (default "")
  4474. global
  4475. {only available when compiled with the |+langmap|
  4476. feature}
  4477. This option allows switching your keyboard into a special language
  4478. mode. When you are typing text in Insert mode the characters are
  4479. inserted directly. When in Normal mode the 'langmap' option takes
  4480. care of translating these special characters to the original meaning
  4481. of the key. This means you don't have to change the keyboard mode to
  4482. be able to execute Normal mode commands.
  4483. This is the opposite of the 'keymap' option, where characters are
  4484. mapped in Insert mode.
  4485. Also consider setting 'langremap' to off, to prevent 'langmap' from
  4486. applying to characters resulting from a mapping.
  4487. This option cannot be set from a |modeline| or in the |sandbox|, for
  4488. security reasons.
  4489. Example (for Greek, in UTF-8): *greek* >
  4490. :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
  4491. < Example (exchanges meaning of z and y for commands): >
  4492. :set langmap=zy,yz,ZY,YZ
  4493. <
  4494. The 'langmap' option is a list of parts, separated with commas. Each
  4495. part can be in one of two forms:
  4496. 1. A list of pairs. Each pair is a "from" character immediately
  4497. followed by the "to" character. Examples: "aA", "aAbBcC".
  4498. 2. A list of "from" characters, a semi-colon and a list of "to"
  4499. characters. Example: "abc;ABC"
  4500. Example: "aA,fgh;FGH,cCdDeE"
  4501. Special characters need to be preceded with a backslash. These are
  4502. ";", ',', '"', '|' and backslash itself.
  4503. This will allow you to activate vim actions without having to switch
  4504. back and forth between the languages. Your language characters will
  4505. be understood as normal vim English characters (according to the
  4506. langmap mappings) in the following cases:
  4507. o Normal/Visual mode (commands, buffer/register names, user mappings)
  4508. o Insert/Replace Mode: Register names after CTRL-R
  4509. o Insert/Replace Mode: Mappings
  4510. Characters entered in Command-line mode will NOT be affected by
  4511. this option. Note that this option can be changed at any time
  4512. allowing to switch between mappings for different languages/encodings.
  4513. Use a mapping to avoid having to type it each time!
  4514. *'langmenu'* *'lm'*
  4515. 'langmenu' 'lm' string (default "")
  4516. global
  4517. {only available when compiled with the |+menu| and
  4518. |+multi_lang| features}
  4519. Language to use for menu translation. Tells which file is loaded
  4520. from the "lang" directory in 'runtimepath': >
  4521. "lang/menu_" .. &langmenu .. ".vim"
  4522. < (without the spaces). For example, to always use the Dutch menus, no
  4523. matter what $LANG is set to: >
  4524. :set langmenu=nl_NL.ISO_8859-1
  4525. < When 'langmenu' is empty, |v:lang| is used.
  4526. Only normal file name characters can be used, "/\*?[|<>" are illegal.
  4527. If your $LANG is set to a non-English language but you do want to use
  4528. the English menus: >
  4529. :set langmenu=none
  4530. < This option must be set before loading menus, switching on filetype
  4531. detection or syntax highlighting. Once the menus are defined setting
  4532. this option has no effect. But you could do this: >
  4533. :source $VIMRUNTIME/delmenu.vim
  4534. :set langmenu=de_DE.ISO_8859-1
  4535. :source $VIMRUNTIME/menu.vim
  4536. < Warning: This deletes all menus that you defined yourself!
  4537. *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
  4538. 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
  4539. global
  4540. {only available when compiled with the |+langmap|
  4541. feature}
  4542. This is just like 'langremap' but with the value inverted. It only
  4543. exists for backwards compatibility. When setting 'langremap' then
  4544. 'langnoremap' is set to the inverted value, and the other way around.
  4545. *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
  4546. 'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
  4547. global
  4548. {only available when compiled with the |+langmap|
  4549. feature}
  4550. When off, setting 'langmap' does not apply to characters resulting from
  4551. a mapping. This basically means, if you noticed that setting
  4552. 'langmap' disables some of your mappings, try resetting this option.
  4553. This option defaults to on for backwards compatibility. Set it off if
  4554. that works for you to avoid mappings to break.
  4555. *'laststatus'* *'ls'*
  4556. 'laststatus' 'ls' number (default 1)
  4557. global
  4558. The value of this option influences when the last window will have a
  4559. status line:
  4560. 0: never
  4561. 1: only if there are at least two windows
  4562. 2: always
  4563. The screen looks nicer with a status line if you have several
  4564. windows, but it takes another screen line. |status-line|
  4565. *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
  4566. 'lazyredraw' 'lz' boolean (default off)
  4567. global
  4568. When this option is set, the screen will not be redrawn while
  4569. executing macros, registers and other commands that have not been
  4570. typed. Also, updating the window title is postponed. To force an
  4571. update use |:redraw|.
  4572. This may occasionally cause display errors. It is only meant to be set
  4573. temporarily when performing an operation where redrawing may cause
  4574. flickering or cause a slow down.
  4575. *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
  4576. 'linebreak' 'lbr' boolean (default off)
  4577. local to window
  4578. {not available when compiled without the |+linebreak|
  4579. feature}
  4580. If on, Vim will wrap long lines at a character in 'breakat' rather
  4581. than at the last character that fits on the screen. Unlike
  4582. 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
  4583. it only affects the way the file is displayed, not its contents.
  4584. If 'breakindent' is set, line is visually indented. Then, the value
  4585. of 'showbreak' is used to put in front of wrapped lines. This option
  4586. is not used when the 'wrap' option is off.
  4587. Note that <Tab> characters after an <EOL> are mostly not displayed
  4588. with the right amount of white space.
  4589. *'lines'* *E593*
  4590. 'lines' number (default 24 or terminal height)
  4591. global
  4592. Number of lines of the Vim window.
  4593. Normally you don't need to set this. It is done automatically by the
  4594. terminal initialization code. Also see |posix-screen-size|.
  4595. When Vim is running in the GUI or in a resizable window, setting this
  4596. option will cause the window size to be changed. When you only want
  4597. to use the size for the GUI, put the command in your |gvimrc| file.
  4598. Vim limits the number of lines to what fits on the screen. You can
  4599. use this command to get the tallest window possible: >
  4600. :set lines=999
  4601. < Minimum value is 2, maximum value is 1000.
  4602. If you get fewer lines than expected, check the 'guiheadroom' option.
  4603. When you set this option and Vim is unable to change the physical
  4604. number of lines of the display, the display may be messed up.
  4605. *'linespace'* *'lsp'*
  4606. 'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
  4607. global
  4608. {only in the GUI}
  4609. Number of pixel lines inserted between characters. Useful if the font
  4610. uses the full character cell height, making lines touch each other.
  4611. When non-zero there is room for underlining.
  4612. With some fonts there can be too much room between lines (to have
  4613. space for ascents and descents). Then it makes sense to set
  4614. 'linespace' to a negative value. This may cause display problems
  4615. though!
  4616. *'lisp'* *'nolisp'*
  4617. 'lisp' boolean (default off)
  4618. local to buffer
  4619. Lisp mode: When <Enter> is typed in insert mode set the indent for
  4620. the next line to Lisp standards (well, sort of). Also happens with
  4621. "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
  4622. flag in 'cpoptions' changes the method of indenting: Vi compatible or
  4623. better. Also see 'lispwords'.
  4624. The '-' character is included in keyword characters. Redefines the
  4625. "=" operator to use this same indentation algorithm rather than
  4626. calling an external program if 'equalprg' is empty.
  4627. This option is not used when 'paste' is set.
  4628. *'lispoptions'* *'lop'*
  4629. 'lispoptions' 'lop' string (default "")
  4630. local to buffer
  4631. Comma-separated list of items that influence the Lisp indenting when
  4632. enabled with the |'lisp'| option. Currently only one item is
  4633. supported:
  4634. expr:1 use 'indentexpr' for Lisp indenting when it is set
  4635. expr:0 do not use 'indentexpr' for Lisp indenting (default)
  4636. Note that when using 'indentexpr' the `=` operator indents all the
  4637. lines, otherwise the first line is not indented (Vi-compatible).
  4638. *'lispwords'* *'lw'*
  4639. 'lispwords' 'lw' string (default is very long)
  4640. global or local to buffer |global-local|
  4641. Comma-separated list of words that influence the Lisp indenting when
  4642. enabled with the |'lisp'| option.
  4643. *'list'* *'nolist'*
  4644. 'list' boolean (default off)
  4645. local to window
  4646. List mode: By default show tabs as CTRL-I is displayed, display $
  4647. after end of line. Useful to see the difference between tabs and
  4648. spaces and for trailing blanks. Further changed by the 'listchars'
  4649. option.
  4650. The cursor is displayed at the start of the space a Tab character
  4651. occupies, not at the end as usual in Normal mode. To get this cursor
  4652. position while displaying Tabs with spaces, use: >
  4653. :set list lcs=tab:\ \
  4654. <
  4655. Note that list mode will also affect formatting (set with 'textwidth'
  4656. or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
  4657. changing the way tabs are displayed.
  4658. *'listchars'* *'lcs'*
  4659. 'listchars' 'lcs' string (default "eol:$")
  4660. global or local to window |global-local|
  4661. Strings to use in 'list' mode and for the |:list| command. It is a
  4662. comma-separated list of string settings.
  4663. *lcs-eol*
  4664. eol:c Character to show at the end of each line. When
  4665. omitted, there is no extra character at the end of the
  4666. line.
  4667. *lcs-tab*
  4668. tab:xy[z] Two or three characters to be used to show a tab.
  4669. The third character is optional.
  4670. tab:xy The 'x' is always used, then 'y' as many times as will
  4671. fit. Thus "tab:>-" displays:
  4672. >
  4673. >-
  4674. >--
  4675. etc.
  4676. tab:xyz The 'z' is always used, then 'x' is prepended, and
  4677. then 'y' is used as many times as will fit. Thus
  4678. "tab:<->" displays:
  4679. >
  4680. <>
  4681. <->
  4682. <-->
  4683. etc.
  4684. When "tab:" is omitted, a tab is shown as ^I.
  4685. *lcs-space*
  4686. space:c Character to show for a space. When omitted, spaces
  4687. are left blank.
  4688. *lcs-multispace*
  4689. multispace:c...
  4690. One or more characters to use cyclically to show for
  4691. multiple consecutive spaces. Overrides the "space"
  4692. setting, except for single spaces. When omitted, the
  4693. "space" setting is used. For example,
  4694. `:set listchars=multispace:---+` shows ten consecutive
  4695. spaces as:
  4696. ---+---+-- ~
  4697. *lcs-lead*
  4698. lead:c Character to show for leading spaces. When omitted,
  4699. leading spaces are blank. Overrides the "space" and
  4700. "multispace" settings for leading spaces. You can
  4701. combine it with "tab:", for example: >
  4702. :set listchars+=tab:>-,lead:.
  4703. < *lcs-leadmultispace*
  4704. leadmultispace:c...
  4705. Like the |lcs-multispace| value, but for leading
  4706. spaces only. Also overrides |lcs-lead| for leading
  4707. multiple spaces.
  4708. `:set listchars=leadmultispace:---+` shows ten
  4709. consecutive leading spaces as:
  4710. ---+---+--XXX ~
  4711. Where "XXX" denotes the first non-blank characters in
  4712. the line.
  4713. *lcs-trail*
  4714. trail:c Character to show for trailing spaces. When omitted,
  4715. trailing spaces are blank. Overrides the "space" and
  4716. "multispace" settings for trailing spaces.
  4717. *lcs-extends*
  4718. extends:c Character to show in the last column, when 'wrap' is
  4719. off and the line continues beyond the right of the
  4720. screen.
  4721. *lcs-precedes*
  4722. precedes:c Character to show in the first visible column of the
  4723. physical line, when there is text preceding the
  4724. character visible in the first column.
  4725. *lcs-conceal*
  4726. conceal:c Character to show in place of concealed text, when
  4727. 'conceallevel' is set to 1.
  4728. *lcs-nbsp*
  4729. nbsp:c Character to show for a non-breakable space character
  4730. (0xA0 (160 decimal) and U+202F). Left blank when
  4731. omitted.
  4732. The characters ':' and ',' should not be used. UTF-8 characters can
  4733. be used when 'encoding' is "utf-8", otherwise only printable
  4734. characters are allowed. All characters must be single width.
  4735. Each character can be specified as hex: >
  4736. set listchars=eol:\\x24
  4737. set listchars=eol:\\u21b5
  4738. set listchars=eol:\\U000021b5
  4739. < Note that a double backslash is used. The number of hex characters
  4740. must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
  4741. Examples: >
  4742. :set lcs=tab:>-,trail:-
  4743. :set lcs=tab:>-,eol:<,nbsp:%
  4744. :set lcs=extends:>,precedes:<
  4745. < The "NonText" highlighting will be used for "eol", "extends" and
  4746. "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
  4747. "multispace", "lead" and "trail".
  4748. |hl-NonText| |hl-SpecialKey|
  4749. *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
  4750. 'loadplugins' 'lpl' boolean (default on)
  4751. global
  4752. When on the plugin scripts are loaded when starting up |load-plugins|.
  4753. This option can be reset in your |vimrc| file to disable the loading
  4754. of plugins.
  4755. Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
  4756. line arguments reset this option. See |-u| and |--noplugin|.
  4757. *'luadll'*
  4758. 'luadll' string (default depends on the build)
  4759. global
  4760. {only available when compiled with the |+lua/dyn|
  4761. feature}
  4762. Specifies the name of the Lua shared library. The default is
  4763. DYNAMIC_LUA_DLL, which was specified at compile time.
  4764. Environment variables are expanded |:set_env|.
  4765. This option cannot be set from a |modeline| or in the |sandbox|, for
  4766. security reasons.
  4767. *'macatsui'* *'nomacatsui'*
  4768. 'macatsui' boolean (default on)
  4769. global
  4770. {not supported}
  4771. No longer supported, as the Mac OS X GUI code was removed.
  4772. *'magic'* *'nomagic'*
  4773. 'magic' boolean (default on)
  4774. global
  4775. Changes the special characters that can be used in search patterns.
  4776. See |pattern|.
  4777. WARNING: Switching this option off most likely breaks plugins! That
  4778. is because many patterns assume it's on and will fail when it's off.
  4779. Only switch it off when working with old Vi scripts. In any other
  4780. situation write patterns that work when 'magic' is on. Include "\M"
  4781. when you want to |/\M|.
  4782. In |Vim9| script the value of 'magic' is ignored, patterns behave like
  4783. it is always set.
  4784. *'makeef'* *'mef'*
  4785. 'makeef' 'mef' string (default: "")
  4786. global
  4787. {not available when compiled without the |+quickfix|
  4788. feature}
  4789. Name of the errorfile for the |:make| command (see |:make_makeprg|)
  4790. and the |:grep| command.
  4791. When it is empty, an internally generated temp file will be used.
  4792. When "##" is included, it is replaced by a number to make the name
  4793. unique. This makes sure that the ":make" command doesn't overwrite an
  4794. existing file.
  4795. NOT used for the ":cf" command. See 'errorfile' for that.
  4796. Environment variables are expanded |:set_env|.
  4797. See |option-backslash| about including spaces and backslashes.
  4798. This option cannot be set from a |modeline| or in the |sandbox|, for
  4799. security reasons.
  4800. *'makeencoding'* *'menc'*
  4801. 'makeencoding' 'menc' string (default "")
  4802. global or local to buffer |global-local|
  4803. Encoding used for reading the output of external commands. When empty,
  4804. encoding is not converted.
  4805. This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
  4806. `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
  4807. and `:laddfile`.
  4808. This would be mostly useful when you use MS-Windows and set 'encoding'
  4809. to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
  4810. 'makeencoding' to "char" has the same effect as setting to the system
  4811. locale encoding. Example: >
  4812. :set encoding=utf-8
  4813. :set makeencoding=char " system locale is used
  4814. <
  4815. *'makeprg'* *'mp'*
  4816. 'makeprg' 'mp' string (default "make", VMS: "MMS")
  4817. global or local to buffer |global-local|
  4818. Program to use for the ":make" command. See |:make_makeprg|.
  4819. This option may contain '%' and '#' characters (see |:_%| and |:_#|),
  4820. which are expanded to the current and alternate file name. Use |::S|
  4821. to escape file names in case they contain special characters.
  4822. Environment variables are expanded |:set_env|. See |option-backslash|
  4823. about including spaces and backslashes.
  4824. Note that a '|' must be escaped twice: once for ":set" and once for
  4825. the interpretation of a command. When you use a filter called
  4826. "myfilter" do it like this: >
  4827. :set makeprg=gmake\ \\\|\ myfilter
  4828. < The placeholder "$*" can be given (even multiple times) to specify
  4829. where the arguments will be included, for example: >
  4830. :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  4831. < This option cannot be set from a |modeline| or in the |sandbox|, for
  4832. security reasons.
  4833. *'matchpairs'* *'mps'*
  4834. 'matchpairs' 'mps' string (default "(:),{:},[:]")
  4835. local to buffer
  4836. Characters that form pairs. The |%| command jumps from one to the
  4837. other.
  4838. Only character pairs are allowed that are different, thus you cannot
  4839. jump between two double quotes.
  4840. The characters must be separated by a colon.
  4841. The pairs must be separated by a comma. Example for including '<' and
  4842. '>' (for HTML): >
  4843. :set mps+=<:>
  4844. < A more exotic example, to jump between the '=' and ';' in an
  4845. assignment, useful for languages like C and Java: >
  4846. :au FileType c,cpp,java set mps+==:;
  4847. < For a more advanced way of using "%", see the matchit.vim plugin in
  4848. the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
  4849. *'matchtime'* *'mat'*
  4850. 'matchtime' 'mat' number (default 5)
  4851. global
  4852. Tenths of a second to show the matching paren, when 'showmatch' is
  4853. set. Note that this is not in milliseconds, like other options that
  4854. set a time. This is to be compatible with Nvi.
  4855. *'maxcombine'* *'mco'*
  4856. 'maxcombine' 'mco' number (default 2)
  4857. global
  4858. The maximum number of combining characters supported for displaying.
  4859. Only used when 'encoding' is "utf-8".
  4860. The default is OK for most languages. Hebrew may require 4.
  4861. Maximum value is 6.
  4862. Even when this option is set to 2 you can still edit text with more
  4863. combining characters, you just can't see them. Use |g8| or |ga|.
  4864. See |mbyte-combining|.
  4865. *'maxfuncdepth'* *'mfd'*
  4866. 'maxfuncdepth' 'mfd' number (default 100)
  4867. global
  4868. {not available when compiled without the |+eval|
  4869. feature}
  4870. Maximum depth of function calls for user functions. This normally
  4871. catches endless recursion. When using a recursive function with
  4872. more depth, set 'maxfuncdepth' to a bigger number. But this will use
  4873. more memory, there is the danger of failing when memory is exhausted.
  4874. Increasing this limit above 200 also changes the maximum for Ex
  4875. command recursion, see |E169|.
  4876. See also |:function|.
  4877. *'maxmapdepth'* *'mmd'* *E223*
  4878. 'maxmapdepth' 'mmd' number (default 1000)
  4879. global
  4880. Maximum number of times a mapping is done without resulting in a
  4881. character to be used. This normally catches endless mappings, like
  4882. ":map x y" with ":map y x". It still does not catch ":map g wg",
  4883. because the 'w' is used before the next mapping is done. See also
  4884. |key-mapping|.
  4885. *'maxmem'* *'mm'*
  4886. 'maxmem' 'mm' number (default between 256 to 5120 (system
  4887. dependent) or half the amount of memory
  4888. available)
  4889. global
  4890. Maximum amount of memory (in Kbyte) to use for one buffer. When this
  4891. limit is reached allocating extra memory for a buffer will cause
  4892. other memory to be freed.
  4893. The maximum usable value is about 2000000. Use this to work without a
  4894. limit.
  4895. The value is ignored when 'swapfile' is off.
  4896. Also see 'maxmemtot'.
  4897. *'maxmempattern'* *'mmp'*
  4898. 'maxmempattern' 'mmp' number (default 1000)
  4899. global
  4900. Maximum amount of memory (in Kbyte) to use for pattern matching.
  4901. The maximum value is about 2000000. Use this to work without a limit.
  4902. *E363*
  4903. When Vim runs into the limit it gives an error message and mostly
  4904. behaves like CTRL-C was typed.
  4905. Running into the limit often means that the pattern is very
  4906. inefficient or too complex. This may already happen with the pattern
  4907. "\(.\)*" on a very long line. ".*" works much better.
  4908. Might also happen on redraw, when syntax rules try to match a complex
  4909. text structure.
  4910. Vim may run out of memory before hitting the 'maxmempattern' limit, in
  4911. which case you get an "Out of memory" error instead.
  4912. *'maxmemtot'* *'mmt'*
  4913. 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
  4914. dependent) or half the amount of memory
  4915. available)
  4916. global
  4917. Maximum amount of memory in Kbyte to use for all buffers together.
  4918. The maximum usable value is about 2000000 (2 Gbyte). Use this to work
  4919. without a limit.
  4920. On 64 bit machines higher values might work. But hey, do you really
  4921. need more than 2 Gbyte for text editing? Keep in mind that text is
  4922. stored in the swap file, one can edit files > 2 Gbyte anyway. We do
  4923. need the memory to store undo info.
  4924. Buffers with 'swapfile' off still count to the total amount of memory
  4925. used.
  4926. Also see 'maxmem'.
  4927. *'menuitems'* *'mis'*
  4928. 'menuitems' 'mis' number (default 25)
  4929. global
  4930. {not available when compiled without the |+menu|
  4931. feature}
  4932. Maximum number of items to use in a menu. Used for menus that are
  4933. generated from a list of items, e.g., the Buffers menu. Changing this
  4934. option has no direct effect, the menu must be refreshed first.
  4935. *'mkspellmem'* *'msm'*
  4936. 'mkspellmem' 'msm' string (default "460000,2000,500")
  4937. global
  4938. {not available when compiled without the |+syntax|
  4939. feature}
  4940. Parameters for |:mkspell|. This tunes when to start compressing the
  4941. word tree. Compression can be slow when there are many words, but
  4942. it's needed to avoid running out of memory. The amount of memory used
  4943. per word depends very much on how similar the words are, that's why
  4944. this tuning is complicated.
  4945. There are three numbers, separated by commas:
  4946. {start},{inc},{added}
  4947. For most languages the uncompressed word tree fits in memory. {start}
  4948. gives the amount of memory in Kbyte that can be used before any
  4949. compression is done. It should be a bit smaller than the amount of
  4950. memory that is available to Vim.
  4951. When going over the {start} limit the {inc} number specifies the
  4952. amount of memory in Kbyte that can be allocated before another
  4953. compression is done. A low number means compression is done after
  4954. less words are added, which is slow. A high number means more memory
  4955. will be allocated.
  4956. After doing compression, {added} times 1024 words can be added before
  4957. the {inc} limit is ignored and compression is done when any extra
  4958. amount of memory is needed. A low number means there is a smaller
  4959. chance of hitting the {inc} limit, less memory is used but it's
  4960. slower.
  4961. The languages for which these numbers are important are Italian and
  4962. Hungarian. The default works for when you have about 512 Mbyte. If
  4963. you have 1 Gbyte you could use: >
  4964. :set mkspellmem=900000,3000,800
  4965. < If you have less than 512 Mbyte |:mkspell| may fail for some
  4966. languages, no matter what you set 'mkspellmem' to.
  4967. This option cannot be set from a |modeline| or in the |sandbox|.
  4968. *'modeline'* *'ml'* *'nomodeline'* *'noml'*
  4969. 'modeline' 'ml' boolean (Vim default: on (off for root),
  4970. Vi default: off)
  4971. local to buffer
  4972. If 'modeline' is on 'modelines' gives the number of lines that is
  4973. checked for set commands. If 'modeline' is off or 'modelines' is zero
  4974. no lines are checked. See |modeline|.
  4975. *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
  4976. 'modelineexpr' 'mle' boolean (default: off)
  4977. global
  4978. When on allow some options that are an expression to be set in the
  4979. modeline. Check the option for whether it is affected by
  4980. 'modelineexpr'. Also see |modeline|.
  4981. This option cannot be set from a |modeline| or in the |sandbox|, for
  4982. security reasons.
  4983. *'modelines'* *'mls'*
  4984. 'modelines' 'mls' number (default 5)
  4985. global
  4986. If 'modeline' is on 'modelines' gives the number of lines that is
  4987. checked for set commands. If 'modeline' is off or 'modelines' is zero
  4988. no lines are checked. See |modeline|.
  4989. NOTE: 'modeline' is set to the Vi default value when 'compatible' is
  4990. set and to the Vim default value when 'compatible' is reset.
  4991. *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
  4992. *E21*
  4993. 'modifiable' 'ma' boolean (default on)
  4994. local to buffer
  4995. When off the buffer contents cannot be changed. The 'fileformat' and
  4996. 'fileencoding' options also can't be changed.
  4997. Can be reset on startup with the |-M| command line argument.
  4998. *'modified'* *'mod'* *'nomodified'* *'nomod'*
  4999. 'modified' 'mod' boolean (default off)
  5000. local to buffer
  5001. When on, the buffer is considered to be modified. This option is set
  5002. when:
  5003. 1. A change was made to the text since it was last written. Using the
  5004. |undo| command to go back to the original text will reset the
  5005. option. But undoing changes that were made before writing the
  5006. buffer will set the option again, since the text is different from
  5007. when it was written.
  5008. 2. 'fileformat' or 'fileencoding' is different from its original
  5009. value. The original value is set when the buffer is read or
  5010. written. A ":set nomodified" command also resets the original
  5011. values to the current values and the 'modified' option will be
  5012. reset.
  5013. Similarly for 'eol' and 'bomb'.
  5014. This option is not set when a change is made to the buffer as the
  5015. result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
  5016. FileAppendPost or VimLeave autocommand event. See |gzip-example| for
  5017. an explanation.
  5018. When 'buftype' is "nowrite" or "nofile" this option may be set, but
  5019. will be ignored.
  5020. Note that the text may actually be the same, e.g. 'modified' is set
  5021. when using "rA" on an "A".
  5022. *'more'* *'nomore'*
  5023. 'more' boolean (Vim default: on, Vi default: off)
  5024. global
  5025. When on, listings pause when the whole screen is filled. You will get
  5026. the |more-prompt|. When this option is off there are no pauses, the
  5027. listing continues until finished.
  5028. NOTE: This option is set to the Vi default value when 'compatible' is
  5029. set and to the Vim default value when 'compatible' is reset.
  5030. *'mouse'*
  5031. 'mouse' string (default "", "a" for GUI and Win32,
  5032. set to "a" or "nvi" in |defaults.vim|)
  5033. global
  5034. Enable the use of the mouse. Works for most terminals (xterm, Win32
  5035. |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
  5036. with gpm). For using the mouse in the GUI, see |gui-mouse|. The
  5037. mouse can be enabled for different modes:
  5038. n Normal mode and Terminal modes
  5039. v Visual mode
  5040. i Insert mode
  5041. c Command-line mode
  5042. h all previous modes when editing a help file
  5043. a all previous modes
  5044. r for |hit-enter| and |more-prompt| prompt
  5045. Normally you would enable the mouse in all five modes with: >
  5046. :set mouse=a
  5047. < If your terminal can't overrule the mouse events going to the
  5048. application, use: >
  5049. :set mouse=nvi
  5050. < Then you can press ":", select text for the system, and press Esc to go
  5051. back to Vim using the mouse events.
  5052. In |defaults.vim| "nvi" is used if the 'term' option is not matching
  5053. "xterm".
  5054. When the mouse is not enabled, the GUI will still use the mouse for
  5055. modeless selection. This doesn't move the text cursor.
  5056. See |mouse-using|. Also see |'clipboard'|.
  5057. Note: When enabling the mouse in a terminal, copy/paste will use the
  5058. "* register if there is access to an X-server. The xterm handling of
  5059. the mouse buttons can still be used by keeping the shift key pressed.
  5060. Also see the 'clipboard' option.
  5061. *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
  5062. 'mousefocus' 'mousef' boolean (default off)
  5063. global
  5064. {only works in the GUI}
  5065. The window that the mouse pointer is on is automatically activated.
  5066. When changing the window layout or window focus in another way, the
  5067. mouse pointer is moved to the window with keyboard focus. Off is the
  5068. default because it makes using the pull down menus a little goofy, as
  5069. a pointer transit may activate a window unintentionally.
  5070. MS-Windows: Also see 'scrollfocus' for what window is scrolled when
  5071. using the mouse scroll wheel.
  5072. *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
  5073. 'mousehide' 'mh' boolean (default on)
  5074. global
  5075. {only works in the GUI}
  5076. When on, the mouse pointer is hidden when characters are typed.
  5077. The mouse pointer is restored when the mouse is moved.
  5078. *'mousemodel'* *'mousem'*
  5079. 'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
  5080. global
  5081. Sets the model to use for the mouse. The name mostly specifies what
  5082. the right mouse button is used for:
  5083. extend Right mouse button extends a selection. This works
  5084. like in an xterm.
  5085. popup Right mouse button pops up a menu. The shifted left
  5086. mouse button extends a selection. This works like
  5087. with Microsoft Windows.
  5088. popup_setpos Like "popup", but the cursor will be moved to the
  5089. position where the mouse was clicked, and thus the
  5090. selected operation will act upon the clicked object.
  5091. If clicking inside a selection, that selection will
  5092. be acted upon, i.e. no cursor move. This implies of
  5093. course, that right clicking outside a selection will
  5094. end Visual mode.
  5095. Overview of what button does what for each model:
  5096. mouse extend popup(_setpos) ~
  5097. left click place cursor place cursor
  5098. left drag start selection start selection
  5099. shift-left search word extend selection
  5100. right click extend selection popup menu (place cursor)
  5101. right drag extend selection -
  5102. middle click paste paste
  5103. In the "popup" model the right mouse button produces a pop-up menu.
  5104. You need to define this first, see |popup-menu|.
  5105. Note that you can further refine the meaning of buttons with mappings.
  5106. See |gui-mouse-mapping|. But mappings are NOT used for modeless
  5107. selection (because that's handled in the GUI code directly).
  5108. The 'mousemodel' option is set by the |:behave| command.
  5109. *'mousemoveevent'* *'mousemev'*
  5110. 'mousemoveevent' 'mousemev' boolean (default off)
  5111. global
  5112. {only works in the GUI}
  5113. When on, mouse move events are delivered to the input queue and are
  5114. available for mapping. The default, off, avoids the mouse movement
  5115. overhead except when needed. See |gui-mouse-mapping|.
  5116. Warning: Setting this option can make pending mappings to be aborted
  5117. when the mouse is moved.
  5118. Currently only works in the GUI, may be made to work in a terminal
  5119. later.
  5120. *'mouseshape'* *'mouses'* *E547*
  5121. 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
  5122. vs:leftright,vd:lrsizing,m:no,
  5123. ml:up-arrow,v:rightup-arrow")
  5124. global
  5125. {only available when compiled with the |+mouseshape|
  5126. feature}
  5127. This option tells Vim what the mouse pointer should look like in
  5128. different modes. The option is a comma-separated list of parts, much
  5129. like used for 'guicursor'. Each part consist of a mode/location-list
  5130. and an argument-list:
  5131. mode-list:shape,mode-list:shape,..
  5132. The mode-list is a dash separated list of these modes/locations:
  5133. In a normal window: ~
  5134. n Normal mode
  5135. v Visual mode
  5136. ve Visual mode with 'selection' "exclusive" (same as 'v',
  5137. if not specified)
  5138. o Operator-pending mode
  5139. i Insert mode
  5140. r Replace mode
  5141. Others: ~
  5142. c appending to the command-line
  5143. ci inserting in the command-line
  5144. cr replacing in the command-line
  5145. m at the 'Hit ENTER' or 'More' prompts
  5146. ml idem, but cursor in the last line
  5147. e any mode, pointer below last window
  5148. s any mode, pointer on a status line
  5149. sd any mode, while dragging a status line
  5150. vs any mode, pointer on a vertical separator line
  5151. vd any mode, while dragging a vertical separator line
  5152. a everywhere
  5153. The shape is one of the following:
  5154. avail name looks like ~
  5155. w x arrow Normal mouse pointer
  5156. w x blank no pointer at all (use with care!)
  5157. w x beam I-beam
  5158. w x updown up-down sizing arrows
  5159. w x leftright left-right sizing arrows
  5160. w x busy The system's usual busy pointer
  5161. w x no The system's usual 'no input' pointer
  5162. x udsizing indicates up-down resizing
  5163. x lrsizing indicates left-right resizing
  5164. x crosshair like a big thin +
  5165. x hand1 black hand
  5166. x hand2 white hand
  5167. x pencil what you write with
  5168. x question big ?
  5169. x rightup-arrow arrow pointing right-up
  5170. w x up-arrow arrow pointing up
  5171. x <number> any X11 pointer number (see X11/cursorfont.h)
  5172. The "avail" column contains a 'w' if the shape is available for Win32,
  5173. x for X11.
  5174. Any modes not specified or shapes not available use the normal mouse
  5175. pointer.
  5176. Example: >
  5177. :set mouseshape=s:udsizing,m:no
  5178. < will make the mouse turn to a sizing arrow over the status lines and
  5179. indicate no input when the hit-enter prompt is displayed (since
  5180. clicking the mouse has no effect in this state.)
  5181. *'mousetime'* *'mouset'*
  5182. 'mousetime' 'mouset' number (default 500)
  5183. global
  5184. Only for GUI, Win32 and Unix with xterm. Defines the maximum
  5185. time in msec between two mouse clicks for the second click to be
  5186. recognized as a multi click.
  5187. *'mzschemedll'*
  5188. 'mzschemedll' string (default depends on the build)
  5189. global
  5190. {only available when compiled with the |+mzscheme/dyn|
  5191. feature}
  5192. Specifies the name of the MzScheme shared library. The default is
  5193. DYNAMIC_MZSCH_DLL which was specified at compile time.
  5194. Environment variables are expanded |:set_env|.
  5195. The value must be set in the |vimrc| script or earlier. In the
  5196. startup, before the |load-plugins| step.
  5197. This option cannot be set from a |modeline| or in the |sandbox|, for
  5198. security reasons.
  5199. *'mzschemegcdll'*
  5200. 'mzschemegcdll' string (default depends on the build)
  5201. global
  5202. {only available when compiled with the |+mzscheme/dyn|
  5203. feature}
  5204. Specifies the name of the MzScheme GC shared library. The default is
  5205. DYNAMIC_MZGC_DLL which was specified at compile time.
  5206. The value can be equal to 'mzschemedll' if it includes the GC code.
  5207. Environment variables are expanded |:set_env|.
  5208. This option cannot be set from a |modeline| or in the |sandbox|, for
  5209. security reasons.
  5210. *'mzquantum'* *'mzq'*
  5211. 'mzquantum' 'mzq' number (default 100)
  5212. global
  5213. {not available when compiled without the |+mzscheme|
  5214. feature}
  5215. The number of milliseconds between polls for MzScheme threads.
  5216. Negative or zero value means no thread scheduling.
  5217. NOTE: This option is set to the Vim default value when 'compatible'
  5218. is reset.
  5219. *'nrformats'* *'nf'*
  5220. 'nrformats' 'nf' string (default "bin,octal,hex",
  5221. set to "bin,hex" in |defaults.vim|)
  5222. local to buffer
  5223. This defines what bases Vim will consider for numbers when using the
  5224. CTRL-A and CTRL-X commands for adding to and subtracting from a number
  5225. respectively; see |CTRL-A| for more info on these commands.
  5226. alpha If included, single alphabetical characters will be
  5227. incremented or decremented. This is useful for a list with a
  5228. letter index a), b), etc. *octal-nrformats*
  5229. octal If included, numbers that start with a zero will be considered
  5230. to be octal. Example: Using CTRL-A on "007" results in "010".
  5231. hex If included, numbers starting with "0x" or "0X" will be
  5232. considered to be hexadecimal. Example: Using CTRL-X on
  5233. "0x100" results in "0x0ff".
  5234. bin If included, numbers starting with "0b" or "0B" will be
  5235. considered to be binary. Example: Using CTRL-X on
  5236. "0b1000" subtracts one, resulting in "0b0111".
  5237. unsigned If included, numbers are recognized as unsigned. Thus a
  5238. leading dash or negative sign won't be considered as part of
  5239. the number. Examples:
  5240. Using CTRL-X on "2020" in "9-2020" results in "9-2019"
  5241. (without "unsigned" it would become "9-2021").
  5242. Using CTRL-A on "2020" in "9-2020" results in "9-2021"
  5243. (without "unsigned" it would become "9-2019").
  5244. Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
  5245. (2^64 - 1) has no effect, overflow is prevented.
  5246. Numbers which simply begin with a digit in the range 1-9 are always
  5247. considered decimal. This also happens for numbers that are not
  5248. recognized as octal or hex.
  5249. *'number'* *'nu'* *'nonumber'* *'nonu'*
  5250. 'number' 'nu' boolean (default off)
  5251. local to window
  5252. Print the line number in front of each line. When the 'n' option is
  5253. excluded from 'cpoptions' a wrapped line will not use the column of
  5254. line numbers (this is the default when 'compatible' isn't set).
  5255. The 'numberwidth' option can be used to set the room used for the line
  5256. number.
  5257. When a long, wrapped line doesn't start with the first character, '-'
  5258. characters are put before the number.
  5259. For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
  5260. |:sign-define| "numhl" argument.
  5261. *number_relativenumber*
  5262. The 'relativenumber' option changes the displayed number to be
  5263. relative to the cursor. Together with 'number' there are these
  5264. four combinations (cursor in line 3):
  5265. 'nonu' 'nu' 'nonu' 'nu'
  5266. 'nornu' 'nornu' 'rnu' 'rnu'
  5267. |apple | 1 apple | 2 apple | 2 apple
  5268. |pear | 2 pear | 1 pear | 1 pear
  5269. |nobody | 3 nobody | 0 nobody |3 nobody
  5270. |there | 4 there | 1 there | 1 there
  5271. *'numberwidth'* *'nuw'*
  5272. 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
  5273. local to window
  5274. {only available when compiled with the |+linebreak|
  5275. feature}
  5276. Minimal number of columns to use for the line number. Only relevant
  5277. when the 'number' or 'relativenumber' option is set or printing lines
  5278. with a line number. Since one space is always between the number and
  5279. the text, there is one less character for the number itself.
  5280. The value is the minimum width. A bigger width is used when needed to
  5281. fit the highest line number in the buffer respectively the number of
  5282. rows in the window, depending on whether 'number' or 'relativenumber'
  5283. is set. Thus with the Vim default of 4 there is room for a line number
  5284. up to 999. When the buffer has 1000 lines five columns will be used.
  5285. The minimum value is 1, the maximum value is 20.
  5286. NOTE: This option is set to the Vi default value when 'compatible' is
  5287. set and to the Vim default value when 'compatible' is reset.
  5288. *'omnifunc'* *'ofu'*
  5289. 'omnifunc' 'ofu' string (default: empty)
  5290. local to buffer
  5291. {not available when compiled without the |+eval|
  5292. feature}
  5293. This option specifies a function to be used for Insert mode omni
  5294. completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
  5295. See |complete-functions| for an explanation of how the function is
  5296. invoked and what it should return. The value can be the name of a
  5297. function, a |lambda| or a |Funcref|. See |option-value-function| for
  5298. more information.
  5299. This option is usually set by a filetype plugin:
  5300. |:filetype-plugin-on|
  5301. This option cannot be set from a |modeline| or in the |sandbox|, for
  5302. security reasons.
  5303. *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
  5304. 'opendevice' 'odev' boolean (default off)
  5305. global
  5306. {only for MS-Windows} *E796*
  5307. Enable reading and writing from devices. This may get Vim stuck on a
  5308. device that can be opened but doesn't actually do the I/O. Therefore
  5309. it is off by default.
  5310. Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
  5311. result in editing a device.
  5312. *'operatorfunc'* *'opfunc'*
  5313. 'operatorfunc' 'opfunc' string (default: empty)
  5314. global
  5315. This option specifies a function to be called by the |g@| operator.
  5316. See |:map-operator| for more info and an example. The value can be
  5317. the name of a function, a |lambda| or a |Funcref|. See
  5318. |option-value-function| for more information.
  5319. This option cannot be set from a |modeline| or in the |sandbox|, for
  5320. security reasons.
  5321. *'osfiletype'* *'oft'*
  5322. 'osfiletype' 'oft' string (default: "")
  5323. local to buffer
  5324. This option was supported on RISC OS, which has been removed.
  5325. *'packpath'* *'pp'*
  5326. 'packpath' 'pp' string (default: see 'runtimepath')
  5327. Directories used to find packages. See |packages|.
  5328. *'paragraphs'* *'para'*
  5329. 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
  5330. global
  5331. Specifies the nroff macros that separate paragraphs. These are pairs
  5332. of two letters (see |object-motions|).
  5333. *'paste'* *'nopaste'*
  5334. 'paste' boolean (default off)
  5335. global
  5336. Put Vim in Paste mode. This is useful if you want to cut or copy
  5337. some text from one window and paste it in Vim. This will avoid
  5338. unexpected effects.
  5339. Setting this option is useful when using Vim in a terminal, where Vim
  5340. cannot distinguish between typed text and pasted text. In the GUI, Vim
  5341. knows about pasting and will mostly do the right thing without 'paste'
  5342. being set. The same is true for a terminal where Vim handles the
  5343. mouse clicks itself.
  5344. This option is reset when starting the GUI. Thus if you set it in
  5345. your .vimrc it will work in a terminal, but not in the GUI. Setting
  5346. 'paste' in the GUI has side effects: e.g., the Paste toolbar button
  5347. will no longer work in Insert mode, because it uses a mapping.
  5348. When the 'paste' option is switched on (also when it was already on):
  5349. - mapping in Insert mode and Command-line mode is disabled
  5350. - abbreviations are disabled
  5351. - 'autoindent' is reset
  5352. - 'expandtab' is reset
  5353. - 'hkmap' is reset
  5354. - 'revins' is reset
  5355. - 'ruler' is reset
  5356. - 'showmatch' is reset
  5357. - 'smarttab' is reset
  5358. - 'softtabstop' is set to 0
  5359. - 'textwidth' is set to 0
  5360. - 'wrapmargin' is set to 0
  5361. - 'varsofttabstop' is made empty
  5362. These options keep their value, but their effect is disabled:
  5363. - 'cindent'
  5364. - 'formatoptions' is used like it is empty
  5365. - 'indentexpr'
  5366. - 'lisp'
  5367. - 'smartindent'
  5368. NOTE: When you start editing another file while the 'paste' option is
  5369. on, settings from the modelines or autocommands may change the
  5370. settings again, causing trouble when pasting text. You might want to
  5371. set the 'paste' option again.
  5372. When the 'paste' option is reset the mentioned options are restored to
  5373. the value before the moment 'paste' was switched from off to on.
  5374. Resetting 'paste' before ever setting it does not have any effect.
  5375. Since mapping doesn't work while 'paste' is active, you need to use
  5376. the 'pastetoggle' option to toggle the 'paste' option with some key.
  5377. *'pastetoggle'* *'pt'*
  5378. 'pastetoggle' 'pt' string (default "")
  5379. global
  5380. When non-empty, specifies the key sequence that toggles the 'paste'
  5381. option. This is like specifying a mapping: >
  5382. :map {keys} :set invpaste<CR>
  5383. < Where {keys} is the value of 'pastetoggle'.
  5384. The difference is that it will work even when 'paste' is set.
  5385. 'pastetoggle' works in Insert mode and Normal mode, but not in
  5386. Command-line mode.
  5387. Mappings are checked first, thus overrule 'pastetoggle'. However,
  5388. when 'paste' is on mappings are ignored in Insert mode, thus you can do
  5389. this: >
  5390. :map <F10> :set paste<CR>
  5391. :map <F11> :set nopaste<CR>
  5392. :imap <F10> <C-O>:set paste<CR>
  5393. :imap <F11> <nop>
  5394. :set pastetoggle=<F11>
  5395. < This will make <F10> start paste mode and <F11> stop paste mode.
  5396. Note that typing <F10> in paste mode inserts "<F10>", since in paste
  5397. mode everything is inserted literally, except the 'pastetoggle' key
  5398. sequence.
  5399. When the value has several bytes 'ttimeoutlen' applies.
  5400. *'pex'* *'patchexpr'*
  5401. 'patchexpr' 'pex' string (default "")
  5402. global
  5403. {not available when compiled without the |+diff|
  5404. feature}
  5405. Expression which is evaluated to apply a patch to a file and generate
  5406. the resulting new version of the file. See |diff-patchexpr|.
  5407. *'patchmode'* *'pm'* *E205* *E206*
  5408. 'patchmode' 'pm' string (default "")
  5409. global
  5410. When non-empty the oldest version of a file is kept. This can be used
  5411. to keep the original version of a file if you are changing files in a
  5412. source distribution. Only the first time that a file is written a
  5413. copy of the original file will be kept. The name of the copy is the
  5414. name of the original file with the string in the 'patchmode' option
  5415. appended. This option should start with a dot. Use a string like
  5416. ".orig" or ".org". 'backupdir' must not be empty for this to work
  5417. (Detail: The backup file is renamed to the patchmode file after the
  5418. new file has been successfully written, that's why it must be possible
  5419. to write a backup file). If there was no file to be backed up, an
  5420. empty file is created.
  5421. When the 'backupskip' pattern matches, a patchmode file is not made.
  5422. Using 'patchmode' for compressed files appends the extension at the
  5423. end (e.g., "file.gz.orig"), thus the resulting name isn't always
  5424. recognized as a compressed file.
  5425. Only normal file name characters can be used, "/\*?[|<>" are illegal.
  5426. *'path'* *'pa'* *E343* *E345* *E347* *E854*
  5427. 'path' 'pa' string (default on Unix: ".,/usr/include,,"
  5428. other systems: ".,,")
  5429. global or local to buffer |global-local|
  5430. This is a list of directories which will be searched when using the
  5431. |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
  5432. provided that the file being searched for has a relative path (not
  5433. starting with "/", "./" or "../"). The directories in the 'path'
  5434. option may be relative or absolute.
  5435. - Use commas to separate directory names: >
  5436. :set path=.,/usr/local/include,/usr/include
  5437. < - Spaces can also be used to separate directory names (for backwards
  5438. compatibility with version 3.0). To have a space in a directory
  5439. name, precede it with an extra backslash, and escape the space: >
  5440. :set path=.,/dir/with\\\ space
  5441. < - To include a comma in a directory name precede it with an extra
  5442. backslash: >
  5443. :set path=.,/dir/with\\,comma
  5444. < - To search relative to the directory of the current file, use: >
  5445. :set path=.
  5446. < - To search in the current directory use an empty string between two
  5447. commas: >
  5448. :set path=,,
  5449. < - A directory name may end in a ':' or '/'.
  5450. - Environment variables are expanded |:set_env|.
  5451. - When using |netrw.vim| URLs can be used. For example, adding
  5452. "http://www.vim.org" will make ":find index.html" work.
  5453. - Search upwards and downwards in a directory tree using "*", "**" and
  5454. ";". See |file-searching| for info and syntax.
  5455. - Careful with '\' characters, type two to get one in the option: >
  5456. :set path=.,c:\\include
  5457. < Or just use '/' instead: >
  5458. :set path=.,c:/include
  5459. < Don't forget "." or files won't even be found in the same directory as
  5460. the file!
  5461. The maximum length is limited. How much depends on the system, mostly
  5462. it is something like 256 or 1024 characters.
  5463. You can check if all the include files are found, using the value of
  5464. 'path', see |:checkpath|.
  5465. The use of |:set+=| and |:set-=| is preferred when adding or removing
  5466. directories from the list. This avoids problems when a future version
  5467. uses another default. To remove the current directory use: >
  5468. :set path-=
  5469. < To add the current directory use: >
  5470. :set path+=
  5471. < To use an environment variable, you probably need to replace the
  5472. separator. Here is an example to append $INCL, in which directory
  5473. names are separated with a semi-colon: >
  5474. :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
  5475. < Replace the ';' with a ':' or whatever separator is used. Note that
  5476. this doesn't work when $INCL contains a comma or white space.
  5477. *'perldll'*
  5478. 'perldll' string (default depends on the build)
  5479. global
  5480. {only available when compiled with the |+perl/dyn|
  5481. feature}
  5482. Specifies the name of the Perl shared library. The default is
  5483. DYNAMIC_PERL_DLL, which was specified at compile time.
  5484. Environment variables are expanded |:set_env|.
  5485. This option cannot be set from a |modeline| or in the |sandbox|, for
  5486. security reasons.
  5487. *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
  5488. 'preserveindent' 'pi' boolean (default off)
  5489. local to buffer
  5490. When changing the indent of the current line, preserve as much of the
  5491. indent structure as possible. Normally the indent is replaced by a
  5492. series of tabs followed by spaces as required (unless |'expandtab'| is
  5493. enabled, in which case only spaces are used). Enabling this option
  5494. means the indent will preserve as many existing characters as possible
  5495. for indenting, and only add additional tabs or spaces as required.
  5496. 'expandtab' does not apply to the preserved white space, a Tab remains
  5497. a Tab.
  5498. NOTE: When using ">>" multiple times the resulting indent is a mix of
  5499. tabs and spaces. You might not like this.
  5500. NOTE: This option is reset when 'compatible' is set.
  5501. Also see 'copyindent'.
  5502. Use |:retab| to clean up white space.
  5503. *'previewheight'* *'pvh'*
  5504. 'previewheight' 'pvh' number (default 12)
  5505. global
  5506. {not available when compiled without the |+quickfix|
  5507. feature}
  5508. Default height for a preview window. Used for |:ptag| and associated
  5509. commands. Used for |CTRL-W_}| when no count is given. Not used when
  5510. 'previewpopup' is set.
  5511. *'previewpopup'* *'pvp'*
  5512. 'previewpopup' 'pvp' string (default empty)
  5513. global
  5514. {not available when compiled without the |+textprop|
  5515. or |+quickfix| feature}
  5516. When not empty a popup window is used for commands that would open a
  5517. preview window. See |preview-popup|.
  5518. Not used for the insert completion info, add "popup" to
  5519. 'completeopt' for that.
  5520. *'previewwindow'* *'nopreviewwindow'*
  5521. *'pvw'* *'nopvw'* *E590*
  5522. 'previewwindow' 'pvw' boolean (default off)
  5523. local to window
  5524. {not available when compiled without the |+quickfix|
  5525. feature}
  5526. Identifies the preview window. Only one window can have this option
  5527. set. It's normally not set directly, but by using one of the commands
  5528. |:ptag|, |:pedit|, etc.
  5529. *'printdevice'* *'pdev'*
  5530. 'printdevice' 'pdev' string (default empty)
  5531. global
  5532. {only available when compiled with the |+printer|
  5533. feature}
  5534. The name of the printer to be used for |:hardcopy|.
  5535. See |pdev-option|.
  5536. This option cannot be set from a |modeline| or in the |sandbox|, for
  5537. security reasons.
  5538. *'printencoding'* *'penc'*
  5539. 'printencoding' 'penc' string (default empty, except for some systems)
  5540. global
  5541. {only available when compiled with the |+printer|
  5542. and |+postscript| features}
  5543. Sets the character encoding used when printing.
  5544. See |penc-option|.
  5545. *'printexpr'* *'pexpr'*
  5546. 'printexpr' 'pexpr' string (default: see below)
  5547. global
  5548. {only available when compiled with the |+printer|
  5549. and |+postscript| features}
  5550. Expression used to print the PostScript produced with |:hardcopy|.
  5551. See |pexpr-option|.
  5552. This option cannot be set from a |modeline| or in the |sandbox|, for
  5553. security reasons.
  5554. *'printfont'* *'pfn'*
  5555. 'printfont' 'pfn' string (default "courier")
  5556. global
  5557. {only available when compiled with the |+printer|
  5558. feature}
  5559. The name of the font that will be used for |:hardcopy|.
  5560. See |pfn-option|.
  5561. *'printheader'* *'pheader'*
  5562. 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
  5563. global
  5564. {only available when compiled with the |+printer|
  5565. feature}
  5566. The format of the header produced in |:hardcopy| output.
  5567. See |pheader-option|.
  5568. *'printmbcharset'* *'pmbcs'*
  5569. 'printmbcharset' 'pmbcs' string (default "")
  5570. global
  5571. {only available when compiled with the |+printer|
  5572. and |+postscript| features}
  5573. The CJK character set to be used for CJK output from |:hardcopy|.
  5574. See |pmbcs-option|.
  5575. *'printmbfont'* *'pmbfn'*
  5576. 'printmbfont' 'pmbfn' string (default "")
  5577. global
  5578. {only available when compiled with the |+printer|
  5579. and |+postscript| features}
  5580. List of font names to be used for CJK output from |:hardcopy|.
  5581. See |pmbfn-option|.
  5582. *'printoptions'* *'popt'*
  5583. 'printoptions' 'popt' string (default "")
  5584. global
  5585. {only available when compiled with |+printer| feature}
  5586. List of items that control the format of the output of |:hardcopy|.
  5587. See |popt-option|.
  5588. *'prompt'* *'noprompt'*
  5589. 'prompt' boolean (default on)
  5590. global
  5591. When on a ":" prompt is used in Ex mode.
  5592. *'pumheight'* *'ph'*
  5593. 'pumheight' 'ph' number (default 0)
  5594. global
  5595. Determines the maximum number of items to show in the popup menu for
  5596. Insert mode completion. When zero as much space as available is used.
  5597. |ins-completion-menu|.
  5598. *'pumwidth'* *'pw'*
  5599. 'pumwidth' 'pw' number (default 15)
  5600. global
  5601. Determines the minimum width to use for the popup menu for Insert mode
  5602. completion. |ins-completion-menu|.
  5603. *'pythondll'*
  5604. 'pythondll' string (default depends on the build)
  5605. global
  5606. {only available when compiled with the |+python/dyn|
  5607. feature}
  5608. Specifies the name of the Python 2.x shared library. The default is
  5609. DYNAMIC_PYTHON_DLL, which was specified at compile time.
  5610. Environment variables are expanded |:set_env|.
  5611. This option cannot be set from a |modeline| or in the |sandbox|, for
  5612. security reasons.
  5613. *'pythonhome'*
  5614. 'pythonhome' string (default "")
  5615. global
  5616. {only available when compiled with the |+python/dyn|
  5617. feature}
  5618. Specifies the name of the Python 2.x home directory. When 'pythonhome'
  5619. and the PYTHONHOME environment variable are not set, PYTHON_HOME,
  5620. which was specified at compile time, will be used for the Python 2.x
  5621. home directory.
  5622. Environment variables are expanded |:set_env|.
  5623. This option cannot be set from a |modeline| or in the |sandbox|, for
  5624. security reasons.
  5625. *'pythonthreedll'*
  5626. 'pythonthreedll' string (default depends on the build)
  5627. global
  5628. {only available when compiled with the |+python3/dyn|
  5629. feature}
  5630. Specifies the name of the Python 3 shared library. The default is
  5631. DYNAMIC_PYTHON3_DLL, which was specified at compile time.
  5632. Environment variables are expanded |:set_env|.
  5633. This option cannot be set from a |modeline| or in the |sandbox|, for
  5634. security reasons.
  5635. *'pythonthreehome'*
  5636. 'pythonthreehome' string (default "")
  5637. global
  5638. {only available when compiled with the |+python3/dyn|
  5639. feature}
  5640. Specifies the name of the Python 3 home directory. When
  5641. 'pythonthreehome' and the PYTHONHOME environment variable are not set,
  5642. PYTHON3_HOME, which was specified at compile time, will be used for
  5643. the Python 3 home directory.
  5644. Environment variables are expanded |:set_env|.
  5645. This option cannot be set from a |modeline| or in the |sandbox|, for
  5646. security reasons.
  5647. *'pyxversion'* *'pyx'*
  5648. 'pyxversion' 'pyx' number (default depends on the build)
  5649. global
  5650. {only available when compiled with the |+python| or
  5651. the |+python3| feature}
  5652. Specifies the python version used for pyx* functions and commands
  5653. |python_x|. The default value is as follows:
  5654. Compiled with Default ~
  5655. |+python| and |+python3| 0
  5656. only |+python| 2
  5657. only |+python3| 3
  5658. Available values are 0, 2 and 3.
  5659. If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
  5660. any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
  5661. sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
  5662. to 2 if Python 2 is available.
  5663. See also: |has-pythonx|
  5664. If Vim is compiled with only |+python| or |+python3| setting
  5665. 'pyxversion' has no effect. The pyx* functions and commands are
  5666. always the same as the compiled version.
  5667. This option cannot be set from a |modeline| or in the |sandbox|, for
  5668. security reasons.
  5669. *'quickfixtextfunc'* *'qftf'*
  5670. 'quickfixtextfunc' 'qftf' string (default "")
  5671. global
  5672. {only available when compiled with the |+quickfix|
  5673. feature}
  5674. This option specifies a function to be used to get the text to display
  5675. in the quickfix and location list windows. This can be used to
  5676. customize the information displayed in the quickfix or location window
  5677. for each entry in the corresponding quickfix or location list. See
  5678. |quickfix-window-function| for an explanation of how to write the
  5679. function and an example. The value can be the name of a function, a
  5680. |lambda| or a |Funcref|. See |option-value-function| for more
  5681. information.
  5682. This option cannot be set from a |modeline| or in the |sandbox|, for
  5683. security reasons.
  5684. *'quoteescape'* *'qe'*
  5685. 'quoteescape' 'qe' string (default "\")
  5686. local to buffer
  5687. The characters that are used to escape quotes in a string. Used for
  5688. objects like a', a" and a` |a'|.
  5689. When one of the characters in this option is found inside a string,
  5690. the following character will be skipped. The default value makes the
  5691. text "foo\"bar\\" considered to be one string.
  5692. *'readonly'* *'ro'* *'noreadonly'* *'noro'*
  5693. 'readonly' 'ro' boolean (default off)
  5694. local to buffer
  5695. If on, writes fail unless you use a '!'. Protects you from
  5696. accidentally overwriting a file. Default on when Vim is started
  5697. in read-only mode ("vim -R") or when the executable is called "view".
  5698. When using ":w!" the 'readonly' option is reset for the current
  5699. buffer, unless the 'Z' flag is in 'cpoptions'.
  5700. When using the ":view" command the 'readonly' option is set for the
  5701. newly edited buffer.
  5702. See 'modifiable' for disallowing changes to the buffer.
  5703. *'redrawtime'* *'rdt'*
  5704. 'redrawtime' 'rdt' number (default 2000)
  5705. global
  5706. {only available when compiled with the |+reltime|
  5707. feature}
  5708. The time in milliseconds for redrawing the display. This applies to
  5709. searching for patterns for 'hlsearch', |:match| highlighting and syntax
  5710. highlighting.
  5711. When redrawing takes more than this many milliseconds no further
  5712. matches will be highlighted.
  5713. For syntax highlighting the time applies per window. When over the
  5714. limit syntax highlighting is disabled until |CTRL-L| is used.
  5715. This is used to avoid that Vim hangs when using a very complicated
  5716. pattern.
  5717. *'regexpengine'* *'re'*
  5718. 'regexpengine' 're' number (default 0)
  5719. global
  5720. This selects the default regexp engine. |two-engines|
  5721. The possible values are:
  5722. 0 automatic selection
  5723. 1 old engine
  5724. 2 NFA engine
  5725. Note that when using the NFA engine and the pattern contains something
  5726. that is not supported the pattern will not match. This is only useful
  5727. for debugging the regexp engine.
  5728. Using automatic selection enables Vim to switch the engine, if the
  5729. default engine becomes too costly. E.g., when the NFA engine uses too
  5730. many states. This should prevent Vim from hanging on a combination of
  5731. a complex pattern with long text.
  5732. *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
  5733. 'relativenumber' 'rnu' boolean (default off)
  5734. local to window
  5735. Show the line number relative to the line with the cursor in front of
  5736. each line. Relative line numbers help you use the |count| you can
  5737. precede some vertical motion commands (e.g. j k + -) with, without
  5738. having to calculate it yourself. Especially useful in combination with
  5739. other commands (e.g. y d c < > gq gw =).
  5740. When the 'n' option is excluded from 'cpoptions' a wrapped
  5741. line will not use the column of line numbers (this is the default when
  5742. 'compatible' isn't set).
  5743. The 'numberwidth' option can be used to set the room used for the line
  5744. number.
  5745. When a long, wrapped line doesn't start with the first character, '-'
  5746. characters are put before the number.
  5747. See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
  5748. the number.
  5749. The number in front of the cursor line also depends on the value of
  5750. 'number', see |number_relativenumber| for all combinations of the two
  5751. options.
  5752. *'remap'* *'noremap'*
  5753. 'remap' boolean (default on)
  5754. global
  5755. Allows for mappings to work recursively. If you do not want this for
  5756. a single entry, use the :noremap[!] command.
  5757. NOTE: To avoid portability problems with Vim scripts, always keep
  5758. this option at the default "on". Only switch it off when working with
  5759. old Vi scripts.
  5760. *'renderoptions'* *'rop'*
  5761. 'renderoptions' 'rop' string (default: empty)
  5762. global
  5763. {only available when compiled with GUI and DIRECTX on
  5764. MS-Windows}
  5765. Select a text renderer and set its options. The options depend on the
  5766. renderer.
  5767. Syntax: >
  5768. set rop=type:{renderer}(,{name}:{value})*
  5769. <
  5770. Currently, only one optional renderer is available.
  5771. render behavior ~
  5772. directx Vim will draw text using DirectX (DirectWrite). It makes
  5773. drawn glyphs more beautiful than default GDI.
  5774. It requires 'encoding' is "utf-8", and only works on
  5775. MS-Windows Vista or newer version.
  5776. Options:
  5777. name meaning type value ~
  5778. gamma gamma float 1.0 - 2.2 (maybe)
  5779. contrast enhancedContrast float (unknown)
  5780. level clearTypeLevel float (unknown)
  5781. geom pixelGeometry int 0 - 2 (see below)
  5782. renmode renderingMode int 0 - 6 (see below)
  5783. taamode textAntialiasMode int 0 - 3 (see below)
  5784. scrlines Scroll Lines int (deprecated)
  5785. See this URL for detail (except for scrlines):
  5786. https://msdn.microsoft.com/en-us/library/dd368190.aspx
  5787. For geom: structure of a device pixel.
  5788. 0 - DWRITE_PIXEL_GEOMETRY_FLAT
  5789. 1 - DWRITE_PIXEL_GEOMETRY_RGB
  5790. 2 - DWRITE_PIXEL_GEOMETRY_BGR
  5791. See this URL for detail:
  5792. https://msdn.microsoft.com/en-us/library/dd368114.aspx
  5793. For renmode: method of rendering glyphs.
  5794. 0 - DWRITE_RENDERING_MODE_DEFAULT
  5795. 1 - DWRITE_RENDERING_MODE_ALIASED
  5796. 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
  5797. 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
  5798. 4 - DWRITE_RENDERING_MODE_NATURAL
  5799. 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
  5800. 6 - DWRITE_RENDERING_MODE_OUTLINE
  5801. See this URL for detail:
  5802. https://msdn.microsoft.com/en-us/library/dd368118.aspx
  5803. For taamode: antialiasing mode used for drawing text.
  5804. 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
  5805. 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
  5806. 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
  5807. 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
  5808. See this URL for detail:
  5809. https://msdn.microsoft.com/en-us/library/dd368170.aspx
  5810. For scrlines:
  5811. This was used for optimizing scrolling behavior, however this
  5812. is now deprecated. If specified, it is simply ignored.
  5813. Example: >
  5814. set encoding=utf-8
  5815. set gfn=Ricty_Diminished:h12
  5816. set rop=type:directx
  5817. <
  5818. If select a raster font (Courier, Terminal or FixedSys which
  5819. have ".fon" extension in file name) to 'guifont', it will be
  5820. drawn by GDI as a fallback.
  5821. NOTE: It is known that some fonts and options combination
  5822. causes trouble on drawing glyphs.
  5823. - 'renmode:5' and 'renmode:6' will not work with some
  5824. special made fonts (True-Type fonts which includes only
  5825. bitmap glyphs).
  5826. - 'taamode:3' will not work with some vector fonts.
  5827. NOTE: With this option, you can display colored emoji
  5828. (emoticon) in Windows 8.1 or later. To display colored emoji,
  5829. there are some conditions which you should notice.
  5830. - If your font includes non-colored emoji already, it will
  5831. be used.
  5832. - If your font doesn't have emoji, the system chooses an
  5833. alternative symbol font. On Windows 10, "Segoe UI Emoji"
  5834. will be used.
  5835. - When this alternative font didn't have fixed width glyph,
  5836. emoji might be rendered beyond the bounding box of drawing
  5837. cell.
  5838. Other render types are currently not supported.
  5839. *'report'*
  5840. 'report' number (default 2)
  5841. global
  5842. Threshold for reporting number of lines changed. When the number of
  5843. changed lines is more than 'report' a message will be given for most
  5844. ":" commands. If you want it always, set 'report' to 0.
  5845. For the ":substitute" command the number of substitutions is used
  5846. instead of the number of lines.
  5847. *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
  5848. 'restorescreen' 'rs' boolean (default on)
  5849. global
  5850. {only in MS-Windows console version}
  5851. When set, the screen contents is restored when exiting Vim. This also
  5852. happens when executing external commands.
  5853. For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
  5854. options in your .vimrc. To disable restoring:
  5855. set t_ti= t_te=
  5856. To enable restoring (for an xterm):
  5857. set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
  5858. (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
  5859. *'revins'* *'ri'* *'norevins'* *'nori'*
  5860. 'revins' 'ri' boolean (default off)
  5861. global
  5862. {only available when compiled with the |+rightleft|
  5863. feature}
  5864. Inserting characters in Insert mode will work backwards. See "typing
  5865. backwards" |ins-reverse|. This option can be toggled with the CTRL-_
  5866. command in Insert mode, when 'allowrevins' is set.
  5867. NOTE: This option is reset when 'compatible' is set.
  5868. This option is reset when 'paste' is set and restored when 'paste' is
  5869. reset.
  5870. *'rightleft'* *'rl'* *'norightleft'* *'norl'*
  5871. 'rightleft' 'rl' boolean (default off)
  5872. local to window
  5873. {only available when compiled with the |+rightleft|
  5874. feature}
  5875. When on, display orientation becomes right-to-left, i.e., characters
  5876. that are stored in the file appear from the right to the left.
  5877. Using this option, it is possible to edit files for languages that
  5878. are written from the right to the left such as Hebrew and Arabic.
  5879. This option is per window, so it is possible to edit mixed files
  5880. simultaneously, or to view the same file in both ways (this is
  5881. useful whenever you have a mixed text file with both right-to-left
  5882. and left-to-right strings so that both sets are displayed properly
  5883. in different windows). Also see |rileft.txt|.
  5884. *'rightleftcmd'* *'rlc'*
  5885. 'rightleftcmd' 'rlc' string (default "search")
  5886. local to window
  5887. {only available when compiled with the |+rightleft|
  5888. feature}
  5889. Each word in this option enables the command line editing to work in
  5890. right-to-left mode for a group of commands:
  5891. search "/" and "?" commands
  5892. This is useful for languages such as Hebrew, Arabic and Farsi.
  5893. The 'rightleft' option must be set for 'rightleftcmd' to take effect.
  5894. *'rubydll'*
  5895. 'rubydll' string (default: depends on the build)
  5896. global
  5897. {only available when compiled with the |+ruby/dyn|
  5898. feature}
  5899. Specifies the name of the Ruby shared library. The default is
  5900. DYNAMIC_RUBY_DLL, which was specified at compile time.
  5901. Environment variables are expanded |:set_env|.
  5902. This option cannot be set from a |modeline| or in the |sandbox|, for
  5903. security reasons.
  5904. *'ruler'* *'ru'* *'noruler'* *'noru'*
  5905. 'ruler' 'ru' boolean (default off, set in |defaults.vim|)
  5906. global
  5907. Show the line and column number of the cursor position, separated by a
  5908. comma. When there is room, the relative position of the displayed
  5909. text in the file is shown on the far right:
  5910. Top first line is visible
  5911. Bot last line is visible
  5912. All first and last line are visible
  5913. 45% relative position in the file
  5914. If 'rulerformat' is set, it will determine the contents of the ruler.
  5915. Each window has its own ruler. If a window has a status line, the
  5916. ruler is shown there. Otherwise it is shown in the last line of the
  5917. screen. If the statusline is given by 'statusline' (i.e. not empty),
  5918. this option takes precedence over 'ruler' and 'rulerformat'.
  5919. If the number of characters displayed is different from the number of
  5920. bytes in the text (e.g., for a TAB or a multibyte character), both
  5921. the text column (byte number) and the screen column are shown,
  5922. separated with a dash.
  5923. For an empty line "0-1" is shown.
  5924. For an empty buffer the line number will also be zero: "0,0-1".
  5925. This option is reset when 'paste' is set and restored when 'paste' is
  5926. reset.
  5927. If you don't want to see the ruler all the time but want to know where
  5928. you are, use "g CTRL-G" |g_CTRL-G|.
  5929. NOTE: This option is reset when 'compatible' is set.
  5930. *'rulerformat'* *'ruf'*
  5931. 'rulerformat' 'ruf' string (default empty)
  5932. global
  5933. {not available when compiled without the |+statusline|
  5934. feature}
  5935. When this option is not empty, it determines the content of the ruler
  5936. string, as displayed for the 'ruler' option.
  5937. The format of this option is like that of 'statusline'.
  5938. This option cannot be set in a modeline when 'modelineexpr' is off.
  5939. The default ruler width is 17 characters. To make the ruler 15
  5940. characters wide, put "%15(" at the start and "%)" at the end.
  5941. Example: >
  5942. :set rulerformat=%15(%c%V\ %p%%%)
  5943. <
  5944. *'runtimepath'* *'rtp'* *vimfiles*
  5945. 'runtimepath' 'rtp' string (default:
  5946. Unix: "$HOME/.vim,
  5947. $VIM/vimfiles,
  5948. $VIMRUNTIME,
  5949. $VIM/vimfiles/after,
  5950. $HOME/.vim/after"
  5951. Amiga: "home:vimfiles,
  5952. $VIM/vimfiles,
  5953. $VIMRUNTIME,
  5954. $VIM/vimfiles/after,
  5955. home:vimfiles/after"
  5956. MS-Windows: "$HOME/vimfiles,
  5957. $VIM/vimfiles,
  5958. $VIMRUNTIME,
  5959. $VIM/vimfiles/after,
  5960. $HOME/vimfiles/after"
  5961. macOS: "$VIM:vimfiles,
  5962. $VIMRUNTIME,
  5963. $VIM:vimfiles:after"
  5964. Haiku: "$BE_USER_SETTINGS/vim,
  5965. $VIM/vimfiles,
  5966. $VIMRUNTIME,
  5967. $VIM/vimfiles/after,
  5968. $BE_USER_SETTINGS/vim/after"
  5969. VMS: "sys$login:vimfiles,
  5970. $VIM/vimfiles,
  5971. $VIMRUNTIME,
  5972. $VIM/vimfiles/after,
  5973. sys$login:vimfiles/after")
  5974. global
  5975. This is a list of directories which will be searched for runtime
  5976. files:
  5977. filetype.vim filetypes by file name |new-filetype|
  5978. scripts.vim filetypes by file contents |new-filetype-scripts|
  5979. autoload/ automatically loaded scripts |autoload-functions|
  5980. colors/ color scheme files |:colorscheme|
  5981. compiler/ compiler files |:compiler|
  5982. doc/ documentation |write-local-help|
  5983. ftplugin/ filetype plugins |write-filetype-plugin|
  5984. import/ files that are found by `:import`
  5985. indent/ indent scripts |indent-expression|
  5986. keymap/ key mapping files |mbyte-keymap|
  5987. lang/ menu translations |:menutrans|
  5988. menu.vim GUI menus |menu.vim|
  5989. pack/ packages |:packadd|
  5990. plugin/ plugin scripts |write-plugin|
  5991. print/ files for printing |postscript-print-encoding|
  5992. spell/ spell checking files |spell|
  5993. syntax/ syntax files |mysyntaxfile|
  5994. tutor/ files for vimtutor |tutor|
  5995. And any other file searched for with the |:runtime| command.
  5996. The defaults for most systems are setup to search five locations:
  5997. 1. In your home directory, for your personal preferences.
  5998. 2. In a system-wide Vim directory, for preferences from the system
  5999. administrator.
  6000. 3. In $VIMRUNTIME, for files distributed with Vim.
  6001. *after-directory*
  6002. 4. In the "after" directory in the system-wide Vim directory. This is
  6003. for the system administrator to overrule or add to the distributed
  6004. defaults (rarely needed)
  6005. 5. In the "after" directory in your home directory. This is for
  6006. personal preferences to overrule or add to the distributed defaults
  6007. or system-wide settings (rarely needed).
  6008. More entries are added when using |packages|. If it gets very long
  6009. then `:set rtp` will be truncated, use `:echo &rtp` to see the full
  6010. string.
  6011. Note that, unlike 'path', no wildcards like "**" are allowed. Normal
  6012. wildcards are allowed, but can significantly slow down searching for
  6013. runtime files. For speed, use as few items as possible and avoid
  6014. wildcards.
  6015. See |:runtime|.
  6016. Example: >
  6017. :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
  6018. < This will use the directory "~/vimruntime" first (containing your
  6019. personal Vim runtime files), then "/mygroup/vim" (shared between a
  6020. group of people) and finally "$VIMRUNTIME" (the distributed runtime
  6021. files).
  6022. You probably should always include $VIMRUNTIME somewhere, to use the
  6023. distributed runtime files. You can put a directory before $VIMRUNTIME
  6024. to find files which replace a distributed runtime files. You can put
  6025. a directory after $VIMRUNTIME to find files which add to distributed
  6026. runtime files.
  6027. When Vim is started with |--clean| the home directory entries are not
  6028. included.
  6029. This option cannot be set from a |modeline| or in the |sandbox|, for
  6030. security reasons.
  6031. *'scroll'* *'scr'*
  6032. 'scroll' 'scr' number (default: half the window height)
  6033. local to window
  6034. Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
  6035. set to half the number of lines in the window when the window size
  6036. changes. This may happen when enabling the |status-line| or
  6037. 'tabline' option after setting the 'scroll' option.
  6038. If you give a count to the CTRL-U or CTRL-D command it will
  6039. be used as the new value for 'scroll'. Reset to half the window
  6040. height with ":set scroll=0".
  6041. *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
  6042. 'scrollbind' 'scb' boolean (default off)
  6043. local to window
  6044. See also |scroll-binding|. When this option is set, the current
  6045. window scrolls as other scrollbind windows (windows that also have
  6046. this option set) scroll. This option is useful for viewing the
  6047. differences between two versions of a file, see 'diff'.
  6048. See |'scrollopt'| for options that determine how this option should be
  6049. interpreted.
  6050. This option is mostly reset when splitting a window to edit another
  6051. file. This means that ":split | edit file" results in two windows
  6052. with scroll-binding, but ":split file" does not.
  6053. *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
  6054. 'scrollfocus' 'scf' boolean (default off)
  6055. global
  6056. {only for MS-Windows GUI}
  6057. When using the scroll wheel and this option is set, the window under
  6058. the mouse pointer is scrolled. With this option off the current
  6059. window is scrolled.
  6060. Systems other than MS-Windows always behave like this option is on.
  6061. *'scrolljump'* *'sj'*
  6062. 'scrolljump' 'sj' number (default 1)
  6063. global
  6064. Minimal number of lines to scroll when the cursor gets off the
  6065. screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
  6066. CTRL-D). Useful if your terminal scrolls very slowly.
  6067. When set to a negative number from -1 to -100 this is used as the
  6068. percentage of the window height. Thus -50 scrolls half the window
  6069. height.
  6070. NOTE: This option is set to 1 when 'compatible' is set.
  6071. *'scrolloff'* *'so'*
  6072. 'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
  6073. global or local to window |global-local|
  6074. Minimal number of screen lines to keep above and below the cursor.
  6075. This will make some context visible around where you are working. If
  6076. you set it to a very large value (999) the cursor line will always be
  6077. in the middle of the window (except at the start or end of the file or
  6078. when long lines wrap).
  6079. After using the local value, go back the global value with one of
  6080. these two: >
  6081. setlocal scrolloff<
  6082. setlocal scrolloff=-1
  6083. < For scrolling horizontally see 'sidescrolloff'.
  6084. NOTE: This option is set to 0 when 'compatible' is set.
  6085. *'scrollopt'* *'sbo'*
  6086. 'scrollopt' 'sbo' string (default "ver,jump")
  6087. global
  6088. This is a comma-separated list of words that specifies how
  6089. 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
  6090. Options.
  6091. The following words are available:
  6092. ver Bind vertical scrolling for 'scrollbind' windows
  6093. hor Bind horizontal scrolling for 'scrollbind' windows
  6094. jump Applies to the offset between two windows for vertical
  6095. scrolling. This offset is the difference in the first
  6096. displayed line of the bound windows. When moving
  6097. around in a window, another 'scrollbind' window may
  6098. reach a position before the start or after the end of
  6099. the buffer. The offset is not changed though, when
  6100. moving back the 'scrollbind' window will try to scroll
  6101. to the desired position when possible.
  6102. When now making that window the current one, two
  6103. things can be done with the relative offset:
  6104. 1. When "jump" is not included, the relative offset is
  6105. adjusted for the scroll position in the new current
  6106. window. When going back to the other window, the
  6107. new relative offset will be used.
  6108. 2. When "jump" is included, the other windows are
  6109. scrolled to keep the same relative offset. When
  6110. going back to the other window, it still uses the
  6111. same relative offset.
  6112. Also see |scroll-binding|.
  6113. When 'diff' mode is active there always is vertical scroll binding,
  6114. even when "ver" isn't there.
  6115. *'sections'* *'sect'*
  6116. 'sections' 'sect' string (default "SHNHH HUnhsh")
  6117. global
  6118. Specifies the nroff macros that separate sections. These are pairs of
  6119. two letters (See |object-motions|). The default makes a section start
  6120. at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
  6121. *'secure'* *'nosecure'* *E523*
  6122. 'secure' boolean (default off)
  6123. global
  6124. When on, ":autocmd", shell and write commands are not allowed in
  6125. ".vimrc" and ".exrc" in the current directory and map commands are
  6126. displayed. Switch it off only if you know that you will not run into
  6127. problems, or when the 'exrc' option is off. On Unix this option is
  6128. only used if the ".vimrc" or ".exrc" is not owned by you. This can be
  6129. dangerous if the systems allows users to do a "chown". You better set
  6130. 'secure' at the end of your ~/.vimrc then.
  6131. This option cannot be set from a |modeline| or in the |sandbox|, for
  6132. security reasons.
  6133. *'selection'* *'sel'*
  6134. 'selection' 'sel' string (default "inclusive")
  6135. global
  6136. This option defines the behavior of the selection. It is only used
  6137. in Visual and Select mode.
  6138. Possible values:
  6139. value past line inclusive ~
  6140. old no yes
  6141. inclusive yes yes
  6142. exclusive yes no
  6143. "past line" means that the cursor is allowed to be positioned one
  6144. character past the line.
  6145. "inclusive" means that the last character of the selection is included
  6146. in an operation. For example, when "x" is used to delete the
  6147. selection.
  6148. When "old" is used and 'virtualedit' allows the cursor to move past
  6149. the end of line the line break still isn't included.
  6150. Note that when "exclusive" is used and selecting from the end
  6151. backwards, you cannot include the last character of a line, when
  6152. starting in Normal mode and 'virtualedit' empty.
  6153. The 'selection' option is set by the |:behave| command.
  6154. *'selectmode'* *'slm'*
  6155. 'selectmode' 'slm' string (default "")
  6156. global
  6157. This is a comma-separated list of words, which specifies when to start
  6158. Select mode instead of Visual mode, when a selection is started.
  6159. Possible values:
  6160. mouse when using the mouse
  6161. key when using shifted special keys
  6162. cmd when using "v", "V" or CTRL-V
  6163. See |Select-mode|.
  6164. The 'selectmode' option is set by the |:behave| command.
  6165. *'sessionoptions'* *'ssop'*
  6166. 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
  6167. help,options,tabpages,winsize,terminal")
  6168. global
  6169. {not available when compiled without the |+mksession|
  6170. feature}
  6171. Changes the effect of the |:mksession| command. It is a comma
  6172. separated list of words. Each word enables saving and restoring
  6173. something:
  6174. word save and restore ~
  6175. blank empty windows
  6176. buffers hidden and unloaded buffers, not just those in windows
  6177. curdir the current directory
  6178. folds manually created folds, opened/closed folds and local
  6179. fold options
  6180. globals global variables that start with an uppercase letter
  6181. and contain at least one lowercase letter. Only
  6182. String and Number types are stored.
  6183. help the help window
  6184. localoptions options and mappings local to a window or buffer (not
  6185. global values for local options)
  6186. options all options and mappings (also global values for local
  6187. options)
  6188. skiprtp exclude 'runtimepath' and 'packpath' from the options
  6189. resize size of the Vim window: 'lines' and 'columns'
  6190. sesdir the directory in which the session file is located
  6191. will become the current directory (useful with
  6192. projects accessed over a network from different
  6193. systems)
  6194. slash backslashes in file names replaced with forward
  6195. slashes
  6196. tabpages all tab pages; without this only the current tab page
  6197. is restored, so that you can make a session for each
  6198. tab page separately
  6199. terminal include terminal windows where the command can be
  6200. restored
  6201. unix with Unix end-of-line format (single <NL>), even when
  6202. on Windows or DOS
  6203. winpos position of the whole Vim window
  6204. winsize window sizes
  6205. Don't include both "curdir" and "sesdir".
  6206. When neither "curdir" nor "sesdir" is included, file names are stored
  6207. with absolute paths.
  6208. If you leave out "options" many things won't work well after restoring
  6209. the session.
  6210. "slash" and "unix" are useful on Windows when sharing session files
  6211. with Unix. The Unix version of Vim cannot source dos format scripts,
  6212. but the Windows version of Vim can source unix format scripts.
  6213. *'shell'* *'sh'* *E91*
  6214. 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
  6215. global
  6216. Name of the shell to use for ! and :! commands. When changing the
  6217. value also check these options: 'shelltype', 'shellpipe', 'shellslash'
  6218. 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
  6219. It is allowed to give an argument to the command, e.g. "csh -f".
  6220. See |option-backslash| about including spaces and backslashes.
  6221. Environment variables are expanded |:set_env|.
  6222. In |restricted-mode| shell commands will not be possible. This mode
  6223. is used if the value of $SHELL ends in "false" or "nologin".
  6224. If the name of the shell contains a space, you need to enclose it in
  6225. quotes and escape the space. Example with quotes: >
  6226. :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
  6227. < Note the backslash before each quote (to avoid starting a comment) and
  6228. each space (to avoid ending the option value). Also note that the
  6229. "-f" is not inside the quotes, because it is not part of the command
  6230. name. Vim automagically recognizes the backslashes that are path
  6231. separators.
  6232. Example with escaped space (Vim will do this when initializing the
  6233. option from $SHELL): >
  6234. :set shell=/bin/with\\\ space/sh
  6235. < The resulting value of 'shell' is "/bin/with\ space/sh", two
  6236. backslashes are consumed by `:set`.
  6237. Under MS-Windows, when the executable ends in ".com" it must be
  6238. included. Thus setting the shell to "command.com" or "4dos.com"
  6239. works, but "command" and "4dos" do not work for all commands (e.g.,
  6240. filtering).
  6241. For unknown reasons, when using "4dos.com" the current directory is
  6242. changed to "C:\". To avoid this set 'shell' like this: >
  6243. :set shell=command.com\ /c\ 4dos
  6244. < This option cannot be set from a |modeline| or in the |sandbox|, for
  6245. security reasons.
  6246. *'shellcmdflag'* *'shcf'*
  6247. 'shellcmdflag' 'shcf' string (default: "-c";
  6248. Win32, when 'shell' contains "powershell":
  6249. "-Command", or when it does not contain "sh"
  6250. somewhere: "/c")
  6251. global
  6252. Flag passed to the shell to execute "!" and ":!" commands; e.g.,
  6253. "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
  6254. For MS-Windows, the default is set according to the value of 'shell',
  6255. to reduce the need to set this option by the user.
  6256. On Unix it can have more than one flag. Each white space separated
  6257. part is passed as an argument to the shell command.
  6258. See |option-backslash| about including spaces and backslashes.
  6259. Also see |dos-shell| and |dos-powershell| for MS-Windows.
  6260. This option cannot be set from a |modeline| or in the |sandbox|, for
  6261. security reasons.
  6262. *'shellpipe'* *'sp'*
  6263. 'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
  6264. "2>&1| tee", or
  6265. "2>&1 | Out-File -Encoding default")
  6266. global
  6267. {not available when compiled without the |+quickfix|
  6268. feature}
  6269. String to be used to put the output of the ":make" command in the
  6270. error file. See also |:make_makeprg|. See |option-backslash| about
  6271. including spaces and backslashes.
  6272. The name of the temporary file can be represented by "%s" if necessary
  6273. (the file name is appended automatically if no %s appears in the value
  6274. of this option).
  6275. For the Amiga the default is ">". For MS-Windows using powershell the
  6276. default is "2>&1 | Out-File -Encoding default", otherwise the default
  6277. is ">%s 2>&1". The output is directly saved in a file and not echoed
  6278. to the screen.
  6279. For Unix the default is "| tee". The stdout of the compiler is saved
  6280. in a file and echoed to the screen. If the 'shell' option is "csh" or
  6281. "tcsh" after initializations, the default becomes "|& tee". If the
  6282. 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  6283. "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
  6284. means that stderr is also included. Before using the 'shell' option a
  6285. path is removed, thus "/bin/sh" uses "sh".
  6286. For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
  6287. becomes ">%s 2>&1" and the output is not echoed to the screen.
  6288. The initialization of this option is done after reading the ".vimrc"
  6289. and the other initializations, so that when the 'shell' option is set
  6290. there, the 'shellpipe' option changes automatically, unless it was
  6291. explicitly set before.
  6292. When 'shellpipe' is set to an empty string, no redirection of the
  6293. ":make" output will be done. This is useful if you use a 'makeprg'
  6294. that writes to 'makeef' by itself. If you want no piping, but do
  6295. want to include the 'makeef', set 'shellpipe' to a single space.
  6296. Don't forget to precede the space with a backslash: ":set sp=\ ".
  6297. In the future pipes may be used for filtering and this option will
  6298. become obsolete (at least for Unix).
  6299. This option cannot be set from a |modeline| or in the |sandbox|, for
  6300. security reasons.
  6301. *'shellquote'* *'shq'*
  6302. 'shellquote' 'shq' string (default: "")
  6303. global
  6304. Quoting character(s), put around the command passed to the shell, for
  6305. the "!" and ":!" commands. The redirection is kept outside of the
  6306. quoting. See 'shellxquote' to include the redirection. It's
  6307. probably not useful to set both options.
  6308. This is an empty string by default. Only known to be useful for
  6309. third-party shells on MS-Windows-like systems, such as the MKS Korn
  6310. Shell or bash, where it should be "\"". See |dos-shell|.
  6311. This option cannot be set from a |modeline| or in the |sandbox|, for
  6312. security reasons.
  6313. *'shellredir'* *'srr'*
  6314. 'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
  6315. "2>&1 | Out-File -Encoding default")
  6316. global
  6317. String to be used to put the output of a filter command in a temporary
  6318. file. See also |:!|. See |option-backslash| about including spaces
  6319. and backslashes.
  6320. The name of the temporary file can be represented by "%s" if necessary
  6321. (the file name is appended automatically if no %s appears in the value
  6322. of this option).
  6323. The default is ">". For Unix, if the 'shell' option is "csh" or
  6324. "tcsh" during initializations, the default becomes ">&". If the
  6325. 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
  6326. "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
  6327. that stderr is also included. For Win32, the Unix checks are done and
  6328. additionally "cmd" is checked for, which makes the default ">%s 2>&1",
  6329. and "powershell" is checked for which makes the default
  6330. "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
  6331. same names with ".exe" appended are checked for.
  6332. The initialization of this option is done after reading the ".vimrc"
  6333. and the other initializations, so that when the 'shell' option is set
  6334. there, the 'shellredir' option changes automatically unless it was
  6335. explicitly set before.
  6336. In the future pipes may be used for filtering and this option will
  6337. become obsolete (at least for Unix).
  6338. This option cannot be set from a |modeline| or in the |sandbox|, for
  6339. security reasons.
  6340. *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
  6341. 'shellslash' 'ssl' boolean (default off)
  6342. global
  6343. {only for MS-Windows}
  6344. When set, a forward slash is used when expanding file names. This is
  6345. useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
  6346. powershell.exe. Backward slashes can still be typed, but they are
  6347. changed to forward slashes by Vim.
  6348. Note that setting or resetting this option has no effect for some
  6349. existing file names, thus this option needs to be set before opening
  6350. any file for best results. This might change in the future.
  6351. 'shellslash' only works when a backslash can be used as a path
  6352. separator. To test if this is so use: >
  6353. if exists('+shellslash')
  6354. < Also see 'completeslash'.
  6355. *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
  6356. 'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
  6357. global
  6358. When on, use temp files for shell commands. When off use a pipe.
  6359. When using a pipe is not possible temp files are used anyway.
  6360. Currently a pipe is only supported on Unix and MS-Windows 2K and
  6361. later. You can check it with: >
  6362. :if has("filterpipe")
  6363. < The advantage of using a pipe is that nobody can read the temp file
  6364. and the 'shell' command does not need to support redirection.
  6365. The advantage of using a temp file is that the file type and encoding
  6366. can be detected.
  6367. The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
  6368. |FilterWritePost| autocommands event are not triggered when
  6369. 'shelltemp' is off.
  6370. The `system()` function does not respect this option and always uses
  6371. temp files.
  6372. NOTE: This option is set to the Vim default value when 'compatible'
  6373. is reset.
  6374. *'shelltype'* *'st'*
  6375. 'shelltype' 'st' number (default 0)
  6376. global
  6377. {only for the Amiga}
  6378. On the Amiga this option influences the way how the commands work
  6379. which use a shell.
  6380. 0 and 1: always use the shell
  6381. 2 and 3: use the shell only to filter lines
  6382. 4 and 5: use shell only for ':sh' command
  6383. When not using the shell, the command is executed directly.
  6384. 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
  6385. 1 and 3: use "shell cmd" to start external commands
  6386. *'shellxescape'* *'sxe'*
  6387. 'shellxescape' 'sxe' string (default: "";
  6388. for MS-Windows: "\"&|<>()@^")
  6389. global
  6390. When 'shellxquote' is set to "(" then the characters listed in this
  6391. option will be escaped with a '^' character. This makes it possible
  6392. to execute most external commands with cmd.exe.
  6393. *'shellxquote'* *'sxq'*
  6394. 'shellxquote' 'sxq' string (default: "";
  6395. for Win32, when 'shell' is cmd.exe: "("
  6396. for Win32, when 'shell' is
  6397. powershell.exe: "\""
  6398. for Win32, when 'shell' contains "sh"
  6399. somewhere: "\""
  6400. for Unix, when using system(): "\"")
  6401. global
  6402. Quoting character(s), put around the command passed to the shell, for
  6403. the "!" and ":!" commands. Includes the redirection. See
  6404. 'shellquote' to exclude the redirection. It's probably not useful
  6405. to set both options.
  6406. When the value is '(' then ')' is appended. When the value is '"('
  6407. then ')"' is appended.
  6408. When the value is '(' then also see 'shellxescape'.
  6409. This is an empty string by default on most systems, but is known to be
  6410. useful for on Win32 version, either for cmd.exe, powershell.exe, or
  6411. pwsh.exe which automatically strips off the first and last quote on a
  6412. command, or 3rd-party shells such as the MKS Korn Shell or bash, where
  6413. it should be "\"". The default is adjusted according the value of
  6414. 'shell', to reduce the need to set this option by the user. See
  6415. |dos-shell|.
  6416. This option cannot be set from a |modeline| or in the |sandbox|, for
  6417. security reasons.
  6418. *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
  6419. 'shiftround' 'sr' boolean (default off)
  6420. global
  6421. Round indent to multiple of 'shiftwidth'. Applies to > and <
  6422. commands. CTRL-T and CTRL-D in Insert mode always round the indent to
  6423. a multiple of 'shiftwidth' (this is Vi compatible).
  6424. NOTE: This option is reset when 'compatible' is set.
  6425. *'shiftwidth'* *'sw'*
  6426. 'shiftwidth' 'sw' number (default 8)
  6427. local to buffer
  6428. Number of spaces to use for each step of (auto)indent. Used for
  6429. |'cindent'|, |>>|, |<<|, etc.
  6430. When zero the 'ts' value will be used. Use the |shiftwidth()|
  6431. function to get the effective shiftwidth value.
  6432. *'shortmess'* *'shm'*
  6433. 'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
  6434. POSIX default: "AS")
  6435. global
  6436. This option helps to avoid all the |hit-enter| prompts caused by file
  6437. messages, for example with CTRL-G, and to avoid some other messages.
  6438. It is a list of flags:
  6439. flag meaning when present ~
  6440. f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
  6441. i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
  6442. l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
  6443. m use "[+]" instead of "[Modified]" *shm-m*
  6444. n use "[New]" instead of "[New File]" *shm-n*
  6445. r use "[RO]" instead of "[readonly]" *shm-r*
  6446. w use "[w]" instead of "written" for file write message *shm-w*
  6447. and "[a]" instead of "appended" for ':w >> file' command
  6448. x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
  6449. instead of "[unix format]" and "[mac]" instead of "[mac
  6450. format]".
  6451. a all of the above abbreviations *shm-a*
  6452. o overwrite message for writing a file with subsequent *shm-o*
  6453. message for reading a file (useful for ":wn" or when
  6454. 'autowrite' on)
  6455. O message for reading a file overwrites any previous *smh-O*
  6456. message. Also for quickfix message (e.g., ":cn").
  6457. s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
  6458. "search hit TOP, continuing at BOTTOM" messages; when using
  6459. the search count do not show "W" after the count message (see
  6460. S below)
  6461. t truncate file message at the start if it is too long *shm-t*
  6462. to fit on the command-line, "<" will appear in the left most
  6463. column. Ignored in Ex mode.
  6464. T truncate other messages in the middle if they are too *shm-T*
  6465. long to fit on the command line. "..." will appear in the
  6466. middle. Ignored in Ex mode.
  6467. W don't give "written" or "[w]" when writing a file *shm-W*
  6468. A don't give the "ATTENTION" message when an existing *shm-A*
  6469. swap file is found.
  6470. I don't give the intro message when starting Vim, *shm-I*
  6471. see |:intro|.
  6472. c don't give |ins-completion-menu| messages. For *shm-c*
  6473. example, "-- XXX completion (YYY)", "match 1 of 2", "The only
  6474. match", "Pattern not found", "Back at original", etc.
  6475. C don't give messages while scanning for ins-completion *shm-C*
  6476. items, for instance "scanning tags"
  6477. q use "recording" instead of "recording @a" *shm-q*
  6478. F don't give the file info when editing a file, like *shm-F*
  6479. `:silent` was used for the command; note that this also
  6480. affects messages from autocommands
  6481. S do not show search count message when searching, e.g. *shm-S*
  6482. "[1/5]"
  6483. This gives you the opportunity to avoid that a change between buffers
  6484. requires you to hit <Enter>, but still gives as useful a message as
  6485. possible for the space available. To get the whole message that you
  6486. would have got with 'shm' empty, use ":file!"
  6487. Useful values:
  6488. shm= No abbreviation of message.
  6489. shm=a Abbreviation, but no loss of information.
  6490. shm=at Abbreviation, and truncate message when necessary.
  6491. NOTE: This option is set to the Vi default value when 'compatible' is
  6492. set and to the Vim default value when 'compatible' is reset.
  6493. *'shortname'* *'sn'* *'noshortname'* *'nosn'*
  6494. 'shortname' 'sn' boolean (default off)
  6495. local to buffer
  6496. Filenames are assumed to be 8 characters plus one extension of 3
  6497. characters. Multiple dots in file names are not allowed. When this
  6498. option is on, dots in file names are replaced with underscores when
  6499. adding an extension (".~" or ".swp"). This option is useful
  6500. when editing files on an MS-DOS compatible filesystem, e.g., messydos
  6501. or crossdos.
  6502. *'showbreak'* *'sbr'* *E595*
  6503. 'showbreak' 'sbr' string (default "")
  6504. global or local to window |global-local|
  6505. {not available when compiled without the |+linebreak|
  6506. feature}
  6507. String to put at the start of lines that have been wrapped. Useful
  6508. values are "> " or "+++ ": >
  6509. :set showbreak=>\
  6510. < Note the backslash to escape the trailing space. It's easier like
  6511. this: >
  6512. :let &showbreak = '+++ '
  6513. < Only printable single-cell characters are allowed, excluding <Tab> and
  6514. comma (in a future version the comma might be used to separate the
  6515. part that is shown at the end and at the start of a line).
  6516. The characters are highlighted according to the '@' flag in
  6517. 'highlight'.
  6518. Note that tabs after the showbreak will be displayed differently.
  6519. If you want the 'showbreak' to appear in between line numbers, add the
  6520. "n" flag to 'cpoptions'.
  6521. A window-local value overrules a global value. If the global value is
  6522. set and you want no value in the current window use NONE: >
  6523. :setlocal showbreak=NONE
  6524. <
  6525. *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
  6526. 'showcmd' 'sc' boolean (Vim default: on, off for Unix,
  6527. Vi default: off, set in |defaults.vim|)
  6528. global
  6529. Show (partial) command in the last line of the screen. Set this
  6530. option off if your terminal is slow.
  6531. In Visual mode the size of the selected area is shown:
  6532. - When selecting characters within a line, the number of characters.
  6533. If the number of bytes is different it is also displayed: "2-6"
  6534. means two characters and six bytes.
  6535. - When selecting more than one line, the number of lines.
  6536. - When selecting a block, the size in screen characters:
  6537. {lines}x{columns}.
  6538. This information can be displayed in an alternative location using the
  6539. 'showcmdloc' option.
  6540. NOTE: This option is set to the Vi default value when 'compatible' is
  6541. set and to the Vim default value when 'compatible' is reset.
  6542. *'showcmdloc'* *'sloc'*
  6543. 'showcmdloc' 'sloc' string (default "last")
  6544. This option can be used to display the (partially) entered command in
  6545. another location. Possible values are:
  6546. last Last line of the screen (default).
  6547. statusline Status line of the current window.
  6548. tabline First line of the screen if 'showtabine' is enabled.
  6549. Setting this option to "statusline" or "tabline" means that these will
  6550. be redrawn whenever the command changes, which can be on every key
  6551. pressed.
  6552. The %S 'statusline' item can be used in 'statusline' or 'tabline' to
  6553. place the text. Without a custom 'statusline' or 'tabline' it will be
  6554. displayed in a convenient location.
  6555. *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
  6556. 'showfulltag' 'sft' boolean (default off)
  6557. global
  6558. When completing a word in insert mode (see |ins-completion|) from the
  6559. tags file, show both the tag name and a tidied-up form of the search
  6560. pattern (if there is one) as possible matches. Thus, if you have
  6561. matched a C function, you can see a template for what arguments are
  6562. required (coding style permitting).
  6563. Note that this doesn't work well together with having "longest" in
  6564. 'completeopt', because the completion from the search pattern may not
  6565. match the typed text.
  6566. *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
  6567. 'showmatch' 'sm' boolean (default off)
  6568. global
  6569. When a bracket is inserted, briefly jump to the matching one. The
  6570. jump is only done if the match can be seen on the screen. The time to
  6571. show the match can be set with 'matchtime'.
  6572. A Beep is given if there is no match (no matter if the match can be
  6573. seen or not).
  6574. This option is reset when 'paste' is set and restored when 'paste' is
  6575. reset.
  6576. When the 'm' flag is not included in 'cpoptions', typing a character
  6577. will immediately move the cursor back to where it belongs.
  6578. See the "sm" field in 'guicursor' for setting the cursor shape and
  6579. blinking when showing the match.
  6580. The 'matchpairs' option can be used to specify the characters to show
  6581. matches for. 'rightleft' and 'revins' are used to look for opposite
  6582. matches.
  6583. Also see the matchparen plugin for highlighting the match when moving
  6584. around |pi_paren.txt|.
  6585. Note: Use of the short form is rated PG.
  6586. *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
  6587. 'showmode' 'smd' boolean (Vim default: on, Vi default: off)
  6588. global
  6589. If in Insert, Replace or Visual mode put a message on the last line.
  6590. Use the 'M' flag in 'highlight' to set the type of highlighting for
  6591. this message.
  6592. When |XIM| may be used the message will include "XIM". But this
  6593. doesn't mean XIM is really active, especially when 'imactivatekey' is
  6594. not set.
  6595. NOTE: This option is set to the Vi default value when 'compatible' is
  6596. set and to the Vim default value when 'compatible' is reset.
  6597. *'showtabline'* *'stal'*
  6598. 'showtabline' 'stal' number (default 1)
  6599. global
  6600. The value of this option specifies when the line with tab page labels
  6601. will be displayed:
  6602. 0: never
  6603. 1: only if there are at least two tab pages
  6604. 2: always
  6605. This is both for the GUI and non-GUI implementation of the tab pages
  6606. line.
  6607. See |tab-page| for more information about tab pages.
  6608. *'sidescroll'* *'ss'*
  6609. 'sidescroll' 'ss' number (default 0)
  6610. global
  6611. The minimal number of columns to scroll horizontally. Used only when
  6612. the 'wrap' option is off and the cursor is moved off of the screen.
  6613. When it is zero the cursor will be put in the middle of the screen.
  6614. When using a slow terminal set it to a large number or 0. When using
  6615. a fast terminal use a small number or 1. Not used for "zh" and "zl"
  6616. commands.
  6617. *'sidescrolloff'* *'siso'*
  6618. 'sidescrolloff' 'siso' number (default 0)
  6619. global or local to window |global-local|
  6620. The minimal number of screen columns to keep to the left and to the
  6621. right of the cursor if 'nowrap' is set. Setting this option to a
  6622. value greater than 0 while having |'sidescroll'| also at a non-zero
  6623. value makes some context visible in the line you are scrolling in
  6624. horizontally (except at beginning of the line). Setting this option
  6625. to a large value (like 999) has the effect of keeping the cursor
  6626. horizontally centered in the window, as long as one does not come too
  6627. close to the beginning of the line.
  6628. After using the local value, go back the global value with one of
  6629. these two: >
  6630. setlocal sidescrolloff<
  6631. setlocal sidescrolloff=-1
  6632. < NOTE: This option is set to 0 when 'compatible' is set.
  6633. Example: Try this together with 'sidescroll' and 'listchars' as
  6634. in the following example to never allow the cursor to move
  6635. onto the "extends" character: >
  6636. :set nowrap sidescroll=1 listchars=extends:>,precedes:<
  6637. :set sidescrolloff=1
  6638. <
  6639. *'signcolumn'* *'scl'*
  6640. 'signcolumn' 'scl' string (default "auto")
  6641. local to window
  6642. {not available when compiled without the |+signs|
  6643. feature}
  6644. Whether or not to draw the signcolumn. Valid values are:
  6645. "auto" only when there is a sign to display
  6646. "no" never
  6647. "yes" always
  6648. "number" display signs in the 'number' column. If the number
  6649. column is not present, then behaves like "auto".
  6650. *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
  6651. 'smartcase' 'scs' boolean (default off)
  6652. global
  6653. Override the 'ignorecase' option if the search pattern contains upper
  6654. case characters. Only used when the search pattern is typed and
  6655. 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
  6656. ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
  6657. "*" and "#" you can make 'smartcase' used by doing a "/" command,
  6658. recalling the search pattern from history and hitting <Enter>.
  6659. NOTE: This option is reset when 'compatible' is set.
  6660. *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
  6661. 'smartindent' 'si' boolean (default off)
  6662. local to buffer
  6663. Do smart autoindenting when starting a new line. Works for C-like
  6664. programs, but can also be used for other languages. 'cindent' does
  6665. something like this, works better in most cases, but is more strict,
  6666. see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
  6667. setting 'si' has no effect. 'indentexpr' is a more advanced
  6668. alternative.
  6669. Normally 'autoindent' should also be on when using 'smartindent'.
  6670. An indent is automatically inserted:
  6671. - After a line ending in '{'.
  6672. - After a line starting with a keyword from 'cinwords'.
  6673. - Before a line starting with '}' (only with the "O" command).
  6674. When typing '}' as the first character in a new line, that line is
  6675. given the same indent as the matching '{'.
  6676. When typing '#' as the first character in a new line, the indent for
  6677. that line is removed, the '#' is put in the first column. The indent
  6678. is restored for the next line. If you don't want this, use this
  6679. mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
  6680. When using the ">>" command, lines starting with '#' are not shifted
  6681. right.
  6682. NOTE: This option is reset when 'compatible' is set.
  6683. This option is reset when 'paste' is set and restored when 'paste' is
  6684. reset.
  6685. *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
  6686. 'smarttab' 'sta' boolean (default off)
  6687. global
  6688. When on, a <Tab> in front of a line inserts blanks according to
  6689. 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
  6690. <BS> will delete a 'shiftwidth' worth of space at the start of the
  6691. line.
  6692. When off, a <Tab> always inserts blanks according to 'tabstop' or
  6693. 'softtabstop'. 'shiftwidth' is only used for shifting text left or
  6694. right |shift-left-right|.
  6695. What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
  6696. option. Also see |ins-expandtab|. When 'expandtab' is not set, the
  6697. number of spaces is minimized by using <Tab>s.
  6698. This option is reset when 'paste' is set and restored when 'paste' is
  6699. reset.
  6700. NOTE: This option is reset when 'compatible' is set.
  6701. *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
  6702. 'smoothscroll' 'sms' boolean (default off)
  6703. local to window
  6704. Scrolling works with screen lines. When 'wrap' is set and the first
  6705. line in the window wraps part of it may not be visible, as if it is
  6706. above the window. "<<<" is displayed at the start of the first line,
  6707. highlighted with |hl-NonText|.
  6708. NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
  6709. and scrolling with the mouse.
  6710. *'softtabstop'* *'sts'*
  6711. 'softtabstop' 'sts' number (default 0)
  6712. local to buffer
  6713. Number of spaces that a <Tab> counts for while performing editing
  6714. operations, like inserting a <Tab> or using <BS>. It "feels" like
  6715. <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
  6716. used. This is useful to keep the 'ts' setting at its standard value
  6717. of 8, while being able to edit like it is set to 'sts'. However,
  6718. commands like "x" still work on the actual characters.
  6719. When 'sts' is zero, this feature is off.
  6720. When 'sts' is negative, the value of 'shiftwidth' is used.
  6721. 'softtabstop' is set to 0 when the 'paste' option is set and restored
  6722. when 'paste' is reset.
  6723. See also |ins-expandtab|. When 'expandtab' is not set, the number of
  6724. spaces is minimized by using <Tab>s.
  6725. The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
  6726. set.
  6727. NOTE: This option is set to 0 when 'compatible' is set.
  6728. If Vim is compiled with the |+vartabs| feature then the value of
  6729. 'softtabstop' will be ignored if |'varsofttabstop'| is set to
  6730. anything other than an empty string.
  6731. *'spell'* *'nospell'*
  6732. 'spell' boolean (default off)
  6733. local to window
  6734. {not available when compiled without the |+syntax|
  6735. feature}
  6736. When on spell checking will be done. See |spell|.
  6737. The languages are specified with 'spelllang'.
  6738. *'spellcapcheck'* *'spc'*
  6739. 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
  6740. local to buffer
  6741. {not available when compiled without the |+syntax|
  6742. feature}
  6743. Pattern to locate the end of a sentence. The following word will be
  6744. checked to start with a capital letter. If not then it is highlighted
  6745. with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
  6746. When this check is not wanted make this option empty.
  6747. Only used when 'spell' is set.
  6748. Be careful with special characters, see |option-backslash| about
  6749. including spaces and backslashes.
  6750. To set this option automatically depending on the language, see
  6751. |set-spc-auto|.
  6752. *'spellfile'* *'spf'*
  6753. 'spellfile' 'spf' string (default empty)
  6754. local to buffer
  6755. {not available when compiled without the |+syntax|
  6756. feature}
  6757. Name of the word list file where words are added for the |zg| and |zw|
  6758. commands. It must end in ".{encoding}.add". You need to include the
  6759. path, otherwise the file is placed in the current directory.
  6760. The path may include characters from 'isfname', space, comma and '@'.
  6761. *E765*
  6762. It may also be a comma-separated list of names. A count before the
  6763. |zg| and |zw| commands can be used to access each. This allows using
  6764. a personal word list file and a project word list file.
  6765. When a word is added while this option is empty Vim will set it for
  6766. you: Using the first directory in 'runtimepath' that is writable. If
  6767. there is no "spell" directory yet it will be created. For the file
  6768. name the first language name that appears in 'spelllang' is used,
  6769. ignoring the region.
  6770. The resulting ".spl" file will be used for spell checking, it does not
  6771. have to appear in 'spelllang'.
  6772. Normally one file is used for all regions, but you can add the region
  6773. name if you want to. However, it will then only be used when
  6774. 'spellfile' is set to it, for entries in 'spelllang' only files
  6775. without region name will be found.
  6776. This option cannot be set from a |modeline| or in the |sandbox|, for
  6777. security reasons.
  6778. *'spelllang'* *'spl'*
  6779. 'spelllang' 'spl' string (default "en")
  6780. local to buffer
  6781. {not available when compiled without the |+syntax|
  6782. feature}
  6783. A comma-separated list of word list names. When the 'spell' option is
  6784. on spellchecking will be done for these languages. Example: >
  6785. set spelllang=en_us,nl,medical
  6786. < This means US English, Dutch and medical words are recognized. Words
  6787. that are not recognized will be highlighted.
  6788. The word list name must consist of alphanumeric characters, a dash or
  6789. an underscore. It should not include a comma or dot. Using a dash is
  6790. recommended to separate the two letter language name from a
  6791. specification. Thus "en-rare" is used for rare English words.
  6792. A region name must come last and have the form "_xx", where "xx" is
  6793. the two-letter, lower case region name. You can use more than one
  6794. region by listing them: "en_us,en_ca" supports both US and Canadian
  6795. English, but not words specific for Australia, New Zealand or Great
  6796. Britain. (Note: currently en_au and en_nz dictionaries are older than
  6797. en_ca, en_gb and en_us).
  6798. If the name "cjk" is included East Asian characters are excluded from
  6799. spell checking. This is useful when editing text that also has Asian
  6800. words.
  6801. Note that the "medical" dictionary does not exist, it is just an
  6802. example of a longer name.
  6803. *E757*
  6804. As a special case the name of a .spl file can be given as-is. The
  6805. first "_xx" in the name is removed and used as the region name
  6806. (_xx is an underscore, two letters and followed by a non-letter).
  6807. This is mainly for testing purposes. You must make sure the correct
  6808. encoding is used, Vim doesn't check it.
  6809. When 'encoding' is set the word lists are reloaded. Thus it's a good
  6810. idea to set 'spelllang' after setting 'encoding' to avoid loading the
  6811. files twice.
  6812. How the related spell files are found is explained here: |spell-load|.
  6813. If the |spellfile.vim| plugin is active and you use a language name
  6814. for which Vim cannot find the .spl file in 'runtimepath' the plugin
  6815. will ask you if you want to download the file.
  6816. After this option has been set successfully, Vim will source the files
  6817. "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
  6818. up to the first character that is not an ASCII letter or number and
  6819. not a dash. Also see |set-spc-auto|.
  6820. *'spelloptions'* *'spo'*
  6821. 'spelloptions' 'spo' string (default "")
  6822. local to buffer
  6823. {not available when compiled without the |+syntax|
  6824. feature}
  6825. A comma-separated list of options for spell checking:
  6826. camel When a word is CamelCased, assume "Cased" is a
  6827. separate word: every upper-case character in a word
  6828. that comes after a lower case character indicates the
  6829. start of a new word.
  6830. *'spellsuggest'* *'sps'*
  6831. 'spellsuggest' 'sps' string (default "best")
  6832. global
  6833. {not available when compiled without the |+syntax|
  6834. feature}
  6835. Methods used for spelling suggestions. Both for the |z=| command and
  6836. the |spellsuggest()| function. This is a comma-separated list of
  6837. items:
  6838. best Internal method that works best for English. Finds
  6839. changes like "fast" and uses a bit of sound-a-like
  6840. scoring to improve the ordering.
  6841. double Internal method that uses two methods and mixes the
  6842. results. The first method is "fast", the other method
  6843. computes how much the suggestion sounds like the bad
  6844. word. That only works when the language specifies
  6845. sound folding. Can be slow and doesn't always give
  6846. better results.
  6847. fast Internal method that only checks for simple changes:
  6848. character inserts/deletes/swaps. Works well for
  6849. simple typing mistakes.
  6850. {number} The maximum number of suggestions listed for |z=|.
  6851. Not used for |spellsuggest()|. The number of
  6852. suggestions is never more than the value of 'lines'
  6853. minus two.
  6854. timeout:{millisec} Limit the time searching for suggestions to
  6855. {millisec} milli seconds. Applies to the following
  6856. methods. When omitted the limit is 5000. When
  6857. negative there is no limit. {only works when built
  6858. with the |+reltime| feature}
  6859. file:{filename} Read file {filename}, which must have two columns,
  6860. separated by a slash. The first column contains the
  6861. bad word, the second column the suggested good word.
  6862. Example:
  6863. theribal/terrible ~
  6864. Use this for common mistakes that do not appear at the
  6865. top of the suggestion list with the internal methods.
  6866. Lines without a slash are ignored, use this for
  6867. comments.
  6868. The word in the second column must be correct,
  6869. otherwise it will not be used. Add the word to an
  6870. ".add" file if it is currently flagged as a spelling
  6871. mistake.
  6872. The file is used for all languages.
  6873. expr:{expr} Evaluate expression {expr}. Use a function to avoid
  6874. trouble with spaces. Best is to call a function
  6875. without arguments, see |expr-option-function|.
  6876. |v:val| holds the badly spelled word. The expression
  6877. must evaluate to a List of Lists, each with a
  6878. suggestion and a score.
  6879. Example:
  6880. [['the', 33], ['that', 44]] ~
  6881. Set 'verbose' and use |z=| to see the scores that the
  6882. internal methods use. A lower score is better.
  6883. This may invoke |spellsuggest()| if you temporarily
  6884. set 'spellsuggest' to exclude the "expr:" part.
  6885. Errors are silently ignored, unless you set the
  6886. 'verbose' option to a non-zero value.
  6887. Only one of "best", "double" or "fast" may be used. The others may
  6888. appear several times in any order. Example: >
  6889. :set sps=file:~/.vim/sugg,best,expr:MySuggest()
  6890. <
  6891. This option cannot be set from a |modeline| or in the |sandbox|, for
  6892. security reasons.
  6893. *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
  6894. 'splitbelow' 'sb' boolean (default off)
  6895. global
  6896. When on, splitting a window will put the new window below the current
  6897. one. |:split|
  6898. *'splitkeep'* *'spk'*
  6899. 'splitkeep' 'spk' string (default "cursor")
  6900. global
  6901. The value of this option determines the scroll behavior when opening,
  6902. closing or resizing horizontal splits.
  6903. Possible values are:
  6904. cursor Keep the same relative cursor position.
  6905. screen Keep the text on the same screen line.
  6906. topline Keep the topline the same.
  6907. For the "screen" and "topline" values, the cursor position will be
  6908. changed when necessary. In this case, the jumplist will be populated
  6909. with the previous cursor position. For "screen", the text cannot always
  6910. be kept on the same screen line when 'wrap' is enabled.
  6911. *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
  6912. 'splitright' 'spr' boolean (default off)
  6913. global
  6914. When on, splitting a window will put the new window right of the
  6915. current one. |:vsplit|
  6916. *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
  6917. 'startofline' 'sol' boolean (default on)
  6918. global
  6919. When "on" the commands listed below move the cursor to the first
  6920. non-blank of the line. When off the cursor is kept in the same column
  6921. (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
  6922. CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
  6923. with a linewise operator, with "%" with a count and to buffer changing
  6924. commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
  6925. only has a line number, e.g., ":25" or ":+".
  6926. In case of buffer changing commands the cursor is placed at the column
  6927. where it was the last time the buffer was edited.
  6928. NOTE: This option is set when 'compatible' is set.
  6929. *'statusline'* *'stl'* *E540* *E542*
  6930. 'statusline' 'stl' string (default empty)
  6931. global or local to window |global-local|
  6932. {not available when compiled without the |+statusline|
  6933. feature}
  6934. When non-empty, this option determines the content of the status line.
  6935. Also see |status-line|.
  6936. The option consists of printf style '%' items interspersed with
  6937. normal text. Each status line item is of the form:
  6938. %-0{minwid}.{maxwid}{item}
  6939. All fields except the {item} are optional. A single percent sign can
  6940. be given as "%%".
  6941. When the option starts with "%!" then it is used as an expression,
  6942. evaluated and the result is used as the option value. Example: >
  6943. :set statusline=%!MyStatusLine()
  6944. < The *g:statusline_winid* variable will be set to the |window-ID| of the
  6945. window that the status line belongs to.
  6946. The result can contain %{} items that will be evaluated too.
  6947. Note that the "%!" expression is evaluated in the context of the
  6948. current window and buffer, while %{} items are evaluated in the
  6949. context of the window that the statusline belongs to.
  6950. When there is error while evaluating the option then it will be made
  6951. empty to avoid further errors. Otherwise screen updating would loop.
  6952. Note that the only effect of 'ruler' when this option is set (and
  6953. 'laststatus' is 2) is controlling the output of |CTRL-G|.
  6954. field meaning ~
  6955. - Left justify the item. The default is right justified
  6956. when minwid is larger than the length of the item.
  6957. 0 Leading zeroes in numeric items. Overridden by '-'.
  6958. minwid Minimum width of the item, padding as set by '-' & '0'.
  6959. Value must be 50 or less.
  6960. maxwid Maximum width of the item. Truncation occurs with a '<'
  6961. on the left for text items. Numeric items will be
  6962. shifted down to maxwid-2 digits followed by '>'number
  6963. where number is the amount of missing digits, much like
  6964. an exponential notation.
  6965. item A one letter code as described below.
  6966. Following is a description of the possible statusline items. The
  6967. second character in "item" is the type:
  6968. N for number
  6969. S for string
  6970. F for flags as described below
  6971. - not applicable
  6972. item meaning ~
  6973. f S Path to the file in the buffer, as typed or relative to current
  6974. directory.
  6975. F S Full path to the file in the buffer.
  6976. t S File name (tail) of file in the buffer.
  6977. m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
  6978. M F Modified flag, text is ",+" or ",-".
  6979. r F Readonly flag, text is "[RO]".
  6980. R F Readonly flag, text is ",RO".
  6981. h F Help buffer flag, text is "[help]".
  6982. H F Help buffer flag, text is ",HLP".
  6983. w F Preview window flag, text is "[Preview]".
  6984. W F Preview window flag, text is ",PRV".
  6985. y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
  6986. Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
  6987. q S "[Quickfix List]", "[Location List]" or empty.
  6988. k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
  6989. being used: "<keymap>"
  6990. n N Buffer number.
  6991. b N Value of character under cursor.
  6992. B N As above, in hexadecimal.
  6993. o N Byte number in file of byte under cursor, first byte is 1.
  6994. Mnemonic: Offset from start of file (with one added)
  6995. {not available when compiled without |+byte_offset| feature}
  6996. O N As above, in hexadecimal.
  6997. N N Printer page number. (Only works in the 'printheader' option.)
  6998. l N Line number.
  6999. L N Number of lines in buffer.
  7000. c N Column number (byte index).
  7001. v N Virtual column number (screen column).
  7002. V N Virtual column number as -{num}. Not displayed if equal to 'c'.
  7003. p N Percentage through file in lines as in |CTRL-G|.
  7004. P S Percentage through file of displayed window. This is like the
  7005. percentage described for 'ruler'. Always 3 in length, unless
  7006. translated.
  7007. S S 'showcmd' content, see 'showcmdloc'.
  7008. a S Argument list status as in default title. ({current} of {max})
  7009. Empty if the argument file count is zero or one.
  7010. { NF Evaluate expression between '%{' and '}' and substitute result.
  7011. Note that there is no '%' before the closing '}'. The
  7012. expression cannot contain a '}' character, call a function to
  7013. work around that. See |stl-%{| below.
  7014. {% - This is almost same as { except the result of the expression is
  7015. re-evaluated as a statusline format string. Thus if the
  7016. return value of expr contains % items they will get expanded.
  7017. The expression can contain the } character, the end of
  7018. expression is denoted by %}.
  7019. For example: >
  7020. func! Stl_filename() abort
  7021. return "%t"
  7022. endfunc
  7023. < `stl=%{Stl_filename()}` results in `"%t"`
  7024. `stl=%{%Stl_filename()%}` results in `"Name of current file"`
  7025. %} - End of `{%` expression
  7026. ( - Start of item group. Can be used for setting the width and
  7027. alignment of a section. Must be followed by %) somewhere.
  7028. ) - End of item group. No width fields allowed.
  7029. T N For 'tabline': start of tab page N label. Use %T after the last
  7030. label. This information is used for mouse clicks.
  7031. X N For 'tabline': start of close tab N label. Use %X after the
  7032. label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
  7033. mark. This information is used for mouse clicks.
  7034. < - Where to truncate line if too long. Default is at the start.
  7035. No width fields allowed.
  7036. = - Separation point between left and right aligned items.
  7037. No width fields allowed.
  7038. # - Set highlight group. The name must follow and then a # again.
  7039. Thus use %#HLname# for highlight group HLname. The same
  7040. highlighting is used, also for the statusline of non-current
  7041. windows.
  7042. * - Set highlight group to User{N}, where {N} is taken from the
  7043. minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
  7044. The difference between User{N} and StatusLine will be applied
  7045. to StatusLineNC for the statusline of non-current windows.
  7046. The number N must be between 1 and 9. See |hl-User1..9|
  7047. When displaying a flag, Vim removes the leading comma, if any, when
  7048. that flag comes right after plaintext. This will make a nice display
  7049. when flags are used like in the examples below.
  7050. When all items in a group becomes an empty string (i.e. flags that are
  7051. not set) and a minwid is not set for the group, the whole group will
  7052. become empty. This will make a group like the following disappear
  7053. completely from the statusline when none of the flags are set. >
  7054. :set statusline=...%(\ [%M%R%H]%)...
  7055. < Beware that an expression is evaluated each and every time the status
  7056. line is displayed.
  7057. *stl-%{* *g:actual_curbuf* *g:actual_curwin*
  7058. While evaluating %{} the current buffer and current window will be set
  7059. temporarily to that of the window (and buffer) whose statusline is
  7060. currently being drawn. The expression will evaluate in this context.
  7061. The variable "g:actual_curbuf" is set to the `bufnr()` number of the
  7062. real current buffer and "g:actual_curwin" to the |window-ID| of the
  7063. real current window. These values are strings.
  7064. The 'statusline' option will be evaluated in the |sandbox| if set from
  7065. a modeline, see |sandbox-option|.
  7066. This option cannot be set in a modeline when 'modelineexpr' is off.
  7067. It is not allowed to change text or jump to another window while
  7068. evaluating 'statusline' |textlock|.
  7069. If the statusline is not updated when you want it (e.g., after setting
  7070. a variable that's used in an expression), you can force an update by
  7071. using `:redrawstatus`.
  7072. A result of all digits is regarded a number for display purposes.
  7073. Otherwise the result is taken as flag text and applied to the rules
  7074. described above.
  7075. Watch out for errors in expressions. They may render Vim unusable!
  7076. If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
  7077. edit your .vimrc or whatever with "vim --clean" to get it right.
  7078. Examples:
  7079. Emulate standard status line with 'ruler' set >
  7080. :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
  7081. < Similar, but add ASCII value of char under the cursor (like "ga") >
  7082. :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
  7083. < Display byte count and byte value, modified flag in red. >
  7084. :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
  7085. :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
  7086. < Display a ,GZ flag if a compressed file is loaded >
  7087. :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
  7088. < In the |:autocmd|'s: >
  7089. :let b:gzflag = 1
  7090. < And: >
  7091. :unlet b:gzflag
  7092. < And define this function: >
  7093. :function VarExists(var, val)
  7094. : if exists(a:var) | return a:val | else | return '' | endif
  7095. :endfunction
  7096. <
  7097. *'suffixes'* *'su'*
  7098. 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
  7099. global
  7100. Files with these suffixes get a lower priority when multiple files
  7101. match a wildcard. See |suffixes|. Commas can be used to separate the
  7102. suffixes. Spaces after the comma are ignored. A dot is also seen as
  7103. the start of a suffix. To avoid a dot or comma being recognized as a
  7104. separator, precede it with a backslash (see |option-backslash| about
  7105. including spaces and backslashes).
  7106. See 'wildignore' for completely ignoring files.
  7107. The use of |:set+=| and |:set-=| is preferred when adding or removing
  7108. suffixes from the list. This avoids problems when a future version
  7109. uses another default.
  7110. *'suffixesadd'* *'sua'*
  7111. 'suffixesadd' 'sua' string (default "")
  7112. local to buffer
  7113. Comma-separated list of suffixes, which are used when searching for a
  7114. file for the "gf", "[I", etc. commands. Example: >
  7115. :set suffixesadd=.java
  7116. <
  7117. *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
  7118. 'swapfile' 'swf' boolean (default on)
  7119. local to buffer
  7120. Use a swapfile for the buffer. This option can be reset when a
  7121. swapfile is not wanted for a specific buffer. For example, with
  7122. confidential information that even root must not be able to access.
  7123. Careful: All text will be in memory:
  7124. - Don't use this for big files.
  7125. - Recovery will be impossible!
  7126. A swapfile will only be present when |'updatecount'| is non-zero and
  7127. 'swapfile' is set.
  7128. When 'swapfile' is reset, the swap file for the current buffer is
  7129. immediately deleted. When 'swapfile' is set, and 'updatecount' is
  7130. non-zero, a swap file is immediately created.
  7131. Also see |swap-file| and |'swapsync'|.
  7132. If you want to open a new buffer without creating a swap file for it,
  7133. use the |:noswapfile| modifier.
  7134. See 'directory' for where the swap file is created.
  7135. This option is used together with 'bufhidden' and 'buftype' to
  7136. specify special kinds of buffers. See |special-buffers|.
  7137. *'swapsync'* *'sws'*
  7138. 'swapsync' 'sws' string (default "fsync")
  7139. global
  7140. When this option is not empty a swap file is synced to disk after
  7141. writing to it. This takes some time, especially on busy unix systems.
  7142. When this option is empty parts of the swap file may be in memory and
  7143. not written to disk. When the system crashes you may lose more work.
  7144. On Unix the system does a sync now and then without Vim asking for it,
  7145. so the disadvantage of setting this option off is small. On some
  7146. systems the swap file will not be written at all. For a unix system
  7147. setting it to "sync" will use the sync() call instead of the default
  7148. fsync(), which may work better on some systems.
  7149. The 'fsync' option is used for the actual file.
  7150. *'switchbuf'* *'swb'*
  7151. 'switchbuf' 'swb' string (default "")
  7152. global
  7153. This option controls the behavior when switching between buffers.
  7154. Mostly for |quickfix| commands some values are also used for other
  7155. commands, as mentioned below.
  7156. Possible values (comma-separated list):
  7157. useopen If included, jump to the first open window that
  7158. contains the specified buffer (if there is one).
  7159. Otherwise: Do not examine other windows.
  7160. This setting is checked with |quickfix| commands, when
  7161. jumping to errors (":cc", ":cn", "cp", etc.). It is
  7162. also used in all buffer related split commands, for
  7163. example ":sbuffer", ":sbnext", or ":sbrewind".
  7164. usetab Like "useopen", but also consider windows in other tab
  7165. pages.
  7166. split If included, split the current window before loading
  7167. a buffer for a |quickfix| command that display errors.
  7168. Otherwise: do not split, use current window (when used
  7169. in the quickfix window: the previously used window or
  7170. split if there is no other window).
  7171. vsplit Just like "split" but split vertically.
  7172. newtab Like "split", but open a new tab page. Overrules
  7173. "split" when both are present.
  7174. uselast If included, jump to the previously used window when
  7175. jumping to errors with |quickfix| commands.
  7176. *'synmaxcol'* *'smc'*
  7177. 'synmaxcol' 'smc' number (default 3000)
  7178. local to buffer
  7179. {not available when compiled without the |+syntax|
  7180. feature}
  7181. Maximum column in which to search for syntax items. In long lines the
  7182. text after this column is not highlighted and following lines may not
  7183. be highlighted correctly, because the syntax state is cleared.
  7184. This helps to avoid very slow redrawing for an XML file that is one
  7185. long line.
  7186. Set to zero to remove the limit.
  7187. *'syntax'* *'syn'*
  7188. 'syntax' 'syn' string (default empty)
  7189. local to buffer
  7190. {not available when compiled without the |+syntax|
  7191. feature}
  7192. When this option is set, the syntax with this name is loaded, unless
  7193. syntax highlighting has been switched off with ":syntax off".
  7194. Otherwise this option does not always reflect the current syntax (the
  7195. b:current_syntax variable does).
  7196. This option is most useful in a modeline, for a file which syntax is
  7197. not automatically recognized. Example, in an IDL file:
  7198. /* vim: set syntax=idl : */ ~
  7199. When a dot appears in the value then this separates two filetype
  7200. names. Example:
  7201. /* vim: set syntax=c.doxygen : */ ~
  7202. This will use the "c" syntax first, then the "doxygen" syntax.
  7203. Note that the second one must be prepared to be loaded as an addition,
  7204. otherwise it will be skipped. More than one dot may appear.
  7205. To switch off syntax highlighting for the current file, use: >
  7206. :set syntax=OFF
  7207. < To switch syntax highlighting on according to the current value of the
  7208. 'filetype' option: >
  7209. :set syntax=ON
  7210. < What actually happens when setting the 'syntax' option is that the
  7211. Syntax autocommand event is triggered with the value as argument.
  7212. This option is not copied to another buffer, independent of the 's' or
  7213. 'S' flag in 'cpoptions'.
  7214. Only normal file name characters can be used, "/\*?[|<>" are illegal.
  7215. *'tabline'* *'tal'*
  7216. 'tabline' 'tal' string (default empty)
  7217. global
  7218. When non-empty, this option determines the content of the tab pages
  7219. line at the top of the Vim window. When empty Vim will use a default
  7220. tab pages line. See |setting-tabline| for more info.
  7221. The tab pages line only appears as specified with the 'showtabline'
  7222. option and only when there is no GUI tab line. When 'e' is in
  7223. 'guioptions' and the GUI supports a tab line 'guitablabel' is used
  7224. instead. Note that the two tab pages lines are very different.
  7225. The value is evaluated like with 'statusline'. You can use
  7226. |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
  7227. the text to be displayed. Use "%1T" for the first label, "%2T" for
  7228. the second one, etc. Use "%X" items for closing labels.
  7229. When changing something that is used in 'tabline' that does not
  7230. trigger it to be updated, use |:redrawtabline|.
  7231. This option cannot be set in a modeline when 'modelineexpr' is off.
  7232. Keep in mind that only one of the tab pages is the current one, others
  7233. are invisible and you can't jump to their windows.
  7234. *'tabpagemax'* *'tpm'*
  7235. 'tabpagemax' 'tpm' number (default 10)
  7236. global
  7237. Maximum number of tab pages to be opened by the |-p| command line
  7238. argument or the ":tab all" command. |tabpage|
  7239. *'tabstop'* *'ts'*
  7240. 'tabstop' 'ts' number (default 8)
  7241. local to buffer
  7242. Number of spaces that a <Tab> in the file counts for. Also see
  7243. the |:retab| command, and the 'softtabstop' option.
  7244. Note: Setting 'tabstop' to any other value than 8 can make your file
  7245. appear wrong in many places, e.g., when printing it.
  7246. The value must be more than 0 and less than 10000.
  7247. There are four main ways to use tabs in Vim:
  7248. 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
  7249. (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
  7250. will use a mix of tabs and spaces, but typing <Tab> and <BS> will
  7251. behave like a tab appears every 4 (or 3) characters.
  7252. 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
  7253. 'expandtab'. This way you will always insert spaces. The
  7254. formatting will never be messed up when 'tabstop' is changed.
  7255. 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
  7256. |modeline| to set these values when editing the file again. Only
  7257. works when using Vim to edit the file.
  7258. 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
  7259. 'noexpandtab'. This should then work (for initial indents only)
  7260. for any tabstop setting that people use. It might be nice to have
  7261. tabs after the first non-blank inserted as spaces if you do this
  7262. though. Otherwise aligned comments will be wrong when 'tabstop' is
  7263. changed.
  7264. If Vim is compiled with the |+vartabs| feature then the value of
  7265. 'tabstop' will be ignored if |'vartabstop'| is set to anything other
  7266. than an empty string.
  7267. *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
  7268. 'tagbsearch' 'tbs' boolean (default on)
  7269. global
  7270. When searching for a tag (e.g., for the |:ta| command), Vim can either
  7271. use a binary search or a linear search in a tags file. Binary
  7272. searching makes searching for a tag a LOT faster, but a linear search
  7273. will find more tags if the tags file wasn't properly sorted.
  7274. Vim normally assumes that your tags files are sorted, or indicate that
  7275. they are not sorted. Only when this is not the case does the
  7276. 'tagbsearch' option need to be switched off.
  7277. When 'tagbsearch' is on, binary searching is first used in the tags
  7278. files. In certain situations, Vim will do a linear search instead for
  7279. certain files, or retry all files with a linear search. When
  7280. 'tagbsearch' is off, only a linear search is done.
  7281. Linear searching is done anyway, for one file, when Vim finds a line
  7282. at the start of the file indicating that it's not sorted: >
  7283. !_TAG_FILE_SORTED 0 /some comment/
  7284. < [The whitespace before and after the '0' must be a single <Tab>]
  7285. When a binary search was done and no match was found in any of the
  7286. files listed in 'tags', and case is ignored or a pattern is used
  7287. instead of a normal tag name, a retry is done with a linear search.
  7288. Tags in unsorted tags files, and matches with different case will only
  7289. be found in the retry.
  7290. If a tag file indicates that it is case-fold sorted, the second,
  7291. linear search can be avoided when case is ignored. Use a value of '2'
  7292. in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
  7293. sorted with the -f switch to "sort" in most unices, as in the command:
  7294. "sort -f -o tags tags". For Universal ctags and Exuberant ctags
  7295. version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
  7296. used for this as well. Note that case must be folded to uppercase for
  7297. this to work.
  7298. By default, tag searches are case-sensitive. Case is ignored when
  7299. 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
  7300. "ignore".
  7301. Also when 'tagcase' is "followscs" and 'smartcase' is set, or
  7302. 'tagcase' is "smart", and the pattern contains only lowercase
  7303. characters.
  7304. When 'tagbsearch' is off, tags searching is slower when a full match
  7305. exists, but faster when no full match exists. Tags in unsorted tags
  7306. files may only be found with 'tagbsearch' off.
  7307. When the tags file is not sorted, or sorted in a wrong way (not on
  7308. ASCII byte value), 'tagbsearch' should be off, or the line given above
  7309. must be included in the tags file.
  7310. This option doesn't affect commands that find all matching tags (e.g.,
  7311. command-line completion and ":help").
  7312. *'tagcase'* *'tc'*
  7313. 'tagcase' 'tc' string (default "followic")
  7314. global or local to buffer |global-local|
  7315. This option specifies how case is handled when searching the tags
  7316. file:
  7317. followic Follow the 'ignorecase' option
  7318. followscs Follow the 'smartcase' and 'ignorecase' options
  7319. ignore Ignore case
  7320. match Match case
  7321. smart Ignore case unless an upper case letter is used
  7322. NOTE: This option is set to the Vi default value when 'compatible' is
  7323. set and to the Vim default value when 'compatible' is reset.
  7324. *'tagfunc'* *'tfu'*
  7325. 'tagfunc' 'tfu' string (default: empty)
  7326. local to buffer
  7327. {not available when compiled without the |+eval|
  7328. feature}
  7329. This option specifies a function to be used to perform tag searches.
  7330. The function gets the tag pattern and should return a List of matching
  7331. tags. See |tag-function| for an explanation of how to write the
  7332. function and an example. The value can be the name of a function, a
  7333. |lambda| or a |Funcref|. See |option-value-function| for more
  7334. information.
  7335. *'taglength'* *'tl'*
  7336. 'taglength' 'tl' number (default 0)
  7337. global
  7338. If non-zero, tags are significant up to this number of characters.
  7339. *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
  7340. 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
  7341. global
  7342. If on and using a tags file in another directory, file names in that
  7343. tags file are relative to the directory where the tags file is.
  7344. NOTE: This option is set to the Vi default value when 'compatible' is
  7345. set and to the Vim default value when 'compatible' is reset.
  7346. *'tags'* *'tag'* *E433*
  7347. 'tags' 'tag' string (default "./tags,tags", when compiled with
  7348. |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
  7349. global or local to buffer |global-local|
  7350. Filenames for the tag command, separated by spaces or commas. To
  7351. include a space or comma in a file name, precede it with a backslash
  7352. (see |option-backslash| about including spaces and backslashes).
  7353. When a file name starts with "./", the '.' is replaced with the path
  7354. of the current file. But only when the 'd' flag is not included in
  7355. 'cpoptions'. Environment variables are expanded |:set_env|. Also see
  7356. |tags-option|.
  7357. "*", "**" and other wildcards can be used to search for tags files in
  7358. a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
  7359. find all files named "tags" below "/lib". The filename itself cannot
  7360. contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
  7361. files called "tags?".
  7362. The |tagfiles()| function can be used to get a list of the file names
  7363. actually used.
  7364. If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
  7365. files are also supported. They are automatically recognized. The
  7366. default value becomes "./tags,./TAGS,tags,TAGS", unless case
  7367. differences are ignored (MS-Windows). |emacs-tags|
  7368. The use of |:set+=| and |:set-=| is preferred when adding or removing
  7369. file names from the list. This avoids problems when a future version
  7370. uses another default.
  7371. *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
  7372. 'tagstack' 'tgst' boolean (default on)
  7373. global
  7374. When on, the |tagstack| is used normally. When off, a ":tag" or
  7375. ":tselect" command with an argument will not push the tag onto the
  7376. tagstack. A following ":tag" without an argument, a ":pop" command or
  7377. any other command that uses the tagstack will use the unmodified
  7378. tagstack, but does change the pointer to the active entry.
  7379. Resetting this option is useful when using a ":tag" command in a
  7380. mapping which should not change the tagstack.
  7381. *'tcldll'*
  7382. 'tcldll' string (default depends on the build)
  7383. global
  7384. {only available when compiled with the |+tcl/dyn|
  7385. feature}
  7386. Specifies the name of the Tcl shared library. The default is
  7387. DYNAMIC_TCL_DLL, which was specified at compile time.
  7388. Environment variables are expanded |:set_env|.
  7389. This option cannot be set from a |modeline| or in the |sandbox|, for
  7390. security reasons.
  7391. *'term'* *E529* *E530* *E531*
  7392. 'term' string (default is $TERM, if that fails:
  7393. in the GUI: "builtin_gui"
  7394. on Amiga: "amiga"
  7395. on Haiku: "xterm"
  7396. on Mac: "mac-ansi"
  7397. on Unix: "ansi"
  7398. on VMS: "ansi"
  7399. on Win 32: "win32")
  7400. global
  7401. Name of the terminal. Used for choosing the terminal control
  7402. characters. Environment variables are expanded |:set_env|.
  7403. For example: >
  7404. :set term=$TERM
  7405. < See |termcap|.
  7406. *'termbidi'* *'tbidi'*
  7407. *'notermbidi'* *'notbidi'*
  7408. 'termbidi' 'tbidi' boolean (default off, on for "mlterm")
  7409. global
  7410. {only available when compiled with the |+arabic|
  7411. feature}
  7412. The terminal is in charge of Bi-directionality of text (as specified
  7413. by Unicode). The terminal is also expected to do the required shaping
  7414. that some languages (such as Arabic) require.
  7415. Setting this option implies that 'rightleft' will not be set when
  7416. 'arabic' is set and the value of 'arabicshape' will be ignored.
  7417. Note that setting 'termbidi' has the immediate effect that
  7418. 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
  7419. This option is reset when the GUI is started.
  7420. For further details see |arabic.txt|.
  7421. *'termencoding'* *'tenc'*
  7422. 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
  7423. global
  7424. Encoding used for the terminal. This specifies what character
  7425. encoding the keyboard produces and the display will understand. For
  7426. the GUI it only applies to the keyboard ('encoding' is used for the
  7427. display).
  7428. *E617* *E950*
  7429. Note: This does not apply to the GTK+ GUI. After the GUI has been
  7430. successfully initialized, 'termencoding' is forcibly set to "utf-8".
  7431. Any attempts to set a different value will be rejected, and an error
  7432. message is shown.
  7433. For the Win32 GUI and console versions 'termencoding' is not used,
  7434. because the Win32 system always passes Unicode characters.
  7435. When empty, the same encoding is used as for the 'encoding' option.
  7436. This is the normal value.
  7437. Not all combinations for 'termencoding' and 'encoding' are valid. See
  7438. |encoding-table|.
  7439. The value for this option must be supported by internal conversions or
  7440. iconv(). When this is not possible no conversion will be done and you
  7441. will probably experience problems with non-ASCII characters.
  7442. Example: You are working with the locale set to euc-jp (Japanese) and
  7443. want to edit a UTF-8 file: >
  7444. :let &termencoding = &encoding
  7445. :set encoding=utf-8
  7446. < You need to do this when your system has no locale support for UTF-8.
  7447. *'termguicolors'* *'tgc'* *E954*
  7448. 'termguicolors' 'tgc' boolean (default off)
  7449. global
  7450. {not available when compiled without the
  7451. |+termguicolors| feature}
  7452. When on, uses |highlight-guifg| and |highlight-guibg| attributes in
  7453. the terminal (thus using 24-bit color).
  7454. Requires a ISO-8613-3 compatible terminal. If setting this option
  7455. does not work (produces a colorless UI) reading |xterm-true-color|
  7456. might help.
  7457. For Win32 console, Windows 10 version 1703 (Creators Update) or later
  7458. is required. Use this check to find out: >
  7459. if has('vcon')
  7460. < This requires Vim to be built with the |+vtp| feature.
  7461. Note that the "cterm" attributes are still used, not the "gui" ones.
  7462. When using Vim with Windows Terminal, the background of Windows
  7463. Terminal is normally filled with the Vim background color. Setting
  7464. 'termguicolors' and the guibg of the Normal highlight group to NONE
  7465. will make the background transparent: >
  7466. :hi Normal guibg=NONE
  7467. <
  7468. NOTE: This option is reset when 'compatible' is set.
  7469. *'termwinkey'* *'twk'*
  7470. 'termwinkey' 'twk' string (default "")
  7471. local to window
  7472. The key that starts a CTRL-W command in a terminal window. Other keys
  7473. are sent to the job running in the window.
  7474. The <> notation can be used, e.g.: >
  7475. :set termwinkey=<C-L>
  7476. < The string must be one key stroke but can be multiple bytes.
  7477. When not set CTRL-W is used, so that CTRL-W : gets you to the command
  7478. line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
  7479. command line.
  7480. *'termwinscroll'* *'twsl'*
  7481. 'termwinscroll' 'twsl' number (default 10000)
  7482. local to buffer
  7483. {not available when compiled without the
  7484. |+terminal| feature}
  7485. Number of scrollback lines to keep. When going over this limit the
  7486. first 10% of the scrollback lines are deleted. This is just to reduce
  7487. the memory usage. See |Terminal-Normal|.
  7488. Also used as a limit for text sent to the terminal in one write,
  7489. multiplied by the number of columns times 3 (average number of bytes
  7490. per cell).
  7491. *'termwinsize'* *'tws'*
  7492. 'termwinsize' 'tws' string (default "")
  7493. local to window
  7494. Size used when opening the |terminal| window. Format:
  7495. {rows}x{columns} or {rows}*{columns}.
  7496. - When empty the terminal gets the size from the window.
  7497. - When set with a "x" (e.g., "24x80") the terminal size is not
  7498. adjusted to the window size. If the window is smaller only the
  7499. top-left part is displayed.
  7500. - When set with a "*" (e.g., "10*50") the terminal size follows the
  7501. window size, but will not be smaller than the specified rows and/or
  7502. columns.
  7503. - When rows is zero then use the height of the window.
  7504. - When columns is zero then use the width of the window.
  7505. - Using "0x0" or "0*0" is the same as empty.
  7506. - Can be overruled in the |term_start()| options with "term_rows" and
  7507. "term_cols".
  7508. Examples:
  7509. "30x0" uses 30 rows and the current window width.
  7510. "20*0" uses at least 20 rows and the current window width.
  7511. "0*40" uses the current window height and at least 40 columns.
  7512. Note that the command running in the terminal window may still change
  7513. the size of the terminal. In that case the Vim window will be
  7514. adjusted to that size, if possible.
  7515. *'termwintype'* *'twt'*
  7516. 'termwintype' 'twt' string (default "")
  7517. global
  7518. {only available when compiled with the |terminal|
  7519. feature on MS-Windows}
  7520. Specify the virtual console (pty) used when opening the terminal
  7521. window.
  7522. Possible values are:
  7523. "" use ConPTY if it is stable, winpty otherwise
  7524. "winpty" use winpty, fail if not supported
  7525. "conpty" use |ConPTY|, fail if not supported
  7526. |ConPTY| support depends on the platform. Windows 10 October 2018
  7527. Update is the first version that supports ConPTY, however it is still
  7528. considered unstable. ConPTY might become stable in the next release
  7529. of Windows 10. winpty support needs to be installed. If neither is
  7530. supported then you cannot open a terminal window.
  7531. *'terse'* *'noterse'*
  7532. 'terse' boolean (default off)
  7533. global
  7534. When set: Add 's' flag to 'shortmess' option (this makes the message
  7535. for a search that hits the start or end of the file not being
  7536. displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
  7537. shortens a lot of messages}
  7538. *'textauto'* *'ta'* *'notextauto'* *'nota'*
  7539. 'textauto' 'ta' boolean (Vim default: on, Vi default: off)
  7540. global
  7541. This option is obsolete. Use 'fileformats'.
  7542. For backwards compatibility, when 'textauto' is set, 'fileformats' is
  7543. set to the default value for the current system. When 'textauto' is
  7544. reset, 'fileformats' is made empty.
  7545. NOTE: This option is set to the Vi default value when 'compatible' is
  7546. set and to the Vim default value when 'compatible' is reset.
  7547. *'textmode'* *'tx'* *'notextmode'* *'notx'*
  7548. 'textmode' 'tx' boolean (Win32: default on,
  7549. others: default off)
  7550. local to buffer
  7551. This option is obsolete. Use 'fileformat'.
  7552. For backwards compatibility, when 'textmode' is set, 'fileformat' is
  7553. set to "dos". When 'textmode' is reset, 'fileformat' is set to
  7554. "unix".
  7555. *'textwidth'* *'tw'*
  7556. 'textwidth' 'tw' number (default 0)
  7557. local to buffer
  7558. Maximum width of text that is being inserted. A longer line will be
  7559. broken after white space to get this width. A zero value disables
  7560. this.
  7561. 'textwidth' is set to 0 when the 'paste' option is set and restored
  7562. when 'paste' is reset.
  7563. When 'textwidth' is zero, 'wrapmargin' may be used. See also
  7564. 'formatoptions' and |ins-textwidth|.
  7565. When 'formatexpr' is set it will be used to break the line.
  7566. NOTE: This option is set to 0 when 'compatible' is set.
  7567. *'thesaurus'* *'tsr'*
  7568. 'thesaurus' 'tsr' string (default "")
  7569. global or local to buffer |global-local|
  7570. List of file names, separated by commas, that are used to lookup words
  7571. for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
  7572. |compl-thesaurus|.
  7573. This option is not used if 'thesaurusfunc' is set, either for the
  7574. buffer or globally.
  7575. To include a comma in a file name precede it with a backslash. Spaces
  7576. after a comma are ignored, otherwise spaces are included in the file
  7577. name. See |option-backslash| about using backslashes. The use of
  7578. |:set+=| and |:set-=| is preferred when adding or removing directories
  7579. from the list. This avoids problems when a future version uses
  7580. another default. Backticks cannot be used in this option for security
  7581. reasons.
  7582. *'thesaurusfunc'* *'tsrfu'*
  7583. 'thesaurusfunc' 'tsrfu' string (default: empty)
  7584. global or local to buffer |global-local|
  7585. {not available when compiled without the |+eval|
  7586. feature}
  7587. This option specifies a function to be used for thesaurus completion
  7588. with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
  7589. The value can be the name of a function, a |lambda| or a |Funcref|.
  7590. See |option-value-function| for more information.
  7591. This option cannot be set from a |modeline| or in the |sandbox|, for
  7592. security reasons.
  7593. *'tildeop'* *'top'* *'notildeop'* *'notop'*
  7594. 'tildeop' 'top' boolean (default off)
  7595. global
  7596. When on: The tilde command "~" behaves like an operator.
  7597. NOTE: This option is reset when 'compatible' is set.
  7598. *'timeout'* *'to'* *'notimeout'* *'noto'*
  7599. 'timeout' 'to' boolean (default on)
  7600. global
  7601. *'ttimeout'* *'nottimeout'*
  7602. 'ttimeout' boolean (default off, set in |defaults.vim|)
  7603. global
  7604. These two options together determine the behavior when part of a
  7605. mapped key sequence or keyboard code has been received:
  7606. 'timeout' 'ttimeout' action ~
  7607. off off do not time out
  7608. on on or off time out on :mappings and key codes
  7609. off on time out on key codes
  7610. If both options are off, Vim will wait until either the complete
  7611. mapping or key sequence has been received, or it is clear that there
  7612. is no mapping or key sequence for the received characters. For
  7613. example: if you have mapped "vl" and Vim has received 'v', the next
  7614. character is needed to see if the 'v' is followed by an 'l'.
  7615. When one of the options is on, Vim will wait for about 1 second for
  7616. the next character to arrive. After that the already received
  7617. characters are interpreted as single characters. The waiting time can
  7618. be changed with the 'timeoutlen' option.
  7619. On slow terminals or very busy systems timing out may cause
  7620. malfunctioning cursor keys. If both options are off, Vim waits
  7621. forever after an entered <Esc> if there are key codes that start
  7622. with <Esc>. You will have to type <Esc> twice. If you do not have
  7623. problems with key codes, but would like to have :mapped key
  7624. sequences not timing out in 1 second, set the 'ttimeout' option and
  7625. reset the 'timeout' option.
  7626. NOTE: 'ttimeout' is reset when 'compatible' is set.
  7627. *'timeoutlen'* *'tm'*
  7628. 'timeoutlen' 'tm' number (default 1000)
  7629. global
  7630. *'ttimeoutlen'* *'ttm'*
  7631. 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
  7632. global
  7633. The time in milliseconds that is waited for a key code or mapped key
  7634. sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
  7635. when part of a command has been typed.
  7636. Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
  7637. different timeout value for key codes is desired set 'ttimeoutlen' to
  7638. a non-negative number.
  7639. ttimeoutlen mapping delay key code delay ~
  7640. < 0 'timeoutlen' 'timeoutlen'
  7641. >= 0 'timeoutlen' 'ttimeoutlen'
  7642. The timeout only happens when the 'timeout' and 'ttimeout' options
  7643. tell so. A useful setting would be >
  7644. :set timeout timeoutlen=3000 ttimeoutlen=100
  7645. < (time out on mapping after three seconds, time out on key codes after
  7646. a tenth of a second).
  7647. *'title'* *'notitle'*
  7648. 'title' boolean (default off, on when title can be restored)
  7649. global
  7650. When on, the title of the window will be set to the value of
  7651. 'titlestring' (if it is not empty), or to:
  7652. filename [+=-] (path) - VIM
  7653. Where:
  7654. filename the name of the file being edited
  7655. - indicates the file cannot be modified, 'ma' off
  7656. + indicates the file was modified
  7657. = indicates the file is read-only
  7658. =+ indicates the file is read-only and modified
  7659. (path) is the path of the file being edited
  7660. - VIM the server name |v:servername| or "VIM"
  7661. Only works if the terminal supports setting window titles
  7662. (currently Amiga console, Win32 console, all GUI versions and
  7663. terminals with a non-empty 't_ts' option - these are Unix xterm and
  7664. iris-ansi by default, where 't_ts' is taken from the builtin termcap).
  7665. *X11*
  7666. When Vim was compiled with HAVE_X11 defined, the original title will
  7667. be restored if possible. The output of ":version" will include "+X11"
  7668. when HAVE_X11 was defined, otherwise it will be "-X11". This also
  7669. works for the icon name |'icon'|.
  7670. But: When Vim was started with the |-X| argument, restoring the title
  7671. will not work (except in the GUI).
  7672. If the title cannot be restored, it is set to the value of 'titleold'.
  7673. You might want to restore the title outside of Vim then.
  7674. When using an xterm from a remote machine you can use this command:
  7675. rsh machine_name xterm -display $DISPLAY &
  7676. then the WINDOWID environment variable should be inherited and the
  7677. title of the window should change back to what it should be after
  7678. exiting Vim.
  7679. *'titlelen'*
  7680. 'titlelen' number (default 85)
  7681. global
  7682. Gives the percentage of 'columns' to use for the length of the window
  7683. title. When the title is longer, only the end of the path name is
  7684. shown. A '<' character before the path name is used to indicate this.
  7685. Using a percentage makes this adapt to the width of the window. But
  7686. it won't work perfectly, because the actual number of characters
  7687. available also depends on the font used and other things in the title
  7688. bar. When 'titlelen' is zero the full path is used. Otherwise,
  7689. values from 1 to 30000 percent can be used.
  7690. 'titlelen' is also used for the 'titlestring' option.
  7691. *'titleold'*
  7692. 'titleold' string (default "Thanks for flying Vim")
  7693. global
  7694. This option will be used for the window title when exiting Vim if the
  7695. original title cannot be restored. Only happens if 'title' is on or
  7696. 'titlestring' is not empty.
  7697. This option cannot be set from a |modeline| or in the |sandbox|, for
  7698. security reasons.
  7699. *'titlestring'*
  7700. 'titlestring' string (default "")
  7701. global
  7702. When this option is not empty, it will be used for the title of the
  7703. window. This happens only when the 'title' option is on.
  7704. Only works if the terminal supports setting window titles (currently
  7705. Amiga console, Win32 console, all GUI versions and terminals with a
  7706. non-empty 't_ts' option).
  7707. When Vim was compiled with HAVE_X11 defined, the original title will
  7708. be restored if possible, see |X11|.
  7709. When this option contains printf-style '%' items, they will be
  7710. expanded according to the rules used for 'statusline'.
  7711. This option cannot be set in a modeline when 'modelineexpr' is off.
  7712. Example: >
  7713. :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
  7714. :set title titlestring=%<%F%=%l/%L-%P titlelen=70
  7715. < The value of 'titlelen' is used to align items in the middle or right
  7716. of the available space.
  7717. Some people prefer to have the file name first: >
  7718. :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
  7719. < Note the use of "%{ }" and an expression to get the path of the file,
  7720. without the file name. The "%( %)" constructs are used to add a
  7721. separating space only when needed.
  7722. NOTE: Use of special characters in 'titlestring' may cause the display
  7723. to be garbled (e.g., when it contains a CR or NL character).
  7724. {not available when compiled without the |+statusline| feature}
  7725. *'toolbar'* *'tb'*
  7726. 'toolbar' 'tb' string (default "icons,tooltips")
  7727. global
  7728. {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
  7729. The contents of this option controls various toolbar settings. The
  7730. possible values are:
  7731. icons Toolbar buttons are shown with icons.
  7732. text Toolbar buttons shown with text.
  7733. horiz Icon and text of a toolbar button are
  7734. horizontally arranged. {only in GTK+ 2 GUI}
  7735. tooltips Tooltips are active for toolbar buttons.
  7736. Tooltips refer to the popup help text which appears after the mouse
  7737. cursor is placed over a toolbar button for a brief moment.
  7738. If you want the toolbar to be shown with icons as well as text, do the
  7739. following: >
  7740. :set tb=icons,text
  7741. < Motif cannot display icons and text at the same time. They
  7742. will show icons if both are requested.
  7743. If none of the strings specified in 'toolbar' are valid or if
  7744. 'toolbar' is empty, this option is ignored. If you want to disable
  7745. the toolbar, you need to set the 'guioptions' option. For example: >
  7746. :set guioptions-=T
  7747. < Also see |gui-toolbar|.
  7748. *'toolbariconsize'* *'tbis'*
  7749. 'toolbariconsize' 'tbis' string (default "small")
  7750. global
  7751. {only in the GTK+ GUI}
  7752. Controls the size of toolbar icons. The possible values are:
  7753. tiny Use tiny icons.
  7754. small Use small icons (default).
  7755. medium Use medium-sized icons.
  7756. large Use large icons.
  7757. huge Use even larger icons.
  7758. giant Use very big icons.
  7759. The exact dimensions in pixels of the various icon sizes depend on
  7760. the current theme. Common dimensions are giant=48x48, huge=32x32,
  7761. large=24x24, medium=24x24, small=20x20 and tiny=16x16.
  7762. If 'toolbariconsize' is empty, the global default size as determined
  7763. by user preferences or the current theme is used.
  7764. *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
  7765. 'ttybuiltin' 'tbi' boolean (default on)
  7766. global
  7767. When on, the builtin termcaps are searched before the external ones.
  7768. When off the builtin termcaps are searched after the external ones.
  7769. When this option is changed, you should set the 'term' option next for
  7770. the change to take effect, for example: >
  7771. :set notbi term=$TERM
  7772. < See also |termcap|.
  7773. Rationale: The default for this option is "on", because the builtin
  7774. termcap entries are generally better (many systems contain faulty
  7775. xterm entries...).
  7776. *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
  7777. 'ttyfast' 'tf' boolean (default on)
  7778. global
  7779. Indicates a fast terminal connection. More characters will be sent to
  7780. the screen for redrawing, instead of using insert/delete line
  7781. commands. Improves smoothness of redrawing when there are multiple
  7782. windows and the terminal does not support a scrolling region.
  7783. Also enables the extra writing of characters at the end of each screen
  7784. line for lines that wrap. This helps when using copy/paste with the
  7785. mouse in an xterm and other terminals.
  7786. The default used to be set only for some terminal names, but these
  7787. days nearly all terminals are fast, therefore the default is now "on".
  7788. If you have a slow connection you may want to set this option off,
  7789. e.g. depending on the host name: >
  7790. if hostname() =~ 'faraway'
  7791. set nottyfast
  7792. endif
  7793. <
  7794. *'ttymouse'* *'ttym'*
  7795. 'ttymouse' 'ttym' string (default depends on 'term')
  7796. global
  7797. {only in Unix and VMS, doesn't work in the GUI; not
  7798. available when compiled without |+mouse|}
  7799. Name of the terminal type for which mouse codes are to be recognized.
  7800. Currently these strings are valid:
  7801. *xterm-mouse*
  7802. xterm xterm-like mouse handling. The mouse generates
  7803. "<Esc>[Mscr", where "scr" is three bytes:
  7804. "s" = button state
  7805. "c" = column plus 33
  7806. "r" = row plus 33
  7807. This only works up to 223 columns! See "dec",
  7808. "urxvt", and "sgr" for solutions.
  7809. xterm2 Works like "xterm", but with the xterm reporting the
  7810. mouse position while the mouse is dragged. This works
  7811. much faster and more precise. Your xterm must at
  7812. least at patchlevel 88 / XFree 3.3.3 for this to
  7813. work. See below for how Vim detects this
  7814. automatically.
  7815. *netterm-mouse*
  7816. netterm NetTerm mouse handling. A left mouse click generates
  7817. "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
  7818. for the row and column. No other mouse events are
  7819. supported.
  7820. *dec-mouse*
  7821. dec DEC terminal mouse handling. The mouse generates a
  7822. rather complex sequence, starting with "<Esc>[".
  7823. This is also available for an Xterm, if it was
  7824. configured with "--enable-dec-locator".
  7825. *jsbterm-mouse*
  7826. jsbterm JSB term mouse handling.
  7827. *pterm-mouse*
  7828. pterm QNX pterm mouse handling.
  7829. *urxvt-mouse*
  7830. urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
  7831. The mouse works only if the terminal supports this
  7832. encoding style, but it does not have 223 columns limit
  7833. unlike "xterm" or "xterm2".
  7834. *sgr-mouse*
  7835. sgr Mouse handling for the terminal that emits SGR-styled
  7836. mouse reporting. The mouse works even in columns
  7837. beyond 223. This option is backward compatible with
  7838. "xterm2" because it can also decode "xterm2" style
  7839. mouse codes.
  7840. The mouse handling must be enabled at compile time |+mouse_xterm|
  7841. |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
  7842. |+mouse_sgr|.
  7843. Only "xterm"(2) is really recognized. NetTerm mouse codes are always
  7844. recognized, if enabled at compile time. DEC terminal mouse codes
  7845. are recognized if enabled at compile time, and 'ttymouse' is not
  7846. "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
  7847. with them).
  7848. This option is automatically set to "xterm", when the 'term' option is
  7849. set to a name that starts with "xterm", "mlterm", "screen", "tmux",
  7850. "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
  7851. already.
  7852. Additionally, if vim is compiled with the |+termresponse| feature and
  7853. |t_RV| is set to the escape sequence to request the xterm version
  7854. number, more intelligent detection is done.
  7855. The "xterm2" value will be set if the xterm version is reported to be
  7856. from 95 to 276. The "sgr" value will be set if Vim detects Mac
  7857. Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
  7858. higher.
  7859. If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
  7860. automatically, set t_RV to an empty string: >
  7861. :set t_RV=
  7862. <
  7863. *'ttyscroll'* *'tsl'*
  7864. 'ttyscroll' 'tsl' number (default 999)
  7865. global
  7866. Maximum number of lines to scroll the screen. If there are more lines
  7867. to scroll the window is redrawn. For terminals where scrolling is
  7868. very slow and redrawing is not slow this can be set to a small number,
  7869. e.g., 3, to speed up displaying.
  7870. *'ttytype'* *'tty'*
  7871. 'ttytype' 'tty' string (default from $TERM)
  7872. global
  7873. Alias for 'term', see above.
  7874. *'undodir'* *'udir'*
  7875. 'undodir' 'udir' string (default ".")
  7876. global
  7877. {only when compiled with the |+persistent_undo| feature}
  7878. List of directory names for undo files, separated with commas.
  7879. See |'backupdir'| for details of the format.
  7880. "." means using the directory of the file. The undo file name for
  7881. "file.txt" is ".file.txt.un~".
  7882. For other directories the file name is the full path of the edited
  7883. file, with path separators replaced with "%".
  7884. When writing: The first directory that exists is used. "." always
  7885. works, no directories after "." will be used for writing.
  7886. When reading all entries are tried to find an undo file. The first
  7887. undo file that exists is used. When it cannot be read an error is
  7888. given, no further entry is used.
  7889. See |undo-persistence|.
  7890. This option cannot be set from a |modeline| or in the |sandbox|, for
  7891. security reasons.
  7892. *'undofile'* *'noundofile'* *'udf'* *'noudf'*
  7893. 'undofile' 'udf' boolean (default off)
  7894. local to buffer
  7895. {only when compiled with the |+persistent_undo| feature}
  7896. When on, Vim automatically saves undo history to an undo file when
  7897. writing a buffer to a file, and restores undo history from the same
  7898. file on buffer read.
  7899. The directory where the undo file is stored is specified by 'undodir'.
  7900. For more information about this feature see |undo-persistence|.
  7901. The undo file is not read when 'undoreload' causes the buffer from
  7902. before a reload to be saved for undo.
  7903. When 'undofile' is turned off the undo file is NOT deleted.
  7904. NOTE: This option is reset when 'compatible' is set.
  7905. *'undolevels'* *'ul'*
  7906. 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
  7907. global or local to buffer |global-local|
  7908. Maximum number of changes that can be undone. Since undo information
  7909. is kept in memory, higher numbers will cause more memory to be used.
  7910. Nevertheless, a single change can already use a large amount of memory.
  7911. Set to 0 for Vi compatibility: One level of undo and "u" undoes
  7912. itself: >
  7913. set ul=0
  7914. < But you can also get Vi compatibility by including the 'u' flag in
  7915. 'cpoptions', and still be able to use CTRL-R to repeat undo.
  7916. Also see |undo-two-ways|.
  7917. Set to -1 for no undo at all. You might want to do this only for the
  7918. current buffer: >
  7919. setlocal ul=-1
  7920. < This helps when you run out of memory for a single change.
  7921. The local value is set to -123456 when the global value is to be used.
  7922. Also see |clear-undo|.
  7923. *'undoreload'* *'ur'*
  7924. 'undoreload' 'ur' number (default 10000)
  7925. global
  7926. Save the whole buffer for undo when reloading it. This applies to the
  7927. ":e!" command and reloading for when the buffer changed outside of
  7928. Vim. |FileChangedShell|
  7929. The save only happens when this option is negative or when the number
  7930. of lines is smaller than the value of this option.
  7931. Set this option to zero to disable undo for a reload.
  7932. When saving undo for a reload, any undo file is not read.
  7933. Note that this causes the whole buffer to be stored in memory. Set
  7934. this option to a lower value if you run out of memory.
  7935. *'updatecount'* *'uc'*
  7936. 'updatecount' 'uc' number (default: 200)
  7937. global
  7938. After typing this many characters the swap file will be written to
  7939. disk. When zero, no swap file will be created at all (see chapter on
  7940. recovery |crash-recovery|). 'updatecount' is set to zero by starting
  7941. Vim with the "-n" option, see |startup|. When editing in readonly
  7942. mode this option will be initialized to 10000.
  7943. The swapfile can be disabled per buffer with |'swapfile'|.
  7944. When 'updatecount' is set from zero to non-zero, swap files are
  7945. created for all buffers that have 'swapfile' set. When 'updatecount'
  7946. is set to zero, existing swap files are not deleted.
  7947. Also see |'swapsync'|.
  7948. This option has no meaning in buffers where |'buftype'| is "nofile"
  7949. or "nowrite".
  7950. *'updatetime'* *'ut'*
  7951. 'updatetime' 'ut' number (default 4000)
  7952. global
  7953. If this many milliseconds nothing is typed the swap file will be
  7954. written to disk (see |crash-recovery|). Also used for the
  7955. |CursorHold| autocommand event.
  7956. *'varsofttabstop'* *'vsts'*
  7957. 'varsofttabstop' 'vsts' string (default "")
  7958. local to buffer
  7959. {only available when compiled with the |+vartabs|
  7960. feature}
  7961. A list of the number of spaces that a <Tab> counts for while editing,
  7962. such as inserting a <Tab> or using <BS>. It "feels" like variable-
  7963. width <Tab>s are being inserted, while in fact a mixture of spaces
  7964. and <Tab>s is used. Tab widths are separated with commas, with the
  7965. final value applying to all subsequent tabs.
  7966. For example, when editing assembly language files where statements
  7967. start in the 9th column and comments in the 41st, it may be useful
  7968. to use the following: >
  7969. :set varsofttabstop=8,32,8
  7970. < This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
  7971. for every column thereafter.
  7972. Note that the value of |'softtabstop'| will be ignored while
  7973. 'varsofttabstop' is set.
  7974. *'vartabstop'* *'vts'*
  7975. 'vartabstop' 'vts' string (default "")
  7976. local to buffer
  7977. {only available when compiled with the |+vartabs|
  7978. feature}
  7979. A list of the number of spaces that a <Tab> in the file counts for,
  7980. separated by commas. Each value corresponds to one tab, with the
  7981. final value applying to all subsequent tabs. For example: >
  7982. :set vartabstop=4,20,10,8
  7983. < This will make the first tab 4 spaces wide, the second 20 spaces,
  7984. the third 10 spaces, and all following tabs 8 spaces.
  7985. Note that the value of |'tabstop'| will be ignored while 'vartabstop'
  7986. is set.
  7987. *'verbose'* *'vbs'*
  7988. 'verbose' 'vbs' number (default 0)
  7989. global
  7990. When bigger than zero, Vim will give messages about what it is doing.
  7991. Currently, these messages are given:
  7992. >= 1 When the viminfo file is read or written.
  7993. >= 2 When a file is ":source"'ed.
  7994. >= 4 Shell commands.
  7995. >= 5 Every searched tags file and include file.
  7996. >= 8 Files for which a group of autocommands is executed.
  7997. >= 9 Every executed autocommand.
  7998. >= 11 Finding items in a path
  7999. >= 12 Every executed function.
  8000. >= 13 When an exception is thrown, caught, finished, or discarded.
  8001. >= 14 Anything pending in a ":finally" clause.
  8002. >= 15 Every executed Ex command from a script (truncated at 200
  8003. characters).
  8004. >= 16 Every executed Ex command.
  8005. This option can also be set with the "-V" argument. See |-V|.
  8006. This option is also set by the |:verbose| command.
  8007. When the 'verbosefile' option is set then the verbose messages are not
  8008. displayed.
  8009. *'verbosefile'* *'vfile'*
  8010. 'verbosefile' 'vfile' string (default empty)
  8011. global
  8012. When not empty all messages are written in a file with this name.
  8013. When the file exists messages are appended.
  8014. Writing to the file ends when Vim exits or when 'verbosefile' is made
  8015. empty. Writes are buffered, thus may not show up for some time.
  8016. Setting 'verbosefile' to a new value is like making it empty first.
  8017. The difference with |:redir| is that verbose messages are not
  8018. displayed when 'verbosefile' is set.
  8019. *'viewdir'* *'vdir'*
  8020. 'viewdir' 'vdir' string (default for Amiga and Win32:
  8021. "$VIM/vimfiles/view",
  8022. for Unix: "~/.vim/view",
  8023. for macOS: "$VIM:vimfiles:view"
  8024. for VMS: "sys$login:vimfiles/view")
  8025. global
  8026. {not available when compiled without the |+mksession|
  8027. feature}
  8028. Name of the directory where to store files for |:mkview|.
  8029. This option cannot be set from a |modeline| or in the |sandbox|, for
  8030. security reasons.
  8031. *'viewoptions'* *'vop'*
  8032. 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
  8033. global
  8034. {not available when compiled without the |+mksession|
  8035. feature}
  8036. Changes the effect of the |:mkview| command. It is a comma-separated
  8037. list of words. Each word enables saving and restoring something:
  8038. word save and restore ~
  8039. cursor cursor position in file and in window
  8040. folds manually created folds, opened/closed folds and local
  8041. fold options
  8042. options options and mappings local to a window or buffer (not
  8043. global values for local options)
  8044. localoptions same as "options"
  8045. slash backslashes in file names replaced with forward
  8046. slashes
  8047. unix with Unix end-of-line format (single <NL>), even when
  8048. on MS-Windows
  8049. curdir the window-local directory, if set with `:lcd`
  8050. "slash" and "unix" are useful on MS-Windows when sharing view files
  8051. with Unix. The Unix version of Vim cannot source dos format scripts,
  8052. but the MS-Windows version of Vim can source unix format scripts.
  8053. *'viminfo'* *'vi'* *E526* *E527* *E528*
  8054. 'viminfo' 'vi' string (Vi default: "", Vim default for
  8055. MS-Windows: '100,<50,s10,h,rA:,rB:,
  8056. for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
  8057. for others: '100,<50,s10,h)
  8058. global
  8059. {not available when compiled without the |+viminfo|
  8060. feature}
  8061. When non-empty, the viminfo file is read upon startup and written
  8062. when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
  8063. "NONE".
  8064. The string should be a comma-separated list of parameters, each
  8065. consisting of a single character identifying the particular parameter,
  8066. followed by a number or string which specifies the value of that
  8067. parameter. If a particular character is left out, then the default
  8068. value is used for that parameter. The following is a list of the
  8069. identifying characters and the effect of their value.
  8070. CHAR VALUE ~
  8071. *viminfo-!*
  8072. ! When included, save and restore global variables that start
  8073. with an uppercase letter, and don't contain a lowercase
  8074. letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
  8075. and "_K_L_M" are not. Nested List and Dict items may not be
  8076. read back correctly, you end up with an empty item.
  8077. *viminfo-quote*
  8078. " Maximum number of lines saved for each register. Old name of
  8079. the '<' item, with the disadvantage that you need to put a
  8080. backslash before the ", otherwise it will be recognized as the
  8081. start of a comment!
  8082. *viminfo-%*
  8083. % When included, save and restore the buffer list. If Vim is
  8084. started with a file name argument, the buffer list is not
  8085. restored. If Vim is started without a file name argument, the
  8086. buffer list is restored from the viminfo file. Quickfix
  8087. ('buftype'), unlisted ('buflisted'), unnamed and buffers on
  8088. removable media (|viminfo-r|) are not saved.
  8089. When followed by a number, the number specifies the maximum
  8090. number of buffers that are stored. Without a number all
  8091. buffers are stored.
  8092. *viminfo-'*
  8093. ' Maximum number of previously edited files for which the marks
  8094. are remembered. This parameter must always be included when
  8095. 'viminfo' is non-empty.
  8096. Including this item also means that the |jumplist| and the
  8097. |changelist| are stored in the viminfo file.
  8098. *viminfo-/*
  8099. / Maximum number of items in the search pattern history to be
  8100. saved. If non-zero, then the previous search and substitute
  8101. patterns are also saved. When not included, the value of
  8102. 'history' is used.
  8103. *viminfo-:*
  8104. : Maximum number of items in the command-line history to be
  8105. saved. When not included, the value of 'history' is used.
  8106. *viminfo-<*
  8107. < Maximum number of lines saved for each register. If zero then
  8108. registers are not saved. When not included, all lines are
  8109. saved. '"' is the old name for this item.
  8110. Also see the 's' item below: limit specified in Kbyte.
  8111. *viminfo-@*
  8112. @ Maximum number of items in the input-line history to be
  8113. saved. When not included, the value of 'history' is used.
  8114. *viminfo-c*
  8115. c When included, convert the text in the viminfo file from the
  8116. 'encoding' used when writing the file to the current
  8117. 'encoding'. See |viminfo-encoding|.
  8118. *viminfo-f*
  8119. f Whether file marks need to be stored. If zero, file marks ('0
  8120. to '9, 'A to 'Z) are not stored. When not present or when
  8121. non-zero, they are all stored. '0 is used for the current
  8122. cursor position (when exiting or when doing ":wviminfo").
  8123. *viminfo-h*
  8124. h Disable the effect of 'hlsearch' when loading the viminfo
  8125. file. When not included, it depends on whether ":nohlsearch"
  8126. has been used since the last search command.
  8127. *viminfo-n*
  8128. n Name of the viminfo file. The name must immediately follow
  8129. the 'n'. Must be at the end of the option! If the
  8130. 'viminfofile' option is set, that file name overrides the one
  8131. given here with 'viminfo'. Environment variables are
  8132. expanded when opening the file, not when setting the option.
  8133. *viminfo-r*
  8134. r Removable media. The argument is a string (up to the next
  8135. ','). This parameter can be given several times. Each
  8136. specifies the start of a path for which no marks will be
  8137. stored. This is to avoid removable media. For MS-Windows you
  8138. could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
  8139. also use it for temp files, e.g., for Unix: "r/tmp". Case is
  8140. ignored. Maximum length of each 'r' argument is 50
  8141. characters.
  8142. *viminfo-s*
  8143. s Maximum size of an item in Kbyte. If zero then registers are
  8144. not saved. Currently only applies to registers. The default
  8145. "s10" will exclude registers with more than 10 Kbyte of text.
  8146. Also see the '<' item above: line count limit.
  8147. Example: >
  8148. :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
  8149. <
  8150. '50 Marks will be remembered for the last 50 files you
  8151. edited.
  8152. <1000 Contents of registers (up to 1000 lines each) will be
  8153. remembered.
  8154. s100 Registers with more than 100 Kbyte text are skipped.
  8155. :0 Command-line history will not be saved.
  8156. n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
  8157. no / Since '/' is not specified, the default will be used,
  8158. that is, save all of the search history, and also the
  8159. previous search and substitute patterns.
  8160. no % The buffer list will not be saved nor read back.
  8161. no h 'hlsearch' highlighting will be restored.
  8162. When setting 'viminfo' from an empty value you can use |:rviminfo| to
  8163. load the contents of the file, this is not done automatically.
  8164. This option cannot be set from a |modeline| or in the |sandbox|, for
  8165. security reasons.
  8166. NOTE: This option is set to the Vim default value when 'compatible'
  8167. is reset.
  8168. *'viminfofile'* *'vif'*
  8169. 'viminfofile' 'vif' string (default: "")
  8170. global
  8171. {not available when compiled without the |+viminfo|
  8172. feature}
  8173. When non-empty, overrides the file name used for viminfo.
  8174. When equal to "NONE" no viminfo file will be read or written.
  8175. This option can be set with the |-i| command line flag. The |--clean|
  8176. command line flag sets it to "NONE".
  8177. This option cannot be set from a |modeline| or in the |sandbox|, for
  8178. security reasons.
  8179. *'virtualedit'* *'ve'*
  8180. 'virtualedit' 've' string (default "")
  8181. global or local to window |global-local|
  8182. A comma-separated list of these words:
  8183. block Allow virtual editing in Visual block mode.
  8184. insert Allow virtual editing in Insert mode.
  8185. all Allow virtual editing in all modes.
  8186. onemore Allow the cursor to move just past the end of the line
  8187. none When used as the local value, do not allow virtual
  8188. editing even when the global value is set. When used
  8189. as the global value, "none" is the same as "".
  8190. NONE Alternative spelling of "none".
  8191. Virtual editing means that the cursor can be positioned where there is
  8192. no actual character. This can be halfway into a tab or beyond the end
  8193. of the line. Useful for selecting a rectangle in Visual mode and
  8194. editing a table.
  8195. "onemore" is not the same, it will only allow moving the cursor just
  8196. after the last character of the line. This makes some commands more
  8197. consistent. Previously the cursor was always past the end of the line
  8198. if the line was empty. But it is far from Vi compatible. It may also
  8199. break some plugins or Vim scripts. For example because |l| can move
  8200. the cursor after the last character. Use with care!
  8201. Using the `$` command will move to the last character in the line, not
  8202. past it. This may actually move the cursor to the left!
  8203. The `g$` command will move to the end of the screen line.
  8204. It doesn't make sense to combine "all" with "onemore", but you will
  8205. not get a warning for it.
  8206. When combined with other words, "none" is ignored.
  8207. NOTE: This option is set to "" when 'compatible' is set.
  8208. *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
  8209. 'visualbell' 'vb' boolean (default off)
  8210. global
  8211. Use a visual bell instead of beeping. The terminal code to display the
  8212. visual bell is given with 't_vb'. When no beep or flash is wanted,
  8213. use: >
  8214. :set vb t_vb=
  8215. < If you want a short flash, you can use this on many terminals: >
  8216. :set vb t_vb=[?5h$<100>[?5l
  8217. < Here $<100> specifies the time, you can use a smaller or bigger value
  8218. to get a shorter or longer flash.
  8219. Note: Vim will limit the bell to once per half a second. This avoids
  8220. having to wait for the flashing to finish when there are lots of
  8221. bells, e.g. on key repeat. This also happens without 'visualbell'
  8222. set.
  8223. In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
  8224. for 20 msec. If you want to use a different time, use "<Esc>|40f",
  8225. where 40 is the time in msec.
  8226. Note: When the GUI starts, 't_vb' is reset to its default value. You
  8227. might want to set it again in your |gvimrc|.
  8228. Does not work on the Amiga, you always get a screen flash.
  8229. Also see 'errorbells'.
  8230. *'warn'* *'nowarn'*
  8231. 'warn' boolean (default on)
  8232. global
  8233. Give a warning message when a shell command is used while the buffer
  8234. has been changed.
  8235. *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
  8236. 'weirdinvert' 'wiv' boolean (default off)
  8237. global
  8238. This option has the same effect as the 't_xs' terminal option.
  8239. It is provided for backwards compatibility with version 4.x.
  8240. Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
  8241. vice versa. Has no effect when the GUI is running.
  8242. *'whichwrap'* *'ww'*
  8243. 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
  8244. global
  8245. Allow specified keys that move the cursor left/right to move to the
  8246. previous/next line when the cursor is on the first/last character in
  8247. the line. Concatenate characters to allow this for these keys:
  8248. char key mode ~
  8249. b <BS> Normal and Visual
  8250. s <Space> Normal and Visual
  8251. h "h" Normal and Visual (not recommended)
  8252. l "l" Normal and Visual (not recommended)
  8253. < <Left> Normal and Visual
  8254. > <Right> Normal and Visual
  8255. ~ "~" Normal
  8256. [ <Left> Insert and Replace
  8257. ] <Right> Insert and Replace
  8258. For example: >
  8259. :set ww=<,>,[,]
  8260. < allows wrap only when cursor keys are used.
  8261. When the movement keys are used in combination with a delete or change
  8262. operator, the <EOL> also counts for a character. This makes "3h"
  8263. different from "3dh" when the cursor crosses the end of a line. This
  8264. is also true for "x" and "X", because they do the same as "dl" and
  8265. "dh". If you use this, you may also want to use the mapping
  8266. ":map <BS> X" to make backspace delete the character in front of the
  8267. cursor.
  8268. When 'l' is included and it is used after an operator at the end of a
  8269. line (not an empty line) then it will not move to the next line. This
  8270. makes "dl", "cl", "yl" etc. work normally.
  8271. NOTE: This option is set to the Vi default value when 'compatible' is
  8272. set and to the Vim default value when 'compatible' is reset.
  8273. *'wildchar'* *'wc'*
  8274. 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
  8275. global
  8276. Character you have to type to start wildcard expansion in the
  8277. command-line, as specified with 'wildmode'.
  8278. More info here: |cmdline-completion|.
  8279. The character is not recognized when used inside a macro. See
  8280. 'wildcharm' for that.
  8281. Some keys will not work, such as CTRL-C, <CR> and Enter.
  8282. Although 'wc' is a number option, you can set it to a special key: >
  8283. :set wc=<Tab>
  8284. < NOTE: This option is set to the Vi default value when 'compatible' is
  8285. set and to the Vim default value when 'compatible' is reset.
  8286. *'wildcharm'* *'wcm'*
  8287. 'wildcharm' 'wcm' number (default: none (0))
  8288. global
  8289. 'wildcharm' works exactly like 'wildchar', except that it is
  8290. recognized when used inside a macro. You can find "spare" command-line
  8291. keys suitable for this option by looking at |ex-edit-index|. Normally
  8292. you'll never actually type 'wildcharm', just use it in mappings that
  8293. automatically invoke completion mode, e.g.: >
  8294. :set wcm=<C-Z>
  8295. :cnoremap ss so $vim/sessions/*.vim<C-Z>
  8296. < Then after typing :ss you can use CTRL-P & CTRL-N.
  8297. *'wildignore'* *'wig'*
  8298. 'wildignore' 'wig' string (default "")
  8299. global
  8300. A list of file patterns. A file that matches with one of these
  8301. patterns is ignored when expanding |wildcards|, completing file or
  8302. directory names, and influences the result of |expand()|, |glob()| and
  8303. |globpath()| unless a flag is passed to disable this.
  8304. The pattern is used like with |:autocmd|, see |autocmd-patterns|.
  8305. Also see 'suffixes'.
  8306. Example: >
  8307. :set wildignore=*.o,*.obj
  8308. < The use of |:set+=| and |:set-=| is preferred when adding or removing
  8309. a pattern from the list. This avoids problems when a future version
  8310. uses another default.
  8311. *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
  8312. 'wildignorecase' 'wic' boolean (default off)
  8313. global
  8314. When set case is ignored when completing file names and directories.
  8315. Has no effect when 'fileignorecase' is set.
  8316. Does not apply when the shell is used to expand wildcards, which
  8317. happens when there are special characters.
  8318. *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
  8319. 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
  8320. global
  8321. When 'wildmenu' is on, command-line completion operates in an enhanced
  8322. mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
  8323. the possible matches are shown.
  8324. When 'wildoptions' contains "pum", then the completion matches are
  8325. shown in a popup menu. Otherwise they are displayed just above the
  8326. command line, with the first match highlighted (overwriting the status
  8327. line, if there is one).
  8328. Keys that show the previous/next match, such as <Tab> or
  8329. CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
  8330. When 'wildmode' is used, "wildmenu" mode is used where "full" is
  8331. specified. "longest" and "list" do not start "wildmenu" mode.
  8332. You can check the current mode with |wildmenumode()|.
  8333. If there are more matches than can fit in the line, a ">" is shown on
  8334. the right and/or a "<" is shown on the left. The status line scrolls
  8335. as needed.
  8336. The "wildmenu" mode is abandoned when a key is hit that is not used
  8337. for selecting a completion.
  8338. While the "wildmenu" is active, not using the popup menu, the
  8339. following keys have special meanings:
  8340. <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
  8341. <Down> - in filename/menu name completion: move into a
  8342. subdirectory or submenu.
  8343. <CR> - in menu completion, when the cursor is just after a
  8344. dot: move into a submenu.
  8345. <Up> - in filename/menu name completion: move up into
  8346. parent directory or parent menu.
  8347. When using the popup menu for command line completion, the following
  8348. keys have special meanings:
  8349. <Down> - select next match (like CTRL-N)
  8350. <Left> - in filename/menu name completion: move up into
  8351. parent directory or parent menu.
  8352. <Right> - in filename/menu name completion: move into a
  8353. subdirectory or submenu.
  8354. <Up> - select previous match (like CTRL-P)
  8355. CTRL-E - end completion, go back to what was there before
  8356. selecting a match.
  8357. CTRL-N - go to the next entry
  8358. CTRL-P - go to the previous entry
  8359. CTRL-Y - accept the currently selected match and stop
  8360. completion.
  8361. This makes the menus accessible from the console |console-menus|.
  8362. If you prefer the <Left> and <Right> keys to move the cursor instead
  8363. of selecting a different match, use this: >
  8364. :cnoremap <Left> <Space><BS><Left>
  8365. :cnoremap <Right> <Space><BS><Right>
  8366. <
  8367. The "WildMenu" highlighting is used for displaying the current match
  8368. |hl-WildMenu|.
  8369. *'wildmode'* *'wim'*
  8370. 'wildmode' 'wim' string (Vim default: "full")
  8371. global
  8372. Completion mode that is used for the character specified with
  8373. 'wildchar'. It is a comma-separated list of up to four parts. Each
  8374. part specifies what to do for each consecutive use of 'wildchar'. The
  8375. first part specifies the behavior for the first use of 'wildchar',
  8376. The second part for the second use, etc.
  8377. Each part consists of a colon separated list consisting of the
  8378. following possible values:
  8379. "" Complete only the first match.
  8380. "full" Complete the next full match. After the last match,
  8381. the original string is used and then the first match
  8382. again. Will also start 'wildmenu' if it is enabled.
  8383. "longest" Complete till longest common string. If this doesn't
  8384. result in a longer string, use the next part.
  8385. "list" When more than one match, list all matches.
  8386. "lastused" When completing buffer names and more than one buffer
  8387. matches, sort buffers by time last used (other than
  8388. the current buffer).
  8389. When there is only a single match, it is fully completed in all cases.
  8390. Examples of useful colon-separated values:
  8391. "longest:full" Like "longest", but also start 'wildmenu' if it is
  8392. enabled. Will not complete to the next full match.
  8393. "list:full" When more than one match, list all matches and
  8394. complete first match.
  8395. "list:longest" When more than one match, list all matches and
  8396. complete till longest common string.
  8397. "list:lastused" When more than one buffer matches, list all matches
  8398. and sort buffers by time last used (other than the
  8399. current buffer).
  8400. Examples: >
  8401. :set wildmode=full
  8402. < Complete first full match, next match, etc. (the default) >
  8403. :set wildmode=longest,full
  8404. < Complete longest common string, then each full match >
  8405. :set wildmode=list:full
  8406. < List all matches and complete each full match >
  8407. :set wildmode=list,full
  8408. < List all matches without completing, then each full match >
  8409. :set wildmode=longest,list
  8410. < Complete longest common string, then list alternatives.
  8411. More info here: |cmdline-completion|.
  8412. *'wildoptions'* *'wop'*
  8413. 'wildoptions' 'wop' string (default "")
  8414. global
  8415. A list of words that change how |cmdline-completion| is done.
  8416. The following values are supported:
  8417. fuzzy Use |fuzzy-matching| to find completion matches. When
  8418. this value is specified, wildcard expansion will not
  8419. be used for completion. The matches will be sorted by
  8420. the "best match" rather than alphabetically sorted.
  8421. This will find more matches than the wildcard
  8422. expansion. Currently fuzzy matching based completion
  8423. is not supported for file and directory names and
  8424. instead wildcard expansion is used.
  8425. pum Display the completion matches using the popup menu
  8426. in the same style as the |ins-completion-menu|.
  8427. tagfile When using CTRL-D to list matching tags, the kind of
  8428. tag and the file of the tag is listed. Only one match
  8429. is displayed per line. Often used tag kinds are:
  8430. d #define
  8431. f function
  8432. *'winaltkeys'* *'wak'*
  8433. 'winaltkeys' 'wak' string (default "menu")
  8434. global
  8435. {only used in Win32, Motif, GTK and Photon GUI}
  8436. Some GUI versions allow the access to menu entries by using the ALT
  8437. key in combination with a character that appears underlined in the
  8438. menu. This conflicts with the use of the ALT key for mappings and
  8439. entering special characters. This option tells what to do:
  8440. no Don't use ALT keys for menus. ALT key combinations can be
  8441. mapped, but there is no automatic handling. This can then be
  8442. done with the |:simalt| command.
  8443. yes ALT key handling is done by the windowing system. ALT key
  8444. combinations cannot be mapped.
  8445. menu Using ALT in combination with a character that is a menu
  8446. shortcut key, will be handled by the windowing system. Other
  8447. keys can be mapped.
  8448. If the menu is disabled by excluding 'm' from 'guioptions', the ALT
  8449. key is never used for the menu.
  8450. This option is not used for <F10>; on Win32 and with GTK <F10> will
  8451. select the menu, unless it has been mapped.
  8452. *'wincolor'* *'wcr'*
  8453. 'wincolor' 'wcr' string (default empty)
  8454. local to window
  8455. Highlight group name to use for this window instead of the Normal
  8456. color |hl-Normal|.
  8457. *'window'* *'wi'*
  8458. 'window' 'wi' number (default screen height - 1)
  8459. global
  8460. Window height used for |CTRL-F| and |CTRL-B| when there is only one
  8461. window and the value is smaller than 'lines' minus one. The screen
  8462. will scroll 'window' minus two lines, with a minimum of one.
  8463. When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
  8464. in a much smarter way, taking care of wrapping lines.
  8465. When resizing the Vim window, the value is smaller than 1 or more than
  8466. or equal to 'lines' it will be set to 'lines' minus 1.
  8467. Note: Do not confuse this with the height of the Vim window, use
  8468. 'lines' for that.
  8469. *'winheight'* *'wh'* *E591*
  8470. 'winheight' 'wh' number (default 1)
  8471. global
  8472. Minimal number of lines for the current window. This is not a hard
  8473. minimum, Vim will use fewer lines if there is not enough room. If the
  8474. focus goes to a window that is smaller, its size is increased, at the
  8475. cost of the height of other windows.
  8476. Set 'winheight' to a small number for normal editing.
  8477. Set it to 999 to make the current window fill most of the screen.
  8478. Other windows will be only 'winminheight' high. This has the drawback
  8479. that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
  8480. to create only two windows, set the option after startup is done,
  8481. using the |VimEnter| event: >
  8482. au VimEnter * set winheight=999
  8483. < Minimum value is 1.
  8484. The height is not adjusted after one of the commands that change the
  8485. height of the current window.
  8486. 'winheight' applies to the current window. Use 'winminheight' to set
  8487. the minimal height for other windows.
  8488. *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
  8489. 'winfixheight' 'wfh' boolean (default off)
  8490. local to window
  8491. Keep the window height when windows are opened or closed and
  8492. 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
  8493. |preview-window| and |quickfix-window|.
  8494. The height may be changed anyway when running out of room.
  8495. *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
  8496. 'winfixwidth' 'wfw' boolean (default off)
  8497. local to window
  8498. Keep the window width when windows are opened or closed and
  8499. 'equalalways' is set. Also for |CTRL-W_=|.
  8500. The width may be changed anyway when running out of room.
  8501. *'winminheight'* *'wmh'*
  8502. 'winminheight' 'wmh' number (default 1)
  8503. global
  8504. The minimal height of a window, when it's not the current window.
  8505. This is a hard minimum, windows will never become smaller.
  8506. When set to zero, windows may be "squashed" to zero lines (i.e. just a
  8507. status bar) if necessary. They will return to at least one line when
  8508. they become active (since the cursor has to have somewhere to go.)
  8509. Use 'winheight' to set the minimal height of the current window.
  8510. This option is only checked when making a window smaller. Don't use a
  8511. large number, it will cause errors when opening more than a few
  8512. windows. A value of 0 to 3 is reasonable.
  8513. *'winminwidth'* *'wmw'*
  8514. 'winminwidth' 'wmw' number (default 1)
  8515. global
  8516. The minimal width of a window, when it's not the current window.
  8517. This is a hard minimum, windows will never become smaller.
  8518. When set to zero, windows may be "squashed" to zero columns (i.e. just
  8519. a vertical separator) if necessary. They will return to at least one
  8520. line when they become active (since the cursor has to have somewhere
  8521. to go.)
  8522. Use 'winwidth' to set the minimal width of the current window.
  8523. This option is only checked when making a window smaller. Don't use a
  8524. large number, it will cause errors when opening more than a few
  8525. windows. A value of 0 to 12 is reasonable.
  8526. *'winptydll'*
  8527. 'winptydll' string (default "winpty32.dll" or "winpty64.dll")
  8528. global
  8529. {only available when compiled with the |terminal|
  8530. feature on MS-Windows}
  8531. Specifies the name of the winpty shared library, used for the
  8532. |:terminal| command. The default depends on whether Vim was built as a
  8533. 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
  8534. a fallback.
  8535. Environment variables are expanded |:set_env|.
  8536. This option cannot be set from a |modeline| or in the |sandbox|, for
  8537. security reasons.
  8538. *'winwidth'* *'wiw'* *E592*
  8539. 'winwidth' 'wiw' number (default 20)
  8540. global
  8541. Minimal number of columns for the current window. This is not a hard
  8542. minimum, Vim will use fewer columns if there is not enough room. If
  8543. the current window is smaller, its size is increased, at the cost of
  8544. the width of other windows. Set it to 999 to make the current window
  8545. always fill the screen. Set it to a small number for normal editing.
  8546. The width is not adjusted after one of the commands to change the
  8547. width of the current window.
  8548. 'winwidth' applies to the current window. Use 'winminwidth' to set
  8549. the minimal width for other windows.
  8550. *'wrap'* *'nowrap'*
  8551. 'wrap' boolean (default on)
  8552. local to window
  8553. This option changes how text is displayed. It doesn't change the text
  8554. in the buffer, see 'textwidth' for that.
  8555. When on, lines longer than the width of the window will wrap and
  8556. displaying continues on the next line. When off lines will not wrap
  8557. and only part of long lines will be displayed. When the cursor is
  8558. moved to a part that is not shown, the screen will scroll
  8559. horizontally.
  8560. The line will be broken in the middle of a word if necessary. See
  8561. 'linebreak' to get the break at a word boundary.
  8562. To make scrolling horizontally a bit more useful, try this: >
  8563. :set sidescroll=5
  8564. :set listchars+=precedes:<,extends:>
  8565. < See 'sidescroll', 'listchars' and |wrap-off|.
  8566. This option can't be set from a |modeline| when the 'diff' option is
  8567. on.
  8568. *'wrapmargin'* *'wm'*
  8569. 'wrapmargin' 'wm' number (default 0)
  8570. local to buffer
  8571. Number of characters from the right window border where wrapping
  8572. starts. When typing text beyond this limit, an <EOL> will be inserted
  8573. and inserting continues on the next line.
  8574. Options that add a margin, such as 'number' and 'foldcolumn', cause
  8575. the text width to be further reduced. This is Vi compatible.
  8576. When 'textwidth' is non-zero, this option is not used.
  8577. This option is set to 0 when 'paste' is set and restored when 'paste'
  8578. is reset.
  8579. See also 'formatoptions' and |ins-textwidth|.
  8580. *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
  8581. 'wrapscan' 'ws' boolean (default on) *E384* *E385*
  8582. global
  8583. Searches wrap around the end of the file. Also applies to |]s| and
  8584. |[s|, searching for spelling mistakes.
  8585. *'write'* *'nowrite'*
  8586. 'write' boolean (default on)
  8587. global
  8588. Allows writing files. When not set, writing a file is not allowed.
  8589. Can be used for a view-only mode, where modifications to the text are
  8590. still allowed. Can be reset with the |-m| or |-M| command line
  8591. argument. Filtering text is still possible, even though this requires
  8592. writing a temporary file.
  8593. *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
  8594. 'writeany' 'wa' boolean (default off)
  8595. global
  8596. Allows writing to any file with no need for "!" override.
  8597. *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
  8598. 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
  8599. otherwise)
  8600. global
  8601. Make a backup before overwriting a file. The backup is removed after
  8602. the file was successfully written, unless the 'backup' option is
  8603. also on.
  8604. WARNING: Switching this option off means that when Vim fails to write
  8605. your buffer correctly and then, for whatever reason, Vim exits, you
  8606. lose both the original file and what you were writing. Only reset
  8607. this option if your file system is almost full and it makes the write
  8608. fail (and make sure not to exit Vim until the write was successful).
  8609. See |backup-table| for another explanation.
  8610. When the 'backupskip' pattern matches, a backup is not made anyway.
  8611. Depending on 'backupcopy' the backup is a new file or the original
  8612. file renamed (and a new file is written).
  8613. NOTE: This option is set to the default value when 'compatible' is
  8614. set.
  8615. *'writedelay'* *'wd'*
  8616. 'writedelay' 'wd' number (default 0)
  8617. global
  8618. The number of milliseconds to wait for each character sent to the
  8619. screen. When non-zero, characters are sent to the terminal one by
  8620. one. For debugging purposes.
  8621. *'xtermcodes'* *'noxtermcodes'*
  8622. 'xtermcodes' boolean (default on)
  8623. global
  8624. When detecting xterm patchlevel 141 or higher with the termresponse
  8625. mechanism and this option is set, Vim will request the actual terminal
  8626. key codes and number of colors from the terminal. This takes care of
  8627. various configuration options of the terminal that cannot be obtained
  8628. from the termlib/terminfo entry, see |xterm-codes|.
  8629. A side effect may be that t_Co changes and Vim will redraw the
  8630. display.
  8631. vim:tw=78:ts=8:noet:ft=help:norl: