mc.1.in 123 KB

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