src/engine/SCons/Tool/link.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="link">
   8 <summary>
   9 Sets construction variables for generic POSIX linkers.
  10 </summary>
  11 <sets>
  12 SHLINK
  13 SHLINKFLAGS
  14 SHLINKCOM
  15 LINK
  16 LINKFLAGS
  17 LINKCOM
  18 LIBDIRPREFIX
  19 LIBDIRSUFFIX
  20 LIBLINKPREFIX
  21 LIBLINKSUFFIX
  22 SHLIBSUFFIX
  23 LDMODULE
  24 LDMODULEPREFIX
  25 LDMODULESUFFIX
  26 LDMODULEFLAGS
  27 LDMODULECOM
  28 </sets>
  29 <uses>
  30 SHLINKCOMSTR
  31 LINKCOMSTR
  32 LDMODULECOMSTR
  33 </uses>
  34 </tool>
  35
  36 <cvar name="LDMODULE">
  37 <summary>
  38 The linker for building loadable modules.
  39 By default, this is the same as &cv-link-SHLINK;.
  40 </summary>
  41 </cvar>
  42
  43 <cvar name="LDMODULECOM">
  44 <summary>
  45 The command line for building loadable modules.
  46 On Mac OS X, this uses the &cv-link-LDMODULE;,
  47 &cv-link-LDMODULEFLAGS; and
  48 &cv-link-FRAMEWORKSFLAGS; variables.
  49 On other systems, this is the same as &cv-link-SHLINK;.
  50 </summary>
  51 </cvar>
  52
  53 <cvar name="LDMODULECOMSTR">
  54 <summary>
  55 The string displayed when building loadable modules.
  56 If this is not set, then &cv-link-LDMODULECOM; (the command line) is displayed.
  57 </summary>
  58 </cvar>
  59
  60 <cvar name="LDMODULEFLAGS">
  61 <summary>
  62 General user options passed to the linker for building loadable modules.
  63 </summary>
  64 </cvar>
  65
  66 <cvar name="LDMODULEPREFIX">
  67 <summary>
  68 The prefix used for loadable module file names.
  69 On Mac OS X, this is null;
  70 on other systems, this is
  71 the same as &cv-link-SHLIBPREFIX;.
  72 </summary>
  73 </cvar>
  74
  75 <cvar name="LDMODULESUFFIX">
  76 <summary>
  77 The suffix used for loadable module file names.
  78 On Mac OS X, this is null;
  79 on other systems, this is
  80 the same as $SHLIBSUFFIX.
  81 </summary>
  82 </cvar>
  83
  84 <cvar name="LINK">
  85 <summary>
  86 The linker.
  87 </summary>
  88 </cvar>
  89
  90 <cvar name="LINKCOM">
  91 <summary>
  92 The command line used to link object files into an executable.
  93 </summary>
  94 </cvar>
  95
  96 <cvar name="LINKCOMSTR">
  97 <summary>
  98 The string displayed when object files
  99 are linked into an executable.
 100 If this is not set, then &cv-link-LINKCOM; (the command line) is displayed.
 101
 102 <example>
 103 env = Environment(LINKCOMSTR = "Linking $TARGET")
 104 </example>
 105 </summary>
 106 </cvar>
 107
 108 <cvar name="LINKFLAGS">
 109 <summary>
 110 General user options passed to the linker.
 111 Note that this variable should
 112 <emphasis>not</emphasis>
 113 contain
 114 <option>-l</option>
 115 (or similar) options for linking with the libraries listed in &cv-link-LIBS;,
 116 nor
 117 <option>-L</option>
 118 (or similar) library search path options
 119 that scons generates automatically from &cv-link-LIBPATH;.
 120 See
 121 &cv-link-_LIBFLAGS;
 122 above,
 123 for the variable that expands to library-link options,
 124 and
 125 &cv-link-_LIBDIRFLAGS;
 126 above,
 127 for the variable that expands to library search path options.
 128 </summary>
 129 </cvar>
 130
 131 <cvar name="SHLINK">
 132 <summary>
 133 The linker for programs that use shared libraries.
 134 </summary>
 135 </cvar>
 136
 137 <cvar name="SHLINKCOM">
 138 <summary>
 139 The command line used to link programs using shared libaries.
 140 </summary>
 141 </cvar>
 142
 143 <cvar name="SHLINKCOMSTR">
 144 <summary>
 145 The string displayed when programs using shared libraries are linked.
 146 If this is not set, then &cv-link-SHLINKCOM; (the command line) is displayed.
 147
 148 <example>
 149 env = Environment(SHLINKCOMSTR = "Linking shared $TARGET")
 150 </example>
 151 </summary>
 152 </cvar>
 153
 154 <cvar name="SHLINKFLAGS">
 155 <summary>
 156 General user options passed to the linker for programs using shared libraries.
 157 Note that this variable should
 158 <emphasis>not</emphasis>
 159 contain
 160 <option>-l</option>
 161 (or similar) options for linking with the libraries listed in &cv-link-LIBS;,
 162 nor
 163 <option>-L</option>
 164 (or similar) include search path options
 165 that scons generates automatically from &cv-link-LIBPATH;.
 166 See
 167 &cv-link-_LIBFLAGS;
 168 above,
 169 for the variable that expands to library-link options,
 170 and
 171 &cv-link-_LIBDIRFLAGS;
 172 above,
 173 for the variable that expands to library search path options.
 174 </summary>
 175 </cvar>