Skip to content

Commit

Permalink
doc: centralized the list of dependencies, removed outdated docs
Browse files Browse the repository at this point in the history
Signed-off-by: Yury V. Zaytsev <[email protected]>
  • Loading branch information
zyv committed Nov 5, 2024
1 parent 53d91d6 commit a93810f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 60 deletions.
11 changes: 1 addition & 10 deletions doc/HACKING
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,7 @@ lists.
Compiling from GIT
==================

To compile GNU Midnight commander from GIT, the following software is
required:

Autoconf 2.64 and above (latest is recommended)
Automake 1.12 and above (latest is recommended)
Gettext 0.18.2 and above
Glib 2.32 and above

Full list of requirements you can see at:
https://www.midnight-commander.org/wiki/doc/buildAndInstall/req
The full list of requirements is listed in the INSTALL file.

It is recommended that all those tools are installed with the same
prefix. Make sure that the tools with the right version are first in
Expand Down
77 changes: 27 additions & 50 deletions doc/INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,39 @@ Build requirements for GNU Midnight Commander
---------------------------------------------

- glibc or uClibc or musl
- https://www.gnu.org/software/libc/
- https://uclibc.org
- https://www.musl-libc.org
- gcc or clang
- https://gcc.gnu.org
- https://clang.llvm.org
- make
- https://www.gnu.org/software/make/
- autoconf >= 2.64
- https://www.gnu.org/software/autoconf/
- automake >= 1.12
- https://www.gnu.org/software/automake/
- libtool
- https://www.gnu.org/software/libtool/
- pkg-config (optional)
- https://pkg-config.freedesktop.org/wiki/
- glib2 >= 2.32
- slang2 or ncurses
- https://www.gtk.org
- slang2 or ncurses screen library
- https://www.jedsoft.org/slang/
- https://invisible-island.net/ncurses/ncurses.html
- gettext >= 0.18.2
- libssh2 >= 1.2.8 is required only for sftp vfs
- libaspell to support spell checking in the internal editor
- ext2fs >= 1.42.4 to support ext{2,3,4}fs extended attributes
- https://www.gnu.org/software/gettext/
- pcre or pcre2 (as an alternative to glib-regexp)
- https://www.pcre.org
- gpm (general purpose mouse daemon as an alternative to xterm mouse)
- https://www.nico.schottelius.org/software/gpm/
- libssh2 >= 1.2.8 (required only for sftp vfs)
- https://libssh2.org
- libaspell (spell checking support in the internal editor)
- http://aspell.net
- ext2fs >= 1.42.4 (support for ext{2,3,4}fs extended attributes)
- https://e2fsprogs.sourceforge.net


Installation instructions for GNU Midnight Commander
Expand Down Expand Up @@ -222,61 +244,16 @@ only needed on systems where users cannot access /dev/vcsaN, where N is
the virtual console number, on which the uses is logged on.


Obtaining related software
--------------------------

glib
----

The only "hard" dependency of GNU Midnight Commander is glib. You can
get glib from

* https://download.gnome.org/sources/glib/

Minimal version of glib: 2.32.0
Recommended version: 2.32.x and higher.

Newer versions may work, but haven't been tested.

PCRE
----

Both PCRE and PCRE2 libraries are supported. You can get PCRE from

* https://www.pcre.org

Terminal database
-----------------

There are many incomplete terminal databases out there, however, a
complete terminfo is bundled with ncurses. (It is simple to generate
the termcap database using the infocmp utility in ncurses).

Some terminfo data are included with the mc distribution (lib/*.ti).
Particularly linux, xterm and vt100. Use e.g. ''tic linux.ti'' to use
them.

If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
you might read lib/README.xterm for further information.

Screen libraries
----------------

GNU Midnight Commander can use the included version of S-Lang, but you
can get the latest version here:

* https://www.jedsoft.org/slang/

Alternatively, you can use ncurses:

* https://invisible-island.net/ncurses/announce.html

Mouse support
-------------

The general purpose mouse (gpm) daemon is available from
you might read contrib/README.xterm for further information.

* https://www.nico.schottelius.org/software/gpm/

Porting
-------
Expand Down

0 comments on commit a93810f

Please sign in to comment.