aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2013-06-23 00:07:26 +0300
committerJussi Pakkanen <jpakkane@gmail.com>2013-06-23 00:07:26 +0300
commit0e7a9c1281384075660754a966563969d19d0f04 (patch)
tree504e6763f70e0fc5505211a108890264a8949ffc /man
parentf18933f80c32c975cec43dffd9bee21a6e9748d7 (diff)
downloadmeson-0e7a9c1281384075660754a966563969d19d0f04.zip
meson-0e7a9c1281384075660754a966563969d19d0f04.tar.gz
meson-0e7a9c1281384075660754a966563969d19d0f04.tar.bz2
Improved the man page.
Diffstat (limited to 'man')
-rw-r--r--man/meson.138
1 files changed, 35 insertions, 3 deletions
diff --git a/man/meson.1 b/man/meson.1
index 813ede2..e078115 100644
--- a/man/meson.1
+++ b/man/meson.1
@@ -1,8 +1,40 @@
-.TH MESON "1" "February 2013" "meson 0.1.0" "User Commands"
+.TH MESON "1" "June 2013" "meson 0.5.0" "User Commands"
.SH NAME
-meson - an experimental build system
+meson - a high productivity build system
.SH DESCRIPTION
-usage: meson [options] [source directory] [build directory]
+
+Meson is a build system designed to optimize programmer
+productivity. It aims to do this by providing simple, out-of-the-box
+support for modern software development tools and practices, such as
+unit tests, coverage reports, Valgrind, CCache and the like.
+
+Using Meson is simple and follows the common two-phase
+process of most build systems. First you run Meson to
+configure your build:
+
+.B meson [
+.I options
+.B ] [
+.I source directory
+.B ] [
+.I build directory
+.B ]
+
+Note that the build directory must be different from the source
+directory. Meson does not support building inside the source directory
+and attempting to do that leads to an error.
+
+After a successful configuration step you can build the source by
+running the actual build command in the build directory. The default
+backend of Meson is Ninja, which can be invoked like this.
+
+\fBninja [\fR \fItarget\fR \fB]\fR
+
+You only need to run the Meson command once: when you first configure
+your build dir. After that you just run the build command. Meson will
+autodetect changes in your source tree and regenerates all files
+needed to build the project.
+
.SS "options:"
.TP
\fB\-\-version\fR