INSTALL 14 KB

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