*** empty log message ***
[midnight-commander.git] / INSTALL.FAST
blob268b49056dd33c7ea042b096942d9f4734ede1e9
1 -*-text-*-
3 Read the INSTALL file for the complete instructions. 
5    GNU Midnight Commander requires glib.  Currently only the 1.2.x
6 series are supported.  You may already have glib installed, but if you
7 don't, take it from ftp://ftp.gtk.org/pub/gtk/v1.2/
9    GNU Midnight Commander by default will use the S-Lang screen manager.
10 It tries the S-Lang library installed on the system, but if it's not
11 found, the included S-Lang sources are used.  It is also possible to
12 use ncurses as the screen manager.  Note that syntax highlighting in
13 the editor is currently unavailable with ncurses.
15 1. Configure the package for your system.
17    Normally, you just `cd' to the package main directory and type
18 `./configure'.
20    The most often needed options to configure are following:
22 `--prefix=PATH'
23         By default, `make install' will install the package's files
24         in `/usr/local/bin', `/usr/local/man', etc. or to `/usr/bin',
25         `/usr/man', etc. depending on the location of an old mc binary.
26         If you have none in your system, default will be `/usr/local'.
27         You can specify an installation prefix other than default by
28         giving `configure' the option `--prefix=PATH'.
30 `--with-included-slang'
31         Don't try the S-Lang library installed in the system - use the
32         included S-Lang sources.  The included library is rather old,
33         by it works very well on many terminals.
34    
35 `--with-ncurses[=PATH]'
36         Use the flag without =PATH if you want to compile with ncurses
37         Use this flag with =PATH part, if you want to compile with ncurses
38         and your ncurses is not installed in any of the places configure
39         checks (/usr/include, /usr/include/ncurses, /usr/local/include and
40         /usr/local/include/ncurses). The configure script will append
41         `lib' and `include' to find the libncurses.a and ncurses.h
42         files respectively.
44 `--with-gpm-mouse[=PATH]'
45         Use this flag if your GPM mouse package cannot be detected by the
46         configure. Use =PATH if it is installed in a non-standard place.
47         The configure will append `lib' and `include' to find the libgpm.a
48         and gpm.h files respectively.  Note that GPM is only available on
49         GNU/Linux systems.
51    You may also want to specify CFLAGS for the compiler, even if it finds
52    itself some defaults by typing e.g.
54    `CFLAGS=-O2 ./configure'
56 2. Type `make' to compile the package.
58 3. Type `make install' (as root) to install programs, data files, and
59 documentation.  If you're on a GNU/Linux system, this will install the
60 `cons.saver' utility, which allows the Midnight Commander to save and
61 restore the screen contents.  If you're making a mc binary distribution
62 for other people and want to tar the whole binary later, you may want
63 to specify `make install DESTDIR=PATH', which will make PATH the root
64 for installation.
66 3a. Type `make mcfninstall' to get an interactive program check if you
67 want to define an useful alias for the Midnight Commander.
69 4. Type `mc' and enjoy!