aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason Woodward <woodwardj@jaos.org>2021-02-21 23:46:20 -0500
committerJussi Pakkanen <jpakkane@gmail.com>2021-02-27 14:35:23 +0200
commit50af09de031c8d003cd9e6afb44b774620b45696 (patch)
tree52e16c84d9f9b851a05307e4fa4f053e44bab00c /docs
parent0047f7439c6bafe964438e2c59a3686201ff24c0 (diff)
downloadmeson-50af09de031c8d003cd9e6afb44b774620b45696.zip
meson-50af09de031c8d003cd9e6afb44b774620b45696.tar.gz
meson-50af09de031c8d003cd9e6afb44b774620b45696.tar.bz2
install_man locale support
Rather than having to manually build the locale aware man paths with `install_data('foo.fr.1', install_dir: join_paths(get_option('mandir'), 'fr', 'man1'), rename: 'foo.1')` Support doing `install_man('foo.fr.1', locale: 'fr')`
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Reference-manual.md5
-rw-r--r--docs/markdown/snippets/install_man_locale.md9
2 files changed, 14 insertions, 0 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 4c30ddd..e299be8 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1133,6 +1133,11 @@ Accepts the following keywords:
format and optionally the owner/uid and group/gid for the installed files.
An example value could be `['rwxr-sr-x', 'root', 'root']`.
+- `locale` *(since 0.58.0)*: can be used to specify the locale into which the
+ man page will be installed within the manual page directory tree.
+ An example manual might be `foo.fr.1` with a locale of `fr`, such
+ that `{mandir}/{locale}/man{num}/foo.1` becomes the installed file.
+
*(since 0.49.0)* [manpages are no longer compressed
implicitly][install_man_49].
diff --git a/docs/markdown/snippets/install_man_locale.md b/docs/markdown/snippets/install_man_locale.md
new file mode 100644
index 0000000..76b7967
--- /dev/null
+++ b/docs/markdown/snippets/install_man_locale.md
@@ -0,0 +1,9 @@
+## Specify man page locale during installation
+
+Locale directories can now be passed to `install_man`:
+
+```meson
+# instead of
+# install_data('foo.fr.1', install_dir: join_paths(get_option('mandir'), 'fr', 'man1'), rename: 'foo.1')`
+install_man('foo.fr.1', locale: 'fr')
+```