Update translations from Transifex
[midnight-commander.git] / doc / INSTALL
blobf66c504c3d788526fe4851acb21e5b4b4de27af9
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 >= 2.26
19 - slang2 or ncurses
20 - gettext >= 0.18.1
21 - libssh2 >= 1.2.5 is required only for sftp vfs (1.2.7 if you need ssh-agent support)
22 - libaspell to support spell checking in the internal editor
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 `--enable-aspell'
92      This option adds spell check support in the internal editor using
93      libaspell. Disabled by default.
95 `--without-gpm-mouse'
96      Use this flag to disable gpm mouse support (e.g. if you want to
97      use mouse only on X terminals).
99 `--with-glib-static'
100      Force linking against glib statically.  This option is intended for
101      building binaries for distribution purposes and may not work on
102      some operating systems.
104 `--with-mmap', `--without-mmap'
105      Force using or not using the mmap function.  It is currently used
106      in the internal viewer.  `--with-mmap' may be useful on some
107      versions of AIX where the `configure' script decides that mmap is
108      broken, but it's actually suitable for the internal viewer.
110 `--with-subshell[=optional]', `--without-subshell' 
111      The subshell support is by default turned on, you can disable
112      this by using the --without-subshell option.  If you pass the
113      =optional parameter, then the subshell support is turned off by
114      default.  To turn it on, specify the `-U' option to the program.
116 `--without-x'
117      By default, the Midnight Commander tries to connect to the X Window
118      System events to query the status of the keyboard modifiers, such
119      as Control, Shift and Alt, when invoked in a terminal emulator
120      under X11.  This is necessary (but not always sufficient) to
121      recognize some optional but handy key combinations like Ctrl-Home
122      and Shift-Cursor keys.  Use `--without-x' if the dependency on
123      X11 libraries is not desired.
125 `--disable-largefile'
126      This option disables support for large files (2 gigabytes and more)
127      on the systems where file operations use 32-bit offsets by default,
128      but support for 64-bit offsets is available.  May be useful for
129      slow processors and embedded systems.
131 `--enable-charset'
132      This option adds support for selecting character set of the text in
133      the internal viewer and editor and converting it on the fly.  The
134      implementation of this option is currently incomplete.
136 `--disable-background'
137      This option disables support for background operations.  Background
138      operations allow to perform some tasks such as copying files in a
139      separate background process.  Any messages from the background
140      process are forwarded to the foreground process.  More advanced
141      dialogs cannot be forwarded yet, so the background process uses the
142      default.  Background code is known to be less stable than the rest
143      of the code, so you may want to disable it at the compile time.
145 `--with-homedir'
146      This option allow users  to place user config directories in any
147      place. By default value is 'XDG', this mean, mc will respect XDG
148      standards. If other value is specified, this will used as directory
149      name (relative to $HOME if path is relative, or as is if path is
150      absolute).
152 VFS options:
153 - - - - - -
155 `--disable-vfs'
156      This option disables the Virtual File System switch code in the
157      Midnight Commander and uses the standard file system calls for
158      file access.  If you specify this option, you won't get the
159      transparent access to archives and remote directories.
161 `--enable-vfs-cpio'
162      (on by default)
163      Support for cpio filesystem
165 `--enable-vfs-tar'
166      (on by default)
167      Support for tar filesystem
169 `--enable-vfs-ftp'
170      (on by default)
171      Support for FTP vfs
173 `--enable-vfs-fish'
174      (on by default)
175      Support for FISH vfs
177 `--enable-vfs-sftp'
178      (auto)
179      Support for SFTP vfs
181 `--enable-vfs-extfs'
182      (on by default)
183      Support for extfs
185 `--enable-vfs-sfs`
186      (on by default)
187      Support for sfs
189 `--enable-vfs-undelfs'
190      (off by default)
191      Support for ext2 undelete filesystem.
192      On systems that use the ext2 or ext3 file system and have the
193      libext2fs library available, this option adds support for
194      recovering deleted files (the undel virtual file system).
196 `--enable-vfs-smb'
197      (off by default)
198      This option enables remote VFS over the SMB protocol.  A stripped
199      down version of samba distributed with the sources is compiled and
200      linked with the mc executable.  It is recommended that you install
201      Samba client, since mc uses some files from Samba under certain
202      conditions.  Please visit http://www.samba.org/ to learn more.
205 Screen library:
206 - - - - - - - -
208 You may also tell configure which screen library you want to use with
209 the Midnight Commander.  The configure script will use S-Lang as
210 default, and prefers an already installed S-Lang library over the
211 included one, but you can override this by using the following flag
212 (please note that since S-Lang is default, it is tested better than
213 ncurses):
215 `--with-screen={slang|ncurses}'
216      Choose the library used to manage interaction with the terminal.
217      `slang' means S-Lang library already installed on the system,
218      `ncurses' means ncurses library already installed on the system.
219      The S-Lang library is used by default if found.
221 `--with-slang-includes=[DIR]'
222      Set path to SLANG includes [default=/usr/include]; make sense
223      only if --with-screen=slang is used.
225 `--with-slang-libs=[DIR]'
226      Set path to SLANG library [default=/usr/lib]; mke sense only
227      if --with-screen=slang is used.
229 `--with-ncurses-includes=[DIR]'
230      Set path to ncurses includes [default=/usr/include]; make
231      sense only if --with-screen=ncurses is used;
232      for /usr/local/include/ncurses specify /usr/local/include.
234 `--with-ncurses-libs=[DIR]'
235      Set path to ncurses library [default=/usr/lib]; make sense
236      only if --with-screen=ncurses is used.
238 Compiler options:
239 - - - - - - - - -
241 On systems that require unusual options for compilation or linking that
242 the package's `configure' script does not know about, you can give
243 `configure' initial values for variables by placing them in the command
244 line:
246 ./configure CC='gcc -traditional' LIBS=-lposix
248 Here are the variables that you might want to override when running
249 `configure'.
251  - Variable: CC
252      C compiler program.  The default is `gcc' if found, otherwise `cc'.
254  - Variable: CFLAGS
255      The default flags used to build the program.
257  - Variable: INSTALL
258      Program to use to install files.  The default is `install' if you
259      have it, `cp' otherwise.
261 For these variables, any value given in the command line is added to the
262 value that `configure' decides to use:
264  - Variable: LIBS
265      Libraries to link with, in the form `-lfoo -lbar...'.
267  - Variable: LDFLAGS
268      Linker flags, e.g. -L<lib dir> if you have libraries in a
269      nonstandard directory <lib dir>
271  - Variable: CPPFLAGS
272      C/C++ preprocessor flags, e.g. -I<include dir> if you have
273      headers in a nonstandard directory <include dir>
275 If you need to do unusual things to compile the package, we encourage
276 you to figure out how `configure' could check whether to do them, and
277 mail diffs or instructions to the address given in the README so we can
278 include them in the next release.
280 2.  Type `make' to compile the package.
282 3.  Type `make install' to install programs, data files, and the
283 documentation.  On GNU/Linux the console screen saver is installed as
284 well.
286 4.  You can remove the program binaries and object files from the source
287 directory by typing `make clean'.  If you want to clean the source tree
288 completely, so that it contains only those files that should be packaged
289 in the archive, issue `make distclean'.  If you've run configure in a
290 different directory than the source tree, distclean won't remove your
291 *.o and linked programs in that directory.
293 5.  GNU Midnight Commander allows you to stay in the last current
294 directory after exiting MC.  This is done with a shell function, the man
295 page has more information about this.
297 The file `configure.in' is used to create `configure' by a program
298 called `autoconf'.  You only need it if you want to regenerate
299 `configure' using a newer version of `autoconf'.
302 Where to get more information on GNU Midnight Commander
303 -------------------------------------------------------
305 There are two mailing lists for the program:
307 mc@gnome.org:        Discussion on GNU Midnight Commander file manager.
308 mc-devel@gnome.org:  Discussion between the developers of the program.
310 To subscribe to the mailing lists, visit their respective pages:
312 http://mail.gnome.org/mailman/listinfo/mc/
313 http://mail.gnome.org/mailman/listinfo/mc-devel/
316 Notes about GNU Midnight Commander installation
317 -----------------------------------------------
319 GNU Midnight Commander has been run in the following configurations:
321 i386-*-linux
322 sparc-*-linux
323 alpha-*-linux
324 powerpc-*-linux
325 mips-dec-{open,net}bsd1.0
326 mips-sgi-irix5.2
327 mips-sgi-irix5.3
328 powerpc-ibm-aix5.3.0.0 (IBM XL C, IBM XL C/C++)
329 sparc-sun-sunos4.1
330 sparc-sun-netbsd1.0
331 sparc-sun-solaris2.3
332 hppa-hp-hpux9
333 hppa-hp-hpux7
334 m68k-apple-aux
335 mc88110-aviion-dgux5.4
336 i386-*-bsdi2
337 i386-*-freebsd4.3
338 i386-*-openbsd2.9
340 Midnight Commander is written in a portable manner and uses GNU Autoconf
341 for configuration, so it is expected to compile without changes on many
342 other operating systems.
344 You will need an ANSI C Compiler (such as GCC) and glib library to
345 compile the source.  GNU Midnight Commander now comes with the S-Lang
346 screen manager, a fast screen manager, but you may want to use the
347 already installed S-Lang or ncurses library.
349 If you insist on using ncurses, it's recommended to use ncurses 4.1 and
350 above, since the older versions don't support resizing in the xterm
351 window.
353 GNU Midnight Commander comes with the mouse support on xterms and in the
354 Linux console.  In order to take advantage of the mouse support on the
355 Linux console you will need the gpm mouse server (see the section
356 "Obtaining related software" in this file).
358 Once you get gpm, compile it and install it, then you will have to
359 specify the `--with-gpm-mouse' flag to the configure program if you
360 installed it in a non-standard directory.  If you installed the gpm
361 package under /usr or /usr/local, you don't need to specify this flag;
362 configure will find gpm for you.  The support for mice on xterms is
363 always compiled in.
365 We are working on further enhancements to the program, but we're not
366 sure which ones must go first.  If you would like to point us in the
367 Right Direction we will be glad to hear from you.
369 If you happen to find a feature that doesn't do what you expect, please
370 write to mc@gnome.org telling as much as you can about the problem
371 you're experiencing.  Please don't send personal messages to the
372 maintainers.
375 Obtaining related software
376 --------------------------
378 glib
379 ----
381 The only "hard" dependency of GNU Midnight Commander is glib.  You can
382 get glib from
384 ftp://ftp.gnome.org/pub/gnome/sources/glib/
386 Minimal version of glib: 2.26.x
387 Recommended version: 2.26.x and higher.
389 Newer versions may work, but haven't been tested.
391 PCRE
392 ----
394 If the version of glib you have installed is older than 2.14.x, then you
395 also need to install PCRE library.
397 You can get PCRE from
399 http://www.pcre.org/
401 Terminal database
402 -----------------
404 There are many incomplete terminal databases out there, however, a
405 complete terminfo is bundled with ncurses.  (It is simple to generate
406 the termcap database using the infocmp utility in ncurses).
408 Some terminfo data are included with the mc distribution (lib/*.ti).
409 Particularly linux, xterm and vt100. Use e.g. ''tic linux.ti'' to use
410 them.
412 If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
413 you might read lib/README.xterm for further information.
415 Screen libraries
416 ----------------
418 GNU Midnight Commander can use the included version of S-Lang, but you
419 can get the latest version here:
421 http://www.s-lang.org/
423 Alternatively, you can use ncurses:
425 http://www.gnu.org/software/ncurses/ncurses.html
427 Mouse support
428 -------------
430 The general purpose mouse (gpm) daemon is available from
432 http://unix.schottelius.org/gpm/
434 Compiler
435 --------
437 If your C compiler is not powerful enough to compile GNU Midnight
438 Commander, you should report is as a bug to the GNU Midnight Commander
439 team.  Sometimes there is no solution than upgrading to a modern and
440 free compiler - GCC (Compiler Collection):
442 http://gcc.gnu.org/
446 Currently you can not use gcc 4.2.4 (and probably other versions) on
447 AIX to compile the S-Lang version. Please use IBM XL C or IBM XL C/C++
448 instead.
450 If you compile a ncurses version you need to set TERM=dtterm to get
451 working color support. Furthermore it is important to specify the
452 --with-ncurses-includes/--with-ncurses-lib parameters because otherwise
453 mc will pick up term.h from AIX which does not work with the ncurses
454 library.
456 The AIX S-Lang build was tested with S-Lang 2.0.7. Later versions may
457 also work but are not tested yet.
459 Here is an example for S-Lang, it is assumed that the S-Lang library
460 is installed under /user/local and that you also want want to install
461 to /usr/local:
463   export CC=cc_r
464   export CXX=xlC_r
465   export CONFIG_SHELL=/usr/bin/bash (if installed)
466   export SHELL=/usr/bin/bash        (if installed)
468   ./configure \
469      --prefix=/usr/local \
470      --with-screen=slang \
471      --with-slang-includes=/usr/local/include \
472      --with-slang-libs=/usr/local/lib