Ticket #2830: subshell history not written on exit
[midnight-commander.git] / doc / man / mc.1.in
blob7274981f131787e4b9223e4c24ed6a86daee3485
1 .\"TOPICS "Topics:"
2 .TH MC 1 "%DATE_OF_MAN_PAGE%" "MC Version %DISTR_VERSION%" "GNU Midnight Commander"
3 .\"SKIP_SECTION"
4 .SH "NAME"
5 mc \- Visual shell for Unix\-like systems.
6 .\"SKIP_SECTION"
7 .SH "USAGE"
8 .B mc
9 [\-abcCdfhPstuUVx] [\-l log] [dir1 [dir2]] [\-e [file]] [\-v file]
10 .\"NODE "DESCRIPTION"
11 .SH "DESCRIPTION"
12 GNU Midnight Commander is a directory browser/file manager for
13 Unix\-like operating systems.
14 .\"NODE "OPTIONS"
15 .\"DONT_SPLIT"
16 .SH "OPTIONS"
17 .TP
18 .I \-a, \-\-stickchars
19 Disable usage of graphic characters for line drawing.
20 .TP
21 .I \-b, \-\-nocolor
22 Force black and white display.
23 .TP
24 .I \-c, \-\-color
25 Force color mode, please check the section
26 .\"LINK2"
27 Colors
28 .\"Colors"
29 for more information.
30 .TP
31 .I \-C arg, \-\-colors=arg
32 Specify a different color set in the command line.  The format of arg is
33 documented in the
34 .\"LINK2"
35 Colors
36 .\"Colors"
37 section.
38 .TP
39 .I \-S arg
40 Specify a name of skin in the command line. Technology of skins is
41 documented in the
42 .\"LINK2"
43 Skins\&.
44 .\"Skins"
45 section.
46 .TP
47 .I \-d, \-\-nomouse
48 Disable mouse support.
49 .TP
50 .I \-e [file], \-\-edit[=file]
51 Start the internal editor.  If the file is specified, open it on
52 startup.  See also
53 .BR "mcedit (1)" .
54 .TP
55 .I \-f, \-\-datadir
56 Display the compiled\-in search paths for Midnight Commander files.
57 .TP
58 .I \-F, \-\-datadir\-info
59 Display extended info about compiled\-in paths for
60 Midnight Commander.
61 .TP
62 .I \-\-configure\-options
63 Display configure options.
64 .TP
65 .I \-k, \-\-resetsoft
66 Reset softkeys to their default from the termcap/terminfo
67 database. Only useful on HP terminals when the function keys don't work.
68 .TP
69 .I \-K file
70 Specify a name of keymap file in the command line.
71 .TP
72 .I \-\-nokeymap
73 Don't load key bindings from any file, use default hardcoded keys.
74 .TP
75 .I \-l file, \-\-ftplog=file
76 Save the ftpfs dialog with the server in file.
77 .TP
78 .I \-P file, \-\-printwd=file
79 Print the last working directory to the specified file.  This option is
80 not meant to be used directly.  Instead, it's used from a special shell
81 script that automatically changes the current directory of the shell to
82 the last directory the Midnight Commander was in.  Source the file
83 .B %prefix%/share/mc/bin/mc.sh
84 (bash and zsh users) or
85 .B %prefix%/share/mc/bin/mc.csh
86 (tcsh users) respectively to define
87 .B mc
88 as an alias to the appropriate shell script.
89 .TP
90 .I \-s
91 Set alternative mode drawing of frameworks.
92 If the section [Lines] is not filled, the symbol for the pseudographics
93 frame is a space, otherwise the frame characters are taken from follow params.
95 .B You can redefine the following variables:
96 .TP
97 .B lefttop
98 left\-top corner
99 .TP
100 .B righttop
101 right\-top corner
103 .B centertop
104 center\-top cross
106 .B centerbottom
107 center\-bottom cross
109 .B leftbottom
110 left\-bottom corner
112 .B rightbottom
113 right\-bottom corner
115 .B leftmiddle
116 left\-middle cross
118 .B rightmiddle
119 right\-middle cross
121 .B centermiddle
122 center cross
124 .B horiz
125 default horizontal line
127 .B vert
128 default vertical line
130 .B thinhoriz
131 thin horizontal line
133 .B thinvert
134 thin vertical line
136 .I \-t, \-\-termcap
137 Used only if the code was compiled with Slang and terminfo: it makes
138 the Midnight Commander use the value of the
139 .B TERMCAP
140 variable for the terminal information instead of the information on
141 the system wide terminal database
143 .I \-u, \-\-nosubshell
144 Disable use of the concurrent shell (only makes sense if the Midnight
145 Commander has been built with concurrent shell support).
147 .I \-U, \-\-subshell
148 Enable use of the concurrent shell support (only makes sense if the
149 Midnight Commander was built with the subshell support set as an
150 optional feature).
152 .I \-v file, \-\-view=file
153 Start the internal viewer to view the specified file.  See also
154 .BR "mcview (1)" .
156 .I \-V, \-\-version
157 Display the version of the program.
159 .I \-x, \-\-xterm
160 Force xterm mode.  Used when running on xterm\-capable terminals (two
161 screen modes, and able to send mouse escape sequences).
163 .I \-X, \-\-no\-x11
164 Do not use X11 to get the state of modifiers Alt, Ctrl, Shift
166 .I \-g, \-\-oldmouse
167 Force a "normal tracking" mouse mode. Used when running on
168 xterm\-capable terminals (tmux/screen).
170 If specified, the first path name is the directory to show in the
171 selected panel; the second path name is the directory to be shown in
172 the other panel.
173 .\"NODE "Overview"
174 .SH "Overview"
175 The screen of the Midnight Commander is divided into four parts.
176 Almost all of the screen space is taken up by two directory panels.
177 By default, the second line from the bottom of the screen is the
178 shell command line, and the bottom line shows the function key labels.
179 The topmost line is the
180 .\"LINK2"
181 menu bar line\&.
182 .\"Menu Bar"
183 The menu bar line may not be visible, but appears if you click the
184 topmost line with the mouse or press the F9 key.
186 The Midnight Commander provides a view of two directories at the same
187 time. One of the panels is the current panel (a selection bar is in
188 the current panel). Almost all operations take place on the current
189 panel. Some file operations like Rename and Copy by default use the
190 directory of the unselected panel as a destination (don't worry, they
191 always ask you for confirmation first). For more information, see the
192 sections on the
193 .\"LINK2"
194 Directory Panels\&,
195 .\"Directory Panels"
197 .\"LINK2"
198 Left and Right Menus
199 .\"Left and Right Menus"
200 and the
201 .\"LINK2"
202 File Menu\&.
203 .\"File Menu"
205 You can execute system commands from the Midnight Commander by simply
206 typing them. Everything you type will appear on the shell command line,
207 and when you press Enter the Midnight Commander will execute the
208 command line you typed; read the
209 .\"LINK2"
210 Shell Command Line
211 .\"Shell Command Line"
213 .\"LINK2"
214 Input Line Keys
215 .\"Input Line Keys"
216 sections to learn more about the command line.
217 .\"NODE "Mouse Support"
218 .SH "Mouse Support"
219 The Midnight Commander comes with mouse support.  It is activated
220 whenever you are running on an
221 .B xterm(1)
222 terminal (it even works if you take a telnet, ssh or rlogin connection to
223 another machine from the xterm) or if you are running on a Linux
224 console and have the
225 .B gpm
226 mouse server running.
228 When you left click on a file in the directory panels, that file is
229 selected; if you click with the right button, the file is marked (or
230 unmarked, depending on the previous state).
232 Double\-clicking on a file will try to execute the command if it is
233 an executable program; and if the
234 .\"LINK2"
235 extension file
236 .\"Extension File Edit"
237 has a program specified for the file's extension, the specified
238 program is executed.
240 Also, it is possible to execute the commands assigned to the function
241 key labels by clicking on them.
243 The default auto repeat rate for the mouse buttons is 400
244 milliseconds. This may be changed to other values by editing the
245 .\"LINK2"
246 \&~/.config/mc/ini
247 .\"Save Setup"
248 file and changing the
249 .I mouse_repeat_rate
250 parameter.
252 If you are running the Midnight Commander with the mouse support, you
253 can get the default mouse behavior (cutting and pasting text) by holding
254 down the Shift key.
255 .SH ""
256 .\"NODE "Keys"
257 .SH "Keys"
258 Some commands in the Midnight Commander involve the use of the
259 .I Control
260 (sometimes labeled CTRL or CTL) and the
261 .I Meta
262 (sometimes labeled ALT or even Compose) keys. In this manual we will
263 use the following abbreviations:
265 .B C\-<chr>
266 means hold the Control key while typing the character <chr>.
267 Thus C\-f would be: hold the Control key and type f.
269 .B Alt\-<chr>
270 means hold the Meta or Alt key down while typing <chr>.
271 If there is no Meta or Alt key, type
272 .IR ESC ,
273 release it, then type the character <chr>.
275 .B S\-<chr>
276 means hold the Shift key down while typing <chr>.
278 All input lines in the Midnight Commander use an approximation to
279 the GNU Emacs editor's key bindings (default).
281 You may redefine key bindings. See
282 .\"LINK2"
283 .I redefine hotkey bindings
284 .\"Keys_redefine"
286 for more info. All other key bindings (described in this manual) relative
287 to default behavior.
290 There are many sections which tell about the keys. The following are
291 the most important.
294 .\"LINK2"
295 File Menu
296 .\"File Menu"
297 section documents the keyboard shortcuts for the commands appearing in
298 the File menu. This section includes the function keys. Most of these
299 commands perform some action, usually on the selected file or the
300 tagged files.
303 .\"LINK2"
304 Directory Panels
305 .\"Directory Panels"
306 section documents the keys which select a file or tag files as a
307 target for a later action (the action is usually one from the file
308 menu).
311 .\"LINK2"
312 Shell Command Line
313 .\"Shell Command Line"
314 section list the keys which are used for entering and editing command
315 lines. Most of these copy file names and such from the directory
316 panels to the command line (to avoid excessive typing) or access the
317 command line history.
319 .\"LINK2"
320 Input Line Keys
321 .\"Input Line Keys"
322 are used for editing input lines. This means both the command line and
323 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 A keymap\-file is searched on the following algorithm (to the first one found):
331 1) command line option
332 .B \-K \<keymap\>
334 .B \-\-keymap=\<keymap\>
336 2) Environment variable
337 .B MC_KEYMAP
339 3) Parameter
340 .B keymap
341 in section
342 .B [Midnight\-Commander]
343 of config file.
345 4) File
346 .B ~/.config/mc/mc.keymap
348 5) File
349 .B %sysconfdir%/mc/mc.keymap
351 6) File
352 .B %prefix%/share/mc/mc.keymap
354 Command line option, environment variable and parameter in config file may
355 contain the absolute path to the keymap\-file (with the extension \.keymap
356 or without it). Search of keymap\-file will occur in (to the first one found):
360 .B ~/.config/mc
363 .B %sysconfdir%/mc/
366 .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:
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.
387 .B C\-l
388 repaint all the information in the Midnight Commander.
390 .B C\-x c
391 run the
392 .\"LINK2"
393 Chmod
394 .\"Chmod"
395 command on a file or on the tagged files.
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.
404 .B C\-x l
405 run the hard link command.
407 .B C\-x s
408 run the absolute symbolic link command.
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.
417 .B C\-x i
418 set the other panel display mode to information.
420 .B C\-x q
421 set the other panel display mode to quick view.
423 .B C\-x !
424 execute the
425 .\"LINK2"
426 External panelize
427 .\"External panelize"
428 command.
430 .B C\-x h
431 run the
432 .\"LINK2"
433 add directory to hotlist
434 .\"Hotlist"
435 command.
437 .B Alt\-!
438 executes the Filtered view command, described in the
439 .\"LINK2"
440 view command\&.
441 .\"Internal File Viewer"
443 .B Alt\-?
444 executes the
445 .\"LINK2"
446 Find file
447 .\"Find File"
448 command.
450 .B Alt\-c
451 pops up the
452 .\"LINK2"
453 quick cd
454 .\"Quick cd"
455 dialog.
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.
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"
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.
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.
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.
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.
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.
506 .B C\-\\\\ (control\-backslash)
507 show the
508 .\"LINK2"
509 directory hotlist
510 .\"Hotlist"
511 and change to the selected directory.
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.
531 .I Case sensitive
532 is off, the case will be ignored.
534 .B \\\\ (backslash)
535 use the "\\" key to unselect a group of files. This is the opposite of
536 the Plus key.
538 .B up\-key, C\-p
539 move the selection bar to the previous entry in the panel.
541 .B down\-key, C\-n
542 move the selection bar to the next entry in the panel.
544 .B home, a1, Alt\-<
545 move the selection bar to the first entry in the panel.
547 .B end, c1, Alt\->
548 move the selection bar to the last entry in the panel.
550 .B next\-page, C\-v
551 move the selection bar one page down.
553 .B prev\-page, Alt\-v
554 move the selection bar one page up.
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.
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.
568 .B C\-PageUp, C\-PageDown
569 only when supported by the terminal: change to ".." and to the currently
570 selected directory respectively.
572 .B Alt\-y
573 moves to the previous directory in the history, equivalent to clicking
575 .I <
576 with the mouse.
578 .B Alt\-u
579 moves to the next directory in the history, equivalent to clicking the
580 .I >
581 with the mouse.
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
592 .I Alt\-s
593 to start a filename search in the directory listing.
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
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.
607 If quick search is started with double pressing of C\-s, the previous quick
608 search pattern will be used for current search.
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.
617 .B Alt\-Enter
618 copy the currently selected file name to the command line.
620 .B C\-Enter
621 same a Alt\-Enter.  May not work on remote systems and some terminals.
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.
627 .B Alt\-Tab
628 does the filename, command, variable, username and hostname
629 .\"LINK2"
630 completion
631 .\"Completion"
632 for you.
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.
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.
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)
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.
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.
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.
663 .B Up, C\-p
664 moves one line backward.
666 .B Down, C\-n
667 moves one line forward.
669 .B Prev Page, Page Up, Alt\-v
670 moves one page up.
672 .B Next Page, Page Down, C\-v
673 moves one page down.
675 .B Home, A1
676 moves to the beginning.
678 .B End, C1
679 move to the end.
681 The help viewer and the file viewer accept the following keys in
682 addition the to ones mentioned above:
684 .B b, C\-b, C\-h, Backspace, Delete
685 moves one page up.
687 .B Space bar
688 moves one page down.
690 .B u, d
691 moves one half of a page up or down.
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:
703 .B C\-a
704 puts the cursor at the beginning of line.
706 .B C\-e
707 puts the cursor at the end of the line.
709 .B C\-b, move\-left
710 move the cursor one position left.
712 .B C\-f, move\-right
713 move the cursor one position right.
715 .B Alt\-f
716 moves one word forward.
718 .B Alt\-b
719 moves one word backward.
721 .B C\-h, Backspace
722 delete the previous character.
724 .B C\-d, Delete
725 delete the character in the point (over the cursor).
727 .B C\-@
728 sets the mark for cutting.
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.
734 .B Alt\-w
735 copies the text between the cursor and the mark to a kill buffer.
737 .B C\-y
738 yanks back the contents of the kill buffer.
740 .B C\-k
741 kills the text from the cursor to the end of the line.
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.
747 .B Alt\-C\-h, Alt\-Backspace
748 delete one word backward.
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".
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.
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.
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.
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
794 .B Right
795 menus (they are named
796 .B Above
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
812 .BR User .
813 The full directory view shows the file name, the size of the file and
814 the modification time.
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.
822 If you choose the "User" display format, then you have to specify
823 the display format.
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.
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.
833 After this you add the name of the fields with an optional size
834 specifier.  This are the available fields you may display:
836 .B name
837 displays the file name.
839 .B size
840 displays the file size.
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.
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).
870 .B mark
871 an asterisk if the file is tagged, a space if it's not.
873 .B mtime
874 file's last modification time.
876 .B atime
877 file's last access time.
879 .B ctime
880 file's status change time.
882 .B perm
883 a string representing the current permission bits of the file.
885 .B mode
886 an octal value with the current permission bits of the file.
888 .B nlink
889 the number of links to the file.
891 .B ngid
892 the GID (numeric).
894 .B nuid
895 the UID (numeric).
897 .B owner
898 the owner of the file.
900 .B group
901 the group of the file.
903 .B inode
904 the inode of the file.
906 Also you can use following keywords to define the panel layout:
908 .B space
909 a space in the display format.
911 .B |
912 add a vertical line to the display format.
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.
923 For example, the
924 .B Full
925 display corresponds to this format:
927 half type name | size | mtime
929 And the
930 .B Long
931 display corresponds to this format:
933 full perm space nlink space owner space group space size space mtime
934 space name
936 This is a nice user display format:
938 half name | size:7 | type mode:3
940 Panels may also be set to the following modes:
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.
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.
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.
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).
997 The File menu has the following commands (keyboard shortcuts in parentheses):
999 .B Help (F1)
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.
1010 .B Menu (F2)
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.
1019 .B View (F3, F13)
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.
1038 .B Filtered View (Alt\-!)
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.
1045 .B Edit (F4, F14)
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.
1059 .B Copy (F5, F15)
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"
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.
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.
1086 .B Link (C\-x l)
1088 Create a hard link to the current file.
1090 .B Absolute symlink (C\-x s)
1092 Create a absolute symbolic link to the current file.
1094 .B Relative symLink (C\-x v)
1096 Create a relative symbolic link to the current file.
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.
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.
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.
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.
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:
1127 .I /home/frodo/mc/mc -> /home/frodo/new/mc
1129 A relative link describes the original file's location starting from the
1130 location of the link itself:
1132 .I /home/frodo/mc/mc -> ../new/mc
1134 You can force Midnight Commander to suggest a relative path by pressing
1135 "C\-x v" instead of "C\-x s".
1137 .B Rename/Move (F6, F16)
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.
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.
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.
1157 .B Mkdir (F7)
1159 Pop up an input dialog and creates the directory specified.
1161 .B Delete (F8)
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.
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.
1174 .B Select group (+)
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.
1193 .I Case sensitive
1194 is off, the case will be ignored.
1196 .B Unselect group (\\\\)
1198 Used to unselect a group of files. This is the opposite of the
1199 .I "Select group"
1200 command.
1202 .B Quit (F10, Shift\-F10)
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"
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"
1225 .\"LINK2"
1226 Directory tree
1227 .\"Directory Tree"
1228 command shows a tree figure of the directories.
1231 .\"LINK2"
1232 "Find file"
1233 .\"Find File"
1234 command allows you to search for a specific file.
1236 The "Swap panels" command swaps the contents of the two directory panels.
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.
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.
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.
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.
1262 .\"LINK2"
1263 "Directory hotlist"
1264 .\"Hotlist"
1265 command makes changing of the current directory to often used directories
1266 faster.
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.
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).
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.
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.
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).
1304 You can use the following keys:
1306 .\"LINK2"
1307 General movement keys
1308 .\"General Movement Keys"
1309 are accepted.
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.
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.
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.
1327 .B F4 (Static/Dynamic).
1328 Toggle between the dynamic navigation mode (default) and the static
1329 navigation mode.
1331 In the static navigation mode you can use the Up and Down keys to
1332 select a directory. All known directories are shown.
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.
1340 .B F5 (Copy).
1341 Copy the directory.
1343 .B F6 (RenMov).
1344 Move the directory.
1346 .B F7 (Mkdir).
1347 Make a new directory below this directory.
1349 .B F8 (Delete).
1350 Delete this directory from the file system.
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.
1356 .B C\-h, Backspace.
1357 Delete the last character of the search string.
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.
1365 The following actions are available only in the directory tree. They
1366 aren't supported in the tree view.
1368 .B F1 (Help).
1369 Invoke the help viewer and show this section.
1371 .B Esc, F10.
1372 Exit the directory tree. Do not change the directory.
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.
1389 Option \"Whole words\" allows select only those files containing matches that
1390 form whole words. Like grep \-w.
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.
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.
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:
1412 /cdrom:/nfs/wuarchive:/afs
1415 Relative paths are supported also. The following example shows how to skip special
1416 directories of version control systems:
1418 /cdrom:/nfs/wuarchive:/afs:.svn:.git:CVS
1421 Attention: input field can contain a dot (.), this means the current absolute path.
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.
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:
1440 find . \-type l \-print
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.
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:
1452 awk '$9 ~! /incoming/ { print $9 }' < /var/log/xferlog
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.
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:
1482 All lines starting with # or empty lines are thrown away.
1484 Lines starting in the first column should have following format:
1486 .IR keyword/expr ,
1487 i.e. everything after the slash until new line is
1488 .IR expr .
1490 .I keyword
1491 can be:
1493 .I shell
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 .
1504 .I regex
1506 .I expr
1507 is a regular expression.  File matches if its name matches the regular
1508 expression.
1510 .I directory
1512 .I expr
1513 is a regular expression.  File matches if it is a directory and its name
1514 matches the regular expression.
1516 .I type
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 .
1524 .I default
1525 \- matches any file.
1526 .I expr
1527 is ignored.
1529 .I include
1530 \- denotes a common section.
1531 .I expr
1532 is the name of the section.
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"
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.
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.
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"
1591 Here is a sample mc.menu file:
1594 A       Dump the currently selected file
1595         od \-c %f
1597 B       Edit a bug report and send it to root
1598         I=`mktemp ${MC_TMPDIR:\-/tmp}/mail.XXXXXX` || exit 1
1599         vi $I
1600         mail \-s "Midnight Commander bug" root < $I
1601         rm \-f $I
1603 M       Read mail
1604         emacs \-f rmail
1606 N       Read Usenet news
1607         emacs \-f gnus
1609 H       Call the info hypertext browser
1610         info
1612 J       Copy current directory to other panel recursively
1613         tar cf \- . | (cd %D && tar xvpf \-)
1615 K       Make a release of the current subdirectory
1616         echo \-n "Name of distribution file: "
1617         read tar
1618         ln \-s %d `dirname %d`/$tar
1619         cd ..
1620         tar cvhf ${tar}.tar $tar
1622 = f *.tar.gz | f *.tgz & t n
1623 X       Extract the contents of a compressed tar file
1624         tar xzvf %f
1627 .B Default Conditions
1629 Each menu entry may be preceded by a condition. The condition must
1630 start from the first column with a '=' character. If the condition is
1631 true, the menu entry will be the default entry.
1634 Condition syntax:       = <sub\-cond>
1635   or:                   = <sub\-cond> | <sub\-cond> ...
1636   or:                   = <sub\-cond> & <sub\-cond> ...
1638 Sub\-condition is one of following:
1640   y <pattern>           syntax of current file matching pattern?
1641                         (for edit menu only)
1642   f <pattern>           current file matching pattern?
1643   F <pattern>           other file matching pattern?
1644   d <pattern>           current directory matching pattern?
1645   D <pattern>           other directory matching pattern?
1646   t <type>              current file of type?
1647   T <type>              other file of type?
1648   x <filename>          is it executable filename?
1649   ! <sub\-cond>         negate the result of sub\-condition
1652 Pattern is a normal shell pattern or a regular expression, according
1653 to the shell patterns option. You can override the global value of
1654 the shell patterns option by writing "shell_patterns=x" on the first
1655 line of the menu file (where "x" is either 0 or 1).
1657 Type is one or more of the following characters:
1660   n     not a directory
1661   r     regular file
1662   d     directory
1663   l     link
1664   c     character device
1665   b     block device
1666   f     FIFO (pipe)
1667   s     socket
1668   x     executable file
1669   t     tagged
1672 For example 'rlf' means either regular file, link or fifo. The 't'
1673 type is a little special because it acts on the panel instead of the
1674 file. The condition '=t t' is true if there are tagged files in the
1675 current panel and false if not.
1677 If the condition starts with '=?' instead of '=' a debug trace will be
1678 shown whenever the value of the condition is calculated.
1680 The conditions are calculated from left to right. This means
1682         = f *.tar.gz | f *.tgz & t n
1684 is calculated as
1686         ( (f *.tar.gz) | (f *.tgz) ) & (t n)
1689 Here is a sample of the use of conditions:
1692 = f *.tar.gz | f *.tgz & t n
1693 L       List the contents of a compressed tar\-archive
1694         gzip \-cd %f | tar xvf \-
1697 .B Addition Conditions
1699 If the condition begins with '+' (or '+?') instead of '=' (or '=?') it
1700 is an addition condition. If the condition is true the menu entry will
1701 be included in the menu. If the condition is false the menu entry will
1702 not be included in the menu.
1704 You can combine default and addition conditions by starting condition
1705 with '+=' or '=+' (or '+=?' or '=+?' if you want debug trace). If you
1706 want to use two different conditions, one for adding and another for
1707 defaulting, you can precede a menu entry with two condition lines, one
1708 starting with '+' and another starting with '='.
1710 Comments are started with '#'. The additional comment lines must start
1711 with '#', space or tab.
1712 .\"NODE "  Options Menu"
1713 .SH "  Options Menu"
1714 The Midnight Commander has some options that may be toggled on and
1715 off in several dialogs which are accessible from this menu. Options
1716 are enabled if they have an asterisk or "x" in front of them.
1719 .\"LINK2"
1720 Configuration
1721 .\"Configuration"
1722 command pops up a dialog from which you can change most of settings of
1723 the Midnight Commander.
1726 .\"LINK2"
1727 Layout
1728 .\"Layout"
1729 command pops up a dialog from which you specify a bunch of options how mc
1730 looks like on the screen.
1733 .\"LINK2"
1734 Panel options
1735 .\"Panel options"
1736 command pops up a dialog from which you specify options of file manager panels.
1739 .\"LINK2"
1740 Confirmation
1741 .\"Confirmation"
1742 command pops up a dialog from which you specify which actions you want to
1743 confirm.
1746 .\"LINK2"
1747 Display bits
1748 .\"Display bits"
1749 command pops up a dialog from which you may select which characters is your
1750 terminal able to display.
1753 .\"LINK2"
1754 Learn keys
1755 .\"Learn keys"
1756 command pops up a dialog from which you test some keys which are not working
1757 on some terminals and you may fix them.
1760 .\"LINK2"
1761 Virtual FS
1762 .\"Virtual FS"
1763 command pops up a dialog from which you specify some VFS related options.
1766 .\"LINK2"
1767 Save setup
1768 .\"Save Setup"
1769 command saves the current settings of the Left, Right and Options
1770 menus. A small number of other settings is saved, too.
1771 .\"NODE "    Configuration"
1772 .SH "    Configuration"
1773 The options in this dialog are divided into several groups: "File
1774 operation options", "Esc key mode", "Pause after run" and "Other options".
1776 .B File operation options
1778 .I Verbose operation.
1779 This toggles whether the file Copy, Rename and Delete operations are
1780 verbose (i.e., display a dialog box for each operation). If you have a
1781 slow terminal, you may wish to disable the verbose operation. It is
1782 automatically turned off if the speed of your terminal is less than
1783 9600 bps.
1785 .I Compute totals.
1786 If this option is enabled, the Midnight Commander computes total byte
1787 sizes and total number of files prior to any Copy, Rename and Delete
1788 operations. This will provide you with a more accurate progress bar
1789 at the expense of some speed. This option has no effect, if
1790 .I Verbose  operation
1791 is disabled.
1793 .I Classic progressbar.
1794 If this option is enabled, the progressbar of Copy/Move/Delete operations
1795 is always grown form left to right. If disabled, the growing direction
1796 of progressbar follows to direction of Copy/Move/Delete operation:
1797 from left panel to right one and vice versa. Enabled by default.
1799 .I Mkdir autoname
1800 When you press F7 to create a new directory, the input line in popup dialog
1801 will be filled by name of current file or directory in active panel.
1802 Disabled by default.
1804 .I Preallocate space
1805 Preallocate space for whole target file, if possible, before copy operation.
1806 Disabled by default.
1808 .B Esc key mode.
1810 By default the Midnight Commander treats the ESC key as a key prefix.
1811 Therefore, you should press Esc code twice to exit a dialog. But there is
1812 a possibility to use a single press of ESC key for that action.
1814 .I Single press.
1815 By default this option is disabled. If you'll enable it, the ESC key
1816 will act as a prefix key for set up time interval (see
1817 .I Timeout
1818 option below), and if no extra keys have arrived, then the ESC key
1819 is interpreted as a cancel key (ESC ESC).
1821 .I Timeout.
1822 This options is used to setup the time interval (in microseconds)
1823 for single press of ESC key. By default, this inrerval is one second
1824 (1000000 microseconds). Also the timeout can be set via KEYBOARD_KEY_TIMEOUT_US
1825 environment variable (also in microseconds), which has higher priority
1826 than Timeout option value.
1828 .B Pause after run
1830 After executing your commands, the Midnight Commander can pause, so
1831 that you can examine the output of the command.  There are three
1832 possible settings for this variable:
1834 .IR Never .
1835 Means that you do not want to see the output of your command.  If you
1836 are using the Linux or FreeBSD console or an xterm, you will be able to
1837 see the output of the command by typing C\-o.
1839 .IR On dumb terminals .
1840 You will get the pause message on terminals that are not capable of
1841 showing the output of the last command executed (any terminal that is
1842 not an xterm or the Linux console).
1844 .IR Always .
1845 The program will pause after executing all of your commands.
1847 .B Other options
1849 .I Use internal editor.
1850 If this option is enabled, the built\-in file editor is used to edit
1851 files. If the option is disabled, the editor specified in the
1852 .B EDITOR
1853 environment variable is used.
1854 If no editor is specified,
1855 .B vi
1856 is used.  See the section on the
1857 .\"LINK2"
1858 internal file editor\&.
1859 .\"Internal File Editor"
1861 .I Use internal viewer.
1862 If this option is enabled, the built\-in file viewer is used to view
1863 files. If the option is disabled, the pager specified in the
1864 .B PAGER
1865 environment variable is used.
1866 If no pager is specified, the
1867 .B view
1868 command is used.  See the section on the
1869 .\"LINK2"
1870 internal file viewer\&.
1871 .\"Internal File Viewer"
1873 .I Auto menus.
1874 If this option is enabled, the user menu will be invoked at startup.
1875 Useful for building menus for non\-unixers.
1877 .I Drop down menus.
1878 When this option is enabled, the pull down menus will be activated as
1879 soon as you press the F9 key. Otherwise, you will only get the menu title,
1880 and you will have to activate the menu either with the arrow keys or with
1881 the hotkeys. It is recommended if you are using hotkeys.
1883 .I Shell Patterns.
1884 By default the Select, Unselect and Filter commands will use shell\-like
1885 regular expressions. The following conversions are performed to achieve
1886 this: the '*' is replaced by '.*' (zero or more characters); the '?'
1887 is replaced by '.' (exactly one character) and '.' by the literal
1888 dot. If the option is disabled, then the regular expressions are the
1889 ones described in ed(1).
1891 .I Complete: show all.
1892 By default the Midnight Commander pops up all possible
1893 .\"LINK2"
1894 completions
1895 .\"Completion"
1896 if the completion is ambiguous only when you press
1897 .B Alt\-Tab
1898 for the second time.  For the first time, it just completes as much as
1899 possible and beeps in the case of ambiguity.  Enable this option if you
1900 want to see all possible completions even after pressing
1901 .B Alt\-Tab
1902 the first time.
1904 .I Rotating dash.
1905 If this option is enabled, the
1906 Midnight Commander shows a rotating dash in the upper right corner
1907 as a work in progress indicator.
1909 .I Cd follows links.
1910 This option, if set, causes the Midnight Commander to follow the
1911 logical chain of directories when changing current directory
1912 either in the panels, or using the cd command. This is the default
1913 behavior of bash. When unset, the Midnight Commander follows the
1914 real directory structure, so cd .. if you've entered that directory
1915 through a link will move you to the current directory's real parent
1916 and not to the directory where the link was present.
1918 .I Safe delete.
1919 If this option is enabled, deleting files and directory hotlist entries
1920 unintentionally becomes more difficult.  The default selection in the
1921 confirmation dialogs for deletion changes from "Yes" to "No".
1922 This option is disabled by default.
1924 .I Auto save setup.
1925 If this option is enabled, when you exit the Midnight Commander the
1926 configurable options of the Midnight Commander are saved in the
1927 ~/.config/mc/ini file.
1928 .\"NODE "    Layout"
1929 .SH "    Layout"
1930 The layout dialog gives you a possibility to change the general layout
1931 of screen. The options in this dialog are divided into several groups:
1932 "Panel split", "Console output" and "Other options".
1934 .B Panel split
1936 The rest of the screen area is used for the two directory panels. You
1937 can specify whether the area is split to the panels in
1938 .I Vertical
1939  or
1940 .I Horizontal
1941 direction. Panel layout can be changed using Alt\-, (Alt\-comma) shortcut.
1943 .I Equal split.
1944 By default, panels have equal sizes. Using this option you can specify
1945 an unequal split.
1947 .B Console output
1949 On the Linux or FreeBSD console you can specify how many lines are shown
1950 in the output window. This option is available if Midnight Commander runs
1951 on native console only.
1953 .B Other options
1955 .I Menu bar visible.
1956 If enabled, main menu of Midnight Commander is always visible on the top row
1957 of screen above panels. Enabled by default.
1959 .I Command prompt.
1960 If enabled, command line is avalable. Enabled by default.
1962 .I Keybar visible.
1963 If enabled, 10 lables associated with F1\-F10 keys are located at the bottom
1964 row of screen. Enabled by default.
1966 .I Hintbar visible.
1967 If enabled, the one\-line hints are visible below panels. Enabled by default.
1969 .I XTerm window title.
1970 When run in a terminal emulator for X11, Midnight Commander sets the
1971 terminal window title to the current working directory and updates it
1972 when necessary.  If your terminal emulator is broken and you see some
1973 incorrect output on startup and directory change, turn off this option.
1974 Enabled by default.
1976 .I Show free space.
1977 If enabled, free space and total space of current file system is shown
1978 at the bottom frame of panel. Enabled by default.
1979 .\"NODE "    Panel options"
1980 .SH "    Panel options"
1981 .B Main panel options
1983 .I Show mini\-status.
1984 If enabled, one line of status information about the currently selected item
1985 is shown at the bottom of the panels. Enabled by default.
1987 .I Use SI size units.
1988 If this option is enabled, Midnight Commander will use SI units (powers of 1000)
1989 when displaying any byte sizes. The suffixes (k, m ...) are shown in lowercase.
1990 If disabled (default), Midnight Commander will use binary units (powers of 1024)
1991 and the suffixes are shown in upper case (K, M ...)
1993 .I Mix all files.
1994 If this option is enabled, all files and directories are shown mixed
1995 together.  If the option is desabled (default), directories (and links to
1996 directories) are shown at the beginning of the listing, and other files below.
1998 .I Show backup files.
1999 If enabled, the Midnight Commander will show files ending with a tilde.
2000 Otherwise, they won't be shown (like GNU's ls option \-B). Enabled by default.
2002 .I Show hidden files.
2003 If enabled, the Midnight Commander will show all files that start with
2004 a dot (like ls \-a). Disabled by default.
2006 .I Fast directory reload.
2007 If this option is enabled, the Midnight Commander will use a trick to
2008 determine if the directory contents have changed.  The trick is to reload
2009 the directory only if the i\-node of the directory has changed; this means
2010 that reloads only happen when files are created or deleted.  If what
2011 changes is the i\-node for a file in the directory (file size changes,
2012 mode or owner changes, etc) the display is not updated.  In these cases,
2013 if you have the option on, you have to rescan the directory manually
2014 (with C\-r). Disabled by default.
2016 .I Mark moves down.
2017 If enabled, the selection bar will move down when you mark a file (with
2018 Insert key). Enabled by default.
2020 .I Reverse files only.
2021 Allow revert selection of files only. Enabled by default.
2022 If enabled, the reverse selection is applied to files only, not to directories.
2023 The selection of directories is untouched. If off, the reverse selection
2024 is applied to files as well to directories: all unselected items become
2025 selected, and vice versa.
2027 .I Simple swap.
2028 If both panels contain file listing, simple swap means that panels exchange
2029 its screen positions: left panel become right one, and vice versa. If this
2030 option is unchecked, file listing panels exchange its content keeping listing
2031 format and sort options. Unchecked by default.
2033 .I Auto save panels setup.
2034 If this option is enabled, when you exit the Midnight Commander the
2035 current settings of panels are saved in the ~/.config/mc/panels.ini file.
2036 Disabled by default.
2038 .B Navigation
2040 .I Lynx\-like motion.
2041 If this option is enabled, you may use the arrows keys to automatically
2042 chdir if the current selection is a subdirectory and the shell command
2043 line is empty. By default, this setting is off.
2045 .I Page scrolling.
2046 If set (the default), panel will scroll by half the display when the
2047 cursor reaches the end or the beginning of the panel, otherwise it
2048 will just scroll a file at a time.
2050 .I Mouse page scrolling.
2051 Controls whenever scrolling with the mouse wheel is done by pages or
2052 line by line on the panels.
2054 .B File highlight
2056 You can specify whether
2057 .I permissions
2059 .I file types
2060 should be highlighted with distinctive
2061 .\"LINK2"
2062 Colors\&.
2063 .\"Colors"
2064 If the permission highlighting is enabled, the parts of the
2065 .I perm
2067 .I mode
2068 .\"LINK2"
2069 display fields
2070 .\"Listing Mode..."
2071 which apply to the user running Midnight Commander are highlighted with
2072 the color defined by the
2073 .I selected
2074 keyword.  If the file type highlighting is enabled, file names are colored
2075 according to rules described in
2076 %sysconfdir%/mc/filehighlight.ini
2077 file. See
2078 .\"LINK2"
2079 Filenames Highlight
2080 .\"Filenames Highlight"
2081 for more info.
2083 .B Quick search
2085 You can specify how the
2086 .\"LINK2"
2087 Quick search
2088 .\"Quick search"
2089 mode should works: case insensitively, case sensitively or be matched
2090 to the the panel sort order: case sensitive or not.
2091 .\"NODE "    Confirmation"
2092 .SH "    Confirmation"
2093 In this dialog you configure the confirmation options for file deletion,
2094 overwriting files, execution by pressing enter, quitting the program,
2095 directory hotlist entries deletion and history cleanup.
2096  and.
2097 .\"NODE "    Display bits"
2098 .SH "    Display bits"
2099 This is used to configure the range of visible characters on the
2100 screen.  This setting may be 7\-bits if your terminal/curses supports
2101 only seven output bits, ISO\-8859\-1 displays all the characters in the
2102 ISO\-8859\-1 map and full 8 bits is for those terminals that can display
2103 full 8 bit characters.
2104 .\"NODE "    Learn keys"
2105 .SH "    Learn keys"
2106 This dialog allows you to test and redefine functional keys, cursor
2107 arrows and some other keys to make them work properly on your terminal.
2108 They often don't, since many terminal databases are incomplete or broken.
2110 You can move around with the Tab key and with the vi moving keys ('h'
2111 left, 'j' down, 'k' up and 'l' right).  Once you press any cursor movement
2112 key and it is recognized, you can use that key as well.
2114 You can test keys just by pressing each of them.  When you press a
2115 key and it is recognized properly, OK should appear next to the name
2116 of that key.  Once a key is marked OK it starts working as usually,
2117 e.g. F1 pressed the first time will just check that the F1 key works,
2118 but after that it will show help.  The same applies to the arrow keys.
2119 The Tab key should be working always.
2121 If some keys do not work properly then you won't see OK appear after
2122 pressing one of these.  Then you may want to redefine it.  Do it by pressing
2123 the button with the name of that key (either by the mouse or by Enter
2124 or Space after selecting the button with Tab or arrows).  Then a message
2125 box will appear asking you to press that key.  Do it and wait until the
2126 message box disappears.  If you want to abort, just press Escape once
2127 and wait.
2129 When you finish with all the keys, you can Save them.  The definitions
2130 for the keys you have redefined will be written into the [terminal:TERM]
2131 section of your ~/.config/mc/ini file (where TERM is the name of your current
2132 terminal).  The definitions of the keys that were already working properly
2133 are not saved.
2134 .\"NODE "    Virtual FS"
2135 .SH "    Virtual FS"
2136 This option gives you control over the settings of the
2137 .\"LINK2"
2138 Virtual File System\&.
2139 .\"Virtual File System"
2141 The Midnight Commander keeps in memory the information related to some
2142 of the virtual file systems to speed up the access to the files in the
2143 file system (for example, directory listings fetched from FTP servers).
2145 Also, in order to access the contents of compressed files (for example,
2146 compressed tar files) the Midnight Commander needs to create temporary
2147 uncompressed files on your disk.
2149 Since both the information in memory and the temporary files on disk
2150 take up resources, you may want to tune the parameters of the cached
2151 information to decrease your resource usage or to maximize the speed of
2152 access to frequently used file systems.
2154 Because of the format of the tar archives, the
2155 .I Tar filesystem
2156 needs to read the whole file just to load the file entries.  Since most
2157 tar files are usually kept compressed (plain tar files are species in
2158 extinction), the tar file system has to uncompress the file on the disk
2159 in a temporary location and then access the uncompressed file as a
2160 regular tar file.
2162 Now, since we all love to browse files and tar files all over the disk,
2163 it's common that you will leave a tar file and then re\-enter it later.
2164 Since decompression is slow, the Midnight Commander will cache the
2165 information in memory for a limited time.  When the timeout expires, all
2166 the resources associated with the file system are released.  The default
2167 timeout is set to one minute.
2170 .\"LINK2"
2171 FTP File System
2172 .\"FTP File System"
2173 (ftpfs) allows you to browse directories on remote FTP servers.  It has
2174 several options.
2176 .I ftp anonymous password
2177 is the password used when you login as "anonymous".  Some sites require
2178 a valid e\-mail address.  On the other hand, you probably don't want to
2179 give your real e\-mail address to untrusted sites, especially if you are
2180 not using spam filtering.
2182 ftpfs keeps the directory listing it fetches from a FTP server in a cache.
2183 The cache expire time is configurable with the
2184 .I ftpfs directory cache timeout
2185 option.  A low value for this option may slow down every operation on
2186 the ftpfs because every operation would require sending a request to the
2187 FTP server.
2189 You can define an FTP proxy host for doing FTP.  Note that most modern
2190 firewalls are fully transparent at least for passive FTP (see below), so
2191 FTP proxies are considered obsolete.
2194 .I Always use ftp proxy
2195 is not set, you can use the exclamation sign to enable proxy for certain
2196 hosts.  See
2197 .\"LINK2"
2198 FTP File System
2199 .\"FTP File System"
2200 for examples.
2202 If this option is set, the program will do two things: consult the
2203 %prefix%/lib/mc/mc.no_proxy file for lines containing host names that
2204 are local (if the host name starts with a dot, it is assumed to be a
2205 domain) and to assume that any hostnames without dots in their names are
2206 directly accessible.  All other hosts will be accessed through the
2207 specified FTP proxy.
2209 You can enable using
2210 .I ~/.netrc
2211 file, which keeps login names and passwords for ftp servers.  See netrc
2212 (5) for the description of the .netrc format.
2214 .I Use passive mode
2215 enables using FTP passive mode, when the connection for data transfer is
2216 initiated by the client, not by the server.  This option is recommended
2217 and enabled by default.  If this option is turned off, the data
2218 connection is initiated by the server.  This may not work with some
2219 firewalls.
2220 .\"NODE "    Save Setup"
2221 .SH "    Save Setup"
2222 At startup the Midnight Commander will try to load initialization
2223 information from the ~/.config/mc/ini file. If this file
2224 doesn't exist, it will load the information from the system\-wide
2225 configuration file, located in %prefix%/share/mc/mc.ini. If the 
2226 system\-wide configuration file doesn't exist, MC uses the default settings.
2229 .I Save Setup
2230 command creates the ~/.config/mc/ini file by saving the
2231 current settings of the
2232 .\"LINK2"
2233 Left, Right
2234 .\"Left and Right Menus"
2236 .\"LINK2"
2237 Options
2238 .\"Options Menu"
2239 menus.
2241 If you activate the
2242 .I auto save setup
2243 option, MC will always save the current settings when exiting.
2245 There also exist settings which can't be changed from the menus. To
2246 change these settings you have to edit the setup file with your
2247 favorite editor. See the section on
2248 .\"LINK2"
2249 Special Settings
2250 .\"Special Settings"
2251 for more information.
2252 .SH ""
2253 .\"NODE "Executing operating system commands"
2254 .SH "Executing operating system commands"
2255 You may execute commands by typing them directly in the Midnight
2256 Commander's input line, or by selecting the program you want to
2257 execute with the selection bar in one of the panels and hitting Enter.
2259 If you press Enter over a file that is not executable, the Midnight
2260 Commander checks the extension of the selected file against the
2261 extensions in the
2262 .\"LINK2"
2263 Extensions File\&.
2264 .\"Extension File Edit"
2265 If a match is found then the code associated with that extension is
2266 executed. A very simple
2267 .\"LINK2"
2268 macro expansion
2269 .\"Macro Substitution"
2270 takes place before executing the command.
2271 .\"NODE "  The cd internal command"
2272 .SH "  The cd internal command"
2274 .I cd
2275 command is interpreted by the Midnight Commander, it is not passed to
2276 the command shell for execution.  Thus it may not handle all of the
2277 nice macro expansion and substitution that your shell does, although it
2278 does some of them:
2280 .I Tilde substitution.
2281 The (~) will be substituted with your home directory, if you append a
2282 username after the tilde, then it will be substituted with the login
2283 directory of the specified user.
2285 For example, ~guest is the home directory for the user guest, while
2286 ~/guest is the directory guest in your home directory.
2288 .I Previous directory.
2289 You can jump to the directory you were previously by using the special
2290 directory name '\-' like this:
2291 .B cd \-
2293 .I CDPATH directories.
2294 If the directory specified to the
2295 .B cd
2296 command is not in the current directory, then The Midnight Commander
2297 uses the value in the environment variable
2298 .B CDPATH
2299 to search for the directory in any of the named directories.
2301 For example you could set your
2302 .B CDPATH
2303 variable to ~/src:/usr/src, allowing you to change your directory to
2304 any of the directories inside the ~/src and /usr/src directories, from
2305 any place in the file system by using its relative name (for example
2306 cd linux could take you to /usr/src/linux).
2307 .\"NODE "  Macro Substitution"
2308 .SH "  Macro Substitution"
2309 When accessing a
2310 .\"LINK2"
2311 user menu\&,
2312 .\"Menu File Edit"
2313 or executing an
2314 .\"LINK2"
2315 extension dependent command\&,
2316 .\"Extension File Edit"
2317 or running a command from the command line input, a simple macro
2318 substitution takes place.
2320 The macros are:
2322 .I %i
2323 The indent of blank space, equal the cursor column position.  For edit
2324 menu only.
2326 .I %y
2327 The syntax type of current file. For edit menu only.
2329 .I %k
2330 The block file name.
2332 .I %e
2333 The error file name.
2335 .I %m
2336 The current menu name.
2338 .IR %f " and " %p
2339 The current file name.
2341 .I %x
2342 The extension of current file name.
2344 .I %b
2345 The current file name without extension.
2347 .I %d
2348 The current directory name.
2350 .I %F
2351 The current file in the unselected panel.
2353 .I %D
2354 The directory name of the unselected panel.
2356 .I %t
2357 The currently tagged files.
2359 .I %T
2360 The tagged files in the unselected panel.
2362 .IR %u " and " %U
2363 Similar to the %t and %T macros, but in addition the files are untagged.
2364 You can use this macro only once per menu file entry or extension file
2365 entry, because next time there will be no tagged files.
2367 .IR %s " and " %S
2368 The selected files: The tagged files if there are any. Otherwise the
2369 current file.
2371 .I %cd
2372 This is a special macro that is used to change the current directory
2373 to the directory specified in front of it.  This is used primarily as
2374 an interface to the
2375 .\"LINK2"
2376 Virtual File System\&.
2377 .\"Virtual File System"
2379 .I %view
2380 This macro is used to invoke the internal viewer.  This macro can be
2381 used alone, or with arguments.  If you pass any arguments to this
2382 macro, they should be enclosed in brackets.
2384 The arguments are:
2385 .I ascii
2386 to force the viewer into ascii mode;
2387 .I hex
2388 to force the viewer into hex mode;
2389 .I nroff
2390 to tell the viewer that it should interpret the bold and underline
2391 sequences of nroff;
2392 .I unformatted
2393 to tell the viewer to not interpret nroff commands for making the text
2394 bold or underlined.
2396 .I %%
2397 The % character
2399 .I %{some text}
2400 Prompt for the substitution. An input box is shown and the text inside
2401 the braces is used as a prompt. The macro is substituted by the text
2402 typed by the user. The user can press ESC or F10 to cancel. This macro
2403 doesn't work on the command line yet.
2405 .I %var{ENV:default}
2406 If environment variable
2407 .I ENV
2408 is unset, the
2409 .I default
2410 is substituted.  Otherwise, the value of
2411 .I ENV
2412 is substituted.
2413 .\"NODE "  The subshell support"
2414 .SH "  The subshell support"
2415 The subshell support is a compile time option, that works with the
2416 shells: bash, tcsh and zsh.
2418 When the subshell code is activated the Midnight Commander will
2419 spawn a concurrent copy of your shell (the one defined in the
2420 .B SHELL
2421 variable and if it is not defined, then the one in the /etc/passwd
2422 file) and run it in a pseudo terminal, instead of invoking a new shell
2423 each time you execute a command, the command will be passed to the
2424 subshell as if you had typed it.  This also allows you to change the
2425 environment variables, use shell functions and define aliases that are
2426 valid until you quit the Midnight Commander.
2428 If you are using
2429 .B bash
2430 you can specify startup
2431 commands for the subshell in your ~/.local/share/mc/bashrc file and
2432 special keyboard maps in the ~/.local/share/mc/inputrc file.
2433 .B tcsh
2434 users may specify startup commands in the ~/.local/share/mc/tcshrc file.
2436 When the subshell code is used, you can suspend applications at any
2437 time with the sequence C\-o and jump back to the Midnight Commander, if
2438 you interrupt an application, you will not be able to run other
2439 external commands until you quit the application you interrupted.
2441 An extra added feature of using the subshell is that the prompt
2442 displayed by the Midnight Commander is the same prompt that you are
2443 currently using in your shell.
2446 .\"LINK2"
2447 OPTIONS
2448 .\"OPTIONS"
2449 section has more information on how you can control the subshell code.
2450 .\"NODE "Chmod"
2451 .SH "Chmod"
2452 The Chmod window is used to change the attribute bits in a group of
2453 files and directories.  It can be invoked with the C\-x c key combination.
2455 The Chmod window has two parts \-
2456 .I Permissions
2458 .IR File .
2460 In the File section are displayed the name of the file or directory
2461 and its permissions in octal form, as well as its owner and group.
2463 In the Permissions section there is a set of check buttons which
2464 correspond to the file attribute bits.  As you change the attribute
2465 bits, you can see the octal value change in the File section.
2467 To move between the widgets (buttons and check buttons) use the
2468 .I arrow keys
2469 or the
2470 .I Tab
2471 key.  To change the state of the check buttons or to select a button
2473 .I Space.
2474 You can also use the hotkeys on the buttons to quickly activate them.
2475 Hotkeys are shown as highlighted letters on the buttons.
2477 To set the attribute bits, use the Enter key.
2479 When working with a group of files or directories, you just click on
2480 the bits you want to set or clear.  Once you have selected the bits
2481 you want to change, you select one of the action buttons (Set marked
2482 or Clear marked).
2484 Finally, to set the attributes exactly to those specified, you can use
2486 .B [Set all]
2487 button, which will act on all the tagged files.
2489 .B [Marked all]
2490 set only marked attributes to all selected files
2492 .B [Set marked]
2493 set marked bits in attributes of all selected files
2495 .B [Clean marked]
2496 clear marked bits in attributes of all selected files
2498 .B [Set]
2499 set the attributes of one file
2501 .B [Cancel]
2502 cancel the Chmod command
2503 .\"NODE "Chown"
2504 .SH "Chown"
2505 The Chown command is used to change the owner/group of a file. The hot
2506 key for this command is C\-x o.
2507 .\"NODE "Advanced Chown"
2508 .SH "Advanced Chown"
2509 The Advanced Chown command is the
2510 .\"LINK2"
2511 Chmod
2512 .\"Chmod"
2514 .\"LINK2"
2515 Chown
2516 .\"Chown"
2517 command combined into one window. You can change the permissions and
2518 owner/group of files at once.
2519 .\"NODE "File Operations"
2520 .SH "File Operations"
2521 When you copy, move or delete files the Midnight Commander shows the
2522 file operations dialog.  It shows the files currently being processed
2523 and uses up to three progress bars.  The file bar indicates the
2524 percentage of the current file that has been processed so far.  The
2525 count bar shows how many of the tagged files have been handled.  The
2526 bytes bar indicates the percentage of the total size of the tagged files
2527 that has been handled.  If the verbose option is off, the file and bytes
2528 bars are not shown.
2530 There are two buttons at the bottom of the dialog. Pressing the Skip
2531 button will skip the rest of the current file. Pressing the Abort
2532 button will abort the whole operation, the rest of the files are
2533 skipped.
2535 There are three other dialogs which you can run into during the file
2536 operations.
2538 The error dialog informs about error conditions and has three choices.
2539 Normally you select either the Skip button to skip the file or the Abort
2540 button to abort the operation altogether.  You can also select the Retry
2541 button if you fixed the problem from another terminal.
2543 The replace dialog is shown when you attempt to copy or move a file on
2544 the top of an existing file.  The dialog shows the dates and sizes of
2545 the both files.  Press the Yes button to overwrite the file, the No
2546 button to skip the file, the All button to overwrite all the files, the
2547 None button to never overwrite and the Update button to overwrite if the
2548 source file is newer than the target file.  You can abort the whole
2549 operation by pressing the Abort button.
2551 The recursive delete dialog is shown when you try to delete a directory
2552 which is not empty.  Press the Yes button to delete the directory
2553 recursively, the No button to skip the directory, the All button to
2554 delete all the directories and the None button to skip all the non\-empty
2555 directories.  You can abort the whole operation by pressing the Abort
2556 button.  If you selected the Yes or All button you will be asked for a
2557 confirmation.  Type "yes" only if you are really sure you want to do the
2558 recursive delete.
2560 If you have tagged files and perform an operation on them only the files
2561 on which the operation succeeded are untagged. Failed and skipped files
2562 are left tagged.
2563 .\"NODE "Mask Copy/Rename"
2564 .SH "Mask Copy/Rename"
2565 The copy/move operations let you translate the names of files in an
2566 easy way.  To do it, you have to specify the correct source mask and
2567 usually in the trailing part of the destination specify some wildcards.
2568 All the files matching the source mask are copied/renamed according to
2569 the target mask.  If there are tagged files, only the tagged files
2570 matching the source mask are renamed.
2572 There are other options which you can set:
2574 .B Follow links
2576 determines whether make the symlinks and hardlinks in the source
2577 directory (recursively in subdirectories) new links in the target
2578 directory or whether would you like to copy their content.
2580 .B Dive into subdirs
2582 determines the behavior when the source directory is about to be copied,
2583 but the target directory already exists.  The default action is to copy
2584 the contents of the source directory into the target directory.
2585 Enabling this option causes copying the source directory itself into the
2586 target directory.
2588 For example, you want to copy directory
2589 .I /foo
2590 containing file
2591 .I bar
2593 .IR /bla/foo ,
2594 which is an already existing directory.  Normally (when
2595 .B Dive into subdirs
2596 is not set), mc would copy file
2597 .I /foo/bar
2598 into the file
2599 .IR /bla/foo/bar .
2600 By enabling this option the
2601 .I /bla/foo/foo
2602 directory will be created, and
2603 .I /foo/bar
2604 will be copied into
2605 .IR /bla/foo/foo/bar .
2607 .B Preserve attributes
2609 determines whether to preserve the permissions, timestamps and (if you
2610 are root) the ownership of the original files.  If this option is not
2611 set, the current value of the umask will be respected.
2613 .B Use shell patterns
2615 When this option is on you can use the '*' and '?' wildcards in the source
2616 mask. They work like they do in the shell. In the target mask only the '*'
2617 and '\\<digit>' wildcards are allowed. The first '*' wildcard in the target
2618 mask corresponds to the first wildcard group in the source mask,
2619 the second '*' corresponds to the second group and so on.  The '\\1' wildcard
2620 corresponds to the first wildcard group in the source mask, the '\\2' wildcard
2621 corresponds to the second group and so on all the way up to '\\9'.
2622 The '\\0' wildcard is the whole filename of the source file.
2624 Two examples:
2626 If the source mask is "*.tar.gz", the destination is "/bla/*.tgz" and the
2627 file to be copied is "foo.tar.gz", the copy will be "foo.tgz" in "/bla".
2629 Suppose you want to swap basename and extension so that "file.c" would
2630 become "c.file" and so on.  The source mask for this is "*.*" and the
2631 destination is "\\2.\\1".
2633 .B Use shell patterns off
2635 When the shell patterns option is off the MC doesn't do automatic
2636 grouping anymore. You must use '\\(...\\)' expressions in the source
2637 mask to specify meaning for the wildcards in the target mask. This is
2638 more flexible but also requires more typing. Otherwise target masks
2639 are similar to the situation when the shell patterns option is on.
2641 Two examples:
2643 If the source mask is "^\\(.*\\)\\.tar\\.gz$", the destination is
2644 "/bla/*.tgz" and the file to be copied is "foo.tar.gz", the copy
2645 will be "/bla/foo.tgz".
2647 Let's suppose you want to swap basename and extension so that "file.c"
2648 will become "c.file" and so on. The source mask for this is
2649 "^\\(.*\\)\\.\\(.*\\)$" and the destination is "\\2.\\1".
2651 .B Case Conversions
2653 You can also change the case of the filenames.  If you use '\\u'
2654 or '\\l' in the target mask, the next character will be converted to
2655 uppercase or lowercase correspondingly.
2657 If you use '\\U' or '\\L' in the target mask, the next characters will
2658 be converted to uppercase or lowercase correspondingly up to the
2659 next '\\E' or next '\\U', '\\L' or the end of the file name.
2661 The '\\u' and '\\l' are stronger than '\\U' and '\\L'.
2663 For example, if the source mask is '*' (
2664 .I Use shell patterns
2665 on) or '^\\(.*\\)$' (
2666 .I Use shell patterns
2667 off) and the target mask is '\\L\\u*' the file names will be converted
2668 to have initial upper case and otherwise lower case.
2670 You can also use '\\' as a quote character. For example, '\\\\' is
2671 a backslash and '\\*' is an asterisk.
2673 .B Stable symlinks
2675 commands Midnight Commander, that it should change symlinks in the target,
2676 so that they'll point to the same location as it did before. With absolute
2677 symbolic links this does nothing, but if you have a relative one, it will
2678 recompute its value, adding necessary ../ and other directory parts and making
2679 the value as short as possible (most modern filesystems keep short symlinks
2680 inside inodes and thus don't waste much disk space).
2682 .\"NODE "Select/Unselect Files"
2683 .SH "Select/Unselect Files"
2684 The dialog of group of files and directories selection or uselection.
2686 .\"LINK2"
2687 input line
2688 .\"Input Line Keys"
2689 allow enter the regular expression of filenames that will be
2690 selected/unselected.
2692 When
2693 .I Files only
2694 checkbox is on, only files will be selected.  If
2695 .I Files only
2696 is off, as files as directories will be selected.
2697 When
2698 .I Shell Patterns
2699 checkbox is on, the regular expression is much like the filename globbing
2700 in the shell (* standing for zero or more characters and ?  standing
2701 for one character). If
2702 .I Shell Patterns
2703 is off, then the tagging of files is done with normal regular
2704 expressions (see ed (1)). When
2705 .I Case sensitive
2706 checkbox is on, the selection will be case sensitive characters.
2708 .I Case sensitive
2709 is off, the case will be ignored.
2710 .\"NODE "Diff Viewer"
2711 .SH "Internal Diff Viewer"
2712 The mcdiff is a visual diff tool. You can compare two files and edit them
2713 in\-place (diffs are updated dynamically). You can browse and view a working
2714 copy from popular version control systems (GIT, Subversion, etc).
2716 Following shortcuts are available in internal diff viewer of Midnight
2717 Commander.
2719 .B F1
2720 Invoke the built\-in hypertext help viewer.
2722 .B F2
2723 Save modified files.
2725 .B F4
2726 Edit file of the left panel in the internal editor.
2728 .B F14
2729 Edit file of the right panel in the internal editor.
2731 .B F5
2732 Merge the current hunk. Only the current hunk will be merged.
2734 .B F7
2735 Start search.
2737 .B F17
2738 Continue search.
2740 .B F10, Esc, q
2741 Exit from diff viewer.
2743 .B Alt\-s, s
2744 Toggle show of hunk status.
2746 .B Alt\-n, l
2747 Toggle show of line numbers.
2749 .B f
2750 Maximize left panel.
2752 .B \=
2753 Make panels equal in width.
2755 .B \>
2756 Reduce the size of the right panel.
2758 .B \<
2759 Reduce the size of the left panel.
2761 .B c
2762 Toggle show of trailing carriage return (CR) symbol as ^M.
2764 .B 2, 3, 4, 8
2765 Set tabulation size
2767 .B C\-u
2768 Swap contents of diff panels.
2770 .B C\-r
2771 Refresh the screen.
2773 .B C\-o
2774 Switch to the subshell and show the command screen.
2776 .B Enter, Space, n
2777 Find next diff hunk.
2779 .B Backspace, p
2780 Find previous diff hunk.
2782 .B g
2783 Go to line.
2785 .B Down
2786 Scroll one line forward.
2788 .B Up
2789 Scroll one line backward.
2791 .B PageUp
2792 Move one page up.
2794 .B PageDown
2795 Mves one page down.
2797 .B Home, A1
2798 Moves to the line beginning.
2800 .B End
2801 Moves to the line end.
2803 .B C\-Home
2804 Move to the file beginning.
2806 .B C\-End, C1
2807 Move to the file end.
2808 .\"NODE "Internal File Viewer"
2809 .SH "Internal File Viewer"
2810 The internal file viewer provides two display modes: ASCII and hex.
2811 To toggle between modes, use the F4 key.
2813 The viewer will try to use the best method provided by your system or
2814 the file type to display the information.
2815 Some character sequences, which appear most often in preformatted manual
2816 pages, are displayed bold and underlined, thus making a pretty display
2817 of your files.
2819 When in hex mode, the search function accepts text in quotes and
2820 constant numbers.  Text in quotes is matched exactly after removing
2821 the quotes.  Each number matches one byte.  You can mix quoted text
2822 with constants like this:
2825 "String" \-1 0xBB 012 "more text"
2828 Note that 012 is an octal number.  \-1 is converted to 0xFF.
2830 Here is a listing of the actions associated with each key that the
2831 Midnight Commander handles in the internal file viewer.
2833 .B F1
2834 Invoke the built\-in hypertext help viewer.
2836 .B F2
2837 Toggle the wrap mode.
2839 .B F4
2840 Toggle the hex mode.
2842 .B F5
2843 Goto line.  This will prompt you for a line number and will display
2844 that line.
2846 .B F6, /.
2847 Regular expression search.
2849 .B ?,
2850 Reverse regular expression search.
2852 .B F7
2853 Normal search / hex mode search.
2855 .B C\-s, F17, n.
2856 Start normal search if there was no previous search expression else
2857 find next match.
2859 .B C\-r.
2860 Start reverse search if there was no previous search expression else
2861 find next match.
2863 .B F8
2864 Toggle Raw/Parsed mode: This will show the file as found on disk or if
2865 a processing filter has been specified in the mc.ext file, then the
2866 output from the filter. Current mode is always the other than written
2867 on the button label, since on the button is the mode which you enter
2868 by that key.
2870 .B F9
2871 Toggle the format/unformat mode: when format mode is on the viewer
2872 will interpret some string sequences to show bold and underline with
2873 different colors. Also, on button label is the other mode than current.
2875 .B F10, Esc.
2876 Exit the internal file viewer.
2878 .B next\-page, space, C\-v.
2879 Scroll one page forward.
2881 .B prev\-page, Alt\-v, C\-b, Backspace.
2882 Scroll one page backward.
2884 .B down\-key
2885 Scroll one line forward.
2887 .B up\-key
2888 Scroll one line backward.
2890 .B C\-l
2891 Refresh the screen.
2893 .B C\-o
2894 Switch to the subshell and show the command screen.
2896 .B "[n] m"
2897 Set the mark n.
2899 .B "[n] r"
2900 Jump to the mark n.
2902 .B C\-f
2903 Jump to the next file.
2905 .B C\-b
2906 Jump to the previous file.
2908 .B Alt\-r
2909 Toggle the ruler.
2911 .B Alt\-e
2912 to change charset of displayed text may use M\-e (Alt\-e).
2913 Recoding is made from selected codepage into system codepage. To
2914 cancel the recoding you may select "<No translation>" in charset
2915 selection dialog.
2917 It's possible to instruct the file viewer how to display a file, look
2918 at the
2919 .\"LINK2"
2920 Extension File Edit section
2921 .\"Extension File Edit"
2923 .\"NODE "Internal File Editor"
2924 .SH "Internal File Editor"
2925 The internal file editor is a full\-featured full screen editor.  It can
2926 edit files up to 64 megabytes.  It is possible to edit binary files.
2927 The internal file editor is invoked using
2928 .B F4
2929 if the
2930 .I use_internal_edit
2931 option is set in the initialization file.
2933 The features it presently supports are: block copy, move, delete, cut,
2934 paste; key for key undo; pull\-down menus; file insertion; macro
2935 commands; regular expression search and replace; shift\-arrow text highlighting
2936 (if supported by the terminal); insert\-overwrite toggle; word wrap;
2937 autoindent; tunable tab size; syntax highlighting for various file
2938 types; and an option to pipe text blocks through shell commands like
2939 indent and ispell.
2941 Sections:
2943 .\"LINK2"
2944 Options of editor in ini\-file
2945 .\"Internal File Editor / options"
2947 The editor is very easy to use and requires no tutoring. To see what
2948 keys do what, just consult the appropriate pull\-down menu. Other keys
2949 are: Shift movement keys do text highlighting.
2950 .B Ctrl\-Ins
2951 copies to the file
2952 .B mcedit.clip
2954 .B Shift\-Ins
2955 pastes from mcedit.clip.
2956 .B Shift\-Del
2957 cuts to
2958 .BR mcedit.clip ,
2960 .B Ctrl\-Del
2961 deletes highlighted text. Mouse highlighting also works, and you
2962 can override the mouse as usual by holding down the shift key
2963 while dragging the mouse to let normal terminal mouse highlighting
2964 work.
2966 To define a macro, press
2967 .B Ctrl\-R
2968 and then type out the key
2969 strokes you want to be executed. Press
2970 .B Ctrl\-R
2971 again when finished. You can then assign the macro to any key you
2972 like by pressing that key. The macro is executed when you press
2973 .B Ctrl\-A
2974 and then the assigned key. The macro is also executed if
2975 you press Meta, Ctrl, or Esc and the assigned key, provided that the
2976 key is not used for any other function. Once defined, the macro
2977 commands go into the file
2978 .B ~/.local/share/mc/mcedit/mcedit.macros
2979 You can delete a macro by deleting the
2980 appropriate line in this file.
2982 To change charset of displayed text may use M\-e (Alt\-e).
2983 Recoding is made from selected codepage into system codepage. To
2984 cancel the recoding you may select "<No translation>" in charset
2985 selection dialog.
2987 .B F19
2988 will format the currently highlighted block (plain text or
2989 .B C
2991 .B C++
2992 code or another). This is controlled by the
2993 file
2994 .B %prefix%/share/mc/edit.indent.rc
2995 which is copied to
2996 .B ~/.local/share/mc/mcedit/edit.indent.rc
2997 in your home directory the first time you use it.
2999 The editor also displays non\-us characters (160+). When editing
3000 binary files, you should set
3001 .B display bits
3002 to 7 bits in the options menu to keep the spacing clean.
3004 .\"NODE "Internal File Editor / options"
3005 .SH "Options of editor in ini\-file"
3007 Some editor options of ini\-file are described in this section.
3008 Options are placed in [Midnight\-Commander] section
3010 .I editor_wordcompletion_collect_entire_file
3011 Search autocomplete candidates in entire of file or just from
3012 begin of file to cursor position (0)
3014 .\"NODE "Screen selector"
3015 .SH "Screen selector"
3016 Midnight Commander supports running many internal modules (such as
3017 editor, viewer and diff viewer) simultaneously and switching between
3018 them without closing open files. Using several file managers at a time,
3019 however, is not currently supported.
3021 Let's call each of these modules a screen. There are three ways to
3022 switch between screens, using one of these global shortcuts:
3024 .B Alt\-}
3025 switch to the next screen;
3027 .B Alt\-{
3028 switch to the previous screen;
3030 .B Alt\-`
3031 open a dialog window with the list of currently open screens (or use the
3032 "Screen list" menu item).
3033 .\"NODE "Completion"
3034 .SH "Completion"
3035 Let the Midnight Commander type for you.
3037 Attempt to perform completion on the text before current position.  MC
3038 attempts completion treating the text as variable (if the text begins
3039 with
3040 .BR $ ),
3041 username (if the text begins with
3042 .BR ~ ),
3043 hostname (if the text begins with
3044 .BR @ )
3045 or command (if you are on the command line in the position where you
3046 might type a command, possible completions then include shell reserved
3047 words and shell built\-in commands as well) in turn.  If none of these
3048 matches, filename completion is attempted.
3050 Filename, username, variable and hostname completion works on all input
3051 lines, command completion is command line specific.  If the completion
3052 is ambiguous (there are more different possibilities), MC beeps and the
3053 following action depends on the setting of the
3054 .I Complete: show all
3055 option in the
3056 .\"LINK2"
3057 Configuration
3058 .\"Configuration"
3059 dialog.  If it is enabled, a list of all possibilities pops up next to
3060 the current position and you can select with the arrow keys and
3061 .B Enter
3062 the correct entry.  You can also type the first letters in which the
3063 possibilities differ to move to a subset of all possibilities and
3064 complete as much as possible.  If you press
3065 .B Alt\-Tab
3066 again, only the subset will be shown in the listbox, otherwise the first
3067 item which matches all the previous characters will be highlighted.  As
3068 soon as there is no ambiguity, dialog disappears, but you can hide it by
3069 canceling keys
3070 .BR Esc ,
3071 .B F10
3072 and left and right arrow keys. If
3073 .\"LINK2"
3074 Complete: show all
3075 .\"Configuration"
3076 is disabled, the dialog pops up only if you press
3077 .B Alt\-Tab
3078 for the second time, for the first time MC just beeps.
3079 .\"NODE "Virtual File System"
3080 .SH "Virtual File System"
3081 The Midnight Commander is provided with a code layer to access the file
3082 system; this code layer is known as the virtual file system switch.  The
3083 virtual file system switch allows the Midnight Commander to manipulate
3084 files not located on the Unix file system.
3086 Currently the Midnight Commander is packaged with some Virtual File
3087 Systems (VFS): the
3088 .I local
3089 file system, used for accessing the regular Unix file system; the
3090 .IR ftpfs ,
3091 used to manipulate files on remote systems with the FTP protocol; the
3092 .IR tarfs ,
3093 used to manipulate tar and compressed tar files; the
3094 .IR undelfs ,
3095 used to recover deleted files on ext2 file systems (the default file
3096 system for Linux systems),
3097 .I fish
3098 (for manipulating files over shell connections such as rsh and ssh).
3099 If the code was compiled with
3100 .I smbfs
3101 support, you can manipulate files on remote systems with the SMB (CIFS)
3102 protocol.
3104 A generic
3105 .I extfs
3106 (EXTernal virtual File System) is provided in order to easily expand
3107 VFS capabilities using scripts and external software.
3109 The VFS switch code will interpret all of the path names used and will
3110 forward them to the correct file system, the formats used for each one
3111 of the file systems is described later in their own section.
3112 .\"NODE "  FTP File System"
3113 .SH "  FTP File System"
3114 The FTP File System (ftpfs) allows you to manipulate files on remote
3115 machines.  To actually use it, you can use the
3116 .I FTP link
3117 item in the menu or directly change your current directory using the
3118 .I cd
3119 command to a path name that looks like this:
3121 .I ftp://[!][user[:pass]@]machine[:port][remote\-dir]
3124 .IR user ,
3125 .I port
3127 .I remote\-dir
3128 elements are optional.  If you specify the
3129 .I user
3130 element, the Midnight Commander will login to the remote machine as that
3131 user, otherwise it will use anonymous login or the login name from the
3132 .I ~/.netrc
3133 file.  The optional
3134 .I pass
3135 element is the password used for the connection.  Using the password in
3136 the VFS directory name is not recommended, because it can appear on the
3137 screen in clear text and can be saved to the directory history.
3139 To enable using FTP proxy, prepend
3140 .B !
3141 (an exclamation sign) to the hostname.
3143 Examples:
3146     ftp://ftp.nuclecu.unam.mx/linux/local
3147     ftp://tsx\-11.mit.edu/pub/linux/packages
3148     ftp://!behind.firewall.edu/pub
3149     ftp://guest@remote\-host.com:40/pub
3150     ftp://miguel:xxx@server/pub
3153 Please check the
3154 .\"LINK2"
3155 Virtual File System
3156 .\"Virtual FS"
3157 dialog box for ftpfs options.
3158 .\"NODE "  Tar File System"
3159 .SH "  Tar File System"
3160 The tar file system provides you with read\-only access to your tar
3161 files and compressed tar files by using the chdir command.  To change
3162 your directory to a tar file, you change your current directory to the
3163 tar file by using the following syntax:
3165 .I /filename.tar/utar://[dir\-inside\-tar]
3167 The mc.ext file already provides a shortcut for tar files, this means
3168 that usually you just point to a tar file and press return to enter
3169 into the tar file, see the
3170 .\"LINK2"
3171 Extension File Edit
3172 .\"Extension File Edit"
3173 section for details on how this is done.
3175 Examples:
3178     mc\-3.0.tar.gz/utar://mc\-3.0/vfs
3179     /ftp/GCC/gcc\-2.7.0.tar/utar://
3182 The latter specifies the full path of the tar archive.
3183 .\"NODE "  FIle transfer over SHell filesystem"
3184 .SH "  FIle transfer over SHell filesystem"
3185 The fish file system is a network based file system that allows you to
3186 manipulate the files in a remote machine as if they were local. To use
3187 this, the other side has to either run fish server, or has to have
3188 bash\-compatible shell.
3190 To connect to a remote machine, you just need to chdir
3191 into a special directory which name is in the following
3192 format:
3194 .I sh://[user@]machine[:options]/[remote\-dir]
3197 .I user,
3198 .I options
3200 .I remote\-dir
3201 elements are optional.  If you specify the
3202 .I user
3203 element, the Midnight Commander will try to login on the remote
3204 machine as that user, otherwise it will use your login name.
3206 The available
3207 .I options
3208 are:
3210   'C' \- use compression;
3211   'r' \- use rsh instead of ssh;
3212   port \- specify the port used by remote server.
3214 If the
3215 .I remote\-dir
3216 element is present, your current directory on the remote machine will be
3217 set to this one.
3219 Examples:
3222     sh://onlyrsh.mx:r/linux/local
3223     sh://joe@want.compression.edu:C/private
3224     sh://joe@noncompressed.ssh.edu/private
3225     sh://joe@somehost.ssh.edu:2222/private
3227 .\"NODE "  Undelete File System"
3228 .SH "  Undelete File System"
3229 On Linux systems, if you asked configure to use the ext2fs undelete
3230 facilities, you will have the undelete file system available.
3231 Recovery of deleted files is only available on ext2 file systems.  The
3232 undelete file system is just an interface to the ext2fs library to
3233 retrieve all of the deleted files names on an ext2fs and provides and
3234 to extract the selected files into a regular partition.
3236 To use this file system, you have to chdir into the special file name
3237 formed by the "undel://" prefix and the file name where the actual
3238 file system resides.
3240 For example, to recover deleted files on the second partition of the
3241 first SCSI disk on Linux, you would use the following path name:
3244     undel://sda2
3247 It may take a while for the undelfs to load the required information
3248 before you start browsing files there.
3249 .\"NODE "  SMB File System"
3250 .SH "  SMB File System"
3251 The smbfs allows you to manipulate files on remote machines with SMB
3252 (or CIFS) protocol.  These include Windows for Workgroups,
3253 Windows 9x/ME/XP, Windows NT, Windows 2000 and Samba.
3254 To actually use it, you may try to use the panel command "SMB link..."
3255 (accessible from the menubar) or you may directly change your current
3256 directory to it using the cd command to a path name that looks like this:
3258 .I smb://[user@]machine[/service][/remote\-dir]
3261 .IR user ,
3262 .I service
3264 .I remote\-dir
3265 elements are optional.
3267 .IR user ,
3268 .I domain
3270 .I password
3271 can be specified in an input dialog.
3273 Examples:
3276     smb://machine/Share
3277     smb://other_machine
3278     smb://guest@machine/Public/Irlex
3280 .\"NODE "  EXTernal File System"
3281 .SH "  EXTernal File System"
3282 .B extfs
3283 allows you to integrate numerous features and file types into GNU Midnight
3284 Commander in an easy way, by writing scripts.
3286 Extfs filesystems can be divided into two categories:
3288 1. Stand\-alone filesystems, which are not associated with any existing
3289 file.  They represent certain system\-wide data as a directory tree.
3290 You can invoke them by typing
3291 .RI ' "cd fsname://" '
3292 where fsname is an extfs short name (see below).  Examples of such
3293 filesystems include audio (list audio tracks on the CD) or apt (list of
3294 all Debian packages in the system).
3296 For example, to list CD\-Audio tracks on your CD\-ROM drive, type
3299   cd audio://
3302 2. 'Archive' filesystems (like rpm, patchfs and more), which represent
3303 contents of a file as a directory tree.  It can consist of 'real' files
3304 compressed in an archive (urar, rpm) or virtual files, like messages
3305 in a mailbox (mailfs) or parts of a patch (patchfs).  To access such
3306 filesystems
3307 .RI ' fsname:// '
3308 should be appended to the archive name.  Note that the archive itself
3309 can be on another vfs.
3311 For example, to list contents of a zip archive documents.zip type
3314   cd documents.zip/uzip://
3317 In many aspects, you could treat extfs like any other directory.  For
3318 instance, you can add it to the hotlist or change to it from directory
3319 history.  An important limitation is that you cannot invoke shell
3320 commands inside extfs, just like any other non\-local VFS.
3322 Common extfs scripts included with Midnight Commander are:
3324 .B a
3325 access 'A:' DOS/Windows diskette
3326 .RI ( "cd a://" ).
3328 .B apt
3329 front end to Debian's APT package management system
3330 .RI ( "cd apt://" ).
3332 .B audio
3333 audio CD ripping and playing
3334 .RI ( "cd audio://"
3336 .IR "cd device/audio://" ).
3338 .B bpp
3339 package of Bad Penguin GNU/Linux distribution
3340 .RI ( "cd file.bpp/bpp://" ).
3342 .B deb
3343 package of Debian GNU/Linux distribution
3344 .RI ( "cd file.deb/deb://" ).
3346 .B dpkg
3347 Debian GNU/Linux installed packages
3348 .RI ( "cd deb://" ).
3350 .B hp48
3351 view and copy files to/from a HP48 calculator
3352 .RI ( "cd hp48://" ).
3354 .B lslR
3355 browsing of lslR listings as found on many FTPs
3356 .RI ( "cd filename/lslR://" ).
3358 .B mailfs
3359 mbox\-style mailbox files support
3360 .RI ( "cd mailbox/mailfs://" ).
3362 .B patchfs
3363 extfs to handle unified and context diffs
3364 .RI ( "cd filename/patchfs://" ).
3366 .B rpm
3367 RPM package
3368 .RI ( "cd filename/rpm://" ).
3370 .B rpms
3371 RPM database management
3372 .RI ( "cd rpms://" ).
3374 .B ulha, urar, uzip, uzoo, uar, uha
3375 archivers
3376 .RI ( "cd archive/xxxx://"
3377 where xxxx is one of:
3378 .IR ulha ,
3379 .IR urar ,
3380 .IR uzip ,
3381 .IR uzoo ,
3382 .IR uar ,
3383 .IR uha ).
3385 You could bind file type/extension to specified extfs as described in the
3386 .\"LINK2"
3387 Extension File Edit
3388 .\"Extension File Edit"
3389 section.  Here is an example entry for Debian packages:
3392   regex/\.deb$
3393           Open=%cd %p/deb://
3395 .\"NODE "Colors"
3396 .SH "Colors"
3397 The Midnight Commander will try to detect if your terminal supports
3398 color using the terminal database and your terminal name.  Sometimes
3399 it gets confused, so you may force color mode or disable color mode
3400 using the \-c and \-b flag respectively.
3402 If the program is compiled with the Slang screen manager instead of
3403 ncurses, it will also check the variable
3404 .B COLORTERM,
3405 if it is set, it has the same effect as the \-c flag.
3407 You may specify terminals that always force color mode
3408 by adding the
3409 .I color_terminals
3410 variable to the Colors section of the initialization file.  This will
3411 prevent the Midnight Commander from trying to detect if your terminal
3412 supports color.  Example:
3415 [Colors]
3416 color_terminals=linux,xterm
3417 color_terminals=terminal\-name1,terminal\-name2...
3420 The program can be compiled with both ncurses and slang, ncurses does
3421 not provide a way to force color mode: ncurses uses just the
3422 information in the terminal database.
3424 The Midnight Commander provides a way to change the default colors.
3425 Currently the colors are configured using the environment variable
3426 .B MC_COLOR_TABLE
3427 or the Colors section in the initialization file.
3429 In the Colors section, the default color map is loaded from the
3430 .I base_color
3431 variable.  You can specify an alternate color map for a terminal by
3432 using the terminal name as the key in this section.  Example:
3435 [Colors]
3436 base_color=
3437 xterm=menu=magenta:marked=,magenta:markselect=,red
3440 The format for the color definition is:
3443   <keyword>=<fgcolor>,<bgcolor>,<attributes>:<keyword>=...
3446 The colors are optional, and the keywords are: normal, selected, disabled, marked,
3447 markselect, errors, input, inputmark, inputunchanged, commandlinemark,
3448 reverse, gauge, header, inputhistory, commandhistory. Button bar colors are:
3449 bbarhotkey, bbarbutton. Status bar color: statusbar. Menu colors are: menunormal,
3450 menusel, menuhot, menuhotsel, menuinactive. Dialog colors are: dnormal, dfocus,
3451 dhotnormal, dhotfocus, dtitle. Error dialog colors are: errdfocus, errdhotnormal,
3452 errdhotfocus, errdtitle.  Help colors are: helpnormal, helpitalic, helpbold,
3453 helplink, helpslink, helptitle.  Viewer color are: viewbold, viewunderline, viewselected.
3454 Editor colors are: editnormal, editbold, editmarked, editwhitespace, editlinestate.
3455 Popup menu colors are: pmenunormal, pmenusel, pmenutitle.
3457 .I header
3458 determines the color of panel header, the line that contains column titles
3459 and sort mode indicator.
3461 .I input
3462 determines the color of input lines used in query dialogs.
3464 .I gauge
3465 determines the color of the filled part of the progress bar (gauge),
3466 which is used to show the user the progress of file operations, such as
3467 copying.
3469 .I disabled
3470 determines the color of the widget that cannot be selected.
3472 The dialog boxes use the following colors:
3473 .I dnormal
3474 is used for the normal text,
3475 .I dfocus
3476 is the color used for the currently selected component,
3477 .I dhotnormal
3478 is the color used to differentiate the hotkey color in normal
3479 components, whereas the
3480 .I dhotfocus
3481 color is used for the highlighted color in the currently selected
3482 component.
3484 Menus use the same scheme but uses the menunormal, menusel, menuhot, menuhotsel
3485 and menuinactive tags instead.
3487 Help uses the following colors:
3488 .I helpnormal
3489 is used for normal text,
3490 .I helpitalic
3491 is used for text which is emphasized in italic in the manual page,
3492 .I helpbold
3493 is used for text which is emphasized in bold in the manual page,
3494 .I helplink
3495 is used for not selected hyperlinks and
3496 .I helpslink
3497 is used for selected hyperlink.
3499 Popup menu uses following colors:
3500 .I pmenunormal
3501 is used for non-selected menu items and as a main color of popup menu window,
3502 .I pmenusel
3503 is used for selected menu item,
3504 .I pmenutitle
3505 is used for popup menu title.
3507 The possible colors are: black, gray, red, brightred, green,
3508 brightgreen, brown, yellow, blue, brightblue, magenta, brightmagenta,
3509 cyan, brightcyan, lightgray and white. And there is a special keyword
3510 for transparent background. It is 'default'. The 'default' can only be
3511 used for background color. Another special keyword "base" means mc's main
3512 colors.  When 256 colors are available, they can be specified either as
3513 color16 to color255, or as rgb000 to rgb555 and gray0 to gray23. Example:
3516 [Colors]
3517 base_color=normal=white,default:marked=magenta,default
3520 Attributes can be any of bold, underline, reverse and blink, appended by a
3521 plus sign if more than one are desired.  The special word "none" means no
3522 attributes, without attempting to fall back to base_color.  Example:
3525 menuhotsel=yellow;black;bold+underline
3528 .\"NODE "Skins"
3529 .SH "Skins"
3530 You can change the appearance of Midnight Commander.
3531 To do this, you must specify a file that contain descriptions of colors
3532 and lines to draw boxes. Redefining of the colors is entirely compatible
3533 with the assignment of colors, as described in Section
3534 .\"LINK2"
3535 Colors\&.
3536 .\"Colors"
3538 If your skin contains any of 256\-color definitions, you should define
3539 the '256colors' key set to TRUE value in [skin] section.
3542 A skin\-file is searched on the following algorithm (to the first one found):
3545 1) command line option
3546 .B \-S \<skin\>
3548 .B \-\-skin=\<skin\>
3550 2) Environment variable
3551 .B MC_SKIN
3553 3) Parameter
3554 .B skin
3555 in section
3556 .B [Midnight\-Commander]
3557 in config file.
3559 4) File
3560 .B %sysconfdir%/mc/skins/default.ini
3562 5) File
3563 .B %prefix%/share/mc/skins/default.ini
3566 Command line option, environment variable and parameter in config file may
3567 contain the absolute path to the skin\-file (with the extension \.ini
3568 or without it). Search of skin\-file will occur in (to the first one found):
3571 .B ~/.local/share/mc/skins/
3574 .B @sysconfdir@/mc/skins/
3577 .B %prefix%/share/mc/skins/
3581 For getting extended info, refer to:
3583 .\"LINK2"
3584 Description of section and parameters
3585 .\"Skins sections"
3587 .\"LINK2"
3588 Color pair definitions
3589 .\"Skins colors"
3591 .\"LINK2"
3592 Draw lines
3593 .\"Skins lines"
3595 .\"LINK2"
3596 Compatibility
3597 .\"Skins oldcolors"
3600 .\"NODE "  Skins sections"
3601 .SH "  Description of section and parameters"
3603 Section
3604 .B [skin]
3605 contain metainfo for skin\-file. Parameter
3606 .I description
3607 contain short text about skin.
3610 Section
3611 .B [filehighlight]
3612 contain descriptions of color pairs for filenames highlighting.
3613 Name of parameters must be equal to names of sections into
3614 filehighlight.ini file.
3616 .\"LINK2"
3617 Filenames Highlight
3618 .\"Filenames Highlight"
3619 for getting more info.
3622 Section
3623 .B [core]
3624 describes the elements that are used everywhere.
3626 .I _default_
3627 Default color pair. Used in all other sections if they not contain
3628 color definitions
3630 .I selected
3631 cursor
3633 .I marked
3634 selected data
3636 .I markselect
3637 cursor on selected data
3639 .I gauge
3640 color of the filled part of the progress bar
3642 .I input
3643 color of input lines used in query dialogs
3645 .I inputmark
3646 color of input selected text
3648 .I inputunhanged
3649 color of input text before first modification or cursor movement
3651 .I commandlinemark
3652 color of selected text in command line
3654 .I reverse
3655 reverse color
3657 Section
3658 .B [dialog]
3659 describes the elements that are placed on dialog windows (except error dialogs).
3661 .I _default_
3662 Default color for this section. Used [core]._default_ if not specified
3664 .I dfocus
3665 Color of active element (in focus)
3667 .I dhotnormal
3668 Color of hotkeys
3670 .I dhotfocus
3671 Color of hotkeys in focused element
3674 Section
3675 .B [error]
3676 describes the elements that are placed on error dialog windows
3678 .I _default_
3679 Default color for this section. Used [core]._default_ if not specified
3681 .I errdhotnormal
3682 Color of hotkeys
3684 .I errdhotfocus
3685 Color of hotkeys in focused element
3688 Section
3689 .B [menu]
3690 describes the elements that are placed in menu. This section describes
3691 system menu (called by F9) and user\-defined menus (called by F2 in panels
3692 and by F11 in editor).
3694 .I _default_
3695 Default color for this section. Used [core]._default_ if not specified
3697 .I entry
3698 Color of menu items
3700 .I menuhot
3701 Color of menu hotkeys
3703 .I menusel
3704 Color of active menu item (in focus)
3706 .I menuhotsel
3707 Color of menu hotkeys in focused menu item
3709 .I menuinactive
3710 Color of inactive menu
3713 Section
3714 .B [help]
3715 describes the elements that are placed on help window.
3717 .I _default_
3718 Default color for this section. Used [core]._default_ if not specified
3720 .I helpitalic
3721 Color pair for element with
3722 .B italic
3723 attribute
3725 .I helpbold
3726 Color pair for element with
3727 .B bold
3728 attribute
3730 .I helplink
3731 Color of links
3733 .I helpslink
3734 Color of active link (on focus)
3737 Section
3738 .B [editor]
3739 describes the colors of elements placed in editor.
3741 .I _default_
3742 Default color for this section. Used [core]._default_ if not specified
3744 .I editbold
3745 Color pair for element with
3746 .B bold
3747 attribute
3749 .I editmarked
3750 Color of selected text
3752 .I editwhitespace
3753 Color of tabs and trailing spaces highlighting
3755 .I editlinestate
3756 Color for line state area
3759 Section
3760 .B [viewer]
3761 describes the colors of elements placed in viewer.
3763 .I viewunderline
3764 Color pair for element with
3765 .B underline
3766 attribute
3768 .\"NODE "  Skins colors"
3769 .SH "  Color pair definitions"
3770 Any parameter in skin\-file contain definition of color pair.
3772 Color pairs described as two colors and the optional attributes
3773 separated by ';'. First field sets the foreground color, second
3774 field sets background color, third field sets the attributes.
3775 Any of the fields may be omitted, in this case value will be
3776 taken from default color pair (global color pair or from default
3777 color pair of this section).
3779 Example:
3782 [core]
3783     # green on black
3784     _default_=green;black
3785     # green (default) on blue
3786     selected=;blue
3787     # yellow on black (default)
3788     # underlined yellow on black (default)
3789     marked=yellow;;underline
3793 Possible colors (names) and attributes are described in
3794 .\"LINK2"
3795 Colors\&.
3796 .\"Colors"
3797 section.
3799 .\"NODE "  Skins lines"
3800 .SH "  Draw lines"
3801 Lines sets in section
3802 .B [Lines]
3803 into skin\-file. By default single lines are used, but you may redefine
3804 to usage of any utf\-8 symbols (like to lines, for example).
3806 .I WARNING!!!
3807 When you build Midnight Commander with the Ncurses screen library
3808 usage of drawing lines is limited!
3809 Possible only drawing a single lines.
3810 For all questions and comments please contact the developers of Ncurses.
3813 Descriptions of parameters
3814 .BR [Lines] :
3816 .I lefttop
3817 left\-top line fragment.
3819 .I righttop
3820 right\-top line fragment.
3822 .I centertop
3823 down branch of horizontal line
3825 .I centerbottom
3826 up branch of horizontal line
3828 .I leftbottom
3829 left\-bottom line fragment
3831 .I rightbottom
3832 right\-bottom line fragment
3834 .I leftmiddle
3835 right branch of vertical line
3837 .I rightmiddle
3838 left branch of vertical line
3840 .I centermiddle
3841 cross of lines
3843 .I horiz
3844 horizontal line
3846 .I vert
3847 vertical line
3849 .I thinhoriz
3850 thin horizontal line
3852 .I thinvert
3853 thin vertical line
3856 .\"NODE "  Skins oldcolors"
3857 .SH "  Compatibility"
3859 Appointment of color  by skin\-files fully compatible with
3860 the appointment of the colors described in
3861 .\"LINK2"
3862 Colors\&.
3863 .\"Colors"
3864 section.
3866 In this case, reassignment of colors has priority over the skin file and is
3867 complementary.
3869 .\"NODE "Filenames Highlight"
3870 .SH "Filenames Highlight"
3871 Section [filehighlight] in current skin\-file contains key names as
3872 highlight groups and values as color pairs. Color pairs is documented
3874 .\"LINK2"
3875 Skins
3876 .\"Skins"
3877 section.
3879 Rules of filenames highlight are placed in %prefix%/share/mc/filehighlight.ini file
3880 (~/.config/mc/filehighlight.ini).
3881 Name of section in this file must be equal to parameters names in
3882 [filehighlight] section (in current skin\-file).
3884 Keys in these groups are:
3886 .I type
3887 file type. If present, all other options are ignored.
3889 .I regexp
3890 regular expression. If present, 'extensions' option is ignored.
3892 .I extensions
3893 list of extensions of files. Separated by ';' sign.
3895 .I extensions_case
3896 (make sense only with 'extensions' parameter) make 'extensions'
3897 rule case sentitive (true) or not (false).
3899 `type' key may have values:
3901 \- FILE (all files)
3902   \- FILE_EXE
3903 \- DIR (all directories)
3904   \- LINK_DIR
3905 \- LINK (all links except stale link)
3906   \- HARDLINK
3907   \- SYMLINK
3908 \- STALE_LINK
3909 \- DEVICE (all device files)
3910   \- DEVICE_BLOCK
3911   \- DEVICE_CHAR
3912 \- SPECIAL (all special files)
3913   \- SPECIAL_SOCKET
3914   \- SPECIAL_FIFO
3915   \- SPECIAL_DOOR
3919 .\"NODE "Special Settings"
3920 .SH "Special Settings"
3921 Most of the Midnight Commander settings can be changed from the
3922 menus. However, there are a small number of settings which can only be
3923 changed by editing the setup file.
3925 These variables may be set in your ~/.config/mc/ini file:
3927 .I clear_before_exec
3928 By default the Midnight Commander clears the screen before executing a
3929 command.  If you would prefer to see the output of the command at the
3930 bottom of the screen, edit your ~/.config/mc/ini file and change the value of
3931 the field clear_before_exec to 0.
3933 .I confirm_view_dir
3934 If you press F3 on a directory, normally MC enters that directory.  If
3935 this flag is set to 1, then MC will ask for confirmation before changing
3936 the directory if you have files tagged.
3938 .I ftpfs_retry_seconds
3939 This value is the number of seconds the Midnight Commander will wait
3940 before attempting to reconnect to an FTP server that has denied the
3941 login.  If the value is zero, the login will no be retried.
3943 .I max_dirt_limit
3944 Specifies how many screen updates can be skipped at most in the internal
3945 file viewer.  Normally this value is not significant, because the code
3946 automatically adjusts the number of updates to skip according to the
3947 rate of incoming keystrokes.  However, on very slow machines or
3948 terminals with a fast keyboard auto repeat, a big value can make screen
3949 updates too jumpy.
3951 It seems that setting max_dirt_limit to 10 causes the best behavior,
3952 and that is the default value.
3954 .I mouse_move_pages_viewer
3955 Controls if scrolling with the mouse is done by pages or line by line
3956 on the internal file viewer.
3958 .I only_leading_plus_minus
3959 Allow special treatment for '+', '\-', '*' in the command line (select,
3960 unselect, reverse selection) only if the command line is empty.  You
3961 don't need to quote those characters in the middle of the command line.
3962 On the other hand, you cannot use them to change selection when the
3963 command line is not empty.
3965 .I show_output_starts_shell
3966 This variable only works if you are not using the subshell support.
3967 When you use the C\-o keystroke to go back to the user screen, if this
3968 one is set, you will get a fresh shell.  Otherwise, pressing any key
3969 will bring you back to the Midnight Commander.
3971 .I timeformat_recent
3972 Change the time format used to display dates less than 6 months from
3973 now.
3974 See strftime or date man page for the format specification. If this
3975 option is absent, default timeformat is used.
3977 .I timeformat_old
3978 Change the time format used to display  dates older than 6 months from
3979 now or for dates in the future.
3980 See strftime or date man page for the format specification. If this
3981 option is absent, default timeformat is used.
3983 .I torben_fj_mode
3984 If this flag is set, then the home and end keys will work slightly
3985 different on the panels, instead of moving the selection to the first
3986 and last files in the panels, they will act as follows:
3988 The home key will: Go up to the middle line, if below it; else go to the
3989 top line unless it is already on the top line, in this case it will go
3990 to the first file in the panel.
3992 The end key has a similar behavior: Go down to the middle line, if over
3993 it; else go to the bottom line unless you already are at the bottom
3994 line, in such case it will move the selection to the last file name in
3995 the panel.
3997 .I use_file_to_guess_type
3998 If this variable is on (the default) it will spawn the file command to
3999 match the file types listed on the
4000 .\"LINK2"
4001 mc.ext file\&.
4002 .\"Extension File Edit"
4004 .I xtree_mode
4005 If this variable is on (default is off) when you browse the file system
4006 on a Tree panel, it will automatically reload the other panel with the
4007 contents of the selected directory.
4009 .I fish_directory_timeout
4010 This variable holds the lifetime of a directory cache entry in seconds. The
4011 default value is 900 seconds.
4013 .I clipboard_store
4014 This variable contains path (with options) to the external clipboard
4015 utility like 'xclip' to read text into X selection from file.
4016 For example:
4019 clipboard_store=xclip \-i
4022 .I clipboard_paste
4023 This variable contains path (with options) to the external clipboard
4024 utility like 'xclip' to print the selection to standard out.
4025 For example:
4028 clipboard_pastee=xclip \-o
4031 .I autodetect_codeset
4032 This option allows use the `enca' command to autodetect codeset of text files
4033 in internal viewer and editor. List of valid values can be obtain by the
4034 `enca \-\-list languages | cut \-d : \-f1' command. Option must be located
4035 in the [Misc] section.
4037 For example:
4040 autodetect_codeset=russian
4042 .\"NODE "Terminal databases"
4043 .SH "Terminal databases"
4044 The Midnight Commander provides a way to fix your system terminal
4045 database without requiring root privileges.  The Midnight Commander
4046 searches in the system initialization file (the mc.lib file located in
4047 the Midnight Commander library directory) and in the 
4048 ~/.config/mc/ini file for the section 
4049 "terminal:your\-terminal\-name" and then for the section
4050 "terminal:general", each line of the section contains a key symbol that
4051 you want to define, followed by an equal sign and the definition for the
4052 key.  You can use the special \\e form to represent the escape character
4053 and the ^x to represent the control\-x character.
4055 The possible key symbols are:
4058 f0 to f20     Function keys f0\-f20
4059 bs            backspace
4060 home          home key
4061 end           end key
4062 up            up arrow key
4063 down          down arrow key
4064 left          left arrow key
4065 right         right arrow key
4066 pgdn          page down key
4067 pgup          page up key
4068 insert        the insert character
4069 delete        the delete character
4070 complete      to do completion
4073 For example, to define the key insert to be the Escape + [ + O + p, you
4074 set this in the ini file:
4077 insert=\\e[Op
4081 Also now you can use
4082 .I extended learn keys.
4083 For example:
4086     ctrl\-alt\-right=\\e[[1;6C
4087     ctrl\-alt\-left=\\e[[1;6D
4091 This means that ctrl+alt+left sends a \\e[[1;6D escape sequence
4092 and therefore Midnight Commander interprets "\\e[[1;6D" as Ctrl\-Alt\-Left.
4096 .I complete
4097 key symbol represents the escape sequences used to invoke the completion
4098 process, this is invoked with Alt\-tab, but you can define other keys to do
4099 the same work (on those keyboard with tons of nice and unused keys
4100 everywhere).
4101 .SH ""
4102 .\"NODE "FILES"
4103 .SH "FILES"
4104 Full paths below may vary between installations.  They are also affected
4105 by the
4106 .BR MC_DATADIR
4107 environment variable. If it's set, its value is used instead of
4108 %prefix%/share/mc in the paths below.
4110 .I %prefix%/share/mc/mc.hlp
4112 The help file for the program.
4114 .I %prefix%/share/mc/mc.ext
4116 The default system\-wide extensions file.
4118 .I ~/.config/mc/mc.ext
4120 User's own extension, view configuration and edit configuration
4121 file.  They override the contents of the system wide files if present.
4123 .I %prefix%/share/mc/mc.ini
4125 The default system\-wide setup for the Midnight Commander, used only if
4126 the user doesn't have his own ~/.config/mc/ini file.
4128 .I %prefix%/share/mc/mc.lib
4130 Global settings for the Midnight Commander.  Settings in this file
4131 affect all users, whether they have ~/.config/mc/ini or not.  Currently, only
4132 .\"LINK2"
4133 terminal settings
4134 .\"Terminal databases"
4135 are loaded from mc.lib.
4137 .I ~/.config/mc/ini
4139 User's own setup. If this file is present then the setup is loaded
4140 from here instead of the system\-wide startup file.
4142 .I %prefix%/share/mc/mc.hint
4144 This file contains the hints displayed by the program.
4146 .I %prefix%/share/mc/mc.menu
4148 This file contains the default system\-wide applications menu.
4150 .I ~/.config/mc/menu
4152 User's own application menu. If this file is present it is used instead
4153 of the system\-wide applications menu.
4155 .I ~/.cache/mc/Tree
4157 The directory list for the directory tree and tree view features.
4159 .I ~/.local/share/mc.menu
4161 Local user\-defined menu. If this file is present, it is used instead of
4162 the home or system\-wide applications menu.
4164 To change default root directory of MC, you can use
4165 .BR MC_HOME
4166 environment variable. The value of MC_HOME must be an absolute path. If MC_HOME
4167 is unset or empty, HOME variable is used. If HOME is unset or empty, MC
4168 directories are get from GLib library.
4169 .\"SKIP_SECTION"
4170 .SH "LICENSE"
4171 This program is distributed under the terms of the GNU General Public
4172 License as published by the Free Software Foundation. See the built\-in
4173 help for details on the License and the lack of warranty.
4174 .\"NODE "AVAILABILITY"
4175 .SH "AVAILABILITY"
4176 The latest version of this program can be found at
4177 ftp://ftp.gnu.org/gnu/mc/.
4178 .\"NODE "SEE ALSO"
4179 .SH "SEE ALSO"
4180 ed(1), gpm(1), terminfo(1), view(1), sh(1), bash(1),
4181 tcsh(1), zsh(1).
4184 The Midnight Commander page on the World Wide Web:
4185         http://www.midnight\-commander.org/
4187 .\"NODE "AUTHORS"
4188 .SH "AUTHORS"
4189 Authors and contributors are listed in the AUTHORS file in the source
4190 distribution.
4191 .\"NODE "BUGS"
4192 .SH "BUGS"
4193 See the file TODO in the distribution for information on what remains to
4194 be done.
4196 If you want to report a problem with the program, please send mail to
4197 this address: mc\-devel@gnome.org.
4199 Provide a detailed description of the bug, the version of the program
4200 you are running
4201 .RI ( "mc \-V"
4202 displays this information), the operating system you are running the
4203 program on.  If the program crashes, we would appreciate a stack trace.