1xmake(1)                    General Commands Manual                   xmake(1)
2
3
4

NAME

6       xmake - cross-platform build utility based on Lua
7
8
9

SYNOPSIS

11       xmake [task] [options] [target]
12
13
14

DESCRIPTION

16       xmake  is  a  lightweight cross-platform build utility based on Lua. It
17       uses  xmake.lua  to  maintain  project  builds.  Compared  with   make‐
18       file/CMakeLists.txt, the configuration syntax is more concise and intu‐
19       itive. It is very friendly to novices and can quickly get started in  a
20       short time. Let users focus more on actual project development.
21
22
23

ACTIONS

25       b, build
26              Build targets if no given tasks.
27
28
29       u, uninstall
30              Uninstall the project binary files.
31
32
33       p, package
34              Package target.
35
36
37       r, run Run the project target.
38
39
40       g, global
41              Configure the global options for xmake.
42
43
44       i, install
45              Package and install the target binary files.
46
47
48       c, clean
49              Remove all binary and temporary files.
50
51
52       create Create a new project.
53
54
55       q, require
56              Install and update required packages.
57
58
59       update Update and uninstall the xmake program.
60
61
62       f, config
63              Configure the project.
64
65
66

PLUGINS

68       plugin Manage plugins of xmake.
69
70
71       m, macro
72              Run the given macro.
73
74
75       doxygen
76              Generate the doxygen document.
77
78
79       l, lua Run the lua script.
80
81
82       repo   Manage package repositories.
83
84
85       service
86              Start  service  for  remote  or distributed compilation and etc.
87              (Experimental, still in development)
88
89
90       project
91              Generate the project file.
92
93
94       show   Show the given project information.
95
96
97

OPTIONS

99       -q, --quiet
100              Quiet operation.
101
102
103       -y, --yes
104              Input yes by default if need user confirm.
105
106
107       --confirm=CONFIRM
108              Input the given result if need user confirm.
109                - yes
110                - no
111                - def
112
113
114       -v, --verbose
115              Print lots of verbose information for users.
116
117
118       --root Allow one to run xmake as root.
119
120
121       -D, --diagnosis
122              Print lots of diagnosis information (backtrace, check  info  ..)
123              only for developers.  And we can append -v to get more whole in‐
124              formation.
125                e.g. $ xmake -vD
126
127
128       --version
129              Print the version number and exit.
130
131
132       -h, --help
133              Print this help message and exit.
134
135
136       -F FILE, --file=FILE
137              Read a given xmake.lua file.
138
139
140       -P PROJECT, --project=PROJECT
141              Change to the given project directory.  Search priority:
142                1. The Given Command Argument
143                2. The Environment Variable: XMAKE_PROJECT_DIR
144                3. The Current Directory
145
146
147

BUILD OPTIONS

149       -b, --build
150              Build target. This is default building mode and optional.
151
152
153       -r, --rebuild
154              Rebuild the target.
155
156
157       -a, --all
158              Build all targets.
159
160
161       --dry-run
162              Dry run to build target.
163
164
165       -j JOBS, --jobs=JOBS
166              Specifies the number of jobs to build simultaneously.  (default:
167              6)
168
169
170       -w, --warning
171              Enable the warnings output.
172
173
174       --files=FILES
175              Build the given source files.
176
177              e.g.
178                - xmake --files=src/main.c
179                - xmake --files='src/*.c' [target]
180                - xmake --files='src/**c|excluded_file.c'
181                - xmake --files='src/main.c:src/test.c'
182
183
184       target The  target  name. It will build all default targets if this pa‐
185              rameter is not specified.
186
187
188

AUTHOR

190       xmake is written by ruki ⟨waruqi@gmail.com⟩.
191
192       This manual page was written by Yangfl ⟨mmyangfl@gmail.com⟩ for the De‐
193       bian Project (and may be used by others).
194
195
196
197                                                                      xmake(1)