README

   1 -*-Text-*-
   2
   3 Contents:
   4 ---------
   5   Requirments
   6   GNOME edition requirments
   7   Features
   8   Midnight Commander editions
   9   Where to get more information
  10   The Midnight Commander
  11   Mini-docs
  12   Obtaining the Midnight Commander
  13   Reporting problems.
  14
  15 This version of the Midnight Commander comes with two interfaces: a
  16 graphical one for the GNOME desktop (http://www.gnome.org) and a text
  17 mode interface (the same old user interface we have had for a long
  18 time).
  19
  20 Most of the engine is shared between both versions, but they come with
  21 radically different interfaces:  the GNOME version is aimed to be a
  22 simple to use tool for novice users.
  23
  24 Requirments
  25 -----------
  26
  27 To compile the GNU Midnight Commander you need at least to have a copy
  28 of the glib library, this library is available in ftp://ftp.gtk.org/pub/gtk.
  29
  30 GNOME edition requirements
  31 --------------------------
  32
  33 Optionally, if you want to compile the GNOME edition, you need to
  34 install the GNOME libraries and its dependencies.
  35
  36 The GNOME libraries are available in:
  37
  38     ftp://ftp.gnome.org/pub/GNOME/sources/gnome-libs
  39
  40
  41 Features
  42 --------
  43
  44 This is version 4 of the Midnight Commander, a free Norton Commander
  45 Clone with many useful features. The Midnight Commander comes with
  46 mouse support on xterms and optionally on the Linux console.
  47
  48 The Midnight Commander is a directory browsing tool which bears a
  49 certain remote resemblance to John Socha's Norton Commander for DOS.
  50 It is feature packed:
  51
  52         o Built in Virtual File System: manipulate remote files
  53         systems through the ftp protocol or Midnight Commander's own
  54         mcfs protocol.  Browse tar, compressed tar files, rpm, zip,
  55         cpio, lha and rar files with a single click.
  56
  57         o All of the Midnight Commander operations work with the virtual
  58         file system, enabling you to do complex tasks.
  59
  60         o Mouse support on the Linux console and under X11's xterms.
  61
  62         o Learn Keys: The Midnight Commander may be configured at run
  63         time to support any kind of input keys for a given terminal,
  64         making its operation even on the most wierd terminals a
  65         breeze.
  66
  67         o Text and hex editors are available for you to use.
  68
  69         o Hotlist allows you to keep a list of common visited
  70         locations (including ftp sites).
  71
  72         o Command completion: By pressing Alt-Tab in any place where a
  73         filename or an executable are expected, the Midnight Commander
  74         will complete for you the name.  If you quickly press Alt-Tab
  75         twice you can get a listbox with the possible completions
  76         available.
  77
  78         o Subshell support: Run your commands by a real shell
  79         interpreter.  The Midnight Commander interacts with bash, tcsh
  80         and zsh to provide you with all of the facilities available in
  81         your shell.
  82
  83         o Find file command can now search inside the contents of
  84         files.
  85
  86         o Background operations allows you to copy or move files from
  87         any virtual file system while you do other tasks (ie, you can
  88         do background ftp copies).
  89
  90         o Proxy support with our ftpfs.
  91
  92         o Linux file recovery: If you are using Linux system, you can
  93         recover deleted files from an ext2fs partition with the
  94         undelete file system.  This is a low level file recovery
  95         function that will recover files deleted by any program in
  96         Linux.
  97
  98         Please note that the undelete file system can only recover
  99         12 file system blocks if the file was deleted with a kernel
 100         in the 2.0.x series.  The 2.1.x series have fixed this and you
 101         can recover all of the file contents there.
 102
 103         o External panelization: You can run any arbitrary external
 104         command and the Midnight Commander will display the output
 105         generated as a file listing that can be manipulated as a
 106         regular directory.
 107
 108         o Emacs like key bindings in all of our widgets.
 109
 110         o Powerfull context dependant actions are available.
 111
 112         o Powerfull built-in file viewer:  The file viewer, together
 113         with the context dependant actions is used to format man pages
 114         on the fly, coloring mail messages and more.
 115
 116
 117 Where to get more information:
 118 ------------------------------
 119
 120 There is a mailing list for discussion on enhancing the program, future
 121 directions and announcements; if you want to subscribe, send mail to:
 122
 123 majordomo@roxanne.nuclecu.unam.mx
 124
 125 There is a WWW page for the Midnight Commander with the URL:
 126 <http://mc.blackdown.org/mc/>.
 127
 128
 129 The Midnight Commander:
 130 -----------------------
 131
 132 The Midnight Commander is released under the GNU General Public License
 133 version 2.0 or any later version.  A copy of the file is included with
 134 this distribution package.
 135
 136 If you have comments, you can send them to me:
 137
 138 miguel@roxanne.nuclecu.unam.mx
 139
 140 or if it would benefit more people, to the mailing list:
 141
 142 mc@roxanne.nuclecu.unam.mx
 143
 144 Help develop and enhance free software.
 145
 146
 147 Mini-documentation:
 148 -------------------
 149
 150 These are hints for the text mode edition:
 151
 152 o Use the F-Keys for invoking the commands in the function key bar.
 153   If your terminal doesn't support F-keys, you can use the <ESC digit>
 154   sequence to invoke the corresponding F-digit key.
 155
 156 o Tab changes the current panel.
 157
 158 o All input lines have emacs-like key-bindings (command history is
 159   accessed through the M-p and M-n keys).
 160
 161 o The panels accept C-n, C-p for browsing the panel (like in emacs).
 162
 163 o M-Enter copies the currently selected file name to the input line.
 164
 165 o M-Tab completes the current word (or tries to).
 166
 167 o The Virtual File System is a cute addition to the project, you may
 168   browse in tar and compressed tar files as well as browsing remote
 169   machines with the mcfs file system.
 170
 171 o Please read the manual page.
 172
 173 o Read the file src/TODO for the current projects.
 174
 175 You can access the whole documentation online with the F1 key,
 176 although it's not as nice as the groff printed manual page :-)
 177
 178
 179 Where you may obtain the Midnight Commander
 180 -------------------------------------------
 181
 182 The software should be available by anonymous ftp at sunsite.unc.edu
 183 in the directory /pub/Linux/utils/file and at ftp.nuclecu.unam.mx
 184 in the directory /linux/local.
 185
 186 The last alpha versions are available at ftp.nuclecu.unam.mx in the
 187 directory /linux/local/devel.
 188
 189 European mirrors of both version 3.1 and alpha versions are available
 190 at sunsite.mff.cuni.cz in the directory /GNU/mc and at ftp.teuto.de
 191 in the directory /lmb/mc.
 192
 193
 194 Reporting problems
 195 ------------------
 196
 197 Please, send a detailed description of your problem to the
 198 mc-bugs@roxanne.nuclecu.unam.mx address.
 199
 200 Include the version of the program, the operating system that you are
 201 using, the compiler and compiler flags used to compile the program (if
 202 you know them), what kind of distribution you are using (if a
 203 GNU/Linux system).
 204
 205 If the program crashed and produces a core dump, please provide a
 206 stack trace of the program.
 207
 208 You can do this by running dbx or gdb like this:
 209
 210 gdb mc core
 211 (gdb) where
 212
 213
 214