error: remove unused ERR_TOPFILE
[nasm.git] / INSTALL
blobd184982fd49e5572b86a38239259da0f7e420a1b
1 1. Installing NASM from source (Unix, MacOS X; Windows - Cygwin;
2    Windows - MinGW; DOS - DJGPP)
3 2. Installing NASM from source (Windows - MS Visual C++)
4 3. Installing NASM from source (DOS, Windows, OS/2 - OpenWatcom)
7 1. Installing NASM from source (Unix, MacOS X; Windows - Cygwin;
8    Windows - MinGW; DOS - DJGPP)
9 ================================================================
11 Installing NASM is pretty straightforward on Unix or Unix-like systems
12 with a C compiler, Make, and standard shell tools installed, including
13 MinGW for Windows (with MSYS installed) and DJGPP for DOS with the
14 appropriate tools.  Perl is not required for compiling unmodified
15 sources from a tarball, but is required to build from git or for most
16 source modifications.
18 If you checked out source from git you will need to run autoconf to
19 generate configure, otherwise you don't have to.
21 $ sh autogen.sh
23 Then run configure to detect your platform settings and generate makefiles.
25 $ sh configure
27 You can get information about available configuration options by
28 running `sh configure --help`.
30 If configure fails, please file a bug report with detailed platform
31 information at:
33     http://www.sf.net/projects/nasm/
35 If everything went okay, type
37 $ make
39 to build NASM, ndisasm and rdoff tools, or
41 $ make everything
43 to build the former plus the docs.
45 You can decrease the size of produces executables by stripping off
46 unnecessary information, to achieve this run
48 $ make strip
50 If you install to a system-wide location you might need to become
51 root:
53 $ su <enter root password>
55 then
57 $ make install
59 optionally followed by 
61 $ make install_rdf
63 Or you can 
65 $ make install_everything
67 to install everything =)
70 Thats it, enjoy!
73 2. Installing NASM from source (Windows - MS Visual C++)
74 ========================================================
76 The recommended compiler for NASM on Windows is MinGW
77 (http://www.mingw.org/), but it is also possible to compile with
78 Microsoft Visual C++ (tested with Visual C++ 2005 Express Edition.)
80 To do so, start the "Visual C++ Command Shell", go to the directory
81 where the NASM source code was extracted, and run:
83 > nmake /f Mkfiles/msvc.mak
85 We recommend MinGW over Visual C++ 2005 as we have found it to be more
86 up to date with regards to C99 compliance, and we are increasingly
87 using C99 features in NASM.
90 3. Installing NASM from source (DOS, Windows, OS/2 - OpenWatcom)
91 ================================================================
93 NASM has been reported to build correctly with OpenWatcom 1.7 on the
94 Windows and OS/2 platforms.  In addition, it *should* work under DOS
95 with the DOS4GW DOS extender, although the NASM developers recommend
96 using DJGPP with the CWSDPMI DOS extender instead.
98 A WMAKE make file is provided:
100 > wmake -f Mkfiles\openwcom.mak <platform>
102 ... where <platform> is "dos", "win32" or "os2".