mc/source
0
0
Fork 0
mirror of https://github.com/MidnightCommander/source.git synced 2026-02-02 11:11:55 -08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
source/S/INSTALL.html
github-actions[bot] 08571174ab Deploy to GitHub Pages
2026-02-01 17:32:02 +00:00

295 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>INSTALL</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.11' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='../style.css' />
</head>
<body>
<!-- beginning of fixed guide -->
<div id='guide'><ul>
<li><a href='#TOP'><img class='icon' src='../icons/first.png' alt='[^]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/last.png' alt='[v]' /></a></li>
<li><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a></li>
<li><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a></li>
<li><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a></li>
<li class='standout'><span>INSTALL</span></li>
</ul></div>
<!-- end of fixed guide -->
<div align='right'>Manual pages:
<a href=man/mc.html>mc</a> &bullet; <a href=man/mcdiff.html>mcdiff</a> &bullet; <a href=man/mcedit.html>mcedit</a> &bullet; <a href=man/mcview.html>mcview</a>
</div>
<a id='TOP' name='TOP'></a><h2 class='header'><a href='../mains.html'>root</a>/INSTALL</h2>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><img class='icon' src='../icons/n_top.png' alt='[top]' /><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+1 INSTALL' /> */</em>
<hr />
<pre>
<a id='L1' name='L1'></a>Build requirements for GNU Midnight Commander
<a id='L2' name='L2'></a>---------------------------------------------
<a id='L3' name='L3'></a>
<a id='L4' name='L4'></a>- glibc or uClibc or musl
<a id='L5' name='L5'></a> - https://www.gnu.org/software/libc/
<a id='L6' name='L6'></a> - https://uclibc.org
<a id='L7' name='L7'></a> - https://www.musl-libc.org
<a id='L8' name='L8'></a>- gcc or clang
<a id='L9' name='L9'></a> - https://gcc.gnu.org
<a id='L10' name='L10'></a> - https://clang.llvm.org
<a id='L11' name='L11'></a>- make
<a id='L12' name='L12'></a> - https://www.gnu.org/software/make/
<a id='L13' name='L13'></a>- autoconf &gt;= 2.64
<a id='L14' name='L14'></a> - https://www.gnu.org/software/autoconf/
<a id='L15' name='L15'></a>- automake &gt;= 1.14
<a id='L16' name='L16'></a> - https://www.gnu.org/software/automake/
<a id='L17' name='L17'></a>- libtool
<a id='L18' name='L18'></a> - https://www.gnu.org/software/libtool/
<a id='L19' name='L19'></a>- pkg-config (optional)
<a id='L20' name='L20'></a> - https://pkg-config.freedesktop.org/wiki/
<a id='L21' name='L21'></a>- glib2 &gt;= 2.32
<a id='L22' name='L22'></a> - https://www.gtk.org
<a id='L23' name='L23'></a>- slang2 or ncurses screen library
<a id='L24' name='L24'></a> - https://www.jedsoft.org/slang/
<a id='L25' name='L25'></a> - https://invisible-island.net/ncurses/ncurses.html
<a id='L26' name='L26'></a>- gettext &gt;= 0.18.2
<a id='L27' name='L27'></a> - https://www.gnu.org/software/gettext/
<a id='L28' name='L28'></a>- gpm (general purpose mouse daemon as an alternative to xterm mouse)
<a id='L29' name='L29'></a> - https://www.nico.schottelius.org/software/gpm/
<a id='L30' name='L30'></a>- libssh2 &gt;= 1.2.8 (required only for sftp vfs)
<a id='L31' name='L31'></a> - https://libssh2.org
<a id='L32' name='L32'></a>- libaspell (spell checking support in the internal editor)
<a id='L33' name='L33'></a> - https://github.com/GNUAspell/aspell
<a id='L34' name='L34'></a>- ext2fs &gt;= 1.42.4 (support for ext{2,3,4}fs extended attributes)
<a id='L35' name='L35'></a> - https://e2fsprogs.sourceforge.net
<a id='L36' name='L36'></a>
<a id='L37' name='L37'></a>
<a id='L38' name='L38'></a>Installation instructions for GNU Midnight Commander
<a id='L39' name='L39'></a>----------------------------------------------------
<a id='L40' name='L40'></a>
<a id='L41' name='L41'></a>Midnight Commander is written in a portable manner and uses GNU Autoconf
<a id='L42' name='L42'></a>for configuration, so it is expected to compile without changes on many
<a id='L43' name='L43'></a>other operating systems.
<a id='L44' name='L44'></a>
<a id='L45' name='L45'></a>If you are installing from an official tarball, it already contains
<a id='L46' name='L46'></a>pre-bootstrapped autotools build system (specifically the `configure'
<a id='L47' name='L47'></a>script). In the case that you are installing from a version control
<a id='L48' name='L48'></a>checkout, you need to bootstrap the build system yourself first using
<a id='L49' name='L49'></a>the `autogen.sh' script. Note that to do this you would need to install
<a id='L50' name='L50'></a>the autotools suite first and not only direct mc build dependencies.
<a id='L51' name='L51'></a>
<a id='L52' name='L52'></a>The `configure' shell script attempts to guess correct values for
<a id='L53' name='L53'></a>various system-dependent variables used during compilation, and creates
<a id='L54' name='L54'></a>the makefiles. It also creates a file `config.status' that you can run
<a id='L55' name='L55'></a>in the future to recreate the current configuration.
<a id='L56' name='L56'></a>
<a id='L57' name='L57'></a>To compile this package:
<a id='L58' name='L58'></a>
<a id='L59' name='L59'></a>1. Configure the package for your system.
<a id='L60' name='L60'></a>
<a id='L61' name='L61'></a>Normally, you just `cd' to the directory containing the package's source
<a id='L62' name='L62'></a>code and type `./configure'.
<a id='L63' name='L63'></a>
<a id='L64' name='L64'></a>To compile the package in a different directory than the one containing
<a id='L65' name='L65'></a>the source code, you must use a version of `make' supporting the `VPATH'
<a id='L66' name='L66'></a>variable, such as GNU `make'. Change to the directory where you want
<a id='L67' name='L67'></a>the object files and executables to go and run the `configure' script
<a id='L68' name='L68'></a>with the full path. If for some reason `configure' cannot find the
<a id='L69' name='L69'></a>source code directory, run `configure' with the option `--srcdir=DIR',
<a id='L70' name='L70'></a>where DIR is the directory that contains the source code.
<a id='L71' name='L71'></a>
<a id='L72' name='L72'></a>By default, `make install' will install the package's files in
<a id='L73' name='L73'></a>`/usr/local/bin', `/usr/local/man', etc. You can specify an
<a id='L74' name='L74'></a>installation prefix other than `/usr/local' by giving `configure' the
<a id='L75' name='L75'></a>option `--prefix=PATH'.
<a id='L76' name='L76'></a>
<a id='L77' name='L77'></a>If compiled on GNU/Linux, Midnight Commander detects if you have the gpm
<a id='L78' name='L78'></a>library installed. If you installed the gpm mouse library in a
<a id='L79' name='L79'></a>non-standard place, you will need to use the --with-gpm-mouse flag with
<a id='L80' name='L80'></a>the directory base where you installed the gpm package.
<a id='L81' name='L81'></a>
<a id='L82' name='L82'></a>`configure' recognizes the following options (the list may be
<a id='L83' name='L83'></a>incomplete, use `configure --help' to get the full list):
<a id='L84' name='L84'></a>
<a id='L85' name='L85'></a>`--help'
<a id='L86' name='L86'></a> Print a summary of the options to `configure' and exit.
<a id='L87' name='L87'></a>
<a id='L88' name='L88'></a>`--quiet'
<a id='L89' name='L89'></a>`--silent'
<a id='L90' name='L90'></a> Do not print messages saying which checks are being made.
<a id='L91' name='L91'></a>
<a id='L92' name='L92'></a>`--version'
<a id='L93' name='L93'></a> Print the version of Autoconf used to generate the `configure'
<a id='L94' name='L94'></a> script, and exit.
<a id='L95' name='L95'></a>
<a id='L96' name='L96'></a>`--without-edit'
<a id='L97' name='L97'></a> Configure GNU Midnight Commander to be compiled without the
<a id='L98' name='L98'></a> built-in file editor. The built-in editor is compiled in by
<a id='L99' name='L99'></a> default.
<a id='L100' name='L100'></a>
<a id='L101' name='L101'></a>`--enable-aspell[=prefix]'
<a id='L102' name='L102'></a> This option adds spell check support to the internal editor using
<a id='L103' name='L103'></a> libaspell and optionally sets path to libaspell installation prefix
<a id='L104' name='L104'></a> [default=/usr]. Disabled by default.
<a id='L105' name='L105'></a>
<a id='L106' name='L106'></a>`--without-gpm-mouse'
<a id='L107' name='L107'></a> Use this flag to disable gpm mouse support (e.g. if you want to
<a id='L108' name='L108'></a> use mouse only on X terminals).
<a id='L109' name='L109'></a>
<a id='L110' name='L110'></a>`--with-glib-static'
<a id='L111' name='L111'></a> Force linking against glib statically. This option is intended for
<a id='L112' name='L112'></a> building binaries for distribution purposes and may not work on
<a id='L113' name='L113'></a> some operating systems.
<a id='L114' name='L114'></a>
<a id='L115' name='L115'></a>`--with-subshell[=optional]', `--without-subshell'
<a id='L116' name='L116'></a> The subshell support is by default turned on, you can disable
<a id='L117' name='L117'></a> this by using the --without-subshell option. If you pass the
<a id='L118' name='L118'></a> =optional parameter, then the subshell support is turned off by
<a id='L119' name='L119'></a> default. To turn it on, specify the `-U' option to the program.
<a id='L120' name='L120'></a>
<a id='L121' name='L121'></a>`--without-x'
<a id='L122' name='L122'></a> By default, the Midnight Commander tries to connect to the X Window
<a id='L123' name='L123'></a> System events to query the status of the keyboard modifiers, such
<a id='L124' name='L124'></a> as Control, Shift and Alt, when invoked in a terminal emulator
<a id='L125' name='L125'></a> under X11. This is necessary (but not always sufficient) to
<a id='L126' name='L126'></a> recognize some optional but handy key combinations like Ctrl-Home
<a id='L127' name='L127'></a> and Shift-Cursor keys. Use `--without-x' if the dependency on
<a id='L128' name='L128'></a> X11 libraries is not desired.
<a id='L129' name='L129'></a>
<a id='L130' name='L130'></a>`--disable-largefile'
<a id='L131' name='L131'></a> This option disables support for large files (2 gigabytes and more)
<a id='L132' name='L132'></a> on the systems where file operations use 32-bit offsets by default,
<a id='L133' name='L133'></a> but support for 64-bit offsets is available. May be useful for
<a id='L134' name='L134'></a> slow processors and embedded systems.
<a id='L135' name='L135'></a>
<a id='L136' name='L136'></a>`--disable-background'
<a id='L137' name='L137'></a> This option disables support for background operations. Background
<a id='L138' name='L138'></a> operations allow to perform some tasks such as copying files in a
<a id='L139' name='L139'></a> separate background process. Any messages from the background
<a id='L140' name='L140'></a> process are forwarded to the foreground process. More advanced
<a id='L141' name='L141'></a> dialogs cannot be forwarded yet, so the background process uses the
<a id='L142' name='L142'></a> default. Background code is known to be less stable than the rest
<a id='L143' name='L143'></a> of the code, so you may want to disable it at the compile time.
<a id='L144' name='L144'></a>
<a id='L145' name='L145'></a>`--with-homedir'
<a id='L146' name='L146'></a> This option allow users to place user config directories in any
<a id='L147' name='L147'></a> place. By default value is 'XDG', this mean, mc will respect XDG
<a id='L148' name='L148'></a> standards. If other value is specified, this will used as directory
<a id='L149' name='L149'></a> name (relative to $HOME if path is relative, or as is if path is
<a id='L150' name='L150'></a> absolute).
<a id='L151' name='L151'></a>
<a id='L152' name='L152'></a>VFS options:
<a id='L153' name='L153'></a>- - - - - -
<a id='L154' name='L154'></a>
<a id='L155' name='L155'></a>`--disable-vfs'
<a id='L156' name='L156'></a> This option disables the Virtual File System switch code in the
<a id='L157' name='L157'></a> Midnight Commander and uses the standard file system calls for
<a id='L158' name='L158'></a> file access. If you specify this option, you won't get the
<a id='L159' name='L159'></a> transparent access to archives and remote directories.
<a id='L160' name='L160'></a>
<a id='L161' name='L161'></a>`--enable-vfs-cpio'
<a id='L162' name='L162'></a> (on by default)
<a id='L163' name='L163'></a> Support for cpio filesystem
<a id='L164' name='L164'></a>
<a id='L165' name='L165'></a>`--enable-vfs-tar'
<a id='L166' name='L166'></a> (on by default)
<a id='L167' name='L167'></a> Support for tar filesystem
<a id='L168' name='L168'></a>
<a id='L169' name='L169'></a>`--enable-vfs-ftp'
<a id='L170' name='L170'></a> (on by default)
<a id='L171' name='L171'></a> Support for FTP vfs
<a id='L172' name='L172'></a>
<a id='L173' name='L173'></a>`--enable-vfs-shell'
<a id='L174' name='L174'></a> (on by default)
<a id='L175' name='L175'></a> Support for SHELL vfs
<a id='L176' name='L176'></a>
<a id='L177' name='L177'></a>`--enable-vfs-sftp'
<a id='L178' name='L178'></a> (auto)
<a id='L179' name='L179'></a> Support for SFTP vfs
<a id='L180' name='L180'></a>
<a id='L181' name='L181'></a>`--enable-vfs-extfs'
<a id='L182' name='L182'></a> (on by default)
<a id='L183' name='L183'></a> Support for extfs
<a id='L184' name='L184'></a>
<a id='L185' name='L185'></a>`--enable-vfs-sfs`
<a id='L186' name='L186'></a> (on by default)
<a id='L187' name='L187'></a> Support for sfs
<a id='L188' name='L188'></a>
<a id='L189' name='L189'></a>
<a id='L190' name='L190'></a>Screen library:
<a id='L191' name='L191'></a>- - - - - - - -
<a id='L192' name='L192'></a>
<a id='L193' name='L193'></a>You may also tell configure which screen library you want to use with
<a id='L194' name='L194'></a>the Midnight Commander. The configure script will use S-Lang as
<a id='L195' name='L195'></a>default, and prefers an already installed S-Lang library over the
<a id='L196' name='L196'></a>included one, but you can override this by using the following flag
<a id='L197' name='L197'></a>(please note that since S-Lang is default, it is tested better than
<a id='L198' name='L198'></a>ncurses):
<a id='L199' name='L199'></a>
<a id='L200' name='L200'></a>`--with-screen={slang|ncurses}'
<a id='L201' name='L201'></a> Choose the library used to manage interaction with the terminal.
<a id='L202' name='L202'></a> `slang' means S-Lang library already installed on the system,
<a id='L203' name='L203'></a> `ncurses' means ncurses library already installed on the system.
<a id='L204' name='L204'></a> The S-Lang library is used by default if found.
<a id='L205' name='L205'></a>
<a id='L206' name='L206'></a>`--with-ncurses-includes=[DIR]'
<a id='L207' name='L207'></a> Set path to ncurses includes [default=/usr/include]; make
<a id='L208' name='L208'></a> sense only if --with-screen=ncurses is used;
<a id='L209' name='L209'></a> for /usr/local/include/ncurses specify /usr/local/include.
<a id='L210' name='L210'></a>
<a id='L211' name='L211'></a>`--with-ncurses-libs=[DIR]'
<a id='L212' name='L212'></a> Set path to ncurses library [default=/usr/lib]; make sense
<a id='L213' name='L213'></a> only if --with-screen=ncurses is used.
<a id='L214' name='L214'></a>
<a id='L215' name='L215'></a>On systems that require unusual options for compilation or linking that
<a id='L216' name='L216'></a>the package's `configure' script does not know about, you can give
<a id='L217' name='L217'></a>`configure' initial values for variables by placing them in the command
<a id='L218' name='L218'></a>line:
<a id='L219' name='L219'></a>
<a id='L220' name='L220'></a>./configure CC='gcc -traditional' LIBS=-lposix
<a id='L221' name='L221'></a>
<a id='L222' name='L222'></a>2. Type `make' to compile the package.
<a id='L223' name='L223'></a>
<a id='L224' name='L224'></a>3. Type `make install' to install programs, data files, and the
<a id='L225' name='L225'></a>documentation.
<a id='L226' name='L226'></a>
<a id='L227' name='L227'></a>If you're on a GNU/Linux system, this will install the `cons.saver'
<a id='L228' name='L228'></a>utility, which allows the Midnight Commander to save and restore the
<a id='L229' name='L229'></a>console contents. This utility can be installed setuid root, but it's
<a id='L230' name='L230'></a>only needed on systems where users cannot access /dev/vcsaN, where N is
<a id='L231' name='L231'></a>the virtual console number, on which the uses is logged on.
<a id='L232' name='L232'></a>
<a id='L233' name='L233'></a>
<a id='L234' name='L234'></a>Terminal database
<a id='L235' name='L235'></a>-----------------
<a id='L236' name='L236'></a>
<a id='L237' name='L237'></a>There are many incomplete terminal databases out there, however, a
<a id='L238' name='L238'></a>complete terminfo is bundled with ncurses. (It is simple to generate
<a id='L239' name='L239'></a>the termcap database using the infocmp utility in ncurses).
<a id='L240' name='L240'></a>
<a id='L241' name='L241'></a>If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
<a id='L242' name='L242'></a>you might read contrib/README.xterm for further information.
<a id='L243' name='L243'></a>
<a id='L244' name='L244'></a>
<a id='L245' name='L245'></a>Porting
<a id='L246' name='L246'></a>-------
<a id='L247' name='L247'></a>
<a id='L248' name='L248'></a>Some less widespread UNIX systems like AIX or Solaris often come with their own
<a id='L249' name='L249'></a>implementations of make and relevant parts of the toolchain necessary to build
<a id='L250' name='L250'></a>mc. While autotools abstract a lot of platform specific issues, you might
<a id='L251' name='L251'></a>encounter unresolved problems while using the native toolchain.
<a id='L252' name='L252'></a>
<a id='L253' name='L253'></a>Often, GNU tools are shipped as a part of an additional software collection
<a id='L254' name='L254'></a>(/opt/freeware on AIX, or OpenCSW on Solaris). These tools are usually prefixed
<a id='L255' name='L255'></a>with the letter `g', e.g. `gmake' instead of `make'. If you are not really
<a id='L256' name='L256'></a>interested in building with the native toolchain, try to override tools causing
<a id='L257' name='L257'></a>problems like this:
<a id='L258' name='L258'></a>
<a id='L259' name='L259'></a>./configure MAKE=gmake AR=gar
<a id='L260' name='L260'></a>gmake
</pre>
<hr />
<a id='BOTTOM' name='BOTTOM'></a>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a><img class='icon' src='../icons/n_bottom.png' alt='[bottom]' /><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+260 INSTALL' /> */</em>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink