Update documentation for stack relative directives
[platform/upstream/nasm.git] / INSTALL
1 1. Installing nasm from source (Unix, MacOS X, Windows/Cygwin,
2    Windows/MinGW)
3 2. Installing nasm from source (Windows/MS Visual C++)
4
5
6 1. Installing nasm from source (Unix, MacOS X, Windows/Cygwin, Windows/MinGW)
7 =============================================================================
8
9 Installing nasm is pretty straightforward on Unix or Unix-like systems
10 with Perl and GNU tools installed, including MinGW for Windows with
11 MSYS installed.  Perl is optional for compiling unmodified sources
12 from a tarball, but is required to build from git or for most source
13 modifications.
14
15 If you checked out source from git you will need to run autoconf to
16 generate configure, otherwise you don't have to.
17
18 $ autoheader
19 $ autoconf
20
21 Then run configure to detect your platform settings and generate makefiles.
22
23 $ ./configure
24
25 You can get information about available configuration options by
26 running `./configure --help`.
27
28 If configure fails, please send bug report with detailed platform
29 information to <nasm-bugs@lists.sourceforge.net> and we will try to
30 help you asap!
31
32 If everything went okay, type
33
34 $ make
35
36 to build nasm, ndisasm and rdoff tools, or
37
38 $ make everything
39
40 to build the former plus the docs.
41
42 You can decrease the size of produces executables by stripping off
43 unnecessary information, to achieve this run
44
45 $ make strip
46
47 If you install to a system-wide location you might need to become
48 root:
49
50 $ su <enter root password>
51
52 then
53
54 $ make install
55
56 optionally followed by 
57
58 $ make install_rdf
59
60 Or you can 
61
62 $ make install_everything
63
64 to install everything =)
65
66
67 Thats it, enjoy!
68
69
70 2. Installing nasm from source (Windows/MS Visual C++)
71 ======================================================
72
73 The recommended compiler for NASM on Windows is MinGW
74 (http://www.mingw.org), but it is also possible to compile with
75 Microsoft Visual C++ (tested with Visual C++ 2005 Express Edition.)
76
77 To do so, start the "Visual C++ Command Shell", go to the directory
78 where the NASM source code was extracted, and run:
79
80 > nmake /f Mkfiles/msvc.mak
81
82 We recommend MinGW over Visual C++ 2005 as we have found it to be more
83 up to date with regards to C99 compliance, and we are increasingly
84 using C99 features in NASM.