src/engine/SCons/Tool/mslink.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="mslink">
   8 <summary>
   9 XXX
  10 </summary>
  11 </tool>
  12
  13 <cvar name="no_import_lib">
  14 <summary>
  15 When set to non-zero,
  16 suppresses creation of a corresponding Windows static import lib by the
  17 <literal>SharedLibrary</literal>
  18 builder when used with
  19 MinGW, Microsoft Visual Studio or Metrowerks.
  20 This also suppresses creation
  21 of an export (.exp) file
  22 when using Microsoft Visual Studio.
  23 </summary>
  24 </cvar>
  25
  26 <cvar name="PDB">
  27 <summary>
  28 The Microsoft Visual C++ PDB file that will store debugging information for
  29 object files, shared libraries, and programs. This variable is ignored by
  30 tools other than Microsoft Visual C++.
  31 When this variable is
  32 defined SCons will add options to the compiler and linker command line to
  33 cause them to generate external debugging information, and will also set up the
  34 dependencies for the PDB file.
  35 Example:
  36
  37 <example>
  38 env['PDB'] = 'hello.pdb'
  39 </example>
  40
  41 The Visual C++ compiler switch that SCons uses by default
  42 to generate PDB information is <option>/Z7</option>.
  43 This works correctly with parallel (<option>-j</option>) builds
  44 because it embeds the debug information in the intermediate object files,
  45 as opposed to sharing a single PDB file between multiple object files.
  46 This is also the only way to get debug information
  47 embedded into a static library.
  48 Using the <option>/Zi</option> instead may yield improved
  49 link-time performance,
  50 although parallel builds will no longer work.
  51 You can generate PDB files with the <option>/Zi</option>
  52 switch by overriding the default &cv-link-CCPDBFLAGS; variable;
  53 see the entry for that variable for specific examples.
  54 </summary>
  55 </cvar>
  56
  57 <cvar name="REGSVR">
  58 <summary>
  59 The program used on Windows systems
  60 to register a newly-built DLL library
  61 whenever the &b-SharedLibrary; builder
  62 is passed a keyword argument of <literal>register=1</literal>.
  63 </summary>
  64 </cvar>
  65
  66 <cvar name="REGSVRCOM">
  67 <summary>
  68 The command line used on Windows systems
  69 to register a newly-built DLL library
  70 whenever the &b-SharedLibrary; builder
  71 is passed a keyword argument of <literal>register=1</literal>.
  72 </summary>
  73 </cvar>
  74
  75 <cvar name="REGSVRCOMSTR">
  76 <summary>
  77 The string displayed when registering a newly-built DLL file.
  78 If this is not set, then &cv-link-REGSVRCOM; (the command line) is displayed.
  79 </summary>
  80 </cvar>
  81
  82 <cvar name="REGSVRFLAGS">
  83 <summary>
  84 Flags passed to the DLL registration program
  85 on Windows systems when a newly-built DLL library is registered.
  86 By default,
  87 this includes the <option>/s</option>
  88 that prevents dialog boxes from popping up
  89 and requiring user attention.
  90 </summary>
  91 </cvar>
  92
  93 <cvar name="WIN32_INSERT_DEF">
  94 <summary>
  95 A deprecated synonym for &cv-link-WINDOWS_INSERT_DEF;.
  96 </summary>
  97 </cvar>
  98
  99 <cvar name="WIN32DEFPREFIX">
 100 <summary>
 101 A deprecated synonym for &cv-link-WINDOWSDEFPREFIX;.
 102 </summary>
 103 </cvar>
 104
 105 <cvar name="WIN32DEFSUFFIX">
 106 <summary>
 107 A deprecated synonym for &cv-link-WINDOWSDEFSUFFIX;.
 108 </summary>
 109 </cvar>
 110
 111 <cvar name="WIN32EXPPREFIX">
 112 <summary>
 113 A deprecated synonym for &cv-link-WINDOWSEXPSUFFIX;.
 114 </summary>
 115 </cvar>
 116
 117 <cvar name="WIN32EXPSUFFIX">
 118 <summary>
 119 A deprecated synonym for &cv-link-WINDOWSEXPSUFFIX;.
 120 </summary>
 121 </cvar>
 122
 123 <cvar name="WINDOWS_INSERT_DEF">
 124 <summary>
 125 When this is set to true,
 126 a library build of a Windows shared library
 127 (<filename>.dll</filename>file)
 128 will also build a corresponding <filename>.def</filename> file
 129 at the same time,
 130 if a <filename>.def</filename> file
 131 is not already listed as a build target.
 132 The default is 0 (do not build a <filename>.def</filename> file).
 133 </summary>
 134 </cvar>
 135
 136 <cvar name="WINDOWS_INSERT_MANIFEST">
 137 <summary>
 138 When this is set to true,
 139 &scons;
 140 will be aware of the
 141 <filename>.manifest</filename>
 142 files generated by Microsoft Visua C/C++ 8.
 143 </summary>
 144 </cvar>
 145
 146 <cvar name="WINDOWSDEFPREFIX">
 147 <summary>
 148 The prefix used for Windows <filename>.def</filename>file names.
 149 </summary>
 150 </cvar>
 151
 152 <cvar name="WINDOWSDEFSUFFIX">
 153 <summary>
 154 The suffix used for Windows <filename>.def</filename> file names.
 155 </summary>
 156 </cvar>
 157
 158 <cvar name="WINDOWSEXPPREFIX">
 159 <summary>
 160 The prefix used for Windows <filename>.exp</filename> file names.
 161 </summary>
 162 </cvar>
 163
 164 <cvar name="WINDOWSEXPSUFFIX">
 165 <summary>
 166 The suffix used for Windows <filename>.exp</filename> file names.
 167 </summary>
 168 </cvar>
 169
 170 <cvar name="WINDOWSPROGMANIFESTPREFIX">
 171 <summary>
 172 The prefix used for executable program <filename>.manifest</filename> files
 173 generated by Microsoft Visual C/C++.
 174 </summary>
 175 </cvar>
 176
 177 <cvar name="WINDOWSPROGMANIFESTSUFFIX">
 178 <summary>
 179 The suffix used for executable program <filename>.manifest</filename> files
 180 generated by Microsoft Visual C/C++.
 181 </summary>
 182 </cvar>
 183
 184 <cvar name="WINDOWSSHLIBMANIFESTPREFIX">
 185 <summary>
 186 The prefix used for shared library <filename>.manifest</filename> files
 187 generated by Microsoft Visual C/C++.
 188 </summary>
 189 </cvar>
 190
 191 <cvar name="WINDOWSSHLIBMANIFESTSUFFIX">
 192 <summary>
 193 The suffix used for shared library <filename>.manifest</filename> files
 194 generated by Microsoft Visual C/C++.
 195 </summary>
 196 </cvar>