README

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