INSTALL 16 KB

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