README

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