diff options
Diffstat (limited to 'src/engine/SCons/Tool/install.xml')
| -rw-r--r-- | src/engine/SCons/Tool/install.xml | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/install.xml b/src/engine/SCons/Tool/install.xml new file mode 100644 index 0000000..9dddca3 --- /dev/null +++ b/src/engine/SCons/Tool/install.xml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +Copyright (c) 2001 - 2014 The SCons Foundation + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> + +<!DOCTYPE sconsdoc [ +<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'> +%scons; +<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'> +%builders-mod; +<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'> +%functions-mod; +<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'> +%tools-mod; +<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'> +%variables-mod; +]> + +<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> + + +<tool name="install"> +<summary> +<para> +Sets construction variables for file +and directory installation. +</para> +</summary> +<sets> +<item>INSTALL</item> +<item>INSTALLSTR</item> +</sets> +</tool> + +<builder name="Install"> +<summary> +<para> +Installs one or more source files or directories +in the specified target, +which must be a directory. +The names of the specified source files or directories +remain the same within the destination directory. The +sources may be given as a string or as a node returned by +a builder. +</para> + +<example_commands> +env.Install('/usr/local/bin', source = ['foo', 'bar']) +</example_commands> +</summary> +</builder> + +<builder name="InstallAs"> +<summary> +<para> +Installs one or more source files or directories +to specific names, +allowing changing a file or directory name +as part of the installation. +It is an error if the +target +and +source +arguments list different numbers of files or directories. +</para> +</summary> +</builder> + +<builder name="InstallVersionedLib"> +<summary> +<para> +Installs a versioned shared library. The &cv-link-SHLIBVERSION; +construction variable should be defined in the environment +to confirm the version number in the library name. +The symlinks appropriate to the architecture will be generated. +</para> + +<example_commands> +env.InstallAs(target = '/usr/local/bin/foo', + source = 'foo_debug') +env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], + source = ['libFOO.a', 'libBAR.a']) +</example_commands> +</summary> +</builder> + +</sconsdoc> |
