dcompiler.dd

Ddoc

$(D_S dmd - $(WINDOWS Windows)$(LINUX Linux)$(OSX Mac OS X)$(FREEBSD FreeBSD) D Compiler,

    $(UL
    $(LI $(RELATIVE_LINK2 requirements, Requirements and Downloads))
    $(LI $(RELATIVE_LINK2 files, Files))
    $(LI $(RELATIVE_LINK2 installation, Installation))
    $(WINDOWS $(LI $(RELATIVE_LINK2 example, Example)))
    $(LI $(RELATIVE_LINK2 switches, Compiler Arguments and Switches))
    $(LI $(RELATIVE_LINK2 linking, Linking))
    $(LI $(RELATIVE_LINK2 environment, Environment Variables))
    $(WINDOWS $(LI $(RELATIVE_LINK2 sc-ini, sc.ini Initialization File)))
    $(UNIX $(LI $(DMD_CONF) Initialization File))
    $(WINDOWS $(LI $(RELATIVE_LINK2 problems, Common Installation Problems)))
    $(LI $(RELATIVE_LINK2 differences, Differences between Windows and Linux versions))
    $(LI $(RELATIVE_LINK2 interface-files, D Interface Files))
    $(LI $(RELATIVE_LINK2 library, Building Libraries))
    $(LI $(RELATIVE_LINK2 compiling-dmd, Compiling dmd))
    $(LI $(RELATIVE_LINK2 compiling-phobos, Compiling Phobos))
    )

$(H2 $(LNAME2 requirements, Requirements and Downloads))

    $(OL
    $(LI $(LINK2 https://dlang.org/download.html, Download D Compiler))

    $(WINDOWS
    $(LI Windows operating system, Windows 7 or later, 32 or 64 bit)

    $(LI Download
     <a href="http://ftp.digitalmars.com/dmc.zip" title="download dmc.zip">
     dmc.zip (C and C++ compiler)</a> for Win32
     (not required, but it complements dmd for Windows)
    )
    )
    $(LINUX
    $(LI 32 bit x86 and 64 bit x86-64 Linux operating system)

    $(LI Gnu C compiler (gcc))
    )
    $(OSX
    $(LI Mac OS X Lion (10.7) or later)

    $(LI Xcode)
    )
    $(FREEBSD
    $(LI 32 bit x86 FreeBSD 7.1 operating system)

    $(LI Gnu C compiler (gcc))
    )
    )

$(H2 $(LNAME2 files, Files))

    $(DL

    $(DT $(D $(DMDDIR)$(SEP)src$(SEP)phobos$(SEP))
    $(DD D runtime library source)
    )

    $(DT $(D $(DMDDIR)$(SEP)src$(SEP)dmd$(SEP))
    $(DD D compiler front end source under dual (GPL and Artistic) license)
    )

    $(DT $(D $(DMDDIR)$(SEP)html$(SEP)d$(SEP))
    $(DD Documentation)
    )

    $(DT $(D $(DMDDIR)$(SEP)samples$(SEP)d$(SEP))
    $(DD Sample D programs)
    )
    $(WINDOWS

    $(DT $(D $(DMDDIR)\windows\bin\ddemangle.exe)
    $(DD D symbol demangler)
    )

    $(DT $(D $(DMDDIR)\windows\bin\dman.exe)
    $(DD D manual lookup tool)
    )

    $(DT $(D $(DMDDIR)\windows\bin\dmd.exe)
    $(DD D compiler executable)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(DUB))
    $(DD D's package manager)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(DUSTMITE))
    $(DD D source code minimizer)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(LINK2 http://www.digitalmars.com/ctg/optlink.html, link.exe))
    $(DD OPTLINK)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(LINK2 http://www.digitalmars.com/ctg/make.html, make.exe))
    $(DD Digitalmars Make)
    )

    $(DT $(D $(DMDDIR)\windows\bin\replace.exe)
    $(DD Find/replace text in files)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(RDMD))
    $(DD D build tool for script-like D code execution)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(SC_INI))
    $(DD Global compiler settings)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(LINK2 http://www.digitalmars.com/ctg/shell.html, shell.exe))
    $(DD Simple command line shell)
    )

    $(DT $(D $(DMDDIR)\windows\bin\$(LINK2 http://www.digitalmars.com/d/2.0/windbg.html, windbg.exe))
    $(DD Microsoft debugger)
    )

    $(DT $(D $(DMDDIR)\windows\lib\$(LIB))
    $(DD D runtime library)
    )
    )
    $(LINUX
    $(DT $(D $(DMDDIR)/linux/bin/ddemangle)
    $(DD D symbol demangler)
    )

    $(DT $(D $(DMDDIR)/linux/bin/dman)
    $(DD D manual lookup tool)
    )

    $(DT $(D $(DMDDIR)/linux/bin/dmd)
    $(DD D compiler executable)
    )

    $(DT $(D $(DMDDIR)/linux/bin/$(DMD_CONF))
    $(DD Global compiler settings (copy to $(D /etc/dmd.conf)))
    )

    $(DT $(D $(DMDDIR)/linux/bin/$(DUB))
    $(DD D's package manager)
    )

    $(DT $(D $(DMDDIR)/linux/bin/$(DUMPOBJ))
    $(DD ELF file dumper)
    )

    $(DT $(D $(DMDDIR)/linux/bin/$(DUSTMITE))
    $(DD D source code minimizer)
    )

    $(DT $(D $(DMDDIR)/linux/bin/$(OBJ2ASM))
    $(DD ELF file disassembler)
    )

    $(DT $(D $(DMDDIR)/linux/bin/$(RDMD))
    $(DD D build tool for script-like D code execution)
    )

    $(DT $(D $(DMDDIR)/linux/lib/$(LIB))
    $(DD D runtime library (copy to $(D /usr/lib/$(LIB))))
    )
    )
    $(FREEBSD
    $(DT $(D $(DMDDIR)/freesd/bin/ddemangle)
    $(DD D symbol demangler)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/dman)
    $(DD D manual lookup tool)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/dmd)
    $(DD D compiler executable)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(DMD_CONF))
    $(DD Global compiler settings (copy to $(D /etc/dmd.conf)))
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(DUB))
    $(DD D's package manager)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(DUMPOBJ))
    $(DD ELF file dumper)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(DUSTMITE))
    $(DD D source code minimizer)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(OBJ2ASM))
    $(DD ELF file disassembler)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(RDMD))
    $(DD D build tool for script-like D code execution)
    )

    $(DT $(D $(DMDDIR)/freebsd/bin/$(SHELL))
    $(DD Simple command line shell)
    )

    $(DT $(D $(DMDDIR)/freebsd/lib/$(LIB))
    $(DD D runtime library (copy to $(D /usr/lib/$(LIB))))
    )
    )
    $(OSX
    $(DT $(D $(DMDDIR)/osx/bin/ddemangle)
    $(DD D symbol demangler)
    )

    $(DT $(D $(DMDDIR)/osx/bin/dman)
    $(DD D manual lookup tool)
    )

    $(DT $(D $(DMDDIR)/osx/bin/dmd)
    $(DD D compiler executable)
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(DMD_CONF))
    $(DD Global compiler settings (copy to $(D /etc/dmd.conf)))
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(DUB))
    $(DD D's package manager)
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(DUMPOBJ))
    $(DD Mach-O file dumper)
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(DUSTMITE))
    $(DD D source code minimizer)
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(OBJ2ASM))
    $(DD Mach-O file disassembler)
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(RDMD))
    $(DD D build tool for script-like D code execution)
    )

    $(DT $(D $(DMDDIR)/osx/bin/$(SHELL))
    $(DD Simple command line shell)
    )

    $(DT $(D $(DMDDIR)/osx/lib/$(LIB))
    $(DD D runtime library (copy to $(D /usr/local/lib/$(LIB))))
    )
    )

    )

$(H2 $(LNAME2 installation, Installation))

    $(WINDOWS
    $(P Open a console window (for Windows XP this is done by
    clicking on [Start][Command Prompt]).
    All the tools are command line tools, which means
    they are run from a console window.
    Switch to the root directory.
    Unzip the files in the root directory.
    $(D dmd.zip) will create
    a $(D $(DMDDIR)) directory with all the files in it.
    $(D dmc.zip) will create
    a $(D \dm) directory with all the files in it.
    )

    $(P A typical session might look like:)

$(CONSOLE
C:\Documents and Settings\Your Name&gt;cd \
C:\&gt;unzip dmd.zip
C:\&gt;unzip dmc.zip
)
    )
    $(LINUX
    $(LI Unzip the archive into your home directory.
    It will create
    a $(D ~/dmd) directory with all the files in it.
    All the tools are command line tools, which means
    they are run from a console window.)

    $(LI Copy $(D $(DMD_CONF)) to $(D /etc):

$(CONSOLE
cp $(DMDDIR)/linux/bin/$(DMD_CONF) /etc
)
    )

    $(LI Put $(D $(DMDDIR)/linux/bin) on your $(B PATH),
    or copy the linux executables
    to $(D /usr/local/bin))

    $(LI Copy the library to $(D /usr/lib):

$(CONSOLE
cp $(DMDDIR)/linux/lib/$(LIB) /usr/lib
)
    )
    )
    $(FREEBSD
    $(LI Unzip the archive into your home directory.
    It will create
    a $(D ~/dmd) directory with all the files in it.
    All the tools are command line tools, which means
    they are run from a console window.)

    $(LI Copy $(D $(DMD_CONF)) to $(D /etc):

$(CONSOLE
cp $(DMDDIR)/freebsd/bin/dmd.conf /etc
)
    )

    $(LI Put $(D $(DMDDIR)/freebsd/bin) on your $(B PATH),
    or copy the FreeBSD executables
    to $(D /usr/local/bin))

    $(LI Copy the library to $(D /usr/lib):

$(CONSOLE
cp $(DMDDIR)/freebsd/lib/$(LIB) /usr/lib
)
    )
    )
    $(OSX
    $(LI Put the dmd zip file into your home directory,
    and unzip it:

$(CONSOLE
unzip dmd.$(I VERSION).zip
)
    where $(I VERSION) is the particular version of the zip file.
    )

    $(LI It will create
    a $(D ~/$(DMDDIR)) directory with all the files in it.
    All the tools are command line tools, which means
    they are run from a console window.)

    $(LI Verify that this works by creating $(D hello.d) in your home directory
    with these contents:
---
import std.stdio;

void main()
{
    writeln("hello world!");
}
---
    and compile and run it with:
$(CONSOLE
$(DMDDIR)/osx/bin/dmd hello
./hello
)
    and it should print:
$(CONSOLE
hello world!
)
    )

    $(LI To install a global copy:)

    $(LI Copy binaries to $(D /usr/local/bin):

$(CONSOLE
sudo cp $(DMDDIR)/osx/bin/{dmd,$(DUMPOBJ),$(OBJ2ASM),$(SHELL),rdmd} /usr/local/bin
sudo cp $(DMDDIR)/osx/bin/dmdx.conf /usr/local/bin/$(DMD_CONF)
)
    )

    $(LI Copy the library to $(D /usr/local/lib):

$(CONSOLE
sudo cp $(DMDDIR)/osx/lib/$(LIB) /usr/local/lib
)
    )
    )

$(WINDOWS
$(H2 $(H2 $(LNAME2 example, Example)))

    $(P Run:)

$(CONSOLE
$(DMDDIR)$(SEP)$(OS)$(SEP)bin$(SEP)$(SHELL) all.sh
)

    $(P in the $(D $(DMDDIR)$(SEP)samples$(SEP)d) directory for several small examples.)
)


$(H2 $(LNAME2 switches, Compiler Arguments and Switches))

    $(DL
      $(DT $(B dmd) $(I files)... -$(I switches)...
        $(DD )
      )

      $(DT $(I files)...
        $(DD
        $(TABLE2 File Extensions,
        $(TR
        $(TH Extension)
        $(TH File Type)
        )
        $(TR
        $(TD $(I none))
        $(TD D source files)
        )
        $(TR
        $(TD $(B .d))
        $(TD D source files)
        )
        $(TR
        $(TD $(B .dd))
        $(TD $(LINK2 spec/ddoc.html, Ddoc) source files)
        )
        $(TR
        $(TD $(B .di))
        $(TD $(RELATIVE_LINK2 interface-files, D interface files))
        )
        $(TR
        $(TD $(B .$(OBJEXT)))
        $(TD Object files to link in)
        )
        $(TR
        $(TD $(B .$(LIBEXT)))
        $(TD Object code libraries to search)
        )
$(WINDOWS
        $(TR
        $(TD $(B .exe))
        $(TD Output executable file)
        )
        $(TR
        $(TD $(B .def))
        $(TD $(LINK2 http://www.digitalmars.com/ctg/ctgDefFiles.html, module definition file))
        )
        $(TR
        $(TD $(B .res))
        $(TD resource file)
        )
)
        )
        )
      )

      $(SWITCH $(B @)$(I cmdfile),
        If $(I cmdfile) is an environment variable,
        read the compiler arguments and switches from
        the value of that variable.
        Otherwise, read compiler arguments and switches from
        the text file $(I cmdfile).
        The file may contain single-line comments starting
        with the hash symbol ($(CODE #)).
      )

      $(SWITCH $(SWNAME -allinst),
        generate code for all template instantiations
      )

      $(SWITCH $(SWNAME -betterC),
        Adjusts the compiler to implement D as a $(LINK2 spec/betterc.html, better C):

	$(UL
	$(LI $(LINK2 spec/expression.html#AssertExpression, Assert Expressions), when they fail,
	call the C runtime library assert failure function
	rather than a function in the D runtime.)

	$(LI $(LINK2 https://dlang.org/spec/arrays.html#bounds, Array overflows)
	call the C runtime library assert failure function
	rather than a function in the D runtime.)

	$(LI $(LINK2 spec/statement.html#final-switch-statement/, Final switch errors)
	call the C runtime library assert failure function
	rather than a function in the D runtime.)

	$(LI Does not automatically link with phobos runtime library.)

	$(UNIX
	$(LI Does not generate Dwarf `eh_frame` with full unwinding information, i.e. exception tables
	are not inserted into `eh_frame`.)
	)

	$(LI Module constructors and destructors are not generated meaning that
	$(LINK2 spec/class.html#StaticConstructor, static) and
	$(LINK2 spec/class.html#SharedStaticConstructor, shared static constructors) and
	$(LINK2 spec/class.html#StaticDestructor, destructors)
	will not get called.)

	$(LI `ModuleInfo` is not generated.)

	$(LI $(LINK2 http://dlang.org/phobos/object.html#.TypeInfo, `TypeInfo`)
	instances will not be generated for structs.)
	)
      )

      $(SWITCH $(SWNAME -boundscheck)=[$(I on|safeonly|off)],
        controls if bounds checking is enabled.
        $(UL
            $(LI $(I on): Bounds checks are enabled for all code. This is the default.)
            $(LI $(I safeonly): Bounds checks are enabled only in $(D @safe) code.
                                This is the default for $(SWLINK -release) builds.)
            $(LI $(I off): Bounds checks are disabled completely (even in $(D @safe)
                           code). This option should be used with caution and as a
                           last resort to improve performance. Confirm turning off
                           $(D @safe) bounds checks is worthwhile by benchmarking.)
        )
      )

      $(SWITCH $(SWNAME -c),
        compile only, do not link
      )

      $(SWITCH $(SWNAME -color)=[$(I on|off)],
        Show colored console output. The default depends on terminal capabilities.
        $(UL
            $(LI $(B on): always use colored output. Same as $(B -color))
            $(LI $(B off): never use colored output.)
        )
      )

      $(SWITCH $(SWNAME -conf)=$(I path)
        use config file at $(I path)
      )

      $(SWITCH $(SWNAME -cov),
        $(P Perform $(LINK2 code_coverage.html, code coverage analysis) and generate
        $(TT .lst) file with report.)
---
dmd -cov -unittest myprog.d
---
      )

      $(SWITCH $(SWNAME -cov)=$(I nnn),
        Perform $(LINK2 code_coverage.html, code coverage analysis), generate
        $(TT .lst) file with report, and error at runtime if code coverage is less than
            $(I nnn)% of the executable lines. This can be integrated into the build
        test process to ensure minimum unit test coverage.
      )

      $(SWITCH $(SWNAME -D),
        $(P Generate $(LINK2 spec/ddoc.html, documentation) from source.)

        $(P Note: mind the $(LINK2 spec/ddoc.html#security, security considerations).)
      )

      $(SWITCH $(SWNAME -Dd)$(I docdir),
        write documentation file to $(I docdir) directory. $(SWLINK -op)
        can be used if the original package hierarchy should
        be retained
      )

      $(SWITCH $(SWNAME -Df)$(I filename),
        write documentation file to $(I filename)
      )

      $(SWITCH $(SWNAME -d),
        Silently allow $(DDLINK deprecate,deprecate,deprecated features) and use of symbols with
        $(DDSUBLINK spec/attribute, deprecated, deprecated attributes).
      )

      $(SWITCH $(SWNAME -dw),
        treat use of deprecated features and attributes as warnings
        $(B (this is the default))
      )

      $(SWITCH $(SWNAME -de),
        treat use of deprecated features and attributes as errors
      )

      $(SWITCH $(SWNAME -debug),
        compile in $(LINK2 spec/version.html#debug, debug) code
      )
      $(SWITCH $(B -debug)=$(I level),
        compile in $(LINK2 spec/version.html#debug, debug level) &lt;= $(I level)
      )
      $(SWITCH $(B -debug)=$(I ident),
        compile in $(LINK2 spec/version.html#debug, debug identifier) $(I ident)
      )

      $(SWITCH $(SWNAME -debuglib)=$(I libname),
        Link in $(I libname) as the default library when
        compiling for symbolic debugging instead of $(B $(LIB)).
        If $(I libname) is not supplied, then no default library is linked in.
      )
      $(SWITCH $(SWNAME -defaultlib)=$(I libname),
        Link in $(I libname) as the default library when
        not compiling for symbolic debugging instead of $(B $(LIB)).
        If $(I libname) is not supplied, then no default library is linked in.
      )
      $(SWITCH $(SWNAME -deps)[=$(I filename)],
        Without $(I filename), print module dependencies
        (imports/file/version/debug/lib).
        With $(I filename), write module dependencies as text to $(I filename)
        (only imports).
      )

      $(SWITCH $(SWNAME -dip25),
        implement http://wiki.dlang.org/DIP25 (experimental)
      )

    $(UNIX
      $(SWITCH $(SWNAME -fPIC),
        generate Position Independent Code (which is used
        for building shared libraries).
        $(OSX This is always on for OSX.)
      )
    )

      $(SWITCH $(SWNAME -g),
    $(WINDOWS
        add CodeView symbolic debug info with
        $(LINK2 spec/abi.html#codeview, D extensions)
        for debuggers such as
        $(LINK2 http://ddbg.mainia.de/releases.html, Ddbg)
    )
    $(UNIX
        add symbolic debug info in Dwarf format
        for debuggers such as
        $(D gdb)
    )
      )

      $(SWITCH $(SWNAME -gc),
    $(WINDOWS
        add CodeView symbolic debug info in C format
        for debuggers such as
        $(D $(DMDDIR)\bin\windbg)
    )
    $(UNIX
        backwards compatibility option for the
        the $(SWLINK -g) switch
    )
      )

      $(SWITCH $(SWNAME -gs),
        always generate standard stack frame
      )

      $(SWITCH $(SWNAME -gx),
        add stack stomp code
      )

      $(SWITCH $(SWNAME -H),
        generate $(RELATIVE_LINK2 interface-files, D interface file)
      )

      $(SWITCH $(SWNAME -Hd)$(I dir),
        write D interface file to $(I dir) directory. $(SWLINK -op)
        can be used if the original package hierarchy should
        be retained
      )

      $(SWITCH $(SWNAME -Hf)$(I filename),
        write D interface file to $(I filename)
      )

      $(SWITCH $(SWNAME --help),
        print brief help to console
      )

      $(SWITCH $(SWNAME -I)$(I path),
        where to look for
        $(LINK2 spec/module.html#ImportDeclaration, imports).
        $(I path) is a ; separated
        list of paths. Multiple $(B -I)'s can be used, and the paths
        are searched in the same order.
      )

      $(SWITCH $(SWNAME -ignore),
        ignore unsupported pragmas
      )

      $(SWITCH $(SWNAME -inline),
        inline expand functions at the discretion of the compiler.
        This can improve performance, at the expense of making
        it more difficult to use a debugger on it.
      )

      $(SWITCH $(SWNAME -J)$(I path),
        where to look for files for
        $(LINK2 spec/expression.html#ImportExpression, $(I ImportExpression))s.
        This switch is required in order to use $(I ImportExpression)s.
        $(I path) is a ; separated
        list of paths. Multiple $(B -J)'s can be used, and the paths
        are searched in the same order.
      )

      $(SWITCH $(SWNAME -L)$(I linkerflag),
        pass $(I linkerflag) to the
        $(WINDOWS linker $(OPTLINK))
        $(UNIX linker), for example,
        $(WINDOWS $(TT -L/ma/li))$(UNIX $(TT -L-M))
      )

      $(SWITCH $(SWNAME -lib),
        generate library file as output instead of object file(s).
        All compiled source files, as well as object files and library
        files specified on the command line, are inserted into
        the output library.
        Compiled source modules may be partitioned into several object
        modules to improve granularity.
        The name of the library is taken from the name of the first
        source module to be compiled. This name can be overridden with
        the $(SWLINK -of) switch.
      )

    $(UNIX
      $(SWITCH $(SWNAME -m32),
        compile a 32 bit executable. This is the default for the
        32 bit dmd.
      )

      $(SWITCH $(SWNAME -m64),
        compile a 64 bit executable. This is the default for the 64 bit dmd.
      )
    )

    $(WINDOWS
      $(SWITCH $(SWNAME -m32),
        Compile a 32 bit executable. This is the default.
        The generated object code is in OMF and is meant to be used with the
        $(LINK2 http://www.digitalmars.com/download/freecompiler.html, Digital Mars C/C++ compiler).
      )

      $(SWITCH $(SWNAME -m32mscoff),
        generate 32 bit code and write MS-COFF object files
      )

      $(SWITCH $(SWNAME -m64),
        Compile a 64 bit executable.
        The generated object code is in MS-COFF and is meant to be used with the
        $(LINK2 https://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx, Microsoft Visual Studio 10)
        or later compiler.
      )
    )

      $(SWITCH $(SWNAME -main),
        Add a default $(D main()) function when compiling. This is useful when
        unittesting a library, as it enables running the unittests
        in a library without having to manually define an entry-point function.
      )

      $(SWITCH $(SWNAME -man),
    $(WINDOWS
        open default browser on this page
    )
    $(LINUX
        open browser specified by the $(B BROWSER)
        environment variable on this page. If $(B BROWSER) is
        undefined, $(B x-www-browser) is assumed.
    )
    $(FREEBSD
        open browser specified by the $(B BROWSER)
        environment variable on this page. If $(B BROWSER) is
        undefined, $(B x-www-browser) is assumed.
    )
    $(OSX
        open browser specified by the $(B BROWSER)
        environment variable on this page. If $(B BROWSER) is
        undefined, $(B Safari) is assumed.
    )
      )

      $(SWITCH $(SWNAME -map),
        generate a $(TT .map) file
      )

      $(SWITCH $(SWNAME -mcpu)=[$(B ?)|$(B baseline)|$(B avx)|$(B native)],
        Set the target architecture for code generation,
        where:
        $(DL
        $(DT ?)$(DD list alternatives)
        $(DT baseline)$(DD the minimum architecture for the target platform (default))
        $(DT avx)$(DD
        generate $(LINK2 https://en.wikipedia.org/wiki/Advanced_Vector_Extensions, AVX)
        instructions instead of $(LINK2 https://en.wikipedia.org/wiki/Streaming_SIMD_Extensions, SSE)
        instructions for vector and floating point operations.
        Not available for 32 bit memory models other than OSX32.
        )
        $(DT native)$(DD use the architecture the compiler is running on)
        )
      )

      $(SWITCH $(SWNAME -mv)=$(I package.module)=$(I path/filename),
        Use $(I path/filename) as the source file for $(I package.module).
        This is used when the source file path and names are not the same
        as the package and module hierarchy.
        The rightmost components of the  $(I path/filename) and $(I package.module)
        can be omitted if they are the same.
      )

    $(WINDOWS
      $(SWITCH $(SWNAME -mscrt)=$(I libname),
        if building MS-COFF object files with -m64 or -m32mscoff, embed a reference to
        the given C runtime library $(I libname) into the object file containing `main`,
        `DllMain` or `WinMain` for automatic linking. The default is $(TT libcmt)
        (release version with static linkage), the other usual alternatives are
        $(TT libcmtd), $(TT msvcrt) and $(TT msvcrtd).
        If $(I libname) is empty, no C runtime library is automatically linked in.
      )
    )

      $(SWITCH $(SWNAME -noboundscheck),
        turns off all array bounds checking, even for safe functions. $(RED Deprecated
        (use $(TT $(SWLINK -boundscheck)=off) instead).)
      )


      $(SWITCH $(SWNAME -O),
        Optimize generated code. For fastest executables, compile
        with the $(TT $(SWLINK -O) $(SWLINK -release) $(SWLINK -inline) $(SWLINK -boundscheck)=off)
        switches together.
      )

      $(SWITCH $(SWNAME -o-),
        Suppress generation of object file. Useful in
        conjuction with $(SWLINK -D) or $(SWLINK -H) flags.
      )

      $(SWITCH $(SWNAME -od)$(I objdir),
        $(DD write object files relative to directory $(I objdir)
        instead of to the current directory. $(SWLINK -op)
        can be used if the original package hierarchy should
        be retained)
      )
      $(SWITCH $(SWNAME -of)$(I filename),
        Set output file name to $(I filename) in the output
        directory. The output file can be an object file,
        executable file, or library file depending on the other
        switches.
      )
      $(SWITCH $(SWNAME -op),
        normally the path for $(B .d) source files is stripped
        off when generating an object, interface, or Ddoc file
        name. $(SWLINK -op) will leave it on.
      )
      $(SWITCH $(SWNAME -profile)[=$(B gc)],
        $(LINK2 http://www.digitalmars.com/ctg/trace.html, profile)
        the runtime performance of the generated code.
        $(UL
            $(LI $(B gc): Instrument calls to memory allocation and write a report
            to the file $(TT profilegc.log) upon program termination.)
        )
      )

      $(SWITCH $(SWNAME -release),

        compile release version, which means not emitting run-time
        checks for contracts and asserts. Array bounds checking is not
        done for system and trusted functions, and assertion failures
        are undefined behaviour.
      )
      $(SWITCH $(SWNAME -run) $(I srcfile args...)
        compile, link, and run the program $(I srcfile) with the
        rest of the
        command line, $(I args...), as the arguments to the program.
        No .$(OBJEXT) or executable file is left behind.
      )

    $(UNIX
          $(SWITCH $(SWNAME -shared),
        generate shared library
      )
    )
    $(WINDOWS
          $(SWITCH $(SWNAME -shared),
                generate DLL library
          )
    )

      $(SWITCH $(SWNAME -transition)=$(I id),
        show additional info about language change identified by $(I id)
      )
      $(SWITCH $(B -transition)=?,
        list all language changes
      )

      $(SWITCH $(SWNAME -unittest),
        compile in $(LINK2 spec/unittest.html, unittest) code, turns on asserts, and sets the
        $(D unittest) $(LINK2 spec/version.html#PredefinedVersions, version identifier)
      )
      $(SWITCH $(SWNAME -v),
        verbose
      )
      $(SWITCH $(SWNAME -vcolumns),
        print character (column) numbers in diagnostics
      )
      $(SWITCH $(SWNAME -verrors)=$(I num),
        limit the number of error messages (0 means unlimited)
      )
      $(SWITCH $(SWNAME -version)=$(I level),
        compile in $(LINK2 spec/version.html#version, version level) >= $(I level)
      )
      $(SWITCH $(B -version)=$(I ident),
        compile in $(LINK2 spec/version.html#version, version identifier) $(I ident)
      )
      $(SWITCH $(SWNAME -vgc),
        list all gc allocations including hidden ones
      )
      $(SWITCH $(SWNAME -vtls),
        print informational messages identifying variables defaulting
        to thread local storage. Handy for migrating to shared model.
      )

      $(SWITCH $(SWNAME -w),
        enable $(LINK2 warnings.html, warnings)
      )
      $(SWITCH $(SWNAME -wi),
        enable $(LINK2 warnings.html, informational warnings (i.e. compilation
        still proceeds normally))
      )
      $(SWITCH $(SWNAME -X),
        generate JSON file
      )
      $(SWITCH $(SWNAME -Xf)$(I filename),
        write JSON file to $(I filename)
      )
    )

    $(WINDOWS
    $(P Empty switches, i.e. "", are ignored.)
    )

$(H2 $(LNAME2 linking, Linking))

    $(P Linking is done directly by the $(B dmd) compiler after a successful
    compile. To prevent $(B dmd) from running the linker, use the
    $(SWLINK -c) switch.
    )

    $(WINDOWS
    $(P 32 bit programs must be linked with the D runtime library $(B phobos.lib),
    followed by the Digital Mars C runtime library $(B snn.lib).
    This is done automatically as long as the directories for the
    libraries are on the $(B LIB) environment variable path. A typical
    way to set $(B LIB) would be:
    )

$(CONSOLE
set LIB=$(DMDDIR)\lib;\dm\lib
)

    $(P If the $(B dmd) command is used to both compile and link
    to an executable, it will make certain optimizations that are
    valid only for Windows executable files. Do not use the resulting
    .obj files in a DLL.
    To compile modules into .obj files that can be used in an exe or
    DLL, compile with $(SWLINK -c) and $(SWLINK -shared).
    )

    $(P Linking 32 bit programs is done using Digital Mars $(OPTLINK).
    )

    $(P Linking 64 bit programs is done using the
    Microsoft linker.
    )
     )
     $(UNIX
    $(P The actual linking is done by running $(B gcc).
    This ensures compatibility with modules compiled with $(B gcc).
    )
     )

$(H2 $(LNAME2 environment, Environment Variables))

    $(P The D compiler dmd uses the following environment variables:
    )

    $(DL

    $(WINDOWS
    $(DT $(B DFLAGS))
    $(DD The value of $(B DFLAGS) is treated as if it were appended to the
    command line to $(B dmd.exe).)

    $(DT $(B LIB))
    $(DD The linker uses $(B LIB) to search for library files. For D, it will
    normally be set to:)

$(CONSOLE
set LIB=$(DMDDIR)\lib;\dm\lib
)

    $(DT $(B LINKCMD))
    $(DD $(B dmd) normally runs the linker by looking for $(OPTLINK)
    along the $(B PATH). To use a specific linker for 32 bit programs instead, set the
    $(B LINKCMD) environment variable to it. For example:)

$(CONSOLE
set LINKCMD=\dmd\windows\bin\link
)

    $(DT $(B LINKCMD64))
    $(DD $(B dmd) normally runs the linker by looking for $(OPTLINK)
    along the $(B PATH). To use a specific linker for 64 bit programs instead, set the
    $(B LINKCMD64) environment variable to it. For example:)

$(CONSOLE
set LINKCMD64=C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\amd64\link.exe
)

    $(DT $(B PATH))
    $(DD If the linker is not found in the same directory as $(B dmd.exe)
    is in, the $(B PATH) is searched for it.
    $(B Note:) other linkers named
    $(B link.exe) will likely not work.
    Make sure the Digital Mars $(OPTLINK)
    is found first in the $(B PATH) before other $(B link.exe)'s,
    or use $(B LINKCMD) to specifically identify which linker
    to use.)
    )
    $(UNIX
    $(DT $(B CC))
    $(DD  $(B dmd) normally runs the linker by looking for $(B gcc)
    along the $(B PATH). To use a specific linker instead, set the
    $(B CC) environment variable to it. For example:)

$(CONSOLE
set CC=gcc
)
    $(DT $(B BROWSER)
        $(DD This sets the browser used to open the manual page with
        the $(SWLINK -man) switch. It defaults to $(D x-www-browser).
        )
    )

    $(DT $(B DFLAGS))
    $(DD The value of $(B DFLAGS) is treated as if it were appended to the
    command line to $(B dmd).)
    )
    )

$(WINDOWS
$(H2 $(LEGACY_LNAME2 sc_ini, sc-ini, sc.ini Initialization File))

    $(P $(B dmd) will look for the initialization file $(B sc.ini) in the
    following sequence of directories:
    )

    $(OL
    $(LI current working directory)
    $(LI directory specified by the $(B HOME) environment variable)
    $(LI directory $(B dmd.exe) resides in)
    )

    $(P If found, environment variable
    settings in the file will override any existing settings.
    This is handy to make $(B dmd) independent of programs with
    conflicting use of environment variables.
    )

$(H3 Initialization File Format)

    $(P Comments are lines that begin with $(D ;) and are ignored.
    )

    $(P Environment variables follow the $(D [Environment]) section
    heading, in $(I NAME)=$(I value) pairs.
    The $(I NAME)s are treated as upper case.
    Comments are lines that start with ;.
    For example:
    )

$(SCINI
; sc.ini file for dmd
; Names enclosed by %% are searched for in the existing environment
; and inserted. The special name %@P% is replaced with the path
; to this file.
[Environment]
LIB="%@P%\..\lib";\dm\lib

DFLAGS="-I%@P%\..\src\phobos" "-I%@P%\..\src\druntime\import"
LINKCMD="%@P%\..\..\dm\bin"
DDOCFILE=mysettings.ddoc
)

$(H3 Location Independence of sc.ini)

    $(P The $(B %@P%) is replaced with the path to $(D sc.ini).
    Thus, if the fully qualified file name $(D sc.ini) is
    $(D c:$(DMDDIR)\bin\sc.ini), then $(B %@P%) will be replaced with
    $(D c:$(DMDDIR)\bin), and the above $(D sc.ini) will be
    interpreted as:
    )

$(SCINI
[Environment]
LIB="c:$(DMDDIR)\bin\..\lib";\dm\lib

DFLAGS="-Ic:$(DMDDIR)\bin\..\src\phobos" "-Ic:$(DMDDIR)\bin\..\src\druntime\import"
LINKCMD="c:$(DMDDIR)\bin\..\..\dm\bin"
DDOCFILE=mysettings.ddoc
)

    $(P This enables your dmd setup to be moved around without having
    to re-edit $(D sc.ini).
    )

)
$(UNIX
$(H2 $(LEGACY_LNAME2 dmd_conf, dmd-conf, dmd.conf Initialization File))

    $(P The dmd file $(D dmd.conf) is the same as $(D sc.ini)
    for Windows, it's just that the file has a different name,
    enabling a setup common to both Windows and this system to be created
    without having to re-edit the file.)

    $(P $(B dmd) will look for the initialization file $(D dmd.conf) in the
    following sequence of directories:)

    $(OL
    $(LI current working directory)
    $(LI directory specified by the $(B HOME) environment variable)
    $(LI directory $(B dmd) resides in)
    $(LI $(D /etc/))
    )

    $(P If found, environment variable
    settings in the file will override any existing settings.
    This is handy to make $(B dmd) independent of programs with
    conflicting use of environment variables.
    )

    $(P Environment variables follow the $(D [Environment]) section
    heading, in $(I NAME)=$(I value) pairs.
    The $(I NAME)s are treated as upper case.
    Comments are lines that start with ;.
    For example:
    )

$(SCINI
; dmd.conf file for dmd
; Names enclosed by %% are searched for in the existing environment
; and inserted. The special name %@P% is replaced with the path
; to this file.
[Environment]

DFLAGS=-I%@P%/../src/phobos -I%@P%/../src/druntime/import
)
)

$(WINDOWS
$(H2 $(LNAME2 problems, Common Installation Problems))

    $(UL
    $(LI Using Cygwin's $(B unzip) utility has been known to cause
    strange problems.
    )
    $(LI Running the compiler under Cygwin's command shell has
    been also known to cause problems. Try getting it to work
    under the regular Windows shell $(B cmd.exe) before trying Cygwin's.
    )
    $(LI Installing $(B dmd) and $(B $(DMC)) into directory paths with spaces
    in them causes problems.
    )
    )
)

<hr>
$(H2 $(LNAME2 differences, Differences between Windows and Linux versions))

    $(UL
    $(LI String literals are read-only under Linux.
    Attempting to write to them
    will cause a segment violation.)
    )
<hr>
$(H2 $(LEGACY_LNAME2 interface_files, interface-files, D Interface Files))

    $(P When an import declaration is processed in a D source file,
    the compiler searches for the D source file corresponding to
    the import, and processes that source file to extract the
    information needed from it. Alternatively, the compiler can
    instead look for a corresponding $(I D interface file).
    A D interface file contains only what an import of the module
    needs, rather than the whole implementation of that module.
    )

    $(P The advantages of using a D interface file for imports rather
    than a D source file are:
    )

    $(UL
    $(LI D interface files are often significantly smaller and much
    faster to process than the corresponding D source file.)
    $(LI They can be used to hide the source code, for example,
    one can ship an object code library along with D interface files
    rather than the complete source code.)
    )

    $(P D interface files can be created by the compiler from a
    D source file by using the $(SWLINK -H) switch to the compiler.
    D interface files have the $(B .di) file extension.
    When the compiler resolves an import declaration, it first looks
    for a $(B .di) D interface file, then it looks for a D source
    file.
    )

    $(P D interface files bear some analogous similarities to C++
    header files. But they are not required in the way that C++
    header files are, and they are not part of the D language.
    They are a feature of the compiler, and serve only as an optimization
    of the build process.
    )

$(H2 $(LNAME2 executable, Building Executables))

    $(P $(B dmd) can build an executable much faster if as many of the
    source files as possible are put on the command line.)

    $(P Another advantage to putting multiple source files on the same
    invocation of $(B dmd) is that $(B dmd) will be able to do some level
    of cross-module optimizations, such as function inlining across modules.
    )

$(H2 $(LNAME2 library, Building Libraries))

    $(P There are three ways to build a library. For example,
    given $(D foo.d) and $(D bar.d) which are to be compiled, and existing
    object file $(D abc.$(OBJEXT)) and existing library
    $(D def.$(LIBEXT)) which are
    all to be combined into a library $(D foo.$(LIBEXT)):)

    $(OL
    $(LI Compile modules separately and then run the librarian on them:
$(WINDOWS
$(CONSOLE
dmd -c foo.d
dmd -c bar.d
$(LIB) -c -p32 foo.lib foo.obj bar.obj abc.obj def.lib
del foo.obj bar.obj
)
)
$(UNIX
$(CONSOLE
dmd -c foo.d
dmd -c bar.d
rm -f foo.a
ar -r foo.a foo.o bar.o abc.o def.a
rm foo.o bar.o
)
)
    This option is typical when using a makefile to avoid compiling
    modules that have already been compiled.
    )
    $(LI Compile modules together and then run the librarian on them:
$(WINDOWS
$(CONSOLE
dmd -c foo.d bar.d
$(LIB) -c -p32 foo.lib foo.obj bar.obj abc.obj def.lib
del foo.obj bar.obj
)
)
$(UNIX
$(CONSOLE
dmd -c foo.d bar.d
rm -f foo.a
ar -r foo.a foo.o bar.o abc.o def.a
rm foo.o bar.o
)
)
    )
    $(LI Use $(B dmd) to compile and build library in one operation:
$(CONSOLE
dmd -lib foo.d bar.d abc.$(OBJEXT) def.$(LIBEXT)
)
    No object files are written to disk, it's all done in memory.
    Using $(SWLINK -lib) also has the advantage that modules may be compiled
    into multiple object files rather than exactly one per module.
    This improves granularity of the library without having to break
    up the modules.
    )
    )

$(H2 $(LEGACY_LNAME2 compiling_dmd, compiling-dmd, Compiling dmd))

    $(P Complete source code is provided to build the compiler.
    Follow these steps:)

$(WINDOWS
$(CONSOLE
cd $(DMDDIR)\src\dmd
make -f win32.mak
)
)
$(UNIX
$(CONSOLE
cd ~/$(DMDDIR)/src/dmd
make -f posix.mak
)
)

$(H2 $(LEGACY_LNAME2 compiling_phobos, compiling-phobos, Compiling Phobos))

    $(P Complete source code is provided to build Phobos, the D runtime library.
    Follow these steps:)


$(WINDOWS
$(CONSOLE
cd $(DMDDIR)\src\druntime
make -f win32.mak DMD=$(DMDDIR)\$(OS)\bin\dmd
cd ..\phobos
make -f win32.mak DMD=$(DMDDIR)\$(OS)\bin\dmd
)
)
$(UNIX
$(CONSOLE
cd ~/$(DMDDIR)/src/druntime
make -f posix.mak DMD=~/$(DMDDIR)/$(OS)/bin/dmd
cd ../phobos
make -f posix.mak DMD=~/$(DMDDIR)/$(OS)/bin/dmd
)
)


)

Macros:
    TITLE=DMD Compiler for $(WINDOWS Windows)$(LINUX Linux)$(OSX OSX)$(FREEBSD FreeBSD)
    BODYCLASS=std dcompiler
    LIB=$(WINDOWS phobos.lib)$(UNIX libphobos2.a)
    DMD_CONF=$(RELATIVE_LINK2 dmd-conf, dmd.conf)
    SC_INI=$(RELATIVE_LINK2 sc-ini, $(DMDDIR)\windows\bin\sc.ini)
    SWNAME=$(LNAME2 switch$1, $(B $1))
    SWLINK=$(LINK2 #switch$1, $(B $1))
    SWITCH=$(DT $1)$(DD $+)
    DMC=$(LINK2 http://www.digitalmars.com/ctg/sc.html, dmc)
    LIB=$(LINK2 http://www.digitalmars.com/ctg/lib.html, lib)
    OPTLINK=$(LINK2 http://www.digitalmars.com/ctg/optlink.html, link.exe)
    DUB=$(LINK2 https://github.com/dlang/dub, dub$(BINEXT))
    RDMD=$(LINK2 $(ROOT_DIR)rdmd.html, rdmd$(BINEXT))
    DUSTMITE=$(LINK2 https://github.com/CyberShadow/DustMite, dustmite$(BINEXT))
    OBJ2ASM=$(HTTP digitalmars.com/ctg/obj2asm.html, obj2asm$(BINEXT))
    DUMPOBJ=$(HTTP digitalmars.com/ctg/dumpobj.html, dumpobj$(BINEXT))
    SHELL=$(HTTP digitalmars.com/ctg/shell.html, shell)
        SUBNAV=$(SUBNAV_CLI_REFERENCE)