File: install-paths-module.qdoc

package info (click to toggle)
qbs 3.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,780 kB
  • sloc: cpp: 120,475; ansic: 72,055; javascript: 14,887; python: 5,882; asm: 1,742; sh: 1,059; java: 693; objc: 409; lex: 194; xml: 141; perl: 137; yacc: 86; makefile: 55; cs: 41
file content (155 lines) | stat: -rw-r--r-- 4,035 bytes parent folder | download | duplicates (3)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/****************************************************************************
**
** Copyright (C) 2025 Janet Black.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmltype installpaths
    \inqmlmodule QbsModules
    \since Qbs 3.1

    \brief Provides properties for install directories.

    The \c installpaths module contains properties indicating directories where
    files should be installed to in a manner allowing distributors to make necessary
    adjustments.

    Example usage:
    \code
    qbs modules.installPaths.libexec:lib64/libexec
    \endcode

    \note On Debian-like Linux distributions, this module also provides some convenience
    auto-detection mechanism using the \c dpkg-architecture tool: If installPaths::autotedect
    is true, \QBS will query the library paths from the system.
*/

/*!
    \qmlproperty string installpaths::autotedect

    Whether to try autodetecting paths using system tools.

    This property has an effect only on Debian-like Linux systems.

    \defaultvalue \c false
*/

/*!
    \qmlproperty string installpaths::applications

    The location where to install applictaton bundles on Apple platforms.

    \defaultvalue \c "Applications"
*/

/*!
    \qmlproperty string installpaths::bin

    The location where to install binaries.

    \defaultvalue \c "bin"
*/

/*!
    \qmlproperty string installpaths::etc

    The location where to install configs.

    \defaultvalue \c "etc"
*/

/*!
    \qmlproperty string installpaths::frameworks

    The location where to install Frameworks on Apple platforms.

    \defaultvalue \c "Library/Frameworks"
*/

/*!
    \qmlproperty string installpaths::include

    The location where to install include files.

    \defaultvalue \c "include"
*/

/*!
    \qmlproperty string installpaths::lib

    The location where to install libraries.

    \defaultvalue \c "lib"
*/

/*!
    \qmlproperty string installpaths::libexec

    The location where to install additional executables.

    \defaultvalue \c{"libexec/"} + \l{subdir}
*/

/*!
    \qmlproperty string installpaths::library

    The location where to install support files on Apple platforms.

    \defaultvalue \c "Library"
*/

/*!
    \qmlproperty string installpaths::loadableModules

    The location where to install loadable modules (bundle plugins) on Apple platforms.

    \defaultvalue \c "Library/<ProjectName>/PlugIns"
*/

/*!
    \qmlproperty string installpaths::subdir

    The additional directory appended to the libexec, share and plugins paths.

    \defaultvalue lower-case \l{Project::name}{Project.name}
*/

/*!
    \qmlproperty string installpaths::plugins

    The location where to install plugins.

    On Apple platforms, non-bundle loadable modules are also installed here.

    \defaultvalue \l{lib} + \c{"/"} + \l{subdir} + \c{"/plugins"}
*/

/*!
    \qmlproperty string installpaths::share

    The location where to install resources.

    \defaultvalue \c{"share/"} + \l{subdir}
*/