README 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. Contents
  2. --------
  3. * Introduction
  4. * Dependencies
  5. * Features
  6. * Mini-documentation
  7. * Where to get more information
  8. * Reporting problems
  9. Introduction
  10. ------------
  11. GNU Midnight Commander (also referred to as MC) is a user shell with
  12. text-mode full-screen interface. It can be run on the OS console,
  13. in xterm and other terminal emulators.
  14. GNU Midnight Commander allows you to manage files while making the most of
  15. your screen and giving you a clear representation of the filesystem, yet
  16. it's simple enough to be run over a telnet or ssh session.
  17. GNU Midnight Commander is released under the GNU General Public
  18. License version 3 or any later version. A copy of the file is
  19. included with this distribution package.
  20. Dependencies
  21. ------------
  22. Please read the file INSTALL for installation instructions
  23. and full list of dependencies.
  24. Features
  25. --------
  26. GNU Midnight Commander was conceived as a free clone of John Socha's
  27. Norton Commander (TM). It also takes the best from more recent software
  28. with similar interfaces. GNU Midnight Commander comes with mouse support
  29. on xterm and optionally on the Linux console.
  30. Some features are specific to the POSIX environment MC runs on, some are
  31. familiar to the users of similar software for other operating systems.
  32. The features include:
  33. * Built in Virtual File System: manipulate remote file systems
  34. through the FTP and SFTP protocols or over secure shell, browse
  35. contents of tar, ar, rpm, zip, cpio, lha and rar archives just
  36. like local files.
  37. * Almost all operations work with the virtual file system,
  38. enabling you to do complex tasks, like viewing files in
  39. archives on an FTP server.
  40. * Mouse support on most terminal emulators for X Window System
  41. as well as on the Linux console.
  42. * Learn Keys: GNU Midnight Commander may be configured at run
  43. time to support any kind of input keys for a given terminal,
  44. making its operation possible even on most weird terminals.
  45. * Text and hex editors are available for you to use (hex editor
  46. is a part of the viewer).
  47. * Hotlist allows you to keep a list of common visited locations,
  48. including remote sites and directories inside archives.
  49. * Command completion: By pressing Alt-Tab in any place where a
  50. filename or an executable are expected, GNU Midnight Commander
  51. will complete the name for you. If you press Alt-Tab for the
  52. second time, you get a list box with all possible completions.
  53. * Subshell support: Run your commands by a real shell
  54. interpreter. GNU Midnight Commander interacts with bash,
  55. tcsh and zsh to provide you with all of the facilities
  56. available in your preferred shell.
  57. * Find file command can search for the file contents.
  58. * Background operations allow you to copy or move files from
  59. any virtual file system while you do other tasks (i.e., you
  60. can do background FTP copies).
  61. * FTP proxy is supported.
  62. * Linux file recovery: If you are using Linux, you can recover
  63. deleted files from an ext2 or ext3 partition with the undelete
  64. file system. This is a low level file recovery function that
  65. can recover files deleted by any program on Linux.
  66. * External panelization: You can run any arbitrary external
  67. command and GNU Midnight Commander will display the output
  68. generated as a file listing that can be manipulated as a
  69. regular directory.
  70. * Emacs-like key bindings are used in all widgets.
  71. * Context dependent actions (open, view, edit) are available.
  72. * The built-in file viewer, together with the context dependent
  73. actions is used to format man pages on the fly, coloring mail
  74. messages and more.
  75. * The built-in editor supports syntax highlighting and external
  76. actions, such as spell checking and formatting.
  77. Mini-documentation
  78. ------------------
  79. These are hints for the text mode edition:
  80. * Use the F-Keys for invoking the commands in the function key bar.
  81. If your terminal doesn't support F-keys, you can use the <ESC digit>
  82. sequence to invoke the corresponding F-digit key.
  83. * Tab changes the current panel.
  84. * All input lines have emacs-like key-bindings (command history is
  85. accessed through the M-p and M-n keys).
  86. * The panels accept C-n, C-p for browsing the panel (like in Emacs).
  87. * M-Enter copies the currently selected file name to the input line.
  88. * M-Tab completes the current word (or tries to).
  89. * The Virtual File System is a cute addition to the project, you may
  90. browse in tar and compressed tar files as well as browsing remote
  91. machines with the shell file system.
  92. * Please read the manual page.
  93. You can access the whole documentation online with the F1 key,
  94. although it's not as nice as the groff printed manual page :-)
  95. Where to get more information
  96. -----------------------------
  97. There is a webpage for GNU Midnight Commander at
  98. * https://www.midnight-commander.org
  99. This page also has current information about mailing lists and some
  100. useful advices how to report bugs.
  101. You can download the latest version of GNU Midnight Commander from
  102. * https://www.midnight-commander.org/downloads/
  103. The Midnight Commander distribution is placed at:
  104. * http://ftp.osuosl.org/pub/midnightcommander/
  105. * ftp://ftp.osuosl.org/pub/midnightcommander/
  106. Reporting problems
  107. ------------------
  108. You can report bug on our site, please read
  109. https://www.midnight-commander.org/wiki/doc/reportDefects
  110. Also you can use mc mailing lists to discuss problems.
  111. There are two mailing lists:
  112. - mc@lists.midnight-commander.org
  113. - mc-devel@lists.midnight-commander.org
  114. Use mc-devel@ if you are prepared for a more technical discussion
  115. with the developers of the package, otherwise use mc@.
  116. Include the output of "mc --version", the operating system and the
  117. distribution (if applicable) you are using, the compiler and the
  118. configure flags used to compile the program (if you know them).
  119. If the program crashed and produced a core dump, please provide a
  120. stack trace of the program.
  121. You can do this by running gdb like this:
  122. gdb mc core
  123. (gdb) where