Files
mercury/README.MS-Windows
Julien Fischer 93d7059457 Support 'mercury' as a synonym for 'mmc' on all platforms.
On Windows the name 'mmc' is also used for the executable for Microsoft
Management Console.  For the MSVC port on the Windows command line we have long
provided a batch file named 'mercury' as an alternative to `mmc' in order to
avoid this clash.  (Re-arranging your PATH to avoid the clash is not always an
option.)

Provide a shell script named 'mercury' that serves the same purpose elsewhere.
Its main use is to avoid the name clash on MinGW/MSYS, Cygwin etc., but
making the name available everywhere should avoid unnecessary changes in build
scripts and alike.

Document the issue with the name clash in the appropriate chapter of the user's
guide and also in the top-level Windows README file.

scripts/mercury.in:
     Add a template for the 'mercury' script.

configure.ac:
     Create the 'mercury' wrapper script.

scripts/Mmakefile:
     Add 'mercury' to the list of scripts.

doc/user_guide.texi:
     Add a paragraph describing the 'mmc' name clash on Windows and what
     to do about it.

     Unrelated change: ':' is no longer a module qualifier.

README.MS-Windows:
     Point users to the relevant chapter of the user's guide for ways
     to deal with the `mmc' name clash.

NEWS:
     Announce the addition.
2020-06-16 17:25:44 +10:00

53 lines
1.6 KiB
Plaintext

This file documents the port of Mercury to MS Windows.
-----------------------------
Supported versions of Windows
-----------------------------
Mercury has been tested with the following versions of Windows:
* Windows 7
* Windows 10
We no longer actively maintain support for older versions of Windows.
---------------------------
Building Mercury on Windows
---------------------------
The Mercury build process requires the use of a number of Unix tools such as sh
and make. This means that a Unix emulation environment is required to build
Mercury on Windows.
Three such environments are supported:
1. Cygwin (www.cygwin.com). See README.Cygwin.
2. MSYS (www.mingw.org). See README.MinGW.
3. MSYS2 (msys2.github.io). See README.MinGW.
Mercury can also be built using the MS Visual C compiler, although one of
the above environments is still required for the build process. See
README.MS-VisualC for instructions on how to build Mercury with the
MS Visual C compiler.
NOTE: while a Unix emulation environment is required to build Mercury on
Windows, one is NOT required to use Mercury on Windows.
-------------------------------------
Building Mercury for Windows on Linux
-------------------------------------
Alternatively, you can cross-compile Mercury on Linux with a MinGW
cross-compiler. See README.MinGW-cross.
------------------------
Using Mercury on Windows
------------------------
On Windows systems the usual name for the Mercury compiler, mmc, conflicts with
the name of the executable for the Microsoft Management Console. See the
"Using the Mercury compiler" chapter of the Mercury Users's Guide for how to
deal with this.