mc.1.in 122 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184
  1. .\"TOPICS "Topics:"
  2. .TH MC 1 "@DATE_OF_MAN_PAGE@" "MC Version @DISTR_VERSION@" "GNU Midnight Commander"
  3. .\"SKIP_SECTION"
  4. .SH "NAME"
  5. mc \- Visual shell for Unix\-like systems.
  6. .\"SKIP_SECTION"
  7. .SH "USAGE"
  8. .B mc
  9. [\-abcCdfhPstuUVx] [\-l log] [dir1 [dir2]] [\-e [file]] [\-v file]
  10. .\"NODE "DESCRIPTION"
  11. .SH "DESCRIPTION"
  12. GNU Midnight Commander is a directory browser/file manager for
  13. Unix\-like operating systems.
  14. .\"NODE "OPTIONS"
  15. .\"DONT_SPLIT"
  16. .SH "OPTIONS"
  17. .TP
  18. .I \-a, \-\-stickchars
  19. Disable usage of graphic characters for line drawing.
  20. .TP
  21. .I \-b, \-\-nocolor
  22. Force black and white display.
  23. .TP
  24. .I \-c, \-\-color
  25. Force color mode, please check the section
  26. .\"LINK2"
  27. Colors
  28. .\"Colors"
  29. for more information.
  30. .TP
  31. .I \-C arg, \-\-colors=arg
  32. Specify a different color set in the command line. The format of arg is
  33. documented in the
  34. .\"LINK2"
  35. Colors
  36. .\"Colors"
  37. section.
  38. .TP
  39. .I \-S arg
  40. Specify a name of skin in the command line. Technology of skins is
  41. documented in the
  42. .\"LINK2"
  43. Skins\&.
  44. .\"Skins"
  45. section.
  46. .TP
  47. .I \-d, \-\-nomouse
  48. Disable mouse support.
  49. .TP
  50. .I \-e [file], \-\-edit[=file]
  51. Start the internal editor. If the file is specified, open it on
  52. startup. See also
  53. .BR "mcedit (1)" .
  54. .TP
  55. .I \-f, \-\-datadir
  56. Display the compiled\-in search paths for Midnight Commander files.
  57. .TP
  58. .I \-F, \-\-datadir\-info
  59. Display extended info about compiled\-in paths for
  60. Midnight Commander.
  61. .TP
  62. .I \-\-configure\-options
  63. Display configure options.
  64. .TP
  65. .I \-k, \-\-resetsoft
  66. Reset softkeys to their default from the termcap/terminfo
  67. database. Only useful on HP terminals when the function keys don't work.
  68. .TP
  69. .I \-K file
  70. Specify a name of keymap file in the command line.
  71. .TP
  72. .I \-\-nokeymap
  73. Don't load key bindings from any file, use default hardcoded keys.
  74. .TP
  75. .I \-l file, \-\-ftplog=file
  76. Save the ftpfs dialog with the server in file.
  77. .TP
  78. .I \-P file, \-\-printwd=file
  79. Print the last working directory to the specified file. This option is
  80. not meant to be used directly. Instead, it's used from a special shell
  81. script that automatically changes the current directory of the shell to
  82. the last directory the Midnight Commander was in. Source the file
  83. .B @prefix@/share/mc/bin/mc.sh
  84. (bash and zsh users) or
  85. .B @prefix@/share/mc/bin/mc.csh
  86. (tcsh users) respectively to define
  87. .B mc
  88. as an alias to the appropriate shell script.
  89. .TP
  90. .I \-s
  91. Set alternative mode drawing of frameworks.
  92. If the section [Lines] is not filled, the symbol for the pseudographics
  93. frame is a space, otherwise the frame characters are taken from follow params.
  94. .B You can redefine the following variables:
  95. .TP
  96. .B lefttop
  97. left\-top corner
  98. .TP
  99. .B righttop
  100. right\-top corner
  101. .TP
  102. .B centertop
  103. center\-top cross
  104. .TP
  105. .B centerbottom
  106. center\-bottom cross
  107. .TP
  108. .B leftbottom
  109. left\-bottom corner
  110. .TP
  111. .B rightbottom
  112. right\-bottom corner
  113. .TP
  114. .B leftmiddle
  115. left\-middle cross
  116. .TP
  117. .B rightmiddle
  118. right\-middle cross
  119. .TP
  120. .B centermiddle
  121. center cross
  122. .TP
  123. .B horiz
  124. default horizontal line
  125. .TP
  126. .B vert
  127. default vertical line
  128. .TP
  129. .B thinhoriz
  130. thin horizontal line
  131. .TP
  132. .B thinvert
  133. thin vertical line
  134. .TP
  135. .I \-t, \-\-termcap
  136. Used only if the code was compiled with Slang and terminfo: it makes
  137. the Midnight Commander use the value of the
  138. .B TERMCAP
  139. variable for the terminal information instead of the information on
  140. the system wide terminal database
  141. .TP
  142. .I \-u, \-\-nosubshell
  143. Disable use of the concurrent shell (only makes sense if the Midnight
  144. Commander has been built with concurrent shell support).
  145. .TP
  146. .I \-U, \-\-subshell
  147. Enable use of the concurrent shell support (only makes sense if the
  148. Midnight Commander was built with the subshell support set as an
  149. optional feature).
  150. .TP
  151. .I \-v file, \-\-view=file
  152. Start the internal viewer to view the specified file. See also
  153. .BR "mcview (1)" .
  154. .TP
  155. .I \-V, \-\-version
  156. Display the version of the program.
  157. .TP
  158. .I \-x, \-\-xterm
  159. Force xterm mode. Used when running on xterm\-capable terminals (two
  160. screen modes, and able to send mouse escape sequences).
  161. .TP
  162. .I \-g, \-\-oldmouse
  163. Force a "normal tracking" mouse mode. Used when running on
  164. xterm\-capable terminals (tmux/screen).
  165. .PP
  166. If specified, the first path name is the directory to show in the
  167. selected panel; the second path name is the directory to be shown in
  168. the other panel.
  169. .\"NODE "Overview"
  170. .SH "Overview"
  171. The screen of the Midnight Commander is divided into four parts.
  172. Almost all of the screen space is taken up by two directory panels.
  173. By default, the second line from the bottom of the screen is the
  174. shell command line, and the bottom line shows the function key labels.
  175. The topmost line is the
  176. .\"LINK2"
  177. menu bar line\&.
  178. .\"Menu Bar"
  179. The menu bar line may not be visible, but appears if you click the
  180. topmost line with the mouse or press the F9 key.
  181. .PP
  182. The Midnight Commander provides a view of two directories at the same
  183. time. One of the panels is the current panel (a selection bar is in
  184. the current panel). Almost all operations take place on the current
  185. panel. Some file operations like Rename and Copy by default use the
  186. directory of the unselected panel as a destination (don't worry, they
  187. always ask you for confirmation first). For more information, see the
  188. sections on the
  189. .\"LINK2"
  190. Directory Panels\&,
  191. .\"Directory Panels"
  192. the
  193. .\"LINK2"
  194. Left and Right Menus
  195. .\"Left and Right Menus"
  196. and the
  197. .\"LINK2"
  198. File Menu\&.
  199. .\"File Menu"
  200. .PP
  201. You can execute system commands from the Midnight Commander by simply
  202. typing them. Everything you type will appear on the shell command line,
  203. and when you press Enter the Midnight Commander will execute the
  204. command line you typed; read the
  205. .\"LINK2"
  206. Shell Command Line
  207. .\"Shell Command Line"
  208. and
  209. .\"LINK2"
  210. Input Line Keys
  211. .\"Input Line Keys"
  212. sections to learn more about the command line.
  213. .\"NODE "Mouse Support"
  214. .SH "Mouse Support"
  215. The Midnight Commander comes with mouse support. It is activated
  216. whenever you are running on an
  217. .B xterm(1)
  218. terminal (it even works if you take a telnet, ssh or rlogin connection to
  219. another machine from the xterm) or if you are running on a Linux
  220. console and have the
  221. .B gpm
  222. mouse server running.
  223. .PP
  224. When you left click on a file in the directory panels, that file is
  225. selected; if you click with the right button, the file is marked (or
  226. unmarked, depending on the previous state).
  227. .PP
  228. Double\-clicking on a file will try to execute the command if it is
  229. an executable program; and if the
  230. .\"LINK2"
  231. extension file
  232. .\"Extension File Edit"
  233. has a program specified for the file's extension, the specified
  234. program is executed.
  235. .PP
  236. Also, it is possible to execute the commands assigned to the function
  237. key labels by clicking on them.
  238. .PP
  239. The default auto repeat rate for the mouse buttons is 400
  240. milliseconds. This may be changed to other values by editing the
  241. .\"LINK2"
  242. \&~/.config/mc/ini
  243. .\"Save Setup"
  244. file and changing the
  245. .I mouse_repeat_rate
  246. parameter.
  247. .PP
  248. If you are running the Midnight Commander with the mouse support, you
  249. can get the default mouse behavior (cutting and pasting text) by holding
  250. down the Shift key.
  251. .SH ""
  252. .\"NODE "Keys"
  253. .SH "Keys"
  254. Some commands in the Midnight Commander involve the use of the
  255. .I Control
  256. (sometimes labeled CTRL or CTL) and the
  257. .I Meta
  258. (sometimes labeled ALT or even Compose) keys. In this manual we will
  259. use the following abbreviations:
  260. .TP
  261. .B C\-<chr>
  262. means hold the Control key while typing the character <chr>.
  263. Thus C\-f would be: hold the Control key and type f.
  264. .TP
  265. .B Alt\-<chr>
  266. means hold the Meta or Alt key down while typing <chr>.
  267. If there is no Meta or Alt key, type
  268. .IR ESC ,
  269. release it, then type the character <chr>.
  270. .TP
  271. .B S\-<chr>
  272. means hold the Shift key down while typing <chr>.
  273. .PP
  274. All input lines in the Midnight Commander use an approximation to
  275. the GNU Emacs editor's key bindings (default).
  276. .PP
  277. You may redefine key bindings. See
  278. .\"LINK2"
  279. .I redefine hotkey bindings
  280. .\"Keys_redefine"
  281. .PP
  282. for more info. All other key bindings (described in this manual) relative
  283. to default behavior.
  284. .PP
  285. There are many sections which tell about the keys. The following are
  286. the most important.
  287. .PP
  288. The
  289. .\"LINK2"
  290. File Menu
  291. .\"File Menu"
  292. section documents the keyboard shortcuts for the commands appearing in
  293. the File menu. This section includes the function keys. Most of these
  294. commands perform some action, usually on the selected file or the
  295. tagged files.
  296. .PP
  297. The
  298. .\"LINK2"
  299. Directory Panels
  300. .\"Directory Panels"
  301. section documents the keys which select a file or tag files as a
  302. target for a later action (the action is usually one from the file
  303. menu).
  304. .PP
  305. The
  306. .\"LINK2"
  307. Shell Command Line
  308. .\"Shell Command Line"
  309. section list the keys which are used for entering and editing command
  310. lines. Most of these copy file names and such from the directory
  311. panels to the command line (to avoid excessive typing) or access the
  312. command line history.
  313. .PP
  314. .\"LINK2"
  315. Input Line Keys
  316. .\"Input Line Keys"
  317. are used for editing input lines. This means both the command line and
  318. the input lines in the query dialogs.
  319. .\"NODE " Keys_redefine"
  320. .SH " Redefine hotkey bindings"
  321. Hotkey bindings may be read from external file (keymap\-file).
  322. A keymap\-file is searched on the following algorithm (to the first one found):
  323. .IP
  324. .br
  325. 1) command line option
  326. .B \-K \<keymap\>
  327. or
  328. .B \-\-keymap=\<keymap\>
  329. .br
  330. 2) Environment variable
  331. .B MC_KEYMAP
  332. .br
  333. 3) Parameter
  334. .B keymap
  335. in section
  336. .B [Midnight\-Commander]
  337. of config file.
  338. .br
  339. 4) File
  340. .B ~/.local/share/mc/mc.keymap
  341. .br
  342. 5) File
  343. .B @sysconfdir@/mc/mc.keymap
  344. .br
  345. 6) File
  346. .B @prefix@/share/mc/mc.keymap
  347. .PP
  348. Command line option, environment variable and parameter in config file may
  349. contain the absolute path to the keymap\-file (with the extension \.keymap
  350. or without it). Search of keymap\-file will occur in (to the first one found):
  351. .IP
  352. .br
  353. 1)
  354. .B ~/.local/share/mc
  355. .br
  356. 2)
  357. .B @sysconfdir@/mc/
  358. .br
  359. 3)
  360. .B @prefix@/share/mc/
  361. .\"NODE " Miscellaneous Keys"
  362. .SH " Miscellaneous Keys"
  363. Here are some keys which don't fall into any of the other categories:
  364. .TP
  365. .B Enter
  366. if there is some text in the command line (the one at the bottom of
  367. the panels), then that command is executed. If there is no text in the
  368. command line then if the selection bar is over a directory the
  369. Midnight Commander does a
  370. .B chdir(2)
  371. to the selected directory and reloads the information on the panel;
  372. if the selection is an executable file then it is executed. Finally,
  373. if the extension of the selected file name matches one of the
  374. extensions in the
  375. .\"LINK2"
  376. extensions file
  377. .\"Extension File Edit"
  378. then the corresponding command is executed.
  379. .TP
  380. .B C\-l
  381. repaint all the information in the Midnight Commander.
  382. .TP
  383. .B C\-x c
  384. run the
  385. .\"LINK2"
  386. Chmod
  387. .\"Chmod"
  388. command on a file or on the tagged files.
  389. .TP
  390. .B C\-x o
  391. run the
  392. .\"LINK2"
  393. Chown
  394. .\"Chown"
  395. command on the current file or on the tagged files.
  396. .TP
  397. .B C\-x l
  398. run the hard link command.
  399. .TP
  400. .B C\-x s
  401. run the absolute symbolic link command.
  402. .TP
  403. .B C\-x v
  404. run the relative symbolic link command. See the
  405. .\"LINK2"
  406. File Menu
  407. .\"File Menu"
  408. section for more information about symbolic links.
  409. .TP
  410. .B C\-x i
  411. set the other panel display mode to information.
  412. .TP
  413. .B C\-x q
  414. set the other panel display mode to quick view.
  415. .TP
  416. .B C\-x !
  417. execute the
  418. .\"LINK2"
  419. External panelize
  420. .\"External panelize"
  421. command.
  422. .TP
  423. .B C\-x h
  424. run the
  425. .\"LINK2"
  426. add directory to hotlist
  427. .\"Hotlist"
  428. command.
  429. .TP
  430. .B Alt\-!
  431. executes the Filtered view command, described in the
  432. .\"LINK2"
  433. view command\&.
  434. .\"Internal File Viewer"
  435. .TP
  436. .B Alt\-?
  437. executes the
  438. .\"LINK2"
  439. Find file
  440. .\"Find File"
  441. command.
  442. .TP
  443. .B Alt\-c
  444. pops up the
  445. .\"LINK2"
  446. quick cd
  447. .\"Quick cd"
  448. dialog.
  449. .TP
  450. .B C\-o
  451. when the program is being run in the Linux or FreeBSD console or under
  452. an xterm, it will show you the output of the previous command. When ran
  453. on the Linux console, the Midnight Commander uses an external program
  454. (cons.saver) to handle saving and restoring of information on the
  455. screen.
  456. .PP
  457. When the subshell support is compiled in, you can type C\-o at any time
  458. and you will be taken back to the Midnight Commander main screen, to
  459. return to your application just type C\-o. If you have an application
  460. suspended by using this trick, you won't be able to execute other
  461. programs from the Midnight Commander until you terminate the suspended
  462. application.
  463. .\"NODE " Directory Panels"
  464. .SH " Directory Panels"
  465. This section lists the keys which operate on the directory panels. If
  466. you want to know how to change the appearance of the panels take a
  467. look at the section on
  468. .\"LINK2"
  469. Left and Right Menus\&.
  470. .\"Left and Right Menus"
  471. .TP
  472. .B Tab, C\-i
  473. change the current panel. The old other panel becomes the new current
  474. panel and the old current panel becomes the new other panel. The
  475. selection bar moves from the old current panel to the new current
  476. panel.
  477. .TP
  478. .B Insert, C\-t
  479. to tag files you may use the Insert key (the kich1 terminfo sequence).
  480. To untag files, just retag a tagged file.
  481. .TP
  482. .B M\-e
  483. to change charset of panel you may use M\-e (Alt\-e).
  484. Recoding is made from selected codepage into system codepage. To
  485. cancel the recoding you may select "directory up" (..) in active panel.
  486. To cancel the charsets in all directories, select "No translation " in
  487. the dialog of encodings.
  488. .TP
  489. .B Alt\-g, Alt\-r, Alt\-j
  490. used to select the top file in a panel, the middle file and the bottom one,
  491. respectively.
  492. .TP
  493. .B Alt\-t
  494. toggle the current display listing to show the next display listing
  495. mode.
  496. With this it is possible to quickly switch to brief listing, long
  497. listing, user defined listing mode, and back to the default.
  498. .TP
  499. .B C\-\\\\ (control\-backslash)
  500. show the
  501. .\"LINK2"
  502. directory hotlist
  503. .\"Hotlist"
  504. and change to the selected directory.
  505. .TP
  506. .B + \ (plus)
  507. this is used to select (tag) a group of files. The Midnight Commander
  508. will prompt for a selection options. When
  509. .I Files only
  510. checkbox is on, only files will be selected. If
  511. .I Files only
  512. is off, as files as directories will be selected.
  513. When
  514. .I Shell Patterns
  515. checkbox is on, the regular expression is much like the filename globbing
  516. in the shell (* standing for zero or more characters and ? standing
  517. for one character). If
  518. .I Shell Patterns
  519. is off, then the tagging of files is done with normal regular
  520. expressions (see ed (1)). When
  521. .I Case sensitive
  522. checkbox is on, the selection will be case sensitive characters.
  523. If
  524. .I Case sensitive
  525. is off, the case will be ignored.
  526. .TP
  527. .B \\\\ (backslash)
  528. use the "\\" key to unselect a group of files. This is the opposite of
  529. the Plus key.
  530. .TP
  531. .B up\-key, C\-p
  532. move the selection bar to the previous entry in the panel.
  533. .TP
  534. .B down\-key, C\-n
  535. move the selection bar to the next entry in the panel.
  536. .TP
  537. .B home, a1, Alt\-<
  538. move the selection bar to the first entry in the panel.
  539. .TP
  540. .B end, c1, Alt\->
  541. move the selection bar to the last entry in the panel.
  542. .TP
  543. .B next\-page, C\-v
  544. move the selection bar one page down.
  545. .TP
  546. .B prev\-page, Alt\-v
  547. move the selection bar one page up.
  548. .TP
  549. .B Alt\-o
  550. If the currently selected file is a directory, load that directory on
  551. the other panel and moves the selection to the next file. If the
  552. currently selected file is not a directory, load the parent directory
  553. on the other panel and moves the selection to the next file.
  554. .TP
  555. .B Alt\-i
  556. make the current directory of the current panel also the current
  557. directory of the other panel. Put the other panel to the listing mode
  558. if needed. If the current panel is panelized, the other panel doesn't
  559. become panelized.
  560. .TP
  561. .B C\-PageUp, C\-PageDown
  562. only when supported by the terminal: change to ".." and to the currently
  563. selected directory respectively.
  564. .TP
  565. .B Alt\-y
  566. moves to the previous directory in the history, equivalent to clicking
  567. the
  568. .I <
  569. with the mouse.
  570. .TP
  571. .B Alt\-u
  572. moves to the next directory in the history, equivalent to clicking the
  573. .I >
  574. with the mouse.
  575. .TP
  576. .B Alt\-Shift\-h, Alt\-H
  577. displays the directory history, equivalent to depressing the 'v' with
  578. the mouse.
  579. .\"NODE " Quick search"
  580. .SH " Quick search"
  581. The Quick search mode allows to perform fast file search in file panel.
  582. Press
  583. .I C\-s
  584. or
  585. .I Alt\-s
  586. to start a filename search in the directory listing.
  587. .P
  588. When the search is active, the user input will be added to the search string
  589. instead of the command line. If the
  590. .I Show mini\-status
  591. option is enabled the search string is shown on the mini\-status
  592. line. When typing, the selection bar will move to the next file
  593. starting with the typed letters. The
  594. .I Backspace
  595. or
  596. .I DEL
  597. keys can be used to correct typing mistakes. If C\-s is pressed
  598. again, the next match is searched for.
  599. .P
  600. If quick search is started with double pressing of C\-s, the previous quick
  601. search pattern will be used for current search.
  602. .P
  603. Besides the filename characters, you can also use wildcard
  604. characters '*' and '?'.
  605. .\"NODE " Shell Command Line"
  606. .SH " Shell Command Line"
  607. This section lists keys which are useful to avoid excessive typing when
  608. entering shell commands.
  609. .TP
  610. .B Alt\-Enter
  611. copy the currently selected file name to the command line.
  612. .TP
  613. .B C\-Enter
  614. same a Alt\-Enter. May not work on remote systems and some terminals.
  615. .TP
  616. .B C\-Shift\-Enter
  617. copy the full path name of the currently selected file to the command
  618. line. May not work on remote systems and some terminals.
  619. .TP
  620. .B Alt\-Tab
  621. does the filename, command, variable, username and hostname
  622. .\"LINK2"
  623. completion
  624. .\"Completion"
  625. for you.
  626. .TP
  627. .B C\-x t, C\-x C\-t
  628. copy the tagged files (or if there are no tagged files, the selected
  629. file) of the current panel (C\-x t) or of the other panel (C\-x C\-t) to
  630. the command line.
  631. .TP
  632. .B C\-x p, C\-x C\-p
  633. the first key sequence copies the current path name to the command
  634. line, and the second one copies the unselected panel's path name to
  635. the command line.
  636. .TP
  637. .B C\-q
  638. the quote command can be used to insert characters that are otherwise
  639. interpreted by the Midnight Commander (like the '+' symbol)
  640. .TP
  641. .B Alt\-p, Alt\-n
  642. use these keys to browse through the command history. Alt\-p takes you
  643. to the last entry, Alt\-n takes you to the next one.
  644. .TP
  645. .B Alt\-h
  646. displays the history for the current input line.
  647. .\"NODE " General Movement Keys"
  648. .SH " General Movement Keys"
  649. The help viewer, the file viewer and the directory tree use common
  650. code to handle moving. Therefore they accept exactly the same
  651. keys. Each of them also accepts some keys of its own.
  652. .PP
  653. Other parts of the Midnight Commander use some of the same movement
  654. keys, so this section may be of use for those parts too.
  655. .TP
  656. .B Up, C\-p
  657. moves one line backward.
  658. .TP
  659. .B Down, C\-n
  660. moves one line forward.
  661. .TP
  662. .B Prev Page, Page Up, Alt\-v
  663. moves one page up.
  664. .TP
  665. .B Next Page, Page Down, C\-v
  666. moves one page down.
  667. .TP
  668. .B Home, A1
  669. moves to the beginning.
  670. .TP
  671. .B End, C1
  672. move to the end.
  673. .PP
  674. The help viewer and the file viewer accept the following keys in
  675. addition the to ones mentioned above:
  676. .TP
  677. .B b, C\-b, C\-h, Backspace, Delete
  678. moves one page up.
  679. .TP
  680. .B Space bar
  681. moves one page down.
  682. .TP
  683. .B u, d
  684. moves one half of a page up or down.
  685. .TP
  686. .B g, G
  687. moves to the beginning or to the end.
  688. .\"NODE " Input Line Keys"
  689. .SH " Input Line Keys"
  690. The input lines (they are used for the
  691. .\"LINK2"
  692. command line
  693. .\"Shell Command Line"
  694. and for the query dialogs in the program) accept these keys:
  695. .TP
  696. .B C\-a
  697. puts the cursor at the beginning of line.
  698. .TP
  699. .B C\-e
  700. puts the cursor at the end of the line.
  701. .TP
  702. .B C\-b, move\-left
  703. move the cursor one position left.
  704. .TP
  705. .B C\-f, move\-right
  706. move the cursor one position right.
  707. .TP
  708. .B Alt\-f
  709. moves one word forward.
  710. .TP
  711. .B Alt\-b
  712. moves one word backward.
  713. .TP
  714. .B C\-h, Backspace
  715. delete the previous character.
  716. .TP
  717. .B C\-d, Delete
  718. delete the character in the point (over the cursor).
  719. .TP
  720. .B C\-@
  721. sets the mark for cutting.
  722. .TP
  723. .B C\-w
  724. copies the text between the cursor and the mark to a kill buffer and
  725. removes the text from the input line.
  726. .TP
  727. .B Alt\-w
  728. copies the text between the cursor and the mark to a kill buffer.
  729. .TP
  730. .B C\-y
  731. yanks back the contents of the kill buffer.
  732. .TP
  733. .B C\-k
  734. kills the text from the cursor to the end of the line.
  735. .TP
  736. .B Alt\-p, Alt\-n
  737. Use these keys to browse through the command history. Alt\-p takes you
  738. to the last entry, Alt\-n takes you to the next one.
  739. .TP
  740. .B Alt\-C\-h, Alt\-Backspace
  741. delete one word backward.
  742. .TP
  743. .B Alt\-Tab
  744. does the filename, command, variable, username and hostname
  745. .\"LINK2"
  746. completion
  747. .\"Completion"
  748. for you.
  749. .SH ""
  750. .\"NODE "Menu Bar"
  751. .SH "Menu Bar"
  752. The menu bar pops up when you press F9 or click the mouse on the top
  753. row of the screen. The menu bar has five menus: "Left", "File",
  754. "Command", "Options" and "Right".
  755. .PP
  756. The
  757. .\"LINK2"
  758. Left and Right Menus
  759. .\"Left and Right Menus"
  760. allow you to modify the appearance of the left and right directory
  761. panels.
  762. .PP
  763. The
  764. .\"LINK2"
  765. File Menu
  766. .\"File Menu"
  767. lists the actions you can perform on the currently selected file or
  768. the tagged files.
  769. .PP
  770. The
  771. .\"LINK2"
  772. Command Menu
  773. .\"Command Menu"
  774. lists the actions which are more general and bear no relation to the
  775. currently selected file or the tagged files.
  776. .PP
  777. The
  778. .\"LINK2"
  779. Options Menu
  780. .\"Options Menu"
  781. lists the actions which allow you to customize the Midnight Commander.
  782. .\"NODE " Left and Right Menus"
  783. .SH " Left and Right (Above and Below) Menus"
  784. The outlook of the directory panels can be changed from the
  785. .B Left
  786. and
  787. .B Right
  788. menus (they are named
  789. .B Above
  790. and
  791. .B Below
  792. when the horizontal panel split is chosen from the
  793. .\"LINK2"
  794. Layout
  795. .\"Layout"
  796. options dialog).
  797. .\"NODE " Listing Mode..."
  798. .SH " Listing Mode..."
  799. The listing mode view is used to display a listing of files, there are
  800. four different listing modes available:
  801. .BR Full ,
  802. .BR Brief ,
  803. .B Long
  804. and
  805. .BR User .
  806. The full directory view shows the file name, the size of the file and
  807. the modification time.
  808. .PP
  809. The brief view shows only the file name and it has two columns
  810. (therefore showing twice as many files as other views). The long view
  811. is similar to the output of
  812. .B "ls \-l"
  813. command. The long view takes the whole screen width.
  814. .PP
  815. If you choose the "User" display format, then you have to specify
  816. the display format.
  817. .PP
  818. The user display format must start with a panel size specifier. This
  819. may be "half" or "full", and they specify a half screen panel and a
  820. full screen panel respectively.
  821. .PP
  822. After the panel size, you may specify the two columns mode on the
  823. panel, this is done by adding the number "2" to the user format
  824. string.
  825. .PP
  826. After this you add the name of the fields with an optional size
  827. specifier. This are the available fields you may display:
  828. .TP
  829. .B name
  830. displays the file name.
  831. .TP
  832. .B size
  833. displays the file size.
  834. .TP
  835. .B bsize
  836. is an alternative form of the
  837. .B size
  838. format. It displays the size of the files and for directories it just
  839. shows SUB\-DIR or UP\-\-DIR.
  840. .TP
  841. .B type
  842. displays a one character wide type field. This character is similar to
  843. what is displayed by ls with the \-F flag \-
  844. .B *
  845. for executable files,
  846. .B /
  847. for directories,
  848. .B @
  849. for links,
  850. .B =
  851. for sockets,
  852. .B \-
  853. for character devices,
  854. .B +
  855. for block devices,
  856. .B |
  857. for pipes,
  858. .B ~
  859. for symbolic links to directories and
  860. .B !
  861. for stale symlinks (links that point nowhere).
  862. .TP
  863. .B mark
  864. an asterisk if the file is tagged, a space if it's not.
  865. .TP
  866. .B mtime
  867. file's last modification time.
  868. .TP
  869. .B atime
  870. file's last access time.
  871. .TP
  872. .B ctime
  873. file's status change time.
  874. .TP
  875. .B perm
  876. a string representing the current permission bits of the file.
  877. .TP
  878. .B mode
  879. an octal value with the current permission bits of the file.
  880. .TP
  881. .B nlink
  882. the number of links to the file.
  883. .TP
  884. .B ngid
  885. the GID (numeric).
  886. .TP
  887. .B nuid
  888. the UID (numeric).
  889. .TP
  890. .B owner
  891. the owner of the file.
  892. .TP
  893. .B group
  894. the group of the file.
  895. .TP
  896. .B inode
  897. the inode of the file.
  898. .PP
  899. Also you can use following keywords to define the panel layout:
  900. .TP
  901. .B space
  902. a space in the display format.
  903. .TP
  904. .B |
  905. add a vertical line to the display format.
  906. .PP
  907. To force one field to a fixed size (a size specifier), you just add
  908. .B :
  909. followed by the number of characters you want the field to have. If the
  910. number is followed by the symbol
  911. .BR + ,
  912. then the size specifies the minimal field size \- if the program finds
  913. out that there is more space on the screen, it will then expand that
  914. field.
  915. .PP
  916. For example, the
  917. .B Full
  918. display corresponds to this format:
  919. .PP
  920. half type name | size | mtime
  921. .PP
  922. And the
  923. .B Long
  924. display corresponds to this format:
  925. .PP
  926. full perm space nlink space owner space group space size space mtime
  927. space name
  928. .PP
  929. This is a nice user display format:
  930. .PP
  931. half name | size:7 | type mode:3
  932. .PP
  933. Panels may also be set to the following modes:
  934. .TP
  935. .B "Info"
  936. The info view display information related to the currently
  937. selected file and if possible information about the current file
  938. system.
  939. .TP
  940. .B "Tree"
  941. The tree view is quite similar to the
  942. .\"LINK2"
  943. directory tree
  944. .\"Directory Tree"
  945. feature. See the section about it for more information.
  946. .TP
  947. .B "Quick View"
  948. In this mode, the panel will switch to a reduced
  949. .\"LINK2"
  950. viewer
  951. .\"Internal File Viewer"
  952. that displays the contents of the currently selected file, if you
  953. select the panel (with the tab key or the mouse), you will have access
  954. to the usual viewer commands.
  955. .\"NODE " Sort Order..."
  956. .SH " Sort Order..."
  957. The eight sort orders are by name, by extension, by modification time,
  958. by access time, and by inode information modification time, by size,
  959. by inode and unsorted. In the Sort order dialog box you can choose
  960. the sort order and you may also specify if you want to sort in reverse
  961. order by checking the reverse box.
  962. .PP
  963. By default directories are sorted before files but this can be changed
  964. from the
  965. .\"LINK2"
  966. Panel options
  967. .\"Panel options"
  968. menu (option
  969. .BR "Mix all files" ).
  970. .\"NODE " Filter..."
  971. .SH " Filter..."
  972. The filter command allows you to specify a shell pattern (for example
  973. .BR "*.tar.gz" )
  974. which the files must match to be shown. Regardless
  975. of the filter pattern, the directories and the links to directories
  976. are always shown in the directory panel.
  977. .\"NODE " Reread"
  978. .SH " Reread"
  979. The reread command reload the list of files in the directory. It is
  980. useful if other processes have created or removed files.
  981. .\"NODE " File Menu"
  982. .SH " File Menu"
  983. The Midnight Commander uses the F1 \- F10 keys as keyboard shortcuts
  984. for commands appearing in the file menu. The escape sequences for the
  985. function keys are terminfo capabilities kf1 trough kf10. On terminals
  986. without function key support, you can achieve the same functionality by
  987. pressing the ESC key and then a number in the range 1 through 9 and 0
  988. (corresponding to F1 to F9 and F10 respectively).
  989. .PP
  990. The File menu has the following commands (keyboard shortcuts in parentheses):
  991. .PP
  992. .B Help (F1)
  993. .PP
  994. Invokes the built\-in hypertext help viewer. Inside the
  995. .\"LINK2"
  996. help viewer\&,
  997. .\"Contents"
  998. you can use the Tab key to select the next link and the Enter key to
  999. follow that link. The keys Space and Backspace are used to move
  1000. forward and backward in a help page. Press F1 again to get the full
  1001. list of accepted keys.
  1002. .PP
  1003. .B Menu (F2)
  1004. .PP
  1005. Invoke the
  1006. .\"LINK2"
  1007. user menu\&.
  1008. .\"Menu File Edit"
  1009. The user menu provides an easy way to provide users with a menu and
  1010. add extra features to the Midnight Commander.
  1011. .PP
  1012. .B View (F3, F13)
  1013. .PP
  1014. View the currently selected file. By default this invokes the
  1015. .\"LINK2"
  1016. Internal File Viewer
  1017. .\"Internal File Viewer"
  1018. but if the option "Use internal view" is off, it invokes an external
  1019. file viewer specified by the
  1020. .B VIEWER
  1021. environment variable. If
  1022. .B VIEWER
  1023. is undefined, the
  1024. .B PAGER
  1025. environment variable is tried. If
  1026. .B PAGER
  1027. is also undefined, the "view" command is invoked. If you use F13
  1028. instead, the viewer will be invoked without doing any formatting or
  1029. preprocessing to the file.
  1030. .PP
  1031. .B Filtered View (Alt\-!)
  1032. .PP
  1033. This command prompts for a command
  1034. and its arguments (the argument defaults to the currently selected
  1035. file name), the output from such command is shown in the internal file
  1036. viewer.
  1037. .PP
  1038. .B Edit (F4, F14)
  1039. .PP
  1040. Press F4 to edit the highlighted file. Press F14 (usually F14)
  1041. to start the editor with a new, empty file.
  1042. Currently they invoke the
  1043. .B vi
  1044. editor, or the editor specified in the
  1045. .B EDITOR
  1046. environment variable, or the
  1047. .\"LINK2"
  1048. Internal File Editor
  1049. .\"Internal File Editor"
  1050. if the use_internal_edit option is on.
  1051. .PP
  1052. .B Copy (F5, F15)
  1053. .PP
  1054. Press F5 to pop up an input dialog to copy the currently selected file (or
  1055. the tagged files, if there is at least one file tagged) to the
  1056. directory/filename you specify in the input dialog. The destination
  1057. defaults to the directory in the non\-selected panel. Space for destination
  1058. file may be preallocated relative to preallocate_space configure option.
  1059. During this process, you can press C\-c or ESC to abort the operation.
  1060. For details about source mask (which will be usually either * or ^\\(.*\\)$
  1061. depending on setting of Use shell patterns) and possible wildcards in the
  1062. destination see
  1063. .\"LINK2"
  1064. Mask copy/rename\&.
  1065. .\"Mask Copy/Rename"
  1066. .PP
  1067. F15 (usually F15) is similar, but defaults to the directory in the
  1068. selected panel. It always operates on the selected file, regardless of
  1069. any tagged files.
  1070. .PP
  1071. On some systems, it is possible to do the copy in the background by
  1072. clicking on the background button (or pressing Alt\-b in the dialog
  1073. box). The
  1074. .\"LINK2"
  1075. Background Jobs
  1076. .\"Background jobs"
  1077. is used to control the background process.
  1078. .PP
  1079. .B Link (C\-x l)
  1080. .PP
  1081. Create a hard link to the current file.
  1082. .PP
  1083. .B Absolute symlink (C\-x s)
  1084. .PP
  1085. Create a absolute symbolic link to the current file.
  1086. .PP
  1087. .B Relative symLink (C\-x v)
  1088. .PP
  1089. Create a relative symbolic link to the current file.
  1090. .PP
  1091. To those of you who don't know what links are: creating a link to a file
  1092. is a bit like copying the file, but both the source filename and the destination
  1093. filename represent the same file image. For example, if you edit one of these
  1094. files, all changes you make will appear in both files. Some people call
  1095. links aliases or shortcuts.
  1096. .PP
  1097. A hard link appears as a real file. After making it, there is no way of
  1098. telling which one is the original and which is the link. If you delete
  1099. either one of them the other one is still intact. It is very difficult
  1100. to notice that the files represent the same image. Use hard links when
  1101. you don't even want to know.
  1102. .PP
  1103. A symbolic link is a reference to the name of the original file. If
  1104. the original file is deleted the symbolic link is useless. It is quite
  1105. easy to notice that the files represent the same image. The Midnight
  1106. Commander shows an "@"\-sign in front of the file name if it is a
  1107. symbolic link to somewhere (except to directory, where it shows a tilde (~)).
  1108. The original file which the link points to is shown on mini\-status line if the
  1109. .I "Show mini\-status"
  1110. option is enabled. Use symbolic links when you want to avoid the
  1111. confusion that can be caused by hard links.
  1112. .PP
  1113. When you press "C\-x s" Midnight Commander will automatically fill in the
  1114. complete path+filename of the original file and suggest a name for the link.
  1115. You can change either one.
  1116. .PP
  1117. Sometimes you may want to change the absolute path of the original into
  1118. a relative path. An absolute path starts from the root directory:
  1119. .PP
  1120. .I /home/frodo/mc/mc -> /home/frodo/new/mc
  1121. .PP
  1122. A relative link describes the original file's location starting from the
  1123. location of the link itself:
  1124. .PP
  1125. .I /home/frodo/mc/mc -> ../new/mc
  1126. .PP
  1127. You can force Midnight Commander to suggest a relative path by pressing
  1128. "C\-x v" instead of "C\-x s".
  1129. .PP
  1130. .B Rename/Move (F6, F16)
  1131. .PP
  1132. Press F6 to pop up an input dialog to copy the currently selected file (or
  1133. the tagged files, if there is at least one file tagged) to the
  1134. directory/filename you specify in the input dialog. The destination
  1135. defaults to the directory in the non\-selected panel. For more details
  1136. look at Copy (F5) operation above, most of the things are quite similar.
  1137. .PP
  1138. F16 (usually F16) is similar, but defaults to the directory in the
  1139. selected panel. It always operates on the selected file, regardless of
  1140. any tagged files.
  1141. .PP
  1142. On some systems, it is possible to do the copy in the background by
  1143. clicking on the background button (or pressing Alt\-b in the dialog
  1144. box). The
  1145. .\"LINK2"
  1146. Background Jobs
  1147. .\"Background jobs"
  1148. is used to control the background process.
  1149. .PP
  1150. .B Mkdir (F7)
  1151. .PP
  1152. Pop up an input dialog and creates the directory specified.
  1153. .PP
  1154. .B Delete (F8)
  1155. .PP
  1156. Delete the currently selected file or the tagged files in the
  1157. currently selected panel. During the process, you can press C\-c or
  1158. ESC to abort the operation.
  1159. .PP
  1160. .B Quick cd (Alt\-c)
  1161. Use the
  1162. .\"LINK2"
  1163. quick cd
  1164. .\"Quick cd"
  1165. command if you have full command line and want to cd somewhere.
  1166. .PP
  1167. .B Select group (+)
  1168. .PP
  1169. This is used to select (tag) a group of files. The Midnight Commander
  1170. will prompt for a selection options. When
  1171. .I Files only
  1172. checkbox is on, only files will be selected. If
  1173. .I Files only
  1174. is off, as files as directories will be selected.
  1175. When
  1176. .I Shell Patterns
  1177. checkbox is on, the regular expression is much like the filename globbing
  1178. in the shell (* standing for zero or more characters and ? standing
  1179. for one character). If
  1180. .I Shell Patterns
  1181. is off, then the tagging of files is done with normal regular
  1182. expressions (see ed (1)). When
  1183. .I Case sensitive
  1184. checkbox is on, the selection will be case sensitive characters.
  1185. If
  1186. .I Case sensitive
  1187. is off, the case will be ignored.
  1188. .PP
  1189. .B Unselect group (\\\\)
  1190. .PP
  1191. Used to unselect a group of files. This is the opposite of the
  1192. .I "Select group"
  1193. command.
  1194. .PP
  1195. .B Quit (F10, Shift\-F10)
  1196. .PP
  1197. Terminate the Midnight Commander. Shift\-F10 is used when you want to
  1198. quit and you are using the shell wrapper. Shift\-F10 will not take you
  1199. to the last directory you visited with the Midnight Commander, instead
  1200. it will stay at the directory where you started the Midnight Commander.
  1201. .\"NODE " Quick cd"
  1202. .SH " Quick cd"
  1203. This command is useful if you have a full command line and want to
  1204. .\"LINK2"
  1205. cd
  1206. .\"The cd internal command"
  1207. somewhere without having to yank and paste the command line. This command
  1208. pops up a small dialog, where you enter everything you would enter after
  1209. .B cd
  1210. on the command line and then you press enter. This features all the things
  1211. that are already in the
  1212. .\"LINK2"
  1213. internal cd command\&.
  1214. .\"The cd internal command"
  1215. .\"NODE " Command Menu"
  1216. .SH " Command Menu"
  1217. The
  1218. .\"LINK2"
  1219. Directory tree
  1220. .\"Directory Tree"
  1221. command shows a tree figure of the directories.
  1222. .PP
  1223. The
  1224. .\"LINK2"
  1225. "Find file"
  1226. .\"Find File"
  1227. command allows you to search for a specific file.
  1228. .PP
  1229. The "Swap panels" command swaps the contents of the two directory panels.
  1230. .PP
  1231. The "Switch panels on/off" command shows the output of the last shell command.
  1232. This works only on xterm and on Linux and FreeBSD console.
  1233. .PP
  1234. The "Compare directories" command compares the directory
  1235. panels with each other. You can then use the Copy (F5) command to make
  1236. the panels identical. There are three compare methods. The quick method
  1237. compares only file size and file date. The thorough method makes a
  1238. full byte\-by\-byte compare. The thorough method is not available if the
  1239. machine does not support the mmap(2) system call. The size\-only
  1240. compare method just compares the file sizes and does not check the
  1241. contents or the date times, it just checks the file size.
  1242. .PP
  1243. The
  1244. .\"LINK2"
  1245. "External panelize"
  1246. .\"External panelize"
  1247. allows you to execute an external program, and make the output of that
  1248. program the contents of the current panel.
  1249. .PP
  1250. The "Command history" command shows a list of typed commands. The
  1251. selected command is copied to the command line. The command history
  1252. can also be accessed by typing Alt\-p or Alt\-n.
  1253. .PP
  1254. The
  1255. .\"LINK2"
  1256. "Directory hotlist"
  1257. .\"Hotlist"
  1258. command makes changing of the current directory to often used directories
  1259. faster.
  1260. .PP
  1261. The
  1262. .\"LINK2"
  1263. "Screen list"
  1264. .\"Screen selector"
  1265. command shows a dialog window with the list of currently running
  1266. internal editors, viewers and other MC modules that support this mode.
  1267. .PP
  1268. The
  1269. .\"LINK2"
  1270. "Edit extension file"
  1271. .\"Extension File Edit"
  1272. command allows you to specify programs to executed when you try to
  1273. execute, view, edit and do a bunch of other thing on files
  1274. with certain extensions (filename endings).
  1275. .PP
  1276. The
  1277. .\"LINK2"
  1278. "Edit menu file"
  1279. .\"Menu File Edit"
  1280. command may be used for editing the user menu (which appears by
  1281. pressing F2).
  1282. .\"NODE " Directory Tree"
  1283. .SH " Directory Tree"
  1284. The Directory Tree command shows a tree figure of the directories. You
  1285. can select a directory from the figure and the Midnight Commander will
  1286. change to that directory.
  1287. .PP
  1288. There are two ways to invoke the tree. The real directory tree command
  1289. is available from Commands menu. The other way is to select tree view
  1290. from the Left or Right menu.
  1291. .PP
  1292. To get rid of long delays the Midnight Commander creates the tree
  1293. figure by scanning only a small subset of all the directories. If the
  1294. directory which you want to see is missing, move to its parent
  1295. directory and press C\-r (or F2).
  1296. .PP
  1297. You can use the following keys:
  1298. .PP
  1299. .\"LINK2"
  1300. General movement keys
  1301. .\"General Movement Keys"
  1302. are accepted.
  1303. .PP
  1304. .B Enter.
  1305. In the directory tree, exits the directory tree and changes to this
  1306. directory in the current panel. In the tree view, changes to this
  1307. directory in the other panel and stays in tree view mode in the
  1308. current panel.
  1309. .PP
  1310. .B C\-r, F2 (Rescan).
  1311. Rescan this directory. Use this when the tree figure is out of date:
  1312. it is missing subdirectories or shows some subdirectories which don't
  1313. exist any more.
  1314. .PP
  1315. .B F3 (Forget).
  1316. Delete this directory from the tree figure. Use this to remove clutter
  1317. from the figure. If you want the directory back to the tree figure
  1318. press F2 in its parent directory.
  1319. .PP
  1320. .B F4 (Static/Dynamic).
  1321. Toggle between the dynamic navigation mode (default) and the static
  1322. navigation mode.
  1323. .PP
  1324. In the static navigation mode you can use the Up and Down keys to
  1325. select a directory. All known directories are shown.
  1326. .PP
  1327. In the dynamic navigation mode you can use the Up and Down keys to
  1328. select a sibling directory, the Left key to move to the parent
  1329. directory, and the Right key to move to a child directory. Only the
  1330. parent, sibling and children directories are shown, others are left
  1331. out. The tree figure changes dynamically as you traverse.
  1332. .PP
  1333. .B F5 (Copy).
  1334. Copy the directory.
  1335. .PP
  1336. .B F6 (RenMov).
  1337. Move the directory.
  1338. .PP
  1339. .B F7 (Mkdir).
  1340. Make a new directory below this directory.
  1341. .PP
  1342. .B F8 (Delete).
  1343. Delete this directory from the file system.
  1344. .PP
  1345. .B C\-s, Alt\-s.
  1346. Search the next directory matching the search string. If there is
  1347. no such directory these keys will move one line down.
  1348. .PP
  1349. .B C\-h, Backspace.
  1350. Delete the last character of the search string.
  1351. .PP
  1352. .B Any other character.
  1353. Add the character to the search string and move to the next directory
  1354. which starts with these characters. In the tree view you must first
  1355. activate the search mode by pressing C\-s. The search string is shown
  1356. in the mini status line.
  1357. .PP
  1358. The following actions are available only in the directory tree. They
  1359. aren't supported in the tree view.
  1360. .PP
  1361. .B F1 (Help).
  1362. Invoke the help viewer and show this section.
  1363. .PP
  1364. .B Esc, F10.
  1365. Exit the directory tree. Do not change the directory.
  1366. .PP
  1367. The mouse is supported. A double\-click behaves like Enter. See
  1368. also the section on
  1369. .\"LINK2"
  1370. mouse support\&.
  1371. .\"Mouse Support"
  1372. .\"NODE " Find File"
  1373. .SH " Find File"
  1374. The Find File feature first asks for the start directory for the
  1375. search and the filename to be searched for. By pressing the Tree
  1376. button you can select the start directory from the
  1377. .\"LINK2"
  1378. directory tree
  1379. .\"Directory Tree"
  1380. figure.
  1381. .PP
  1382. Option \"Whole words\" allows select only those files containing matches that
  1383. form whole words. Like grep \-w.
  1384. .PP
  1385. You can start the search by pressing the OK button.
  1386. During the search you can stop from the Stop button and continue from
  1387. the Start button.
  1388. .PP
  1389. You can browse the filelist with the up and down arrow keys. The Chdir
  1390. button will change to the directory of the currently selected
  1391. file. The Again button will ask for the parameters for a new
  1392. search. The Quit button quits the search operation. The Panelize
  1393. button will place the found files to the current directory panel so
  1394. that you can do additional operations on them (view, copy, move,
  1395. delete and so on). After panelizing you can press C\-r to return to the
  1396. normal file listing.
  1397. .PP
  1398. The 'Enable ignore directories' checkbox and input field below it
  1399. allow to set up the list of directories that should be skip during the search
  1400. files (for example, you may want to avoid searches on a CD\-ROM or on a NFS
  1401. directory that is mounted across a slow link). List components must be separated
  1402. with a colon, here is an example:
  1403. .PP
  1404. .nf
  1405. /cdrom:/nfs/wuarchive:/afs
  1406. .fi
  1407. .PP
  1408. Relative paths are supported also. The following example shows how to skip special
  1409. directories of version control systems:
  1410. .nf
  1411. /cdrom:/nfs/wuarchive:/afs:.svn:.git:CVS
  1412. .fi
  1413. .PP
  1414. Attention: input field can contain a dot (.), this means the current absolute path.
  1415. .PP
  1416. You may consider using the
  1417. .\"LINK2"
  1418. External panelize
  1419. .\"External panelize"
  1420. command for some operations. Find file command is for simple queries
  1421. only, while using External panelize you can do as mysterious searches
  1422. as you would like.
  1423. .\"NODE " External panelize"
  1424. .SH " External panelize"
  1425. The External panelize allows you to execute an external program, and
  1426. make the output of that program the contents of the current panel.
  1427. .PP
  1428. For example, if you want to manipulate in one of the panels all the
  1429. symbolic links in the current directory, you can use external
  1430. panelization to run the following command:
  1431. .PP
  1432. .nf
  1433. find . \-type l \-print
  1434. .fi
  1435. .PP
  1436. Upon command completion, the directory contents of the panel will no
  1437. longer be the directory listing of the current directory, but all the
  1438. files that are symbolic links.
  1439. .PP
  1440. If you want to panelize all of the files that have been downloaded
  1441. from your FTP server, you can use this awk command to extract the file
  1442. name from the transfer log files:
  1443. .PP
  1444. .nf
  1445. awk '$9 ~! /incoming/ { print $9 }' < /var/log/xferlog
  1446. .fi
  1447. .PP
  1448. You may want to save often used panelize commands under a descriptive name,
  1449. so that you can recall them quickly. You do this by typing the command on
  1450. the input line and pressing Add new button. Then you enter a name under
  1451. which you want the command to be saved. Next time, you just choose that
  1452. command from the list and do not have to type it again.
  1453. .\"NODE " Hotlist"
  1454. .SH " Hotlist"
  1455. The Directory hotlist command shows the labels of the directories
  1456. in the directory hotlist. The Midnight Commander will change to the
  1457. directory corresponding to the selected label. From the hotlist dialog,
  1458. you can remove already created label/directory pairs and add new ones.
  1459. To add new directories quickly, you can use the Add to hotlist command
  1460. (C\-x h), which adds the current directory into the directory hotlist,
  1461. asking just for the label for the directory.
  1462. .PP
  1463. This makes cd to often used directories faster. You may consider using the
  1464. CDPATH variable as described in
  1465. .\"LINK2"
  1466. internal cd command
  1467. .\"The cd internal command"
  1468. description.
  1469. .\"NODE " Extension File Edit"
  1470. .SH " Extension File Edit"
  1471. This will invoke your editor on the file
  1472. .IR ~/.local/share/mc/mc.ext .
  1473. The format of this file following:
  1474. .PP
  1475. All lines starting with # or empty lines are thrown away.
  1476. .PP
  1477. Lines starting in the first column should have following format:
  1478. .PP
  1479. .IR keyword/expr ,
  1480. i.e. everything after the slash until new line is
  1481. .IR expr .
  1482. .PP
  1483. .I keyword
  1484. can be:
  1485. .TP
  1486. .I shell
  1487. \-
  1488. .I expr
  1489. is an extension (no wildcards). File matches it its name ends
  1490. with
  1491. .IR expr .
  1492. Example:
  1493. .I shell/.tar
  1494. matches
  1495. .IR *.tar .
  1496. .TP
  1497. .I regex
  1498. \-
  1499. .I expr
  1500. is a regular expression. File matches if its name matches the regular
  1501. expression.
  1502. .TP
  1503. .I directory
  1504. \-
  1505. .I expr
  1506. is a regular expression. File matches if it is a directory and its name
  1507. matches the regular expression.
  1508. .TP
  1509. .I type
  1510. \-
  1511. .I expr
  1512. is a regular expression. File matches if the output of
  1513. .I file %f
  1514. without the initial "filename:" part matches regular expression
  1515. .IR expr .
  1516. .TP
  1517. .I default
  1518. \- matches any file.
  1519. .I expr
  1520. is ignored.
  1521. .TP
  1522. .I include
  1523. \- denotes a common section.
  1524. .I expr
  1525. is the name of the section.
  1526. .PP
  1527. Other lines should start with a space or tab and should be of the format:
  1528. .I keyword=command
  1529. (with no spaces around =), where
  1530. .I keyword
  1531. should be:
  1532. .I Open
  1533. (invoked on Enter or double click),
  1534. .I View
  1535. (F3),
  1536. .I Edit
  1537. (F4) or
  1538. .I Include
  1539. (to add rules from the common section).
  1540. .I command
  1541. is any one\-line shell command, with the simple
  1542. .\"LINK2"
  1543. macro substitution\&.
  1544. .\"Macro Substitution"
  1545. .PP
  1546. Rules are matched from top to bottom, thus the order is important. If
  1547. the appropriate action is missing, search continues as if this rule
  1548. didn't match (i.e. if a file matches the first and second entry and View
  1549. action is missing in the first one, then on pressing F3 the View action
  1550. from the second entry will be used).
  1551. .I default
  1552. should match all the actions.
  1553. .\"NODE " Background jobs"
  1554. .SH " Background Jobs"
  1555. This lets you control the state of any background Midnight Commander
  1556. process (only copy and move files operations can be done in the
  1557. background). You can stop, restart and kill a background job from
  1558. here.
  1559. .\"NODE " Menu File Edit"
  1560. .SH " Menu File Edit"
  1561. The user menu is a menu of useful actions that can be customized by
  1562. the user. When you access the user menu, the
  1563. file .mc.menu from the current directory is used if it exists,
  1564. but only if it is owned by user or root and is not world\-writable.
  1565. If no such file found, ~/.local/share/mc/menu is tried in the same way,
  1566. and otherwise mc uses the default system\-wide menu
  1567. @prefix@/share/mc/mc.menu.
  1568. .PP
  1569. The format of the menu file is very simple. Lines that start with
  1570. anything but space or tab are considered entries for the menu (in
  1571. order to be able to use it like a hot key, the first character should
  1572. be a letter). All the lines that start with a space or a tab are the
  1573. commands that will be executed when the entry is selected.
  1574. .PP
  1575. When an option is selected all the command lines of the option are
  1576. copied to a temporary file in the temporary directory (usually
  1577. /usr/tmp) and then that file is executed. This allows the user to put
  1578. normal shell constructs in the menus. Also simple macro substitution
  1579. takes place before executing the menu code. For more information, see
  1580. .\"LINK2"
  1581. macro substitution\&.
  1582. .\"Macro Substitution"
  1583. .PP
  1584. Here is a sample mc.menu file:
  1585. .PP
  1586. .nf
  1587. A Dump the currently selected file
  1588. od \-c %f
  1589. B Edit a bug report and send it to root
  1590. I=`mktemp ${MC_TMPDIR:\-/tmp}/mail.XXXXXX` || exit 1
  1591. vi $I
  1592. mail \-s "Midnight Commander bug" root < $I
  1593. rm \-f $I
  1594. M Read mail
  1595. emacs \-f rmail
  1596. N Read Usenet news
  1597. emacs \-f gnus
  1598. H Call the info hypertext browser
  1599. info
  1600. J Copy current directory to other panel recursively
  1601. tar cf \- . | (cd %D && tar xvpf \-)
  1602. K Make a release of the current subdirectory
  1603. echo \-n "Name of distribution file: "
  1604. read tar
  1605. ln \-s %d `dirname %d`/$tar
  1606. cd ..
  1607. tar cvhf ${tar}.tar $tar
  1608. = f *.tar.gz | f *.tgz & t n
  1609. X Extract the contents of a compressed tar file
  1610. tar xzvf %f
  1611. .fi
  1612. .PP
  1613. .B Default Conditions
  1614. .PP
  1615. Each menu entry may be preceded by a condition. The condition must
  1616. start from the first column with a '=' character. If the condition is
  1617. true, the menu entry will be the default entry.
  1618. .PP
  1619. .nf
  1620. Condition syntax: = <sub\-cond>
  1621. or: = <sub\-cond> | <sub\-cond> ...
  1622. or: = <sub\-cond> & <sub\-cond> ...
  1623. Sub\-condition is one of following:
  1624. y <pattern> syntax of current file matching pattern?
  1625. (for edit menu only)
  1626. f <pattern> current file matching pattern?
  1627. F <pattern> other file matching pattern?
  1628. d <pattern> current directory matching pattern?
  1629. D <pattern> other directory matching pattern?
  1630. t <type> current file of type?
  1631. T <type> other file of type?
  1632. x <filename> is it executable filename?
  1633. ! <sub\-cond> negate the result of sub\-condition
  1634. .fi
  1635. .PP
  1636. Pattern is a normal shell pattern or a regular expression, according
  1637. to the shell patterns option. You can override the global value of
  1638. the shell patterns option by writing "shell_patterns=x" on the first
  1639. line of the menu file (where "x" is either 0 or 1).
  1640. .PP
  1641. Type is one or more of the following characters:
  1642. .PP
  1643. .nf
  1644. n not a directory
  1645. r regular file
  1646. d directory
  1647. l link
  1648. c character device
  1649. b block device
  1650. f FIFO (pipe)
  1651. s socket
  1652. x executable file
  1653. t tagged
  1654. .fi
  1655. .PP
  1656. For example 'rlf' means either regular file, link or fifo. The 't'
  1657. type is a little special because it acts on the panel instead of the
  1658. file. The condition '=t t' is true if there are tagged files in the
  1659. current panel and false if not.
  1660. .PP
  1661. If the condition starts with '=?' instead of '=' a debug trace will be
  1662. shown whenever the value of the condition is calculated.
  1663. .PP
  1664. The conditions are calculated from left to right. This means
  1665. .nf
  1666. = f *.tar.gz | f *.tgz & t n
  1667. .fi
  1668. is calculated as
  1669. .nf
  1670. ( (f *.tar.gz) | (f *.tgz) ) & (t n)
  1671. .fi
  1672. .PP
  1673. Here is a sample of the use of conditions:
  1674. .PP
  1675. .nf
  1676. = f *.tar.gz | f *.tgz & t n
  1677. L List the contents of a compressed tar\-archive
  1678. gzip \-cd %f | tar xvf \-
  1679. .fi
  1680. .PP
  1681. .B Addition Conditions
  1682. .PP
  1683. If the condition begins with '+' (or '+?') instead of '=' (or '=?') it
  1684. is an addition condition. If the condition is true the menu entry will
  1685. be included in the menu. If the condition is false the menu entry will
  1686. not be included in the menu.
  1687. .PP
  1688. You can combine default and addition conditions by starting condition
  1689. with '+=' or '=+' (or '+=?' or '=+?' if you want debug trace). If you
  1690. want to use two different conditions, one for adding and another for
  1691. defaulting, you can precede a menu entry with two condition lines, one
  1692. starting with '+' and another starting with '='.
  1693. .PP
  1694. Comments are started with '#'. The additional comment lines must start
  1695. with '#', space or tab.
  1696. .\"NODE " Options Menu"
  1697. .SH " Options Menu"
  1698. The Midnight Commander has some options that may be toggled on and
  1699. off in several dialogs which are accessible from this menu. Options
  1700. are enabled if they have an asterisk or "x" in front of them.
  1701. .PP
  1702. The
  1703. .\"LINK2"
  1704. Configuration
  1705. .\"Configuration"
  1706. command pops up a dialog from which you can change most of settings of
  1707. the Midnight Commander.
  1708. .PP
  1709. The
  1710. .\"LINK2"
  1711. Layout
  1712. .\"Layout"
  1713. command pops up a dialog from which you specify a bunch of options how mc
  1714. looks like on the screen.
  1715. .PP
  1716. The
  1717. .\"LINK2"
  1718. Panel options
  1719. .\"Panel options"
  1720. command pops up a dialog from which you specify options of file manager panels.
  1721. .PP
  1722. The
  1723. .\"LINK2"
  1724. Confirmation
  1725. .\"Confirmation"
  1726. command pops up a dialog from which you specify which actions you want to
  1727. confirm.
  1728. .PP
  1729. The
  1730. .\"LINK2"
  1731. Display bits
  1732. .\"Display bits"
  1733. command pops up a dialog from which you may select which characters is your
  1734. terminal able to display.
  1735. .PP
  1736. The
  1737. .\"LINK2"
  1738. Learn keys
  1739. .\"Learn keys"
  1740. command pops up a dialog from which you test some keys which are not working
  1741. on some terminals and you may fix them.
  1742. .PP
  1743. The
  1744. .\"LINK2"
  1745. Virtual FS
  1746. .\"Virtual FS"
  1747. command pops up a dialog from which you specify some VFS related options.
  1748. .PP
  1749. The
  1750. .\"LINK2"
  1751. Save setup
  1752. .\"Save Setup"
  1753. command saves the current settings of the Left, Right and Options
  1754. menus. A small number of other settings is saved, too.
  1755. .\"NODE " Configuration"
  1756. .SH " Configuration"
  1757. The options in this dialog are divided into several groups: "File
  1758. operation options", "Esc key mode", "Pause after run" and "Other options".
  1759. .PP
  1760. .B File operation options
  1761. .PP
  1762. .I Verbose operation.
  1763. This toggles whether the file Copy, Rename and Delete operations are
  1764. verbose (i.e., display a dialog box for each operation). If you have a
  1765. slow terminal, you may wish to disable the verbose operation. It is
  1766. automatically turned off if the speed of your terminal is less than
  1767. 9600 bps.
  1768. .PP
  1769. .I Compute totals.
  1770. If this option is enabled, the Midnight Commander computes total byte
  1771. sizes and total number of files prior to any Copy, Rename and Delete
  1772. operations. This will provide you with a more accurate progress bar
  1773. at the expense of some speed. This option has no effect, if
  1774. .I Verbose operation
  1775. is disabled.
  1776. .PP
  1777. .I Classic progressbar.
  1778. If this option is enabled, the progressbar of Copy/Move/Delete operations
  1779. is always grown form left to right. If disabled, the growing direction
  1780. of progressbar follows to direction of Copy/Move/Delete operation:
  1781. from left panel to right one and vice versa. Enabled by default.
  1782. .PP
  1783. .I Mkdir autoname
  1784. When you press F7 to create a new directory, the input line in popup dialog
  1785. will be filled by name of current file or directory in active panel.
  1786. Disabled by default.
  1787. .PP
  1788. .B Esc key mode.
  1789. .PP
  1790. By default the Midnight Commander treats the ESC key as a key prefix.
  1791. Therefore, you should press Esc code twice to exit a dialog. But there is
  1792. a possibility to use a single press of ESC key for that action.
  1793. .PP
  1794. .I Single press.
  1795. By default this option is disabled. If you'll enable it, the ESC key
  1796. will act as a prefix key for set up time interval (see
  1797. .I Timeout
  1798. option below), and if no extra keys have arrived, then the ESC key
  1799. is interpreted as a cancel key (ESC ESC).
  1800. .PP
  1801. .I Timeout.
  1802. This options is used to setup the time interval (in microseconds)
  1803. for single press of ESC key. By default, this inrerval is one second
  1804. (1000000 microseconds). Also the timeout can be set via KEYBOARD_KEY_TIMEOUT_US
  1805. environment variable (also in microseconds), which has higher priority
  1806. than Timeout option value.
  1807. .PP
  1808. .B Pause after run
  1809. .PP
  1810. After executing your commands, the Midnight Commander can pause, so
  1811. that you can examine the output of the command. There are three
  1812. possible settings for this variable:
  1813. .PP
  1814. .IR Never .
  1815. Means that you do not want to see the output of your command. If you
  1816. are using the Linux or FreeBSD console or an xterm, you will be able to
  1817. see the output of the command by typing C\-o.
  1818. .PP
  1819. .IR On dumb terminals .
  1820. You will get the pause message on terminals that are not capable of
  1821. showing the output of the last command executed (any terminal that is
  1822. not an xterm or the Linux console).
  1823. .PP
  1824. .IR Always .
  1825. The program will pause after executing all of your commands.
  1826. .PP
  1827. .B Other options
  1828. .PP
  1829. .I Use internal editor.
  1830. If this option is enabled, the built\-in file editor is used to edit
  1831. files. If the option is disabled, the editor specified in the
  1832. .B EDITOR
  1833. environment variable is used.
  1834. If no editor is specified,
  1835. .B vi
  1836. is used. See the section on the
  1837. .\"LINK2"
  1838. internal file editor\&.
  1839. .\"Internal File Editor"
  1840. .PP
  1841. .I Use internal viewer.
  1842. If this option is enabled, the built\-in file viewer is used to view
  1843. files. If the option is disabled, the pager specified in the
  1844. .B PAGER
  1845. environment variable is used.
  1846. If no pager is specified, the
  1847. .B view
  1848. command is used. See the section on the
  1849. .\"LINK2"
  1850. internal file viewer\&.
  1851. .\"Internal File Viewer"
  1852. .PP
  1853. .I Auto menus.
  1854. If this option is enabled, the user menu will be invoked at startup.
  1855. Useful for building menus for non\-unixers.
  1856. .PP
  1857. .I Drop down menus.
  1858. When this option is enabled, the pull down menus will be activated as
  1859. soon as you press the F9 key. Otherwise, you will only get the menu title,
  1860. and you will have to activate the menu either with the arrow keys or with
  1861. the hotkeys. It is recommended if you are using hotkeys.
  1862. .PP
  1863. .I Shell Patterns.
  1864. By default the Select, Unselect and Filter commands will use shell\-like
  1865. regular expressions. The following conversions are performed to achieve
  1866. this: the '*' is replaced by '.*' (zero or more characters); the '?'
  1867. is replaced by '.' (exactly one character) and '.' by the literal
  1868. dot. If the option is disabled, then the regular expressions are the
  1869. ones described in ed(1).
  1870. .PP
  1871. .I Complete: show all.
  1872. By default the Midnight Commander pops up all possible
  1873. .\"LINK2"
  1874. completions
  1875. .\"Completion"
  1876. if the completion is ambiguous only when you press
  1877. .B Alt\-Tab
  1878. for the second time. For the first time, it just completes as much as
  1879. possible and beeps in the case of ambiguity. Enable this option if you
  1880. want to see all possible completions even after pressing
  1881. .B Alt\-Tab
  1882. the first time.
  1883. .PP
  1884. .I Rotating dash.
  1885. If this option is enabled, the
  1886. Midnight Commander shows a rotating dash in the upper right corner
  1887. as a work in progress indicator.
  1888. .PP
  1889. .I Cd follows links.
  1890. This option, if set, causes the Midnight Commander to follow the
  1891. logical chain of directories when changing current directory
  1892. either in the panels, or using the cd command. This is the default
  1893. behavior of bash. When unset, the Midnight Commander follows the
  1894. real directory structure, so cd .. if you've entered that directory
  1895. through a link will move you to the current directory's real parent
  1896. and not to the directory where the link was present.
  1897. .PP
  1898. .I Safe delete.
  1899. If this option is enabled, deleting files and directory hotlist entries
  1900. unintentionally becomes more difficult. The default selection in the
  1901. confirmation dialogs for deletion changes from "Yes" to "No".
  1902. This option is disabled by default.
  1903. .PP
  1904. .I Auto save setup.
  1905. If this option is enabled, when you exit the Midnight Commander the
  1906. configurable options of the Midnight Commander are saved in the
  1907. ~/.config/mc/ini file.
  1908. .\"NODE " Layout"
  1909. .SH " Layout"
  1910. The layout dialog gives you a possibility to change the general layout
  1911. of screen. The options in this dialog are divided into several groups:
  1912. "Panel split", "Console output" and "Other options".
  1913. .PP
  1914. .B Panel split
  1915. .PP
  1916. The rest of the screen area is used for the two directory panels. You
  1917. can specify whether the area is split to the panels in
  1918. .I Vertical
  1919. or
  1920. .I Horizontal
  1921. direction. Panel layout can be changed using Alt\-, (Alt\-comma) shortcut.
  1922. .PP
  1923. .I Equal split.
  1924. By default, panels have equal sizes. Using this option you can specify
  1925. an unequal split.
  1926. .PP
  1927. .B Console output
  1928. .PP
  1929. On the Linux or FreeBSD console you can specify how many lines are shown
  1930. in the output window. This option is available if Midnight Commander runs
  1931. on native console only.
  1932. .PP
  1933. .B Other options
  1934. .PP
  1935. .I Menu bar visible.
  1936. If enabled, main menu of Midnight Commander is always visible on the top row
  1937. of screen above panels. Enabled by default.
  1938. .PP
  1939. .I Command prompt.
  1940. If enabled, command line is avalable. Enabled by default.
  1941. .PP
  1942. .I Keybar visible.
  1943. If enabled, 10 lables associated with F1\-F10 keys are located at the bottom
  1944. row of screen. Enabled by default.
  1945. .PP
  1946. .I Hintbar visible.
  1947. If enabled, the one\-line hints are visible below panels. Enabled by default.
  1948. .PP
  1949. .I XTerm window title.
  1950. When run in a terminal emulator for X11, Midnight Commander sets the
  1951. terminal window title to the current working directory and updates it
  1952. when necessary. If your terminal emulator is broken and you see some
  1953. incorrect output on startup and directory change, turn off this option.
  1954. Enabled by default.
  1955. .PP
  1956. .I Show free space.
  1957. If enabled, free space and total space of current file system is shown
  1958. at the bottom frame of panel. Enabled by default.
  1959. .\"NODE " Panel options"
  1960. .SH " Panel options"
  1961. .B Main panel options
  1962. .PP
  1963. .I Show mini\-status.
  1964. If enabled, one line of status information about the currently selected item
  1965. is shown at the bottom of the panels. Enabled by default.
  1966. .PP
  1967. .I Use SI size units.
  1968. If this option is enabled, Midnight Commander will use SI units (powers of 1000)
  1969. when displaying any byte sizes. The suffixes (k, m ...) are shown in lowercase.
  1970. If disabled (default), Midnight Commander will use binary units (powers of 1024)
  1971. and the suffixes are shown in upper case (K, M ...)
  1972. .PP
  1973. .I Mix all files.
  1974. If this option is enabled, all files and directories are shown mixed
  1975. together. If the option is desabled (default), directories (and links to
  1976. directories) are shown at the beginning of the listing, and other files below.
  1977. .PP
  1978. .I Show backup files.
  1979. If enabled, the Midnight Commander will show files ending with a tilde.
  1980. Otherwise, they won't be shown (like GNU's ls option \-B). Enabled by default.
  1981. .PP
  1982. .I Show hidden files.
  1983. If enabled, the Midnight Commander will show all files that start with
  1984. a dot (like ls \-a). Disabled by default.
  1985. .PP
  1986. .I Fast directory reload.
  1987. If this option is enabled, the Midnight Commander will use a trick to
  1988. determine if the directory contents have changed. The trick is to reload
  1989. the directory only if the i\-node of the directory has changed; this means
  1990. that reloads only happen when files are created or deleted. If what
  1991. changes is the i\-node for a file in the directory (file size changes,
  1992. mode or owner changes, etc) the display is not updated. In these cases,
  1993. if you have the option on, you have to rescan the directory manually
  1994. (with C\-r). Disabled by default.
  1995. .PP
  1996. .I Mark moves down.
  1997. If enabled, the selection bar will move down when you mark a file (with
  1998. Insert key). Enabled by default.
  1999. .PP
  2000. .I Reverse files only.
  2001. Allow revert selection of files only. Enabled by default.
  2002. If enabled, the reverse selection is applied to files only, not to directories.
  2003. The selection of directories is untouched. If off, the reverse selection
  2004. is applied to files as well to directories: all unselected items become
  2005. selected, and vice versa.
  2006. .PP
  2007. .I Simple swap.
  2008. If both panels contain file listing, simple swap means that panels exchange
  2009. its screen positions: left panel become right one, and vice versa. If this
  2010. option is unchecked, file listing panels exchange its content keeping listing
  2011. format and sort options. Unchecked by default.
  2012. .PP
  2013. .I Auto save panels setup.
  2014. If this option is enabled, when you exit the Midnight Commander the
  2015. current settings of panels are saved in the ~/.cache/mc/panels.ini file.
  2016. Disabled by default.
  2017. .PP
  2018. .B Navigation
  2019. .PP
  2020. .I Lynx\-like motion.
  2021. If this option is enabled, you may use the arrows keys to automatically
  2022. chdir if the current selection is a subdirectory and the shell command
  2023. line is empty. By default, this setting is off.
  2024. .PP
  2025. .I Page scrolling.
  2026. If set (the default), panel will scroll by half the display when the
  2027. cursor reaches the end or the beginning of the panel, otherwise it
  2028. will just scroll a file at a time.
  2029. .PP
  2030. .I Mouse page scrolling.
  2031. Controls whenever scrolling with the mouse wheel is done by pages or
  2032. line by line on the panels.
  2033. .PP
  2034. .B File highlight
  2035. .PP
  2036. You can specify whether
  2037. .I permissions
  2038. and
  2039. .I file types
  2040. should be highlighted with distinctive
  2041. .\"LINK2"
  2042. Colors\&.
  2043. .\"Colors"
  2044. If the permission highlighting is enabled, the parts of the
  2045. .I perm
  2046. and
  2047. .I mode
  2048. .\"LINK2"
  2049. display fields
  2050. .\"Listing Mode..."
  2051. which apply to the user running Midnight Commander are highlighted with
  2052. the color defined by the
  2053. .I selected
  2054. keyword. If the file type highlighting is enabled, file names are colored
  2055. according to rules described in @sysconfdir@/mc/filehighlight.ini file. See
  2056. .\"LINK2"
  2057. Filenames Highlight
  2058. .\"Filenames Highlight"
  2059. for more info.
  2060. .PP
  2061. .B Quick search
  2062. .PP
  2063. You can specify how the
  2064. .\"LINK2"
  2065. Quick search
  2066. .\"Quick search"
  2067. mode should works: case insensitively, case sensitively or be matched
  2068. to the the panel sort order: case sensitive or not.
  2069. .\"NODE " Confirmation"
  2070. .SH " Confirmation"
  2071. In this dialog you configure the confirmation options for file deletion,
  2072. overwriting files, execution by pressing enter, quitting the program,
  2073. directory hotlist entries deletion and history cleanup.
  2074. and.
  2075. .\"NODE " Display bits"
  2076. .SH " Display bits"
  2077. This is used to configure the range of visible characters on the
  2078. screen. This setting may be 7\-bits if your terminal/curses supports
  2079. only seven output bits, ISO\-8859\-1 displays all the characters in the
  2080. ISO\-8859\-1 map and full 8 bits is for those terminals that can display
  2081. full 8 bit characters.
  2082. .\"NODE " Learn keys"
  2083. .SH " Learn keys"
  2084. This dialog allows you to test and redefine functional keys, cursor
  2085. arrows and some other keys to make them work properly on your terminal.
  2086. They often don't, since many terminal databases are incomplete or broken.
  2087. .PP
  2088. You can move around with the Tab key and with the vi moving keys ('h'
  2089. left, 'j' down, 'k' up and 'l' right). Once you press any cursor movement
  2090. key and it is recognized, you can use that key as well.
  2091. .PP
  2092. You can test keys just by pressing each of them. When you press a
  2093. key and it is recognized properly, OK should appear next to the name
  2094. of that key. Once a key is marked OK it starts working as usually,
  2095. e.g. F1 pressed the first time will just check that the F1 key works,
  2096. but after that it will show help. The same applies to the arrow keys.
  2097. The Tab key should be working always.
  2098. .PP
  2099. If some keys do not work properly then you won't see OK appear after
  2100. pressing one of these. Then you may want to redefine it. Do it by pressing
  2101. the button with the name of that key (either by the mouse or by Enter
  2102. or Space after selecting the button with Tab or arrows). Then a message
  2103. box will appear asking you to press that key. Do it and wait until the
  2104. message box disappears. If you want to abort, just press Escape once
  2105. and wait.
  2106. .PP
  2107. When you finish with all the keys, you can Save them. The definitions
  2108. for the keys you have redefined will be written into the [terminal:TERM]
  2109. section of your ~/.config/mc/ini file (where TERM is the name of your current
  2110. terminal). The definitions of the keys that were already working properly
  2111. are not saved.
  2112. .\"NODE " Virtual FS"
  2113. .SH " Virtual FS"
  2114. This option gives you control over the settings of the
  2115. .\"LINK2"
  2116. Virtual File System\&.
  2117. .\"Virtual File System"
  2118. .PP
  2119. The Midnight Commander keeps in memory the information related to some
  2120. of the virtual file systems to speed up the access to the files in the
  2121. file system (for example, directory listings fetched from FTP servers).
  2122. .PP
  2123. Also, in order to access the contents of compressed files (for example,
  2124. compressed tar files) the Midnight Commander needs to create temporary
  2125. uncompressed files on your disk.
  2126. .PP
  2127. Since both the information in memory and the temporary files on disk
  2128. take up resources, you may want to tune the parameters of the cached
  2129. information to decrease your resource usage or to maximize the speed of
  2130. access to frequently used file systems.
  2131. .PP
  2132. Because of the format of the tar archives, the
  2133. .I Tar filesystem
  2134. needs to read the whole file just to load the file entries. Since most
  2135. tar files are usually kept compressed (plain tar files are species in
  2136. extinction), the tar file system has to uncompress the file on the disk
  2137. in a temporary location and then access the uncompressed file as a
  2138. regular tar file.
  2139. .PP
  2140. Now, since we all love to browse files and tar files all over the disk,
  2141. it's common that you will leave a tar file and then re\-enter it later.
  2142. Since decompression is slow, the Midnight Commander will cache the
  2143. information in memory for a limited time. When the timeout expires, all
  2144. the resources associated with the file system are released. The default
  2145. timeout is set to one minute.
  2146. .PP
  2147. The
  2148. .\"LINK2"
  2149. FTP File System
  2150. .\"FTP File System"
  2151. (ftpfs) allows you to browse directories on remote FTP servers. It has
  2152. several options.
  2153. .PP
  2154. .I ftp anonymous password
  2155. is the password used when you login as "anonymous". Some sites require
  2156. a valid e\-mail address. On the other hand, you probably don't want to
  2157. give your real e\-mail address to untrusted sites, especially if you are
  2158. not using spam filtering.
  2159. .PP
  2160. ftpfs keeps the directory listing it fetches from a FTP server in a cache.
  2161. The cache expire time is configurable with the
  2162. .I ftpfs directory cache timeout
  2163. option. A low value for this option may slow down every operation on
  2164. the ftpfs because every operation would require sending a request to the
  2165. FTP server.
  2166. .PP
  2167. You can define an FTP proxy host for doing FTP. Note that most modern
  2168. firewalls are fully transparent at least for passive FTP (see below), so
  2169. FTP proxies are considered obsolete.
  2170. .PP
  2171. If
  2172. .I Always use ftp proxy
  2173. is not set, you can use the exclamation sign to enable proxy for certain
  2174. hosts. See
  2175. .\"LINK2"
  2176. FTP File System
  2177. .\"FTP File System"
  2178. for examples.
  2179. .PP
  2180. If this option is set, the program will do two things: consult the
  2181. @prefix@/lib/mc/mc.no_proxy file for lines containing host names that
  2182. are local (if the host name starts with a dot, it is assumed to be a
  2183. domain) and to assume that any hostnames without dots in their names are
  2184. directly accessible. All other hosts will be accessed through the
  2185. specified FTP proxy.
  2186. .PP
  2187. You can enable using
  2188. .I ~/.netrc
  2189. file, which keeps login names and passwords for ftp servers. See netrc
  2190. (5) for the description of the .netrc format.
  2191. .PP
  2192. .I Use passive mode
  2193. enables using FTP passive mode, when the connection for data transfer is
  2194. initiated by the client, not by the server. This option is recommended
  2195. and enabled by default. If this option is turned off, the data
  2196. connection is initiated by the server. This may not work with some
  2197. firewalls.
  2198. .\"NODE " Save Setup"
  2199. .SH " Save Setup"
  2200. At startup the Midnight Commander will try to load initialization
  2201. information from the ~/.config/mc/ini file. If this file
  2202. doesn't exist, it will load the information from the system\-wide
  2203. configuration file, located in @prefix@/share/mc/mc.ini. If the
  2204. system\-wide configuration file doesn't exist, MC uses the default settings.
  2205. .PP
  2206. The
  2207. .I Save Setup
  2208. command creates the ~/.config/mc/ini file by saving the
  2209. current settings of the
  2210. .\"LINK2"
  2211. Left, Right
  2212. .\"Left and Right Menus"
  2213. and
  2214. .\"LINK2"
  2215. Options
  2216. .\"Options Menu"
  2217. menus.
  2218. .PP
  2219. If you activate the
  2220. .I auto save setup
  2221. option, MC will always save the current settings when exiting.
  2222. .PP
  2223. There also exist settings which can't be changed from the menus. To
  2224. change these settings you have to edit the setup file with your
  2225. favorite editor. See the section on
  2226. .\"LINK2"
  2227. Special Settings
  2228. .\"Special Settings"
  2229. for more information.
  2230. .SH ""
  2231. .\"NODE "Executing operating system commands"
  2232. .SH "Executing operating system commands"
  2233. You may execute commands by typing them directly in the Midnight
  2234. Commander's input line, or by selecting the program you want to
  2235. execute with the selection bar in one of the panels and hitting Enter.
  2236. .PP
  2237. If you press Enter over a file that is not executable, the Midnight
  2238. Commander checks the extension of the selected file against the
  2239. extensions in the
  2240. .\"LINK2"
  2241. Extensions File\&.
  2242. .\"Extension File Edit"
  2243. If a match is found then the code associated with that extension is
  2244. executed. A very simple
  2245. .\"LINK2"
  2246. macro expansion
  2247. .\"Macro Substitution"
  2248. takes place before executing the command.
  2249. .\"NODE " The cd internal command"
  2250. .SH " The cd internal command"
  2251. The
  2252. .I cd
  2253. command is interpreted by the Midnight Commander, it is not passed to
  2254. the command shell for execution. Thus it may not handle all of the
  2255. nice macro expansion and substitution that your shell does, although it
  2256. does some of them:
  2257. .PP
  2258. .I Tilde substitution.
  2259. The (~) will be substituted with your home directory, if you append a
  2260. username after the tilde, then it will be substituted with the login
  2261. directory of the specified user.
  2262. .PP
  2263. For example, ~guest is the home directory for the user guest, while
  2264. ~/guest is the directory guest in your home directory.
  2265. .PP
  2266. .I Previous directory.
  2267. You can jump to the directory you were previously by using the special
  2268. directory name '\-' like this:
  2269. .B cd \-
  2270. .PP
  2271. .I CDPATH directories.
  2272. If the directory specified to the
  2273. .B cd
  2274. command is not in the current directory, then The Midnight Commander
  2275. uses the value in the environment variable
  2276. .B CDPATH
  2277. to search for the directory in any of the named directories.
  2278. .PP
  2279. For example you could set your
  2280. .B CDPATH
  2281. variable to ~/src:/usr/src, allowing you to change your directory to
  2282. any of the directories inside the ~/src and /usr/src directories, from
  2283. any place in the file system by using its relative name (for example
  2284. cd linux could take you to /usr/src/linux).
  2285. .\"NODE " Macro Substitution"
  2286. .SH " Macro Substitution"
  2287. When accessing a
  2288. .\"LINK2"
  2289. user menu\&,
  2290. .\"Menu File Edit"
  2291. or executing an
  2292. .\"LINK2"
  2293. extension dependent command\&,
  2294. .\"Extension File Edit"
  2295. or running a command from the command line input, a simple macro
  2296. substitution takes place.
  2297. .PP
  2298. The macros are:
  2299. .TP
  2300. .I %i
  2301. The indent of blank space, equal the cursor column position. For edit
  2302. menu only.
  2303. .TP
  2304. .I %y
  2305. The syntax type of current file. For edit menu only.
  2306. .TP
  2307. .I %k
  2308. The block file name.
  2309. .TP
  2310. .I %e
  2311. The error file name.
  2312. .TP
  2313. .I %m
  2314. The current menu name.
  2315. .TP
  2316. .IR %f " and " %p
  2317. The current file name.
  2318. .TP
  2319. .I %x
  2320. The extension of current file name.
  2321. .TP
  2322. .I %b
  2323. The current file name without extension.
  2324. .TP
  2325. .I %d
  2326. The current directory name.
  2327. .TP
  2328. .I %F
  2329. The current file in the unselected panel.
  2330. .TP
  2331. .I %D
  2332. The directory name of the unselected panel.
  2333. .TP
  2334. .I %t
  2335. The currently tagged files.
  2336. .TP
  2337. .I %T
  2338. The tagged files in the unselected panel.
  2339. .TP
  2340. .IR %u " and " %U
  2341. Similar to the %t and %T macros, but in addition the files are untagged.
  2342. You can use this macro only once per menu file entry or extension file
  2343. entry, because next time there will be no tagged files.
  2344. .TP
  2345. .IR %s " and " %S
  2346. The selected files: The tagged files if there are any. Otherwise the
  2347. current file.
  2348. .TP
  2349. .I %cd
  2350. This is a special macro that is used to change the current directory
  2351. to the directory specified in front of it. This is used primarily as
  2352. an interface to the
  2353. .\"LINK2"
  2354. Virtual File System\&.
  2355. .\"Virtual File System"
  2356. .TP
  2357. .I %view
  2358. This macro is used to invoke the internal viewer. This macro can be
  2359. used alone, or with arguments. If you pass any arguments to this
  2360. macro, they should be enclosed in brackets.
  2361. .IP
  2362. The arguments are:
  2363. .I ascii
  2364. to force the viewer into ascii mode;
  2365. .I hex
  2366. to force the viewer into hex mode;
  2367. .I nroff
  2368. to tell the viewer that it should interpret the bold and underline
  2369. sequences of nroff;
  2370. .I unformatted
  2371. to tell the viewer to not interpret nroff commands for making the text
  2372. bold or underlined.
  2373. .TP
  2374. .I %%
  2375. The % character
  2376. .TP
  2377. .I %{some text}
  2378. Prompt for the substitution. An input box is shown and the text inside
  2379. the braces is used as a prompt. The macro is substituted by the text
  2380. typed by the user. The user can press ESC or F10 to cancel. This macro
  2381. doesn't work on the command line yet.
  2382. .TP
  2383. .I %var{ENV:default}
  2384. If environment variable
  2385. .I ENV
  2386. is unset, the
  2387. .I default
  2388. is substituted. Otherwise, the value of
  2389. .I ENV
  2390. is substituted.
  2391. .\"NODE " The subshell support"
  2392. .SH " The subshell support"
  2393. The subshell support is a compile time option, that works with the
  2394. shells: bash, tcsh and zsh.
  2395. .PP
  2396. When the subshell code is activated the Midnight Commander will
  2397. spawn a concurrent copy of your shell (the one defined in the
  2398. .B SHELL
  2399. variable and if it is not defined, then the one in the /etc/passwd
  2400. file) and run it in a pseudo terminal, instead of invoking a new shell
  2401. each time you execute a command, the command will be passed to the
  2402. subshell as if you had typed it. This also allows you to change the
  2403. environment variables, use shell functions and define aliases that are
  2404. valid until you quit the Midnight Commander.
  2405. .PP
  2406. If you are using
  2407. .B bash
  2408. you can specify startup
  2409. commands for the subshell in your ~/.local/share/mc/bashrc file and
  2410. special keyboard maps in the ~/.local/share/mc/inputrc file.
  2411. .B tcsh
  2412. users may specify startup commands in the ~/.local/share/mc/tcshrc file.
  2413. .PP
  2414. When the subshell code is used, you can suspend applications at any
  2415. time with the sequence C\-o and jump back to the Midnight Commander, if
  2416. you interrupt an application, you will not be able to run other
  2417. external commands until you quit the application you interrupted.
  2418. .PP
  2419. An extra added feature of using the subshell is that the prompt
  2420. displayed by the Midnight Commander is the same prompt that you are
  2421. currently using in your shell.
  2422. .PP
  2423. The
  2424. .\"LINK2"
  2425. OPTIONS
  2426. .\"OPTIONS"
  2427. section has more information on how you can control the subshell code.
  2428. .\"NODE "Chmod"
  2429. .SH "Chmod"
  2430. The Chmod window is used to change the attribute bits in a group of
  2431. files and directories. It can be invoked with the C\-x c key combination.
  2432. .PP
  2433. The Chmod window has two parts \-
  2434. .I Permissions
  2435. and
  2436. .IR File .
  2437. .PP
  2438. In the File section are displayed the name of the file or directory
  2439. and its permissions in octal form, as well as its owner and group.
  2440. .PP
  2441. In the Permissions section there is a set of check buttons which
  2442. correspond to the file attribute bits. As you change the attribute
  2443. bits, you can see the octal value change in the File section.
  2444. .PP
  2445. To move between the widgets (buttons and check buttons) use the
  2446. .I arrow keys
  2447. or the
  2448. .I Tab
  2449. key. To change the state of the check buttons or to select a button
  2450. use
  2451. .I Space.
  2452. You can also use the hotkeys on the buttons to quickly activate them.
  2453. Hotkeys are shown as highlighted letters on the buttons.
  2454. .PP
  2455. To set the attribute bits, use the Enter key.
  2456. .PP
  2457. When working with a group of files or directories, you just click on
  2458. the bits you want to set or clear. Once you have selected the bits
  2459. you want to change, you select one of the action buttons (Set marked
  2460. or Clear marked).
  2461. .PP
  2462. Finally, to set the attributes exactly to those specified, you can use
  2463. the
  2464. .B [Set all]
  2465. button, which will act on all the tagged files.
  2466. .PP
  2467. .B [Marked all]
  2468. set only marked attributes to all selected files
  2469. .PP
  2470. .B [Set marked]
  2471. set marked bits in attributes of all selected files
  2472. .PP
  2473. .B [Clean marked]
  2474. clear marked bits in attributes of all selected files
  2475. .PP
  2476. .B [Set]
  2477. set the attributes of one file
  2478. .PP
  2479. .B [Cancel]
  2480. cancel the Chmod command
  2481. .\"NODE "Chown"
  2482. .SH "Chown"
  2483. The Chown command is used to change the owner/group of a file. The hot
  2484. key for this command is C\-x o.
  2485. .\"NODE "Advanced Chown"
  2486. .SH "Advanced Chown"
  2487. The Advanced Chown command is the
  2488. .\"LINK2"
  2489. Chmod
  2490. .\"Chmod"
  2491. and
  2492. .\"LINK2"
  2493. Chown
  2494. .\"Chown"
  2495. command combined into one window. You can change the permissions and
  2496. owner/group of files at once.
  2497. .\"NODE "File Operations"
  2498. .SH "File Operations"
  2499. When you copy, move or delete files the Midnight Commander shows the
  2500. file operations dialog. It shows the files currently being processed
  2501. and uses up to three progress bars. The file bar indicates the
  2502. percentage of the current file that has been processed so far. The
  2503. count bar shows how many of the tagged files have been handled. The
  2504. bytes bar indicates the percentage of the total size of the tagged files
  2505. that has been handled. If the verbose option is off, the file and bytes
  2506. bars are not shown.
  2507. .PP
  2508. There are two buttons at the bottom of the dialog. Pressing the Skip
  2509. button will skip the rest of the current file. Pressing the Abort
  2510. button will abort the whole operation, the rest of the files are
  2511. skipped.
  2512. .PP
  2513. There are three other dialogs which you can run into during the file
  2514. operations.
  2515. .PP
  2516. The error dialog informs about error conditions and has three choices.
  2517. Normally you select either the Skip button to skip the file or the Abort
  2518. button to abort the operation altogether. You can also select the Retry
  2519. button if you fixed the problem from another terminal.
  2520. .PP
  2521. The replace dialog is shown when you attempt to copy or move a file on
  2522. the top of an existing file. The dialog shows the dates and sizes of
  2523. the both files. Press the Yes button to overwrite the file, the No
  2524. button to skip the file, the All button to overwrite all the files, the
  2525. None button to never overwrite and the Update button to overwrite if the
  2526. source file is newer than the target file. You can abort the whole
  2527. operation by pressing the Abort button.
  2528. .PP
  2529. The recursive delete dialog is shown when you try to delete a directory
  2530. which is not empty. Press the Yes button to delete the directory
  2531. recursively, the No button to skip the directory, the All button to
  2532. delete all the directories and the None button to skip all the non\-empty
  2533. directories. You can abort the whole operation by pressing the Abort
  2534. button. If you selected the Yes or All button you will be asked for a
  2535. confirmation. Type "yes" only if you are really sure you want to do the
  2536. recursive delete.
  2537. .PP
  2538. If you have tagged files and perform an operation on them only the files
  2539. on which the operation succeeded are untagged. Failed and skipped files
  2540. are left tagged.
  2541. .\"NODE "Mask Copy/Rename"
  2542. .SH "Mask Copy/Rename"
  2543. The copy/move operations let you translate the names of files in an
  2544. easy way. To do it, you have to specify the correct source mask and
  2545. usually in the trailing part of the destination specify some wildcards.
  2546. All the files matching the source mask are copied/renamed according to
  2547. the target mask. If there are tagged files, only the tagged files
  2548. matching the source mask are renamed.
  2549. .PP
  2550. There are other options which you can set:
  2551. .PP
  2552. .B Follow links
  2553. .PP
  2554. determines whether make the symlinks and hardlinks in the source
  2555. directory (recursively in subdirectories) new links in the target
  2556. directory or whether would you like to copy their content.
  2557. .PP
  2558. .B Dive into subdirs
  2559. .PP
  2560. determines the behavior when the source directory is about to be copied,
  2561. but the target directory already exists. The default action is to copy
  2562. the contents of the source directory into the target directory.
  2563. Enabling this option causes copying the source directory itself into the
  2564. target directory.
  2565. .PP
  2566. For example, you want to copy directory
  2567. .I /foo
  2568. containing file
  2569. .I bar
  2570. to
  2571. .IR /bla/foo ,
  2572. which is an already existing directory. Normally (when
  2573. .B Dive into subdirs
  2574. is not set), mc would copy file
  2575. .I /foo/bar
  2576. into the file
  2577. .IR /bla/foo/bar .
  2578. By enabling this option the
  2579. .I /bla/foo/foo
  2580. directory will be created, and
  2581. .I /foo/bar
  2582. will be copied into
  2583. .IR /bla/foo/foo/bar .
  2584. .PP
  2585. .B Preserve attributes
  2586. .PP
  2587. determines whether to preserve the permissions, timestamps and (if you
  2588. are root) the ownership of the original files. If this option is not
  2589. set, the current value of the umask will be respected.
  2590. .PP
  2591. .B Use shell patterns on
  2592. .PP
  2593. When the shell patterns option is on you can use the '*' and '?'
  2594. wildcards in the source mask. They work like they do in the shell. In
  2595. the target mask only the '*' and '\\<digit>' wildcards are allowed. The
  2596. first '*' wildcard in the target mask corresponds to the first wildcard
  2597. group in the source mask, the second '*' corresponds to the second group
  2598. and so on. The '\\1' wildcard corresponds to the first wildcard group
  2599. in the source mask, the '\\2' wildcard corresponds to the second group
  2600. and so on all the way up to '\\9'. The '\\0' wildcard is the whole
  2601. filename of the source file.
  2602. .PP
  2603. Two examples:
  2604. .PP
  2605. If the source mask is "*.tar.gz", the destination is "/bla/*.tgz" and the
  2606. file to be copied is "foo.tar.gz", the copy will be "foo.tgz" in "/bla".
  2607. .PP
  2608. Suppose you want to swap basename and extension so that "file.c" would
  2609. become "c.file" and so on. The source mask for this is "*.*" and the
  2610. destination is "\\2.\\1".
  2611. .PP
  2612. .B Use shell patterns off
  2613. .PP
  2614. When the shell patterns option is off the MC doesn't do automatic
  2615. grouping anymore. You must use '\\(...\\)' expressions in the source
  2616. mask to specify meaning for the wildcards in the target mask. This is
  2617. more flexible but also requires more typing. Otherwise target masks
  2618. are similar to the situation when the shell patterns option is on.
  2619. .PP
  2620. Two examples:
  2621. .PP
  2622. If the source mask is "^\\(.*\\)\\.tar\\.gz$", the destination is
  2623. "/bla/*.tgz" and the file to be copied is "foo.tar.gz", the copy
  2624. will be "/bla/foo.tgz".
  2625. .PP
  2626. Let's suppose you want to swap basename and extension so that "file.c"
  2627. will become "c.file" and so on. The source mask for this is
  2628. "^\\(.*\\)\\.\\(.*\\)$" and the destination is "\\2.\\1".
  2629. .PP
  2630. .B Case Conversions
  2631. .PP
  2632. You can also change the case of the filenames. If you use '\\u'
  2633. or '\\l' in the target mask, the next character will be converted to
  2634. uppercase or lowercase correspondingly.
  2635. .PP
  2636. If you use '\\U' or '\\L' in the target mask, the next characters will
  2637. be converted to uppercase or lowercase correspondingly up to the
  2638. next '\\E' or next '\\U', '\\L' or the end of the file name.
  2639. .PP
  2640. The '\\u' and '\\l' are stronger than '\\U' and '\\L'.
  2641. .PP
  2642. For example, if the source mask is '*' (shell patterns on) or '^\\(.*\\)$'
  2643. (shell patterns off) and the target mask is '\\L\\u*' the file names
  2644. will be converted to have initial upper case and otherwise lower case.
  2645. .PP
  2646. You can also use '\\' as a quote character. For example, '\\\\' is
  2647. a backslash and '\\*' is an asterisk.
  2648. .PP
  2649. .B Stable symlinks
  2650. .PP
  2651. commands Midnight Commander, that it should change symlinks in the target,
  2652. so that they'll point to the same location as it did before. With absolute
  2653. symbolic links this does nothing, but if you have a relative one, it will
  2654. recompute its value, adding necessary ../ and other directory parts and making
  2655. the value as short as possible (most modern filesystems keep short symlinks
  2656. inside inodes and thus don't waste much disk space).
  2657. .\"NODE "Select/Unselect Files"
  2658. .SH "Select/Unselect Files"
  2659. The dialog of group of files and directories selection or uselection.
  2660. The
  2661. .\"LINK2"
  2662. input line
  2663. .\"Input Line Keys"
  2664. allow enter the regular expression of filenames that will be
  2665. selected/unselected.
  2666. .PP
  2667. When
  2668. .I Files only
  2669. checkbox is on, only files will be selected. If
  2670. .I Files only
  2671. is off, as files as directories will be selected.
  2672. When
  2673. .I Shell Patterns
  2674. checkbox is on, the regular expression is much like the filename globbing
  2675. in the shell (* standing for zero or more characters and ? standing
  2676. for one character). If
  2677. .I Shell Patterns
  2678. is off, then the tagging of files is done with normal regular
  2679. expressions (see ed (1)). When
  2680. .I Case sensitive
  2681. checkbox is on, the selection will be case sensitive characters.
  2682. If
  2683. .I Case sensitive
  2684. is off, the case will be ignored.
  2685. .\"NODE "Diff Viewer"
  2686. .SH "Internal Diff Viewer"
  2687. The mcdiff is a visual diff tool. You can compare two files and edit them
  2688. in\-place (diffs are updated dynamically). You can browse and view a working
  2689. copy from popular version control systems (GIT, Subversion, etc).
  2690. .PP
  2691. Following shortcuts are available in internal diff viewer of Midnight
  2692. Commander.
  2693. .PP
  2694. .B F1
  2695. Invoke the built\-in hypertext help viewer.
  2696. .PP
  2697. .B F2
  2698. Save modified files.
  2699. .PP
  2700. .B F4
  2701. Edit file of the left panel in the internal editor.
  2702. .PP
  2703. .B F14
  2704. Edit file of the right panel in the internal editor.
  2705. .PP
  2706. .B F5
  2707. Merge the current hunk. Only the current hunk will be merged.
  2708. .PP
  2709. .B F7
  2710. Start search.
  2711. .PP
  2712. .B F17
  2713. Continue search.
  2714. .PP
  2715. .B F10, Esc, q
  2716. Exit from diff viewer.
  2717. .PP
  2718. .B Alt\-s, s
  2719. Toggle show of hunk status.
  2720. .PP
  2721. .B Alt\-n, l
  2722. Toggle show of line numbers.
  2723. .PP
  2724. .B f
  2725. Maximize left panel.
  2726. .PP
  2727. .B \=
  2728. Make panels equal in width.
  2729. .PP
  2730. .B \>
  2731. Reduce the size of the right panel.
  2732. .PP
  2733. .B \<
  2734. Reduce the size of the left panel.
  2735. .PP
  2736. .B c
  2737. Toggle show of trailing carriage return (CR) symbol as ^M.
  2738. .PP
  2739. .B 2, 3, 4, 8
  2740. Set tabulation size
  2741. .PP
  2742. .B C\-u
  2743. Swap contents of diff panels.
  2744. .PP
  2745. .B C\-r
  2746. Refresh the screen.
  2747. .PP
  2748. .B C\-o
  2749. Switch to the subshell and show the command screen.
  2750. .PP
  2751. .B Enter, Space, n
  2752. Find next diff hunk.
  2753. .PP
  2754. .B Backspace, p
  2755. Find previous diff hunk.
  2756. .PP
  2757. .B g
  2758. Go to line.
  2759. .PP
  2760. .B Down
  2761. Scroll one line forward.
  2762. .PP
  2763. .B Up
  2764. Scroll one line backward.
  2765. .PP
  2766. .B PageUp
  2767. Move one page up.
  2768. .PP
  2769. .B PageDown
  2770. Mves one page down.
  2771. .PP
  2772. .B Home, A1
  2773. Moves to the line beginning.
  2774. .PP
  2775. .B End
  2776. Moves to the line end.
  2777. .PP
  2778. .B C\-Home
  2779. Move to the file beginning.
  2780. .PP
  2781. .B C\-End, C1
  2782. Move to the file end.
  2783. .\"NODE "Internal File Viewer"
  2784. .SH "Internal File Viewer"
  2785. The internal file viewer provides two display modes: ASCII and hex.
  2786. To toggle between modes, use the F4 key.
  2787. .PP
  2788. The viewer will try to use the best method provided by your system or
  2789. the file type to display the information.
  2790. Some character sequences, which appear most often in preformatted manual
  2791. pages, are displayed bold and underlined, thus making a pretty display
  2792. of your files.
  2793. .PP
  2794. When in hex mode, the search function accepts text in quotes and
  2795. constant numbers. Text in quotes is matched exactly after removing
  2796. the quotes. Each number matches one byte. You can mix quoted text
  2797. with constants like this:
  2798. .PP
  2799. .nf
  2800. "String" \-1 0xBB 012 "more text"
  2801. .fi
  2802. .PP
  2803. Note that 012 is an octal number. \-1 is converted to 0xFF.
  2804. .PP
  2805. Here is a listing of the actions associated with each key that the
  2806. Midnight Commander handles in the internal file viewer.
  2807. .PP
  2808. .B F1
  2809. Invoke the built\-in hypertext help viewer.
  2810. .PP
  2811. .B F2
  2812. Toggle the wrap mode.
  2813. .PP
  2814. .B F4
  2815. Toggle the hex mode.
  2816. .PP
  2817. .B F5
  2818. Goto line. This will prompt you for a line number and will display
  2819. that line.
  2820. .PP
  2821. .B F6, /.
  2822. Regular expression search.
  2823. .PP
  2824. .B ?,
  2825. Reverse regular expression search.
  2826. .PP
  2827. .B F7
  2828. Normal search / hex mode search.
  2829. .PP
  2830. .B C\-s, F17, n.
  2831. Start normal search if there was no previous search expression else
  2832. find next match.
  2833. .PP
  2834. .B C\-r.
  2835. Start reverse search if there was no previous search expression else
  2836. find next match.
  2837. .PP
  2838. .B F8
  2839. Toggle Raw/Parsed mode: This will show the file as found on disk or if
  2840. a processing filter has been specified in the mc.ext file, then the
  2841. output from the filter. Current mode is always the other than written
  2842. on the button label, since on the button is the mode which you enter
  2843. by that key.
  2844. .PP
  2845. .B F9
  2846. Toggle the format/unformat mode: when format mode is on the viewer
  2847. will interpret some string sequences to show bold and underline with
  2848. different colors. Also, on button label is the other mode than current.
  2849. .PP
  2850. .B F10, Esc.
  2851. Exit the internal file viewer.
  2852. .PP
  2853. .B next\-page, space, C\-v.
  2854. Scroll one page forward.
  2855. .PP
  2856. .B prev\-page, Alt\-v, C\-b, Backspace.
  2857. Scroll one page backward.
  2858. .PP
  2859. .B down\-key
  2860. Scroll one line forward.
  2861. .PP
  2862. .B up\-key
  2863. Scroll one line backward.
  2864. .PP
  2865. .B C\-l
  2866. Refresh the screen.
  2867. .PP
  2868. .B C\-o
  2869. Switch to the subshell and show the command screen.
  2870. .PP
  2871. .B "[n] m"
  2872. Set the mark n.
  2873. .PP
  2874. .B "[n] r"
  2875. Jump to the mark n.
  2876. .PP
  2877. .B C\-f
  2878. Jump to the next file.
  2879. .PP
  2880. .B C\-b
  2881. Jump to the previous file.
  2882. .PP
  2883. .B Alt\-r
  2884. Toggle the ruler.
  2885. .PP
  2886. .B Alt\-e
  2887. to change charset of displayed text may use M\-e (Alt\-e).
  2888. Recoding is made from selected codepage into system codepage. To
  2889. cancel the recoding you may select "<No translation>" in charset
  2890. selection dialog.
  2891. .PP
  2892. It's possible to instruct the file viewer how to display a file, look
  2893. at the
  2894. .\"LINK2"
  2895. Extension File Edit section
  2896. .\"Extension File Edit"
  2897. .\"NODE "Internal File Editor"
  2898. .SH "Internal File Editor"
  2899. The internal file editor is a full\-featured full screen editor. It can
  2900. edit files up to 64 megabytes. It is possible to edit binary files.
  2901. The internal file editor is invoked using
  2902. .B F4
  2903. if the
  2904. .I use_internal_edit
  2905. option is set in the initialization file.
  2906. .PP
  2907. The features it presently supports are: block copy, move, delete, cut,
  2908. paste; key for key undo; pull\-down menus; file insertion; macro
  2909. commands; regular expression search and replace; shift\-arrow text highlighting
  2910. (if supported by the terminal); insert\-overwrite toggle; word wrap;
  2911. autoindent; tunable tab size; syntax highlighting for various file
  2912. types; and an option to pipe text blocks through shell commands like
  2913. indent and ispell.
  2914. .PP
  2915. Sections:
  2916. .IP
  2917. .\"LINK2"
  2918. Options of editor in ini\-file
  2919. .\"Internal File Editor / options"
  2920. .PP
  2921. The editor is very easy to use and requires no tutoring. To see what
  2922. keys do what, just consult the appropriate pull\-down menu. Other keys
  2923. are: Shift movement keys do text highlighting.
  2924. .B Ctrl\-Ins
  2925. copies to the file
  2926. .B mcedit.clip
  2927. and
  2928. .B Shift\-Ins
  2929. pastes from mcedit.clip.
  2930. .B Shift\-Del
  2931. cuts to
  2932. .BR mcedit.clip ,
  2933. and
  2934. .B Ctrl\-Del
  2935. deletes highlighted text. Mouse highlighting also works, and you
  2936. can override the mouse as usual by holding down the shift key
  2937. while dragging the mouse to let normal terminal mouse highlighting
  2938. work.
  2939. .PP
  2940. To define a macro, press
  2941. .B Ctrl\-R
  2942. and then type out the key
  2943. strokes you want to be executed. Press
  2944. .B Ctrl\-R
  2945. again when finished. You can then assign the macro to any key you
  2946. like by pressing that key. The macro is executed when you press
  2947. .B Ctrl\-A
  2948. and then the assigned key. The macro is also executed if
  2949. you press Meta, Ctrl, or Esc and the assigned key, provided that the
  2950. key is not used for any other function. Once defined, the macro
  2951. commands go into the file
  2952. .B ~/.local/share/mc/mcedit/mcedit.macros
  2953. You can delete a macro by deleting the
  2954. appropriate line in this file.
  2955. .PP
  2956. To change charset of displayed text may use M\-e (Alt\-e).
  2957. Recoding is made from selected codepage into system codepage. To
  2958. cancel the recoding you may select "<No translation>" in charset
  2959. selection dialog.
  2960. .PP
  2961. .B F19
  2962. will format the currently highlighted block (plain text or
  2963. .B C
  2964. or
  2965. .B C++
  2966. code or another). This is controlled by the
  2967. file
  2968. .B @prefix@/share/mc/edit.indent.rc
  2969. which is copied to
  2970. .B ~/.local/share/mc/mcedit/edit.indent.rc
  2971. in your home directory the first time you use it.
  2972. .PP
  2973. The editor also displays non\-us characters (160+). When editing
  2974. binary files, you should set
  2975. .B display bits
  2976. to 7 bits in the options menu to keep the spacing clean.
  2977. .\"NODE "Internal File Editor / options"
  2978. .SH "Options of editor in ini\-file"
  2979. Some editor options of ini\-file are described in this section.
  2980. Options are placed in [Midnight\-Commander] section
  2981. .TP
  2982. .I editor_wordcompletion_collect_entire_file
  2983. Search autocomplete candidates in entire of file or just from
  2984. begin of file to cursor position (0)
  2985. .\"NODE "Screen selector"
  2986. .SH "Screen selector"
  2987. Midnight Commander supports running many internal modules (such as
  2988. editor, viewer and diff viewer) simultaneously and switching between
  2989. them without closing open files. Using several file managers at a time,
  2990. however, is not currently supported.
  2991. .PP
  2992. Let's call each of these modules a screen. There are three ways to
  2993. switch between screens, using one of these global shortcuts:
  2994. .TP
  2995. .B Alt\-}
  2996. switch to the next screen;
  2997. .TP
  2998. .B Alt\-{
  2999. switch to the previous screen;
  3000. .TP
  3001. .B Alt\-`
  3002. open a dialog window with the list of currently open screens (or use the
  3003. "Screen list" menu item).
  3004. .\"NODE "Completion"
  3005. .SH "Completion"
  3006. Let the Midnight Commander type for you.
  3007. .PP
  3008. Attempt to perform completion on the text before current position. MC
  3009. attempts completion treating the text as variable (if the text begins
  3010. with
  3011. .BR $ ),
  3012. username (if the text begins with
  3013. .BR ~ ),
  3014. hostname (if the text begins with
  3015. .BR @ )
  3016. or command (if you are on the command line in the position where you
  3017. might type a command, possible completions then include shell reserved
  3018. words and shell built\-in commands as well) in turn. If none of these
  3019. matches, filename completion is attempted.
  3020. .PP
  3021. Filename, username, variable and hostname completion works on all input
  3022. lines, command completion is command line specific. If the completion
  3023. is ambiguous (there are more different possibilities), MC beeps and the
  3024. following action depends on the setting of the
  3025. .I Complete: show all
  3026. option in the
  3027. .\"LINK2"
  3028. Configuration
  3029. .\"Configuration"
  3030. dialog. If it is enabled, a list of all possibilities pops up next to
  3031. the current position and you can select with the arrow keys and
  3032. .B Enter
  3033. the correct entry. You can also type the first letters in which the
  3034. possibilities differ to move to a subset of all possibilities and
  3035. complete as much as possible. If you press
  3036. .B Alt\-Tab
  3037. again, only the subset will be shown in the listbox, otherwise the first
  3038. item which matches all the previous characters will be highlighted. As
  3039. soon as there is no ambiguity, dialog disappears, but you can hide it by
  3040. canceling keys
  3041. .BR Esc ,
  3042. .B F10
  3043. and left and right arrow keys. If
  3044. .\"LINK2"
  3045. Complete: show all
  3046. .\"Configuration"
  3047. is disabled, the dialog pops up only if you press
  3048. .B Alt\-Tab
  3049. for the second time, for the first time MC just beeps.
  3050. .\"NODE "Virtual File System"
  3051. .SH "Virtual File System"
  3052. The Midnight Commander is provided with a code layer to access the file
  3053. system; this code layer is known as the virtual file system switch. The
  3054. virtual file system switch allows the Midnight Commander to manipulate
  3055. files not located on the Unix file system.
  3056. .PP
  3057. Currently the Midnight Commander is packaged with some Virtual File
  3058. Systems (VFS): the
  3059. .I local
  3060. file system, used for accessing the regular Unix file system; the
  3061. .IR ftpfs ,
  3062. used to manipulate files on remote systems with the FTP protocol; the
  3063. .IR tarfs ,
  3064. used to manipulate tar and compressed tar files; the
  3065. .IR undelfs ,
  3066. used to recover deleted files on ext2 file systems (the default file
  3067. system for Linux systems),
  3068. .I fish
  3069. (for manipulating files over shell connections such as rsh and ssh).
  3070. If the code was compiled with
  3071. .I smbfs
  3072. support, you can manipulate files on remote systems with the SMB (CIFS)
  3073. protocol.
  3074. .PP
  3075. A generic
  3076. .I extfs
  3077. (EXTernal virtual File System) is provided in order to easily expand
  3078. VFS capabilities using scripts and external software.
  3079. .PP
  3080. The VFS switch code will interpret all of the path names used and will
  3081. forward them to the correct file system, the formats used for each one
  3082. of the file systems is described later in their own section.
  3083. .\"NODE " FTP File System"
  3084. .SH " FTP File System"
  3085. The FTP File System (ftpfs) allows you to manipulate files on remote
  3086. machines. To actually use it, you can use the
  3087. .I FTP link
  3088. item in the menu or directly change your current directory using the
  3089. .I cd
  3090. command to a path name that looks like this:
  3091. .PP
  3092. .I ftp://[!][user[:pass]@]machine[:port][remote\-dir]
  3093. .PP
  3094. The
  3095. .IR user ,
  3096. .I port
  3097. and
  3098. .I remote\-dir
  3099. elements are optional. If you specify the
  3100. .I user
  3101. element, the Midnight Commander will login to the remote machine as that
  3102. user, otherwise it will use anonymous login or the login name from the
  3103. .I ~/.netrc
  3104. file. The optional
  3105. .I pass
  3106. element is the password used for the connection. Using the password in
  3107. the VFS directory name is not recommended, because it can appear on the
  3108. screen in clear text and can be saved to the directory history.
  3109. .PP
  3110. To enable using FTP proxy, prepend
  3111. .B !
  3112. (an exclamation sign) to the hostname.
  3113. .PP
  3114. Examples:
  3115. .PP
  3116. .nf
  3117. ftp://ftp.nuclecu.unam.mx/linux/local
  3118. ftp://tsx\-11.mit.edu/pub/linux/packages
  3119. ftp://!behind.firewall.edu/pub
  3120. ftp://guest@remote\-host.com:40/pub
  3121. ftp://miguel:xxx@server/pub
  3122. .fi
  3123. .PP
  3124. Please check the
  3125. .\"LINK2"
  3126. Virtual File System
  3127. .\"Virtual FS"
  3128. dialog box for ftpfs options.
  3129. .\"NODE " Tar File System"
  3130. .SH " Tar File System"
  3131. The tar file system provides you with read\-only access to your tar
  3132. files and compressed tar files by using the chdir command. To change
  3133. your directory to a tar file, you change your current directory to the
  3134. tar file by using the following syntax:
  3135. .PP
  3136. .I /filename.tar/utar://[dir\-inside\-tar]
  3137. .PP
  3138. The mc.ext file already provides a shortcut for tar files, this means
  3139. that usually you just point to a tar file and press return to enter
  3140. into the tar file, see the
  3141. .\"LINK2"
  3142. Extension File Edit
  3143. .\"Extension File Edit"
  3144. section for details on how this is done.
  3145. .PP
  3146. Examples:
  3147. .PP
  3148. .nf
  3149. mc\-3.0.tar.gz/utar://mc\-3.0/vfs
  3150. /ftp/GCC/gcc\-2.7.0.tar/utar://
  3151. .fi
  3152. .PP
  3153. The latter specifies the full path of the tar archive.
  3154. .\"NODE " FIle transfer over SHell filesystem"
  3155. .SH " FIle transfer over SHell filesystem"
  3156. The fish file system is a network based file system that allows you to
  3157. manipulate the files in a remote machine as if they were local. To use
  3158. this, the other side has to either run fish server, or has to have
  3159. bash\-compatible shell.
  3160. .PP
  3161. To connect to a remote machine, you just need to chdir
  3162. into a special directory which name is in the following
  3163. format:
  3164. .PP
  3165. .I sh://[user@]machine[:options]/[remote\-dir]
  3166. .PP
  3167. The
  3168. .I user,
  3169. .I options
  3170. and
  3171. .I remote\-dir
  3172. elements are optional. If you specify the
  3173. .I user
  3174. element, the Midnight Commander will try to login on the remote
  3175. machine as that user, otherwise it will use your login name.
  3176. .PP
  3177. The available
  3178. .I options
  3179. are:
  3180. .nf
  3181. 'C' \- use compression;
  3182. 'r' \- use rsh instead of ssh;
  3183. port \- specify the port used by remote server.
  3184. .fi
  3185. If the
  3186. .I remote\-dir
  3187. element is present, your current directory on the remote machine will be
  3188. set to this one.
  3189. .PP
  3190. Examples:
  3191. .PP
  3192. .nf
  3193. sh://onlyrsh.mx:r/linux/local
  3194. sh://joe@want.compression.edu:C/private
  3195. sh://joe@noncompressed.ssh.edu/private
  3196. sh://joe@somehost.ssh.edu:2222/private
  3197. .fi
  3198. .\"NODE " Undelete File System"
  3199. .SH " Undelete File System"
  3200. On Linux systems, if you asked configure to use the ext2fs undelete
  3201. facilities, you will have the undelete file system available.
  3202. Recovery of deleted files is only available on ext2 file systems. The
  3203. undelete file system is just an interface to the ext2fs library to
  3204. retrieve all of the deleted files names on an ext2fs and provides and
  3205. to extract the selected files into a regular partition.
  3206. .PP
  3207. To use this file system, you have to chdir into the special file name
  3208. formed by the "undel://" prefix and the file name where the actual
  3209. file system resides.
  3210. .PP
  3211. For example, to recover deleted files on the second partition of the
  3212. first SCSI disk on Linux, you would use the following path name:
  3213. .PP
  3214. .nf
  3215. undel://sda2
  3216. .fi
  3217. .PP
  3218. It may take a while for the undelfs to load the required information
  3219. before you start browsing files there.
  3220. .\"NODE " SMB File System"
  3221. .SH " SMB File System"
  3222. The smbfs allows you to manipulate files on remote machines with SMB
  3223. (or CIFS) protocol. These include Windows for Workgroups,
  3224. Windows 9x/ME/XP, Windows NT, Windows 2000 and Samba.
  3225. To actually use it, you may try to use the panel command "SMB link..."
  3226. (accessible from the menubar) or you may directly change your current
  3227. directory to it using the cd command to a path name that looks like this:
  3228. .PP
  3229. .I smb://[user@]machine[/service][/remote\-dir]
  3230. .PP
  3231. The
  3232. .IR user ,
  3233. .I service
  3234. and
  3235. .I remote\-dir
  3236. elements are optional.
  3237. The
  3238. .IR user ,
  3239. .I domain
  3240. and
  3241. .I password
  3242. can be specified in an input dialog.
  3243. .PP
  3244. Examples:
  3245. .PP
  3246. .nf
  3247. smb://machine/Share
  3248. smb://other_machine
  3249. smb://guest@machine/Public/Irlex
  3250. .fi
  3251. .\"NODE " EXTernal File System"
  3252. .SH " EXTernal File System"
  3253. .B extfs
  3254. allows to integrate numerous features and file types into GNU Midnight
  3255. Commander in an easy way, by writing scripts.
  3256. .PP
  3257. Extfs filesystems can be divided into two categories:
  3258. .PP
  3259. 1. Stand\-alone filesystems, which are not associated with any existing
  3260. file. They represent certain system\-wide data as a directory tree.
  3261. You can invoke them by typing
  3262. .RI ' "cd fsname://" '
  3263. where fsname is an extfs short name (see below). Examples of such
  3264. filesystems include audio (list audio tracks on the CD) or apt (list of
  3265. all Debian packages in the system).
  3266. .PP
  3267. For example, to list CD\-Audio tracks on your CD\-ROM drive, type
  3268. .PP
  3269. .nf
  3270. cd audio://
  3271. .fi
  3272. .PP
  3273. 2. 'Archive' filesystems (like rpm, patchfs and more), which represent
  3274. contents of a file as a directory tree. It can consist of 'real' files
  3275. compressed in an archive (urar, rpm) or virtual files, like messages
  3276. in a mailbox (mailfs) or parts of a patch (patchfs). To access such
  3277. filesystems
  3278. .RI ' fsname:// '
  3279. should be appended to the archive name. Note that the archive itself
  3280. can be on another vfs.
  3281. .PP
  3282. For example, to list contents of a zip archive documents.zip type
  3283. .PP
  3284. .nf
  3285. cd documents.zip/uzip://
  3286. .fi
  3287. .PP
  3288. In many aspects, you could treat extfs like any other directory. For
  3289. instance, you can add it to the hotlist or change to it from directory
  3290. history. An important limitation is that you cannot invoke shell
  3291. commands inside extfs, just like any other non\-local VFS.
  3292. .PP
  3293. Common extfs scripts included with Midnight Commander are:
  3294. .TP
  3295. .B a
  3296. access 'A:' DOS/Windows diskette
  3297. .RI ( "cd a://" ).
  3298. .TP
  3299. .B apt
  3300. front end to Debian's APT package management system
  3301. .RI ( "cd apt://" ).
  3302. .TP
  3303. .B audio
  3304. audio CD ripping and playing
  3305. .RI ( "cd audio://"
  3306. or
  3307. .IR "cd device/audio://" ).
  3308. .TP
  3309. .B bpp
  3310. package of Bad Penguin GNU/Linux distribution
  3311. .RI ( "cd file.bpp/bpp://" ).
  3312. .TP
  3313. .B deb
  3314. package of Debian GNU/Linux distribution
  3315. .RI ( "cd file.deb/deb://" ).
  3316. .TP
  3317. .B dpkg
  3318. Debian GNU/Linux installed packages
  3319. .RI ( "cd deb://" ).
  3320. .TP
  3321. .B hp48
  3322. view and copy files to/from a HP48 calculator
  3323. .RI ( "cd hp48://" ).
  3324. .TP
  3325. .B lslR
  3326. browsing of lslR listings as found on many FTPs
  3327. .RI ( "cd filename/lslR://" ).
  3328. .TP
  3329. .B mailfs
  3330. mbox\-style mailbox files support
  3331. .RI ( "cd mailbox/mailfs://" ).
  3332. .TP
  3333. .B patchfs
  3334. extfs to handle unified and context diffs
  3335. .RI ( "cd filename/patchfs://" ).
  3336. .TP
  3337. .B rpm
  3338. RPM package
  3339. .RI ( "cd filename/rpm://" ).
  3340. .TP
  3341. .B rpms
  3342. RPM database management
  3343. .RI ( "cd rpms://" ).
  3344. .TP
  3345. .B ulha, urar, uzip, uzoo, uar, uha
  3346. archivers
  3347. .RI ( "cd archive/xxxx://"
  3348. where xxxx is one of:
  3349. .IR ulha ,
  3350. .IR urar ,
  3351. .IR uzip ,
  3352. .IR uzoo ,
  3353. .IR uar ,
  3354. .IR uha ).
  3355. .PP
  3356. You could bind file type/extension to specified extfs as described in the
  3357. .\"LINK2"
  3358. Extension File Edit
  3359. .\"Extension File Edit"
  3360. section. Here is an example entry for Debian packages:
  3361. .PP
  3362. .nf
  3363. regex/\.deb$
  3364. Open=%cd %p/deb://
  3365. .fi
  3366. .\"NODE "Colors"
  3367. .SH "Colors"
  3368. The Midnight Commander will try to detect if your terminal supports
  3369. color using the terminal database and your terminal name. Sometimes
  3370. it gets confused, so you may force color mode or disable color mode
  3371. using the \-c and \-b flag respectively.
  3372. .PP
  3373. If the program is compiled with the Slang screen manager instead of
  3374. ncurses, it will also check the variable
  3375. .B COLORTERM,
  3376. if it is set, it has the same effect as the \-c flag.
  3377. .PP
  3378. You may specify terminals that always force color mode
  3379. by adding the
  3380. .I color_terminals
  3381. variable to the Colors section of the initialization file. This will
  3382. prevent the Midnight Commander from trying to detect if your terminal
  3383. supports color. Example:
  3384. .PP
  3385. .nf
  3386. [Colors]
  3387. color_terminals=linux,xterm
  3388. color_terminals=terminal\-name1,terminal\-name2...
  3389. .fi
  3390. .PP
  3391. The program can be compiled with both ncurses and slang, ncurses does
  3392. not provide a way to force color mode: ncurses uses just the
  3393. information in the terminal database.
  3394. .PP
  3395. The Midnight Commander provides a way to change the default colors.
  3396. Currently the colors are configured using the environment variable
  3397. .B MC_COLOR_TABLE
  3398. or the Colors section in the initialization file.
  3399. .PP
  3400. In the Colors section, the default color map is loaded from the
  3401. .I base_color
  3402. variable. You can specify an alternate color map for a terminal by
  3403. using the terminal name as the key in this section. Example:
  3404. .PP
  3405. .nf
  3406. [Colors]
  3407. base_color=
  3408. xterm=menu=magenta:marked=,magenta:markselect=,red
  3409. .fi
  3410. .PP
  3411. The format for the color definition is:
  3412. .PP
  3413. .nf
  3414. <keyword>=<fgcolor>,<bgcolor>,<attributes>:<keyword>=...
  3415. .fi
  3416. .PP
  3417. The colors are optional, and the keywords are: normal, selected, disabled, marked,
  3418. markselect, errors, input, inputmark, inputunchanged, commandlinemark,
  3419. reverse, gauge, header, inputhistory, commandhistory. Button bar colors are:
  3420. bbarhotkey, bbarbutton. Status bar color: statusbar. Menu colors are: menunormal,
  3421. menusel, menuhot, menuhotsel, menuinactive. Dialog colors are: dnormal, dfocus,
  3422. dhotnormal, dhotfocus, dtitle. Error dialog colors are: errdfocus, errdhotnormal,
  3423. errdhotfocus, errdtitle. Help colors are: helpnormal, helpitalic, helpbold,
  3424. helplink, helpslink, helptitle. Viewer color are: viewbold, viewunderline, viewselected.
  3425. Editor colors are: editnormal, editbold, editmarked, editwhitespace, editlinestate.
  3426. Popup menu colors are: pmenunormal, pmenusel, pmenutitle.
  3427. .PP
  3428. .I header
  3429. determines the color of panel header, the line that contains column titles
  3430. and sort mode indicator.
  3431. .PP
  3432. .I input
  3433. determines the color of input lines used in query dialogs.
  3434. .PP
  3435. .I gauge
  3436. determines the color of the filled part of the progress bar (gauge),
  3437. which is used to show the user the progress of file operations, such as
  3438. copying.
  3439. .PP
  3440. .I disabled
  3441. determines the color of the widget that cannot be selected.
  3442. .PP
  3443. The dialog boxes use the following colors:
  3444. .I dnormal
  3445. is used for the normal text,
  3446. .I dfocus
  3447. is the color used for the currently selected component,
  3448. .I dhotnormal
  3449. is the color used to differentiate the hotkey color in normal
  3450. components, whereas the
  3451. .I dhotfocus
  3452. color is used for the highlighted color in the currently selected
  3453. component.
  3454. .PP
  3455. Menus use the same scheme but uses the menunormal, menusel, menuhot, menuhotsel
  3456. and menuinactive tags instead.
  3457. .PP
  3458. Help uses the following colors:
  3459. .I helpnormal
  3460. is used for normal text,
  3461. .I helpitalic
  3462. is used for text which is emphasized in italic in the manual page,
  3463. .I helpbold
  3464. is used for text which is emphasized in bold in the manual page,
  3465. .I helplink
  3466. is used for not selected hyperlinks and
  3467. .I helpslink
  3468. is used for selected hyperlink.
  3469. .PP
  3470. Popup menu uses following colors:
  3471. .I pmenunormal
  3472. is used for non-selected menu items and as a main color of popup menu window,
  3473. .I pmenusel
  3474. is used for selected menu item,
  3475. .I pmenutitle
  3476. is used for popup menu title.
  3477. .PP
  3478. The possible colors are: black, gray, red, brightred, green,
  3479. brightgreen, brown, yellow, blue, brightblue, magenta, brightmagenta,
  3480. cyan, brightcyan, lightgray and white. And there is a special keyword
  3481. for transparent background. It is 'default'. The 'default' can only be
  3482. used for background color. Another special keyword "base" means mc's main
  3483. colors. When 256 colors are available, they can be specified either as
  3484. color16 to color255, or as rgb000 to rgb555 and gray0 to gray23. Example:
  3485. .PP
  3486. .nf
  3487. [Colors]
  3488. base_color=normal=white,default:marked=magenta,default
  3489. .fi
  3490. .PP
  3491. Attributes can be any of bold, underline, reverse and blink, appended by a
  3492. plus sign if more than one are desired. The special word "none" means no
  3493. attributes, without attempting to fall back to base_color. Example:
  3494. .PP
  3495. .nf
  3496. menuhotsel=yellow;black;bold+underline
  3497. .fi
  3498. .\"NODE "Skins"
  3499. .SH "Skins"
  3500. You can change the appearance of Midnight Commander.
  3501. To do this, you must specify a file that contain descriptions of colors
  3502. and lines to draw boxes. Redefining of the colors is entirely compatible
  3503. with the assignment of colors, as described in Section
  3504. .\"LINK2"
  3505. Colors\&.
  3506. .\"Colors"
  3507. .PP
  3508. If your skin contains any of 256\-color definitions, you should define
  3509. the '256colors' key set to TRUE value in [skin] section.
  3510. .PP
  3511. A skin\-file is searched on the following algorithm (to the first one found):
  3512. .IP
  3513. .br
  3514. 1) command line option
  3515. .B \-S \<skin\>
  3516. or
  3517. .B \-\-skin=\<skin\>
  3518. .br
  3519. 2) Environment variable
  3520. .B MC_SKIN
  3521. .br
  3522. 3) Parameter
  3523. .B skin
  3524. in section
  3525. .B [Midnight\-Commander]
  3526. in config file.
  3527. .br
  3528. 4) File
  3529. .B @sysconfdir@/mc/skins/default.ini
  3530. .br
  3531. 5) File
  3532. .B @prefix@/share/mc/skins/default.ini
  3533. .PP
  3534. Command line option, environment variable and parameter in config file may
  3535. contain the absolute path to the skin\-file (with the extension \.ini
  3536. or without it). Search of skin\-file will occur in (to the first one found):
  3537. .IP
  3538. 1)
  3539. .B ~/.local/share/mc/skins/
  3540. .br
  3541. 2)
  3542. .B @sysconfdir@/mc/skins/
  3543. .br
  3544. 3)
  3545. .B @prefix@/share/mc/skins/
  3546. .br
  3547. .PP
  3548. For getting extended info, refer to:
  3549. .IP
  3550. .\"LINK2"
  3551. Description of section and parameters
  3552. .\"Skins sections"
  3553. .br
  3554. .\"LINK2"
  3555. Color pair definitions
  3556. .\"Skins colors"
  3557. .br
  3558. .\"LINK2"
  3559. Draw lines
  3560. .\"Skins lines"
  3561. .br
  3562. .\"LINK2"
  3563. Compatibility
  3564. .\"Skins oldcolors"
  3565. .br
  3566. .\"NODE " Skins sections"
  3567. .SH " Description of section and parameters"
  3568. Section
  3569. .B [skin]
  3570. contain metainfo for skin\-file. Parameter
  3571. .I description
  3572. contain short text about skin.
  3573. .PP
  3574. Section
  3575. .B [filehighlight]
  3576. contain descriptions of color pairs for filenames highlighting.
  3577. Name of parameters must be equal to names of sections into
  3578. filehighlight.ini file.
  3579. See
  3580. .\"LINK2"
  3581. Filenames Highlight
  3582. .\"Filenames Highlight"
  3583. for getting more info.
  3584. .PP
  3585. Section
  3586. .B [core]
  3587. describes the elements that are used everywhere.
  3588. .TP
  3589. .I _default_
  3590. Default color pair. Used in all other sections if they not contain
  3591. color definitions
  3592. .TP
  3593. .I selected
  3594. cursor
  3595. .TP
  3596. .I marked
  3597. selected data
  3598. .TP
  3599. .I markselect
  3600. cursor on selected data
  3601. .TP
  3602. .I gauge
  3603. color of the filled part of the progress bar
  3604. .TP
  3605. .I input
  3606. color of input lines used in query dialogs
  3607. .TP
  3608. .I inputmark
  3609. color of input selected text
  3610. .TP
  3611. .I inputunhanged
  3612. color of input text before first modification or cursor movement
  3613. .TP
  3614. .I commandlinemark
  3615. color of selected text in command line
  3616. .TP
  3617. .I reverse
  3618. reverse color
  3619. .PP
  3620. Section
  3621. .B [dialog]
  3622. describes the elements that are placed on dialog windows (except error dialogs).
  3623. .TP
  3624. .I _default_
  3625. Default color for this section. Used [core]._default_ if not specified
  3626. .TP
  3627. .I dfocus
  3628. Color of active element (in focus)
  3629. .TP
  3630. .I dhotnormal
  3631. Color of hotkeys
  3632. .TP
  3633. .I dhotfocus
  3634. Color of hotkeys in focused element
  3635. .PP
  3636. Section
  3637. .B [error]
  3638. describes the elements that are placed on error dialog windows
  3639. .TP
  3640. .I _default_
  3641. Default color for this section. Used [core]._default_ if not specified
  3642. .TP
  3643. .I errdhotnormal
  3644. Color of hotkeys
  3645. .TP
  3646. .I errdhotfocus
  3647. Color of hotkeys in focused element
  3648. .PP
  3649. Section
  3650. .B [menu]
  3651. describes the elements that are placed in menu. This section describes
  3652. system menu (called by F9) and user\-defined menus (called by F2 in panels
  3653. and by F11 in editor).
  3654. .TP
  3655. .I _default_
  3656. Default color for this section. Used [core]._default_ if not specified
  3657. .TP
  3658. .I entry
  3659. Color of menu items
  3660. .TP
  3661. .I menuhot
  3662. Color of menu hotkeys
  3663. .TP
  3664. .I menusel
  3665. Color of active menu item (in focus)
  3666. .TP
  3667. .I menuhotsel
  3668. Color of menu hotkeys in focused menu item
  3669. .TP
  3670. .I menuinactive
  3671. Color of inactive menu
  3672. .PP
  3673. Section
  3674. .B [help]
  3675. describes the elements that are placed on help window.
  3676. .TP
  3677. .I _default_
  3678. Default color for this section. Used [core]._default_ if not specified
  3679. .TP
  3680. .I helpitalic
  3681. Color pair for element with
  3682. .B italic
  3683. attribute
  3684. .TP
  3685. .I helpbold
  3686. Color pair for element with
  3687. .B bold
  3688. attribute
  3689. .TP
  3690. .I helplink
  3691. Color of links
  3692. .TP
  3693. .I helpslink
  3694. Color of active link (on focus)
  3695. .PP
  3696. Section
  3697. .B [editor]
  3698. describes the colors of elements placed in editor.
  3699. .TP
  3700. .I _default_
  3701. Default color for this section. Used [core]._default_ if not specified
  3702. .TP
  3703. .I editbold
  3704. Color pair for element with
  3705. .B bold
  3706. attribute
  3707. .TP
  3708. .I editmarked
  3709. Color of selected text
  3710. .TP
  3711. .I editwhitespace
  3712. Color of tabs and trailing spaces highlighting
  3713. .TP
  3714. .I editlinestate
  3715. Color for line state area
  3716. .PP
  3717. Section
  3718. .B [viewer]
  3719. describes the colors of elements placed in viewer.
  3720. .TP
  3721. .I viewunderline
  3722. Color pair for element with
  3723. .B underline
  3724. attribute
  3725. .\"NODE " Skins colors"
  3726. .SH " Color pair definitions"
  3727. Any parameter in skin\-file contain definition of color pair.
  3728. .PP
  3729. Color pairs described as two colors and the optional attributes
  3730. separated by ';'. First field sets the foreground color, second
  3731. field sets background color, third field sets the attributes.
  3732. Any of the fields may be omitted, in this case value will be
  3733. taken from default color pair (global color pair or from default
  3734. color pair of this section).
  3735. .PP
  3736. Example:
  3737. .br
  3738. .nf
  3739. [core]
  3740. # green on black
  3741. _default_=green;black
  3742. # green (default) on blue
  3743. selected=;blue
  3744. # yellow on black (default)
  3745. # underlined yellow on black (default)
  3746. marked=yellow;;underline
  3747. .fi
  3748. .PP
  3749. Possible colors (names) and attributes are described in
  3750. .\"LINK2"
  3751. Colors\&.
  3752. .\"Colors"
  3753. section.
  3754. .\"NODE " Skins lines"
  3755. .SH " Draw lines"
  3756. Lines sets in section
  3757. .B [Lines]
  3758. into skin\-file. By default single lines are used, but you may redefine
  3759. to usage of any utf\-8 symbols (like to lines, for example).
  3760. .PP
  3761. .I WARNING!!!
  3762. When you build Midnight Commander with the Ncurses screen library
  3763. usage of drawing lines is limited!
  3764. Possible only drawing a single lines.
  3765. For all questions and comments please contact the developers of Ncurses.
  3766. .PP
  3767. Descriptions of parameters
  3768. .BR [Lines] :
  3769. .TP
  3770. .I lefttop
  3771. left\-top line fragment.
  3772. .TP
  3773. .I righttop
  3774. right\-top line fragment.
  3775. .TP
  3776. .I centertop
  3777. down branch of horizontal line
  3778. .TP
  3779. .I centerbottom
  3780. up branch of horizontal line
  3781. .TP
  3782. .I leftbottom
  3783. left\-bottom line fragment
  3784. .TP
  3785. .I rightbottom
  3786. right\-bottom line fragment
  3787. .TP
  3788. .I leftmiddle
  3789. right branch of vertical line
  3790. .TP
  3791. .I rightmiddle
  3792. left branch of vertical line
  3793. .TP
  3794. .I centermiddle
  3795. cross of lines
  3796. .TP
  3797. .I horiz
  3798. horizontal line
  3799. .TP
  3800. .I vert
  3801. vertical line
  3802. .TP
  3803. .I thinhoriz
  3804. thin horizontal line
  3805. .TP
  3806. .I thinvert
  3807. thin vertical line
  3808. .\"NODE " Skins oldcolors"
  3809. .SH " Compatibility"
  3810. Appointment of color by skin\-files fully compatible with
  3811. the appointment of the colors described in
  3812. .\"LINK2"
  3813. Colors\&.
  3814. .\"Colors"
  3815. section.
  3816. .PP
  3817. In this case, reassignment of colors has priority over the skin file and is
  3818. complementary.
  3819. .\"NODE "Filenames Highlight"
  3820. .SH "Filenames Highlight"
  3821. Section [filehighlight] in current skin\-file contains key names as
  3822. highlight groups and values as color pairs. Color pairs is documented
  3823. in
  3824. .\"LINK2"
  3825. Skins
  3826. .\"Skins"
  3827. section.
  3828. .PP
  3829. Rules of filenames highlight are placed in @prefix@/share/mc/filehighlight.ini file
  3830. (~/.config/mc/filehighlight.ini).
  3831. Name of section in this file must be equal to parameters names in
  3832. [filehighlight] section (in current skin\-file).
  3833. .PP
  3834. Keys in these groups are:
  3835. .TP
  3836. .I type
  3837. file type. If present, all other options are ignored.
  3838. .TP
  3839. .I regexp
  3840. regular expression. If present, 'extensions' option is ignored.
  3841. .TP
  3842. .I extensions
  3843. list of extensions of files. Separated by ';' sign.
  3844. .TP
  3845. .I extensions_case
  3846. (make sense only with 'extensions' parameter) make 'extensions'
  3847. rule case sentitive (true) or not (false).
  3848. .PP
  3849. `type' key may have values:
  3850. .nf
  3851. \- FILE (all files)
  3852. \- FILE_EXE
  3853. \- DIR (all directories)
  3854. \- LINK_DIR
  3855. \- LINK (all links except stale link)
  3856. \- HARDLINK
  3857. \- SYMLINK
  3858. \- STALE_LINK
  3859. \- DEVICE (all device files)
  3860. \- DEVICE_BLOCK
  3861. \- DEVICE_CHAR
  3862. \- SPECIAL (all special files)
  3863. \- SPECIAL_SOCKET
  3864. \- SPECIAL_FIFO
  3865. \- SPECIAL_DOOR
  3866. .fi
  3867. .PP
  3868. .\"NODE "Special Settings"
  3869. .SH "Special Settings"
  3870. Most of the Midnight Commander settings can be changed from the
  3871. menus. However, there are a small number of settings which can only be
  3872. changed by editing the setup file.
  3873. .PP
  3874. These variables may be set in your ~/.config/mc/ini file:
  3875. .TP
  3876. .I clear_before_exec
  3877. By default the Midnight Commander clears the screen before executing a
  3878. command. If you would prefer to see the output of the command at the
  3879. bottom of the screen, edit your ~/.config/mc/ini file and change the value of
  3880. the field clear_before_exec to 0.
  3881. .TP
  3882. .I confirm_view_dir
  3883. If you press F3 on a directory, normally MC enters that directory. If
  3884. this flag is set to 1, then MC will ask for confirmation before changing
  3885. the directory if you have files tagged.
  3886. .TP
  3887. .I ftpfs_retry_seconds
  3888. This value is the number of seconds the Midnight Commander will wait
  3889. before attempting to reconnect to an FTP server that has denied the
  3890. login. If the value is zero, the login will no be retried.
  3891. .TP
  3892. .I max_dirt_limit
  3893. Specifies how many screen updates can be skipped at most in the internal
  3894. file viewer. Normally this value is not significant, because the code
  3895. automatically adjusts the number of updates to skip according to the
  3896. rate of incoming keystrokes. However, on very slow machines or
  3897. terminals with a fast keyboard auto repeat, a big value can make screen
  3898. updates too jumpy.
  3899. .IP
  3900. It seems that setting max_dirt_limit to 10 causes the best behavior,
  3901. and that is the default value.
  3902. .TP
  3903. .I mouse_move_pages_viewer
  3904. Controls if scrolling with the mouse is done by pages or line by line
  3905. on the internal file viewer.
  3906. .TP
  3907. .I only_leading_plus_minus
  3908. Allow special treatment for '+', '\-', '*' in the command line (select,
  3909. unselect, reverse selection) only if the command line is empty. You
  3910. don't need to quote those characters in the middle of the command line.
  3911. On the other hand, you cannot use them to change selection when the
  3912. command line is not empty.
  3913. .TP
  3914. .I show_output_starts_shell
  3915. This variable only works if you are not using the subshell support.
  3916. When you use the C\-o keystroke to go back to the user screen, if this
  3917. one is set, you will get a fresh shell. Otherwise, pressing any key
  3918. will bring you back to the Midnight Commander.
  3919. .TP
  3920. .I timeformat_recent
  3921. Change the time format used to display dates less than 6 months from
  3922. now.
  3923. See strftime or date man page for the format specification. If this
  3924. option is absent, default timeformat is used.
  3925. .TP
  3926. .I timeformat_old
  3927. Change the time format used to display dates older than 6 months from
  3928. now or for dates in the future.
  3929. See strftime or date man page for the format specification. If this
  3930. option is absent, default timeformat is used.
  3931. .TP
  3932. .I torben_fj_mode
  3933. If this flag is set, then the home and end keys will work slightly
  3934. different on the panels, instead of moving the selection to the first
  3935. and last files in the panels, they will act as follows:
  3936. .IP
  3937. The home key will: Go up to the middle line, if below it; else go to the
  3938. top line unless it is already on the top line, in this case it will go
  3939. to the first file in the panel.
  3940. .IP
  3941. The end key has a similar behavior: Go down to the middle line, if over
  3942. it; else go to the bottom line unless you already are at the bottom
  3943. line, in such case it will move the selection to the last file name in
  3944. the panel.
  3945. .TP
  3946. .I use_file_to_guess_type
  3947. If this variable is on (the default) it will spawn the file command to
  3948. match the file types listed on the
  3949. .\"LINK2"
  3950. mc.ext file\&.
  3951. .\"Extension File Edit"
  3952. .TP
  3953. .I xtree_mode
  3954. If this variable is on (default is off) when you browse the file system
  3955. on a Tree panel, it will automatically reload the other panel with the
  3956. contents of the selected directory.
  3957. .TP
  3958. .I fish_directory_timeout
  3959. This variable holds the lifetime of a directory cache entry in seconds. The
  3960. default value is 900 seconds.
  3961. .TP
  3962. .I clipboard_store
  3963. This variable contains path (with options) to the external clipboard
  3964. utility like 'xclip' to read text into X selection from file.
  3965. For example:
  3966. .PP
  3967. .nf
  3968. clipboard_store=xclip \-i
  3969. .fi
  3970. .TP
  3971. .I clipboard_paste
  3972. This variable contains path (with options) to the external clipboard
  3973. utility like 'xclip' to print the selection to standard out.
  3974. For example:
  3975. .PP
  3976. .nf
  3977. clipboard_pastee=xclip \-o
  3978. .fi
  3979. .TP
  3980. .I autodetect_codeset
  3981. This option allows use the `enca' command to autodetect codeset of text files
  3982. in internal viewer and editor. List of valid values can be obtain by the
  3983. `enca \-\-list languages | cut \-d : \-f1' command. Option must be located
  3984. in the [Misc] section.
  3985. .PP
  3986. For example:
  3987. .PP
  3988. .nf
  3989. autodetect_codeset=russian
  3990. .fi
  3991. .\"NODE "Terminal databases"
  3992. .SH "Terminal databases"
  3993. The Midnight Commander provides a way to fix your system terminal
  3994. database without requiring root privileges. The Midnight Commander
  3995. searches in the system initialization file (the mc.lib file located in
  3996. the Midnight Commander library directory) and in the
  3997. ~/.config/mc/ini file for the section
  3998. "terminal:your\-terminal\-name" and then for the section
  3999. "terminal:general", each line of the section contains a key symbol that
  4000. you want to define, followed by an equal sign and the definition for the
  4001. key. You can use the special \\e form to represent the escape character
  4002. and the ^x to represent the control\-x character.
  4003. .PP
  4004. The possible key symbols are:
  4005. .PP
  4006. .nf
  4007. f0 to f20 Function keys f0\-f20
  4008. bs backspace
  4009. home home key
  4010. end end key
  4011. up up arrow key
  4012. down down arrow key
  4013. left left arrow key
  4014. right right arrow key
  4015. pgdn page down key
  4016. pgup page up key
  4017. insert the insert character
  4018. delete the delete character
  4019. complete to do completion
  4020. .fi
  4021. .PP
  4022. For example, to define the key insert to be the Escape + [ + O + p, you
  4023. set this in the ini file:
  4024. .PP
  4025. .nf
  4026. insert=\\e[Op
  4027. .fi
  4028. .PP
  4029. Also now you can use
  4030. .I extended learn keys.
  4031. For example:
  4032. .nf
  4033. ctrl\-alt\-right=\\e[[1;6C
  4034. ctrl\-alt\-left=\\e[[1;6D
  4035. .fi
  4036. .PP
  4037. This means that ctrl+alt+left sends a \\e[[1;6D escape sequence
  4038. and therefore Midnight Commander interprets "\\e[[1;6D" as Ctrl\-Alt\-Left.
  4039. .PP
  4040. The
  4041. .I complete
  4042. key symbol represents the escape sequences used to invoke the completion
  4043. process, this is invoked with Alt\-tab, but you can define other keys to do
  4044. the same work (on those keyboard with tons of nice and unused keys
  4045. everywhere).
  4046. .SH ""
  4047. .\"NODE "FILES"
  4048. .SH "FILES"
  4049. Full paths below may vary between installations. They are also affected
  4050. by the MC_DATADIR environment variable. If it's set, its value is used
  4051. instead of @prefix@/share/mc in the paths below.
  4052. .PP
  4053. .I @prefix@/share/mc/mc.hlp
  4054. .IP
  4055. The help file for the program.
  4056. .PP
  4057. .I @prefix@/share/mc/mc.ext
  4058. .IP
  4059. The default system\-wide extensions file.
  4060. .PP
  4061. .I ~/.local/share/mc/mc.ext
  4062. .IP
  4063. User's own extension, view configuration and edit configuration
  4064. file. They override the contents of the system wide files if present.
  4065. .PP
  4066. .I @prefix@/share/mc/mc.ini
  4067. .IP
  4068. The default system\-wide setup for the Midnight Commander, used only if
  4069. the user doesn't have his own ~/.config/mc/ini file.
  4070. .PP
  4071. .I @prefix@/share/mc/mc.lib
  4072. .IP
  4073. Global settings for the Midnight Commander. Settings in this file
  4074. affect all users, whether they have ~/.config/mc/ini or not. Currently, only
  4075. .\"LINK2"
  4076. terminal settings
  4077. .\"Terminal databases"
  4078. are loaded from mc.lib.
  4079. .PP
  4080. .I ~/.config/mc/ini
  4081. .IP
  4082. User's own setup. If this file is present then the setup is loaded
  4083. from here instead of the system\-wide startup file.
  4084. .PP
  4085. .I @prefix@/share/mc/mc.hint
  4086. .IP
  4087. This file contains the hints displayed by the program.
  4088. .PP
  4089. .I @prefix@/share/mc/mc.menu
  4090. .IP
  4091. This file contains the default system\-wide applications menu.
  4092. .PP
  4093. .I ~/.local/share/mc/menu
  4094. .IP
  4095. User's own application menu. If this file is present it is used instead
  4096. of the system\-wide applications menu.
  4097. .PP
  4098. .I ~/.cache/mc/Tree
  4099. .IP
  4100. The directory list for the directory tree and tree view features.
  4101. .PP
  4102. .I ~/.local/share/mc.menu
  4103. .IP
  4104. Local user\-defined menu. If this file is present, it is used instead of
  4105. the home or system\-wide applications menu.
  4106. .\"SKIP_SECTION"
  4107. .SH "LICENSE"
  4108. This program is distributed under the terms of the GNU General Public
  4109. License as published by the Free Software Foundation. See the built\-in
  4110. help for details on the License and the lack of warranty.
  4111. .\"NODE "AVAILABILITY"
  4112. .SH "AVAILABILITY"
  4113. The latest version of this program can be found at
  4114. ftp://ftp.gnu.org/gnu/mc/.
  4115. .\"NODE "SEE ALSO"
  4116. .SH "SEE ALSO"
  4117. ed(1), gpm(1), terminfo(1), view(1), sh(1), bash(1),
  4118. tcsh(1), zsh(1).
  4119. .PP
  4120. .nf
  4121. The Midnight Commander page on the World Wide Web:
  4122. http://www.midnight\-commander.org/
  4123. .fi
  4124. .\"NODE "AUTHORS"
  4125. .SH "AUTHORS"
  4126. Authors and contributors are listed in the AUTHORS file in the source
  4127. distribution.
  4128. .\"NODE "BUGS"
  4129. .SH "BUGS"
  4130. See the file TODO in the distribution for information on what remains to
  4131. be done.
  4132. .PP
  4133. If you want to report a problem with the program, please send mail to
  4134. this address: mc\-devel@gnome.org.
  4135. .PP
  4136. Provide a detailed description of the bug, the version of the program
  4137. you are running
  4138. .RI ( "mc \-V"
  4139. displays this information), the operating system you are running the
  4140. program on. If the program crashes, we would appreciate a stack trace.