SCons/Platform/posix.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   4 SPDX-License-Identifier: MIT
   5 SPDX-FileType: DOCUMENTATION
   6
   7 This file is processed by the bin/SConsDoc.py module.
   8 -->
   9
  10 <!DOCTYPE sconsdoc [
  11 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  12 %scons;
  13 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  14 %builders-mod;
  15 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  16 %functions-mod;
  17 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  18 %tools-mod;
  19 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  20 %variables-mod;
  21 ]>
  22
  23 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  24           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  25           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  26
  27 <cvar name="RPATH">
  28 <summary>
  29 <para>
  30 A list of paths to search for shared libraries when running programs.
  31 Currently only used in the GNU (gnulink),
  32 IRIX (sgilink) and Sun (sunlink) linkers.
  33 Ignored on platforms and toolchains that don't support it.
  34 Note that the paths added to RPATH
  35 are not transformed by
  36 &scons;
  37 in any way:  if you want an absolute
  38 path, you must make it absolute yourself.
  39 </para>
  40 </summary>
  41 </cvar>
  42
  43 <cvar name="_RPATH">
  44 <summary>
  45 <para>
  46 An automatically-generated construction variable
  47 containing the rpath flags to be used when linking
  48 a program with shared libraries.
  49 The value of &cv-_RPATH; is created
  50 by respectively prepending &cv-RPATHPREFIX; and appending &cv-RPATHSUFFIX;
  51 to the beginning and end
  52 of each directory in &cv-RPATH;.
  53 </para>
  54 </summary>
  55 </cvar>
  56
  57 <cvar name="RPATHPREFIX">
  58 <summary>
  59 <para>
  60 The prefix used to specify a directory to be searched for
  61 shared libraries when running programs.
  62 This will be prepended to the beginning of each directory
  63 in the &cv-RPATH; construction variable
  64 when the &cv-_RPATH; variable is automatically generated.
  65 </para>
  66 </summary>
  67 </cvar>
  68
  69 <cvar name="RPATHSUFFIX">
  70 <summary>
  71 <para>
  72 The suffix used to specify a directory to be searched for
  73 shared libraries when running programs.
  74 This will be appended to the end of each directory
  75 in the &cv-RPATH; construction variable
  76 when the &cv-_RPATH; variable is automatically generated.
  77 </para>
  78 </summary>
  79 </cvar>
  80
  81 </sconsdoc>