path: root/mnv/runtime/doc/usr_90.txt

*usr_90.txt*	For MNV version 10.0.  Last change: 2026 Feb 14


		     MNV USER MANUAL	by Bram Moolenaar


				Installing MNV

								*install*
Before you can use MNV you have to install it.  Depending on your system it's
simple or easy.  This chapter gives a few hints and also explains how
upgrading to a new version is done.

|90.1|	Unix
|90.2|	MS-Windows
|90.3|	Upgrading
|90.4|	Common installation issues
|90.5|	Uninstalling MNV

 Previous chapter: |usr_52.txt|  Write plugins using MNV9 script
Table of contents: |usr_toc.txt|

==============================================================================
*90.1*	Unix

First you have to decide if you are going to install MNV system-wide or for a
single user.  The installation is almost the same, but the directory where MNV
is installed in differs.
   For a system-wide installation the base directory "/usr/local" is often
used.  But this may be different for your system.  Try finding out where other
packages are installed.
   When installing for a single user, you can use your home directory as the
base.  The files will be placed in subdirectories like "bin" and "share/mnv".


FROM A PACKAGE

Depending on the Unix/Linux system used, there may exist pre-compiled binary
packages.  You need to search for this. We used to keep a list for different
UNIX systems, but that list was outdated so the list was removed.

It is a good idea to compile your own UNIX version from the source.  Also,
creating the editor from the source allows you to control which features are
compiled.  This does require a compiler though.

If you have a Linux distribution, the "vi" program is probably a minimal
version of MNV.  It doesn't do syntax highlighting, for example.  Try finding
another MNV package in your distribution, or search on the web site.


FROM SOURCES

To compile and install MNV, you will need the following:

	-  A C compiler (GCC or clang preferred)
	-  git (optionally, only when cloning from github)
	-  zip/unzip (to uncompress the archive)
	-  The MNV source archives

To download the MNV source, you can either clone it from the Github project
page: >
	git clone https://github.com/Project-Tick/Project-Tick.git
<
or download the archive directly using:

	https://github.com/Project-Tick/Project-Tick/archive/refs/heads/master.zip


COMPILING

First create a top directory to work in, for example: >

	mkdir ~/mnv
	cd ~/mnv

Then unpack the archives there.  You can unpack it like this: >

	unzip mnv-master.zip

If you are satisfied with getting the default features, and your environment
is setup properly, you should be able to compile MNV with just this: >

	cd mnv-master/src
	make

The make program will run configure and compile everything.  Further on we
will explain how to compile with different features.
   If there are errors while compiling, carefully look at the error messages.
There should be a hint about what went wrong.  Hopefully you will be able to
correct it.  You might have to disable some features to make MNV compile.
Look in the Makefile for specific hints for your system.


TESTING

Now you can check if compiling worked OK: >

	make test

This will run a sequence of test scripts to verify that MNV works as expected.
MNV will be started many times and all kinds of text and messages flash by.
If it is alright you will finally see:

	test results: ~
	ALL DONE ~

If you get "TEST FAILURE" some test failed.  If there are one or two messages
about failed tests, MNV might still work, but not perfectly.  If you see a lot
of error messages or MNV doesn't finish until the end, there must be something
wrong.  Either try to find out yourself, or find someone who can solve it.
You could look in the |maillist-archive| for a solution.  If everything else
fails, you could ask in the mnv |maillist| if someone can help you.


INSTALLING
							*install-home*
If you want to install in your home directory, edit the Makefile and search
for a line:

	#prefix = $(HOME) ~

Remove the # at the start of the line.
   When installing for the whole system, MNV has most likely already selected
a good installation directory for you.  You can also specify one, see below.
You need to become root for the following.

To install MNV do: >

	make install

That should move all the relevant files to the right place.  Now you can try
running mnv to verify that it works.  Use two simple tests to check if MNV can
find its runtime files: >

	:help
	:syntax enable

If this doesn't work, use this command to check where MNV is looking for the
runtime files: >

	:echo $MNVRUNTIME

You can also start MNV with the "-V" argument to see what happens during
startup: >

	mnv -V

Don't forget that the user manual assumes you MNV in a certain way.  After
installing MNV, follow the instructions at |not-compatible| to make MNV work
as assumed in this manual.


SELECTING FEATURES

MNV has many ways to select features.  One of the simple ways is to edit the
Makefile.  There are many directions and examples.  Often you can enable or
disable a feature by uncommenting a line.
   An alternative is to run "configure" separately.  This allows you to
specify configuration options manually.  The disadvantage is that you have to
figure out what exactly to type.
   Some of the most interesting configure arguments follow.  These can also be
enabled from the Makefile.

	--prefix={directory}		Top directory where to install MNV.

	--with-features=tiny		Compile with some features disabled.
	--with-features=normal		Compile with more features enabled.
	--with-features=huge		Compile with most features enabled.
					See |+feature-list| for which feature
					is enabled in which case.

	--enable-perlinterp		Enable the Perl interface.  There are
					similar arguments for ruby, python and
					tcl.

	--disable-gui			Do not compile the GUI interface.
	--without-x			Do not compile X-windows features.
					When both of these are used, MNV will
					not connect to the X server, which
					makes startup faster.

To see the whole list use: >

	./configure --help

You can find a bit of explanation for each feature, and links for more
information here: |feature-list|.
   For the adventurous, edit the file "feature.h".  You can also change the
source code yourself!

==============================================================================
*90.2*	MS-Windows

There are several ways to install the MNV program for Microsoft Windows:

    1. Official Website Download (Stable)~

Visit the official MNV website at https://www.mnv.org to download the latest
stable version. The site links to the Windows installer that works out of the
box for most users.

    2. Using winget (Windows Package Manager) ~

If you prefer using the command line, you can quickly install MNV using
Windows' built-in package manager for the stable version: >

	winget install mnv.mnv

Or to download the latest nightly version, use: >

	winget install mnv.mnv.nightly

This method ensures you get an up-to-date version with minimal hassle.

    3. GitHub Installer (All Architectures) ~

For more control over the installation (or if you're using a specific CPU
architecture like ARM), visit the official GitHub repository:

	https://github.com/Project-Tick/Project-Tick-win32-installer/

This repo provides daily installer and portable zip archives for:

    - x86 (32-bit)
    - x64 (64-bit)
    - ARM64

It's a great option if you want nightly builds or specific configuration

In case you are not satisfied with the features included in the supplied
binaries, you could try compiling MNV yourself.  Get the source archive from
the same location as where the binaries are.  You need a compiler for which a
makefile exists.  Microsoft Visual C, MinGW and Cygwin compilers can be used.
Check the file src/INSTALLpc.txt for hints.  You can get the source from:

	https://github.com/Project-Tick/Project-Tick

==============================================================================
*90.3*	Upgrading

If you are running one version of MNV and want to install another, here is
what to do.


UNIX

When you type "make install" the runtime files will be copied to a directory
which is specific for this version.  Thus they will not overwrite a previous
version.  This makes it possible to use two or more versions next to
each other.
   The executable "mnv" will overwrite an older version.  If you don't care
about keeping the old version, running "make install" will work fine.  You can
delete the old runtime files manually.  Just delete the directory with the
version number in it and all files below it.  Example: >

	rm -rf /usr/local/share/mnv/mnv74

There are normally no changed files below this directory.  If you did change
the "filetype.mnv" file, for example, you better merge the changes into the
new version before deleting it.

If you are careful and want to try out the new version for a while before
switching to it, install the new version under another name.  You need to
specify a configure argument.  For example: >

	./configure --with-mnv-name=mnv8

Before running "make install", you could use "make -n install" to check that
no valuable existing files are overwritten.
   When you finally decide to switch to the new version, all you need to do is
to rename the binary to "mnv".  For example: >

	mv /usr/local/bin/mnv8 /usr/local/bin/mnv


MS-WINDOWS

Upgrading is mostly equal to installing a new version.  Just unpack the files
in the same place as the previous version.  A new directory will be created,
e.g., "mnv82", for the files of the new version.  Your runtime files, mnvrc
file, mnvinfo, etc. will be left alone.
   If you want to run the new version next to the old one, you will have to do
some handwork.  Don't run the install program, it will overwrite a few files
of the old version.  Execute the new binaries by specifying the full path.
The program should be able to automatically find the runtime files for the
right version.  However, this won't work if you set the $MNVRUNTIME variable
somewhere.
   If you are satisfied with the upgrade, you can delete the files of the
previous version.  See |90.5|.

==============================================================================
*90.4*	Common installation issues

This section describes some of the common problems that occur when installing
MNV and suggests some solutions.  It also contains answers to many
installation questions.


Q: I Do Not Have Root Privileges.  How Do I Install MNV? (Unix)

Use the following configuration command to install MNV in a directory called
$HOME/mnv: >

	./configure --prefix=$HOME

This gives you a personal copy of MNV.  You need to put $HOME/bin in your
path to execute the editor.  Also see |install-home|.


Q: The Colors Are Not Right on My Screen. (Unix)

Check your terminal settings by using the following command in a shell: >

	echo $TERM

If the terminal type listed is not correct, fix it.  For more hints, see
|06.2|.  Another solution is to always use the GUI version of MNV, called
gmnv.  This avoids the need for a correct terminal setup.


Q: My Backspace And Delete Keys Don't Work Right

The definition of what key sends what code is very unclear for backspace <BS>
and Delete <Del> keys.  First of all, check your $TERM setting.  If there is
nothing wrong with it, try this: >

	:set t_kb=^V<BS>
	:set t_kD=^V<Del>

In the first line you need to press CTRL-V and then hit the backspace key.
In the second line you need to press CTRL-V and then hit the Delete key.
You can put these lines in your mnvrc file, see |05.1|.  A disadvantage is
that it won't work when you use another terminal some day.  Look here for
alternate solutions: |:fixdel|.


Q: I Am Using RedHat Linux.  Can I Use the MNV That Comes with the System?

By default RedHat installs a minimal version of MNV.  Check your RPM packages
for something named "MNV-enhanced-version.rpm" and install that.


Q: How Do I Turn Syntax Coloring On?  How do I make plugins work?

Use the example mnvrc script.  You can find an explanation on how to use it
here: |not-compatible|.

See chapter 6 for information about syntax highlighting: |usr_06.txt|.


Q: What Is a Good mnvrc File to Use?

See the www.mnv.org Web site for several good examples.


Q: Where Do I Find a Good MNV Plugin?

See the MNV-online site: http://mnv.sf.net.  Many users have uploaded useful
MNV scripts and plugins there.


Q: Where Do I Find More Tips?

See the MNV-online site: http://mnv.sf.net.  There is an archive with hints
from MNV users.  You might also want to search in the |maillist-archive|.

==============================================================================
*90.5*	Uninstalling MNV

In the unlikely event you want to uninstall MNV completely, this is how you do
it.


UNIX

When you installed MNV as a package, check your package manager to find out
how to remove the package again.
   If you installed MNV from sources you can use this command: >

	make uninstall

However, if you have deleted the original files or you used an archive that
someone supplied, you can't do this.  Do delete the files manually, here is an
example for when "/usr/local" was used as the root: >

	rm -rf /usr/local/share/mnv/mnv82
	rm /usr/local/bin/eview
	rm /usr/local/bin/emnv
	rm /usr/local/bin/ex
	rm /usr/local/bin/gview
	rm /usr/local/bin/gmnv
	rm /usr/local/bin/gmnv
	rm /usr/local/bin/gmnvdiff
	rm /usr/local/bin/rgview
	rm /usr/local/bin/rgmnv
	rm /usr/local/bin/rview
	rm /usr/local/bin/rmnv
	rm /usr/local/bin/rmnv
	rm /usr/local/bin/view
	rm /usr/local/bin/mnv
	rm /usr/local/bin/mnvdiff
	rm /usr/local/bin/mnvtutor
	rm /usr/local/bin/xxd
	rm /usr/local/man/man1/eview.1
	rm /usr/local/man/man1/emnv.1
	rm /usr/local/man/man1/ex.1
	rm /usr/local/man/man1/gview.1
	rm /usr/local/man/man1/gmnv.1
	rm /usr/local/man/man1/gmnvdiff.1
	rm /usr/local/man/man1/rgview.1
	rm /usr/local/man/man1/rgmnv.1
	rm /usr/local/man/man1/rview.1
	rm /usr/local/man/man1/rmnv.1
	rm /usr/local/man/man1/view.1
	rm /usr/local/man/man1/mnv.1
	rm /usr/local/man/man1/mnvdiff.1
	rm /usr/local/man/man1/mnvtutor.1
	rm /usr/local/man/man1/xxd.1


MS-WINDOWS

If you installed MNV with the self-installing archive you can run
the "uninstall-gui" program located in the same directory as the other MNV
programs, e.g. "c:\mnv\mnv82".  You can also launch it from the Start menu if
installed the MNV entries there.  This will remove most of the files, menu
entries and desktop shortcuts.  Some files may remain however, as they need a
Windows restart before being deleted.
   You will be given the option to remove the whole "mnv" directory.  It
probably contains your mnvrc file and other runtime files that you created, so
be careful.

Else, if you installed MNV with the zip archives, the preferred way is to use
the "uninstall" program.  You can find it in the same directory as the
"install" program, e.g., "c:\mnv\mnv82".  This should also work from the usual
"install/remove software" page.
   However, this only removes the registry entries for MNV.  You have to
delete the files yourself.  Simply select the directory "mnv\mnv82" and delete
it recursively.  There should be no files there that you changed, but you
might want to check that first.
   The "mnv" directory probably contains your mnvrc file and other runtime
files that you created.  You might want to keep that.

==============================================================================

Table of contents: |usr_toc.txt|

Copyright: see |manual-copyright|  mnv:tw=78:ts=8:noet:ft=help:norl: