Debian Codegraph @

subprojects/meson-docs/docs/yaml/functions/install_man.yaml

raw
1 name: install_man
2 returns: void
3 description: |
4 Installs the specified man files from the source tree into system's man directory
5 during the install step. This directory can be
6 overridden by specifying it with the `install_dir` keyword argument.
7
8 *(since 0.49.0)* [manpages are no longer compressed implicitly][install_man_49].
9
10 [install_man_49]:
11 https://mesonbuild.com/Release-notes-for-0-49-0.html#manpages-are-no-longer-compressed-implicitly
12
13 varargs:
14 name: file
15 type: file | str
16 description: Man pages to install.
17
18 warnings:
19 - the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0.
20
21 kwargs:
22 install_mode:
23 type: list[str | int | bool]
24 since: 0.47.0
25 description: |
26 Specify the file mode in symbolic format
27 and optionally the owner/uid and group/gid for the installed files.
28
29 See the `install_mode` kwarg of [[install_data]] for more information.
30
31 install_dir:
32 type: str
33 description: Where to install to.
34
35 locale:
36 type: str
37 since: 0.58.0
38 description: |
39 Can be used to specify the locale
40 into which the
41 man page will be installed within the manual page directory tree.
42 An example manual might be `foo.fr.1` with a locale of `fr`, such
43 that `{mandir}/{locale}/man{num}/foo.1` becomes the installed file.