*** empty log message ***
[midnight-commander.git] / INSTALL
blob00c026aa09d55e7787b9a9170c66bdfb8cd3de05
1 This file contains:
3 - Installation instructions and notes for GNU Midnight Commander
4 - Where to get more information on GNU Midnight Commander
5 - Common problems
6 - Information on porting the program
7 - Obtaining the missing pieces of GNU Midnight Commander
10 Installation instructions for GNU Midnight Commander
11 ----------------------------------------------------
13    The `configure' shell script attempts to guess correct values for
14 various system-dependent variables used during compilation, and creates
15 the makefiles.  It also creates a file `config.status' that you can run in
16 the future to recreate the current configuration.
18 NeXTStep users, make sure you read the "Compiling under NeXTStep" section.
20 To compile this package:
22 1.  Configure the package for your system.
24    Normally, you just `cd' to the directory containing the package's
25 source code and type `./configure'.  If you're using `csh' on an old
26 version of SystemV, you might need to type `sh configure' instead to
27 prevent `csh' from trying to execute `configure' itself.  Under AIX, you
28 may need to use ksh instead of sh.
30    Running `configure' takes a while.  While it is running, it
31 prints some messages that tell what it is doing.  If you don't want to
32 see any messages, run `configure' with the `--quiet' option.
34    To compile the package in a different directory than the one containing
35 the source code, you must use a version of `make' supporting the `VPATH'
36 variable, such as GNU `make'.  `cd' to the directory where you want the
37 object files and executables to go and run the `configure' script with the
38 path to it.  If for some reason `configure' is not in the source code
39 directory that you are configuring, then it will report that it can't find
40 the source code.  In that case, run `configure' with the option
41 `--srcdir=DIR', where DIR is the directory that contains the source code.
43    By default, `make install' will install the package's files in
44 `/usr/local/bin', `/usr/local/man', etc.  You can specify an installation
45 prefix other than `/usr/local' by giving `configure' the option
46 `--prefix=PATH'.  Alternately, you can do so by consistently giving a
47 value for the `prefix' variable when you run `make', e.g.,
49      make prefix=/usr/gnu
50      make prefix=/usr/gnu install
52    You can specify separate installation prefixes for architecture
53 specific files and architecture-independent files.  If you give
54 `configure' the option `--exec-prefix=PATH' or set the `make' variable
55 `exec_prefix' to PATH, the package will use PATH as the prefix for
56 installing programs and libraries.  Data files and documentation will
57 still use the regular prefix.  Normally, all files are installed using the
58 same prefix.
60    If run on GNU/Linux, Midnight Commander detects if you have the gpm
61 library installed.  If you installed the gpm mouse library in a
62 non-standard place, you will need to use the --with-gpm-mouse flag with
63 the directory base where you installed the gpm package.
65    `configure' also recognizes the following options:
67 `--help'
68      Print a summary of the options to `configure', and exit.
70 `--quiet'
71 `--silent'
72      Do not print messages saying which checks are being made.
74 `--verbose'
75      Print the results of the checks.
77 `--version'
78      Print the version of Autoconf used to generate the `configure'
79      script, and exit.
81 `--without-edit'
82      Configures the program to be compiled without the built-in file
83      editor.  The built-in editor is compiled in by default.
85 `--with-ext2undel[=PATH]'
86      On systems that use the Extended 2 file system and have the
87      libext2fs.a library available, this compiles into the Midnight
88      Commander the support code for recovering deleted files (the
89      undel virtual file system). 
90      Use =PATH if libext2fs.a is installed in a non-standard place. 
91      The configure will append `lib' and `include' to find the ext2fs 
92      libraries and include files respectively.
94 `--with-gpm-mouse[=PATH]'
95      Use this flag if your gpm mouse package cannot be detected by the
96      configure. Use =PATH if it is installed in a non-standard place.
97      The configure will append `lib' and `include' to find the libgpm.a
98      and gpm.h files respectively.
100 `--without-gpm-mouse'
101      Use this flag to disable gpm mouse support (e.g. if you want to
102      use mouse only on X terminals).
104 `--with-hsc'
105      Compiles support for HSC firewall into the ftp virtual file system.
107 `--with-mmap', `--without-mmap'
108      Force using or not using the mmap function.  It is currently used
109      in the internal viewer.  `--with-mmap' may be useful on some
110      versions of AIX where the `configure' script decides that mmap is
111      broken, but it's actually suitable for the internal viewer.
113 `--with-subshell[=optional]', `--without-subshell' 
114      The subshell support is by default turned on, you can disable
115      this by using the --without-subshell option.  If you pass the
116      =optional parameter, then the subshell support is turned off by
117      default.  To turn it on, specify the `-U' option to the program.
119 `--with-termnet'
120      Enables the network support with the Term package.
122 `--with-tm-x-support'
123      This option enables minimal X Window support in the text edition. It 
124      enables MC to query the status of the modifiers CONTROL and SHIFT 
125      when invoked in a terminal emulator under X11. That's necessary 
126      to recognize some optional but handy key combinations like Ctrl-Home 
127      and Shift-Cursor key.
129 `--without-vfs'
130      This option disables the Virtual File System switch code in the
131      Midnight Commander and uses the standard file system calls for
132      file access.  If you specify this option you will not get the
133      transparent tar File system manipulation as well nor the
134      networked Midnight Commander file system.
136 `--disable-largefile'
137      This option disables support for large files (2 gigabytes and more)
138      on the systems where file operations use 32-bit offsets by default,
139      but support for 64-bit offsets is available.  May be useful for
140      slow processors and embedded systems.
142 You may also tell configure which display library you want to use with the
143 Midnight Commander.  The configure script will use S-Lang as default, but
144 you can override this by using any of the following flags (please note
145 that S-Lang is included as part of the distribution and is tested much 
146 better than everything else),
148 `--with-slang' (default)
149      This is used to configure the program to use the S-Lang screen
150      library.  This is included as part of GNU Midnight Commander,
151      you don't need it installed on your system.  If S-Lang is installed
152      on your system it will be used if possible.  You can force usage of
153      the included S-Lang with the `--with-included-slang' option.
155      This option will usually try to use the terminfo database if it
156      is available, otherwise it will use the termcap database.  At
157      compile time, you may force the use the terminal database with
158      the `--with-termcap' and `--with-terminfo' options (both options
159      automatically turn `--with-included-slang' on).
161 `--with-ncurses[=directory]'
162      Use this flag (either with or without the =directory part), if
163      you want to compile with ncurses instead of the default S-Lang.
165      Use the =directory part if your ncurses is not installed in any of the
166      places configure will check (/usr/include, /usr/include/ncurses,
167      /usr/local/include and /usr/local/include/ncurses).
168      The argument to this flag is the base directory where the ncurses
169      files are located.  The configure will append lib and include to
170      find the libncurses.a and ncurses.h file respectively.  For
171      example, if you have installed ncurses under /gnu/lib and
172      /gnu/include, you specify: --with-ncurses=/gnu
174    Run `configure --help' to see the full list of options.
176    On systems that require unusual options for compilation or linking
177 that the package's `configure' script does not know about, you can give
178 `configure' initial values for variables by setting them in the
179 environment.  In Bourne-compatible shells, you can do that on the
180 command line like this:
182      CC='gcc -traditional' LIBS=-lposix ./configure
184 On systems that have the `env' program, you can do it like this:
186      env CC='gcc -traditional' LIBS=-lposix ./configure
188    Here are the `make' variables that you might want to override with
189 environment variables when running `configure'.
191    For these variables, any value given in the environment overrides the
192 value that `configure' would choose:
194  - Variable: CC
195      C compiler program.  The default is `cc'.
197  - Variable: CFLAGS
198      The default flags used to build the program.
200  - Variable: INSTALL
201      Program to use to install files.  The default is `install' if you
202      have it, `cp' otherwise.
204    For these variables, any value given in the environment is added to
205 the value that `configure' decides to use:
207  - Variable: LIBS
208      Libraries to link with, in the form `-lfoo -lbar...'.
210    If you need to do unusual things to compile the package, we encourage
211 you to figure out how `configure' could check whether to do them, and mail
212 diffs or instructions to the address given in the README so we can include
213 them in the next release.
215 2.  Type `make' to compile the package.
217 3.  If the package comes with self-tests and you want to run them,
218 type `make check'.  If you're not sure whether there are any, try it;
219 if `make' responds with something like
220         make: *** No way to make target `check'.  Stop.
221 then the package does not come with self-tests.
223 4.  Type `make install' to install programs, data files, and the
224 documentation.  On GNU/Linux the console screen saver is installed as
225 well.
227 5.  You can remove the program binaries and object files from the source
228 directory by typing `make clean'.  If you want to clean the source tree
229 completely, so that it contains only those files that should be packaged
230 in the archive, issue `make distclean'.  If you've run configure in a
231 different directory than the source tree, distclean won't remove your *.o
232 and linked programs in that directory.
234 6.  GNU Midnight Commander allows you to stay in the last current
235 directory after exiting MC.  This is done with a shell function, the man
236 page has more information about this.  If you want to let the install
237 program make the change to your /etc/profile or your ~/.profile or
238 ~/.bashrc, then type: `make mcfninstall'.
240    The file `configure.in' is used to create `configure' by a program
241 called `autoconf'.  You only need it if you want to regenerate
242 `configure' using a newer version of `autoconf'.
244 Compiling under NeXTStep 
245 ------------------------
247 These instructions were provided by Gregor Hoffleit
248 <flight@mathi.uni-heidelberg.DE>, he recommends configuring the
249 program like this:
251 export CC="cc -posix"
252 configure --without-subshell --with-termcap
255 Where to get more information on GNU Midnight Commander
256 -------------------------------------------------------
258 There are two mailing lists for the program:
260 mc:         Discussion on GNU Midnight Commander file manager.
261 mc-devel:   For discussion between the developers of the program.
263 to subscribe to the mailing lists, visit their respective pages:
265 http://mail.gnome.org/mailman/listinfo/mc/
266 http://mail.gnome.org/mailman/listinfo/mc-devel/
269 Notes about GNU Midnight Commander installation
270 ------------------------------------------------
272 GNU Midnight Commander has been run in the following configurations:
274 i386-*-linux
275 sparc-*-linux
276 alpha-*-linux
277 powerpc-*-linux
278 mips-dec-ultrix4.3
279 mips-dec-{open,net}bsd1.0
280 mips-sgi-irix5.2
281 mips-sgi-irix5.3
282 rs6000-ibm-aix3.2.5
283 sparc-sun-sunos4.1
284 sparc-sun-netbsd1.0
285 sparc-sun-solaris2.3
286 hppa-hp-hpux9
287 hppa-hp-hpux7
288 m68k-apple-aux
289 mc88110-aviion-dgux5.4
290 i386-*-bsdi2
291 i386-*-freebsd4.3
292 i386-*-openbsd2.9
294 Midnight Commander is written in a portable manner and uses GNU Autoconf
295 for configuration, so it is expected to compile without changes on many
296 other operating systems.
298 You will need GNU C (or an ANSI C Compiler) and glib library version
299 1.2.x to compile the source.  GNU Midnight Commander now comes with the
300 S-Lang screen manager, a fast screen manager, so don't need to worry
301 about screen libraries.
303 If you insist on using ncurses, it's recommended to use ncurses 4.1 and
304 above, since the older versions don't support resizing of the xterm
305 window.
307 GNU Midnight Commander comes with the mouse support on xterms and in the
308 Linux console.  In order to take advantage of the mouse support on the
309 Linux console you will need the gpm mouse server (see the section
310 "Obtaining the missing pieces of GNU Midnight Commander" in this file).
312 Once you get the Mouse Server, compile it and install it, then you
313 will have to specify the `--with-gpm-mouse' flag to the configure
314 program if you installed it in a non-standard directory.  If you
315 installed the gpm package under /usr or /usr/local, you don't need to
316 specify this flag; configure will find gpm for you.  The support for
317 mice on xterms is always compiled in.
319 We are working on further enhancements to the program, but we're not sure
320 which ones must go first.  If you would like to point us in the Right
321 Direction we will be glad to hear from you (you could check the file TODO
322 included with this distribution for the current projects).
324 If you happen to find an undocumented feature that doesn't do what you
325 expected, please write to mc@gnome.org telling as much as you can about
326 the problem you're experiencing.  Please don't send personal messages to
327 the maintainers.
330 Porting the program
331 -------------------
333 Random notes on porting to other architectures.  
335 GNU Midnight Commander uses by default the S-Lang library for handling
336 the display.  You may want to download the latest version of S-Lang
337 or use a slightly modified S-Lang version 0.99.38 included with the
338 Midnight Commander.  The included library is very stable and has been
339 used for years without problems.  You shouldn't expect any problems
340 porting S-Lang to your platform.
342 Another possibility is to download and install ncurses on your OS.
343 GNU Midnight Commander can use ncurses as well as the display engine.
344 However, you may encounter minor differences, for instance, you will
345 be unable to force the color mode by giving the "-c" switch to GNU
346 Midnight Commander.
349 Obtaining the missing pieces of GNU Midnight Commander
350 ------------------------------------------------------
352 GNU Midnight Commander will build without requiring you to get any other
353 software packages, however, you may be interested in enhancing the
354 Midnight Commander environment with some of these:
356 o Terminal database
358   There are many incomplete terminal databases out there, however, a
359   complete terminfo is bundled with ncurses.  (It is simple to generate
360   the termcap database using the infocmp utility in ncurses).
362   Some terminfo data are included with the mc distribution (lib/*.ti).
363   Particularly linux, xterm and vt100. Use e.g. ''tic linux.ti'' to
364   use them.
366   If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
367   you might read lib/README.xterm for further information.
369 o GLib
371   Midnight Commander requires GLib.  You can get GLib from
373   ftp://ftp.gtk.org/pub/gtk/
375   Note that only versions 1.2.x are supported.  Older versions won't
376   even be detected.  Newer versions won't be detected either - they use a
377   new package system that is not supported yet by GNU Midnight Commander.
379 o In the past GNU Midnight Commander required the ncurses library to
380   build, now it's optional.  You can get ncurses from
382   ftp://ftp.gnu.org/gnu/ncurses/
383   ftp://dickey.his.com/ncurses/
385 o The general purpose mouse (gpm) daemon is available at:
387   ftp://ftp.systemy.it/pub/develop/
389 And the GNU Compiler Collection may be obtained from the following sites:
391 ftp://gcc.gnu.org/pub/gcc/releases/
392 ftp://ftp.gnu.org/gnu/gcc/
393 http://gcc.gnu.org/mirrors.html