From 4a21c7454162318d8b3e59bd523788fcadc4645f Mon Sep 17 00:00:00 2001 From: Cagebreak Signing Key 3 Date: Fri, 5 Mar 2021 15:26:25 +0100 Subject: [PATCH] Add documentation of man page build --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e22c300..eb92a84 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,11 @@ option. Then, add `-Dxwayland=true` to the `meson` command above. Note that you'll need to have the XWayland binary installed on your system for this to work. +#### Man Pages + +Cagebreak has man pages. To use them, make sure that you have `pandoc` +installed. Then, add `-Dman-pages=true to the `meson` command. + ### Running Cagebreak You can start Cagebreak by running `./build/cagebreak`. If you run it from @@ -171,7 +176,7 @@ There are reproducibility issues up to and including release `1.2.0`. See All hashes and signatures are provided for the following build instructions. ``` -meson build -Dxwayland=true --buildtype=release +meson build -Dxwayland=true -Dman-pages=true --buildtype=release ninja -C build ```