xref: /openbsd-src/share/man/man5/qmake-module.5 (revision d0fc3bb68efd6c434b4053cd7adb29023cbec341)
1.\"	$OpenBSD: qmake-module.5,v 1.1 2021/02/25 09:13:18 espie Exp $
2.\"
3.\" Copyright (c) 2008 Marc Espie
4.\"
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd $Mdocdate: February 25 2021 $
28.Dt QMAKE-MODULE 5
29.Os
30.Sh NAME
31.Nm qmake-module
32.Nd devel/qmake port module
33.Sh DESCRIPTION
34This manual page documents the behavior of setting
35.Li MODULE=devel/qmake
36in the
37.Xr ports 7
38tree.
39.Pp
40This module automates usage of qmake, independently of the actual
41version of Qt being used.
42This module requires that one of the
43.Pa x11/qt3 ,
44.Pa x11/qt4
45or
46.Pa x11/qt5
47to be used as well.
48.Pp
49If
50.Ev CONFIGURE_STYLE
51was not set before, sets its value to
52.Sq qmake .
53If
54.Ev CONFIGURE_STYLE
55contains
56.Sq qmake
57the module will define each of the
58.Ar do-build
59and
60.Ar do-install
61targets, unless port already defines one; also,
62.Ev SEPARATE_BUILD
63will be set to
64.Sq Yes
65unless it's already set to some value.
66Also, unless
67.Ev NO_TEST
68is set, the
69.Ar do-test
70target will be defined.
71.Pp
72The following variables could be used in qmake-based ports:
73.Bl -tag -width 1234
74.It Ev MODQMAKE_ARGS
75Additional arguments for qmake invocation.
76The module already defines some.
77.It Ev MODQMAKE_INSTALL_ROOT
78Root directory for fake install.
79Normally, it's a WRKINST, but some (broken) ports require another value,
80like PREFIX.
81.It Ev MODQMAKE_PROJECTS
82List of qmake project files to be used, relative to WRKSRC.
83Directories containing those projects could be used as well,
84see qmake documentation for details.
85Defaults to
86.Sq \&. ,
87which means the (only) project in WRKSRC directory.
88.It Ev MODQMAKE_RECURSIVE
89If
90.Sq Yes ,
91then qmake will be run recursively during configure stage;
92otherwise, only projects mentioned in
93.Ev MODQMAKE_PROJECTS
94will be processed during configure stage, and their descendants will
95be visited during main build phase.
96Sometimes a qmake project processing depends on files generated
97by other qmake project during build, and recursive builds break this.
98For Qt4+ defaults to
99.Sq Yes ,
100and Qt3 doesn't support recursive configuring.
101.It Ev MODQMAKE_build
102Actual commands that module will use to build all
103.Ev MODQMAKE_PROJECTS
104provided.
105To be used in complicated cases, when port have to use its own
106.Ar do-build
107target or mix different
108.Ev CONFIGURE_STYLE
109values.
110.It Ev MODQMAKE_install
111Same as for
112.Ev MODQMAKE_build ,
113but used in
114.Ar do-install
115stage.
116.El
117.Sh SEE ALSO
118.Xr port-modules 5
119