aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Wiele <jwiele@redhat.com>2024-05-30 10:33:53 -0400
committerJohn Wiele <jwiele@redhat.com>2024-06-06 09:15:13 -0400
commit2e6f5c8bf296b26cd6af5de40b634b19ff216919 (patch)
treef0bd916be7442de2989b34bf48f45e9c7ec6eac8
parentcaa32abf45146941a80ce99bc97fb35ce7c59bfd (diff)
downloadmeson-2e6f5c8bf296b26cd6af5de40b634b19ff216919.zip
meson-2e6f5c8bf296b26cd6af5de40b634b19ff216919.tar.gz
meson-2e6f5c8bf296b26cd6af5de40b634b19ff216919.tar.bz2
Add help for meson compile to the man page.
The added help text was derived from the output of the meson help command much like the markdown online help is derived.
-rw-r--r--man/meson.156
1 files changed, 56 insertions, 0 deletions
diff --git a/man/meson.1 b/man/meson.1
index 37e3299..0467f66 100644
--- a/man/meson.1
+++ b/man/meson.1
@@ -453,6 +453,62 @@ Modify the project default options
\fBcommand (cmd)\fR
Execute a JSON array of commands
+.SH The compile command
+
+.B meson compile
+builds the project.
+
+.B meson compile [
+.I options
+.B ] [
+.I TARGET...
+.B ]
+
+.SS "positional arguments:"
+.TP
+\fBTARGET\fR
+Targets to build. Target has the following format:
+[PATH_TO_TARGET/]TARGET_NAME.TARGET_SUFFIX[:TARGET_TYPE].
+
+.SS "options:"
+
+.TP
+\fB\-h, \-\-help\fR
+show this help message and exit
+
+.TP
+\fB\-\-clean\fR
+Clean the build directory.
+
+.TP
+\fB\-C WD\fR
+directory to cd into before running
+
+.TP
+\fB\-j JOBS, \-\-jobs JOBS\fR
+The number of worker jobs to run (if supported). If the value is less
+than 1 the build program will guess.
+
+.TP
+\fB\-l LOAD_AVERAGE, \-\-load-average LOAD_AVERAGE\fR
+The system load average to try to maintain (if supported).
+
+.TP
+\fB\-v, \-\-verbose\fR
+Show more verbose output.
+
+.TP
+\fB\-\-ninja\-args NINJA_ARGS\fR
+Arguments to pass to `ninja` (applied only on `ninja` backend).
+
+.TP
+\fB\-\-vs\-args VS_ARGS\fR
+Arguments to pass to `msbuild` (applied only on `vs` backend).
+
+.TP
+\fB\-\-xcode\-args XCODE_ARGS\fR
+Arguments to pass to `xcodebuild` (applied only on `xcode` backend).
+
.SH EXIT STATUS
.TP