install_man()

Installs the specified man files from the source tree into system's man directory during the install step. This directory can be overridden by specifying it with the install_dir keyword argument.

(since 0.49.0) manpages are no longer compressed implicitly.

Signature

# Installs the specified man files from the source tree into system's man directory
void install_man(
  file | str file...,  # Man pages to install

  # Keyword arguments:
  install_dir  : str               # Where to install to
  install_mode : array[str | int]  # Specify the file mode in symbolic format
  locale       : str               # Can be used to specify the locale
)

Arguments

The function accepts between 0 and infinity variadic arguments (file...) of type file | str.

Man pages to install.

The function install_man() accepts the following keyword arguments:

Name Type Description Tags
install_dir str

Where to install to.
install_mode array[str | int]

Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files.

See the install_mode kwarg of install_data() for more information.

(since 0.47.0)
locale str

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.58.0)

The results of the search are