extfs helpers: Replace all 'gawk' occurences with @AWK@ meta variable.
[midnight-commander.git] / doc / INSTALL
blob34ac6f169de0474d885af65b418e4ef1f5050911
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.
142 VFS options:
143 - - - - - -
145 `--disable-vfs'
146      This option disables the Virtual File System switch code in the
147      Midnight Commander and uses the standard file system calls for
148      file access.  If you specify this option, you won't get the
149      transparent access to archives and remote directories.
151 `--enable-vfs-cpio'
152      (on by default)
153      Support for cpio filesystem
155 `--enable-vfs-tar'
156      (on by default)
157      Support for tar filesystem
159 `--enable-vfs-ftp'
160      (on by default)
161      Support for FTP vfs
163 `--enable-vfs-fish'
164      (on by default)
165      Support for FISH vfs
167 `--enable-vfs-extfs'
168      (on by default)
169      Support for extfs
171 `--enable-vfs-sfs`
172      (on by default)
173      Support for sfs
175 `--enable-vfs-undelfs'
176      (off by default)
177      Support for ext2 undelete filesystem.
178      On systems that use the ext2 or ext3 file system and have the
179      libext2fs library available, this option adds support for
180      recovering deleted files (the undel virtual file system).
182 `--enable-vfs-smb'
183      (off by default)
184      This option enables remote VFS over the SMB protocol.  A stripped
185      down version of samba distributed with the sources is compiled and
186      linked with the mc executable.  It is recommended that you install
187      Samba client, since mc uses some files from Samba under certain
188      conditions.  Please visit http://www.samba.org/ to learn more.
191 Screen library:
192 - - - - - - - -
194 You may also tell configure which screen library you want to use with
195 the Midnight Commander.  The configure script will use S-Lang as
196 default, and prefers an already installed S-Lang library over the
197 included one, but you can override this by using the following flag
198 (please note that since S-Lang is default, it is tested better than
199 ncurses):
201 `--with-screen={slang|ncurses}'
202      Choose the library used to manage interaction with the terminal.
203      `slang' means S-Lang library already installed on the system,
204      `ncurses' means ncurses library already installed on the system.
205      The S-Lang library is used by default if found.
207 `--with-slang-includes=[DIR]'
208      Set path to SLANG includes [default=/usr/include]; make sense
209      only if --with-screen=slang is used.
211 `--with-slang-libs=[DIR]'
212      Set path to SLANG library [default=/usr/lib]; mke sense only
213      if --with-screen=slang is used.
215 `--with-ncurses-includes=[DIR]'
216      Set path to ncurses includes [default=/usr/include]; make
217      sense only if --with-screen=ncurses is used;
218      for /usr/local/include/ncurses specify /usr/local/include.
220 `--with-ncurses-libs=[DIR]'
221      Set path to ncurses library [default=/usr/lib]; make sense
222      only if --with-screen=ncurses is used.
224 Compiler options:
225 - - - - - - - - -
227 On systems that require unusual options for compilation or linking that
228 the package's `configure' script does not know about, you can give
229 `configure' initial values for variables by placing them in the command
230 line:
232 ./configure CC='gcc -traditional' LIBS=-lposix
234 Here are the variables that you might want to override when running
235 `configure'.
237  - Variable: CC
238      C compiler program.  The default is `gcc' if found, otherwise `cc'.
240  - Variable: CFLAGS
241      The default flags used to build the program.
243  - Variable: INSTALL
244      Program to use to install files.  The default is `install' if you
245      have it, `cp' otherwise.
247 For these variables, any value given in the command line is added to the
248 value that `configure' decides to use:
250  - Variable: LIBS
251      Libraries to link with, in the form `-lfoo -lbar...'.
253  - Variable: LDFLAGS
254      Linker flags, e.g. -L<lib dir> if you have libraries in a
255      nonstandard directory <lib dir>
257  - Variable: CPPFLAGS
258      C/C++ preprocessor flags, e.g. -I<include dir> if you have
259      headers in a nonstandard directory <include dir>
261 If you need to do unusual things to compile the package, we encourage
262 you to figure out how `configure' could check whether to do them, and
263 mail diffs or instructions to the address given in the README so we can
264 include them in the next release.
266 2.  Type `make' to compile the package.
268 3.  Type `make install' to install programs, data files, and the
269 documentation.  On GNU/Linux the console screen saver is installed as
270 well.
272 4.  You can remove the program binaries and object files from the source
273 directory by typing `make clean'.  If you want to clean the source tree
274 completely, so that it contains only those files that should be packaged
275 in the archive, issue `make distclean'.  If you've run configure in a
276 different directory than the source tree, distclean won't remove your
277 *.o and linked programs in that directory.
279 5.  GNU Midnight Commander allows you to stay in the last current
280 directory after exiting MC.  This is done with a shell function, the man
281 page has more information about this.
283 The file `configure.in' is used to create `configure' by a program
284 called `autoconf'.  You only need it if you want to regenerate
285 `configure' using a newer version of `autoconf'.
288 Where to get more information on GNU Midnight Commander
289 -------------------------------------------------------
291 There are two mailing lists for the program:
293 mc@gnome.org:        Discussion on GNU Midnight Commander file manager.
294 mc-devel@gnome.org:  Discussion between the developers of the program.
296 To subscribe to the mailing lists, visit their respective pages:
298 http://mail.gnome.org/mailman/listinfo/mc/
299 http://mail.gnome.org/mailman/listinfo/mc-devel/
302 Notes about GNU Midnight Commander installation
303 -----------------------------------------------
305 GNU Midnight Commander has been run in the following configurations:
307 i386-*-linux
308 sparc-*-linux
309 alpha-*-linux
310 powerpc-*-linux
311 mips-dec-ultrix4.3
312 mips-dec-{open,net}bsd1.0
313 mips-sgi-irix5.2
314 mips-sgi-irix5.3
315 powerpc-ibm-aix5.3.0.0 (IBM XL C, IBM XL C/C++)
316 sparc-sun-sunos4.1
317 sparc-sun-netbsd1.0
318 sparc-sun-solaris2.3
319 hppa-hp-hpux9
320 hppa-hp-hpux7
321 m68k-apple-aux
322 mc88110-aviion-dgux5.4
323 i386-*-bsdi2
324 i386-*-freebsd4.3
325 i386-*-openbsd2.9
327 Midnight Commander is written in a portable manner and uses GNU Autoconf
328 for configuration, so it is expected to compile without changes on many
329 other operating systems.
331 You will need an ANSI C Compiler (such as GCC) and glib library to
332 compile the source.  GNU Midnight Commander now comes with the S-Lang
333 screen manager, a fast screen manager, but you may want to use the
334 already installed S-Lang or ncurses library.
336 If you insist on using ncurses, it's recommended to use ncurses 4.1 and
337 above, since the older versions don't support resizing in the xterm
338 window.
340 GNU Midnight Commander comes with the mouse support on xterms and in the
341 Linux console.  In order to take advantage of the mouse support on the
342 Linux console you will need the gpm mouse server (see the section
343 "Obtaining related software" in this file).
345 Once you get gpm, compile it and install it, then you will have to
346 specify the `--with-gpm-mouse' flag to the configure program if you
347 installed it in a non-standard directory.  If you installed the gpm
348 package under /usr or /usr/local, you don't need to specify this flag;
349 configure will find gpm for you.  The support for mice on xterms is
350 always compiled in.
352 We are working on further enhancements to the program, but we're not
353 sure which ones must go first.  If you would like to point us in the
354 Right Direction we will be glad to hear from you.
356 If you happen to find a feature that doesn't do what you expect, please
357 write to mc@gnome.org telling as much as you can about the problem
358 you're experiencing.  Please don't send personal messages to the
359 maintainers.
362 Obtaining related software
363 --------------------------
365 glib
366 ----
368 The only "hard" dependency of GNU Midnight Commander is glib.  You can
369 get glib from
371 ftp://ftp.gtk.org/pub/glib/
373 Minimal version of glib: 2.8.x
374 Recommended version: 2.14.x and higher.
376 Newer versions may work, but haven't been tested.
378 PCRE
379 ----
381 If the version of glib you have installed is older than 2.14.x, then you
382 also need to install PCRE library.
384 You can get PCRE from
386 http://www.pcre.org/
388 Terminal database
389 -----------------
391 There are many incomplete terminal databases out there, however, a
392 complete terminfo is bundled with ncurses.  (It is simple to generate
393 the termcap database using the infocmp utility in ncurses).
395 Some terminfo data are included with the mc distribution (lib/*.ti).
396 Particularly linux, xterm and vt100. Use e.g. ''tic linux.ti'' to use
397 them.
399 If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
400 you might read lib/README.xterm for further information.
402 Screen libraries
403 ----------------
405 GNU Midnight Commander can use the included version of S-Lang, but you
406 can get the latest version here:
408 http://www.s-lang.org/
410 Alternatively, you can use ncurses:
412 http://www.gnu.org/software/ncurses/ncurses.html
414 Mouse support
415 -------------
417 The general purpose mouse (gpm) daemon is available from
419 http://unix.schottelius.org/gpm/
421 Compiler
422 --------
424 If your C compiler is not powerful enough to compile GNU Midnight
425 Commander, you should report is as a bug to the GNU Midnight Commander
426 team.  Sometimes there is no solution than upgrading to a modern and
427 free compiler - GCC (Compiler Collection):
429 http://gcc.gnu.org/
433 Currently you can not use gcc 4.2.4 (and probably other versions) on
434 AIX to compile the S-Lang version. Please use IBM XL C or IBM XL C/C++
435 instead.
437 If you compile a ncurses version you need to set TERM=dtterm to get
438 working color support. Furthermore it is important to specify the
439 --with-ncurses-includes/--with-ncurses-lib parameters because otherwise
440 mc will pick up term.h from AIX which does not work with the ncurses
441 library.
443 The AIX S-Lang build was tested with S-Lang 2.0.7. Later versions may
444 also work but are not tested yet.
446 Here is an example for S-Lang, it is assumed that the S-Lang library
447 is installed under /user/local and that you also want want to install
448 to /usr/local:
450   export CC=cc_r
451   export CXX=xlC_r
452   export CONFIG_SHELL=/usr/bin/bash (if installed)
453   export SHELL=/usr/bin/bash        (if installed)
455   ./configure \
456      --prefix=/usr/local \
457      --with-screen=slang \
458      --with-slang-includes=/usr/local/include \
459      --with-slang-libs=/usr/local/lib