INSTALL 16 KB

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