37.4.1 The DESCRIPTION File

Last-modified: 2025-03-09 (日) 15:58:01

37.4.1 DESCRIPTION ファイル

の説明ファイルには、パッケージの名前、作成者、バージョンなど、パッケージに関するさまざまな情報が含まれています。このファイルは非常にシンプルな形式です。

'で始まる行#' はコメントです。
空白文字で始まる行は、前の行からの継続です。
その他はすべて の形式ですNameOfOption: ValueOfOption。
以下は、説明ファイル

Name: The name of my package

Version: 1.0.0
Date: 2007-18-04
Author: The name (and possibly email) of the package author.
Maintainer: The name (and possibly email) of the current

package maintainer.

Title: The title of the package
Description: A short description of the package. If this

description gets too long for one line it can continue
on the next by adding a space to the beginning of the
following lines.

License: GPLv3+
パッケージマネージャは現在、次のキーワードを認識します

Name
パッケージの名前。

Version
パッケージのバージョン。パッケージのバージョンは通常ドットで区切られた数字ですが、「+', '-', '~'、および英数字 ("C" ロケールの場合) で構成されます。たとえば、"2.1.0+"パッケージの開発バージョンを示すことができます。バージョンはcompare_versionsを使用して比較されます。

Date
最終更新日。

Author
パッケージのオリジナル作成者。

Maintainer
パッケージのメンテナー。

Title
パッケージの 1 行の説明。

Description
パッケージの 1 段落の説明。

Categories
パッケージを説明するオプションのキーワード(索引ファイルが指定されている場合は必須です。

Problems
既知の問題のオプションのリスト。

Url
パッケージに関連するホームページのオプションのリスト。

Depends
このパッケージが依存する他の Octave パッケージのリスト。これには、次の形式で特定のバージョンへの依存関係を含めることができます。

Depends: package (>= 1.0.0)
使用可能な演算子は<、、、、またはです。 の依存関係の部分が欠落している場合は、パッケージの任意<=のバージョンが受け入れられます。 複数の依存関係は、コンマ区切りのリストとして定義できます。 これを使用して、特定のパッケージのバージョンの範囲を定義できます。 ==>=>()

Depends: package (>= 1.0.0), package (< 1.5.0)
Octave コアの特定のバージョンに依存することも可能です。

Depends: octave (>= 3.8.0)
License
使用されているライセンスの短い説明(例:GPLバージョン3以降)。これは、ファイルコピー必須です。

SystemRequirements
これらはパッケージの外部インストール依存関係であり、パッケージ マネージャーによってチェックされません。これは、ディストリビューション パッケージャーへのヒントとしてここにあります。これらは、 Dependsキーワードと同じ規則に従います。

BuildRequires
これらはパッケージの外部ビルド依存関係であり、パッケージ マネージャーによってチェックされません。これは、ディストリビューション パッケージャーへのヒントとしてここにあります。これらは、Dependsキーワードと同じ規則に従います。一般に、またはrpmなどのパッケージング システムは、debビルド依存関係からインストール依存関係を自動検出するため、 BuildRequires依存関係によって依存関係の必要性がなくなる ことに注意してくださいSystemRequirements。

開発者は、追加の引数を自由に追加することができます。 説明ファイルは独自の目的のために作成されます。パッケージ作成者を支援するもう 1 つの詳細は、キーワードSystemRequirementsと BuildRequiresキーワードにディストリビューション依存のセクションがあり、自動ビルド プロセスでこれらが使用されることです。この形式の例を以下に示します。

ビルド要件: libtermcap-devel [Mandriva] libtermcap2-devel
最初のパッケージ名がデフォルトで使用され、RPM が Mandriva ディストリビューション上にビルドされている場合は、代わりに 2 番目のパッケージ名が使用されます。