自分で port を作る
原作: &a.jkh;, &a.gpalmer;, &a.asami;, &a.obrien; and
&a.hoek;.
28 August 1996. .
訳: &a.simokawa;, &a.asami;.
10 November 1996.
自分で port を作ることに興味がありますか, すばらしい! これから, FreeBSD用のportを作る際の, いくつかのガイドラインを
説明します. 実際にportをコンパイルするときのほとんどの仕事は
/usr/share/mk/bsd.port.mk というファイルでおこないます.
Portsコレクションについてのさらに細かい内部の働きについては, そちらの
ファイルを参照してください. これにはコメントが細かく書いてありますので,
Makefile を読むのにあまり慣れていない人でも, 得るものはとても大きいで
しょう.
注意: ここでは, 変更可能な変数の一部についてのみ記述してい
ます. ほとんどの変数はbsd.port.mk の始めに記述があり
ます. また, このファイルは非標準のタブの設定になっていま
す. Emacs や Vim はファイルのロード時にこれ
を認識しますが, vi やex では, ファイルをロード
したら `:set tabstop=4 'のようにして正しい値を設定する
ことができます.
3分porting
この節では, 簡単なportの方法について説明します. 多くの場合これ
では不十分ですが, まあうまくいくかどうか試してみて損はないでしょ
う.
まず, 元のtarファイルを${DISTDIR} に置きます.
デフォルトは/usr/ports/distfiles です.
注: 以下では, ソフトウェアはそのままコンパイルされるとします.
つまり, FreeBSDのマシンで動かすために, 変更がまったく必要ない
とします. もしなにか変更が必要な場合には次の節も参照する必要
があります.
Makefileの作成
最小限のMakefile は次のようなものです:
# New ports collection makefile for: oneko
# Version required: 1.1b
# Date created: 5 December 1994
# Whom: asami
#
# $Id$
#
DISTNAME= oneko-1.1b
CATEGORIES= games
MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/
MAINTAINER= asami@FreeBSD.ORG
MAN1= oneko.1
MANCOMPRESSED= yes
USE_IMAKE= yes
.include
おわかりになりますでしょうか. $Id$ があ
る行の内容については, 気にしないでください. これはこのファイル
がportsツリーに書き込まれるときにCVSによって自動的に書
き込まれます. もっと詳しい例が見たければ, [の節をご覧ください.
]
Package記述ファイルの作成
どのようなportでも, packageにするしないに関わらず, 3つ
の記述ファイルが必要です. pkg サブディレクトリにある,
COMMENT , DESCR , それにPLIST です.
COMMENT
これには, そのportについての説明を1行で書きます. Package
の名前, バージョン番号等は含めない でください.
たとえば, こんな具合です:
A cat chasing a mouse all over the screen
DESCR
これは, そのソフトウェアについての, すこし長い説明を記述
します. その port が何をするのかについての数段落程度の簡潔
な解説があれば十分です. このファイルはマニュアルでもなけれ
ば, 使用方法やコンパイル方法についての細かい説明書でもあり
ません. 特に, README ファイルや manpage をコ
ピーしようとしてしている場合には注意してください
このファイルの最後にあなたの名前を書くことが推奨されています.
たとえば, こんな具合です.
This is a port of oneko, in which a cat chases a poor mouse all over
the screen.
:
(うんぬん.)
http://www.oneko.org/
- Satoshi
asami@cs.berkeley.edu
PLIST
このファイルには, このportによってインストールされるファ
イルが列挙されます. このファイルはpackageを作る際のリス
トとして使われるため, `packing list' とも呼ばれます. ここ
に書かれているファイル名は, インストール時のプレフィックス
(普通は /usr/local か /usr/X11R6 ) からの
相対パスです. 簡単な例を載せておきましょう:
bin/oneko
lib/X11/app-defaults/Oneko
lib/X11/oneko/cat1.xpm
lib/X11/oneko/cat2.xpm
lib/X11/oneko/mouse.xpm
@dirrm lib/X11/oneko
'Packing list'の詳細については, pkg_create(1) の
マニュアルを参照してください. すべてファイルを列挙しなければ
なりませんが, ディレクトリ名は必要ありません. また, ports が
インストール時にディレクトリを作成する場合には, このファイルには, ファイル名をアルファベット順に並べるよう
にしてください. port のアップグレートのとき, 楽に確認ができ
るようになります.
チェックサムファイルの作成
ただ, `make makesum ' と入力するだけです.
bsd.port.mk にルールがあるので, 自動的にfiles/md5 が
生成されます.
Portのテスト
そのportが正しく動くことを, package化を含めて確認してく
ださい. 以下の重要なポイントを確認してください.
deintall の際に
[をすること.
]
推奨されるテストの手順:
make install
make package
make deinstall
pkg_add `make package-name`
make deinstall
make reinstall
make package
portlint でチェック
portlint を使って, あなたの port が我々のガイドライン
そっているかを確認してください.
[
が正しい形式になっているか, ][
の名前が正しいか, をチェックするのに良いでしょう.
]
Portの送付
まず, [
についての節を読んでください.
]さあ, あなたのportに満足したら, あとはそれをFreeBSDのメイ
ンの ports ツリーに置いて, 皆に使ってもらうだけです.
いまある work/ ディレクトリや pkgname.tgz
パッケージは必要ありませんから, まず消去してください.
あとは, バグレポートの中に `shar `find port_dir` '
の出力を, send-pr(1) プログラムを使用して送ってくだ
さい. (send-pr についての詳細は, [を参照してください.)
もし, 圧縮していない状態で, 20KB以上あるようなポートで
あれば, 圧縮して tar ファイルにして, バグレポートに入れる前に
]uuencode(1) を使用してください. (20KB以下のものでも,
tar ファイルにして送ってもよいですが, あまり歓迎されません).
バクレポートの category は `ports', class は `change-request'
を必ず使用してください. (レポートを `confidential'(内密) に
しないようにしてください!)
もう一度, オリジナルのソースファイル, work/
ディレクトリ, `make package 'で作成したパッケージが
含まれていないこと を確認してください.
注: 以前, 新しい port をわれわれの ftp サイト
(:<
私たちは, 何か不明な点があったらあなたに確認したのち,
それをツリーへ置きます. あなたの名前は, FreeBSD
ハンドブックやその他のファイルの `Additional FreeBSD
contributors' のリストにも載るでしょう. う〜ん, 素晴らし
い. :)
本格的なport
残念ながら, 移植がそう簡単ではなく, 動かすために多少の変更が
必要な場合も多いでしょう. この節では, portsコレクション
の方法論にのっとって, そのような場合にどのように変更を施し, 動
くようにしたらよいかを順を追って説明します.
port構築の詳細
まず, あなたがportのディレクトリで `make ' とタイ
プしてから起こる一連の出来事について,順を追って説明しま
す. ここを読むときには, 他のウィンドウで同時に
bsd.port.mk も開いておくとよいかもしれません.
しかし, bsd.port.mk が何をしているのか, 完全に理解
できなくても心配する必要はありません. そう多くの人が理解して
いるわけではないですから... f(^_^;)
- まず, fetchというターゲットが実行されます. このfetchターゲッ
トはローカルディスクの
${DISTDIR} に配布ファ
イルがあるようにするのが役目です. もし, fetchが必要なファ
イルを${DISTDIR} に見つけることができなけ
れば, Makefileに指定されているURL
${MASTER_SITES} , そして私たちのFTPサイトで
ある (ここ
には, 私たちが取ってきたファイルをバックアップとして置いてあ
ります) に探しにいきます. そして, ユーザのサイトがインター
ネットに直接接続されている場合には,
${FETCH} を使って, その名前のファイルを取っ
てきて, ${DISTDIR} に保存します.
- 次に実行されるのはextractターゲットです. これは,
${DISTDIR} にある, 配布ファイル (普通は
gzipされたtarファイル) を読み, ソースを一時的な作業ディレ
クトリ${WRKDIR} (デフォルトは
work ) に展開します.
- 次に, patchというターゲットが実行されます. まず,
${PATCHFILES} に定義されている, すべてのパッ
チをあてます. 次にもし${PATCHDIR} (デフォ
ルトはpatches サブディレクトリ) にパッチが存在す
れば, これらをアルファベット順にあてます.
- 次に実行されるターゲットはconfigureです. これには, い
ろいろな場合があります.
- もし存在すれば,
scripts/configure が実行されます.
- もし,
${HAS_CONFIGURE} あるいは
${GNU_CONFIGURE} がセットされていれば,
${WRKSRC}/configure が実行されます.
- もし,
${USE_IMAKE} がセットされていれば,
${XMKMF} (デフォルト: `xmkmf
-a ') が実行されます.
- 最後に, buildというターゲットが実行されます. これは, そのport
の専用の作業ディレクトリ (
${WRKSRC} ) にい
き, コンパイルするのが役目です. もし
${USE_GMAKE} がセットされていれば, GNU
make が使用されます. さもなければFreeBSDの
make が使用されます.
上記はデフォルトのルールです. さらに, `pre-<何とか
> や `post-<何とか> ' というターゲット
が定義してあったり, そのような名前のスクリプトが
scripts サブディレクトリに置いてある場合には, それ
らはデフォルトの動作の前後に実行されます.
たとえば, post-extract というターゲットがMakefile
で定義されていて, pre-build というファイルが,
scripts サブディレクトリにあるとすると,
post-extract ターゲットは, 通常の展開動作のあとに呼
び出され, pre-build スクリプトはデフォルトのコンパイ
ルのルールが実行される前に実行されます. もし動作が簡単であれ
ば, Makefileのターゲットを使用することが推奨されています. な
ぜならば, そのportが何らかのデフォルトではない動作を必要とす
るのかどうかが一箇所にまとめて書いてあった方が他の人に理解しやす
いからです.
デフォルトの動作はbsd.port.mk の
`do-<何とか> ' というターゲットでおこなわれます.
たとえば, portを展開するコマンドは, `do-extract '
というターゲットにあります. もし, デフォルトのターゲットに
不満があれば, `do-<something> ' というターゲッ
トを再定義することによって, どのようにでも直すことができます.
「メイン」のターゲット (例えば, extract ,
configure 等) は, すべての前段階が実行されていること
を確認して, 実際のターゲットやスクリプトを呼び出す以外のこと
はしません. bsd.port.mkはこれらが変更されることは仮定してい
ませんので, もし, 例えば, 展開の仕方を直したいときには,
do-extract を直し, 絶対にextract には手を
触れないでください.
これで, ユーザが `make ' と入力したときに何が起こ
るのかが理解できたと思います. では, 完璧なportを手順を追っ
て作ってみましょう.
オリジナルのソースの入手
オリジナルのソースを, (普通は) 圧縮されたtarファイルの形
(<foo>.tar.gz あるいは
<foo>.tar.Z ) で入手して, それを
${DISTDIR} にコピーします. 可能なかぎり, 広
く使われている主流の ソースを使用するようにしてください.
もし, ネットワークへの接続のよい FTP/HTTP サイトを見つけるこ
とができなかったり, 頭にくるような非標準的な形式しか持ってい
ないサイトしか見つけられないときには, 自分で管理する確実な
ftp か http サーバ (たとえば, あなたのホームページ)に置くこと
ができます. MASTER_SITES に正しく反映されていること
を確認してください.
もしも, そのような都合の良く, 安心な置き場所が見つけられない
場合(あなたが FreeBSD の committer であれば, 自分の
public_html ディレクトリに置けます), 私たちが,
ftp://ftp.FreeBSD.ORG/pub/FreeBSD/distfiles/LOCAL_PORTS/
${MASTER_SITE_LOCAL} を使って参照してくださ
い. これについての問い合わせのメールは &a.ports へお願いしま
す.
その port の配布ファイルが特に理由もなく, しょっちゅう
変る場合には, 配布ファイルをあなたのホームページに置いて
MASTER_SITES の最初に入れてください. こうすること
によって, ユーザ利用する場合に `checksum mismatch' エラー
が起るのを防ぎ, 我々の ftp サイトの保守の負担を
減らすことができます. もし, master site がたった一つ
しかない場合には, あなたのサイトにバックアップを置いて
MASTER_SITES の2番目に加えてください.
もし, あなたのportに必要ないくつかの追加パッチがインター
ネット上で手に入るのならば, それらも取ってきて,
${DISTDIR} に置きます. もし, それらがメイン
のソースのtarファイルとは別のサイトにあっても, 心配する必要
はありません. そのような状況にはちゃんと対応できるようになっ
ています. (以下の[をご覧ください).
]
Portの修正
適当なディレクトリにtarファイルを展開して, FreeBSDの最新の
バージョン上で, 正しくコンパイルできるために必要なあらゆる変
更を施します. 最終的に処理は自動化するわけですから, 何をおこなっ
たかを注意深く記録しておきましょう . あなたのport
が完成した暁には, ファイルの削除, 追加, 修正を含むすべての処
理が, 自動化されたスクリプトやパッチファイルでおこなえるようになっ
ていないといけません.
もし, あなたのportのコンパイルやインストールのために必要
な手作業があまりに多いようならば, Larry Wallの模範的な
Configureスクリプトでも参考にしたほうがいいかもしれませ
ん. 新しいportsコレクションは, 最小のディスクスペースで,
個々のportがエンドユーザにできるだけ「プラグ & プレ
イ」の状態でmakeできることをめざしています.
注意: あなたが作成しFreeBSDのportsに寄付されたパッチファイル,
スクリプトおよびその他のファイルは，明示的に記述されている場合
を除いては, BSDの標準的な著作権条件によりカバーされていると見な
されます．
パッチをあてる
portの過程で追加されたり変更されたファイルは再帰的diffで変
更点を取り出すことができます. パッチは適当にまとめて,
`patch-<xx> ' という名前のファイルに入れてくだ
さい. <xx> はパッチが適用される順番を示します --
これらは, アルファベット順 , つまり `aa ' が
最初, つぎに `ab ' などとなります. これらのファイル
を${PATCHDIR} に置いておくと, 自動的に適用さ
れるようになっています. すべてのパッチは
${WRKSRC} (通常は, portのtarファイルが展
開されるところで, makeが実行されるところと同じです) からの相
対パスになります. 修正やアップグレードを容易にするため, 2つ
以上のパッチが同じファイルを修正するのは避けてください. (例,
patch-aaとpatch-abが共に${WRKSRC} /foobar.c
を修正する, など.)
コンフィグレーション
カスタマイズのために追加したいコマンドがあれば,
configure という名前のスクリプトに入れて
`scripts ' サブディレクトリに置きます. 上で述べたよ
うに, pre-configure あるいはpost-configure
というMakefileのターゲットおよび/あるいはスクリプトで処理す
ることもできます.
ユーザからの入力の扱い
もし, そのportがビルド, コンフィグレーション, インストー
ルの際にユーザからの入力を必要とするならば, Makefileで
IS_INTERACTIVE をセットしてください. これによって,
深夜, 自動的にたくさんのportをコンパイルすることが可能にな
ります. 環境変数BATCH がセットされていると
IS_INTERACTIVE の定義されているportはスキップされ
ます (そして, ユーザがINTERACTIVE という変数をセッ
トすると入力を必要とするportのみ コンパイルされま
す).
もし, 適切なデフォルト設定があるのであれば,
Makefileの作成
Makefileの作成は非常に単純です. 繰り返しになりますが, 始める
まえに, すでにある例を見てみることをお奨めします. またこのハ
ンドブックには[
があります. それを見て, Makefile内の変数の順番や空行を入れると
ころなどの参考にしてください. そうすると他の人々にも読みやすい
ものとなります.
]では, Makefileをデザインするときに問題となるところを順に追っ
て見てみましょう.
オリジナルのソース
ソースは${DISTDIR} に, 標準的なgzipされた
tarファイルとして置かれていますか? そうであれば, 次のステッ
プに進めます. そうでなければ, 変数
${EXTRACT_CMD} ,
${EXTRACT_BEFORE_ARGS} ,
${EXTRACT_AFTER_ARGS} ,
${EXTRACT_SUFX} ,
${DISTFILES} を適当に書き換えないといけません.
どれだけ変更しないといけないかは, あなたのportの
配布ファイルがどの程度標準からかけはなれているかによりま
す. (最もよくある場合は, gzipではなく普通のcompressコマンド
でtarファイルが圧縮されている場合で,
`EXTRACT_SUFX=.tar.Z ' とするだけです.)
最悪の場合には, 自分で `do-extract ' ターゲットを作
成して, デフォルトを上書きすることもできます. しかし, そこま
でする必要があることはめったにないでしょう.
DISTNAME
${DISTNAME} にはportの名前の基幹部分を入れ
ます. デフォルトのルールでは, 配布ファイルのリスト
(${DISTFILES} ) は
${DISTNAME}${EXTRACT_SUFX} という名前
になっています. 例えば, `DISTNAME=foozolix-1.0 'の場
合, 通常のtarファイルだと,
foozolix-1.0.tar.gz
work/${DISTNAME} というサブディレクトリ
に展開されることを仮定しています, 例えば
work/foozolix-1.0/
${DISTFILES} を設定してください. もし,
${DISTFILES} の一部だけが実際に展開される場合
には, それらを${EXTRACT_ONLY} に設定してくだ
さい. この変数が定義されている場合には, 展開時に
${DISTFILES} に優先して利用されます. 残りのファ
イルも${DISTDIR} に取ってきますが, 展開時に
はなにもせずに後で使うためにそのまま置いておかれます.
PKGNAME
もし, ${DISTNAME} が我々の
[
に沿ったものでない場合には, ]${PKGNAME} にもっと良い
名前を設定してください. 詳細は上記のガイドラインを参照してください.
CATEGORIES (分類)
完成したpackageの実体は/usr/ports/packages/All
に置かれます. また, 1つかそれ以上の
/usr/ports/packages のサブディレクトリからのシンボリッ
クリンクが作られます. それらのサブディレクトリの名前が
${CATEGORIES} という変数によって指定されます.
これは, ユーザがFTPサイトやCD-ROMのpackageの山を渡り歩
くことを容易にするためです. 現在存在する
[を見て, そ
のportに適したもを選んでください.
]このリストは, この port が port tree のどこに import
されるかも決定します. 2つ以上のカテゴリを指定した場合には
最初のカテゴリで指定されるサブディレクトリに置かれること
になります. 適切なカテゴリを選ぶ方法については,
[の節を
参照してください.
]もしそのportが本当に現在存在するすべてのものとは異なって
いる場合には, 新しいカテゴリ名を作ることもできます.
その際には, &a.ports 宛てに新しいカテゴリ名を提案する
メールを送ってください.
カテゴリ名については, なんのエラーチェックも行なわれません.
ミスタイプがあっても`make package ' はなにも考えずに
新しいディレクトリを作ってしまいますので, 注意してください.
MASTER_SITES
オリジナルの配布ファイルを指し示すFTPまたはHTTPのURLのディ
レクトリ部分までを${MASTER_SITES} に記録しま
す. スラッシュ (/ ) を最後につけることをお忘れなく.
配布ファイルがシステム上に存在しないときに, makeマクロは
${FETCH} でこの変数に指定されたサイトから取っ
てきます.
複数の, できれば異なる大陸のサイトをこのリストに入れておく
ことが推奨されています. これによって, 広域ネットワークにトラ
ブルがあった場合でも成功する可能性が高くなります. 私たちはさら
に, 自動的に最も近いマスタサイトを検出して, そこから取って
くるメカニズムの導入を計画しています.
オリジナルのtar ファイルが, X-contrib, GNU, Perl CPAN, TeX CTAN
または Linux Sunsite などの有名なアーカイブにある場合には,
MASTER_SITE_XCONTRIB, MASTER_SITE_GNU,
MASTER_SITE_PERL_CPAN, MASTER_SITE_TEX_CTAN および
MASTER_SITE_SUNSITE を利用することで, 簡単にこれらのサイトを
指定することができます. あとは MASTER_SITE_SUBDIR にアーカイ
ブ内でのパスを指定するだけです. 以下に例を示します.
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
ユーザは/etc/make.conf 中で MASTER_SITE_* 変数を設定
することによって, デフォルトの FTP サイトではなく, これらの
有名なアーカイブのミラーの中で好みのものを使用することが可能
です.
PATCHFILES
もし, オリジナルの配布ファイル以外にもFTPかHTTPで手に入る
パッチが必要な場合には, ${PATCHFILES} にファ
イル名を, ${PATCH_SITES} にサイトとディレクト
リの名前を${MASTER_SITES} と同様に設定してく
ださい.
そのパッチ内のファイル名ががソースツリーの一番上のディレク
トリ (${WKRSRC} ) からの相対パスになっていな
い場合には, ${PATCH_DIST_STRIP} を指定してく
ださい. 例えば, パッチ内のファイル名にすべて余計な
`foozolix-1.0/ ' がついている場合には,
`PATCH_DIST_STRIP=-p1 'としてください.
これらのパッチは圧縮されていても大丈夫です. ファイル名が
`.gz ' か `.Z ' で終わる場合には自動的に復元
されるようになっています.
もしパッチが, 文書などその他のファイルと一緒にgzipされた
tarファイルで配布されている場合には，単純に
${PATCHFILES} を使うことはできません.
このような場合には, このパッチの tar ファイルの名前と場所を
${DISTFILES} と ${MASTER_SITES}
に加えます. それから, pre-patch ターゲットで,
パッチコマンドを走らせるか, パッチファイルを
${PATCHDIR} ディレクトリに
patch-<xx> という名前でコピーするかして,
パッチを適用するようにします．(普通の gzip か compress された
tar ファイルであれば，通常のソースファイルと一緒にその時までに
展開されていますので，明示的に展開する必要はありません．)
もし，後者の方法を使用する場合には，すでにそのディレクトリにある
なにかを上書きしないように, 注意する必要があります.
さらに, pre-clean ターゲットにコピーしたパッチファイル
を削除するコマンドを追加するのを忘れないでください.
MAINTAINER
あなたのメールアドレスをここに入れてください. お願いします.
:)
保守担当者(maintainer)の責任についての詳細は，
[
の節をご覧ください．
]
依存関係
このプログラムが他のportに依存する場合には, 必要なものが
自動的に作られるようにすることができます. そのために, 以下の
5つの変数が用意されています. よくあるケースのために
あらかじめ設定された依存変数や, いくつかの依存関係の制御のため
の変数があります.
LIB_DEPENDS
Portが必要とする非標準の共有ライブラリをこの変数で指定
します. これは `lib:dir[:target] ' という組のリストで,
lib が共有ライブラリの名前, そしてdir
がそのライブラリが見つからない場合にインストールするport
のあるディレクトリで,
LIB_DEPENDS= jpeg.9:${PORTSDIR}/graphics/jpeg:install
と指定してあれば, まずメジャーバージョンが9のjpegライブ
ラリがあるかどうか確認し, ない場合にはportsツリーの中の
graphics/jpeg というサブディレクトリに移動し, そこ
でコンパイルとインストールを行ないます. `${DEPENDS_TARGET} (デフォルトは
`lib 部分は `ldconfig -r | grep -wF '
への引数になります. この変数には正規表現を入れられません.
この依存関係は2度チェックされます. まず pkg_add が自動的にインストールします.
RUN_DEPENDS
Portを使用する際に必要となるファイルまたはプログラムがある
ときにはこの変数で指定します. これは`path:dir[:target] '
という組のリストで, path がファイルまたはプログラムの
名前, そしてdir がそれが見つからない場合に作成する
ためのディレクトリ名で, 'Path の最初の文字がスラッ
シュ (/ ) の場合にはファイルかディレクトリとみなし,
その存在を `test -e ' でチェックします; そうでない
場合には実行可能であると仮定し, `which -s ' を使って
そのプログラムがユーザのサーチパス上にあるかどうか確認します.
例えばMakefileに以下のように書いてあるとします.
RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \
wish8.0:${PORTSDIR}/x11-toolkits/tk80
/usr/local/etc/innd ' というファイルか
ディレクトリが存在するか確認し, ない場合にはportsツリーの中の
news/inn というサブディレクトリから作られます. ま
た, `wish8.0 ' というプログラムがユーザのサーチパス中
にあるかどうか探し, ない場合には同じくportsツリーの
x11-toolkit/tk80 というサブディレクトリから作られます.
(この例で, `innd ' は実際にはプログラムです; この
ように, プログラムであっても標準のサーチパス以外のところに
あるようなものの場合には, 絶対パスで指定してください.)
この依存関係はinstall ステージのはじめでチェック
されます. また, packageを作る際に必要となるportのpackage名
が記録され, pkg_add を使用するとユーザのシステム
に存在しない場合には自動的にそちらのpackageもインストール
されるようになります. `${DEPENDS_TARGET} と同じ場合には省略可能
です.
BUILD_DEPENDS
Portのコンパイルに必要なファイルまたはプログラムがある
ときは, この変数で指定してください. RUN_DEPENDS と同
様に, これは `path:dir[:target] ' という組のリストです.
例えば,
BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip
unzip ' という名前のプログラムを探し, 見つから
ない場合にはarchivers/unzip サブディレクトリで作
れという意味になります.
ここでは「コンパイル」と一口にいいましたが, この変数は実際
にはファイルの展開から実際のコンパイル・リンクまで全部をま
とめて面倒を見てくれます. この依存関係はextract
ステージからチェックされます. `${DEPENDS_TARGET} と同じ場合には省略可能です.
FETCH_DEPENDS
この変数は, portを取ってくるのに必要なファイルまたはプロ
グラムを指定するのに使います. 上の二つと同様に, これは
`path:dir[:target] ' という組のリストです. 例えば,
FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2
ncftp2 ' という名前のプログラムを探
し, 見つからない場合にはnet/ncftp2 サブディレク
トリにいってインストールします.
この依存関係はfetch ステージからチェックされます.
`${DEPENDS_TARGET}
と同じ場合には省略可能です.
DEPENDS
上記の四つのいずれにもあてはまらないような依存関係がある場
合, または他の port がインストールされれているだけではなく,
ソースが展開されている必要がある場合にはこの変数
を使います. これは `dir[:target] ' という形式のリスト
になります. 上記の四つと違って特に「確認」するものがありませ
んので.
よくある依存関係を表す変数
もし ports が X Window System を必要とするのであれば,
`USE_XLIB=yes ' を定義してください. (これは
USE_IMAKE も意味します) BSD USE_GMAKE=yes '
を定義. 動作するのに GNU autoconf を必要とする場合には,
`USE_AUTOCONF=yes ' を定義. 最新の qt toolkit を使用
する場合には `USE_QT=yes ' を定義. perl 言語の
バージョン5 を必要とする場合には, `USE_PERL5=yes '
を定義してください. (特に最後のは重要で, FreeBSD のいくつかの
バージョンでは基本システムに perl5 を含みますが, 他のものは
含んでいません.)
依存関係に関する注意
上で述べたように, 依存する ports が必要になったときに
呼ばれるデフォルトのターゲットは
${DEPENDS_TARGET} で, そのデフォルトは
`${DEPENDS_TARGET} を再定義
するのではなく, *_DEPENDS 変数の ``make clean ' とタイプしたときには, 依存する
port も自動的に clean されます. もしそうしたくない場合
には, 無条件に他の port に依存させるには, 特別に `
BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract
これは, 常に JPEG port の directory に行きソースの展開
を行ないます.
あなたがやりたいことが他の方法ではできない場合以外は,
`
コンパイル時の特別な指定
GNUのmake を使う場合には, `USE_GMAKE=yes '
と指定してください. Portに GNU configure が含まれ
ている場合には, `GNU_CONFIGURE=yes ' を使います
(これは, configure に追加の引数 (デフォルトでは, GNU の
--prefix=${PREFIX} ',
GNUでない${CONFIGURE_ARGS} で指定してください.
そのパッケージが USE_AUTOCONF=yes ' を使います. これは,
X Window Systemのアプリケーションなど, imake を
使ってImakefileからMakefileを作成するportの場合には
`USE_IMAKE=yes ' を指定してください. コンフィグレー
ションステージで自動的にxmkmf -a が実行されます. も
し `-a ' フラグが問題をもたらすなら, さらに
`XMKMF=xmkmf 'としてください.
もし, port が imake を使用するけれども, `install.man '
ターゲットがない場合には, `NO_INSTALL_MANPAGES=yes '
を指定してください. ついでに, その port のオリジナルの
作者を探し出して八つ裂きにするといいでしょう. :>
PortのMakefileが `all ' 以外のものをメインのター
ゲットとしている場合には, ${ALL_TARGET} でそ
れを指定してください. `install ' と
${INSTALL_TARGET} も同様です.
もし, port の元の Makefile が `all ' 以外のターゲット
をメインのターゲットとしている場合には,
${ALL_TARGET} をそれに合わせて設定してください.
`install ' と ${INSTALL_TARGET} に
ついても同様です.
特別な配慮
Portを作成する場合, 考慮しなくてはいけないことがさらにいくつか
あります. この節では, それらのうちもっともありがちなものに
ついて説明します.
ldconfig
共有ライブラリをインストールするときには, 共有ライブラリのキャッ
シュを更新するためにportのMakefileのpost-install
target から`${LDCONFIG} -m ' を走らせてください.
このコマンドの引数は共有ライブラリのインストールしてあるディ
レクトリ (通常 ${PREFIX}/lib ) です.
また, pkg/PLIST に@exec /sbin/ldconfig -m
'/`@unexec /sbin/ldconfig -R ' の組を入れて, package
をインストールした場合にも共有ライブラリがすぐ使え, 削除の際
にも, システムがまだライブラリが存在すると誤認しないようにし
てください. この行は共有ライブラリを指定する行のすぐ後に書く
のがよいでしょう:
lib/libtcl80.so.1
@exec /sbin/ldconfig -m %D/lib
@unexec /sbin/ldconfig -R
絶対に 引数なしでただ `ldconfig 'とだけ書い
てある行をMakefileやpkg/PLISTファイルに入れないでください.
このコマンドを実行すると, 共有ライブラリのキャッシュが
/usr/lib の内容のみとなり, ユーザのマシンにさまざま
な問題をもたらします (「ぎゃぁ! このportをインストールした
らxinitが使えなくなっちゃった!」). この掟を破った者は, 永久
に地獄の底で苦しみ続けるように, 閻魔様に頼んでおきます.
ELF 対応
FreeBSD は 3.0-release 以後, ELF に移行しますので,
シェアードライブラリを作成するたくさんの port を ELF 対応
にする必要があります. 3.0 システムは ELF も a.out も
実行できますし, 2.2 ブランチからのもう一つのリリース (2.2.8)
もあるので, 複雑な状況です. 以下は a.out のみに対応している
port をどのように a.out と ELF 両方に対応させるかのガイドライ
ンです.
このリストの一部は, 移行時にしかあてはまらないものもあります
が, 古い port をアップグレードしたい場合に参考になるように,
しばらくのあいだは残しておきます.
a.out ライブラリの退避
a.out ライブラリは, /usr/local/lib から,
`src/Makefile にある
`
フォーマット
port ツリーは package をそのマシンのフォーマットで作成しま
す. つまり, 2.2 では a.out, また 3.0 では
`objformat` の結果によって, a.out か ELF になります.
また, いったん a.out ライブラリをサブディレクトリに移動すると
a.out ライブラリの作成はサポートされません. (つまり, あなたがな
にをすれば良いのかを理解しているのならば, うまく作成できるかもし
れませんが, 自力でやらなければならないということです)
注: もし port が aout でしか動作しないのなら,
PORTOBJFORMAT
PORTOBJFORMAT=${PORTOBJFORMAT} ' とし
て この変数は, 以下のようにして
PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat ||
echo aout
この変数を使って, port の make の過程で何をすべきかを決定す
べきですが, もし port の
共有ライブラリの作成
以下は, a.out と ELF での共有ライブラリの扱いの違いです.
共有ライブラリのバージョン ELF の共有ライブラリ
は, "リンカコマンドライン直接 'cc -shared ' を使用してください. たった一つの違いは,
ELF には, `-Wl,-soname,libfoo.so.M ' コマンドライ
ンにを加える必要があることです.
ELF のリンカを満足させるためには, libfoo.so ->
libfoo.so.N というシンボリックリンクを作る必要があり
ます. これは,
すべての port の Makefile を編集して, foo\\.1\\.\\(33|40\\) ' -> `foo.2 '.)
マッチングは `grep -wF ' 使って行われます.
ELF システムで 2 つのバージョン番号を持つ共有ライブラリをイ
ンストールしたり, aout システムで 1 つのバージョン番号しか持
たない共有ライブラリをインストールするのが避けられない場合
(例えば他のオペレーティングシステム用の互換ライブラリをイン
ストールする port など),
Makefile 中の
${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....
また
@exec /usr/bin/env OBJFORMAT=%%PORTOBJFORMAT%% /sbin/ldconfig -m ...
@unexec /usr/bin/env OBJFORMAT=%%PORTOBJFORMAT%% /sbin/ldconfig -R
となります. これは, システムのデフォルトフォーマットではなく
パッケージのフォーマットに応じて, 正しい
もし, あなたの port が 変数(例えば 解像度とか紙のサイズなど)
を変えたりした, ちょっと違うバージョンを作成する必要があるとき
には, ユーザが分りやすいように, package ごとに別々のサブ
ディレクトリを作成し, ただし, できるだけ port 間でファイル
を共有するようにしてください. 典型的な例では, うまく変数を
使えば, とても短いMakefileだけ, 1つ以外のすべてのディレクトリ
に置くだけで済みます. その短い Makefile には
${MASTERDIR} を使って, 残りのファイルがある
ディレクトリを指定できます. また
以下が, とても良い例になるでしょう. これは
japanese/xdvi300/Makefile の一部です:
:
PKGNAME= ja-xdvi${RESOLUTION}-17
:
# default
RESOLUTION?= 300
.if ${RESOLUTION} != 118 && ${RESOLUTION} != 240 && \
${RESOLUTION} != 300 && ${RESOLUTION} != 400
@${ECHO} "Error: invalid value for RESOLUTION: \"${RESOLUTION}\""
@${ECHO} "Possible values are: 118, 240, 300 (default) and 400."
@${FALSE}
.endif
japanese/xdvi300 は通常のパッチ, package ファイルも
もっています. そこで, `他の解像度に関してですが, これが, xdvi118/Makefile
の(コメントを除いた)
RESOLUTION= 118
MASTERDIR= ${.CURDIR}/../xdvi300
.include "${MASTERDIR}/Makefile"
(xdvi240/Makefile と xdvi400/Makefile も
同様です). ${MASTERDIR} が ${PATCHDIR} や ${PKGDIR}
などの通常のサブディレクトリが xdvi300/Makefile
の
共有ライブラリのバージョン
まず, [ を読んで,
共有ライブラリのバージョンを一般的にどうすれば良いかを
理解してください. 盲目的に, ソフトウエアの作者がちゃんと理解
していると信じててはいけません, 多くの場合違います.
細い点まで考慮することは大変重要なことです, なぜなら我々は
互換性がないかもしれない大量のソフトウェアを共存させようと
する, 特殊な状況にあるからです. 不注意な port の導入が
共有ライブラリに関して, 多大な問題を引き起したことが過去にあ
ります (今まで, ]しかしながら, が同じソフトウェアの違ったバージョンのソフト
ウェアが既にツリーにあるばあいには, 状況は非常に複雑です.
つまり, FreeBSD では, ユーザがリンカにどのバージョンの
共有ライブラリを使用するかを指定できないからです(リンカは
常にもっとも高いバージョンを選びます). これは, もし,
マニュアル
MAN[1-9LN] 変数を使用すると, 自動的にすべてのマニュアルを
pkg/PLIST に加えます (つまり, マニュアルを を参照してください).
またマニュアルを /etc/make.conf 中の
NOMANCOMPRESS の設定に応じて, install時に自動的に
圧縮したり伸長したりします.
マニュアルをインストール時に圧縮するかどうかを指定するには,
PREFIX 以外のディレクトリの下にマニュアルを置く
ようなportではMANPREFIX を指定することが
できます. さらに, 特定のセクションのマニュアルだけ, 標準では
ない場所にインストールする場合, 例えばいくつかの Perl のモ
ジュールの ports など, には個々のマニュアルのパスを
MANsect PREFIX (sect は, 1 から 9
または, L か N を表わします) によって指定できます.
ができます.
マニュアルが, 言語特有のサブディレクトリに置かれる場合には,
言語名を "" になっています (つまり, 英語のみ).
これは, 全部をまとめた例です.
MAN1= foo.1
MAN3= bar.3
MAN4= baz.4
MANLANG= "" ja
MAN3PREFIX= ${PREFIX}/share/foobar
MAN8COMPRESSED= yes
${PREFIX}/man/man1/foo.1.gz
${PREFIX}/man/ja/man1/foo.1.gz
${PREFIX}/share/foobar/man/man3/bar.3.gz
${PREFIX}/share/foobar/man/ja/man3/bar.3.gz
${PREFIX}/man/man4/baz.4.gz
${PREFIX}/man/ja/man4/baz.4.gz
Motifを必要とするport
最近はコンパイルにMotifを必要とするアプリケーションが増えて
きました. (Motif自体は有料のものがいくつかの会社から手に入りま
すし, 多くのアプリケーションがコンパイル可能な無料の互換ライブラリ
が x11-toolkits/lesstif にあります)
Motifはかなり広く使われていますし, 製品のライ
センスではライブラリを静的にリンクした実行形式は再配布が認めら
れている場合が多いので, Motifを必要とするソフトウェアを簡単に
動的(port からコンパイルする人々のために)/静的(package を配布
する人々のために)にリンクできるようなしくみが用意されています.
REQUIRES_MOTIF
MotifがないとコンパイルできないportのMakefileではこの変
数を指定してください. これによって, Motifを持っていない人が
このportをコンパイルしようとするのを未然に防ぎます.
${MOTIFLIB}
この変数はbsd.port.mk によってMotifライブラリの指
定に置き換えられます. ソース内のMakefileやImakefileで
Motifライブラリを指定しているところをこの変数に置き換えるよ
うにパッチをあててください.
代表的な例としては以下の二つがあげられます:
- MakefileかImakefileの中でMotifライブラリが
`
-lXm ' として使われている場合には, かわりに
`${MOTIFLIB} ' と書いてください.
- Imakefileの中で `
XmClientLibs ' が使われている
場合には, それを `${MOTIFLIB}
${XTOOLLIB} ${XLIB} ' と書きかえてください.
${MOTIFLIB} は通常 `-L/usr/X11R6/lib
-lXm ' か `/usr/X11R6/lib/libXm.a ' に置き換えら
れます. したがって前に `-L ' や `-l ' をつけ
る必要はありません.
X11 のフォント
もし, あなたの port が X window system のフォントをインストール
するのであれば, それらを
${X11BASE}/lib/X11/fonts/local に置くようにして
ください. このディレクトリは XFree86 release 3.3.3 で新設された
ものです. もし, それが存在しなければ作成し, ユーザに
XFree86 を 3.3.3 かそれより新しいものに更新か,
すくなくとも, このディレクトリを /etc/XF86Config の
font path に加えるように促すメッセージを出力するようにしてください.
Info ファイル
新しい版の texinfo(2.2.2-RELEASE およびそれ以降に入っています)
には, `&dollar{PREFIX}/info/dir ファイル
を更新するようにしてください. (この節は, とても長くてすいません,
しかし info ファイルを作りあげるためには, これらは不可欠
です. 正しく行なえば, 美しい リストができますので,
辛抱してください! まず, これを知っておかなければなりません:
% install-info --help
install-info [OPTION]... [INFO-FILE [DIR-FILE]]
Install INFO-FILE in the Info directory file DIR-FILE.
(訳注: Info ディレクトリの INO-FILE を DIR-FILE にインストールする)
Options:
--delete Delete existing entries in INFO-FILE;
don't insert any new entries.
(訳注: INFO-FILE の中の項目を削除,
新しい項目は一切追加しない.)
:
--entry=TEXT Insert TEXT as an Info directory entry.
(訳注: TEXT を Info ディレクトリの項目として追加する.)
:
--section=SEC Put this file's entries in section SEC of the directory.
(訳注: このファイルの項目を Info ディレクトリの SEC
という節に置く.)
:
このプログラムは, 実際には info ファイルをこれから, editors/emacs を
使用します.
- まず, texinfo のソースを見て,
--- ./man/vip.texi.org Fri Jun 16 15:31:11 1995
+++ ./man/vip.texi Tue May 20 01:28:33 1997
@@ -2,6 +2,10 @@
@setfilename ../info/vip
@settitle VIP
+@dircategory The Emacs editor and associated tools
+@direntry
+* VIP: (vip). A VI-emulation for Emacs.
+@end direntry
@iftex
@finalout
:
フォーマットについては見ればわかると思います.
1つのファイルに対して1つの info の項目しか書けないことに注
意してください, これは, `install-info --delete '
が, そのバグにより, texinfo のソースにパッチをあてるかわりに, japanese/skk の portのディレクトリに戻って, `make clean; make '
をして, info ファイルが texinfo ソースファイルから再び生成さ
れることを確認してください. texinfo ソースファイルのほうが
info ファイルよりも新しいので,
--- ./Makefile.in.org Mon Aug 19 21:12:19 1996
+++ ./Makefile.in Tue Apr 15 00:15:28 1997
@@ -184,7 +184,7 @@
# Subdirectories to make recursively. `lisp' is not included
# because the compiled lisp files are part of the distribution
# and you cannot remake them without installing Emacs first.
-SUBDIR = lib-src src
+SUBDIR = lib-src src man
# The makefiles of the directories in $SUBDIR.
SUBDIR_MAKEFILES = lib-src/Makefile man/Makefile src/Makefile oldXMenu/Makefile lwlib/Makefile
--- ./man/Makefile.in.org Thu Jun 27 15:27:19 1996
+++ ./man/Makefile.in Tue Apr 15 00:29:52 1997
@@ -66,6 +66,7 @@
${srcdir}/gnu1.texi \
${srcdir}/glossary.texi
+all: info
info: $(INFO_TARGETS)
dvi: $(DVI_TARGETS)
/usr/share/info
にあるからです. (このパッチはここにはありません.)
- もし,
--- ./Makefile.in.org Mon Aug 19 21:12:19 1996
+++ ./Makefile.in Mon Apr 14 23:38:07 1997
@@ -368,14 +368,8 @@
if [ `(cd ${srcdir}/info && /bin/pwd)` != `(cd ${infodir} && /bin/pwd)` ]; \
then \
(cd ${infodir}; \
- if [ -f dir ]; then \
- if [ ! -f dir.old ]; then mv -f dir dir.old; \
- else mv -f dir dir.bak; fi; \
- fi; \
cd ${srcdir}/info ; \
- (cd $${thisdir}; ${INSTALL_DATA} ${srcdir}/info/dir ${infodir}/dir); \
- (cd $${thisdir}; chmod a+r ${infodir}/dir); \
for f in ccmode* cl* dired-x* ediff* emacs* forms* gnus* info* message* mh-e* sc* vip*; do \
(cd $${thisdir}; \
${INSTALL_DATA} ${srcdir}/info/$$f ${infodir}/$$f; \
chmod a+r ${infodir}/$$f); \
- (これは, 既存のportを修正するときのみ必要です.)
pkg/PLIST を見て, info/dir にパッチをあて
ようとするものすべてを削除します. これらは,
pkg/INSTALL やその他のファイルにもあるかもしれない
ので, いろいろさがしてみてください.
Index: pkg/PLIST
===================================================================
RCS file: /usr/cvs/ports/editors/emacs/pkg/PLIST,v
retrieving revision 1.15
diff -u -r1.15 PLIST
--- PLIST 1997/03/04 08:04:00 1.15
+++ PLIST 1997/04/15 06:32:12
@@ -15,9 +15,6 @@
man/man1/emacs.1.gz
man/man1/etags.1.gz
man/man1/ctags.1.gz
-@unexec cp %D/info/dir %D/info/dir.bak
-info/dir
-@unexec cp %D/info/dir.bak %D/info/dir
info/cl
info/cl-1
info/cl-2
Index: Makefile
===================================================================
RCS file: /usr/cvs/ports/editors/emacs/Makefile,v
retrieving revision 1.26
diff -u -r1.26 Makefile
--- Makefile 1996/11/19 13:14:40 1.26
+++ Makefile 1997/05/20 10:25:09 1.28
@@ -20,5 +20,11 @@
post-install:
.for file in emacs-19.34 emacsclient etags ctags b2m
strip ${PREFIX}/bin/${file}
.endfor
+ if [ ! -f ${PREFIX}/info/dir ]; then \
+ ${SED} -ne '1,/Menu:/p' /usr/share/info/dir > ${PREFIX}/info/dir; \
+ fi
+.for info in emacs vip viper forms gnus mh-e cl sc dired-x ediff ccmode
+ install-info ${PREFIX}/info/${info} ${PREFIX}/info/dir
+.endfor
.include
新しい info ファイルを作成するのに,
/usr/share/info/dir と上のコマンド, 以外は使用しな
いでください. 実際のところ, もし port する人がこれに関して
info/dir を削除する必
要はありません.
Index: pkg/PLIST
===================================================================
RCS file: /usr/cvs/ports/editors/emacs/pkg/PLIST,v
retrieving revision 1.15
diff -u -r1.15 PLIST
--- PLIST 1997/03/04 08:04:00 1.15
+++ PLIST 1997/05/20 10:25:12 1.17
@@ -16,7 +14,15 @@
man/man1/etags.1.gz
man/man1/ctags.1.gz
+@unexec install-info --delete %D/info/emacs %D/info/dir
:
+@unexec install-info --delete %D/info/ccmode %D/info/dir
info/cl
info/cl-1
@@ -87,6 +94,18 @@
info/viper-3
info/viper-4
+@exec [ -f %D/info/dir ] || sed -ne '1,/Menu:/p' /usr/share/info/dir > %D/info/dir
+@exec install-info %D/info/emacs %D/info/dir
:
+@exec install-info %D/info/ccmode %D/info/dir
libexec/emacs/19.34/i386--freebsd/cvtmail
libexec/emacs/19.34/i386--freebsd/digest-doc
@unexec install-info --delete ' コマンドは, info
ファイル自身より先に置き, コマンドがファイルを読めるようにし
ておかなければならないことに注意してください.
また, `@exec install-info ' コマンドは
info ファイルおよび [ をして
出来栄えに感服しましょう ]
まだ触れていない, いくつかのこつが
もし, インストールする人に
メッセージを表示する必要がある場合には, そのメッセージを
pkg/MESSAGE に置けます. この機能は,
バイナリパッケージが INSTALL ${PKGNAME} PRE-INSTALL ' と実行され,
2度目には, '`INSTALL ${PKGNAME} POST-INSTALL '
と実行されます. どちらのモードで実行されているかは,
`$2 ' を調べることによってわかります.
環境変数 `PKG_PREFIX ' には package がインストールさ
れるディレクトリが設定されます. 詳細は man
pkg_add(1) を見てください.
注意すべきことは, port を `make install ' で
インストールするときには, このスクリプトは自動的に実行されな
いということです. もし, 実行される必要があるならば, port の
Makefile で明示的に呼ぶ必要があります.
port が(インストールされるシステムの状態によって)
インストールされるべきか, されないべきか区別する必要があると
きには, 「要件(requirements)」スクリプト pkg/REQ を作ること
ができます. これは, インストール及びデインストール
(package の削除)の時に自動的に実行され, それらが処理されるべ
きかを決定します.
makeの変数にあわせた
いくつかの port, 特に p5- portsなど, は configure のオプション
(あるいは, p5- ports の場合は perl のバージョン)によって,
%%PERL_VERSION%% は, 適切に置き換えられるようになって
います. 他の置き換えが必要であれば, PLIST_SUB 変数に
VAR=VALUE という形式のペアのリストを設定することに
よって, %%VAR%% ' は `
OCTAVE_VERSION= 2.0.13
PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}
と書いて, %%OCTAVE_VERSION%% と書きます.
このようにしておけば, port をアップグレードするときに,
何十行(ときとして, 何百行)も この書き換えは ([
の追加も) ]${PLIST} を読み
${TMPPLIST} (デフォルトは,
${WRKDIR}/.PLIST.mktmp ) に書き込むことによって
行なわれます. もし, あなたの port が ${PLIST}
を実行時に生成するのであれば,
ライセンス上の問題
ソフトウェアによっては制限の厳しいライセンスがついてきたり,
法律的に問題があるかもしれません. (PKPの公開鍵暗号化, ITAR (暗
号化ソフトウェアの輸出) などが例としてあげられます). それらを
どう扱えばいいかはライセンスの文面によってさまざまな場合があり
ます.
ソフトウェア移植者として, あなたにはライセンスをよく読み,
FreeBSDプロジェクトがFTPまたはCD-ROMで配布してはいけないソフ
トウェアを配布してしまうことのないよう, 注意する義務があります.
なにか疑問がある場合には, &a.ports;に聞いてみてください.
よく見られるケースに対処するために, 二つの変数が用意されてい
ます:
- ソフトウェアに「有償再配布を禁ずる」という趣旨のライセン
スがついてきた場合には
NO_CDROM という変数にその理由
を記述してください. 私たちはこれがついている port は CD-ROM
リリースに入れないようにしますが, オリジナルのソースファイル
とpackageはFTPでは取れるようにしておきます.
- もしも, 生成される package が個々のサイトで独自に構築さ
れる必要があったり, ライセンスによって生成されるバイナリが
配布できない場合には,
NO_PACKAGE 変数にその理由を
記述してください. そのような package が FTP サイトに置かれ
たり, リリース時の CD-ROM へ入らないようにします. ただし,
いずれの場合も distfile は(FTP や CD-ROM に)含まれるように
なります.
- Portが, 使用者によっては法律上の問題が生じる時 (暗号化ソフ
トウェアなど), または「商用利用を禁ずる」とライセンスに書い
てある場合には
RESTRICTED という変数にその理由を入れ
てください. この場合には, ソースファイルやpackageは私たちの
FTPサイトにも置かれません.
注: GNU一般公有使用許諾書 (GPL) はバージョン1, 2とも
port作成上は何ら問題にはなりません.
注: もしあなたが，ソースツリー管理者 (committer) であれば，
ソースツリーにこのようなportを入れる際に,
ports/LEGAL ファイルを書き換えるのを忘れないようにし
てください.
アップグレード
Portのバージョンが原作者からのものに比べて古いことに気がつ
いたら, まずはあなたの持っているportが私たちの最新のもの (ミラー
サイトのports-current というディレクトリにあります)
であることを確認してください.
次に, portのMakefileにMAINTAINER (保守担当者) の
アドレスが書いてある場合には, その人にメールを出してみましょう.
保守担当者の人がすでにアップグレードの準備をしているかもしれま
せんし, (新しいバージョンの安定度に問題があるなど) あえてアッ
プグレードをしない理由があるのかもしれません.
保守担当者にアップグレードをしてくれと頼まれた場合, あるいは
そもそもportのMakefileに保守担当者が書いてない場合などは, あ
なたがアップグレードをしてくださると助かります. その場合にはアッ
プグレードをしたのち, 変更前と変更後のディレクトリの再帰的diff
(unified diff と context diff のどちらでもいいのですが,
port のコミッター達は unified diff のほうを好むようです)
をとって送ってください. (例えば, 変更前のディレクトリが
`superedit.bak ' という名前でとってあり, 変更後のもの
が `superedit ' に入っているなら, `diff -ruN
superedit.bak superedit ' の結果を送ってください. )
diff の出力を見て, すべての変更が正しくなされているか確認して
ください. 変更箇所については, send-pr (カテゴリーは,
`ports')に diff の出力結果を添えて, 私たちに送ってもらうのが一
番よいです. commit する際に CVS に明確に記述しなければならない
ので, 付け加えたり削除したりしたファイルがあったら, それについ
て書いておいてください. もし diff の大きさが 20 KB 程度を
超えるようであれば, 圧縮したものを uuencode して下さい.
そうでなければそのまま PR に入れるだけでいいです.
やってよいことといけないこと
この節では, ソフトウェアをportする上でよくある落し穴などにつ
いて説明します. このリストを使って, あなた自身が作成した port
のチェックはもとより, PR データベースにある, 他の人が作成した
port のチェックもできます. あなたがチェックした port について
のコメントを
[
にしたがって, 送ってください. PR データベースにある port を
チェックすることによって, 私達がそれらを commit するのを早くし,
あなたが何をしているか理解していることも示します.
]
バイナリのstrip
バイナリはstripしてください. オリジナルのソースがバイナリを
stripしてくれる場合は良いですが, そうでない場合には
post-install ターゲットを指定して strip するようにする
とよいでしょう. 例えば, こんな風になります:
post-install:
strip ${PREFIX}/bin/xdl
インストールされた実行形式がすでにstripされているかどうか
はfile コマンドで確認できます. これが`not stripped'
と言わなければ, stripされているということです.
INSTALL_* マクロ
あなた自身の *-install ターゲットでファイルの正しいモードと
オーナを保証するために, 必ずbsd.port.mk で提供されて
いるマクロを使用してください. マクロは以下のようなものがあります.
${INSTALL_PROGRAM} は実行可能なバイナリを
インストールするコマンドです．
${INSTALL_SCRIPT} は実行可能なスクリプトを
インストールするコマンドです．
${INSTALL_DATA} は共有可能なデータを
インストールするコマンドです．
${INSTALL_MAN} はマニュアルとその他のドキュメ
ントをインストールするコマンドです．(圧縮はしません)
これらは基本的にinstall コマンドに適当なフラグを与え
たものです. どのようにこれらを使用するかは以下の例を見てください.
OS や OS のバージョンの区別
Portの過程で, 修正や, どのバージョンのUNIXで動くかによる条件
つきコンパイルなどが必要なコードに出会うかもしれません. その
ような条件つきコンパイルなどのための変更をおこなうときには,
FreeBSD 1.x システムへの移植や, CSRGの4.4BSD, BSD/386,
386BSD, NetBSD, OpenBSD などの他のBSDシステムへの移植が可能な
ように, できるだけ普遍的な変更をおこなうことを心がけてください.
4.3BSD/Reno (1990) およびそれより新しいBSD版を古いバージョン
と区別するには `BSD ' マクロを利用するのがよいでしょう.
これは <sys/param.h> で定義されています. このファ
イルがすでにインクルードされていればよいのですが, もしそうでな
い場合には以下のコードを, その.c ファイルの適当な場所
に加えてください.
#if (defined(__unix__) || defined(unix)) && !defined(USG)
#include
#endif
これらのシンボルが定義されているすべてのシステムには
sys/param.h があるはずです. もし, そうでないシステムを発見した
ら我々にも教えてください. &a.ports; までメールを送ってください.
あるいは, GNU の Autoconf のスタイルを使用することもできます,
#ifdef HAVE_SYS_PARAM_H
#include
#endif
CFLAGS に
-DHAVE_SYS_PARAM_H を加えることを忘れないようにしてく
ださい.
いったん<sys/param.h> がインクルードされると,
#if (defined(BSD) && (BSD >= 199103))
#if (defined(BSD) && (BSD >= 199306))
以下は控え目に使ってください.
__FreeBSD__ はFreeBSDのすべての版で定義されてい
ます. 変更がFreeBSDだけに適用されるとき以外は使用しないでく
ださい. Portでよくある, strerror() ではなく
sys_errlist[] を使うなどは, FreeBSDでの変更ではなく,
BSDの流儀です.
- FreeBSD 2.xでは
__FreeBSD__ が2と定義されていま
す. それ以前の版では1になっています. その後の版では,
そのメジャー番号に合うように上がっていきます.
- もし, FreeBSD 1.x システムと FreeBSD 2.x あるいは
FreeBSD 3.x システムを区別する必要があれば, 上で述べた
BSD マクロを使用するのが,
大抵の場合において正しい答です. もし, FreeBSD特有の変更であ
れば (`ld ' を使うときのシェアードライブラリ用のな
オプションなど), __FreeBSD__ を使い
`#if __FreeBSD__ > 1 ' のようにFreeBSD 2.x
および, それ以降のシステムを検出するのはかまいません.
もし, 2.0-RELEASE以降のFreeBSDシステムを細かく検出したけれ
ば, 以下を使用することができます.
#if __FreeBSD__ >= 2
#include
# if __FreeBSD_version >= 199504
/* 2.0.5+ release specific code here */
# endif
#endif
__FreeBSD_version の値は以下の通りです:
2.0-RELEASE: 199411
2.1-current's: 199501, 199503
2.0.5-RELEASE: 199504
2.2-current (2.1以前): 199508
2.1.0-RELEASE: 199511
2.2-current (2.1.5以前): 199512
2.1.5-RELEASE: 199607
2.2-current (2.1.6以前): 199608
2.1.6-RELEASE: 199612
2.1.7-RELEASE: 199612
2.2-RELEASE: 220000
2.2.1-RELEASE: 220000 (2.2-RELEASE と同じです)
2.2-STABLE (2.2.1-RELEASE 以後): 220000 (これも同じです)
2.2-STABLE (texinfo-3.9 以後): 221001
2.2-STABLE (top 導入以後): 221002
2.2.2-RELEASE: 222000
2.2-STABLE (2.2.2-RELEASE 以後): 222001
2.2.5-RELEASE: 225000
2.2-STABLE (2.2.5-RELEASE 以後): 225001
2.2-STABLE (ldconfig -R 以後): 225002
2.2.6-RELEASE: 226000
2.2.7-RELEASE: 227000
2.2-STABLE (2.2.7-RELEASE 以後): 227001
2.2-STABLE (semctl(2) 変更後): 227002
2.2.8-RELEASE: 228000
2.2-STABLE (2.2.8-RELEASE 以後): 228001
3.0-current (mount(2) 変更以前): 300000
3.0-current (mount(2) 変更後): 300001
3.0-current (semctl(2) 変更後): 300002
3.0-current (ioctl 引数変更後): 300003
3.0-current (ELF(2) 移行後): 300004
3.0-RELEASE: 300005
3.0-current (3.0-RELEASE 以後): 300005
これまで, 何百ものportが作られてきましたが,
__FreeBSD__ が正しく使われたのは, 1つか2つの場合だけで
しょう. 以前のportが誤った場所でそのマクロを使っているからと
いって, それをまねする理由はありません.
`.include <bsd.port.mk> ' の行の後には
なにも書かないようにしてください. 大抵の場合は Makefile の
中程のどこかで,
&dollar{ARCH} `uname -m ' で返される
アーキテクチャ. (例, `i386').
&dollar{OPSYS} `uname -s ' で返される
オペレーティングシステム (例, `FreeBSD').
&dollar{OSREL} オペレーティングシステムの
リリースバージョン (例., `2.1.5', `2.2.7').
&dollar{OSVERSION} 数字形式のオペレーティングシステム
のバージョン, 上記の [ と同じです.
]&dollar{PORTOBJFORMAT} システムのオブジェクト
フォーマット (`aout' あるいは `elf').
&dollar{LOCALBASE} 'local' ツリーのベース.
(例, `/usr/local/').
&dollar{X11BASE} `X11' ツリーのベース.
(例, `/usr/X11R6/').
&dollar{PREFIX} portsのインストール先
([を参照).
]
# no need to compile lang/perl5 if perl5 is already in system
.if ${OSVERSION} > 300003
BROKEN= perl is in system
.endif
# only one shlib version number for ELF
.if ${PORTOBJFORMAT} == "elf"
TCL_LIB_FILE= ${TCL_LIB}.${SHLIB_MAJOR}
.else
TCL_LIB_FILE= ${TCL_LIB}.${SHLIB_MAJOR}.${SHLIB_MINOR}
.endif
# software already makes link for ELF, but not for a.out
post-install:
.if ${PORTOBJFORMAT} == "aout"
${LN} -sf liblinpack.so.1.0 ${PREFIX}/lib/liblinpack.so
.endif
付加的ドキュメント
普通のマニュアルやinfoファイルのほかにユーザにとって有用だ
と思えるようなドキュメントがある場合には,
${PREFIX}/share/doc の下にインストールしてく
ださい. これは前記と同様, post-install ターゲットの
中からするのがいいでしょう.
まず, あなたのportのために新しいディレクトリを作りま
す. どのportのドキュメントか簡単にわかるような名前にする必
要がありますので, 普通は${PKGNAME} からバージョ
ン番号を除いた部分を使うといいでしょう. もちろん, ユーザが異
なるバージョンのものを同時に使うことが予想されるportの場合
には, ${PKGNAME} をそのまま使ってかまいません.
ユーザが/etc/make.conf でこの部分を禁止するために
NOPORTDOCS という変数をセットしている場合には，
これらのドキュメントがインストールされないようにしてください.
こんな具合です.
post-install:
.if !defined(NOPORTDOCS)
${MKDIR} -p ${PREFIX}/share/doc/xv
${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${PREFIX}/share/doc/xv
.endif
これらのファイルをpkg/PLIST に入れるのを忘れないよ
うにしてください. (packageが/etc/make.conf 内の
変数を読む方法は今のところ存在しませんので,
NOPORTDOCS については気にしないでください.)
インストール時に pkg/MESSAGE ファイルを利用して,
メッセージを表示することができます. 詳細は [ の節を参照してください.
]
DIST_SUBDIR
/usr/ports/distfiles ディレクトリ内をあまり散らかさ
ないようにしてください. たくさんのファイルを取ってくるport
や, 数は少なくてもほかのportのファイルと混同されるおそれが
あるファイル (`Makefile' など) がある場合には,
${DIST_SUBDIR} にportの名前
(${PKGNAME} からバージョン番号を取った部分を
使うといいでしょう) を入れてください. すると,
${DISTDIR} がデフォルトの
/usr/ports/distfiles から
/usr/ports/distfiles/${DIST_SUBDIR} に変更さ
れ, 取ってきたファイルはすべてそのサブディレクトリの中に置か
れるようになります.
また, ファイルを取ってくるときにバックアップサイトとして使わ
れるftp.freebsd.org のディレクトリ名にもこの変数の
値が使われます. (${DISTDIR} を明示的に指定し
た場合には, ローカルのファイルを置くところは変わりますが, こ
のサイトのディレクトリ名は変わりませんので, 必ず
${DIST_SUBDIR} を使うようにしてください.)
この変数はMakefile中で明示的に指定された
${MASTER_SITES} には影響しないことに注意して
ください.
RCS文字列
RCSが特別な意味を与えている文字列をパッチ内に入れないように
してください. ファイルを私たちのソースツリーに入れる時にこれら
の文字列はCVSによって書き換えられてしまい, あとでまたパッチ
を使おうとした時にうまくいかないことがあります. RCS文字列は
ドル記号 (`$ ') で囲まれており,
`$Id ' や `$RCS ' などで始まり
ます.
パッチ作成上の注意
diff の再帰 (`-r ') フラグを使って再帰的なパッ
チを作るのは大変結構なのですが, でき上がったパッチは必ず目で
チェックして余計なゴミが入っていないことを確認してくださ
い. よくあるのはバックアップファイル同士の変更点, あるいは
Imake や GNU ファイルをまるごと消す場合にはパッチを使わずに
post-extract ターゲットで消す方が簡単です. できあがった
差分に満足したら, それらをソースのファイルごとに別々の
パッチファイルに分割してください.
PREFIX
なるべくportは${PREFIX} に対する相対パス
にインストールすることができるように心がけてください.
(この変数の値は ${USE_X_PREFIX} か
${USE_IMAKE} が指定してある時には
${X11BASE} (デフォルト/usr/X11R6 ),
そうでない場合には${LOCALBASE}
(デフォルト/usr/local ) にセットされます.)
サイトによってフリーソフトウェアがインストールされる場所が
違いますので, ソース内で `/usr/local ' や
`/usr/X11R6 ' を明示的に書かないようにしてくださ
い. Xのプログラムでimakeを使うものについては, これは問題に
はなりません. それ以外の場合には, ソース中のMakefileやスク
リプトで `/usr/local ' (imakeを使わないXのプログラ
ムは `/usr/X11R6 ') と書いてあるところを
`${PREFIX} ' に書き換えてください. この値は
portのコンパイル, およびインストール時に自動的に環境変数として
下位makeに渡されます.
USE_X_PREFIX は本当に必要な時(つまり, X のライブラ
リなどとリンクしたり, ${X11BASE} 以下にある
ファイルを参照したりする必要がある時)以外には設定しないでく
ださい.
変数${PREFIX} の値はportのMakefileやユー
ザの環境で変更することもできます. しかし, 個々のportが
Makefileでこの変数の値を明示的に設定することはなるべくしない
でください.
また, 他のportからインストールされるプログラムやファイル
を指定するときには, 上で述べた変数を使用してください. 例えば,
less のフルパスをPAGER というマクロに入れた
い場合は, コンパイラに
-DPAGER=\"/usr/local/bin/less\" と渡すかわりに
-DPAGER=\"${PREFIX}/bin/less\" (Xを使う
portの時は
-DPAGER=\"${LOCALBASE}/bin/less\" ) を渡し
てください. こうしておけば, `/usr/local' がまるごとどこか他
の場所に移してあるサイトでも, あなたのportがそのまま使える
可能性が高くなります.
ディレクトリ構成
インストール時には${PREFIX} の正しいサブディ
レクトリにファイルを置くように心がけてください. ソフトウェア
によっては新しいディレクトリを一つ作ってファイルを全部それに
入れてしまうものがありますが, それはよくありません. また, バ
イナリ, ヘッダファイルとマニュアル以外のすべてを
`lib 'というディレクトリに入れてしまうportもあります
が, これもBSD的なファイルシステム構成からいうと正しくありま
せん. これは以下のように分散すべきです. `etc ' にセッ
トアップ/コンフィグレーションファイル, `libexec ' に
内部で使用されるプログラム (コマンドラインから呼ばれることの
ないコマンド), `sbin ' に管理者用のコマンド,
`info ' に GNU Info 用のドキュメント, そして
`share ' にアーキテクチャに依存しないファイルが入り
ます. 詳細については man hier(7) を見てくださ
い. /usr の構成方針はほとんどそのまま
/usr/local にもあてはまります. USENET ニュースを
扱う ports は例外です. これらは, ファイルのインストール先として
${PREFIX}/news を使用します.
空のディレクトリの除去
ports は デインストール(削除) の際には, 自分自身を消去した
あとに, (ディレクトリの)除去をするようにしてください.
これは, 大抵の場合
:
lib/X11/oneko/pixmaps/cat.xpm
lib/X11/oneko/sounds/cat.au
:
@dirrm lib/X11/oneko/pixmaps
@dirrm lib/X11/oneko/sounds
@dirrm lib/X11/oneko
といった感じです.
しかし, ときとして, 他の port をディレクトリを共有している
ために
:
@unexec rmdir %D/share/doc/gimp 2>/dev/null || true
これを使えば, たとえ, 他の port がファイルをインストールして
いて, ${PREFIX}/share/doc/gimp が空でない場合でも
エラーメッセージは表示されませんし,
UID
もしあなたの portがインストールされるシステム上に特定のユー
ザを必要とする場合は, pkg/INSTALL スクリプトから
pw コマンドを実行して自動的にそのユーザを追加するよ
うにしてください.
net/cvsup-mirror の portが参考になるでしょう.
もしあなたの port が, バイナリのパッケージとして
としてインストールされるときにも, コンパイルされたときと同じ
ユーザー/グループ ID を使わなければならないのなら, 50 から 99
の間で空いている UID を選んで登録してください.
japanese/Wnn の port が参考になるでしょう.
既にシステムや他の portで利用されている UIDを使わないように
十分注意してください. 現在の 50から 99までの間の UIDは以下の
とおりです.
majordom:*:54:54:Majordomo Pseudo User:/usr/local/majordomo:/nonexistent
cyrus:*:60:60:the cyrus mail server:/nonexistent:/nonexistent
gnats:*:61:1:GNATS database owner:/usr/local/share/gnats/gnats-db:/bin/sh
uucp:*:66:66:UUCP pseudo-user:/var/spool/uucppublic:/usr/libexec/uucp/uucico
xten:*:67:67:X-10 daemon:/usr/local/xten:/nonexistent
pop:*:68:6:Post Office Owner (popper):/nonexistent:/nonexistent
wnn:*:69:7:Wnn:/nonexistent:/nonexistent
ifmail:*:70:66:Ifmail user:/nonexistent:/nonexistent
pgsql:*:70:70:PostgreSQL pseudo-user:/usr/local/pgsql:/bin/sh
ircd:*:72:72:IRCd hybrid:/nonexistent:/nonexistent
alias:*:81:81:QMail user:/var/qmail/alias:/nonexistent
qmaill:*:83:81:QMail user:/var/qmail:/nonexistent
qmaild:*:82:81:QMail user:/var/qmail:/nonexistent
qmailq:*:85:82:QMail user:/var/qmail:/nonexistent
qmails:*:87:82:QMail user:/var/qmail:/nonexistent
qmailp:*:84:81:QMail user:/var/qmail:/nonexistent
qmailr:*:86:82:QMail user:/var/qmail:/nonexistent
msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh
このリストを最新の状態に保つためにも,
この範囲の UID や GID を予約するような port を作ったり,
既存の port にそのような改変を行って我々に送るときには,
UID の予約に関する注意書きをつけてください.
合理的な port
Makefile は単純かつ適切であるべきです. もし, Makefile を
数行短かくできたり, もっと読みやすくできるのであれば, そうし
てください. 例えば, shell の `if ' 構文を使う代りに,
make の `.if ' 構文を使う,
${EXTRACT*} の再定義で代用できるのであれば,
do-extract を再定義しない, `CONFIGURE_ARGS +=
--prefix=${PREFIX} ' とするかわりに,
$GNU_CONFIGURE とする, などです.
CFLAGS の尊重
${CFLAGS} 変数は尊重すべきです. その port
がこれを無視するのであれば, `NO_PACKAGE=ignores
cflags ' を Makefile に加えてください.
コンフィグレーション(設定)ファイル
もしあなたの port が設定ファイルを
${PREFIX}/etc に置く必要がある場合には,
それを単純にインストールしたり, pkg/PLIST に加え
ては代りに, 見本となるファイルを suffix (
`<filename>.sample ' が良いでしょう) を付けて
インストールして, [
を表示して, ソフトウエアを動かす前に, ユーザがそのファイル
をコピーして編集をしなければならないことを知らせましょう.
]
Portlint
送付や commit をする前に
[ を使ってチェック
しましょう.
]
フィードバック
Portを作るためにソフトウェアに変更を加えたら, なるべく原
作者にその旨を伝えてパッチ等を送ってください. これらが次のリ
リースに取り入れられれば, アップグレードが楽になります.
その他諸々
pkg/DESCR , pkg/COMMENT ,
pkg/PLIST などのファイルは, それぞれ2重にチェックし
てください. 再検討してもっと良い記述があれば, それに置きかえ
てください.
GNU General Public License(GNU一般公有使用許諾)のコピーは
(すでにあるので)コピーしないでください, おねがいします.
法律に関することには, 十分注意をはらってください.
私達に法律に反するような形でソフトフェアの配布をさせない
でください!
困ったら....
私たちに質問を送る前に, 既存のportの例とbsd.port.mk を
ちゃんと読んでください! ;)
それでもわからないことがあったら, 一人で悩まないでどんどん
質問してください! :)
Makefileのお手本
これはportのMakefileを作る際のお手本です. かぎかっこ
([])内のコメントは忘れずに取ってください.
変数の順番, 段落の間の空行など, Makefileを作るときはなるべくこ
の形式にしたがってください. この形式は重要な情報が簡単に見つけら
れるように設計されています. [ を使って Makefile をチェックすることが
推奨されています.
]
[ヘッダ -- どのようなportのMakefileかすぐにわかるようになっています]
# New ports collection makefile for: xdvi
# Version required: pl18 ["1.5alpha" みたいなのでも結構です]
[この Makefile の最初の版が作成された日付です. この port をアップグ
レードするときには変えないでください.]
# Date created: 26 May 1995
[このソフトウェアを最初に FreeBSD に port した人の名前, つまり,
この Makefile の最初の版を書いた人です. この port をアップグレー
ドするとき, この行も変えないでください.]
# Whom: Satoshi Asami
#
# $Id$
[ ^^^^ この部分は, CVS ツリーに入れる時に自動的に RCS の ID 文字列に
置き換えられます.]
#
[Port自体, およびオリジナルのソースを取ってくるところを記述する部分.
最初は必ずDISTNAME, そして必要ならPKGNAME, CATEGORIES, 続いて
MASTER_SITESがおかれ, さらに MASTER_SITE_SUBDIR がおかれることもあり
ます. そのあと, EXTRACT_SUFX か DISTFILES を指定することも可能です]
DISTNAME= xdvi
PKGNAME= xdvi-pl18
CATEGORIES= print
[MASTER_SITE_* マクロを使用しない場合は,
最後のスラッシュを忘れないように ("/")!]
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
[ソースファイルが標準の ".tar.gz" 形式でない時にこれを使いましょう]
EXTRACT_SUFX= .tar.Z
[配布パッチのセクション -- ない場合もあります]
PATCH_SITES= ftp://ftp.sra.co.jp/pub/X11/japanese/
PATCHFILES= xdvi-18.patch1.gz xdvi-18.patch2.gz
[保守責任者 -- これは *必ず* 必要です. 担当者 (あなた) 自身, あるいは
担当者に素早く連絡をとれる人のアドレスを書いてください. どうしてもこ
こに自分のアドレスを書くのがいやな人は "ports@FreeBSD.ORG" と書いて
もいいです]
MAINTAINER= asami@FreeBSD.ORG
[依存するport -- ない場合もあります]
RUN_DEPENDS= gs:${PORTSDIR}/print/ghostscript
LIB_DEPENDS= Xpm.5:${PORTSDIR}/graphics/xpm
[ここには標準のbsd.port.mkの変数で, 上のどれにもあてはまらないものを
書きます]
[コンフィグレーション, コンパイル, インストールなどの時に質問をする
なら...]
IS_INTERACTIVE=yes
[${DISTNAME}以外のディレクトリにソースが展開されるなら...]
WRKSRC= ${WRKDIR}/xdvi-new
[配布されているパッチが ${WRKSRC} に対する相対パスで作られてい
ない場合にこの変数の指定が必要かも...]
PATCH_DIST_STRIP= -p1
[GNU autoconfによって生成された "configure" スクリプトを走らせたいなら...]
GNU_CONFIGURE= yes
[/usr/bin/makeでなく, GNU makeを使わないといけないなら...]
USE_GMAKE= yes
[これがXのアプリケーションで "xmkmf -a" を走らせたいなら...]
USE_IMAKE= yes
[などなど]
[下の方のルールで使う非標準の変数]
MY_FAVORITE_RESPONSE= "yeah, right"
[そして, 特別なターゲット, 使用順に]
pre-fetch:
i go fetch something, yeah
post-patch:
i need to do something after patch, great
pre-install:
and then some more stuff before installing, wow
[最後には必ず]
.include
Packageの名前
Packageの名前は以下のルールにしたがってつけてください. こ
れはpackageのディレクトリを見やすくするためで, 無秩序な名前
がたくさん並んでいるとユーザが使いづらくなるのではという心配か
らです. (FTPサイトなどにはたくさんpackageがありますからね.)
Packageの名前は以下のようにしてください.
[<言語>-]<名前>[[-]<オプション>]-<バージョン.番号>;
${DISTNAME} が上記の形式になっていない場合に
は, ${PKGNAME} をそのようにしてください.
- FreeBSDはユーザの慣れ親しんだ言語のサポートに力を入れて
います. 特定の言語のためのportのpackage名には
`<言語>' に ISO-639 で定義されている言語名の略称を入れ
てください. 例えば, 日本語なら `ja', ロシア語なら `ru', ベト
ナム語なら `vi', 中国語なら `zh', 韓国語ならば `ko', ドイツ
語なら `de', といった具合です.
- `
<名前> ' の部分は原則的にはすべて英小文字
を使います. 例外はたくさんのプログラムが入っている巨大なport
の場合で, XFree86 (ほんとにあるんですよ) やImageMagickな
どがこれにあたります. そうでない場合には, 名前の大文字を小文
字に (少なくとも最初の一字だけは) 変えてください.
もし, 大文字であることが重要な場合(例えば, 1文字の名前,
R とか V)には, あなたの裁量で大文字を使うのも良いでしょう.
Perl 5 のモジュールでは, 頭に `p5-' を付け, 2重コロン(::)
のセパレータをハイフン(-)に置きかえるしきたりになっています.
例えば, `Data::Dumper' は `p5-Data-Dumper'
になります. また, その
ソフトウェアの名前として通常使われるものに番号, ハイフン, あ
るいは下線が入っている場合には, それらを使うことも構いません
(`kinput2' など).
- コンパイル時に環境変数や
make の引数などで
[
を変えてコンパイルできる場合, `<compiled.specifics>'
にそのコンパイル時のデフォルトを入れてください
(ハイフンはあってもなくてもかまいません). 用紙のサイズ,
あるいはフォントの解像度などがこれにあたります.
]- バージョン番号は数字とアルファベットからなり, ピリオド
(.) で区切ります. アルファベットは二文字以上続けてはいけませ
ん. ただ一つの例外は「パッチレベル」を意味する `pl' で, それ
以外にバージョン番号がまったくついていない場合にのみ使うことがで
きます.
では, ${DISTNAME} を正しい
${PKGNAME} に直す例を見てみましょう:
DISTNAME PKGNAME 理由
mule-2.2.2 mule-2.2.2 まったく問題なし
XFree86-3.1.2 XFree86-3.1.2 同上
EmiClock-1.0.2 emiclock-1.0.2 プログラム一つだけの時は小文字のみ
gmod1.4 gmod-1.4 `<名前>' のあとにハイフンが必要
xmris.4.02 xmris-4.02 同上
rdist-1.3alpha rdist-1.3a `alpha'のような文字列は使えない
es-0.9-beta1 es-0.9b1 同上
v3.3beta021.src tiff-3.3 なんなんでしょう ;)
tvtwm tvtwm-pl11 バージョン番号は必ず必要
piewm piewm-1.0 同上
xvgr-2.10pl1 xvgr-2.10.1 `pl' が使えるのは他にバージョン番号がない場合のみ
gawk-2.15.6 ja-gawk-2.15.6 日本語バージョン
psutils-1.13 psutils-letter-1.13 コンパイル時に用紙のサイズを指定
pkfonts pkfonts300-1.0 300dpiフォント用のpackage
オリジナルのソースにまったくバージョン情報が見当たらず, また原作
者が新しいバージョンをリリースする可能性が低いときには, バージョ
ン番号として `1.0' を使えばいいでしょう (上記のpiewmの例がこ
れにあたります). そうでない場合には, 原作者に聞くか, 日付 (`年.
月.日') を使うなどしてください.
カテゴリ
すでに御存知のように, ports はいくつかのカテゴリに
分類されています. これを有効に利用するためには, port を
行う人々とユーザが, そろぞれのカテゴリーが何であるか,
どのようにしてカテゴリに分類するかを理解する必要があります.
現在のカテゴリのリスト
まず, これが現在の port のカテゴリーのリストです.
アスタリスク(pkg/COMMENT に1行の記述
があります(例, archivers/pkg/COMMENT ).
Archiving tools.
Astronomical ports.
Sound support.
Benchmarking utilities.
Biology-related software.
Computer aided design tools.
Chinese language support.
Communication software. Mostly software
to talk to your serial port.
Character code converters.
Databases.
Things that used to be on the
desktop before computers were invented.
Development utilities. Do not put
libraries here just because they are libraries -- unless
they truly don't belong to anywhere else, they shouldn't be
in this category.
General editors. Specialized editors
go in the section for those tools (e.g., a
mathematical-formula editor will go in Emacs-lisp ports.
Emulators for other operating
systems. Terminal emulators do Games.
German language support.
Graphics utilities.
Japanese language support.
Ports that form the K Desktop Environment
(kde).
Korean language support.
Programming languages.