summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/install.xml
blob: f3a04baa793d62a4e23e704e8ecd23434f116c13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<!--
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 The SCons Foundation

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<tool name="install">
<summary>
Sets construction variables for file
and directory installation.
</summary>
<sets>
INSTALL
INSTALLSTR
</sets>
</tool>

<builder name="Install">
<summary>
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.

<example>
env.Install('/usr/local/bin', source = ['foo', 'bar'])
</example>
</summary>
</builder>

<builder name="InstallAs">
<summary>
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.

<example>
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>
</summary>
</builder>