vifm-help.txt 194 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900
  1. VIFM(1) General Commands Manual VIFM(1)
  2. NAME
  3. vifm - vi file manager
  4. SYNOPSIS
  5. vifm [OPTION]...
  6. vifm [OPTION]... path
  7. vifm [OPTION]... path path
  8. DESCRIPTION
  9. Vifm is an ncurses based file manager with vi like keybindings. If you
  10. use vi, vifm gives you complete keyboard control over your files with-
  11. out having to learn a new set of commands.
  12. OPTIONS
  13. vifm starts in the current directory unless it is given a different
  14. directory on the command line or 'vifminfo' option includes "savedirs"
  15. (in which case last visited directories are used as defaults).
  16. - Read list of files from standard input stream and compose custom
  17. view out of them (see "Custom views" section). Current working
  18. directory is used as a base for relative paths.
  19. <path> Starts Vifm in the specified path.
  20. <path> <path>
  21. Starts Vifm in the specified paths.
  22. Specifying two directories triggers split view even when vifm was in
  23. single-view mode on finishing previous session. To suppress this be-
  24. haviour :only command can be put in the vifmrc file.
  25. When only one path argument is found on command-line, the left/top pane
  26. is automatically set as the current view.
  27. Paths to files are also allowed in case you want vifm to start with
  28. some archive opened.
  29. --select <path>
  30. Open parent directory of the given path and select specified
  31. file in it.
  32. -f Makes vifm instead of opening files write selection to
  33. $VIFM/vimfiles and quit.
  34. --choose-files <path>|-
  35. Sets output file to write selection into on exit instead of
  36. opening files. "-" means standard output. Use empty value to
  37. disable it.
  38. --choose-dir <path>|-
  39. Sets output file to write last visited directory into on exit.
  40. "-" means standard output. Use empty value to disable it.
  41. --delimiter <delimiter>
  42. Sets separator for list of file paths written out by vifm.
  43. Empty value means null character. Default is new line charac-
  44. ter.
  45. --on-choose <command>
  46. Sets command to be executed on selected files instead of opening
  47. them. The command may use any of macros described in "Command
  48. macros" section below. The command is executed once for whole
  49. selection.
  50. --logging[=<startup log path>]
  51. Log some operational details $VIFM/log. If the optional startup
  52. log path is specified and permissions allow to open it for writ-
  53. ing, then logging of early initialization (before value of $VIFM
  54. is determined) is put there.
  55. --server-list
  56. List available server names and exit.
  57. --server-name <name>
  58. Name of target or this instance (sequential numbers are appended
  59. on name conflict).
  60. --remote
  61. Sends the rest of the command line to another instance of vifm,
  62. --server-name is treated just like any other argument and should
  63. precede --remote on the command line. When there is no server,
  64. quits silently. There is no limit on how many arguments can be
  65. processed. One can combine --remote with -c <command> or +<com-
  66. mand> to execute commands in already running instance of vifm.
  67. See also "Client-Server" section below.
  68. --remote-expr
  69. passes expression to vifm server and prints result. See also
  70. "Client-Server" section below.
  71. -c <command> or +<command>
  72. Run command-line mode <command> on startup. Commands in such
  73. arguments are executed in the order they appear in command line.
  74. Commands with spaces or special symbols must be enclosed in dou-
  75. ble or single quotes or all special symbols should be escaped
  76. (the exact syntax strongly depends on shell). "+" argument is
  77. equivalent to "$" and thus picks last item of of the view.
  78. --help, -h
  79. Show a brief command summary and exit vifm.
  80. --version, -v
  81. Show version information and quit.
  82. --no-configs
  83. Skip reading vifmrc and vifminfo.
  84. See "Startup" section below for the explanations on $VIFM.
  85. General keys
  86. Ctrl-C or Escape
  87. cancel most operations (see "Cancellation" section below), clear
  88. all selected files.
  89. Ctrl-L clear and redraw the screen.
  90. Basic Movement
  91. The basic vi key bindings are used to move through the files and pop-up
  92. windows.
  93. k, gk, or Ctrl-P
  94. move cursor up one line.
  95. j, gj or Ctrl-N
  96. move cursor down one line.
  97. h when 'lsview' is off move up one directory (moves to parent
  98. directory node in tree view), otherwise move left one file.
  99. l when 'lsview' is off move into a directory or launches a file,
  100. otherwise move right one file.
  101. gg move to the first line of the file list.
  102. G move to the last line in the file list.
  103. gh go up one directory regardless of view representation (regular,
  104. ls-like). Also can be used to leave custom views including tree
  105. view.
  106. gl or Enter
  107. enter directory or launch a file.
  108. H move to the first file in the window.
  109. M move to the file in the middle of the window.
  110. L move to the last file in the window.
  111. Ctrl-F or Page Down
  112. move forward one page.
  113. Ctrl-B or Page Up
  114. move back one page.
  115. Ctrl-D jump back one half page.
  116. Ctrl-U jump forward one half page.
  117. n% move to the file that is n percent from the top of the list (for
  118. example 25%).
  119. 0 or ^ move cursor to the first column. See 'lsview' option descrip-
  120. tion.
  121. $ move cursor to the last column. See 'lsview' option descrip-
  122. tion.
  123. Space switch file lists.
  124. gt switch to the next tab (wrapping around).
  125. {n}gt switch to the tab number {n} (wrapping around).
  126. gT switch to the previous tab (wrapping around).
  127. {n}gT switch to {n}-th previous tab.
  128. Movement with Count
  129. Most movement commands also accept a count, 12j would move down 12
  130. files.
  131. [count]%
  132. move to percent of the file list.
  133. [count]j
  134. move down [count] files.
  135. [count]k
  136. move up [count] files.
  137. [count]G or [count]gg
  138. move to list position [count].
  139. [count]h
  140. go up [count] directories.
  141. Scrolling panes
  142. zt redraw pane with file in top of list.
  143. zz redraw pane with file in center of list.
  144. zb redraw pane with file in bottom of list.
  145. Ctrl-E scroll pane one line down.
  146. Ctrl-Y scroll pane one line up.
  147. Pane manipulation
  148. Second character can be entered with or without Control key.
  149. Ctrl-W H
  150. move the pane to the far left.
  151. Ctrl-W J
  152. move the pane to the very bottom.
  153. Ctrl-W K
  154. move the pane to the very top.
  155. Ctrl-W L
  156. move the pane to the far right.
  157. Ctrl-W h
  158. switch to the left pane.
  159. Ctrl-W j
  160. switch to the pane below.
  161. Ctrl-W k
  162. switch to the pane above.
  163. Ctrl-W l
  164. switch to the right pane.
  165. Ctrl-W b
  166. switch to bottom-right window.
  167. Ctrl-W t
  168. switch to top-left window.
  169. Ctrl-W p
  170. switch to previous window.
  171. Ctrl-W w
  172. switch to other pane.
  173. Ctrl-W o
  174. leave only one pane.
  175. Ctrl-W s
  176. split window horizontally.
  177. Ctrl-W v
  178. split window vertically.
  179. Ctrl-W x
  180. exchange panes.
  181. Ctrl-W z
  182. quit preview pane or view modes.
  183. Ctrl-W -
  184. decrease size of the view by count.
  185. Ctrl-W +
  186. increase size of the view by count.
  187. Ctrl-W <
  188. decrease size of the view by count.
  189. Ctrl-W >
  190. increase size of the view by count.
  191. Ctrl-W |
  192. set current view size to count.
  193. Ctrl-W _
  194. set current view size to count.
  195. Ctrl-W =
  196. make size of two views equal.
  197. For Ctrl-W +, Ctrl-W -, Ctrl-W <, Ctrl-W >, Ctrl-W | and Ctrl-W _ com-
  198. mands count can be given before and/or after Ctrl-W. The resulting
  199. count is a multiplication of those two. So "2 Ctrl-W 2 -" decreases
  200. window size by 4 lines or columns.
  201. Ctrl-W | and Ctrl-W _ maximise current view by default.
  202. Marks
  203. Marks are set the same way as they are in vi.
  204. You can use these characters for marks [a-z][A-Z][0-9].
  205. m[a-z][A-Z][0-9]
  206. set a mark for the file at the current cursor position.
  207. '[a-z][A-Z][0-9]
  208. navigate to the file set for the mark.
  209. There are also several special marks that can't be set manually:
  210. - ' (single quote) - previously visited directory of the view, thus
  211. hitting '' allows switching between two last locations
  212. - < - the first file of the last visually selected block
  213. - > - the last file of the last visually selected block
  214. Searching
  215. /regular expression pattern
  216. search for files matching regular expression in forward direc-
  217. tion and advance cursor to next match.
  218. / perform forward search with top item of search pattern history.
  219. ?regular expression pattern
  220. search for files matching regular expression in backward direc-
  221. tion and advance cursor to previous match.
  222. ? perform backward search with top item of search pattern history.
  223. Trailing slash for directories is taken into account, so /\/ searches
  224. for directories and symbolic links to directories. At the moment //
  225. works too, but this can change in the future, so consider escaping the
  226. slash if not typing pattern by hand.
  227. Matches are automatically selected if 'hlsearch' is set. Enabling
  228. 'incsearch' makes search interactive. 'ignorecase' and 'smartcase'
  229. options affect case sensitivity of search queries.
  230. [count]n
  231. go to the next file matching last search pattern. Takes last
  232. search direction into account.
  233. [count]N
  234. go to the previous file matching last search pattern. Takes
  235. last search direction into account.
  236. If 'hlsearch' option is set, hitting n/N to perform search and go to
  237. the first matching item resets current selection in normal mode. It is
  238. not the case if search was already performed on files in the directory,
  239. thus selection is not reset after clearing selection with escape key
  240. and hitting n/N key again.
  241. Note: vifm uses extended regular expressions for / and ?.
  242. [count]f[character]
  243. search forward for file with [character] as first character in
  244. name. Search wraps around the end of the list.
  245. [count]F[character]
  246. search backward for file with [character] as first character in
  247. name. Search wraps around the end of the list.
  248. [count];
  249. find the next match of f or F.
  250. [count],
  251. find the previous match of f or F.
  252. Note: f, F, ; and , wrap around list beginning and end when they are
  253. used alone and they don't wrap when they are used as selectors.
  254. File Filters
  255. There are three basic file filters:
  256. - dot files filter (excluding "." and ".." special directories, whose
  257. appearance is controlled by the 'dotdirs' option);
  258. - manual filter for file names;
  259. - automatic filter for file names;
  260. - local filter for file names (see description of the "=" normal mode
  261. command).
  262. Performing operations on manual filter for file names automatically
  263. does the same on automatic one. The file name filter is separated
  264. mainly for convenience purpose and to get more deterministic behaviour.
  265. The basic vim folding key bindings are used for filtering files.
  266. Each file list has its own copy of each filter.
  267. Filtered files are not checked in / search or :commands.
  268. Files and directories are filtered separately. For this a slash is
  269. appended to a directory name before testing whether it matches the fil-
  270. ter. Examples:
  271. " filter directories which names end with '.files'
  272. :filter /^.*\.files\/$/
  273. " filter files which names end with '.d'
  274. :filter /^.*\.d$/
  275. " filter files and directories which names end with '.o'
  276. :filter /^.*\.o\/?$/
  277. Note: vifm uses extended regular expressions.
  278. za toggle visibility of dot files.
  279. zo show dot files.
  280. zm hide dot files.
  281. zf add selected files to file name filter.
  282. zO show files hidden by file name filter.
  283. zM restore all filters.
  284. zR remove all filters.
  285. zr remove local filter.
  286. zd exclude selection or current file from a custom view. Does
  287. nothing for regular view. For tree view excluding directory
  288. excludes that sub-tree. For compare views zd hides group of
  289. adjacent identical files, count can be specified as 1 to exclude
  290. just single file or selected items instead. Files excluded this
  291. way are not counted as filtered out and can't be returned unless
  292. view is reloaded.
  293. =regular expression pattern
  294. filter out files that don't match regular expression. Whether
  295. view is updated as regular expression is changed depends on the
  296. value of the 'incsearch' option. This kind of filter is auto-
  297. matically reset when directory is changed.
  298. Other Normal Mode Keys
  299. [count]:
  300. enter command line mode. [count] generates range.
  301. q: open external editor to prompt for command-line command. See
  302. "Command line editing" section for details.
  303. q/ open external editor to prompt for search pattern to be searched
  304. in forward direction. See "Command line editing" section for
  305. details.
  306. q? open external editor to prompt for search pattern to be searched
  307. in backward direction. See "Command line editing" section for
  308. details.
  309. q= open external editor to prompt for filter pattern. See "Command
  310. line editing" section for details. Unlike other q{x} commands
  311. this one doesn't work in Visual mode.
  312. [count]!! and [count]!<selector>
  313. enter command line mode with entered ! command. [count] modi-
  314. fies range.
  315. Ctrl-O go backwards through directory history of current view. Nonex-
  316. istent directories are automatically skipped.
  317. Ctrl-I if 'cpoptions' contains "t" flag, <tab> and <c-i> switch active
  318. pane just like <space> does, otherwise it goes forward through
  319. directory history of current view. Nonexistent directories are
  320. automatically skipped.
  321. Ctrl-G create a window showing detailed information about the current
  322. file.
  323. Shift-Tab
  324. enters view mode (works only after activating view pane with
  325. :view command).
  326. ga calculate directory size. Uses cached directory sizes when pos-
  327. sible for better performance. As a special case calculating
  328. size of ".." entry results in calculation of size of current
  329. directory.
  330. gA like ga, but force update. Ignores old values of directory
  331. sizes.
  332. If file under cursor is selected, each selected item is processed, oth-
  333. erwise only current file is updated.
  334. gf find link destination (like l with 'followlinks' off, but also
  335. finds directories).
  336. gr only for MS-Windows
  337. same as l key, but tries to run program with administrative
  338. privileges.
  339. av go to visual mode into selection amending state preserving cur-
  340. rent selection.
  341. gv go to visual mode restoring last selection.
  342. [reg]gs
  343. when no register is specified, restore last t selection (similar
  344. to what gv does for visual mode selection). If register is
  345. present, then all files listed in that register and which are
  346. visible in current view are selected.
  347. gu<selector>
  348. make names of selected files lowercase.
  349. [count]guu and [count]gugu
  350. make names of [count] files starting from the current one lower-
  351. case. Without [count] only current file is affected.
  352. gU<selector>
  353. make names of selected files uppercase.
  354. [count]gUU and [count]gUgU
  355. make names of [count] files starting from the current one upper-
  356. case. Without [count] only current file is affected.
  357. e explore file in the current pane.
  358. i handle file (even if it's an executable and 'runexec' option is
  359. set).
  360. cw change word is used to rename a file or files.
  361. cW change WORD is used to change only name of file (without exten-
  362. sion).
  363. cl change link target.
  364. co only for *nix
  365. change file owner.
  366. cg only for *nix
  367. change file group.
  368. [count]cp
  369. change file attributes (permission on *nix and properties on
  370. Windows). If [count] is specified, it's treated as numerical
  371. argument for non-recursive `chmod` command (of the form
  372. [0-7]{3,4}).
  373. [count]C
  374. clone file [count] times.
  375. [count]dd or d[count]selector
  376. move selected file or files to trash directory (if 'trash'
  377. option is set, otherwise delete). See "Trash directory" section
  378. below.
  379. [count]DD or D[count]selector
  380. like dd and d<selector>, but omitting trash directory (even when
  381. 'trash' option is set).
  382. Y, [count]yy or y[count]selector
  383. yank selected files.
  384. p copy yanked files to the current directory or move the files to
  385. the current directory if they were deleted with dd or :d[elete]
  386. or if the files were yanked from trash directory. See "Trash
  387. directory" section below.
  388. P move the last yanked files. The advantage of using P instead of
  389. d followed by p is that P moves files only once. This isn't
  390. important in case you're moving files in the same file system
  391. where your home directory is, but using P to move files on some
  392. other file system (or file systems, in case you want to move
  393. files from fs1 to fs2 and your home is on fs3) can save your
  394. time.
  395. al put symbolic links with absolute paths.
  396. rl put symbolic links with relative paths.
  397. t select or unselect (tag) the current file.
  398. u undo last change.
  399. Ctrl-R redo last change.
  400. dp in compare view of "ofboth grouppaths" kind, makes corresponding
  401. entry of the other pane equal to the current one. The semantics
  402. is as follows:
  403. - nothing done for identical entries
  404. - if file is missing in current view, its pair gets removed
  405. - if file is missing or differs in other view, it's replaced
  406. - file pairs are defined by matching relative paths
  407. File removal obeys 'trash' option. When the option is enabled,
  408. the operation can be undone/redone (although results won't be
  409. visible automatically).
  410. Unlike in Vim, this operation is performed on a single line
  411. rather than a set of adjacent changes.
  412. do same as dp, but applies changes in the opposite direction.
  413. v or V enter visual mode, clears current selection.
  414. [count]Ctrl-A
  415. increment first number in file name by [count] (1 by default).
  416. [count]Ctrl-X
  417. decrement first number in file name by [count] (1 by default).
  418. ZQ same as :quit!.
  419. ZZ same as :quit.
  420. . repeat last command-line command (not normal mode command) of
  421. this session (does nothing right after startup or :restart com-
  422. mand). The command doesn't depend on command-line history and
  423. can be used with completely disabled history.
  424. ( go to previous group. Groups are defined by primary sorting
  425. key. For name and iname members of each group have same first
  426. letter, for all other sorting keys vifm uses size, uid, ...
  427. ) go to next group. See ( key description above.
  428. { speeds up navigation to closest previous entry of the opposite
  429. type by moving to the first file backwards when cursor is on a
  430. directory and to the first directory backwards when cursor is on
  431. a file. This is essentially a special case of ( that is locked
  432. on "dirs".
  433. } same as {, but in forward direction.
  434. [c go to previous mismatched entry in directory comparison view or
  435. do nothing.
  436. ]c go to next mismatched entry in directory comparison view or do
  437. nothing.
  438. [d go to previous directory entry or do nothing.
  439. ]d go to next directory entry or do nothing.
  440. [r same as :siblprev.
  441. ]r same as :siblnext.
  442. [R same as :siblprev!.
  443. ]R same as :siblnext!.
  444. [s go to previous selected entry or do nothing.
  445. ]s go to next selected entry or do nothing.
  446. [z go to first sibling of current entry.
  447. ]z go to last sibling of current entry.
  448. zj go to next directory sibling of current entry or do nothing.
  449. zk go to previous directory sibling of current entry or do nothing.
  450. Using Count
  451. You can use count with commands like yy.
  452. [count]yy
  453. yank count files starting from current cursor position downward.
  454. Or you can use count with motions passed to y, d or D.
  455. d[count]j
  456. delete (count + 1) files starting from current cursor position
  457. upward.
  458. Registers
  459. vifm supports multiple registers for temporary storing list of yanked
  460. or deleted files.
  461. Registers should be specified by hitting double quote key followed by a
  462. register name. Count is specified after register name. By default
  463. commands use unnamed register, which has double quote as its name.
  464. Though all commands accept registers, most of commands ignores them
  465. (for example H or Ctrl-U). Other commands can fill register or append
  466. new files to it.
  467. Presently vifm supports ", _, a-z and A-Z characters as register names.
  468. As mentioned above " is unnamed register and has special meaning of the
  469. default register. Every time when you use named registers (a-z and A-
  470. Z) unnamed register is updated to contain same list of files as the
  471. last used register.
  472. _ is black hole register. It can be used for writing, but its list is
  473. always empty.
  474. Registers with names from a to z and from A to Z are named ones. Low-
  475. ercase registers are cleared before adding new files, while uppercase
  476. aren't and should be used to append new files to the existing file list
  477. of appropriate lowercase register (A for a, B for b, ...).
  478. Registers can be changed on :empty command if they contain files under
  479. trash directory (see "Trash directory" section below).
  480. Registers do not contain one file more than once.
  481. Example:
  482. "a2yy
  483. puts names of two files to register a (and to the unnamed register),
  484. "Ad
  485. removes one file and append its name to register a (and to the unnamed
  486. register),
  487. p or "ap or "Ap
  488. inserts previously yanked and deleted files into current directory.
  489. Selectors
  490. y, d, D, !, gu and gU commands accept selectors. You can combine them
  491. with any of selectors below to quickly remove or yank several files.
  492. Most of selectors are like vi motions: j, k, gg, G, H, L, M, %, f, F,
  493. ;, comma, ', ^, 0 and $. But there are some additional ones.
  494. a all files in current view.
  495. s selected files.
  496. S all files except selected.
  497. Examples:
  498. - dj - delete file under cursor and one below;
  499. - d2j - delete file under cursor and two below;
  500. - y6gg - yank all files from cursor position to 6th file in the list.
  501. When you pass a count to whole command and its selector they are multi-
  502. plied. So:
  503. - 2d2j - delete file under cursor and four below;
  504. - 2dj - delete file under cursor and two below;
  505. - 2y6gg - yank all files from cursor position to 12th file in the
  506. list.
  507. Visual Mode
  508. Visual mode has to generic operating submodes:
  509. - plain selection as it is in Vim;
  510. - selection editing submode.
  511. Both modes select files in range from cursor position at which visual
  512. mode was entered to current cursor position (let's call it "selection
  513. region"). Each of two borders can be adjusted by swapping them via "o"
  514. or "O" keys and updating cursor position with regular cursor motion
  515. keys. Obviously, once initial cursor position is altered this way,
  516. real start position becomes unavailable.
  517. Plain Vim-like visual mode starts with cleared selection, which is not
  518. restored on rejecting selection ("Escape", "Ctrl-C", "v", "V"). Con-
  519. trary to it, selection editing doesn't clear previously selected files
  520. and restores them after reject. Accepting selection by performing an
  521. operation on selected items (e.g. yanking them via "y") moves cursor to
  522. the top of current selection region (not to the top most selected file
  523. of the view).
  524. In turn, selection editing supports three types of editing (look at
  525. statusbar to know which one is currently active):
  526. - append - amend selection by selecting elements in selection region;
  527. - remove - amend selection by deselecting elements in selection
  528. region;
  529. - invert - amend selection by inverting selection of elements in
  530. selection region.
  531. No matter how you activate selection editing it starts in "append".
  532. One can switch type of operation (in the order given above) via "Ctrl-
  533. G" key.
  534. Almost all normal mode keys work in visual mode, but instead of accept-
  535. ing selectors they operate on selected items.
  536. Enter save selection and go back to normal mode not moving cursor.
  537. av leave visual mode if in amending mode (restores previous selec-
  538. tion), otherwise switch to amending selection mode.
  539. gv restore previous visual selection.
  540. v, V, Ctrl-C or Escape
  541. leave visual mode if not in amending mode, otherwise switch to
  542. normal visual selection.
  543. Ctrl-G switch type of amending by round robin scheme: append -> remove
  544. -> invert.
  545. : enter command line mode. Selection is cleared on leaving the
  546. mode.
  547. o switch active selection bound.
  548. O switch active selection bound.
  549. gu, u make names of selected files lowercase.
  550. gU, U make names of selected files uppercase.
  551. View Mode
  552. This mode tries to imitate the less program. List of builtin shortcuts
  553. can be found below. Shortcuts can be customized using :qmap, :qnoremap
  554. and :qunmap command-line commands.
  555. Shift-Tab, Tab, q, Q, ZZ
  556. return to normal mode.
  557. [count]e, [count]Ctrl-E, [count]j, [count]Ctrl-N, [count]Enter
  558. scroll forward one line (or [count] lines).
  559. [count]y, [count]Ctrl-Y, [count]k, [count]Ctrl-K, [count]Ctrl-P
  560. scroll backward one line (or [count] lines).
  561. [count]f, [count]Ctrl-F, [count]Ctrl-V, [count]Space
  562. scroll forward one window (or [count] lines).
  563. [count]b, [count]Ctrl-B, [count]Alt-V
  564. scroll backward one window (or [count] lines).
  565. [count]z
  566. scroll forward one window (and set window to [count]).
  567. [count]w
  568. scroll backward one window (and set window to [count]).
  569. [count]Alt-Space
  570. scroll forward one window, but don't stop at end-of-file.
  571. [count]d, [count]Ctrl-D
  572. scroll forward one half-window (and set half-window to [count]).
  573. [count]u, [count]Ctrl-U
  574. scroll backward one half-window (and set half-window to
  575. [count]).
  576. r, Ctrl-R, Ctrl-L
  577. repaint screen.
  578. R reload view preserving scroll position.
  579. F toggle automatic forwarding. Roughly equivalent to periodic
  580. file reload and scrolling to the bottom. The behaviour is simi-
  581. lar to `tail -F` or F key in less.
  582. [count]/pattern
  583. search forward for ([count]-th) matching line.
  584. [count]?pattern
  585. search backward for ([count]-th) matching line.
  586. [count]n
  587. repeat previous search (for [count]-th occurrence).
  588. [count]N
  589. repeat previous search in reverse direction (for [count]-th
  590. occurrence).
  591. [count]g, [count]<, [count]Alt-<
  592. scroll to the first line of the file (or line [count]).
  593. [count]G, [count]>, [count]Alt->
  594. scroll to the last line of the file (or line [count]).
  595. [count]p, [count]%
  596. scroll to the beginning of the file (or N percent into file).
  597. v invoke an editor to edit the current file being viewed. The
  598. command for editing is taken from the 'vicmd'/'vixcmd' option
  599. value and extended with middle line number prepended by a plus
  600. sign and name of the current file.
  601. All "Ctrl-W x" keys work the same was as in Normal mode. Active mode
  602. is automatically changed on navigating among windows. When less-like
  603. mode activated on file preview is left using one by "Ctrl-W x" keys,
  604. its state is stored until another file is displayed using preview (it's
  605. possible to leave the mode, hide preview pane, do something else, then
  606. get back to the file and show preview pane again with previously stored
  607. state in it).
  608. Command line Mode
  609. These keys are available in all submodes of the command line mode: com-
  610. mand, search, prompt and filtering.
  611. Down, Up, Left, Right, Home, End and Delete are extended keys and they
  612. are not available if vifm is compiled with --disable-extended-keys
  613. option.
  614. Esc, Ctrl-C
  615. leave command line mode, cancels input. Cancelled input is
  616. saved into appropriate history and can be recalled later.
  617. Ctrl-M, Enter
  618. execute command and leave command line mode.
  619. Ctrl-I, Tab
  620. complete command or its argument.
  621. Shift-Tab
  622. complete in reverse order.
  623. Ctrl-_ stop completion and return original input.
  624. Ctrl-B, Left
  625. move cursor to the left.
  626. Ctrl-F, Right
  627. move cursor to the right.
  628. Ctrl-A, Home
  629. go to line beginning.
  630. Ctrl-E, End
  631. go to line end.
  632. Alt-B go to the beginning of previous word.
  633. Alt-F go to the end of next word.
  634. Ctrl-U remove characters from cursor position till the beginning of
  635. line.
  636. Ctrl-K remove characters from cursor position till the end of line.
  637. Ctrl-H, Backspace
  638. remove character before the cursor.
  639. Ctrl-D, Delete
  640. remove character under the cursor.
  641. Ctrl-W remove characters from cursor position till the beginning of
  642. previous word.
  643. Alt-D remove characters from cursor position till the beginning of
  644. next word.
  645. Ctrl-T swap the order of current and previous character and move cursor
  646. forward or, if cursor past the end of line, swap the order of
  647. two last characters in the line.
  648. Alt-. insert last part of previous command to current cursor position.
  649. Each next call will insert last part of older command.
  650. Ctrl-G edit command-line content in external editor. See "Command line
  651. editing" section for details.
  652. Ctrl-N recall more recent command-line from history.
  653. Ctrl-P recall older command-line from history.
  654. Up recall more recent command-line from history, that begins as the
  655. current command-line.
  656. Down recall older command-line from history, that begins as the cur-
  657. rent command-line.
  658. Ctrl-] trigger abbreviation expansion.
  659. Pasting special values
  660. The shortcuts listed below insert specified values into current cursor
  661. position. Last key of every shortcut references value that it inserts:
  662. - c - [c]urrent file
  663. - d - [d]irectory path
  664. - e - [e]xtension of a file name
  665. - r - [r]oot part of a file name
  666. - t - [t]ail part of directory path
  667. - a - [a]utomatic filter
  668. - m - [m]anual filter
  669. - = - local filter, which is bound to "=" in normal mode
  670. Values related to filelist in current pane are available through Ctrl-X
  671. prefix, while values from the other pane have doubled Ctrl-X key as
  672. their prefix (doubled Ctrl-X is presumably easier to type than upper-
  673. case letters; it's still easy to remap the keys to correspond to names
  674. of similar macros).
  675. Ctrl-X c
  676. name of the current file of the active pane.
  677. Ctrl-X d
  678. path to the current directory of the active pane.
  679. Ctrl-X e
  680. extension of the current file of the active pane.
  681. Ctrl-X r
  682. name root of current file of the active pane.
  683. Ctrl-X t
  684. the last component of path to the current directory of the
  685. active pane.
  686. Ctrl-X Ctrl-X c
  687. name of the current file of the inactive pane.
  688. Ctrl-X Ctrl-X d
  689. path to the current directory of the inactive pane.
  690. Ctrl-X Ctrl-X e
  691. extension of the current file of the inactive pane.
  692. Ctrl-X Ctrl-X r
  693. name root of current file of the inactive pane.
  694. Ctrl-X Ctrl-X t
  695. the last component of path to the current directory of the inac-
  696. tive pane.
  697. Ctrl-X a
  698. value of automatic filter of the active pane.
  699. Ctrl-X m
  700. value of manual filter of the active pane.
  701. Ctrl-X =
  702. value of local filter of the active pane.
  703. Ctrl-X /
  704. last pattern from search history.
  705. Command line editing
  706. vifm provides a facility to edit several kinds of data, that is usually
  707. edited in command-line mode, in external editor (using command speci-
  708. fied by 'vicmd' or 'vixcmd' option). This has at least two advantages
  709. over built-in command-line mode:
  710. - one can use full power of Vim to edit text;
  711. - finding and reusing history entries becomes possible.
  712. The facility is supported by four input submodes of the command-line:
  713. - command;
  714. - forward search;
  715. - backward search;
  716. - file rename (see description of cw and cW normal mode keys).
  717. Editing command-line using external editor is activated by the Ctrl-G
  718. shortcut. It's also possible to do almost the same from Normal and
  719. Visual modes using q:, q/ and q? commands.
  720. Temporary file created for the purpose of editing the line has the fol-
  721. lowing structure:
  722. 1. First line, which is either empty or contains text already entered
  723. in command-line.
  724. 2. 2nd and all other lines with history items starting with the most
  725. recent one. Altering this lines in any way won't change history
  726. items stored by vifm.
  727. After editing application is finished the first line of the file is
  728. taken as the result of operation, when the application returns zero
  729. exit code. If the application returns an error (see :cquit command in
  730. Vim), all the edits made to the file are ignored, but the initial value
  731. of the first line is saved in appropriate history.
  732. More Mode
  733. This is the mode that appears when status bar content is so big that it
  734. doesn't fit on the screen. One can identify the mode by "-- More --"
  735. message at the bottom.
  736. The following keys are handled in this mode:
  737. Enter, Ctrl-J, j or Down
  738. scroll one line down.
  739. Backspace, k or Up
  740. scroll one line up.
  741. d scroll one page (half of a screen) down.
  742. u scroll one page (half of a screen) up.
  743. Space, f or PageDown
  744. scroll down a screen.
  745. b or PageUp
  746. scroll up a screen.
  747. G scroll to the bottom.
  748. g scroll to the top.
  749. q, Escape or Ctrl-C
  750. quit the mode.
  751. : switch to command-line mode.
  752. Commands
  753. Commands are executed with :command_name<Enter>
  754. Commented out lines should start with the double quote symbol ("),
  755. which may be preceded by whitespace characters intermixed with colons.
  756. Inline comments can be added at the end of the line after double quote
  757. symbol, only last line of a multi-line command can contain such com-
  758. ment. Not all commands support inline comments as their syntax con-
  759. flicts with names of registers and fields where double quotes are
  760. allowed.
  761. Most of the commands have two forms: complete and the short one. Exam-
  762. ple:
  763. :noh[lsearch]
  764. This means the complete command is nohlsearch, and the short one is
  765. noh.
  766. Most of command-line commands completely reset selection in the current
  767. view. However, there are several exceptions:
  768. - `:invert s` most likely leaves some files selected;
  769. - :normal command (when it doesn't leave command-line mode);
  770. - :if and :else commands don't affect selection on successful execu-
  771. tion.
  772. '|' can be used to separate commands, so you can give multiple commands
  773. in one line. If you want to use '|' in an argument, precede it with
  774. '\'.
  775. These commands see '|' as part of their arguments even when it's
  776. escaped:
  777. :[range]!
  778. :autocmd
  779. :cabbrev
  780. :cmap
  781. :cnoreabbrev
  782. :cnoremap
  783. :command
  784. :dmap
  785. :dnoremap
  786. :filetype
  787. :fileviewer
  788. :filextype
  789. :map
  790. :mmap
  791. :mnoremap
  792. :nmap
  793. :nnoremap
  794. :noremap
  795. :normal
  796. :qmap
  797. :qnoremap
  798. :vmap
  799. :vnoremap
  800. :wincmd
  801. :windo
  802. :winrun
  803. To be able to use another command after one of these, wrap it with the
  804. :execute command. An example:
  805. if filetype('.') == 'reg' | execute '!!echo regular file' | endif
  806. :[count]
  807. :number
  808. move to the file number.
  809. :12 would move to the 12th file in the list.
  810. :0 move to the top of the list.
  811. :$ move to the bottom of the list.
  812. :[count]command
  813. The only builtin :[count]command are :[count]d[elete] and
  814. :[count]y[ank].
  815. :d3 would delete three files starting at the current file position
  816. moving down.
  817. :3d would delete one file at the third line in the list.
  818. :command [args]
  819. :[range]!program
  820. execute command via shell. Accepts macros.
  821. :[range]!command &
  822. same as above, but the command is run in the background using vifm's
  823. means.
  824. Programs that write to stdout like "ls" create an error message showing
  825. partial output of the command.
  826. Note the space before ampersand symbol, if you omit it, command will be
  827. run in the background using job control of your shell.
  828. Accepts macros.
  829. :!!
  830. :[range]!!command
  831. same as :!, but pauses before returning.
  832. :!! repeat the last command.
  833. :alink
  834. :[range]alink[!?]
  835. create absolute symbolic links to files in directory of inactive
  836. view. With "?" prompts for destination file names in an edi-
  837. tor. "!" forces overwrite.
  838. :[range]alink[!] path
  839. create absolute symbolic links to files in directory specified
  840. by the path (absolute or relative to directory of inactive
  841. view).
  842. :[range]alink[!] name1 name2...
  843. create absolute symbolic links of files in directory of other
  844. view giving each next link a corresponding name from the argu-
  845. ment list.
  846. :apropos
  847. :apropos keyword...
  848. create a menu of items returned by the apropos command. Select-
  849. ing an item in the menu opens corresponding man page. By
  850. default the command relies on the external "apropos" utility,
  851. which can be customized by altering value of the 'aproposprg'
  852. option.
  853. :autocmd
  854. :au[tocmd] {event} {pat} {cmd}
  855. register autocommand for the {event}, which can be:
  856. - DirEnter - performed on entering a directory
  857. Event name is case insensitive.
  858. {pat} is a comma-separated list of modified globs patterns,
  859. which can contain tilde or environment variables. All paths use
  860. slash ('/') as directory separator. The pattern can start with
  861. a '!', which negates it. Patterns that do not contain slashes
  862. are matched against the last item of the path only (e.g. "dir"
  863. in "/path/dir"). Literal comma can be entered by doubling it.
  864. Two modifications to globs matching are as follows:
  865. - * - never matches a slash (i.e., can signify single direc-
  866. tory level)
  867. - ** - matches any character (i.e., can match path of arbi-
  868. trary depth)
  869. {cmd} is a :command or several of them separated with '|'.
  870. Examples of patterns:
  871. - conf.d - matches conf.d directory anywhere
  872. - *.d - matches directories ending with ".d" anywhere
  873. - **.git - matches something.git, but not .git anywhere
  874. - **/.git/** - matches /path/.git/objects, but not /path/.git
  875. - **/.git/**/ - matches /path/.git/ only (because of trailing
  876. slash)
  877. - /etc/* - matches /etc/conf.d/, /etc/X11, but not
  878. /etc/X11/fs
  879. - /etc/**/*.d - matches /etc/conf.d, /etc/X11/conf.d, etc.
  880. - /etc/**/* - matches /etc/ itself and any file below it
  881. - /etc/**/** - matches /etc/ itself and any file below it
  882. :au[tocmd] [{event}] [{pat}]
  883. list those autocommands that match given event-pattern combina-
  884. tion.
  885. {event} and {pat} can be omitted to list all autocommands. To
  886. list any autocommands for specific pattern one can use * place-
  887. holder in place of {event}.
  888. :au[tocmd]! [{event}] [{pat}]
  889. remove autocommands that match given event-pattern combination.
  890. Syntax is the same as for listing above.
  891. :apropos
  892. repeat last :apropos command.
  893. :bmark
  894. :bmark tag1 [tag2 [tag3...]]
  895. bookmark current directory with specified tags.
  896. :bmark! path tag1 [tag2 [tag3...]]
  897. same as :bmark, but allows bookmarking specific path instead of
  898. current directory. This is for use in vifmrc and for bookmark-
  899. ing files.
  900. Path can contain macros that expand to single path (%c, %C, %d,
  901. %D) or those that can expand to multiple paths, but contain only
  902. one (%f, %F, %rx). The latter is done for convenience on using
  903. the command interactively. Complex macros that include spaces
  904. (e.g. "%c:gs/ /_") should be escaped.
  905. :bmarks
  906. :bmarks
  907. display all bookmarks in a menu.
  908. :bmarks [tag1 [tag2...]]
  909. display menu of bookmarks that include all of the specified
  910. tags.
  911. :bmgo
  912. :bmgo [tag1 [tag2...]]
  913. when there are more than one match acts exactly like :bmarks,
  914. otherwise navigates to single match immediately (and fails if
  915. there is no match).
  916. :cabbrev
  917. :ca[bbrev]
  918. display menu of command-line mode abbreviations.
  919. :ca[bbrev] lhs-prefix
  920. display command-line mode abbreviations which left-hand side
  921. starts with specified prefix.
  922. :ca[bbrev] lhs rhs
  923. register new or overwrites existing abbreviation for command-
  924. line mode. rhs can contain spaces and any special sequences
  925. accepted in rhs of mappings (see "Mappings" section below).
  926. Abbreviations are expanded non-recursively.
  927. :cnoreabbrev
  928. :cnorea[bbrev]
  929. display menu of command-line mode abbreviations.
  930. :cnorea[bbrev] lhs-prefix
  931. display command-line mode abbreviations which left-hand side
  932. starts with specified prefix.
  933. :cnorea[bbrev] lhs rhs
  934. same as :cabbrev, but mappings in rhs are ignored during expan-
  935. sion.
  936. :cd
  937. :cd or :cd ~ or :cd $HOME
  938. change to home directory.
  939. :cd - go to the last visited directory.
  940. :cd ~/dir
  941. change directory to ~/dir.
  942. :cd /curr/dir /other/dir
  943. change directory of the current pane to /curr/dir and directory
  944. of the other pane to /other/dir. Relative paths are assumed to
  945. be relative to directory of current view. Command won't fail if
  946. one of directories is invalid. All forms of the command accept
  947. macros.
  948. :cd! /dir
  949. same as :cd /dir /dir.
  950. :change
  951. :c[hange]
  952. create a menu window to alter a files properties.
  953. :chmod
  954. :[range]chmod
  955. display file attributes (permission on *nix and properties on
  956. Windows) change dialog.
  957. :[range]chmod[!] arg...
  958. only for *nix
  959. change permissions for files. See `man 1 chmod` for arg format.
  960. "!" means set permissions recursively.
  961. :chown
  962. :[range]chown
  963. only for *nix
  964. same as co key in normal mode.
  965. :[range]chown [user][:][group]
  966. only for *nix
  967. change owner and/or group of files. Operates on directories
  968. recursively.
  969. :clone
  970. :[range]clone[!?]
  971. clones files in current directory. With "?" vifm will open vi
  972. to edit file names. "!" forces overwrite. Macros are expanded.
  973. :[range]clone[!] path
  974. clones files to directory specified with the path (absolute or
  975. relative to current directory). "!" forces overwrite. Macros
  976. are expanded.
  977. :[range]clone[!] name1 name2...
  978. clones files in current directory giving each next clone a cor-
  979. responding name from the argument list. "!" forces overwrite.
  980. Macros are expanded.
  981. :colorscheme
  982. :colo[rscheme]?
  983. print current color scheme name on the status bar.
  984. :colo[rscheme]
  985. display a menu with a list of available color schemes. You can
  986. choose primary color scheme here. It is used for view if no
  987. directory specific colorscheme fits current path. It's also
  988. used to set border color (except view titles) and colors in
  989. menus and dialogs.
  990. :colo[rscheme] color_scheme_name
  991. change primary color scheme to color_scheme_name. In case of
  992. errors (e.g. some colors are not supported by terminal) either
  993. nothing is changed or color scheme is reset to builtin colors to
  994. ensure that TUI is left in a usable state.
  995. :colo[rscheme] color_scheme_name directory
  996. associate directory with the color scheme. The directory argu-
  997. ment can be either absolute or relative path when :colorscheme
  998. command is executed from command line, but mandatory should be
  999. an absolute path when the command is executed in scripts loaded
  1000. at startup (until vifm is completely loaded).
  1001. :comclear
  1002. :comc[lear]
  1003. remove all user defined commands.
  1004. :command
  1005. :com[mand]
  1006. display a menu of user commands.
  1007. :com[mand] beginning
  1008. display user defined commands that start with the beginning.
  1009. :com[mand] name action
  1010. set a new user command.
  1011. Trying to use a reserved command name will result in an error
  1012. message.
  1013. Use :com[mand]! to overwrite a previously set command.
  1014. Unlike vim user commands do not have to start with a capital
  1015. letter. User commands are run in a shell by default. To run a
  1016. command in the background you must set it as a background com-
  1017. mand with & at the end of the commands action (:com rm rm %f &).
  1018. Command name cannot contain numbers or special symbols (except
  1019. '?' and '!').
  1020. :com[mand] name /pattern
  1021. set search pattern.
  1022. :com[mand] name =pattern
  1023. set local filter value.
  1024. :com[mand] name filter{:filter args}
  1025. set file name filter (see :filter command description). For
  1026. example:
  1027. " display only audio files
  1028. :command onlyaudio filter/.+.\(mp3|wav|mp3|flac|ogg|m4a|wma|ape\)$/i
  1029. " display everything except audio files
  1030. :command noaudio filter!/.+.\(mp3|wav|mp3|flac|ogg|m4a|wma|ape\)$/i
  1031. :com[mand] cmd :commands
  1032. set kind of an alias for internal command (like in a shell).
  1033. Passes range given to alias to an aliased command, so running
  1034. :%cp after
  1035. :command cp :copy %a
  1036. equals
  1037. :%copy
  1038. :compare
  1039. :compare [byname | bysize | bycontents | listall | listunique |
  1040. listdups | ofboth | ofone | groupids | grouppaths | skipempty]...
  1041. compare files in one or two views according the arguments. The
  1042. default is "bycontents listall ofboth grouppaths". See "Compare
  1043. views" section below for details. Tree structure is incompati-
  1044. ble with alternative representations, so values of 'lsview' and
  1045. 'millerview' options are ignored.
  1046. :copen
  1047. :cope[n]
  1048. opens menu with contents of the last displayed menu with naviga-
  1049. tion to files by default, if any.
  1050. :copy
  1051. :[range]co[py][!?][ &]
  1052. copy files to directory of other view. With "?" prompts for
  1053. destination file names in an editor. "!" forces overwrite.
  1054. :[range]co[py][!] path[ &]
  1055. copy files to directory specified with the path (absolute or
  1056. relative to directory of other view). "!" forces overwrite.
  1057. :[range]co[py][!] name1 name2...[ &]
  1058. copy files to directory of other view giving each next file a
  1059. corresponding name from the argument list. "!" forces over-
  1060. write.
  1061. :cquit
  1062. :cq[uit][!]
  1063. same as :quit, but also aborts directory choosing via
  1064. --choose-dir (empties output file) and returns non-zero exit
  1065. code.
  1066. :cunabbrev
  1067. :cuna[bbrev] lhs
  1068. unregister command-line mode abbreviation by its lhs.
  1069. :cuna[bbrev] rhs
  1070. unregister command-line mode abbreviation by its rhs, so that
  1071. abbreviation could be removed even after expansion.
  1072. :delbmarks
  1073. :delbmarks
  1074. remove bookmarks from current directory.
  1075. :delbmarks tag1 [tag2 [tag3...]]
  1076. remove set of bookmarks that include all of the specified tags.
  1077. :delbmarks!
  1078. remove all bookmarks.
  1079. :delbmarks! path1 [path2 [path3...]]
  1080. remove bookmarks of listed paths.
  1081. :delcommand
  1082. :delc[ommand] user_command
  1083. remove user defined command named user_command.
  1084. :delete
  1085. :[range]d[elete][!][ &]
  1086. delete selected file or files. "!" means complete removal
  1087. (omitting trash).
  1088. :[range]d[elete][!] [reg] [count][ &]
  1089. delete selected or [count] files to the reg register. "!" means
  1090. complete removal (omitting trash).
  1091. :delmarks
  1092. :delm[arks]!
  1093. delete all marks.
  1094. :delm[arks] marks ...
  1095. delete specified marks, each argument is treated as a set of
  1096. marks.
  1097. :display
  1098. :di[splay]
  1099. display menu with registers content.
  1100. :di[splay] list ...
  1101. display the contents of the numbered and named registers that
  1102. are mentioned in list (for example "az to display "", "a and "z
  1103. content).
  1104. :dirs
  1105. :dirs display directory stack.
  1106. :echo
  1107. :ec[ho] [<expr>...]
  1108. evaluate each argument as an expression and output them sepa-
  1109. rated with a space. See help on :let command for a definition
  1110. of <expr>.
  1111. :edit
  1112. :[range]e[dit] [file...]
  1113. open selected or passed file(s) in editor. Macros and environ-
  1114. ment variables are expanded.
  1115. :else
  1116. :el[se]
  1117. execute commands until next matching :endif if all other condi-
  1118. tions didn't match. See also help on :if and :endif commands.
  1119. :elseif
  1120. :elsei[f] {expr1}
  1121. execute commands until next matching :elseif, :else or :endif if
  1122. conditions of previous :if and :elseif branches were evaluated
  1123. to zero. See also help on :if and :endif commands.
  1124. :empty
  1125. :empty permanently remove files from all existing non-empty trash
  1126. directories (see "Trash directory" section below). Trash direc-
  1127. tories which are specified via %r and/or %u also get deleted
  1128. completely. Also remove all operations from undolist that have
  1129. no sense after :empty and remove all records about files located
  1130. inside directories from all registers. Removal is performed as
  1131. background task with undetermined amount of work and can be
  1132. checked via :jobs menu.
  1133. :endif
  1134. :en[dif]
  1135. end conditional block. See also help on :if and :else commands.
  1136. :execute
  1137. :exe[cute] [<expr>...]
  1138. evaluate each argument as an expression and join results sepa-
  1139. rated by a space to get a single string which is then executed
  1140. as a command-line command. See help on :let command for a defi-
  1141. nition of <expr>.
  1142. :exit
  1143. :exi[t][!]
  1144. same as :quit.
  1145. :file
  1146. :f[ile][ &]
  1147. display menu of programs set for the file type of the current
  1148. file. " &" forces running associated program in background.
  1149. :f[ile] arg[ &]
  1150. run associated command that begins with the arg skipping opening
  1151. menu. " &" forces running associated program in background.
  1152. :filetype
  1153. :filet[ype] pattern-list [{descr}]def_prog[ &],[{descr}]prog2[ &],...
  1154. associate given program list to each of the patterns. Associ-
  1155. ated program (command) is used by handlers of l and Enter keys
  1156. (and also in the :file menu). If you need to insert comma into
  1157. command just double it (",,"). Space followed by an ampersand
  1158. as two last characters of a command means running of the command
  1159. in the background. Optional description can be given to each
  1160. command to ease understanding of what command will do in the
  1161. :file menu. Vifm will try the rest of the programs for an asso-
  1162. ciation when the default isn't found. When program entry
  1163. doesn't contain any of vifm macros, name of current file is
  1164. appended as if program entry ended with %c macro on *nix and %"c
  1165. on Windows. On Windows path to executables containing spaces
  1166. can (and should be for correct work with such paths) be double
  1167. quoted. See "Patterns" section below for pattern definition.
  1168. See also "Automatic FUSE mounts" section below. Example for zip
  1169. archives and several actions:
  1170. filetype *.zip,*.jar,*.war,*.ear
  1171. \ {Mount with fuse-zip}
  1172. \ FUSE_MOUNT|fuse-zip %SOURCE_FILE %DESTINATION_DIR,
  1173. \ {View contents}
  1174. \ zip -sf %c | less,
  1175. \ {Extract here}
  1176. \ tar -xf %c,
  1177. Note that on OS X when `open` is used to call an app, vifm is
  1178. unable to check whether that app is actually available. So if
  1179. automatic skipping of programs that aren't there is desirable,
  1180. `open` should be replaced with an actual command.
  1181. :filet[ype] filename
  1182. list (in menu mode) currently registered patterns that match
  1183. specified file name. Same as ":filextype filename".
  1184. :filextype
  1185. :filex[type] pattern-list [{ description }] def_program,program2,...
  1186. same as :filetype, but this command is ignored if not running in
  1187. X. In X :filextype is equal to :filetype. See "Patterns" sec-
  1188. tion below for pattern definition. See also "Automatic FUSE
  1189. mounts" section below.
  1190. For example, consider the following settings (the order might
  1191. seem strange, but it's for the demonstration purpose):
  1192. filetype *.html,*.htm
  1193. \ {View in lynx}
  1194. \ lynx
  1195. filextype *.html,*.htm
  1196. \ {Open with dwb}
  1197. \ dwb %f %i &,
  1198. filetype *.html,*.htm
  1199. \ {View in links}
  1200. \ links
  1201. filextype *.html,*.htm
  1202. \ {Open with firefox}
  1203. \ firefox %f &,
  1204. \ {Open with uzbl}
  1205. \ uzbl-browser %f %i &,
  1206. If you're using vifm inside a terminal emulator that is running
  1207. in graphical environment (when X is used on *nix; always on Win-
  1208. dows), vifm attempts to run application in this order:
  1209. 1. lynx
  1210. 2. dwb
  1211. 3. links
  1212. 4. firefox
  1213. 5. uzbl
  1214. If there is no graphical environment (checked presence of $DIS-
  1215. PLAY environment variable on *nix; never happens on Windows),
  1216. the list will look like:
  1217. 1. lynx
  1218. 2. links
  1219. Just as if all :filextype commands were not there.
  1220. The purpose of such differentiation is to allow comfortable use
  1221. of vifm with same settings in desktop environment/through remote
  1222. connection (SSH)/in native console.
  1223. Note that on OS X $DISPLAY isn't defined unless you define it,
  1224. so :filextype should be used only if you set $DISPLAY in some
  1225. way.
  1226. :filext[ype] filename
  1227. list (in menu mode) currently registered patterns that match
  1228. specified file name. Same as ":filetype filename".
  1229. :fileviewer
  1230. :filev[iewer] pattern-list command1,command2,...
  1231. register specified list of commands as viewers for each of the
  1232. patterns. Viewer is a command which output is captured and dis-
  1233. played in one of the panes of vifm after pressing "e" or running
  1234. :view command. When the command doesn't contain any of vifm
  1235. macros, name of current file is appended as if command ended
  1236. with %c macro. Comma escaping and missing commands processing
  1237. rules as for :filetype apply to this command. See "Patterns"
  1238. section below for pattern definition.
  1239. Example for zip archives:
  1240. fileviewer *.zip,*.jar,*.war,*.ear zip -sf %c, echo "No zip to preview:"
  1241. :filev[iewer] filename
  1242. list (in menu mode) currently registered patterns that match
  1243. specified filename.
  1244. :filter
  1245. :filter[!] {pattern}
  1246. filter files matching the pattern out of directory listings.
  1247. '!' controls state of filter inversion after updating filter
  1248. value (see also 'cpoptions' description). Filter is matched
  1249. case sensitively on *nix and case insensitively on Windows. See
  1250. "File Filters" and "Patterns" sections.
  1251. Example:
  1252. " filter all files ending in .o from the filelist.
  1253. :filter /.o$/
  1254. :filter[!] {empty-pattern}
  1255. same as above, but use last search pattern as pattern value.
  1256. Example:
  1257. :filter //I
  1258. :filter
  1259. reset filter (set it to an empty string) and show all files.
  1260. :filter!
  1261. same as :invert.
  1262. :filter?
  1263. show information on local, name and auto filters.
  1264. :find
  1265. :[range]fin[d] pattern
  1266. display results of find command in the menu. Searches among
  1267. selected files if any. Accepts macros. By default the command
  1268. relies on the external "find" utility, which can be customized
  1269. by altering value of the 'findprg' option.
  1270. :[range]fin[d] -opt...
  1271. same as :find above, but user defines all find arguments.
  1272. Searches among selected files if any.
  1273. :[range]fin[d] path -opt...
  1274. same as :find above, but user defines all find arguments.
  1275. Ignores selection and range.
  1276. :[range]fin[d]
  1277. repeat last :find command.
  1278. :finish
  1279. :fini[sh]
  1280. stop sourcing a script. Can only be used in a vifm script file.
  1281. This is a quick way to skip the rest of the file.
  1282. :goto
  1283. :go[to]
  1284. change directory if necessary and put specified path under the
  1285. cursor. The path should be existing non-root path. Macros and
  1286. environment variables are expanded.
  1287. :grep
  1288. :[range]gr[ep][!] pattern
  1289. will show results of grep command in the menu. Add "!" to
  1290. request inversion of search (look for lines that do not match
  1291. pattern). Searches among selected files if any and no range
  1292. given. Ignores binary files by default. By default the command
  1293. relies on the external "grep" utility, which can be customized
  1294. by altering value of the 'grepprg' option.
  1295. :[range]gr[ep][!] -opt...
  1296. same as :grep above, but user defines all grep arguments, which
  1297. are not escaped. Searches among selected files if any.
  1298. :[range]gr[ep][!]
  1299. repeats last :grep command. "!" of this command inverts "!" in
  1300. repeated command.
  1301. :help
  1302. :h[elp]
  1303. show the help file.
  1304. :h[elp] argument
  1305. is the same as using ':h argument' in vim. Use vifm-<something>
  1306. to get help on vifm (tab completion works). This form of the
  1307. command doesn't work when 'vimhelp' option is off.
  1308. :highlight
  1309. :hi[ghlight]
  1310. display information about all highlight groups active at the
  1311. moment.
  1312. :hi[ghlight] clear
  1313. reset all highlighting to builtin defaults and removed all file-
  1314. name-specific rules.
  1315. :hi[ghlight] clear ( {pat1,pat2,...} | /regexp/ )
  1316. removes specified rule.
  1317. :hi[ghlight] ( group-name | {pat1,pat2,...} | /regexp/ )
  1318. display information on given highlight group or file name pat-
  1319. tern of color scheme used in the active view.
  1320. :hi[ghlight] ( group-name | {pat1,pat2,...} | /regexp/[iI] )
  1321. cterm=style | ctermfg=color | ctermbg=color
  1322. set style (cterm), foreground (ctermfg) or/and background
  1323. (ctermbg) parameters of highlight group or file name pattern for
  1324. color scheme used in the active view.
  1325. All style values as well as color names are case insensitive.
  1326. Available style values (some of them can be combined):
  1327. - bold
  1328. - underline
  1329. - reverse or inverse
  1330. - standout
  1331. - italic (on unsupported systems becomes reverse)
  1332. - none
  1333. Available group-name values:
  1334. - Win - color of all windows (views, dialogs, menus) and default color
  1335. for their content (e.g. regular files in views)
  1336. - AuxWin - color of auxiliary areas of windows
  1337. - Border - color of vertical parts of the border
  1338. - TabLine - tab line color
  1339. - TabLineSel - color of the tip of selected tab
  1340. - TopLineSel - top line color of the current pane
  1341. - TopLine - top line color of the other pane
  1342. - CmdLine - the command line/status bar color
  1343. - ErrorMsg - color of error messages in the status bar
  1344. - StatusLine - color of the line above the status bar
  1345. - JobLine - color of job line that appears above the status line
  1346. - WildMenu - color of the wild menu items
  1347. - SuggestBox - color of key suggestion box
  1348. - CurrLine - line at cursor position in active view
  1349. - OtherLine - line at cursor position in inactive view
  1350. - Selected - color of selected files
  1351. - Directory - color of directories
  1352. - Link - color of symbolic links in the views
  1353. - BrokenLink - color of broken symbolic links
  1354. - Socket - color of sockets
  1355. - Device - color of block and character devices
  1356. - Executable - color of executable files
  1357. - Fifo - color of fifo pipes
  1358. - CmpMismatch - color of mismatched files in side-by-side comparison
  1359. by path
  1360. - User1..User9 - 9 colors which can be used via %* 'statusline' macro
  1361. Available colors:
  1362. - -1 or default or none - default or transparent
  1363. - black and lightblack
  1364. - red and lightred
  1365. - green and lightgreen
  1366. - yellow and lightyellow
  1367. - blue and lightblue
  1368. - magenta and lightmagenta
  1369. - cyan and lightcyan
  1370. - white and lightwhite
  1371. - 0-255 - corresponding colors from 256-color palette
  1372. Light versions of colors are regular colors with bold attribute set.
  1373. So order of arguments of :highlight command is important and it's bet-
  1374. ter to put "cterm" in front of others to prevent it from overwriting
  1375. attributes set by "ctermfg" or "ctermbg" arguments.
  1376. For convenience of color scheme authors xterm-like names for 256 color
  1377. palette is also supported. The mapping is taken from
  1378. http://vim.wikia.com/wiki/Xterm256_color_names_for_console_Vim Dupli-
  1379. cated entries were altered by adding an underscore followed by numeri-
  1380. cal suffix.
  1381. 0 Black 86 Aquamarine1 172 Orange3
  1382. 1 Red 87 DarkSlateGray2 173 LightSalmon3_2
  1383. 2 Green 88 DarkRed_2 174 LightPink3
  1384. 3 Yellow 89 DeepPink4_2 175 Pink3
  1385. 4 Blue 90 DarkMagenta 176 Plum3
  1386. 5 Magenta 91 DarkMagenta_2 177 Violet
  1387. 6 Cyan 92 DarkViolet 178 Gold3_2
  1388. 7 White 93 Purple 179 LightGoldenrod3
  1389. 8 LightBlack 94 Orange4_2 180 Tan
  1390. 9 LightRed 95 LightPink4 181 MistyRose3
  1391. 10 LightGreen 96 Plum4 182 Thistle3
  1392. 11 LightYellow 97 MediumPurple3 183 Plum2
  1393. 12 LightBlue 98 MediumPurple3_2 184 Yellow3_2
  1394. 13 LightMagenta 99 SlateBlue1 185 Khaki3
  1395. 14 LightCyan 100 Yellow4 186 LightGoldenrod2
  1396. 15 LightWhite 101 Wheat4 187 LightYellow3
  1397. 16 Grey0 102 Grey53 188 Grey84
  1398. 17 NavyBlue 103 LightSlateGrey 189 LightSteelBlue1
  1399. 18 DarkBlue 104 MediumPurple 190 Yellow2
  1400. 19 Blue3 105 LightSlateBlue 191 DarkOliveGreen1
  1401. 20 Blue3_2 106 Yellow4_2 192 DarkOliveG-
  1402. reen1_2
  1403. 21 Blue1 107 DarkOliveGreen3 193 DarkSeaGreen1_2
  1404. 22 DarkGreen 108 DarkSeaGreen 194 Honeydew2
  1405. 23 DeepSkyBlue4 109 LightSkyBlue3 195 LightCyan1
  1406. 24 DeepSkyBlue4_2 110 LightSkyBlue3_2 196 Red1
  1407. 25 DeepSkyBlue4_3 111 SkyBlue2 197 DeepPink2
  1408. 26 DodgerBlue3 112 Chartreuse2_2 198 DeepPink1
  1409. 27 DodgerBlue2 113 DarkOliveGreen3_2 199 DeepPink1_2
  1410. 28 Green4 114 PaleGreen3_2 200 Magenta2_2
  1411. 29 SpringGreen4 115 DarkSeaGreen3 201 Magenta1
  1412. 30 Turquoise4 116 DarkSlateGray3 202 OrangeRed1
  1413. 31 DeepSkyBlue3 117 SkyBlue1 203 IndianRed1
  1414. 32 DeepSkyBlue3_2 118 Chartreuse1 204 IndianRed1_2
  1415. 33 DodgerBlue1 119 LightGreen_2 205 HotPink
  1416. 34 Green3 120 LightGreen_3 206 HotPink_2
  1417. 35 SpringGreen3 121 PaleGreen1 207 MediumOrchid1_2
  1418. 36 DarkCyan 122 Aquamarine1_2 208 DarkOrange
  1419. 37 LightSeaGreen 123 DarkSlateGray1 209 Salmon1
  1420. 38 DeepSkyBlue2 124 Red3 210 LightCoral
  1421. 39 DeepSkyBlue1 125 DeepPink4_3 211 PaleVioletRed1
  1422. 40 Green3_2 126 MediumVioletRed 212 Orchid2
  1423. 41 SpringGreen3_2 127 Magenta3 213 Orchid1
  1424. 42 SpringGreen2 128 DarkViolet_2 214 Orange1
  1425. 43 Cyan3 129 Purple_2 215 SandyBrown
  1426. 44 DarkTurquoise 130 DarkOrange3 216 LightSalmon1
  1427. 45 Turquoise2 131 IndianRed 217 LightPink1
  1428. 46 Green1 132 HotPink3 218 Pink1
  1429. 47 SpringGreen2_2 133 MediumOrchid3 219 Plum1
  1430. 48 SpringGreen1 134 MediumOrchid 220 Gold1
  1431. 49 MediumSpringGreen 135 MediumPurple2 221 LightGolden-
  1432. rod2_2
  1433. 50 Cyan2 136 DarkGoldenrod 222 LightGolden-
  1434. rod2_3
  1435. 51 Cyan1 137 LightSalmon3 223 NavajoWhite1
  1436. 52 DarkRed 138 RosyBrown 224 MistyRose1
  1437. 53 DeepPink4 139 Grey63 225 Thistle1
  1438. 54 Purple4 140 MediumPurple2_2 226 Yellow1
  1439. 55 Purple4_2 141 MediumPurple1 227 LightGoldenrod1
  1440. 56 Purple3 142 Gold3 228 Khaki1
  1441. 57 BlueViolet 143 DarkKhaki 229 Wheat1
  1442. 58 Orange4 144 NavajoWhite3 230 Cornsilk1
  1443. 59 Grey37 145 Grey69 231 Grey100
  1444. 60 MediumPurple4 146 LightSteelBlue3 232 Grey3
  1445. 61 SlateBlue3 147 LightSteelBlue 233 Grey7
  1446. 62 SlateBlue3_2 148 Yellow3 234 Grey11
  1447. 63 RoyalBlue1 149 DarkOliveGreen3_3 235 Grey15
  1448. 64 Chartreuse4 150 DarkSeaGreen3_2 236 Grey19
  1449. 65 DarkSeaGreen4 151 DarkSeaGreen2 237 Grey23
  1450. 66 PaleTurquoise4 152 LightCyan3 238 Grey27
  1451. 67 SteelBlue 153 LightSkyBlue1 239 Grey30
  1452. 68 SteelBlue3 154 GreenYellow 240 Grey35
  1453. 69 CornflowerBlue 155 DarkOliveGreen2 241 Grey39
  1454. 70 Chartreuse3 156 PaleGreen1_2 242 Grey42
  1455. 71 DarkSeaGreen4_2 157 DarkSeaGreen2_2 243 Grey46
  1456. 72 CadetBlue 158 DarkSeaGreen1 244 Grey50
  1457. 73 CadetBlue_2 159 PaleTurquoise1 245 Grey54
  1458. 74 SkyBlue3 160 Red3_2 246 Grey58
  1459. 75 SteelBlue1 161 DeepPink3 247 Grey62
  1460. 76 Chartreuse3_2 162 DeepPink3_2 248 Grey66
  1461. 77 PaleGreen3 163 Magenta3_2 249 Grey70
  1462. 78 SeaGreen3 164 Magenta3_3 250 Grey74
  1463. 79 Aquamarine3 165 Magenta2 251 Grey78
  1464. 80 MediumTurquoise 166 DarkOrange3_2 252 Grey82
  1465. 81 SteelBlue1_2 167 IndianRed_2 253 Grey85
  1466. 82 Chartreuse2 168 HotPink3_2 254 Grey89
  1467. 83 SeaGreen2 169 HotPink2 255 Grey93
  1468. 84 SeaGreen1 170 Orchid
  1469. 85 SeaGreen1_2 171 MediumOrchid1
  1470. There are two colors (foreground and background) and only one bold
  1471. attribute. Thus single bold attribute affects both colors when
  1472. "reverse" attribute is used in vifm run inside terminal emulator. At
  1473. the same time linux native console can handle boldness of foreground
  1474. and background colors independently, but for consistency with terminal
  1475. emulators this is available only implicitly by using light versions of
  1476. colors. This behaviour might be changed in the future.
  1477. Although vifm supports 256 colors in a sense they are supported by UI
  1478. drawing library, whether you will be able to use all of them highly
  1479. depends on your terminal. To set up terminal properly, make sure that
  1480. $TERM in the environment you run vifm is set to name of 256-color ter-
  1481. minal (on *nixes it can also be set via X resources), e.g.
  1482. xterm-256color. One can find list of available terminal names by list-
  1483. ing /usr/lib/terminfo/. Number of colors supported by terminal with
  1484. current settings can be checked via "tput colors" command.
  1485. Here is the hierarchy of highlight groups, which you need to know for
  1486. using transparency:
  1487. JobLine
  1488. SuggestBox
  1489. StatusLine
  1490. WildMenu
  1491. User1..User9
  1492. Border
  1493. CmdLine
  1494. ErrorMsg
  1495. Win
  1496. AuxWin
  1497. File name specific highlights
  1498. Directory
  1499. Link
  1500. BrokenLink
  1501. Socket
  1502. Device
  1503. Fifo
  1504. Executable
  1505. Selected
  1506. CurrLine
  1507. OtherLine
  1508. TopLine
  1509. TopLineSel
  1510. TabLine
  1511. TabLineSel
  1512. "none" means default terminal color for highlight groups at the first
  1513. level of the hierarchy and transparency for all others.
  1514. Here file name specific highlights mean those configured via globs ({})
  1515. or regular expressions (//). At most one of them is applied per file
  1516. entry, namely the first that matches file name, hence order of :high-
  1517. light commands might be important in certain cases.
  1518. :history
  1519. :his[tory]
  1520. creates a pop-up menu of directories visited.
  1521. :his[tory] x
  1522. x can be:
  1523. d[ir] or . show directory history.
  1524. c[md] or : show command line history.
  1525. s[earch] or / show search history and search forward on l key.
  1526. f[search] or / show search history and search forward on l key.
  1527. b[search] or ? show search history and search backward on l key.
  1528. i[nput] or @ show prompt history (e.g. on one file renaming).
  1529. fi[lter] or = show filter history (see description of the "="
  1530. normal mode command).
  1531. :histnext
  1532. :histnext
  1533. same as <c-i>. The main use case for this command is to work
  1534. around the common pain point of <tab> and <c-i> being the same
  1535. ASCII character: one could alter the terminal emulator settings
  1536. to emit, for example, the `F1` keycode when Ctrl-I is pressed,
  1537. then `:noremap <f1> :histnext<cr>` in vifm, add "t" flag to the
  1538. 'cpoptions', and thus have both <c-i> and <tab> working as
  1539. expected.
  1540. :histprev
  1541. :histprev
  1542. same as <c-o>.
  1543. :if
  1544. :if {expr1}
  1545. starts conditional block. Commands are executed until next
  1546. matching :elseif, :else or :endif command if {expr1} evaluates
  1547. to non-zero, otherwise they are ignored. See also help on :else
  1548. and :endif commands.
  1549. Example:
  1550. if $TERM == 'screen.linux'
  1551. highlight CurrLine ctermfg=lightwhite ctermbg=lightblack
  1552. elseif $TERM == 'tmux'
  1553. highlight CurrLine cterm=reverse ctermfg=black ctermbg=white
  1554. else
  1555. highlight CurrLine cterm=bold,reverse ctermfg=black ctermbg=white
  1556. endif
  1557. :invert
  1558. :invert [f]
  1559. invert file name filter.
  1560. :invert? [f]
  1561. show current filter state.
  1562. :invert s
  1563. invert selection.
  1564. :invert o
  1565. invert sorting order of the primary sorting key.
  1566. :invert? o
  1567. show sorting order of the primary sorting key.
  1568. :jobs
  1569. :jobs shows menu of current backgrounded processes.
  1570. :let
  1571. :let $ENV_VAR = <expr>
  1572. sets environment variable. Warning: setting environment vari-
  1573. able to an empty string on Windows removes it.
  1574. :let $ENV_VAR .= <expr>
  1575. append value to environment variable.
  1576. :let &[l:|g:]opt = <expr>
  1577. sets option value.
  1578. :let &[l:|g:]opt .= <expr>
  1579. append value to string option.
  1580. :let &[l:|g:]opt += <expr>
  1581. increasing option value, adding sub-values.
  1582. :let &[l:|g:]opt -= <expr>
  1583. decreasing option value, removing sub-values.
  1584. Where <expr> could be a single-quoted string, double-quoted string, an
  1585. environment variable, function call or a concatanation of any of them
  1586. in any order using the '.' operator. Any whitespace is ignored.
  1587. :locate
  1588. :locate filename
  1589. use "locate" command to create a menu of filenames. Selecting a
  1590. file from the menu will reload the current file list in vifm to
  1591. show the selected file. By default the command relies on the
  1592. external "locate" utility (it's assumed that its database is
  1593. already built), which can be customized by altering value of the
  1594. 'locateprg' option.
  1595. :locate
  1596. repeats last :locate command.
  1597. :ls
  1598. :ls lists windows of active terminal multiplexer (only when terminal
  1599. multiplexer is used). This is achieved by issuing proper com-
  1600. mand for active terminal multiplexer, thus the list is not han-
  1601. dled by vifm.
  1602. :lstrash
  1603. :lstrash
  1604. displays a menu with list of files in trash. Each element of
  1605. the list is original path of a deleted file, thus the list can
  1606. contain duplicates.
  1607. :mark
  1608. :[range]ma[rk][?] x [/full/path] [filename]
  1609. Set mark x (a-zA-Z0-9) at /full/path and filename. By default
  1610. current directory is being used. If no filename was given and
  1611. /full/path is current directory then last file in [range] is
  1612. used. Using of macros is allowed. Question mark will stop com-
  1613. mand from overwriting existing marks.
  1614. :marks
  1615. :marks create a pop-up menu of marks.
  1616. :marks list ...
  1617. display the contents of the marks that are mentioned in list.
  1618. :media
  1619. :media only for *nix
  1620. display media management menu. See also 'mediaprg' option.
  1621. :messages
  1622. :mes[sages]
  1623. shows previously given messages (up to 50).
  1624. :mkdir
  1625. :[line]mkdir[!] dir ...
  1626. create directories at specified paths. The [line] can be used
  1627. to pick node in a tree-view. "!" means make parent directories
  1628. as needed. Macros are expanded.
  1629. :move
  1630. :[range]m[ove][!?][ &]
  1631. move files to directory of other view. With "?" prompts for
  1632. destination file names in an editor. "!" forces overwrite.
  1633. :[range]m[ove][!] path[ &]
  1634. move files to directory specified with the path (absolute or
  1635. relative to directory of other view). "!" forces overwrite.
  1636. :[range]m[ove][!] name1 name2...[ &]
  1637. move files to directory of other view giving each next file a
  1638. corresponding name from the argument list. "!" forces over-
  1639. write.
  1640. :nohlsearch
  1641. :noh[lsearch]
  1642. clear selection in current pane.
  1643. :normal
  1644. :norm[al][!] commands
  1645. execute normal mode commands. If "!" is used, user defined map-
  1646. pings are ignored. Unfinished last command is aborted as if
  1647. <esc> or <c-c> was typed. A ":" should be completed as well.
  1648. Commands can't start with a space, so put a count of 1 (one)
  1649. before it.
  1650. :only
  1651. :on[ly]
  1652. switch to a one window view.
  1653. :popd
  1654. :popd remove pane directories from stack.
  1655. :pushd
  1656. :pushd[!] /curr/dir [/other/dir]
  1657. add pane directories to stack and process arguments like :cd
  1658. command.
  1659. :pushd exchange the top two items of the directory stack.
  1660. :put
  1661. :[line]pu[t][!] [reg] [ &]
  1662. puts files from specified register (" by default) into current
  1663. directory. The [line] can be used to pick node in a tree-view.
  1664. "!" moves files "!" moves files from their original location
  1665. instead of copying them. During this operation no confirmation
  1666. dialogs will be shown, all checks are performed beforehand.
  1667. :pwd
  1668. :pw[d] show the present working directory.
  1669. :qall
  1670. :qa[ll][!]
  1671. exit vifm (add ! to skip saving changes and checking for active
  1672. backgrounded commands).
  1673. :quit
  1674. :q[uit][!]
  1675. if there is more than one tab, close the current one, otherwise
  1676. exit vifm (add ! to skip saving changes and checking for active
  1677. backgrounded commands).
  1678. :redraw
  1679. :redr[aw]
  1680. redraw the screen immediately.
  1681. :registers
  1682. :reg[isters]
  1683. display menu with registers content.
  1684. :reg[isters] list ...
  1685. display the contents of the numbered and named registers that
  1686. are mentioned in list (for example "az to display "", "a and "z
  1687. content).
  1688. :regular
  1689. :regular
  1690. switch to regular view leaving custom view.
  1691. :rename
  1692. :[range]rename[!]
  1693. rename files using vi to edit names. ! means go recursively
  1694. through directories.
  1695. :[range]rename name1 name2...
  1696. rename each of selected files to a corresponding name.
  1697. :restart
  1698. :restart
  1699. free a lot of things (histories, commands, etc.), reread
  1700. vifminfo and vifmrc files and run startup commands passed in the
  1701. argument list, thus losing all unsaved changes (e.g. recent his-
  1702. tory or keys mapped in current session).
  1703. :restore
  1704. :[range]restore
  1705. restore file from trash directory, doesn't work outside one of
  1706. trash directories. See "Trash directory" section below.
  1707. :rlink
  1708. :[range]rlink[!?]
  1709. create relative symbolic links to files in directory of other
  1710. view. With "?" prompts for destination file names in an editor.
  1711. "!" forces overwrite.
  1712. :[range]rlink[!] path
  1713. create relative symbolic links of files in directory specified
  1714. with the path (absolute or relative to directory of other view).
  1715. "!" forces overwrite.
  1716. :[range]rlink[!] name1 name2...
  1717. create relative symbolic links of files in directory of other
  1718. view giving each next link a corresponding name from the argu-
  1719. ment list. "!" forces overwrite.
  1720. :screen
  1721. :screen
  1722. toggle whether to use the terminal multiplexer or not.
  1723. A terminal multiplexer uses pseudo terminals to allow multiple
  1724. windows to be used in the console or in a single xterm. Start-
  1725. ing vifm from terminal multiplexer with appropriate support
  1726. turned on will cause vifm to open a new terminal multiplexer
  1727. window for each new file edited or program launched from vifm.
  1728. This requires screen version 3.9.9 or newer for the screen -X
  1729. argument or tmux (1.8 version or newer is recommended).
  1730. :screen!
  1731. enable integration with terminal multiplexers.
  1732. :screen?
  1733. display whether integration with terminal multiplexers is
  1734. enabled.
  1735. Note: the command is called screen for historical reasons (when tmux
  1736. wasn't yet supported) and might be changed in future releases, or get
  1737. an alias.
  1738. :select
  1739. :[range]select
  1740. select files in the given range (current file if no range is
  1741. given).
  1742. :select {pattern}
  1743. select files that match specified pattern. Possible {pattern}
  1744. forms are described in "Patterns" section below. Trailing slash
  1745. for directories is taken into account, so `:select! */ | invert
  1746. s` selects only files.
  1747. :select //[iI]
  1748. same as item above, but reuses last search pattern.
  1749. :select !{external command}
  1750. select files from the list supplied by external command. Files
  1751. are matched by full paths, relative paths are converted to abso-
  1752. lute ones beforehand.
  1753. :[range]select! [{pattern}]
  1754. same as above, but resets previously selected items before pro-
  1755. ceeding.
  1756. :set
  1757. :se[t] display all options that differ from their default value.
  1758. :se[t] all
  1759. display all options.
  1760. :se[t] opt1=val1 opt2='val2' opt3="val3" ...
  1761. sets given options. For local options both values are set.
  1762. You can use following syntax:
  1763. - for all options - option, option? and option&
  1764. - for boolean options - nooption, invoption and option!
  1765. - for integer options - option=x, option+=x and option-=x
  1766. - for string options - option=x and option+=x
  1767. - for string list options - option=x, option+=x and option-=x
  1768. - for enumeration options - option=x, option+=x and option-=x
  1769. - for set options - option=x, option+=x and option-=x
  1770. - for charset options - option=x, option+=x, option-=x and
  1771. option^=x
  1772. the meaning:
  1773. - option - turn option on (for boolean) or print its value (for
  1774. all others)
  1775. - nooption - turn option off
  1776. - invoption - invert option state
  1777. - option! - invert option state
  1778. - option? - print option value
  1779. - option& - reset option to its default value
  1780. - option=x or option:x - set option to x
  1781. - option+=x - add/append x to option
  1782. - option-=x - remove (or subtract) x from option
  1783. - option^=x - toggle x presence among values of the option
  1784. Option name can be prepended and appended by any number of
  1785. whitespace characters.
  1786. :setglobal
  1787. :setg[lobal]
  1788. display all global options that differ from their default value.
  1789. :setg[lobal] all
  1790. display all global options.
  1791. :setg[lobal] opt1=val1 opt2='val2' opt3="val3" ...
  1792. same as :set, but changes/prints only global options or global
  1793. values of local options. Changes to the latter might be not
  1794. visible until directory is changed.
  1795. :setlocal
  1796. :setl[ocal]
  1797. display all local options that differ from their default value.
  1798. :setl[ocal] all
  1799. display all local options.
  1800. :setl[ocal] opt1=val1 opt2='val2' opt3="val3" ...
  1801. same as :set, but changes/prints only local values of local
  1802. options.
  1803. :shell
  1804. :sh[ell][!]
  1805. start a shell in current directory. "!" suppresses spawning
  1806. dedicated window of terminal multiplexer for a shell. To make
  1807. vifm adaptive to environment it uses $SHELL if it's defined,
  1808. otherwise 'shell' value is used.
  1809. :siblnext
  1810. :[count]siblnext[!]
  1811. change directory to [count]th next sibling directory after cur-
  1812. rent path using value of global sort option of current pane.
  1813. "!" enables wrapping.
  1814. For example, say, you're at /boot and root listing starts like
  1815. this:
  1816. bin/
  1817. boot/
  1818. dev/
  1819. ...
  1820. Issuing :siblnext will navigate to /dev.
  1821. :siblprev
  1822. :[count]siblprev[!]
  1823. same as :siblnext, but in the opposite direction.
  1824. :sort
  1825. :sor[t]
  1826. display dialog with different sorting methods, when one can
  1827. select primary sorting key. When 'viewcolumns' options is empty
  1828. and 'lsview' is off, changing primary sorting key will also
  1829. affect view look (in particular the second column of the view
  1830. will be changed).
  1831. :source
  1832. :so[urce] file
  1833. read command-line commands from the file.
  1834. :split
  1835. :sp[lit]
  1836. switch to a two window horizontal view.
  1837. :sp[lit]!
  1838. toggle horizontal window splitting.
  1839. :sp[lit] path
  1840. splits the window horizontally to show both file directories.
  1841. Also changes other pane to path (absolute or relative to current
  1842. directory of active pane).
  1843. :substitute
  1844. :[range]s[ubstitute]/pattern/string/[flags]
  1845. for each file in range replace a match of pattern with string.
  1846. String can contain \0...\9 to link to capture groups (\0 - all match,
  1847. \1 - first group, etc.).
  1848. Pattern is stored in search history.
  1849. Available flags:
  1850. - i - ignore case (the 'ignorecase' and 'smartcase' options are not
  1851. used)
  1852. - I - don't ignore case (the 'ignorecase' and 'smartcase' options are
  1853. not used)
  1854. - g - substitute all matches in each file name (each g toggles this)
  1855. :[range]s[ubstitute]/pattern
  1856. substitute pattern with an empty string.
  1857. :[range]s[ubstitute]//string/[flags]
  1858. use last pattern from search history.
  1859. :[range]s[ubstitute]
  1860. repeat previous substitution command.
  1861. :sync
  1862. :sync [relative path]
  1863. change the other pane to the current pane directory or to some
  1864. path relative to the current directory. Using macros is
  1865. allowed.
  1866. :sync! change the other pane to the current pane directory and synchro-
  1867. nize cursor position. If current pane displays custom list of
  1868. files, position before entering it is used (current one might
  1869. not make any sense).
  1870. :sync! [location | cursorpos | localopts | filters | filelist | tree |
  1871. all]...
  1872. change enumerated properties of the other pane to match corre-
  1873. sponding properties of the current pane. Arguments have the
  1874. following meanings:
  1875. - location - current directory of the pane;
  1876. - cursorpos - cursor position (doesn't make sense without
  1877. "location");
  1878. - localopts - all local options;
  1879. - filters - all filters;
  1880. - filelist - list of files for custom view (implies "loca-
  1881. tion");
  1882. - tree - tree structure for tree view (implies "location");
  1883. - all - all of the above.
  1884. :tabclose
  1885. :tabc[lose]
  1886. close current tab, unless it's the only one open at current
  1887. scope.
  1888. :tabmove
  1889. :tabm[ove] [N]
  1890. without the argument or with `$` as the argument, current tab
  1891. becomes the last tab. With the argument, current tab is moved
  1892. after the tab with the specified number. Argument of `0` moves
  1893. current tab to the first position.
  1894. :tabname
  1895. :tabname [name]
  1896. set, update or reset (when no argument is provided) name of the
  1897. current tab.
  1898. :tabnew
  1899. :tabnew [path]
  1900. create new tab. Accepts optional path for the new tab. Macros
  1901. and environment variables are expanded.
  1902. :tabnext
  1903. :tabn[ext]
  1904. switch to the next tab (wrapping around).
  1905. :tabn[ext] {n}
  1906. go to the tab number {n}. Tab numeration starts with 1.
  1907. :tabprevious
  1908. :tabp[revious]
  1909. switch to the previous tab (wrapping around).
  1910. :tabp[revious] {n}
  1911. go to the {n}-th previous tab. Note that :tabnext handles its
  1912. argument differently.
  1913. :touch
  1914. :[line]touch file...
  1915. create files at specified paths. Aborts on errors. Doesn't
  1916. update time of existing files. The [line] can be used to pick
  1917. node in a tree-view. Macros are expanded.
  1918. :tr
  1919. :[range]tr/pattern/string/
  1920. for each file in range transliterate the characters which appear
  1921. in pattern to the corresponding character in string. When
  1922. string is shorter than pattern, it's padded with its last char-
  1923. acter.
  1924. :trashes
  1925. :trashes
  1926. lists all valid trash directories in a menu. Only non-empty and
  1927. writable trash directories are shown. This is exactly the list
  1928. of directories that are cleared when :empty command is executed.
  1929. :trashes?
  1930. same as :trashes, but also displays size of each trash direc-
  1931. tory.
  1932. :tree
  1933. :tree turn pane into tree view with current directory as its root.
  1934. The tree view is implemented on top of a custom view, but is
  1935. automatically kept in sync with file system state and considers
  1936. all the filters. Thus the structure corresponds to what one
  1937. would see on visiting the directories manually. As a special
  1938. case for trees built out of custom view file-system tracking
  1939. isn't performed.
  1940. To leave tree view go up from its root or use gh at any level of
  1941. the tree. Any command that changes directory will also do, in
  1942. particular, `:cd ..`.
  1943. Tree structure is incompatible with alternative representations,
  1944. so values of 'lsview' and 'millerview' options are ignored.
  1945. :tree! toggle current view in and out of tree mode.
  1946. :undolist
  1947. :undol[ist]
  1948. display list of latest changes. Use "!" to see actual commands.
  1949. :unlet
  1950. :unl[et][!] $ENV_VAR1 $ENV_VAR2 ...
  1951. remove environment variables. Add ! to omit displaying of warn-
  1952. ings about nonexistent variables.
  1953. :unselect
  1954. :[range]unselect
  1955. unselect files in the given range (current file if no range is
  1956. given).
  1957. :unselect {pattern}
  1958. unselect files that match specified pattern. Possible {pattern}
  1959. forms are described in "Patterns" section below. Trailing slash
  1960. for directories is taken into account, so `:unselect */` unse-
  1961. lects directories.
  1962. :unselect !{external command}
  1963. unselect files from the list supplied by external command.
  1964. Files are matched by full paths, relative paths are converted to
  1965. absolute ones beforehand.
  1966. :unselect //[iI]
  1967. same as item above, but reuses last search pattern.
  1968. :version
  1969. :ve[rsion]
  1970. show menu with version information.
  1971. :vifm
  1972. :vifm same as :version.
  1973. :view
  1974. :vie[w]
  1975. toggle on and off the quick file view. See also 'quickview'
  1976. option.
  1977. :vie[w]!
  1978. turn on quick file view if it's off.
  1979. :volumes
  1980. :volumes
  1981. only for MS-Windows
  1982. display menu with volume list. Hitting l (or Enter) key opens
  1983. appropriate volume in the current pane.
  1984. :vsplit
  1985. :vs[plit]
  1986. switch to a two window vertical view.
  1987. :vs[plit]!
  1988. toggle window vertical splitting.
  1989. :vs[plit] path
  1990. split the window vertically to show both file directories. And
  1991. changes other pane to path (absolute or relative to current
  1992. directory of active pane).
  1993. :wincmd
  1994. :[count]winc[md] {arg}
  1995. same as running Ctrl-W [count] {arg}.
  1996. :windo
  1997. :windo [command...]
  1998. execute command for each pane (same as :winrun % command).
  1999. :winrun
  2000. :winrun type [command...]
  2001. execute command for pane(s), which is determined by type argu-
  2002. ment:
  2003. - ^ - top-left pane
  2004. - $ - bottom-right pane
  2005. - % - all panes
  2006. - . - current pane
  2007. - , - other pane
  2008. :write
  2009. :w[rite]
  2010. write vifminfo file.
  2011. :wq
  2012. :wq[!] same as :quit, but ! only disables check of backgrounded com-
  2013. mands. :wqall
  2014. :wqa[ll][!]
  2015. same as :qall, but ! only disables check of backgrounded com-
  2016. mands.
  2017. :xall
  2018. :xa[ll][!]
  2019. same as :qall.
  2020. :xit
  2021. :x[it][!]
  2022. same as :quit.
  2023. :yank
  2024. :[range]y[ank] [reg] [count]
  2025. will yank files to the reg register.
  2026. :map lhs rhs
  2027. :map lhs rhs
  2028. map lhs key sequence to rhs in normal and visual modes.
  2029. :map! lhs rhs
  2030. map lhs key sequence to rhs in command line mode.
  2031. :cmap :dmap :mmap :nmap :qmap
  2032. :vmap
  2033. :cm[ap] lhs rhs
  2034. map lhs to rhs in command line mode.
  2035. :dm[ap] lhs rhs
  2036. map lhs to rhs in dialog modes.
  2037. :mm[ap] lhs rhs
  2038. map lhs to rhs in menu mode.
  2039. :nm[ap] lhs rhs
  2040. map lhs to rhs in normal mode.
  2041. :qm[ap] lhs rhs
  2042. map lhs to rhs in view mode.
  2043. :vm[ap] lhs rhs
  2044. map lhs to rhs in visual mode.
  2045. :*map
  2046. :cm[ap]
  2047. list all maps in command line mode.
  2048. :dm[ap]
  2049. list all maps in dialog modes.
  2050. :mm[ap]
  2051. list all maps in menu mode.
  2052. :nm[ap]
  2053. list all maps in normal mode.
  2054. :qm[ap]
  2055. list all maps in view mode.
  2056. :vm[ap]
  2057. list all maps in visual mode.
  2058. :*map beginning
  2059. :cm[ap] beginning
  2060. list all maps in command line mode that start with the begin-
  2061. ning.
  2062. :dm[ap] beginning
  2063. list all maps in dialog modes that start with the beginning.
  2064. :mm[ap] beginning
  2065. list all maps in menu mode that start with the beginning.
  2066. :nm[ap] beginning
  2067. list all maps in normal mode that start with the beginning.
  2068. :qm[ap] beginning
  2069. list all maps in view mode that start with the beginning.
  2070. :vm[ap] beginning
  2071. list all maps in visual mode that start with the beginning.
  2072. :noremap
  2073. :no[remap] lhs rhs
  2074. map the key sequence lhs to rhs for normal and visual modes, but
  2075. disallow mapping of rhs.
  2076. :no[remap]! lhs rhs
  2077. map the key sequence lhs to rhs for command line mode, but dis-
  2078. allow mapping of rhs.
  2079. :cnoremap :dnoremap :mnoremap :nnoremap :qnoremap
  2080. :vnoremap
  2081. :cno[remap] lhs rhs
  2082. map the key sequence lhs to rhs for command line mode, but dis-
  2083. allow mapping of rhs.
  2084. :dn[oremap] lhs rhs
  2085. map the key sequence lhs to rhs for dialog modes, but disallow
  2086. mapping of rhs.
  2087. :mn[oremap] lhs rhs
  2088. map the key sequence lhs to rhs for menu mode, but disallow map-
  2089. ping of rhs.
  2090. :nn[oremap] lhs rhs
  2091. map the key sequence lhs to rhs for normal mode, but disallow
  2092. mapping of rhs.
  2093. :qn[oremap] lhs rhs
  2094. map the key sequence lhs to rhs for view mode, but disallow map-
  2095. ping of rhs.
  2096. :vn[oremap] lhs rhs
  2097. map the key sequence lhs to rhs for visual mode, but disallow
  2098. mapping of rhs.
  2099. :unmap
  2100. :unm[ap] lhs
  2101. remove the mapping of lhs from normal and visual modes.
  2102. :unm[ap]! lhs
  2103. remove the mapping of lhs from command line mode.
  2104. :cunmap :dunmap :munmap :nunmap :qunmap
  2105. :vunmap
  2106. :cu[nmap] lhs
  2107. remove the mapping of lhs from command line mode.
  2108. :du[nmap] lhs
  2109. remove the mapping of lhs from dialog modes.
  2110. :mu[nmap] lhs
  2111. remove the mapping of lhs from menu mode.
  2112. :nun[map] lhs
  2113. remove the mapping of lhs from normal mode.
  2114. :qun[map] lhs
  2115. remove the mapping of lhs from view mode.
  2116. :vu[nmap] lhs
  2117. remove the mapping of lhs from visual mode.
  2118. Ranges
  2119. The ranges implemented include:
  2120. 2,3 - from second to third file in the list (including it)
  2121. % - the entire directory.
  2122. . - the current position in the filelist.
  2123. $ - the end of the filelist.
  2124. 't - the mark position t.
  2125. Examples:
  2126. :%delete
  2127. would delete all files in the directory.
  2128. :2,4delete
  2129. would delete the files in the list positions 2 through 4.
  2130. :.,$delete
  2131. would delete the files from the current position to the end of the
  2132. filelist.
  2133. :3delete4
  2134. would delete the files in the list positions 3, 4, 5, 6.
  2135. If a backward range is given :4,2delete - an query message is given and
  2136. user can chose what to do next.
  2137. The builtin commands that accept a range are :d[elete] and :y[ank].
  2138. Command macros
  2139. The command macros may be used in user commands.
  2140. %a User arguments. When user arguments contain macros, they are
  2141. expanded before preforming substitution of %a.
  2142. %c %"c The current file under the cursor.
  2143. %C %"C The current file under the cursor in the other directory.
  2144. %f %"f All of the selected files.
  2145. %F %"F All of the selected files in the other directory list.
  2146. %b %"b Same as %f %F.
  2147. %d %"d Full path to current directory.
  2148. %D %"D Full path to other file list directory.
  2149. %rx %"rx
  2150. Full paths to files in the register {x}. In case of invalid
  2151. symbol in place of {x}, it's processed with the rest of the line
  2152. and default register is used.
  2153. %m Show command output in a menu.
  2154. %M Same as %m, but l (or Enter) key is handled like for :locate and
  2155. :find commands.
  2156. %u Process command output as list of paths and compose custom view
  2157. out of it.
  2158. %U Same as %u, but implies less list updates inside vifm, which is
  2159. absence of sorting at the moment.
  2160. %Iu same as %u, but gives up terminal before running external com-
  2161. mand.
  2162. %IU same as %U, but gives up terminal before running external com-
  2163. mand.
  2164. %S Show command output in the status bar.
  2165. %q redirect command output to quick view, which is activated if
  2166. disabled.
  2167. %s Execute command in split window of active terminal multiplexer
  2168. (ignored if not running inside one).
  2169. %n Forbid using of terminal multiplexer to run the command.
  2170. %i Completely ignore command output.
  2171. %pc Marks end of the main command and beginning of the clear command
  2172. for graphical preview, which is invoked on closing preview of a
  2173. file.
  2174. The following dimensions and coordinates are in characters:
  2175. %px x coordinate of top-left corner of preview area.
  2176. %py y coordinate of top-left corner of preview area.
  2177. %pw width of preview area.
  2178. %ph height of preview area.
  2179. Use %% if you need to put a percent sign in your command.
  2180. Note that %m, %M, %s, %S, %i, %u and %U macros are mutually exclusive.
  2181. Only the last one of them on the command will take effect.
  2182. You can use file name modifiers after %c, %C, %f, %F, %b, %d and %D
  2183. macros. Supported modifiers are:
  2184. - :p - full path
  2185. - :u - UNC name of path (e.g. "\\server" in
  2186. "\\server\share"), Windows only. Expands to current computer name
  2187. for not UNC paths.
  2188. - :~ - relative to the home directory
  2189. - :. - relative to current directory
  2190. - :h - head of the file name
  2191. - :t - tail of the file name
  2192. - :r - root of the file name (without last extension)
  2193. - :e - extension of the file name (last one)
  2194. - :s?pat?sub? - substitute the first occurrence of pat with sub.
  2195. You can use any character for '?', but it must not occur in pat or
  2196. sub.
  2197. - :gs?pat?sub? - like :s, but substitutes all occurrences of pat with
  2198. sub.
  2199. See ':h filename-modifiers' in Vim's documentation for the detailed
  2200. description.
  2201. Using %x means expand corresponding macro escaping all characters that
  2202. have special meaning. And %"x means using of double quotes and escape
  2203. only backslash and double quote characters, which is more useful on
  2204. Windows systems.
  2205. Position and quantity (if there is any) of %m, %M, %S or %s macros in
  2206. the command is unimportant. All their occurrences are removed from the
  2207. resulting command.
  2208. %c and %f macros are expanded to file names only, when %C and %F are
  2209. expanded to full paths. %f and %F follow this in %b too.
  2210. :com move mv %f %D
  2211. set the :move command to move all of the files selected in the
  2212. current directory to the other directory.
  2213. The %a macro is replaced with any arguments given to an alias command.
  2214. All arguments are considered optional.
  2215. :com lsl !!ls -l %a - set the lsl command to execute ls -l with
  2216. or without an argument.
  2217. :lsl<Enter>
  2218. will list the directory contents of the current directory.
  2219. :lsl filename<Enter>
  2220. will list only the given filename.
  2221. The macros can also be used in directly executing commands. ":!mv %f
  2222. %D" would move the current directory selected files to the other direc-
  2223. tory.
  2224. Appending & to the end of a command causes it to be executed in the
  2225. background. Typically you want to run two kinds of external commands
  2226. in the background:
  2227. - GUI applications that doesn't fork thus block vifm (:!sxiv %f &);
  2228. - console tools that do not work with terminal (:!mv %f %D &).
  2229. You don't want to run terminal commands, which require terminal input
  2230. or output something in background because they will mess up vifm's TUI.
  2231. Anyway, if you did run such a command, you can use Ctrl-L key to update
  2232. vifm's TUI.
  2233. Rewriting the example command with macros given above with background-
  2234. ing:
  2235. %m, %M, %s, %S, %u and %U macros cannot be combined with background
  2236. mark (" &") as it doesn't make much sense.
  2237. Command backgrounding
  2238. Copy and move operation can take a lot of time to proceed. That's why
  2239. vifm supports backgrounding of this two operations. To run :copy,
  2240. :move or :delete command in the background just add " &" at the end of
  2241. a command.
  2242. For each background operation a new thread is created. Currently job
  2243. cannot be stopped or paused.
  2244. You can see if command is still running in the :jobs menu. Back-
  2245. grounded commands have progress instead of process id at the line
  2246. beginning.
  2247. Background operations cannot be undone.
  2248. Cancellation
  2249. Note that cancellation works somewhat different on Windows platform due
  2250. to different mechanism of break signal propagation. One also might
  2251. need to use Ctrl-Break shortcut instead of Ctrl-C.
  2252. There are two types of operations that can be cancelled:
  2253. - file system operations;
  2254. - mounting with FUSE (but not unmounting as it can cause loss of
  2255. data);
  2256. - calls of external applications.
  2257. Note that vifm never terminates applications, it sends SIGINT signal
  2258. and lets the application quit normally.
  2259. When one of set of operations is cancelled (e.g. copying of 5th file of
  2260. 10 files), further operations are cancelled too. In this case undo
  2261. history will contain only actually performed operations.
  2262. Cancelled operations are indicated by "(cancelled)" suffix appended to
  2263. information message on statusbar.
  2264. File system operations
  2265. Currently the following commands can be cancelled: :alink, :chmod,
  2266. :chown, :clone, :copy, :delete, :mkdir, :move, :restore, :rlink,
  2267. :touch. File putting (on p/P key) can be cancelled as well. It's not
  2268. hard to see that these are mainly long-running operations.
  2269. Cancelling commands when they are repeated for undo/redo operations is
  2270. allowed for convenience, but is not recommended as further undo/redo
  2271. operations might get blocked by side-effects of partially cancelled
  2272. group of operations.
  2273. These commands can't be cancelled: :empty, :rename, :substitute, :tr.
  2274. Mounting with FUSE
  2275. It's not considered to be an error, so only notification on the status
  2276. bar is shown.
  2277. External application calls
  2278. Each of this operations can be cancelled: :apropos, :find, :grep,
  2279. :locate.
  2280. Patterns
  2281. :highlight, :filetype, :filextype, :fileviewer commands and 'classify'
  2282. option support globs, regular expressions and mime types to match file
  2283. names or their paths.
  2284. There are six possible ways to write a single pattern:
  2285. 1. [!]{comma-separated-name-globs}
  2286. 2. [!]{{comma-separated-path-globs}}
  2287. 3. [!]/name-regular-expression/[iI]
  2288. 4. [!]//path-regular-expression//[iI]
  2289. 5. [!]<comma-separated-mime-type-globs>
  2290. 6. undecorated-pattern
  2291. Flags of regular expressions mean the following:
  2292. - "i" makes filter case insensitive;
  2293. - "I" makes filter case sensitive. They can be repeated multiple
  2294. times, but the later one takes precedence (e.g. "iiiI" is equivalent
  2295. to "I" and "IiIi" is the same as "i").
  2296. To combine several patterns (AND them), make sure you're using one of
  2297. the first five forms and write patterns one after another, like this:
  2298. <text/plain>{*.vifm}
  2299. Mind that if you make a mistake the whole string will be treated as the
  2300. sixth form.
  2301. :filetype, :filextype and :fileviewer commands accept comma-separated
  2302. list of patterns instead of a single pattern, thus effectively handling
  2303. OR operation on them:
  2304. <text/plain>{*.vifm},<application/pdf>{*.pdf}
  2305. Five first forms can include leading exclamation mark that negates pat-
  2306. tern matching.
  2307. The last form is implicitly refers to one of others. :highlight does
  2308. not accept undecorated form, while :filetype, :filextype, :fileviewer,
  2309. :select, :unselect and 'classify' treat it as list of name globs.
  2310. Regular expression patterns are case insensitive by default, see
  2311. description of commands, which might override default behaviour.
  2312. "Globs" section below provides short overview of globs and some impor-
  2313. tant points that one needs to know about them.
  2314. Mime type matching is essentially globs matching applied to mime type
  2315. of a file instead of its name/path. Note: mime types aren't detected
  2316. on Windows.
  2317. Globs
  2318. Globs are always case insensitive as it makes sense in general case.
  2319. *, ?, [ and ] are treated as special symbols in the pattern. E.g.
  2320. :filetype * less %c
  2321. matches all files. One can use character classes for escaping, so
  2322. :filetype [*] less %c
  2323. matches only one file name, the one which contains only asterisk sym-
  2324. bol.
  2325. * means any number of any characters (possibly an empty substring),
  2326. with one exception: asterisk at the pattern beginning doesn't match dot
  2327. in the first position. E.g.
  2328. :fileviewer *.zip,*.jar zip -sf %c
  2329. associates using of zip program to preview all files with zip or jar
  2330. extensions as listing of their content.
  2331. ? means any character at this position. E.g.
  2332. :fileviewer ?.out file %c
  2333. calls file tool for all files which has exactly one character before
  2334. their extension (e.g. a.out, b.out).
  2335. Square brackets designate character class, which means that whole char-
  2336. acter class matches against any of characters listed in it. For exam-
  2337. ple
  2338. :fileviewer *.[ch] highlight -O xterm256 -s dante --syntax c %c
  2339. makes vifm call highlight program to colorize source and header files
  2340. in C language for a 256-color terminal. Equal command would be
  2341. :fileviewer *.c,*.h highlight -O xterm256 -s dante --syntax c %c
  2342. Inside square brackets ^ or ! can be used for symbol class negotiation
  2343. and the - symbol to set a range. ^ and ! should appear right after the
  2344. opening square bracket. For example
  2345. :filetype *.[!d]/ inspect_dir
  2346. associates inspect_dir as additional handler for all directories that
  2347. have one character extension unless it's "d" letter. And
  2348. :filetype [0-9].jpg sxiv
  2349. associates sxiv picture viewer only for JPEG-files that contain single
  2350. digit in their name.
  2351. :set options
  2352. Local options
  2353. These are kind of options that are local to a specific view. So
  2354. you can set ascending sorting order for left pane and descending
  2355. order for right pane.
  2356. In addition to being local to views, each such option also has
  2357. two values:
  2358. - local to current directory (value associated with current
  2359. location);
  2360. - global to current directory (value associated with the
  2361. pane).
  2362. The idea is that current directory can be made a temporary
  2363. exception to regular configuration of the view, until directory
  2364. change. Use :setlocal for that. :setglobal changes view value
  2365. not affecting settings until directory change. :set applies
  2366. changes immediately to all values.
  2367. 'aproposprg'
  2368. type: string
  2369. default: "apropos %a"
  2370. Specifies format for an external command to be invoked by the
  2371. :apropos command. The format supports expanding of macros, spe-
  2372. cific for a particular *prg option, and %% sequence for insert-
  2373. ing percent sign literally. This option should include the %a
  2374. macro to specify placement of arguments passed to the :apropos
  2375. command. If the macro is not used, it will be implicitly added
  2376. after a space to the value of this option.
  2377. 'autochpos'
  2378. type: boolean
  2379. default: true
  2380. When disabled vifm will set cursor to the first line in the view
  2381. after :cd and :pushd commands instead of saved cursor position.
  2382. Disabling this will also make vifm clear information about cur-
  2383. sor position in the view history on :cd and :pushd commands (and
  2384. on startup if 'autochpos' is disabled in the vifmrc). l key in
  2385. the ":history ." and ":trashes" menus are treated like :cd com-
  2386. mand. This option also affects marks so that navigating to a
  2387. mark doesn't restore cursor position.
  2388. When this option is enabled, more fine grained control over cur-
  2389. sor position is available via 'histcursor' option.
  2390. 'columns' 'co'
  2391. type: integer
  2392. default: terminal width on startup
  2393. Terminal width in characters.
  2394. 'caseoptions'
  2395. type: charset
  2396. default: ""
  2397. This option gives additional control over case sensitivity by
  2398. allowing overriding default behaviour to either always be case
  2399. sensitive or always be case insensitive. Possible values form
  2400. pairs of lower and upper case letters that configure specific
  2401. aspect of behaviour:
  2402. p - always ignore case of paths during completion.
  2403. P - always match case of paths during completion.
  2404. g - always ignore case of characters for f/F/;/,.
  2405. G - always match case of characters for f/F/;/,.
  2406. At most one item of each pair takes affect, if both or more are
  2407. present, only the last one matters. When none of pair's ele-
  2408. ments are present, the behaviour is default (depends on operat-
  2409. ing system for path completion and on values of 'ignorecase' and
  2410. 'smartcase' options for file navigation).
  2411. 'cdpath' 'cd'
  2412. type: string list
  2413. default: value of $CDPATH with commas instead of colons
  2414. Specifies locations to check on changing directory with relative
  2415. path that doesn't start with "./" or "../". When non-empty,
  2416. current directory is examined after directories listed in the
  2417. option.
  2418. This option doesn't affect completion of :cd command.
  2419. Example:
  2420. set cdpath=~
  2421. This way ":cd bin" will switch to "~/bin" even if directory
  2422. named "bin" exists in current directory, while ":cd ./bin" com-
  2423. mand will ignore value of 'cdpath'.
  2424. 'chaselinks'
  2425. type: boolean
  2426. default: false
  2427. When enabled path of view is always resolved to real path (with
  2428. all symbolic links expanded).
  2429. 'classify'
  2430. type: string list
  2431. default: ":dir:/"
  2432. Specifies file name prefixes and suffixes depending on file type
  2433. or name. The format is either of:
  2434. - [{prefix}]:{filetype}:[{suffix}]
  2435. - [{prefix}]::{pattern}::[{suffix}]
  2436. Possible {pattern} forms are described in "Patterns" section
  2437. above.
  2438. Priority rules:
  2439. - file name patterns have priority over type patterns
  2440. - file name patterns are matched in left-to-right order of
  2441. their appearance in this option
  2442. Either {prefix} or {suffix} or both can be omitted (which is the
  2443. default for all unspecified file types), this means empty {pre-
  2444. fix} and/or {suffix}. {prefix} and {suffix} should consist of
  2445. at most eight characters. Elements are separated by commas.
  2446. Neither prefixes nor suffixes are part of file names, so they
  2447. don't affect commands which operate on file names in any way.
  2448. Comma (',') character can be inserted by doubling it. List of
  2449. file type names can be found in the description of filetype()
  2450. function.
  2451. 'confirm' 'cf'
  2452. type: set
  2453. default: delete,permdelete
  2454. Defines which operations require confirmation:
  2455. - delete - moving files to trash (on d or :delete);
  2456. - permdelete - permanent deletion of files (on D or :delete!
  2457. command or on undo/redo operation).
  2458. 'cpoptions' 'cpo'
  2459. type: charset
  2460. default: "fst"
  2461. Contains a sequence of single-character flags. Each flag
  2462. enables behaviour of older versions of vifm. Flags:
  2463. - f - when included, running :filter command results in not
  2464. inverted (matching files are filtered out) and :filter! in
  2465. inverted (matching files are left) filter, when omitted, meaning
  2466. of the exclamation mark changes to the opposite;
  2467. - s - when included, yy, dd and DD normal mode commands act on
  2468. selection, otherwise they operate on current file only;
  2469. - t - when included, <tab> (thus <c-i>) behave as <space> and
  2470. switches active pane, otherwise <tab> and <c-i> go forward in
  2471. the view history. It's possible to make both <tab> and <c-i> to
  2472. work as expected by setting up the terminal to emit a custom
  2473. sequence when <c-i> is pressed; see :histnext for details.
  2474. 'cvoptions'
  2475. type: set
  2476. default:
  2477. Specifies whether entering/leaving custom views triggers events
  2478. that normally happen on entering/leaving directories:
  2479. - autocmds - trigger autocommands on entering/leaving custom
  2480. views;
  2481. - localopts - reset local options on entering/leaving custom
  2482. views;
  2483. - localfilter - reset local filter on entering/leaving custom
  2484. views.
  2485. 'deleteprg'
  2486. type: string
  2487. default: ""
  2488. Specifies program to run on files that are permanently removed.
  2489. When empty, files are removed as usual, otherwise this command
  2490. is invoked on each file by appending its name. If the command
  2491. doesn't remove files, they will remain on the file system.
  2492. 'dirsize'
  2493. type: enumeration
  2494. default: size
  2495. Controls how size of directories is displayed in file views.
  2496. The following values are possible:
  2497. - size - size of directory (i.e., size used to store list of
  2498. files)
  2499. - nitems - number of entries in the directory (excluding . and
  2500. ..)
  2501. Size obtained via ga/gA overwrites this setting so seeing count
  2502. of files and occasionally size of directories is possible.
  2503. 'dotdirs'
  2504. type: set
  2505. default: nonrootparent
  2506. Controls displaying of dot directories. The following values
  2507. are possible:
  2508. - rootparent - show "../" in root directory of file system
  2509. - nonrootparent - show "../" in non-root directories of file
  2510. system
  2511. Note that empty directories always contain "../" entry regard-
  2512. less of value of this option. "../" disappears at the moment at
  2513. least one file is created.
  2514. 'dotfiles'
  2515. type: boolean
  2516. default: false
  2517. Whether dot files are shown in the view. Can be controlled with
  2518. z* bindings.
  2519. 'fastrun'
  2520. type: boolean
  2521. default: false
  2522. With this option turned on you can run partially entered com-
  2523. mands with unambiguous beginning using :! (e.g. :!Te instead of
  2524. :!Terminal or :!Te<tab>).
  2525. 'fillchars' 'fcs'
  2526. type: string list
  2527. default: ""
  2528. Sets characters used to fill borders.
  2529. item default used for
  2530. vborder:c ' ' left, middle and right vertical bor-
  2531. ders
  2532. If value is omitted, its default value is used. Example:
  2533. set fillchars=vborder:.
  2534. 'findprg'
  2535. type: string
  2536. default: "find %s %a -print , -type d \( ! -readable -o ! -exe-
  2537. cutable \) -prune"
  2538. Specifies format for an external command to be invoked by the
  2539. :find command. The format supports expanding of macros, spe-
  2540. cific for a particular *prg option, and %% sequence for insert-
  2541. ing percent sign literally. This option should include the %s
  2542. macro to specify placement of list of paths to search in and %a
  2543. or %A macro to specify placement of arguments passed to the
  2544. :find command. If some of the macros are not used, they will be
  2545. implicitly added after a space to the value of the option in the
  2546. following order: %s, %a. Note that when neither %a nor %A are
  2547. specified, it's %a which is added implicitly.
  2548. The macros can slightly change their meaning depending on :find
  2549. command arguments. When the first argument points to an exist-
  2550. ing directory, %s is assigned all arguments and %a/%A are left
  2551. empty. Otherwise, %s is assigned a dot (".") meaning current
  2552. directory or list of selected file names, if any. %a/%A are
  2553. assigned arguments when first argument starts with a dash ("-"),
  2554. otherwise %a gets an escaped version of arguments, prepended by
  2555. "-name" (on *nix) or "-iname" (on Windows) predicate.
  2556. %a and %A macros contain almost the same value, the difference
  2557. is that %a can be escaped and %A is never escaped. %A is to be
  2558. used mainly on Windows, where shell escaping is a mess and can
  2559. break command execution.
  2560. Optional %u or %U macro could be used (if both specified %U is
  2561. chosen) to force redirection to custom or unsorted custom view
  2562. respectively.
  2563. Starting from Windows Server 2003 a where command is available,
  2564. one can configure vifm to use it in the following way:
  2565. set findprg="where /R %s %A"
  2566. As the syntax of this command is rather limited, one can't use
  2567. :find command with selection of more than one item in this case.
  2568. The command looks for files only completely ignoring directo-
  2569. ries.
  2570. When using find port on Windows, another option is to setup
  2571. 'findprg' like this:
  2572. set findprg="find %s %a"
  2573. 'followlinks'
  2574. type: boolean
  2575. default: true
  2576. Follow links on l or Enter. That is navigate to destination
  2577. file instead of treating the link as if it were target file.
  2578. Doesn't affects links to directories, which are always entered
  2579. (use gf key for directories).
  2580. 'fusehome'
  2581. type: string
  2582. default: "($XDG_DATA_HOME/.local/share | $VIFM)/fuse/"
  2583. Directory to be used as a root dir for FUSE mounts. Value of
  2584. the option can contain environment variables (in form
  2585. "$envname"), which will be expanded (prepend it with a slash to
  2586. prevent expansion). The value should expand to an absolute
  2587. path.
  2588. If you change this option, vifm won't remount anything. It
  2589. affects future mounts only. See "Automatic FUSE mounts" section
  2590. below for more information.
  2591. 'gdefault' 'gd'
  2592. type: boolean
  2593. default: false
  2594. When on, 'g' flag is on for :substitute by default.
  2595. 'grepprg'
  2596. type: string
  2597. default: "grep -n -H -I -r %i %a %s"
  2598. Specifies format for an external command to be invoked by the
  2599. :grep command. The format supports expanding of macros, spe-
  2600. cific for a particular *prg option, and %% sequence for insert-
  2601. ing percent sign literally. This option should include the %i
  2602. macro to specify placement of "-v" string when inversion of
  2603. results is requested, %a or %A macro to specify placement of
  2604. arguments passed to the :grep command and the %s macro to spec-
  2605. ify placement of list of files to search in. If some of the
  2606. macros are not used, they will be implicitly added after a space
  2607. to the value of the 'grepprg' option in the following order: %i,
  2608. %a, %s. Note that when neither %a nor %A are specified, it's %a
  2609. which is added implicitly.
  2610. Optional %u or %U macro could be used (if both specified %U is
  2611. chosen) to force redirection to custom or unsorted custom view
  2612. respectively.
  2613. See 'findprg' option for description of difference between %a
  2614. and %A.
  2615. Example of setup to use ack (http://beyondgrep.com/) instead of
  2616. grep:
  2617. set grepprg='ack -H -r %i %a %s'
  2618. or The Silver Searcher (https://github.com/ggreer/the_sil-
  2619. ver_searcher):
  2620. set grepprg='ag --line-numbers %i %a %s'
  2621. 'histcursor'
  2622. type: set
  2623. default: startup,dirmark,direnter
  2624. Defines situations when cursor should be moved according to
  2625. directory history:
  2626. - startup - on loading file lists during startup
  2627. - dirmark - after navigating to a mark that doesn't specify
  2628. file
  2629. - direnter - on opening directory from a file list
  2630. This option has no effect when 'autochpos' is disabled.
  2631. Note that the list is not exhaustive and there are other situa-
  2632. tions when cursor is positioned automatically.
  2633. 'history' 'hi'
  2634. type: integer
  2635. default: 15
  2636. Maximum number of stored items in all histories.
  2637. 'hlsearch' 'hls'
  2638. type: boolean
  2639. default: true
  2640. Highlight all matches of search pattern.
  2641. 'iec' type: boolean
  2642. default: false
  2643. Use KiB, MiB, ... suffixes instead of K, M, ... when printing
  2644. size in human-friendly format.
  2645. 'ignorecase' 'ic'
  2646. type: boolean
  2647. default: false
  2648. Ignore case in search patterns (:substitute, / and ? commands)
  2649. and characters after f and F commands. It doesn't affect file
  2650. filtering.
  2651. 'incsearch' 'is'
  2652. type: boolean
  2653. default: false
  2654. When this option is set, search and view update for local filter
  2655. is be performed starting from initial cursor position each time
  2656. search pattern is changed.
  2657. 'iooptions'
  2658. type: set
  2659. default:
  2660. Controls details of file operations. The following values are
  2661. available:
  2662. - fastfilecloning - perform fast file cloning (copy-on-write),
  2663. when available
  2664. (available on Linux and btrfs file system).
  2665. 'laststatus' 'ls'
  2666. type: boolean
  2667. default: true
  2668. Controls if status bar is visible.
  2669. 'lines'
  2670. type: integer
  2671. default: terminal height on startup
  2672. Terminal height in lines.
  2673. 'locateprg'
  2674. type: string
  2675. default: "locate %a"
  2676. Specifies format for an external command to be invoked by the
  2677. :locate command. The format supports expanding of macros, spe-
  2678. cific for a particular *prg option, and %% sequence for insert-
  2679. ing percent sign literally. This option should include the %a
  2680. macro to specify placement of arguments passed to the :locate
  2681. command. If the macro is not used, it will be implicitly added
  2682. after a space to the value of this option.
  2683. Optional %u or %U macro could be used (if both specified %U is
  2684. chosen) to force redirection to custom or unsorted custom view
  2685. respectively.
  2686. 'mediaprg'
  2687. type: string
  2688. default: path to bundled script that supports udevil and udisks
  2689. {only for *nix}
  2690. Specifies command to be used to manage media devices. Used by
  2691. :media command.
  2692. The command can be passed the following parameters:
  2693. - list -- list media
  2694. - mount {device} -- mount a device
  2695. - unmount {path} -- unmount given mount point
  2696. The output of `list` subcommand is parsed in search of lines
  2697. that start with one of the following prefixes:
  2698. - device= - specifies device path (e.g., "/dev/sde")
  2699. - label= - specifies optional device label (e.g., "Memory
  2700. card")
  2701. - mount-point= - specifies a mount point (can be absent or
  2702. appear more than once)
  2703. All other lines are ignored. Each `device=` starts a new sec-
  2704. tion describing a device which should include two other possible
  2705. prefixes.
  2706. `list` subcommand is assumed to always succeed, while error
  2707. stream and exit code of `mount` and `unmount` is taken into
  2708. account to determine whether operation was performed success-
  2709. fully.
  2710. 'lsoptions'
  2711. type: string list
  2712. default: ""
  2713. scope: local
  2714. Configures ls-like view.
  2715. item used for
  2716. transposed filling view grid by columns rather than by
  2717. lines
  2718. 'lsview'
  2719. type: boolean
  2720. default: false
  2721. scope: local
  2722. When this option is set, directory view will be displayed in
  2723. multiple columns with file names similar to output of `ls -x`
  2724. command. See "ls-like view" section below for format descrip-
  2725. tion. This option has no effect if 'millerview' is on.
  2726. 'milleroptions'
  2727. type: string list
  2728. default: "lsize:1,csize:1,rsize:1"
  2729. scope: local
  2730. Configures miller view.
  2731. item default used for
  2732. lsize:num 0 left column
  2733. csize:num 1 center column (can't be disabled)
  2734. rsize:num 0 right column
  2735. *size specifies ratios of columns. Each ratio is in the range
  2736. from 0 to 100 and values are adjusted to fit the limits. Zero
  2737. disables a column, but central (main) column can't be disabled.
  2738. Example of two-column mode which is useful in combination with
  2739. :view command:
  2740. set milleroptions=lsize:1,csize:2
  2741. 'millerview'
  2742. type: boolean
  2743. default: false
  2744. scope: local
  2745. When this option is set, directory view will be displayed in
  2746. multiple cascading columns. Ignores 'lsview'.
  2747. 'mintimeoutlen'
  2748. type: integer
  2749. default: 150
  2750. The fracture of 'timeoutlen' in milliseconds that is waited
  2751. between subsequent input polls, which affects various asynchro-
  2752. nous operations (detecting changes made by external applica-
  2753. tions, monitoring background jobs, redrawing UI). There are no
  2754. strict guarantees, however the higher this value is, the less is
  2755. CPU load in idle mode.
  2756. 'number' 'nu'
  2757. type: boolean
  2758. default: false
  2759. scope: local
  2760. Print line number in front of each file name when 'lsview'
  2761. option is turned off. Use 'numberwidth' to control width of
  2762. line number. Also see 'relativenumber'.
  2763. 'numberwidth' 'nuw'
  2764. type: integer
  2765. default: 4
  2766. scope: local
  2767. Minimal number of characters for line number field.
  2768. 'previewprg'
  2769. type: string
  2770. default: ""
  2771. scope: local
  2772. External command to be used instead of preview programs config-
  2773. ured via :fileviewer command.
  2774. Example:
  2775. " always show git log in preview of files inside some repository
  2776. au DirEnter '~/git-repo/**/*' setl previewprg='git log --color -- %c 2>&1'
  2777. 'quickview'
  2778. type: boolean
  2779. default: false
  2780. Whether quick view (:view) is currently active or not.
  2781. 'relativenumber' 'rnu'
  2782. type: boolean
  2783. default: false
  2784. scope: local
  2785. Print relative line number in front of each file name when
  2786. 'lsview' option is turned off. Use 'numberwidth' to control
  2787. width of line number. Various combinations of 'number' and
  2788. 'relativenumber' lead to such results:
  2789. nonumber number
  2790. norelativenumber | first | 1 first
  2791. | second | 2 second
  2792. | third | 3 third
  2793. relativenumber | 1 first | 1 first
  2794. | 0 second |2 second
  2795. | 1 third | 1 third
  2796. 'rulerformat' 'ruf'
  2797. type: string
  2798. default: "%l/%S "
  2799. Determines the content of the ruler. Its minimal width is 13
  2800. characters and it's right aligned. Following macros are sup-
  2801. ported:
  2802. %= - separation point between left and right aligned halves of
  2803. the line
  2804. %l - file number
  2805. %L - total number of files in view (including filtered out
  2806. ones)
  2807. %x - number of files excluded by filters
  2808. %0- - old name for %x macro
  2809. %S - number of displayed files
  2810. %= - separation point between left and right align items
  2811. %% - percent sign
  2812. %[ - designates beginning of an optional block
  2813. %] - designates end of an optional block
  2814. Percent sign can be followed by optional minimum field width.
  2815. Add '-' before minimum field width if you want field to be right
  2816. aligned.
  2817. Example:
  2818. set rulerformat='%2l-%S%[ +%x%]'
  2819. 'runexec'
  2820. type: boolean
  2821. default: false
  2822. Run executable file on Enter or l.
  2823. 'scrollbind' 'scb'
  2824. type: boolean
  2825. default: false
  2826. When this option is set, vifm will try to keep difference of
  2827. scrolling positions of two windows constant.
  2828. 'scrolloff' 'so'
  2829. type: integer
  2830. default: 0
  2831. Minimal number of screen lines to keep above and below the cur-
  2832. sor. If you want cursor line to always be in the middle of the
  2833. view (except at the beginning or end of the file list), set this
  2834. option to some large value (e.g. 999).
  2835. 'shell' 'sh'
  2836. type: string
  2837. default: $SHELL or "/bin/sh" or "cmd" (on MS-Windows)
  2838. Full path to the shell to use to run external commands. On *nix
  2839. a shell argument can be supplied.
  2840. 'shortmess' 'shm'
  2841. type: charset
  2842. default: "p"
  2843. Contains a sequence of single-character flags. Each flag
  2844. enables shortening of some message displayed by vifm in the TUI.
  2845. Flags:
  2846. - M - shorten titles in windows of terminal multiplexers cre-
  2847. ated by vifm down to file name instead of using full path.
  2848. - T - truncate status-bar messages in the middle if they are
  2849. too long to fit on the command line. "..." will appear in the
  2850. middle.
  2851. - p - use tilde shortening in view titles.
  2852. 'showtabline' 'stal'
  2853. type: enumeration
  2854. default: multiple
  2855. Specifies when tab line should be displayed. Possible values:
  2856. - never - never display tab line
  2857. - multiple - show tab line only when there are at least two
  2858. tabs
  2859. - always - display tab line always
  2860. Alternatively 0, 1 and 2 Vim-like values are also accepted and
  2861. correspond to "never", "multiple" and "always" respectively.
  2862. 'sizefmt'
  2863. type: string list
  2864. default: "units:iec"
  2865. Configures the way size is formatted in human-friendly way.
  2866. item value meaning
  2867. units: iec Use 1024 byte units (K or KiB,
  2868. etc.).
  2869. See 'iec' option.
  2870. si Use 1000 byte units (KB, etc.).
  2871. precision: i > 0 How many fraction digits to con-
  2872. sider.
  2873. {not set} Precision of 1 for integer part
  2874. < 10,
  2875. 0 otherwise (provides old behav-
  2876. iour).
  2877. Numbers are rounded from zero. Trailing zeros are dropped.
  2878. Example:
  2879. set sizefmt=units:iec,precision:2
  2880. 'slowfs'
  2881. type: string list
  2882. default: ""
  2883. only for *nix
  2884. A list of mounter fs name beginnings (first column in /etc/mtab
  2885. or /proc/mounts) or paths prefixes for fs/directories that work
  2886. too slow for you. This option can be used to stop vifm from
  2887. making some requests to particular kinds of file systems that
  2888. can slow down file browsing. Currently this means don't check
  2889. if directory has changed, skip check if target of symbolic links
  2890. exists, assume that link target located on slow fs to be a
  2891. directory (allows entering directories and navigating to files
  2892. via gf). If you set the option to "*", it means all the systems
  2893. are considered slow (useful for cygwin, where all the checks
  2894. might render vifm very slow if there are network mounts).
  2895. Example for autofs root /mnt/autofs:
  2896. set slowfs+=/mnt/autofs
  2897. 'smartcase' 'scs'
  2898. type: boolean
  2899. default: false
  2900. Overrides the ignorecase option if the search pattern contains
  2901. at least one upper case character. Only used when ignorecase
  2902. option is enabled. It doesn't affect file filtering.
  2903. 'sort' type: string list
  2904. default: +name on *nix and +iname on Windows
  2905. scope: local
  2906. Sets list of sorting keys (first item is primary key, second is
  2907. secondary key, etc.):
  2908. [+-]ext - extension of files and directories
  2909. [+-]fileext - extension of files only
  2910. [+-]name - name (including extension)
  2911. [+-]iname - name (including extension, ignores case)
  2912. [+-]type - file type
  2913. (dir/reg/exe/link/char/block/sock/fifo)
  2914. [+-]dir - directory grouping (directory < file)
  2915. [+-]gid - group id (*nix only)
  2916. [+-]gname - group name (*nix only)
  2917. [+-]mode - file type derived from its mode (*nix only)
  2918. [+-]perms - permissions string (*nix only)
  2919. [+-]uid - owner id (*nix only)
  2920. [+-]uname - owner name (*nix only)
  2921. [+-]nlinks - number of hard links (*nix only)
  2922. [+-]inode - inode number (*nix only)
  2923. [+-]size - size
  2924. [+-]nitems - number of items in a directory (zero for files)
  2925. [+-]groups - groups extracted via regexps from 'sortgroups'
  2926. [+-]target - symbolic link target (empty for other file
  2927. types)
  2928. [+-]atime - time accessed (e.g. read, executed)
  2929. [+-]ctime - time changed (changes in metadata, e.g. mode)
  2930. [+-]mtime - time modified (when file contents is changed)
  2931. Note: look for st_atime, st_ctime and st_mtime in "man 2 stat"
  2932. for more information on time keys.
  2933. '+' means ascending sort for this key, and '-' means descending
  2934. sort.
  2935. "dir" key is somewhat similar in this regard but it's added
  2936. implicitly: when "dir" is not specified, sorting behaves as if
  2937. it was the first key in the list. That's why if one wants sort-
  2938. ing algorithm to mix directories and files, "dir" should be
  2939. appended to sorting option, for example like this:
  2940. set sort+=dir
  2941. or
  2942. set sort=-size,dir
  2943. Value of the option is checked to include dir key and default
  2944. sorting key (name on *nix, iname on Windows). Here is what hap-
  2945. pens if one of them is missing:
  2946. - type key is added at the beginning;
  2947. - default key is added at the end;
  2948. all other keys are left untouched (at most they are moved).
  2949. This option also changes view columns according to primary sort-
  2950. ing key set, unless 'viewcolumns' option is not empty.
  2951. 'sortnumbers'
  2952. type: boolean
  2953. default: false
  2954. scope: local
  2955. Natural sort of (version) numbers within text.
  2956. 'sortgroups'
  2957. type: string
  2958. default: ""
  2959. scope: local
  2960. Sets comma-separated list of regular expressions to use for
  2961. group sorting, double comma is literal comma. Each expression
  2962. should contain at least one group or its value will be consid-
  2963. ered to be always empty. Only first match of each regular
  2964. expression is considered. Groups are considered from right to
  2965. first similar to 'sort', first group divides list of files into
  2966. sub-groups, each of which is sorted by the second group and so
  2967. on.
  2968. Example:
  2969. set sortgroups=-(done|todo).*
  2970. this would put files with "-done" in their names above all files
  2971. with "-todo".
  2972. 'sortorder'
  2973. type: enumeration
  2974. default: ascending
  2975. Sets sort order for primary key: ascending, descending.
  2976. 'statusline' 'stl'
  2977. type: string
  2978. default: ""
  2979. Determines the content of the status line (the line right above
  2980. command-line). Empty string means use same format like in pre-
  2981. vious versions. Following macros are supported:
  2982. - %t - file name (considering value of the 'classify' option)
  2983. - %T - symbolic link target (empty for other filetypes)
  2984. - %f - file name relative to current directory (considers 'clas-
  2985. sify')
  2986. - %A - file attributes (permissions on *nix or properties on
  2987. Windows) %u - user name or uid (if it cannot be resolved)
  2988. - %g - group name or gid (if it cannot be resolved)
  2989. - %s - file size in human readable format
  2990. - %E - size of selected files in human readable format, same as
  2991. %s when no files are selected, except that it will never show
  2992. size of ../ in visual mode, since it cannot be selected
  2993. - %d - file modification date (uses 'timefmt' option)
  2994. - %D - path of the other pane for single-pane layout
  2995. - %a - amount of free space available at current partition
  2996. - %z - short tips/tricks/hints that chosen randomly after one
  2997. minute period
  2998. - %{<expr>} - evaluate arbitrary vifm expression '<expr>', e.g.
  2999. '&sort'
  3000. - %* - resets or applies one of User1..User9 highlight groups;
  3001. reset happens when width field is 0 or not specified, one of
  3002. groups gets picked when width field is in the range from 1 to
  3003. 9
  3004. - all 'rulerformat' macros
  3005. Percent sign can be followed by optional minimum field width.
  3006. Add '-' before minimum field width if you want field to be right
  3007. aligned.
  3008. On Windows file properties include the following flags (upper
  3009. case means flag is on):
  3010. A - archive
  3011. H - hidden
  3012. I - content isn't indexed
  3013. R - readonly
  3014. S - system
  3015. C - compressed
  3016. D - directory
  3017. E - encrypted
  3018. P - reparse point (e.g. symbolic link)
  3019. Z - sparse file
  3020. Example without colors:
  3021. set statusline=" %t%= %A %10u:%-7g %15s %20d %{&sort} "
  3022. Example with colors:
  3023. highlight User1 ctermbg=yellow
  3024. highlight User2 ctermbg=blue ctermfg=white cterm=bold
  3025. set statusline="%1* %-26t %2* %= %1* %A %2* %7u:%-7g %1* %-5s %2* %d "
  3026. 'suggestoptions'
  3027. type: string list
  3028. default:
  3029. Controls when, for what and how suggestions are displayed. The
  3030. following values are available:
  3031. - normal - in normal mode;
  3032. - visual - in visual mode;
  3033. - view - in view mode;
  3034. - otherpane - use other pane to display suggestions, when
  3035. available;
  3036. - delay[:num] - display suggestions after a small delay (to
  3037. do not annoy if you just want to type a fast shortcut consisting
  3038. of multiple keys), num specifies the delay in ms (500 by
  3039. default), 'timeoutlen' at most;
  3040. - keys - include shortcuts (commands and selectors);
  3041. - foldsubkeys - fold multiple keys with common prefix;
  3042. - marks - include marks;
  3043. - registers[:num] - include registers, at most num files (5 by
  3044. default).
  3045. 'syncregs'
  3046. type: string
  3047. default:
  3048. Specifies identifier of group of instances that share registers
  3049. between each other. When several instances of vifm have this
  3050. option set to identical value, they automatically synchronize
  3051. contents of their registers on operations which use them.
  3052. 'syscalls'
  3053. type: boolean
  3054. default: false
  3055. When disabled, vifm will rely on external applications to per-
  3056. form file-system operations, otherwise system calls are used
  3057. instead (much faster and supports progress tracking). The
  3058. option should eventually be removed. Mostly *nix-like systems
  3059. are affected.
  3060. 'tabscope'
  3061. type: enumeration
  3062. default: global
  3063. Picks style of tabs, which defines what a single tab contains.
  3064. Possible values:
  3065. - global - tab describes complete UI of two views and how they
  3066. are arranged
  3067. - pane - tab is located "inside" a pane and manages it and
  3068. quick view
  3069. 'tabstop' 'ts'
  3070. type: integer
  3071. default: value from curses library
  3072. Number of spaces that a Tab in the file counts for.
  3073. 'timefmt'
  3074. type: string
  3075. default: "%m/%d %H:%M"
  3076. Format of time in file list. See "man 1 date" or "man 3 strf-
  3077. time" for details.
  3078. 'timeoutlen' 'tm'
  3079. type: integer
  3080. default: 1000
  3081. The time in milliseconds that is waited for a mapped key in case
  3082. of already typed key sequence is ambiguous.
  3083. 'title'
  3084. type: boolean
  3085. default: true when title can be restored, false otherwise
  3086. When enabled title of the terminal or terminal multiplexer's
  3087. window is updated according to current location.
  3088. 'trash'
  3089. type: boolean
  3090. default: true
  3091. Use trash directory. See "Trash directory" section below.
  3092. 'trashdir'
  3093. type: string
  3094. default: on *nix:
  3095. "%r/.vifm-Trash-%u,$VIFM/Trash,%r/.vifm-Trash"
  3096. or if $VIFM/Trash doesn't exist
  3097. "%r/.vifm-Trash-%u,$XDG_DATA_HOME/vifm/Trash,%r/.vifm-Trash"
  3098. on Windows:
  3099. "%r/.vifm-Trash,$XDG_DATA_HOME/vifm/Trash"
  3100. List of trash directory path specifications, separated with com-
  3101. mas. Each list item either defines an absolute path to trash
  3102. directory or a path relative to a mount point root when list
  3103. element starts with "%r/". Value of the option can contain
  3104. environment variables (of form "$envname"), which will be
  3105. expanded (prepend $ with a slash to prevent expansion). Envi-
  3106. ronment variables are expanded when the option is set.
  3107. On *nix, if element ends with "%u", the mark is replaced with
  3108. real user ID and permissions are set so that only that only
  3109. owner is able to use it.
  3110. Note that even this setup is not completely secure when combined
  3111. with "%r/" and it's overall safer to keep files in home direc-
  3112. tory, but that implies cost of copying files between partitions.
  3113. When new file gets cut (deleted) vifm traverses each element of
  3114. the option in the order of their appearance and uses first trash
  3115. directory that it was able to create or that is already
  3116. writable.
  3117. Default value tries to use trash directory per mount point and
  3118. falls back to ~/.vifm/Trash on failure.
  3119. Will attempt to create the directory if it does not exist. See
  3120. "Trash directory" section below.
  3121. 'tuioptions' 'to'
  3122. type: charset
  3123. default: "ps"
  3124. Each flag configures some aspect of TUI appearance. The flags
  3125. are:
  3126. p - when included:
  3127. * file list inside a pane gets additional single character
  3128. padding on left and right sides;
  3129. * quick view and view mode get single character padding.
  3130. s - when included, left and right borders (side borders, hence
  3131. "s" character) are visible.
  3132. u - use Unicode characters in the TUI (Unicode ellipsis instead
  3133. of "...").
  3134. 'undolevels' 'ul'
  3135. type: integer
  3136. default: 100
  3137. Maximum number of changes that can be undone. Note that here
  3138. single file operation is used as a unit, not operation, i.e.
  3139. deletion of 101 files will exceed default limit.
  3140. 'vicmd'
  3141. type: string
  3142. default: "vim"
  3143. The actual command used to start vi. Ampersand sign at the end
  3144. (regardless whether it's preceded by space or not) means back-
  3145. grounding of command.
  3146. Background flag is ignored in certain context where vifm waits
  3147. for the editor to finish. Such contexts include any command
  3148. that spawns editor to change list of file names or a command,
  3149. with :rename being one example. `-f` is also appended to pre-
  3150. vent forking in such cases, so the command needs to handle the
  3151. flag.
  3152. Additionally `+{num}` and `+'call cursor()'` arguments are used
  3153. to position cursor when location is known.
  3154. 'viewcolumns'
  3155. type: string
  3156. default: ""
  3157. scope: local
  3158. Format string containing list of columns in the view. When this
  3159. option is empty, view columns to show are chosen automatically
  3160. using sorting keys (see 'sort') as a base. Value of this option
  3161. is ignored if 'lsview' is set. See "Column view" section below
  3162. for format description.
  3163. An example of setting the options for both panes (note :windo
  3164. command):
  3165. windo set viewcolumns=-{name}..,6{size},11{perms}
  3166. 'vixcmd'
  3167. type: string
  3168. default: value of 'vicmd'
  3169. Same as 'vicmd', but takes precedence over it when running in X.
  3170. 'vifminfo'
  3171. type: set
  3172. default: bookmarks,bmarks
  3173. Controls what will be saved in the $VIFM/vifminfo file.
  3174. bmarks - named bookmarks
  3175. bookmarks - marks, except special ones like '< and '>
  3176. tui - state of the user interface (sorting, number of
  3177. windows, quick
  3178. view state, active view)
  3179. dhistory - directory history
  3180. state - file name and dot filters and terminal multiplex-
  3181. ers integration
  3182. state
  3183. cs - primary color scheme
  3184. savedirs - save last visited directory (requires dhistory)
  3185. chistory - command line history
  3186. shistory - search history (/ and ? commands)
  3187. phistory - prompt history
  3188. fhistory - history of local filter (see description of the
  3189. "=" normal mode
  3190. command)
  3191. dirstack - directory stack overwrites previous stack, unless
  3192. stack of
  3193. current session is empty
  3194. registers - registers content
  3195. options - all options that can be set with the :set command
  3196. (obsolete)
  3197. filetypes - associated programs and viewers (obsolete)
  3198. commands - user defined commands (see :command description)
  3199. (obsolete)
  3200. 'vimhelp'
  3201. type: boolean
  3202. default: false
  3203. Use vim help format.
  3204. 'wildmenu' 'wmnu'
  3205. type: boolean
  3206. default: false
  3207. Controls whether possible matches of completion will be shown
  3208. above the command line.
  3209. 'wildstyle'
  3210. type: enumeration
  3211. default: bar
  3212. Picks presentation style of wild menu. Possible values:
  3213. - bar - one-line with left-to-right cursor
  3214. - popup - multi-line with top-to-bottom cursor
  3215. 'wordchars'
  3216. type: string list
  3217. default: "1-8,14-31,33-255" (that is all non-whitespace charac-
  3218. ters)
  3219. Specifies which characters in command-line mode should be con-
  3220. sidered as part of a word. Value of the option is comma-sepa-
  3221. rated list of ranges. If both endpoints of a range match, sin-
  3222. gle endpoint is enough (e.g. "a" = "a-a"). Both endpoints are
  3223. inclusive. There are two accepted forms: character representing
  3224. itself or number encoding character according to ASCII table.
  3225. In case of ambiguous characters (dash, comma, digit) use numeric
  3226. form. Accepted characters are in the range from 0 to 255. Any
  3227. Unicode character with code greater than 255 is considered to be
  3228. part of a word.
  3229. The option affects Alt-D, Alt-B and Alt-F, but not Ctrl-W. This
  3230. is intentionally to allow two use cases:
  3231. - Moving by WORDS and deletion by words.
  3232. - Moving by words and deletion by WORDS.
  3233. To get the latter use the following mapping:
  3234. cnoremap <c-w> <a-b><a-d>
  3235. Also used for abbreviations.
  3236. 'wrap' type: boolean
  3237. default: true
  3238. Controls whether to wrap text in quick view.
  3239. 'wrapscan' 'ws'
  3240. type: boolean
  3241. default: true
  3242. Searches wrap around end of the list.
  3243. Mappings
  3244. Map arguments
  3245. LHS of mappings can be preceded by arguments which take the form of
  3246. special sequences:
  3247. <silent>
  3248. Postpone UI updates until RHS is completely processed.
  3249. <wait> In case of builtin mapping causing conflict for a user-defined
  3250. mapping (e.g., `t` builtin to a partially typed `ta` user-
  3251. defined mapping), ignore the builtin mapping and wait for input
  3252. indefinitely as opposed to default behaviour of triggering the
  3253. builtin mapping after a delay defined by 'timeoutlen'. Example:
  3254. nnoremap <wait> tw :set wrap!<cr>
  3255. nnoremap <wait> tn :set number!<cr>
  3256. nnoremap <wait> tr :set relativenumber!<cr>
  3257. Special sequences
  3258. Since it's not easy to enter special characters there are several spe-
  3259. cial sequences that can be used in place of them. They are:
  3260. <cr> Enter key.
  3261. <esc> Escape key.
  3262. <space>
  3263. Space key.
  3264. <lt> Less-than character (<).
  3265. <nop> provides a way to disable a mapping (by mapping it to <nop>).
  3266. <bs> Backspace key (see key conflict description below).
  3267. <tab> <s-tab>
  3268. Tabulation and Shift+Tabulation keys.
  3269. <home> <end>
  3270. Home/End.
  3271. <left> <right> <up> <down>
  3272. Arrow keys.
  3273. <pageup> <pagedown>
  3274. PageUp/PageDown.
  3275. <del> <delete>
  3276. Delete key. <del> and <delete> mean different codes, but
  3277. <delete> is more common.
  3278. <insert>
  3279. Insert key.
  3280. <c-a>,<c-b>,...,<c-z>,<c-[>,<c->,<c-]>,<c-^>,<c-_>
  3281. Control + some key (see key conflict description below).
  3282. <c-@> only for *nix
  3283. Control + Space.
  3284. <a-a>,<a-b>,...,<a-z>
  3285. <m-a>,<m-b>,...,<m-z> Alt + some key.
  3286. <a-c-a>,<a-c-b>,...,<a-c-z>
  3287. <m-c-a>,<m-c-b>,...,<m-c-z> only for *nix
  3288. Alt + Ctrl + some key.
  3289. <f0> - <f63>
  3290. Functional keys.
  3291. <c-f1> - <c-f12>
  3292. only for MS-Windows
  3293. functional keys with Control key pressed.
  3294. <a-f1> - <a-f12>
  3295. only for MS-Windows
  3296. functional keys with Alt key pressed.
  3297. <s-f1> - <s-f12>
  3298. only for MS-Windows
  3299. functional keys with Shift key pressed.
  3300. Note that due to the way terminals process their input, several key-
  3301. board keys might be mapped to single key code, for example:
  3302. - <cr> and <c-m>;
  3303. - <tab> and <c-i>;
  3304. - <c-h> and <bs>;
  3305. - etc.
  3306. Most of the time they are defined consistently and don't cause sur-
  3307. prises, but <c-h> and <bs> are treated differently in different envi-
  3308. ronments (although they match each other all the time), that's why they
  3309. correspond to different keys in vifm. As a consequence, if you map <c-
  3310. h> or <bs> be sure to repeat the mapping with the other one so that it
  3311. works in all environments. Alternatively, provide your mapping in one
  3312. form and add one of the following:
  3313. " if mappings with <c-h> in the LHS work
  3314. map <c-h> <bs>
  3315. " if mappings with <bs> in the LHS work
  3316. map <bs> <c-h>
  3317. Whitespace
  3318. vifm removes whitespace characters at the beginning and end of com-
  3319. mands. That's why you may want to use <space> at the end of rhs in
  3320. mappings. For example:
  3321. cmap <f1> man<space>
  3322. will put "man " in line when you hit the <f1> key in the command line
  3323. mode.
  3324. Expression syntax
  3325. Supported expressions is a subset of what VimL provides.
  3326. Expression syntax summary, from least to most significant:
  3327. expr1 expr2
  3328. expr2 || expr2 .. logical OR
  3329. expr2 expr3
  3330. expr3 && expr3 .. logical AND
  3331. expr3 expr4
  3332. expr4 == expr4 equal
  3333. expr4 != expr4 not equal
  3334. expr4 > expr4 greater than
  3335. expr4 >= expr4 greater than or equal
  3336. expr4 < expr4 smaller than
  3337. expr4 <= expr4 smaller than or equal
  3338. expr4 expr5
  3339. expr5 + expr5 .. number addition
  3340. expr5 - expr5 .. number subtraction
  3341. expr5 expr6
  3342. expr6 . expr6 .. string concatenation
  3343. expr6 expr7
  3344. - expr6 unary minus
  3345. + expr6 unary plus
  3346. ! expr6 logical NOT
  3347. expr7 number number constant
  3348. "string" string constant, \ is special
  3349. 'string' string constant, ' is doubled
  3350. &option option value
  3351. $VAR environment variable
  3352. v:var builtin variable
  3353. function(expr1, ...) function call
  3354. (expr1) nested expression
  3355. ".." indicates that the operations in this level can be concatenated.
  3356. expr1
  3357. -----
  3358. expr2 || expr2
  3359. Arguments are converted to numbers before evaluation.
  3360. Result is non-zero if at least one of arguments is non-zero.
  3361. It's right associative and with short-circuiting, so sub-expressions
  3362. are evaluated from left to right until result of whole expression is
  3363. determined (i.e., until first non-zero) or end of the expression.
  3364. expr2
  3365. -----
  3366. expr3 && expr3
  3367. Arguments are converted to numbers before evaluation.
  3368. Result is non-zero only if both arguments are non-zero.
  3369. It's right associative and with short-circuiting, so sub-expressions
  3370. are evaluated from left to right until result of whole expression is
  3371. determined (i.e., until first zero) or end of the expression.
  3372. expr3
  3373. -----
  3374. expr4 {cmp} expr4
  3375. Compare two expr4 expressions, resulting in a 0 if it evaluates to
  3376. false or 1 if it evaluates to true.
  3377. equal ==
  3378. not equal !=
  3379. greater than >
  3380. greater than or equal >=
  3381. smaller than <
  3382. smaller than or equal <=
  3383. Examples:
  3384. 'a' == 'a' == 1
  3385. 'a' > 'b' == 1
  3386. 'a' == 'b' == 0
  3387. '2' > 'b' == 0
  3388. 2 > 'b' == 1
  3389. 2 > '1b' == 1
  3390. 2 > '9b' == 0
  3391. -1 == -'1' == 1
  3392. 0 == '--1' == 1
  3393. expr4
  3394. -----
  3395. expr5 + expr5 .. number addition expr5 - expr5 .. number sub-
  3396. traction
  3397. Examples:
  3398. 1 + 3 - 3 == 1
  3399. 1 + '2' == 3
  3400. expr5
  3401. -----
  3402. expr6 . expr6 .. string concatenation
  3403. Examples:
  3404. 'a' . 'b' == 'ab'
  3405. 'aaa' . '' . 'c' == 'aaac'
  3406. expr6
  3407. -----
  3408. - expr6 unary minus
  3409. + expr6 unary plus
  3410. ! expr6 logical NOT
  3411. For '-' the sign of the number is changed.
  3412. For '+' the number is unchanged.
  3413. For '!' non-zero becomes zero, zero becomes one.
  3414. A String will be converted to a Number first.
  3415. These operations can be repeated and mixed. Examples:
  3416. --9 == 9
  3417. ---9 == -9
  3418. -+9 == 9
  3419. !-9 == 0
  3420. !'' == 1
  3421. !'x' == 0
  3422. !!9 == 1
  3423. expr7
  3424. -----
  3425. number number constant
  3426. -----
  3427. Decimal number. Examples:
  3428. 0 == 0
  3429. 0000 == 0
  3430. 01 == 1
  3431. 123 == 123
  3432. 10000 == 10000
  3433. string
  3434. ------
  3435. "string" string constant
  3436. Note that double quotes are used.
  3437. A string constant accepts these special characters:
  3438. \b backspace <bs>
  3439. \e escape <esc>
  3440. \n newline
  3441. \r return <cr>
  3442. \t tab <tab>
  3443. \\ backslash
  3444. \" double quote
  3445. Examples:
  3446. "\"Hello,\tWorld!\""
  3447. "Hi,\nthere!"
  3448. literal-string
  3449. --------------
  3450. 'string' string constant
  3451. Note that single quotes are used.
  3452. This string is taken as it is. No backslashes are removed or have a
  3453. special meaning. The only exception is that two quotes stand for one
  3454. quote.
  3455. Examples:
  3456. 'All\slashes\are\saved.'
  3457. 'This string contains doubled single quotes ''here'''
  3458. option
  3459. ------
  3460. &option option value (local one is preferred, if exists)
  3461. &g:option global option value &l:option local
  3462. option value
  3463. Examples:
  3464. echo 'Terminal size: '.&columns.'x'.&lines
  3465. if &columns > 100
  3466. Any valid option name can be used here (note that "all" in ":set all"
  3467. is a pseudo option). See ":set options" section above.
  3468. environment variable
  3469. --------------------
  3470. $VAR environment variable
  3471. The String value of any environment variable. When it is not defined,
  3472. the result is an empty string.
  3473. Examples:
  3474. 'This is my $PATH env: ' . $PATH
  3475. 'vifmrc at ' . $MYVIFMRC . ' is used.'
  3476. builtin variable
  3477. --------------------
  3478. v:var builtin variable
  3479. Information exposed by vifm for use in scripting.
  3480. v:count
  3481. count passed to : command, 0 by default. Can be used in mappings to
  3482. pass
  3483. count to a different command.
  3484. v:count1
  3485. same as v:count, but 1 by default.
  3486. v:servername
  3487. See below.
  3488. function call
  3489. -------------
  3490. function(expr1, ...) function call
  3491. See "Functions" section below.
  3492. Examples:
  3493. "'" . filetype('.') . "'"
  3494. filetype('.') == 'reg'
  3495. expression nesting
  3496. ------------------
  3497. (expr1) nested expression
  3498. Groups any other expression of arbitrary complexity enforcing order in
  3499. which operators are applied.
  3500. Functions
  3501. USAGE RESULT DESCRIPTION
  3502. chooseopt({opt}) String Queries choose parameters passed on
  3503. startup.
  3504. executable({expr}) Integer Checks whether {expr} command avail-
  3505. able.
  3506. expand({expr}) String Expands special keywords in {expr}.
  3507. filetype({fnum} [, {resolve}])
  3508. String Returns file type from position.
  3509. fnameescape({expr}) String Escapes {expr} for use in a :command.
  3510. getpanetype() String Returns type of current pane.
  3511. has({property}) Integer Checks whether instance has {prop-
  3512. erty}.
  3513. layoutis({type}) Integer Checks whether layout is of type
  3514. {type}.
  3515. paneisat({loc}) Integer Checks whether current pane is at
  3516. {loc}.
  3517. system({command}) String Executes shell command and returns
  3518. its output.
  3519. tabpagenr([{arg}]) Integer Returns number of current or last
  3520. tab.
  3521. term({command}) String Like system(), but for interactive
  3522. commands.
  3523. chooseopt({opt})
  3524. Retrieves values of options related to file choosing. {opt} can be one
  3525. of:
  3526. files returns argument of --choose-files or empty string
  3527. dir returns argument of --choose-dir or empty string
  3528. cmd returns argument of --on-choose or empty string
  3529. delimiter returns argument of --delimiter or the default one (\n)
  3530. executable({expr})
  3531. If {expr} is absolute or relative path, checks whether path destination
  3532. exists and refers to an executable, otherwise checks whether command
  3533. named {expr} is present in directories listed in $PATH. Checks for
  3534. various executable extensions on Windows. Returns boolean value
  3535. describing result of the check.
  3536. Example:
  3537. " use custom default viewer script if it's available and installed
  3538. " in predefined system directory, otherwise try to find it elsewhere
  3539. if executable('/usr/local/bin/defviewer')
  3540. fileview * /usr/local/bin/defviewer %c
  3541. else
  3542. if executable('defviewer')
  3543. fileview * defviewer %c
  3544. endif
  3545. endif
  3546. expand({expr})
  3547. Expands environment variables and macros in {expr} just like it's done
  3548. for command-line commands. Returns a string. See "Command macros"
  3549. section above.
  3550. Examples:
  3551. " percent sign
  3552. :echo expand('%%')
  3553. " the last part of directory name of the other pane
  3554. :echo expand('%D:t')
  3555. " $PATH environment variable (same as `:echo $PATH`)
  3556. :echo expand('$PATH')
  3557. filetype({fnum}[,{resolve}])
  3558. The result is a string, which represents file type and is one of the
  3559. list:
  3560. exe executables
  3561. reg regular files
  3562. link symbolic links
  3563. broken broken symbolic links (appears only when resolving)
  3564. dir directories
  3565. char character devices
  3566. block block devices
  3567. fifo pipes
  3568. sock *nix domain sockets
  3569. ? unknown file type (should not normally appear)
  3570. The result can also be an empty string in case of invalid argument.
  3571. Parameter {fnum} can have following values:
  3572. - '.' to get type of file under the cursor in the active pane
  3573. - numerical value base 1 to get type of file on specified line num-
  3574. ber
  3575. Optional parameter {resolve} is treated as a boolean and specifies
  3576. whether symbolic links should be resolved.
  3577. fnameescape({expr})
  3578. Escapes parameter to make it suitable for use as an argument of a :com-
  3579. mand. List of escaped characters includes %, which is doubled.
  3580. Usage example:
  3581. " navigate to most recently modified file in current directory
  3582. execute 'goto' fnameescape(system('ls -t | head -1'))
  3583. getpanetype()
  3584. Retrieves string describing type of current pane. Possible return val-
  3585. ues:
  3586. regular regular file listing of some directory
  3587. custom custom file list (%u)
  3588. very-custom very custom file list (%U)
  3589. tree tree view
  3590. has({property})
  3591. Allows examining internal parameters from scripts to e.g. figure out
  3592. environment in which application is running. Returns 1 if property is
  3593. true/present, otherwise 0 is returned. Currently the following proper-
  3594. ties are supported (anything else will yield 0):
  3595. unix runs in *nix-like environment (including Cygwin)
  3596. win runs on Windows
  3597. Usage example:
  3598. " skip user/group on Windows
  3599. if !has('win')
  3600. let $RIGHTS = '%10u:%-7g '
  3601. endif
  3602. execute 'set' 'statusline=" %t%= %A '.$RIGHTS.'%15E %20d "'
  3603. layoutis({type})
  3604. Checks whether current interface layout is {type} or not, where {type}
  3605. can be:
  3606. only single-pane mode
  3607. split double-pane mode (either vertical or horizon split)
  3608. vsplit vertical split (left and right panes)
  3609. hsplit horizontal split (top and bottom panes)
  3610. Usage example:
  3611. " automatically split vertically before enabling preview
  3612. :nnoremap w :if layoutis('only') | vsplit | endif | view!<cr>
  3613. paneisat({loc})
  3614. Checks whether position of active pane in current layout matches one of
  3615. the following locations:
  3616. top pane reaches top border
  3617. bottom pane reaches bottom border
  3618. left pane reaches left border
  3619. right pane reaches right border
  3620. system({command})
  3621. Runs the command in shell and returns its output (joined standard out-
  3622. put and standard error streams). All trailing newline characters are
  3623. stripped to allow easy appending to command output. Ctrl-C should
  3624. interrupt the command.
  3625. Use this function to consume output of external commands that don't
  3626. require user interaction and term() for interactive commands that make
  3627. use of terminal and are capable of handling stream redirection.
  3628. Usage example:
  3629. " command to enter .git/ directory of git-repository (when ran inside one)
  3630. command! cdgit :execute 'cd' system('git rev-parse --git-dir')
  3631. tabpagenr([{arg}])
  3632. When called without arguments returns number of current tab page base
  3633. one.
  3634. When called with "$" as an argument returns number of the last tab page
  3635. base one, which is the same as number of tabs.
  3636. term({command})
  3637. Same as system() function, but user interface is shutdown during the
  3638. execution of the command, which makes sure that external interactive
  3639. applications won't affect the way terminal is used by vifm.
  3640. Usage example:
  3641. " command to change directory by picking it via fzf
  3642. command! fzfcd :execute 'cd' "'".term('find -type d | fzf 2> /dev/tty')."'"
  3643. Menus and dialogs
  3644. When navigating to some path from a menu there is a difference in end
  3645. location depending on whether path has trailing slash or not. Files
  3646. normally don't have trailing slashes so "file/" won't work and one can
  3647. only navigate to a file anyway. On the other hand with directories
  3648. there are two options: navigate to a directory or inside of it. To
  3649. allow both use cases, the first one is used on paths like "dir" and the
  3650. second one for "dir/".
  3651. Commands
  3652. :range navigate to a menu line.
  3653. :exi[t][!] :q[uit][!] :x[it][!]
  3654. leave menu mode.
  3655. :noh[lsearch]
  3656. reset search match highlighting.
  3657. :w[rite] {dest}
  3658. write all menu lines into file specified by {dest}.
  3659. General
  3660. j, Ctrl-N - move down.
  3661. k, Ctrl-P - move up.
  3662. Enter, l - select and exit the menu.
  3663. Ctrl-L - redraw the menu.
  3664. Escape, Ctrl-C, ZZ, ZQ, q - quit.
  3665. In all menus
  3666. The following set of keys has the same meaning as in normal mode.
  3667. Ctrl-B, Ctrl-F
  3668. Ctrl-D, Ctrl-U
  3669. Ctrl-E, Ctrl-Y
  3670. /, ?
  3671. n, N
  3672. [count]G, [count]gg
  3673. H, M, L
  3674. zb, zt, zz
  3675. zh - scroll menu items [count] characters to the right.
  3676. zl - scroll menu items [count] characters to the left.
  3677. zH - scroll menu items half of screen width characters to the right.
  3678. zL - scroll menu items half of screen width characters to the left.
  3679. : - enter command line mode for menus (currently only :exi[t], :q[uit],
  3680. :x[it] and :{range} are supported).
  3681. b - interpret content of the menu as list of paths and use it to create
  3682. custom view in place of previously active pane. See "Custom views"
  3683. section below.
  3684. B - same as above, but creates unsorted view.
  3685. v - load menu content into quickfix list of the editor (Vim compatible
  3686. by assumption) or if list doesn't have separators after file names
  3687. (colons) open each line as a file name.
  3688. Below is description of additional commands and reaction on selection
  3689. in some menus and dialogs.
  3690. Apropos menu
  3691. Selecting menu item runs man on a given topic. Menu won't be closed
  3692. automatically to allow view several pages one by one.
  3693. Command-line mode abbreviations menu
  3694. Type dd on an abbreviation to remove it.
  3695. c leaves menu preserving file selection and inserts right-hand side of
  3696. selected command into command-line.
  3697. Color scheme menu
  3698. Selecting name of a color scheme applies it the same way as if ":col-
  3699. orscheme <name>" was executed on the command-line.
  3700. Commands menu
  3701. Selecting command executes it with empty arguments (%a).
  3702. dd on a command to remove.
  3703. Marks menu
  3704. Selecting mark navigates to it.
  3705. dd on a mark to remove it.
  3706. Bookmarks menu
  3707. Selecting a bookmark navigates to it.
  3708. Type dd on a bookmark to remove it.
  3709. gf and e also work to make it more convenient to bookmark files.
  3710. Trash (:lstrash) menu
  3711. r on a file name to restore it from trash.
  3712. dd deletes file under the cursor.
  3713. Trashes menu
  3714. dd empties selected trash in background.
  3715. Directory history and Trashes menus
  3716. Selecting directory name will change directory of the current view as
  3717. if :cd command was used.
  3718. Directory stack menu
  3719. Selecting directory name will rotate stack to put selected directory
  3720. pair at the top of the stack.
  3721. Filetype menu
  3722. Commands from vifmrc or typed in command-line are displayed above empty
  3723. line. All commands below empty line are from .desktop files.
  3724. c leaves menu preserving file selection and inserts command after :! in
  3725. command-line mode.
  3726. Grep, find, locate, bookmarks and user menu with navigation (%M macro)
  3727. gf - navigate previously active view to currently selected item.
  3728. Leaves menu mode except for grep menu. Pressing Enter key has the same
  3729. effect.
  3730. e - open selected path in the editor, stays in menu mode.
  3731. c - leave menu preserving file selection and insert file name after :!
  3732. in command-line mode.
  3733. User menu without navigation (%m macro)
  3734. c leaves menu preserving file selection and inserts whole line after :!
  3735. in command-line mode.
  3736. Grep menu
  3737. Selecting file (via Enter or l key) opens it in editor set by 'vicmd'
  3738. at given line number. Menu won't be closed automatically to allow
  3739. viewing more than one result.
  3740. See above for "gf" and "e" keys description.
  3741. Command-line history menu
  3742. Selecting an item executes it as command-line command, search query or
  3743. local filter.
  3744. c leaves menu preserving file selection and inserts line into command-
  3745. line of appropriate kind.
  3746. Volumes menu
  3747. Selecting a drive navigates previously active pane to the root of that
  3748. drive.
  3749. Fileinfo dialog
  3750. Enter, q - close dialog
  3751. Sort dialog
  3752. h, Space - switch ascending/descending.
  3753. q - close dialog
  3754. One shortcut per sorting key (see the dialog).
  3755. Attributes (permissions or properties) dialog
  3756. h, Space - check/uncheck.
  3757. q - close dialog
  3758. Item states:
  3759. - * - checked flag.
  3760. - X - means that it has different value for files in selection.
  3761. - d (*nix only) - (only for execute flags) means u-x+X, g-x+X or o-x+X
  3762. argument for the chmod program. If you're not on OS X and want to
  3763. remove execute permission bit from all files, but preserve it for
  3764. directories, set all execute flags to 'd' and check 'Set Recursively'
  3765. flag.
  3766. Jobs menu
  3767. dd requests cancellation of job under cursor. The job won't be removed
  3768. from the list, but marked as being cancelled (if cancellation was suc-
  3769. cessfully requested). A message will pop up if the job has already
  3770. stopped. Note that on Windows cancelling external programs like this
  3771. might not work, because their parent shell doesn't have any windows.
  3772. e key displays errors of selected job if any were collected. They are
  3773. displayed in a new menu, but you can get back to jobs menu by pressing
  3774. h.
  3775. Undolist menu
  3776. r - reset undo position to group under the cursor.
  3777. Media menu
  3778. r - reload the list.
  3779. m - mount/unmount device (cursor should be positioned on lines under
  3780. device information).
  3781. Custom views
  3782. Definition
  3783. Normally file views contain list of files from a single directory, but
  3784. sometimes it's useful to populate them with list of files that do not
  3785. belong to the same directory, which is what custom views are for.
  3786. Presentation
  3787. Custom views are still related to directory they were in before custom
  3788. list was loaded. Path to that directory (original directory) can be
  3789. seen in the title of a custom view.
  3790. Files in same directory have to be named differently, this doesn't hold
  3791. for custom views thus seeing just file names might be rather confusing.
  3792. In order to give an idea where files come from and when possible, rela-
  3793. tive paths to original directory of the view is displayed, otherwise
  3794. full path is used instead.
  3795. Custom views normally don't contain any inexistent files.
  3796. Navigation
  3797. Custom views have some differences related to navigation in regular
  3798. views.
  3799. gf - acts similar to gf on symbolic links and navigates to the file at
  3800. its real
  3801. location.
  3802. h - go to closes parent node in tree view, otherwise return to the
  3803. original directory.
  3804. gh - return to the original directory.
  3805. Opening ".." entry also causes return to the original directory.
  3806. History
  3807. Custom list exists only while it's visible, once left one can't return
  3808. to it, so there is no appearances of it in any history.
  3809. Filters
  3810. Only local filter affects content of the view. This is intentional,
  3811. presumably if one loads list, precisely that list should be displayed
  3812. (except for inexistent paths, which are ignored).
  3813. Search
  3814. Although directory names are visible in listing, they are not search-
  3815. able. Only file names are taken into account (might be changed in
  3816. future, searching whole lines seems quite reasonable).
  3817. Sorting
  3818. Contrary to search sorting by name works on whole visible part of file
  3819. path.
  3820. Highlight
  3821. Whole file name is highlighted as one entity, even if there are direc-
  3822. tory elements.
  3823. Updates
  3824. Reloads can occur, though they are not automatic due to files being
  3825. scattered among different places. On a reload, inexistent files are
  3826. removed and meta-data of all other files is updated.
  3827. Once custom view forgets about the file, it won't add it back even if
  3828. it's created again. So not seeing file previously affected by an oper-
  3829. ation, which was undone is normal.
  3830. Operations
  3831. All operations that add files are forbidden for custom views. For
  3832. example, moving/copying/putting files into a custom view doesn't work,
  3833. because it doesn't make much sense.
  3834. On the other hand, operations that use files of a custom view as a
  3835. source (e.g. yanking, copying, moving file from custom view, deletion)
  3836. and operations that modify names are all allowed.
  3837. Compare views
  3838. Kinds
  3839. :compare can produce four different results depending on arguments:
  3840. - single compare view (ofone and either listall or listdups);
  3841. - single custom view (ofone and listunique);
  3842. - two compare views (ofboth and either listall or listdups);
  3843. - two custom views (ofboth and listunique).
  3844. The first two display files of one file system tree. Here duplicates
  3845. are files that have at least one copy in the same tree. The other two
  3846. kinds of operation compare two trees, in which duplicates are files
  3847. that are found in both trees.
  3848. Lists of unique files are presented in custom views because there is no
  3849. file grouping to preserve as all file ids are guaranteed to be dis-
  3850. tinct.
  3851. Creation
  3852. Arguments passed to :compare form four categories each with its own
  3853. prefix and is responsible for particular property of operation.
  3854. Which files to compare:
  3855. - ofboth - compares files of two panes against each other;
  3856. - ofone - compares files of the same directory.
  3857. How files are compared:
  3858. - byname - by their name only;
  3859. - bysize - only by their size;
  3860. - bycontents - by combination of size and hash of file contents.
  3861. Which files to display:
  3862. - listall - all files;
  3863. - listunique - unique files only;
  3864. - listdups - only duplicated files.
  3865. How results are grouped (has no effect if "ofone" specified):
  3866. - groupids - files considered identical are always adjacent in out-
  3867. put;
  3868. - grouppaths - file system ordering is preferred (this also enables
  3869. displaying identically named files as mismatches).
  3870. Which files to omit:
  3871. - skipempty - ignore empty files.
  3872. Each argument can appear multiple times, the rightmost one of the group
  3873. is considered. Arguments alter default behaviour instead of substitut-
  3874. ing it.
  3875. Examples
  3876. The defaults corresponds to probably the most common use case of com-
  3877. paring files in two trees with grouping by paths, so the following are
  3878. equivalent:
  3879. :compare
  3880. :compare bycontents grouppaths
  3881. :compare bycontents listall ofboth grouppaths
  3882. Another use case is to find duplicates in the current sub-tree:
  3883. :compare listdups ofone
  3884. The following command lists files that are unique to each pane:
  3885. :compare listunique
  3886. Look
  3887. The view can't switch to ls-like view as it's unable to display diff-
  3888. like data.
  3889. Comparison views have second column displaying id of the file, files
  3890. with same id are considered to be equal. The view columns configura-
  3891. tion is predefined.
  3892. Behaviour
  3893. When two views are being compared against each other the following
  3894. changes to the regular behaviour apply:
  3895. - views are scrolled synchronously (as if 'scrollbind' was set);
  3896. - views' cursors are synchronized;
  3897. - local filtering is disabled (its results wouldn't be meaningful);
  3898. - zd excludes groups of adjacent identical files, 1zd gives usual be-
  3899. haviour;
  3900. - sorting is permanently disabled (ordering is fixed);
  3901. - removed files hide their counter pairs;
  3902. - exiting one of the views terminates the other immediately;
  3903. - renaming files isn't blocked, but isn't taken into account and might
  3904. require regeneration of comparison;
  3905. - entries which indicate absence of equivalent file have empty names
  3906. and can be matched as such;
  3907. - when unique files of both views are listed custom views can be
  3908. empty, this absence of unique files is stated clearly.
  3909. One compare view has similar properties (those that are applicable for
  3910. single pane).
  3911. Files are gathered in this way:
  3912. - recursively starting at current location of the view;
  3913. - dot files are excluded if view hides them at the moment of compari-
  3914. son;
  3915. - directories are not taken into account;
  3916. - symbolic links to directories are ignored.
  3917. Startup
  3918. On startup vifm determines several variables that are used during the
  3919. session. They are determined in the order they appear below.
  3920. On *nix systems $HOME is normally present and used as is. On Windows
  3921. systems vifm tries to find correct home directory in the following
  3922. order:
  3923. - $HOME variable;
  3924. - $USERPROFILE variable (on Windows only);
  3925. - a combination of $HOMEDRIVE and $HOMEPATH variables (on Windows
  3926. only).
  3927. vifm tries to find correct configuration directory by checking the fol-
  3928. lowing places:
  3929. - $VIFM variable;
  3930. - parent directory of the executable file (on Windows only);
  3931. - $HOME/.vifm directory;
  3932. - $APPDATA/Vifm directory (on Windows only);
  3933. - $XDG_CONFIG_HOME/vifm directory;
  3934. - $HOME/.config/vifm directory.
  3935. vifm tries to find correct configuration file by checking the following
  3936. places:
  3937. - $MYVIFMRC variable;
  3938. - vifmrc in parent directory of the executable file (on Windows only);
  3939. - $VIFM/vifmrc file.
  3940. Configure
  3941. See "Startup" section above for the explanations on $VIFM and $MYV-
  3942. IFMRC.
  3943. The vifmrc file contains commands that will be executed on vifm
  3944. startup. There are two such files: global and local. Global one is at
  3945. {prefix}/etc/vifm/vifmrc, see $MYVIFMRC variable description for the
  3946. search algorithm used to find local vifmrc. Global vifmrc is loaded
  3947. before the local one, so that the later one can redefine anything con-
  3948. figured globally.
  3949. Use vifmrc to set settings, mappings, filetypes etc. To use multi line
  3950. commands precede each next line with a slash (whitespace before slash
  3951. is ignored, but all spaces at the end of the lines are saved). For
  3952. example:
  3953. set
  3954. \smartcase
  3955. equals "setsmartcase". When
  3956. set<space here>
  3957. \ smartcase
  3958. equals "set smartcase".
  3959. The $VIFM/vifminfo file contains session settings. You may edit it by
  3960. hand to change the settings, but it's not recommended to do that, edit
  3961. vifmrc instead. You can control what settings will be saved in
  3962. vifminfo by setting 'vifminfo' option. Vifm always writes this file on
  3963. exit unless 'vifminfo' option is empty. Marks, bookmarks, commands,
  3964. histories, filetypes, fileviewers and registers in the file are merged
  3965. with vifm configuration (which has bigger priority).
  3966. Generally, runtime configuration has bigger priority during merging,
  3967. but there are some exceptions:
  3968. - directory stack stored in the file is not overwritten unless some-
  3969. thing is changed in vifm session that performs merge;
  3970. - each mark or bookmark is marked with a timestamp, so that newer
  3971. value is not overwritten by older one, thus no matter from where it
  3972. comes, the newer one wins.
  3973. The $VIFM/scripts directory can contain shell scripts. vifm modifies
  3974. its PATH environment variable to let user run those scripts without
  3975. specifying full path. All subdirectories of the $VIFM/scripts will be
  3976. added to PATH too. Script in a subdirectory overlaps script with the
  3977. same name in all its parent directories.
  3978. The $VIFM/colors/ and {prefix}/etc/vifm/colors/ directories contain
  3979. color schemes. Available color schemes are searched in that order, so
  3980. on name conflict the one in $VIFM/colors/ wins.
  3981. Each color scheme should have ".vifm" extension. This wasn't the case
  3982. before and for this reason the following rules apply during lookup:
  3983. - if there is no file with .vifm extension, all regular files are
  3984. listed;
  3985. - otherwise only files with .vifm extension are listed (with the
  3986. extension being truncated).
  3987. Automatic FUSE mounts
  3988. vifm has a builtin support of automated FUSE file system mounts. It is
  3989. implemented using file associations mechanism. To enable automated
  3990. mounts, one needs to use a specially formatted program line in filetype
  3991. or filextype commands. Currently two formats are supported:
  3992. 1) FUSE_MOUNT This format should be used in case when all information
  3993. needed for mounting all files of a particular type is the same. E.g.
  3994. mounting of tar files don't require any file specific options.
  3995. Format line:
  3996. FUSE_MOUNT|mounter %SOURCE_FILE %DESTINATION_DIR [%FOREGROUND]
  3997. Example filetype command:
  3998. :filetype FUSE_MOUNT|fuse-zip %SOURCE_FILE %DESTINATION_DIR
  3999. 2) FUSE_MOUNT2 This format allows one to use specially formatted files
  4000. to perform mounting and is useful for mounting remotes, for example
  4001. remote file systems over ftp or ssh.
  4002. Format line:
  4003. FUSE_MOUNT2|mounter %PARAM %DESTINATION_DIR [%FOREGROUND]
  4004. Example filetype command:
  4005. :filetype FUSE_MOUNT2|sshfs %PARAM %DESTINATION_DIR
  4006. Example file content:
  4007. root@127.0.0.1:/
  4008. All % macros are expanded by vifm at runtime and have the following
  4009. meaning:
  4010. - %SOURCE_FILE is replaced by full path to selected file;
  4011. - %DESTINATION_DIR is replaced by full path to mount directory, which
  4012. is created by vifm basing on the value of 'fusehome' option;
  4013. - %PARAM value is filled from the first line of file (whole line),
  4014. though in the future it can be changed to whole file content;
  4015. - %FOREGROUND means that you want to run mount command as a regular
  4016. command (required to be able to provide input for communication with
  4017. mounter in interactive way).
  4018. %FOREGROUND is an optional macro. Other macros are not mandatory, but
  4019. mount commands likely won't work without them.
  4020. %CLEAR is obsolete name of %FOREGROUND, which is still supported, but
  4021. might be removed in future. Its use is discouraged.
  4022. The mounted FUSE file systems will be automatically unmounted in two
  4023. cases:
  4024. - when vifm quits (with ZZ, :q, etc. or when killed by signal);
  4025. - when you explicitly leave mount point going up to its parent direc-
  4026. tory (with h, Enter on "../" or ":cd ..") and other pane is not in
  4027. the same directory or its child directories.
  4028. View look
  4029. vifm supports displaying of file list view in two different ways:
  4030. - in a table mode, when multiple columns can be set using 'view-
  4031. columns' option (see "Column view" section below for details);
  4032. - in a multicolumn list manner which looks almost like `ls -x` com-
  4033. mand output (see "ls-like view" section below for details).
  4034. The look is local for each view and can be chosen by changing value of
  4035. the 'lsview' boolean option.
  4036. Depending on view look some of keys change their meaning to allow more
  4037. natural cursor moving. This concerns mainly h, j, k, l and other simi-
  4038. lar navigation keys.
  4039. Also some of options can be ignored if they don't affect view display-
  4040. ing in selected look. For example value of 'viewcolumns' when 'lsview'
  4041. is set.
  4042. ls-like view
  4043. When this view look is enabled by setting 'lsview' option on, vifm will
  4044. display files in multiple columns. Number of columns depends on the
  4045. length of the longest file name present in current directory of the
  4046. view. Whole file list is automatically reflowed on directory change,
  4047. terminal or view resize.
  4048. View looks close to output of `ls -x` command, so files are listed left
  4049. to right in rows.
  4050. In this mode file manipulation commands (e.g. d) don't work line-wise
  4051. like they do in Vim, since such operations would be uncommon for file
  4052. manipulation tasks. Thus, for example, dd will remove only current
  4053. file.
  4054. By default the view is filled by lines, 'lsoptions' can be used to get
  4055. filling by columns.
  4056. Note that tree-view and compare view inhibit ls-like view.
  4057. Column view
  4058. View columns are described by a comma-separated list of column descrip-
  4059. tions, each of which has the following format
  4060. [ '-' ] [ fw ( [ '.' tw ] | '%' ) ] '{' type '}' '.'{0,3}
  4061. where fw stands for full width and tw stands for text width.
  4062. So it basically consists of four parts:
  4063. 1. Optional alignment specifier
  4064. 2. Optional width specifier
  4065. 3. Mandatory column name
  4066. 4. Optional cropping specifier
  4067. Alignment specifier
  4068. It's an optional minus or asterisk sign as the first symbol of the
  4069. string.
  4070. Specifies type of text alignment within a column. Three types are sup-
  4071. ported:
  4072. - left align
  4073. set viewcolumns=-{name}
  4074. - right align (default)
  4075. set viewcolumns={name}
  4076. - dynamic align
  4077. It's like left alignment, but when the text is bigger than the col-
  4078. umn, the alignment is made at the right (so the part of the field is
  4079. always visible).
  4080. set viewcolumns=*{name}
  4081. Width specifier
  4082. It's a number followed by a percent sign, two numbers (second one
  4083. should be less than or equal to the first one) separated with a dot or
  4084. a single number.
  4085. Specifies column width and its units. There are three size types:
  4086. - absolute size - column width is specified in characters
  4087. set viewcolumns=-100{name},20.15{ext}
  4088. results in two columns with lengths of 100 and 20 and a reserved
  4089. space of five characters on the left of second column.
  4090. - relative (percent) size - column width is specified in percents of
  4091. view width
  4092. set viewcolumns=-80%{name},15%{ext},5%{mtime}
  4093. results in three columns with lengths of 80/100, 15/100 and 5/100 of
  4094. view width.
  4095. - auto size (default) - column width is automatically determined
  4096. set viewcolumns=-{name},{ext},{mtime}
  4097. results in three columns with length of one third of view width.
  4098. There is no size adjustment to content, since it will slow down ren-
  4099. dering.
  4100. Columns of different sizing types can be freely mixed in one view.
  4101. Though sometimes some of columns can be seen partly or be completely
  4102. invisible if there is not enough space to display them.
  4103. Column name
  4104. This is just a sort key surrounded with curly braces or {root}, e.g.
  4105. {name},{ext},{mtime}
  4106. {name} and {iname} keys are the same and present both for consistency
  4107. with 'sort' option.
  4108. Following keys don't have corresponding sorting keys:
  4109. - {root} - display name without extension (as a complement for {ext})
  4110. Empty curly braces ({}) are replaced with the default secondary column
  4111. for primary sort key. So after the next command view will be displayed
  4112. almost as if 'viewcolumns' is empty, but adding ellipsis for long file
  4113. names:
  4114. set viewcolumns=-{name}..,6{}.
  4115. Cropping specifier
  4116. It's from one to three dots after closing curly brace in column format.
  4117. Specifies type of text truncation if it doesn't fit in the column.
  4118. Currently three types are supported:
  4119. - truncation - text is truncated
  4120. set viewcolumns=-{name}.
  4121. results in truncation of names that are too long too fit in the
  4122. view.
  4123. - adding of ellipsis - ellipsis on the left or right are added when
  4124. needed
  4125. set viewcolumns=-{name}..
  4126. results in that ellipsis are added at the end of too long file
  4127. names.
  4128. - none (default) - text can pass column boundaries
  4129. set viewcolumns=-{name}...,{ext}
  4130. results in that long file names can partially be written on the ext
  4131. column.
  4132. Color schemes
  4133. The color schemes in vifm can be applied in two different ways:
  4134. - as the primary color scheme;
  4135. - as local to a pane color scheme.
  4136. Both types are set using :colorscheme command, but of different forms:
  4137. - :colorscheme color_scheme_name - for the primary color scheme;
  4138. - :colorscheme color_scheme_name directory - for local color schemes.
  4139. Look of different parts of the TUI (Text User Interface) is determined
  4140. in this way:
  4141. - Border, TabLine, TabLineSel, TopLineSel, TopLine, CmdLine,
  4142. ErrorMsg, StatusLine, JobLine, SuggestBox and WildMenu are always
  4143. determined by the primary color scheme;
  4144. - CurrLine, Selected, Directory, Link, BrokenLink, Socket, Device,
  4145. Executable, Fifo, CmpMismatch, Win and AuxWin are determined by
  4146. primary color scheme and a set of local color schemes, which can be
  4147. empty.
  4148. There might be a set of local color schemes because they are structured
  4149. hierarchically according to file system structure. For example, having
  4150. the following piece of file system:
  4151. ~
  4152. `-- bin
  4153. |
  4154. `-- my
  4155. Two color schemes:
  4156. # ~/.vifm/colors/for_bin
  4157. highlight Win cterm=none ctermfg=white ctermbg=red
  4158. highlight CurrLine cterm=none ctermfg=red ctermbg=black
  4159. # ~/.vifm/colors/for_bin_my
  4160. highlight CurrLine cterm=none ctermfg=green ctermbg=black
  4161. And these three commands in the vifmrc file:
  4162. colorscheme Default
  4163. colorscheme for_bin ~/bin
  4164. colorscheme for_bin_my ~/bin/my
  4165. File list will look in the following way for each level:
  4166. - ~/ - Default color scheme
  4167. black background
  4168. cursor with blue background
  4169. - ~/bin/ - mix of Default and for_bin color schemes
  4170. red background
  4171. cursor with black background and red foreground
  4172. - ~/bin/my/ - mix of Default, for_bin and for_bin_my color schemes
  4173. red background
  4174. cursor with black background and green foreground
  4175. Trash directory
  4176. vifm has support of trash directory, which is used as temporary storage
  4177. for deleted files or files that were cut. Using trash is controlled by
  4178. the 'trash' option, and exact path to the trash can be set with
  4179. 'trashdir' option. Trash directory in vifm differs from the system-
  4180. wide one by default, because of possible incompatibilities of storing
  4181. deleted files among different file managers. But one can set
  4182. 'trashdir' to "~/.local/share/Trash" to use a "standard" trash direc-
  4183. tory.
  4184. There are two scenarios of using trash in vifm:
  4185. 1. As a place for storing files that were cut by "d" and may be
  4186. inserted to some other place in file system.
  4187. 2. As a storage of files, that are deleted but not purged yet.
  4188. The first scenario uses deletion ("d") operations to put files to trash
  4189. and put ("p") operations to restore files from trash directory. Note
  4190. that such operations move files to and from trash directory, which can
  4191. be long term operations in case of different partitions or remote
  4192. drives mounted locally.
  4193. The second scenario uses deletion ("d") operations for moving files to
  4194. trash directory and :empty command-line command to purge all previously
  4195. deleted files.
  4196. Deletion and put operations depend on registers, which can point to
  4197. files in trash directory. Normally, there are no nonexistent files in
  4198. registers, but vifm doesn't keep track of modifications under trash
  4199. directory, so one shouldn't expect value of registers to be absolutely
  4200. correct if trash directory was modified not by operation that are meant
  4201. for it. But this won't lead to any issues with operations, since they
  4202. ignore nonexistent files.
  4203. Client-Server
  4204. vifm supports remote execution of command-line mode commands, remote
  4205. changing of directories and expression evaluation. This is possible
  4206. using --remote and --remote-expr command-line arguments.
  4207. To execute a command remotely combine --remote argument with -c <com-
  4208. mand> or +<command>. For example:
  4209. vifm --remote -c 'cd /'
  4210. vifm --remote '+cd /'
  4211. To change directory not using command-line mode commands one can spec-
  4212. ify paths right after --remote argument, like this:
  4213. vifm --remote /
  4214. vifm --remote ~
  4215. vifm --remote /usr/bin /tmp
  4216. Evaluating expression remotely might be useful to query information
  4217. about an instance, for example its location:
  4218. vifm --remote-expr 'expand("%d")'
  4219. If there are several running instances, the target can be specified
  4220. with --server-name option (otherwise, the first one lexicographically
  4221. is used):
  4222. vifm --server-name work --remote ~/work/project
  4223. List of names of running instances can be obtained via --server-list
  4224. option. Name of the current one is available via v:servername.
  4225. v:servername
  4226. server name of the running vifm instance. Empty if client-
  4227. server feature is disabled.
  4228. Plugin
  4229. Plugin for using vifm in vim as a file selector.
  4230. Commands:
  4231. :EditVifm select a file or files to open in the current buffer.
  4232. :SplitVifm split buffer and select a file or files to open.
  4233. :VsplitVifm vertically split buffer and select a file or files to
  4234. open.
  4235. :DiffVifm select a file or files to compare to the current file
  4236. with
  4237. :vert diffsplit.
  4238. :TabVifm select a file or files to open in tabs.
  4239. Each command accepts up to two arguments: left pane directory and right
  4240. pane directory. After arguments are checked, vifm process is spawned
  4241. in a special "file-picker" mode. To pick files just open them either
  4242. by pressing l, i or Enter keys, or by running :edit command. If no
  4243. files are selected, file under the cursor is opened, otherwise whole
  4244. selection is passed to the plugin and opened in vim.
  4245. The plugin have only two settings. It's a string variable named
  4246. g:vifm_term to let user specify command to run GUI terminal. By
  4247. default it's equal to 'xterm -e'. And another string variable named
  4248. g:vifm_exec, which equals "vifm" by default and specifies path to
  4249. vifm's executable. To pass arguments to vifm use g:vifm_exec_args,
  4250. which is empty by default.
  4251. To use the plugin copy the vifm.vim file to either the system wide
  4252. vim/plugin directory or into ~/.vim/plugin.
  4253. If you would prefer not to use the plugin and it is in the system wide
  4254. plugin directory add
  4255. let loaded_vifm=1
  4256. to your ~/.vimrc file.
  4257. Reserved
  4258. The following command names are reserved and shouldn't be used for user
  4259. commands.
  4260. g[lobal]
  4261. v[global]
  4262. ENVIRONMENT
  4263. VIFM Points to main configuration directory (usually ~/.vifm/).
  4264. MYVIFMRC
  4265. Points to main configuration file (usually ~/.vifm/vifmrc).
  4266. These environment variables are valid inside vifm and also can be used
  4267. to configure it by setting some of them before running vifm.
  4268. When $MYVIFMRC isn't set, it's made as $VIFM/vifmrc (exception for Win-
  4269. dows: vifmrc in the same directory as vifm.exe has higher priority than
  4270. $VIFM/vifmrc).
  4271. See "Startup" section above for more details.
  4272. VIFM_FUSE_FILE
  4273. On execution of external commands this variable is set to the
  4274. full path of file used to initiate FUSE mount of the closes
  4275. mount point from current pane directory up. It's not set when
  4276. outside FUSE mount point. When vifm is used inside terminal
  4277. multiplexer, it tries to set this variable as well (it doesn't
  4278. work this way on its own).
  4279. SEE ALSO
  4280. vifm-convert-dircolors(1), vifm-pause(1)
  4281. Website: https://vifm.info/
  4282. Wiki: https://wiki.vifm.info/
  4283. Esperanto translation of the documentation by Sebastian Cyprych:
  4284. http://cyprych.neostrada.pl/tekstoj/komputiloj/vifm-help.eo.html
  4285. AUTHOR
  4286. Vifm was written by ksteen <ksteen@users.sourceforge.net>
  4287. And currently is developed by xaizek <xaizek@posteo.net>
  4288. vifm 0.10 November 11, 2018 VIFM(1)