Scroll to navigation

DH_INSTALLMAN(1) Debhelper DH_INSTALLMAN(1)

名前

dh_installman - パッケージビルドディレクトリ以下に man ページをインストールする

書式

dh_installman [debhelper options] [manpage ...]

説明

dh_installman is a debhelper program that handles installing man pages into the correct locations in package build directories for when upstream's build system does not properly install them as a part of its install step (or it does not have an install step).

If upstream's installs the manpages in the proper directories, dh_install(1) may be easier to use for deciding which package should ship the manpages. In this case, dh_installman can still be useful for converting the manpage encoding to UTF-8 and for converting .so links (as described below). However, that part happens automatically without any explicit configuration.

You tell it what man pages go in your packages, and it figures out where to install them based on the section field in their .TH or .Dt line. If you have a properly formatted .TH or .Dt line, your man page will be installed into the right directory, with the right name (this includes proper handling of pages with a subsection, like 3perl, which are placed in man3, and given an extension of .3perl). If your .TH or .Dt line is incorrect or missing, the program may guess wrong based on the file extension.

このコマンドは翻訳された man ページについても、.ll.8.ll_LL.8 の拡張子に持つファイルを探す事により、あるいは、--language を指定することによって扱います。

dh_installman が間違った章番号や、間違った拡張子をつけて man ページをインストールするように見えるときがあります。これは、man ページが間違った章番号を .TH.Dt 行に列挙しているのが原因です。この場合、man ページを編集して、章番号を正しくすれば、dh_installman は意図どおりに動作するようになります。.TH 章についての詳細は man(7) を参照ください。さらに、.Dt 章については、mdoc(7) を参照ください。また、dh_installman/usr/share/man/pl/man1/ のようなディレクトリへ man ページをインストールしてしまう場合があります。これは、パッケージにF <foo.pl> のような名前を持つファイルがあり、dh_installman がこれをポーランド語への翻訳済み man ページと勘違いする時となります。この動作を避けるには、--language=C を利用してください。

dh_installman は、man ページをインストールした後に、処理を行ったパッケージ内の一時ディレクトリ以下にある全 man ページを対象に、.so リンクを含むかどうかを確認します。もし存在するようであれば、その man ページ本体をシンボリックリンクへ変更します。

また、dh_installman は man コマンドを使って、man ページの文字コードを推定し、UTF-8 に変換します。この推定作業は失敗に終わる事があるので、文字コード宣言文を使って検出されるべき文字コードの情報を上書きできます。詳細については manconv(1) を参照ください。

ファイル

debian/package.manpages
インストールされるべき man ページを列挙したものです。

オプション

-A, --all
全パッケージに対して、コマンドラインパラメータに指定されたファイルを全てインストールします。
--language=ll
処理予定の man ページがどんな言語で記載されているかをこちらのオプションを使って指定します。
manpage ...
最初に処理するパッケージにこれらの man ページをインストールします (あるいは、-A が指定された場合は、全パッケージにインストールを行います)

使用例

An example debian/manpages file could look like this:

  doc/man/foo.1
  # Translations
  doc/man/foo.da.1
  doc/man/foo.de.1
  doc/man/foo.fr.1
  # NB: The following line is considered a polish translation
  # of "foo.1" (and not a manpage written in perl called "foo.pl")
  doc/man/foo.pl.1
  # ...

付記

本プログラムの昔のバージョンのプログラムである dh_installmanpages(1) を未だに利用しているパッケージが存在します。また、dh_installmanpages(1) は未だに debhelper に梱包されています。しかしながら、このプログラムは、非直感的で統一されていないインターフェースの為に、すでに廃止となっています。代わりに本プログラムを使ってください。

参照

debhelper(7)

このプログラムは debhelper の一部です。

作者

Joey Hess <joeyh@debian.org>
2017-05-26 10.4