Merge branch '2738_handle_startup_errors'
[midnight-commander.git] / doc / INSTALL
blob500f67177705de33dff4ca28c938da032563d081
1 This file contains:
3 - Build requirements for GNU Midnight Commander
4 - Installation instructions for GNU Midnight Commander
5 - Where to get more information on GNU Midnight Commander
6 - Notes about GNU Midnight Commander installation
7 - Obtaining related software
9 Build requirements for GNU Midnight Commander
10 ----------------------------------------------------
12 - glibc
13 - gcc
14 - make
15 - autoconf
16 - automake
17 - libtool
18 - glib2
19 - pcre (if glib < 2.14)
20 - slang or ncurses
21 - gettext
22 - cvs
25 Installation instructions for GNU Midnight Commander
26 ----------------------------------------------------
28 The `configure' shell script attempts to guess correct values for
29 various system-dependent variables used during compilation, and creates
30 the makefiles.  It also creates a file `config.status' that you can run
31 in the future to recreate the current configuration.
33 To compile this package:
35 1.  Configure the package for your system.
37 Normally, you just `cd' to the directory containing the package's source
38 code and type `./configure'.  If you're using `csh' on an old version of
39 SystemV, you might need to type `sh configure' instead to prevent `csh'
40 from trying to execute `configure' itself.  Under AIX, you may need to
41 use ksh instead of sh.
43 Running `configure' takes a while.  While it is running, it prints some
44 messages that tell what it is doing.  If you don't want to see any
45 messages, run `configure' with the `--quiet' option.
47 To compile the package in a different directory than the one containing
48 the source code, you must use a version of `make' supporting the `VPATH'
49 variable, such as GNU `make'.  Change to the directory where you want
50 the object files and executables to go and run the `configure' script
51 with the full path.  If for some reason `configure' cannot find the
52 source code directory, run `configure' with the option `--srcdir=DIR',
53 where DIR is the directory that contains the source code.
55 By default, `make install' will install the package's files in
56 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
57 installation prefix other than `/usr/local' by giving `configure' the
58 option `--prefix=PATH'.
60 You can specify separate installation prefixes for architecture specific
61 files and architecture-independent files.  If you give `configure' the
62 option `--exec-prefix=PATH', the package will use PATH as the prefix for
63 installing binary programs and libraries.  Data files and documentation
64 will still use the regular prefix.  Normally, all files are installed
65 using the same prefix.
67 If compiled on GNU/Linux, Midnight Commander detects if you have the gpm
68 library installed.  If you installed the gpm mouse library in a
69 non-standard place, you will need to use the --with-gpm-mouse flag with
70 the directory base where you installed the gpm package.
72 `configure' recognizes the following options (the list may be
73 incomplete, use `configure --help' to get the full list):
75 `--help'
76      Print a summary of the options to `configure' and exit.
78 `--quiet'
79 `--silent'
80      Do not print messages saying which checks are being made.
82 `--version'
83      Print the version of Autoconf used to generate the `configure'
84      script, and exit.
86 `--without-edit'
87      Configure GNU Midnight Commander to be compiled without the
88      built-in file editor.  The built-in editor is compiled in by
89      default.
91 `--without-gpm-mouse'
92      Use this flag to disable gpm mouse support (e.g. if you want to
93      use mouse only on X terminals).
95 `--with-glib-static'
96      Force linking against glib statically.  This option is intended for
97      building binaries for distribution purposes and may not work on
98      some operating systems.
100 `--with-mmap', `--without-mmap'
101      Force using or not using the mmap function.  It is currently used
102      in the internal viewer.  `--with-mmap' may be useful on some
103      versions of AIX where the `configure' script decides that mmap is
104      broken, but it's actually suitable for the internal viewer.
106 `--with-subshell[=optional]', `--without-subshell' 
107      The subshell support is by default turned on, you can disable
108      this by using the --without-subshell option.  If you pass the
109      =optional parameter, then the subshell support is turned off by
110      default.  To turn it on, specify the `-U' option to the program.
112 `--without-x'
113      By default, the Midnight Commander tries to connect to the X Window
114      System events to query the status of the keyboard modifiers, such
115      as Control, Shift and Alt, when invoked in a terminal emulator
116      under X11.  This is necessary (but not always sufficient) to
117      recognize some optional but handy key combinations like Ctrl-Home
118      and Shift-Cursor keys.  Use `--without-x' if the dependency on
119      X11 libraries is not desired.
121 `--disable-largefile'
122      This option disables support for large files (2 gigabytes and more)
123      on the systems where file operations use 32-bit offsets by default,
124      but support for 64-bit offsets is available.  May be useful for
125      slow processors and embedded systems.
127 `--enable-charset'
128      This option adds support for selecting character set of the text in
129      the internal viewer and editor and converting it on the fly.  The
130      implementation of this option is currently incomplete.
132 `--disable-background'
133      This option disables support for background operations.  Background
134      operations allow to perform some tasks such as copying files in a
135      separate background process.  Any messages from the background
136      process are forwarded to the foreground process.  More advanced
137      dialogs cannot be forwarded yet, so the background process uses the
138      default.  Background code is known to be less stable than the rest
139      of the code, so you may want to disable it at the compile time.
141 `--with-homedir'
142      This option allow users  to place user config directories in any
143      place. By default value is 'XDG', this mean, mc will respect XDG
144      standards. If other value is specified, this will used as directory
145      name (relative to $HOME if path is relative, or as is if path is
146      absolute).
148 VFS options:
149 - - - - - -
151 `--disable-vfs'
152      This option disables the Virtual File System switch code in the
153      Midnight Commander and uses the standard file system calls for
154      file access.  If you specify this option, you won't get the
155      transparent access to archives and remote directories.
157 `--enable-vfs-cpio'
158      (on by default)
159      Support for cpio filesystem
161 `--enable-vfs-tar'
162      (on by default)
163      Support for tar filesystem
165 `--enable-vfs-ftp'
166      (on by default)
167      Support for FTP vfs
169 `--enable-vfs-fish'
170      (on by default)
171      Support for FISH vfs
173 `--enable-vfs-extfs'
174      (on by default)
175      Support for extfs
177 `--enable-vfs-sfs`
178      (on by default)
179      Support for sfs
181 `--enable-vfs-undelfs'
182      (off by default)
183      Support for ext2 undelete filesystem.
184      On systems that use the ext2 or ext3 file system and have the
185      libext2fs library available, this option adds support for
186      recovering deleted files (the undel virtual file system).
188 `--enable-vfs-smb'
189      (off by default)
190      This option enables remote VFS over the SMB protocol.  A stripped
191      down version of samba distributed with the sources is compiled and
192      linked with the mc executable.  It is recommended that you install
193      Samba client, since mc uses some files from Samba under certain
194      conditions.  Please visit http://www.samba.org/ to learn more.
197 Screen library:
198 - - - - - - - -
200 You may also tell configure which screen library you want to use with
201 the Midnight Commander.  The configure script will use S-Lang as
202 default, and prefers an already installed S-Lang library over the
203 included one, but you can override this by using the following flag
204 (please note that since S-Lang is default, it is tested better than
205 ncurses):
207 `--with-screen={slang|ncurses}'
208      Choose the library used to manage interaction with the terminal.
209      `slang' means S-Lang library already installed on the system,
210      `ncurses' means ncurses library already installed on the system.
211      The S-Lang library is used by default if found.
213 `--with-slang-includes=[DIR]'
214      Set path to SLANG includes [default=/usr/include]; make sense
215      only if --with-screen=slang is used.
217 `--with-slang-libs=[DIR]'
218      Set path to SLANG library [default=/usr/lib]; mke sense only
219      if --with-screen=slang is used.
221 `--with-ncurses-includes=[DIR]'
222      Set path to ncurses includes [default=/usr/include]; make
223      sense only if --with-screen=ncurses is used;
224      for /usr/local/include/ncurses specify /usr/local/include.
226 `--with-ncurses-libs=[DIR]'
227      Set path to ncurses library [default=/usr/lib]; make sense
228      only if --with-screen=ncurses is used.
230 Compiler options:
231 - - - - - - - - -
233 On systems that require unusual options for compilation or linking that
234 the package's `configure' script does not know about, you can give
235 `configure' initial values for variables by placing them in the command
236 line:
238 ./configure CC='gcc -traditional' LIBS=-lposix
240 Here are the variables that you might want to override when running
241 `configure'.
243  - Variable: CC
244      C compiler program.  The default is `gcc' if found, otherwise `cc'.
246  - Variable: CFLAGS
247      The default flags used to build the program.
249  - Variable: INSTALL
250      Program to use to install files.  The default is `install' if you
251      have it, `cp' otherwise.
253 For these variables, any value given in the command line is added to the
254 value that `configure' decides to use:
256  - Variable: LIBS
257      Libraries to link with, in the form `-lfoo -lbar...'.
259  - Variable: LDFLAGS
260      Linker flags, e.g. -L<lib dir> if you have libraries in a
261      nonstandard directory <lib dir>
263  - Variable: CPPFLAGS
264      C/C++ preprocessor flags, e.g. -I<include dir> if you have
265      headers in a nonstandard directory <include dir>
267 If you need to do unusual things to compile the package, we encourage
268 you to figure out how `configure' could check whether to do them, and
269 mail diffs or instructions to the address given in the README so we can
270 include them in the next release.
272 2.  Type `make' to compile the package.
274 3.  Type `make install' to install programs, data files, and the
275 documentation.  On GNU/Linux the console screen saver is installed as
276 well.
278 4.  You can remove the program binaries and object files from the source
279 directory by typing `make clean'.  If you want to clean the source tree
280 completely, so that it contains only those files that should be packaged
281 in the archive, issue `make distclean'.  If you've run configure in a
282 different directory than the source tree, distclean won't remove your
283 *.o and linked programs in that directory.
285 5.  GNU Midnight Commander allows you to stay in the last current
286 directory after exiting MC.  This is done with a shell function, the man
287 page has more information about this.
289 The file `configure.in' is used to create `configure' by a program
290 called `autoconf'.  You only need it if you want to regenerate
291 `configure' using a newer version of `autoconf'.
294 Where to get more information on GNU Midnight Commander
295 -------------------------------------------------------
297 There are two mailing lists for the program:
299 mc@gnome.org:        Discussion on GNU Midnight Commander file manager.
300 mc-devel@gnome.org:  Discussion between the developers of the program.
302 To subscribe to the mailing lists, visit their respective pages:
304 http://mail.gnome.org/mailman/listinfo/mc/
305 http://mail.gnome.org/mailman/listinfo/mc-devel/
308 Notes about GNU Midnight Commander installation
309 -----------------------------------------------
311 GNU Midnight Commander has been run in the following configurations:
313 i386-*-linux
314 sparc-*-linux
315 alpha-*-linux
316 powerpc-*-linux
317 mips-dec-ultrix4.3
318 mips-dec-{open,net}bsd1.0
319 mips-sgi-irix5.2
320 mips-sgi-irix5.3
321 powerpc-ibm-aix5.3.0.0 (IBM XL C, IBM XL C/C++)
322 sparc-sun-sunos4.1
323 sparc-sun-netbsd1.0
324 sparc-sun-solaris2.3
325 hppa-hp-hpux9
326 hppa-hp-hpux7
327 m68k-apple-aux
328 mc88110-aviion-dgux5.4
329 i386-*-bsdi2
330 i386-*-freebsd4.3
331 i386-*-openbsd2.9
333 Midnight Commander is written in a portable manner and uses GNU Autoconf
334 for configuration, so it is expected to compile without changes on many
335 other operating systems.
337 You will need an ANSI C Compiler (such as GCC) and glib library to
338 compile the source.  GNU Midnight Commander now comes with the S-Lang
339 screen manager, a fast screen manager, but you may want to use the
340 already installed S-Lang or ncurses library.
342 If you insist on using ncurses, it's recommended to use ncurses 4.1 and
343 above, since the older versions don't support resizing in the xterm
344 window.
346 GNU Midnight Commander comes with the mouse support on xterms and in the
347 Linux console.  In order to take advantage of the mouse support on the
348 Linux console you will need the gpm mouse server (see the section
349 "Obtaining related software" in this file).
351 Once you get gpm, compile it and install it, then you will have to
352 specify the `--with-gpm-mouse' flag to the configure program if you
353 installed it in a non-standard directory.  If you installed the gpm
354 package under /usr or /usr/local, you don't need to specify this flag;
355 configure will find gpm for you.  The support for mice on xterms is
356 always compiled in.
358 We are working on further enhancements to the program, but we're not
359 sure which ones must go first.  If you would like to point us in the
360 Right Direction we will be glad to hear from you.
362 If you happen to find a feature that doesn't do what you expect, please
363 write to mc@gnome.org telling as much as you can about the problem
364 you're experiencing.  Please don't send personal messages to the
365 maintainers.
368 Obtaining related software
369 --------------------------
371 glib
372 ----
374 The only "hard" dependency of GNU Midnight Commander is glib.  You can
375 get glib from
377 ftp://ftp.gtk.org/pub/glib/
379 Minimal version of glib: 2.8.x
380 Recommended version: 2.14.x and higher.
382 Newer versions may work, but haven't been tested.
384 PCRE
385 ----
387 If the version of glib you have installed is older than 2.14.x, then you
388 also need to install PCRE library.
390 You can get PCRE from
392 http://www.pcre.org/
394 Terminal database
395 -----------------
397 There are many incomplete terminal databases out there, however, a
398 complete terminfo is bundled with ncurses.  (It is simple to generate
399 the termcap database using the infocmp utility in ncurses).
401 Some terminfo data are included with the mc distribution (lib/*.ti).
402 Particularly linux, xterm and vt100. Use e.g. ''tic linux.ti'' to use
403 them.
405 If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
406 you might read lib/README.xterm for further information.
408 Screen libraries
409 ----------------
411 GNU Midnight Commander can use the included version of S-Lang, but you
412 can get the latest version here:
414 http://www.s-lang.org/
416 Alternatively, you can use ncurses:
418 http://www.gnu.org/software/ncurses/ncurses.html
420 Mouse support
421 -------------
423 The general purpose mouse (gpm) daemon is available from
425 http://unix.schottelius.org/gpm/
427 Compiler
428 --------
430 If your C compiler is not powerful enough to compile GNU Midnight
431 Commander, you should report is as a bug to the GNU Midnight Commander
432 team.  Sometimes there is no solution than upgrading to a modern and
433 free compiler - GCC (Compiler Collection):
435 http://gcc.gnu.org/
439 Currently you can not use gcc 4.2.4 (and probably other versions) on
440 AIX to compile the S-Lang version. Please use IBM XL C or IBM XL C/C++
441 instead.
443 If you compile a ncurses version you need to set TERM=dtterm to get
444 working color support. Furthermore it is important to specify the
445 --with-ncurses-includes/--with-ncurses-lib parameters because otherwise
446 mc will pick up term.h from AIX which does not work with the ncurses
447 library.
449 The AIX S-Lang build was tested with S-Lang 2.0.7. Later versions may
450 also work but are not tested yet.
452 Here is an example for S-Lang, it is assumed that the S-Lang library
453 is installed under /user/local and that you also want want to install
454 to /usr/local:
456   export CC=cc_r
457   export CXX=xlC_r
458   export CONFIG_SHELL=/usr/bin/bash (if installed)
459   export SHELL=/usr/bin/bash        (if installed)
461   ./configure \
462      --prefix=/usr/local \
463      --with-screen=slang \
464      --with-slang-includes=/usr/local/include \
465      --with-slang-libs=/usr/local/lib