一般的に, システムへの貢献は次の 6 つのカテゴリの1つ以上に分類されます:
報告するべきバグがあったり, 提案したいことがあれば:
一般的な 技術的関心事に関するアイデアや提案は FreeBSD technical discussions mailing list <freebsd-hackers@FreeBSD.ORG> へメールしてください. 同様に, このような事柄に興味のある (そして膨大なメール! に耐えられる) 人は, <majordomo@FreeBSD.ORG> へメールを送って hackers メーリングリストに参加すると良いでしょう. 情報については メーリングリスト を参照してください.
バグを発見したり変更を送付しようとしている場合は send-pr(1) プログラムか WEB ベースの send-pr を使用して報告してください. バグレポートの各項目を埋めるようにしてください. 65KB を超えるのでなければ, レポート中に直接 パッチを入れてくださって結構です. 20KB を超える場合は, それらを compress して uuencode(1) することも検討してください. とても大きくなる場合は ftp.freebsd.org:/pub/FreeBSD/incoming/ を利用してください.
レポートがファイリングされれば, バグ報告の確認と トラッキング番号をメールで受け取るはずです. このトラッキング番号を覚えておき, 問題に関する詳細情報を <bug-followup@FreeBSD.ORG> に メールで送って更新できるようにしてください. 例えば "Re: kern/3377" のように, この番号をサブジェクト行に使用してください. すべてのバグレポートの追加情報は, この方法で送付されなければいけません.
もしタイムリに (あなたの電子メール接続形態にもよりますが, 3日から 1週間) 確認を受けとれないとか, 何らかの理由で send-pr(1) コマンドが 使用できない場合には, FreeBSD problem reports mailing list <freebsd-bugs@FreeBSD.ORG> へメールを送り, 誰か代りにバグ報告を 送付してもらうようたずねてください.
文書の変更は FreeBSD documentation project mailing list <freebsd-doc@FreeBSD.ORG> が監督しています. バグ報告と一般的な論評 に記述されているように send-pr コマンドを使用して, 提案や変更 (どんな些細なものでも歓迎します!) を送ってください.
現存のソースコードへの追加または変更は, いくらかトリッキーな仕事で あり, core の FreeBSD 開発の現状にあなたがどれだけ通じているかに大 きく依存します. ``FreeBSD-current''として知られる FreeBSD の特別な 継続的リリースがあります. FreeBSD-current は開発者の積極的な活動の 便宜のために, 色々な方法で利用可能になっています. FreeBSD-current の入手と使用方法についての詳しい情報については 最新の FreeBSD を追いかける を参照してください.
不幸にして古いソースをもとに仕事をすることは, 時々あなたの変更が時 代遅れ, または FreeBSD への簡単な再統合に合わなくなっていることを意 味します. システムの現状に関する議論がおこなわれている FreeBSD announcements mailing list <freebsd-announce@FreeBSD.ORG> と FreeBSD-current mailing list <freebsd-current@FreeBSD.ORG> へ参加することで, この可能性を最小限にすることができます.
完全な最新のソースを変更のベースにできることが 確実になったと仮定し て, 次のステップは FreeBSD の保守担当者へ送る差分ファイルの生成です. これは diff(1) コマンドを使用しておこないますが, ``context diff''形式が好まれるようです. 例えば:
% diff -c oldfile newfile
または
% diff -c -r olddir newdir
これで指定されたソースファイルまたはディレクトリ階層に 対するコンテ キスト形式の差分が生成されます. 詳しい説明は diff(1) のマ ニュアルページを参照してください.
差分ファイル (patch(1) コマンドでテストできます) を作ったら, それらを FreeBSD に含めてもらうようメールで送ってください. バグ報告と一般的な論評 に記述されているように send-pr(1) コマンドを使用してください. 差分ファイルだけを FreeBSD technical discussions mailing list <freebsd-hackers@FreeBSD.ORG> へ送ってはいけません. 途方にくれてしまいます! 私たちは多忙なので, あなたの提案に大変感謝します (これはボランティアのプロジェクトです!). すぐに取りかかることはできませんが, 処理されるまでは ちゃんと pr データベースに残っています.
あなたがそうした方がいいと思う場合 (例えば, ファイルの追加, 削除または名称変更など), 変更を tar ファイルにまとめ, uuencode(1) プログラムにかけてください. Shar アーカイブも歓迎します.
例えばあなたがそれ自身のさらなる配布を管理する コピーライト問題を良 く分かっていないとか, 単に厳しいレビューをおこなっておらず, リリース する準備ができていないなど, あなたの変更が潜在的に不安定な性質をも つものである場合, send-pr(1) で送付するよりむしろ FreeBSD core team <freebsd-core@FreeBSD.ORG> へ直接送ってください. コアチームメーリングリスト宛のメールは, 日々の仕 事のほとんどを FreeBSD でおこなっている人たちの, より小さなグルー プに届きます. このグループもまたとても忙しい ことに注意し て, 本当に必要な場合にコアチームの彼らにメールを 送るだけにしてください.
コーディングスタイルに関する情報は man 9 intro および man 9 style を参照してください. コードを提出する前には, 少なくともこの情報を意識しておいてくださるようお願いします.
重要な大きい仕事の寄贈や, 重要な新しいフィーチャーを FreeBSD に追加 する稀な場合には, 変更点を tar/uuencode したファイルにして送るか, それらを私たちの ftp サイト ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming へアップロードす ることのどちらかが通常必要になります.
大量のコードを伴った仕事の場合, コピーライトの神経過敏な問題が常に 出てきます. FreeBSD に含めるコードのコピーライトとして受け入れるこ とができるのは, 以下の二つです:
BSD コピーライト. このコピーライトは``権利に縛られない''性格 と商用企業にとって一般的な魅力をもつために最も好まれま す. FreeBSD プロジェクトは商用利用を阻んだりせず, 何かを FreeBSD へ投資する気になった商業関係者による参加を積極的に奨励 します.
GNU一般公有使用許諾, または``GPL''. このライセンスはコード を商用目的に使用する場合に余分な努力が求められるため, 私たち にあまり評判が良いというわけではありません. しかし, 私たちは 既に GPL 下の高品質なコード (コンパイラ, アセンブラ, テキスト フォーマッタ等) の提供を受けており, 私たちは現在それを必要と しています. そのため, このライセンスによる新たな貢献を拒絶す るというのは愚かなことでしょう. GPL 下のコードはソースツリー の別の部分, 現在のところ /sys/gnu か /usr/src/gnu に入っています. そのため, GPL が問題と なるような人は, 誰でも簡単にそれとわかるようになっています.
これ以外のタイプのコピーライトによる寄贈は, FreeBSD へ含めることを 考慮する前に, 注意深いレビューを受けなければなりません. 作者が独自 のチャネルを通して配布しており, そのような変更をおこなうことを常に 奨励している場合でも, 特に限定的な商用のコピーライトが適用される寄 贈は一般に拒否されます.
あなたの作品に ``BSD-スタイル'' のコピーライトを付けるには, 保護した いソースコードファイルすべての一番最初に 以下のテキストを入れて, %% の間を適切な情報に置き換えください.
Copyright (c) %%適切な年%%
%%あなたの名前%%, %%あなたの州%% %%郵便番号%%. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer as
the first lines of this file unmodified.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY %%あなたの名前%% ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL %%あなたの名前%% BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
$Id$
便宜をはかるため, このテキストのコピーは次の場所に置いてあります. /usr/share/examples/etc/bsd-style-copyright.
(訳注: 以下は神田敏広氏より寄贈された bsd-style-copyright の日本語訳です. ソースファイルに含めるものは原文の方であることに注意して ご利用ください. また, 原文との間に趣旨の差異が生じた場合, 原文の内容が FreeBSD プロジェクトの 意思であるものとします.)
Copyright (C) [年]
[あなたの名前] All rights reserved.
ソースとバイナリ形式の再配布および使用は, 変更の有無にかかわらず以下の
条件を満たす場合に限り許可される:
1. ソースコードの再配布は, 上記の著作権表示・この条件のリスト・下記の
否認声明文を保持しなければならない.
2. バイナリ形式の再配布は, 上記の著作権表示・この条件のリスト・下記の
否認声明文を, 配布物と共に提供される文書および/または他の資料の中に
含めなければならない.
(訳注:ここから「否認声明文」です)
このソフトウェアは[あなたの名前]および貢献者によって ``あるがままの状態''
で提供され, 商品性と特定の目的に対する適合性についての暗黙の保証に留ま
らず, いかなる明示および暗黙の保証を認めない. [あなたの名前]および貢献
者は, あらゆる直接的・間接的・偶発的・特殊的・典型的・必然的な損害 (代
替製品または代替サービスの獲得費; 効用・データ・利益の喪失; または業務
中断を含み, またそれだけに留まらない損害) に対して, たとえどのようにし
て生じたとしても, そしてこのソフトウェアの使用によってどのようにであれ
生じる, 契約上であろうと, 厳密な責任内であろうと, あるいは不正行為 (過
失やそうでない場合を含む) における場合であろうとも, いかなる責任論上も,
たとえそのような損害の可能性が予見されていたとしても, 一切の責任を持た
ない.
翻訳: 神田敏広
御協力 (五十音順・敬称略):
池田研二, 内川 喜章, 藤村 英治, むらたしゅういちろう
杢野 雅一, 横田＠宇都宮
原作: Jordan K. Hubbard <jkh@FreeBSD.ORG>, Gary Palmer <gpalmer@FreeBSD.ORG>, 浅見 賢 <asami@FreeBSD.ORG>, David O'Brien <obrien@FreeBSD.ORG> and Tim Vanderhoek <hoek@FreeBSD.ORG>. 28 August 1996.
訳: 下川 英敏 <simokawa@jp.FreeBSD.org>, 浅見 賢 <asami@FreeBSD.ORG>. 10 November 1996.
自分で port を作ることに興味がありますか, すばらしい!
これから, FreeBSD 用のportを作る際の, いくつかのガイドラインを 説明します. 実際にportをコンパイルするときのほとんどの仕事は /usr/share/mk/bsd.port.mk というファイルでおこないます. Portsコレクションについてのさらに細かい内部の働きについては, そちらの ファイルを参照してください. これにはコメントが細かく書いてありますので, Makefile を読むのにあまり慣れていない人でも, 得るものはとても大きいで しょう.
Note: ここでは, 変更可能な変数の一部についてのみ記述しています. ほとんどの変数はbsd.port.mk の始めに記述があります. また, このファイルは非標準のタブの設定になっています. Emacs や Vim はファイルのロード時にこれを認識しますが, viやexでは, ファイルをロードしたら :set tabstop=4 のようにして正しい値を設定する ことができます.
この節では, 簡単なportの方法について説明します. 多くの場合これ では不十分ですが, まあうまくいくかどうか試してみて損はないでしょ う.
まず, 元のtarファイルをDISTDIRに置きます. デフォルトは/usr/ports/distfilesです.
Note: 以下では, ソフトウェアはそのままコンパイルされるとします. つまり, FreeBSDのマシンで動かすために, 変更がまったく必要ない とします. もしなにか変更が必要な場合には次の節も参照する必要 があります.
最小限の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 <bsd.port.mk>
おわかりになりますでしょうか. $Id$があ る行の内容については, 気にしないでください. これはこのファイル がportsツリーに書き込まれるときにCVSによって自動的に書 き込まれます. もっと詳しい例が見たければ, Makefileのお手本 の節をご覧ください.
どのようなportでも, packageにするしないに関わらず, 3つ の記述ファイルが必要です. pkgサブディレクトリにある, COMMENT, DESCR, それに PLISTです.
これには, そのportについての説明を1行で書きます. Package の名前, バージョン番号等は 含めないでください. たとえば, こんな具合です:
A cat chasing a mouse all over the screen.
これは, そのソフトウェアについての, すこし長い説明を記述します. その port が何をするのかについての数段落程度の 簡潔な解説があれば十分です. このファイルはマニュアルでもなければ, 使用方法やコンパイル方法についての細かい 説明書でもありません. 特に, READMEファイル manpage をコピーしようとしてしている場合には 注意してください. これらは多くの場合, そのポートの簡潔な説明に なっていなかったり, 扱いにくい形式(manpage の場合, 行を揃えるために空白が調整されます)になっていたりします. もしこのソフトウエアに公式の WWW のホームページがあれば, ここに書いて下さい.
このファイルの最後にあなたの名前を書くことが 推奨されています. たとえば, こんな具合です.
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
このファイルには, このportによってインストールされるファ イルが列挙されます. このファイルはpackageを作る際のリス トとして使われるため, `packing list' とも呼ばれます. ここ に書かれているファイル名は, インストール時のプレフィックス (普通は /usr/local か /usr/X11R6) からの 相対パスです. MANn 変数を使用する場合(使用することが推奨されています)には, マニュアルはここに入れないでください.
簡単な例を載せておきましょう:
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 がインストール時にディレクトリを作成する場合には, @dirrm の行を加えて, その port が削除されるとき, そのディレクトリも削除されるようにしてください.
このファイルには, ファイル名をアルファベット順に並べるようにしてください. port のアップグレートのとき, 楽に確認ができるようになります.
ただ, make makesum と入力するだけです. bsd.port.mk にルールがあるので, 自動的にfiles/md5が生成されます.
そのportが正しく動くことを, package化を含めて確認してください. 以下の重要なポイントを確認してください.
PLIST にその port がインストールしないものが含まれていないこと.
PLIST にその port がインストールする全てのものが含まれていること.
reinstall ターゲットを使うことによって, 何度でもインストールが可能こと.
deintall の際に 後片付け をすること.
推奨されるテストの手順
make install
make package
make deinstall
pkg_add `make package-name`
make deinstall
make reinstall
make package
package および deinstall の段階で, どんな警告(warning)も出力されないことを確認してください. ステップ3の後, 新しいディレクトリが全て正しく消去されているかを 確認してください. また, ステップ4の後にそのソフトウェアを使用してみて, package からインストールされた場合に正しく動作するかを 確認してください.
portlintを使って, あなたの port が我々のガイドラインそっているかを確認してください. portlint プログラムは ports コレクションに含まれています. 特に, Makefile が正しい形式になっているか, package の名前が正しいか, をチェックするのに良いでしょう.
まず, やってよいことといけないこと についての節を読んでください.
さあ, あなたのportに満足したら, あとはそれをFreeBSDのメイ ンのportsツリーに置いて, 皆に使ってもらうだけです. いまある work ディレクトリや pkgname.tgz パッケージは必要ありませんから, まず消去してください. あとは, バグレポートの中に shar `find port_dir` の出力を, send-pr(1) プログラムを使用して送ってください. send-pr(1) についての詳細は, バグ報告と一般的な論評 を参照してください.) もし, 圧縮していない状態で, 20KB以上あるようなポートであれば, 圧縮して tar ファイルにして, バグレポートに入れる前に uuencode(1) を使用してください. (20KB以下のものでも, tar ファイルにして送ってもよいですが, あまり歓迎されません). バクレポートの category は ports, class は change-requestを必ず使用してください. (レポートを confidential (内密) にしないようにしてください!)
もう一度, オリジナルのソースファイル, work ディレクトリ, make package で作成したパッケージが含まれていないこと を確認してください.
Note: 以前, 新しい port をわれわれの ftp サイト (ftp.freebsd.org) にアップロードするようにお願いしたことがありますが, 現在このサイトの incoming ディレクトリは読み出し不可になっており, いまでは推奨されていません. 沢山の海賊版ソフトウェアがそこに置かれたためです.
私たちは, 何か不明な点があったらあなたに確認したのち, それをツリーへ置きます. あなたの名前は, FreeBSD ハンドブックやその他のファイルの ``Additional FreeBSD contributors'' のリストにも載るでしょう. う〜ん, 素晴らし い. :)
残念ながら, 移植がそう簡単ではなく, 動かすために多少の変更が 必要な場合も多いでしょう. この節では, portsコレクション の方法論にのっとって, そのような場合にどのように変更を施し, 動 くようにしたらよいかを順を追って説明します.
まず, あなたがportのディレクトリで make とタイ プしてから起こる一連の出来事について,順を追って説明しま す. ここを読むときには, 他のウィンドウで同時に bsd.port.mk も開いておくとよいかもしれません.
しかし, bsd.port.mkが何をしているのか, 完全に理解 できなくても心配する必要はありません. そう多くの人が理解して いるわけではないですから... f(^_^;)
まず, fetch というターゲットが実行されます. このfetchターゲットは ローカルディスクのDISTDIRに配布ファ イルがあるようにするのが役目です. もし, fetchが必要なファ イルをDISTDIRに見つけることが できなけ れば, Makefileに指定されているURL MASTER_SITES, そして私たちのFTPサイトで ある ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/ (ここ には, 私たちが取ってきたファイルを バックアップとして置いてあ ります) に探しにいきます. そして, ユーザのサイトがインター ネットに 直接接続されている場合には, 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 というターゲッ トを再定義することによって, どのようにでも直すことができます.
Note: ``メイン''のターゲット (例えば, 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/ports/distfiles/LOCAL_PORTS/ に置き場所を提供できます. この場所は, 変数 MASTER_SITE_LOCAL を使って参照してください. これについての問い合わせのメールは FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG> へお願いします.
その port の配布ファイルが特に理由もなく, しょっちゅう変る場合には, 配布ファイルをあなたのホームページに置いて MASTER_SITESの最初に入れてください. こうすることによって, ユーザ利用する場合に checksum mismatch エラーが起るのを防ぎ, 我々の ftp サイトの保守の負担を減らすことができます. もし, master site がたった一つしかない場合には, あなたのサイトにバックアップを置いて MASTER_SITES の2番目に加えてください.
もし, あなたのportに必要ないくつかの追加パッチがインター ネット上で手に入るのならば, それらも取ってきて, DISTDIR に置きます. もし, それらがメイン のソースのtarファイルとは別のサイトにあっても, 心配する必要 はありません. そのような状況にはちゃんと対応できるようになっ ています. (以下のPATCHFILESの記述 をご覧ください).
適当なディレクトリにtarファイルを展開して, FreeBSDの最新の バージョン上で, 正しくコンパイルできるために必要なあらゆる変 更を施します. 最終的に処理は自動化するわけですから, 何をおこなっ たかを注意深く記録しておきましょう. あなたのport が完成した暁には, ファイルの削除, 追加, 修正を含むすべての処 理が, 自動化されたスクリプトやパッチファイルで おこなえるようになっ ていないといけません.
もし, あなたの port のコンパイルやインストールのために必要 な手作業があまりに多いようならば, Larry Wall の模範的な Configure スクリプトでも参考にしたほうがいいかもしれませ ん. 新しいportsコレクションは, 最小のディスクスペースで, 個々のportがエンドユーザにできるだけ``プラグ & プレ イ''の状態でmakeできることをめざしています.
Note: あなたが作成し 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 のみコンパイルされま す).
もし, 適切なデフォルト設定があるのであれば, PACKAGE_BUILDING 変数をチェックして, それが設定されて いる場合には, ユーザ入力のスクリプトを起動しないように してください. こうすることによって, CD-ROM や ftp に 置く package を我々が作成することができます.
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 には port の名前の基幹部分を入れ ます. デフォルトのルールでは, 配布ファイルのリスト (DISTFILES) は DISTNAME EXTRACT_SUFX という名前 になっています. 例えば, foozolix-1.0.tar.gzの場 合, 通常のtarファイルだと, DISTNAME=foozolix-1.0 のようになります.
さらにデフォルトのルールでは, tarファイルは work/DISTNAME というサブディレクトリ に展開されることを仮定しています, 例えば work/foozolix-1.0/ といった具合いです.
これらの動作はもちろんすべて変更可能です. デフォルトのルー ルは最も標準的な場合を仮定しているだけです. まず, port が複 数の配布ファイルを必要とするときには, 単に明示的に DISTFILESを設定してください. もし, DISTFILES の一部だけが実際に展開される場合 には, それらをEXTRACT_ONLY に設定してくだ さい. この変数が定義されている場合には, 展開時に DISTFILESに優先して利用されます. 残りのファ イルもDISTDIRに取ってきますが, 展開時に はなにもせずに後で使うためにそのまま置いておかれます.
もし, DISTNAME が我々の package の名前についてのガイドライン に沿ったものでない場合には, PKGNAME にもっと良い名前を設定してください. 詳細は上記のガイドラインを参照してください.
完成した package の実体は /usr/ports/packages/All に置かれます. また, 1つかそれ以上の /usr/ports/packages のサブディレクトリからのシンボリッ クリンクが作られます. それらのサブディレクトリの名前が CATEGORIES という変数によって指定されます. これは, ユーザがFTPサイトやCD-ROMのpackageの山を渡り歩 くことを容易にするためです. 現在存在する カテゴリを見て, そ のportに適したもを選んでください.
このリストは, この port が port tree のどこに import されるかも決定します. 2つ以上のカテゴリを指定した場合には 最初のカテゴリで指定されるサブディレクトリに置かれること になります. 適切なカテゴリを選ぶ方法については, カテゴリ の節を参照してください.
もしその port が本当に現在存在するすべてのものとは異なって いる場合には, 新しいカテゴリ名を作ることもできます. その際には, FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG> 宛てに新しいカテゴリ名を提案する メールを送ってください.
カテゴリ名については, なんのエラーチェックも行なわれません.ミスタイプがあっても make package はなにも考えずに 新しいディレクトリを作ってしまいますので, 注意してください.
オリジナルの配布ファイルを指し示す 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 サイトではなく, これらの 有名なアーカイブの ミラーの中で好みのものを使用することが可能 です.
もし, オリジナルの配布ファイル以外にも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 という名前でコピーするかして, パッチを適用するようにします．
Note: 普通の gzip か compress された tar ファイルであれば, 通常のソースファイルと一緒にその時までに 展開されていますので, 明示的に展開する必要はありません. もし, 後者の方法を使用する場合には, すでにそのディレクトリにある なにかを上書きしないように, 注意する必要があります. さらに, pre-clean ターゲットにコピーしたパッチファイル を削除するコマンドを追加するのを忘れないでください.
あなたのメールアドレスをここに入れてください. お願いします. :)
保守担当者(maintainer)の責任についての詳細は， Makefile 中の MAINTAINER の節をご覧ください．
このプログラムが他のportに依存する場合には, 必要なものが 自動的に作られるようにすることができます. そのために, 以下の 5つの変数が用意されています. よくあるケースのためにあらかじめ設定された依存変数や, いくつかの依存関係の制御のための変数があります.
Port が必要とする非標準の共有ライブラリを この変数で指定 します. これは lib: dir[: target] という組のリストで, うち lib が共有ライブラリの名前, そして dir がそのライブラリが見つからない場合にインストールする port のあるディレクトリで, target はそのディレクトリで呼ばれるターゲットです. 例えば,
LIB_DEPENDS=
jpeg.9:${PORTSDIR}/graphics/jpeg:install
と指定してあれば,
まずメジャーバージョンが9のjpegライブ
ラリがあるかどうか確認し,
ない場合にはportsツリーの中の
graphics/jpeg というサブディレクトリに移動し,
そこ でコンパイルとインストールを行ないます. target の 部分は, DEPENDS_TARGET (デフォルトは install)
と等しいときには省略できます.
Note: 前半の lib 部分は ldconfig -r | grep -wF への引数になります. この変数には正規表現を入れられません.
この依存関係は2度チェックされます. まず extract ターゲットで, 次に install でチェックされます. (これは, その port を作成するマシンとインストールする マシンが違う場合でも, きちんとそのライブラリが利用できる ことを確認するためです.) また, 依存するもの名前は package の中にも含まれますので, ユーザのシステムに存在しなければ, pkg_add が自動的にインストールします.
Port を使用する際に必要となるファイルまたはプログラムがある ときにはこの変数で指定します. これは path: dir[:target] とい う組のリストで, path がファイルまたはプログラムの 名前, そして dir がそれが見つからない場合に作成する ためのディレクトリ名で target はそのディレクトリで呼ばれるターゲットです. 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-toolkits/tk80 というサブディレクトリから作られます.
Note: この例で, innd は実際にはプログラムです; この ように, プログラムであっても標準のサーチパス以外のところに あるようなものの場合には, 絶対パスで指定してください.
この依存関係はinstall ステージのはじめでチェック されます. また, packageを作る際に必要となるportのpackage名 が記録され, pkg_addを使用すると ユーザのシステムに存在しない場合には自動的にそちら のpackageもインストールされるようになります. target の部分は, DEPENdS_TARGET と同じ場合には省略可能です.
Port のコンパイルに必要なファイルまたはプログラムがある ときは, この変数で指定してください. RUN_DEPENDSと同 様に, これは path: dir[:target] という組のリストです. 例 えば,
BUILD_DEPENDS=
unzip:${PORTSDIR}/archivers/unzip
は unzip
という名前のプログラムを探し, 見つから
ない場合にはarchivers/unzip
サブディレクトリで作 れという意味になります.
Note: ここでは ``コンパイル'' と一口にいいましたが, この変数は実際 にはファイルの展開から実際のコンパイル・リンクまで 全部をま とめて面倒を見てくれます. この依存関係は extract ステージからチェックされます. target の部分は DEPENDS_TARGET と同じ場合には省略可能です.
この変数は, portを取ってくるのに必要なファイルまたはプロ グラムを指定するのに使います. 上の二つと同様に, これは path: dir[:target] という組のリストです. 例えば,
FETCH_DEPENDS=
ncftp2:${PORTSDIR}/net/ncftp2
としておけば, ncftp2
という名前のプログラムを探 し,
見つからない場合にはnet/ncftp2 サブディレク
トリにいってインストールします.
この依存関係は fetch ステージからチェックされます. target の部分は DEPENDS_TARGET と同じ場合には省略可能です.
上記の四つのいずれにもあてはまらないような 依存関係がある場 合, または他の port がインストールされれているだけではなく, ソースが展開されている必要がある場合にはこの変数 を使います. これは dir[:target] という形式のリスト になります. 上記の四つと違って特に ``確認''するものがありませんので.
もし ports が X Window System を必要とするのであれば, USE_XLIB=yes を定義してください. (これは USE_IMAKEも意味します) BSD make の代りに GNU make を必要とする場合には, USE_GMAKE=yes を定義. 動作するのに GNU autoconf を必要とする場合には, USE_AUTOCONF=yes を定義. 最新の qt toolkit を使用 する場合には USE_QT=yes を定義. perl 言語のバージョン5 を必要とする場合には, USE_PERL5=yes を定義してください. (特に最後のは重要で, FreeBSD のいくつかの バージョンでは基本システムに perl5 を含みますが, 他のものは含んでいません.)
上で述べたように, 依存する ports が必要になったときに呼ばれるデフォルトのターゲットは DEPENDS_TARGET で, そのデフォルトは install です. これは, ユーザの使用する変数で, port の Makefile で定義されるものではありません. もし, あなたのportが特別な方法で, 依存関係を扱う必要が ある場合には, DEPENDS_TARGET を再定義するのではなく, *_DEPENDS 変数の :target の部分を利用してください.
make clean とタイプしたときには, 依存する port も自動的に clean されます. もしそうしたくない場合には, NOCLEANDEPENDS を環境変数として設定してください.
無条件に他の port に依存させるには, 特別に nonexistent という文字列を BUILD_DEPENDS あるいは RUN_DEPENDS の最初のフィールドに使用してください. これは, 他の port のソースが必要なときのみ使用してください. target も指定することによって, コンパイルの時間を節約することができます. 例えば,
BUILD_DEPENDS=
/nonexistent:${PORTSDIR}/graphics/jpeg:extract
これは, 常に JPEG port の directory
に行きソースの展開を行ないます.
あなたがやりたいことが他の方法ではできない場合以外は, DEPENDS を使わないでください. これは常に 他の port の作成を行い(さらにデフォルトでインストール を行い), package も作成します. もし本当にこれがあなたの やりたいことでしたら, 代りにこれを BUILD_DEPENDS と RUN_DEPENDS で書くことをお勧めします --- 少なくとも意図が明確になります.
GNUのmakeを使う場合には, USE_GMAKE=yes と指定してください. Port に GNU の configure が含まれ ている場合には, GNU_CONFIGURE=yes を使います(これは, HAS_CONFIGURE も意味します). configure に追加の引数 (デフォルトでは, GNU の configure では --prefix=${PREFIX}, GNUでない configure では空) を渡したい場合には追加部分を CONFIGURE_ARGS で指定してください. そのパッケージが autoconf を使用する場合には, USE_AUTOCONF=yes を使います. これは, GNU_CONFIGURE も意味し, configure の前に autoconf を実行します.
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 がimakeは使うものの install.man ターゲットを持っていない場合, NO_INSTALL_MANPAGES=yes を指定してください. つい でに, 作者を探し出して八つ裂きにするといいでしょ う. (-_-#)
Portを作成する場合, 考慮しなくてはいけないことがさらにいくつかあります. この節では, それらのうちもっともありがちなものについて説明します.
共有ライブラリをインストールするときには, 共有ライブラリのキャッシュを更新するために port の Makefile の post-installtarget から${LDCONFIG} -m を走らせてください. このコマンドの引数は共有ライブラリのインストールしてある ディレクトリ (通常 PREFIX/lib) です.
また, pkg/PLIST に @exec /sbin/ldconfig -m と @unexec /sbin/ldconfig -R の組を入れて, package をインストールした場合にも共有ライブラリがすぐ使え, 削除の際にも, システムがまだライブラリが存在すると 誤認しないようにしてください. この行は共有ライブラリを指定する行のすぐ後に 書くのがよいでしょう:
lib/libtvl80.so.1 @exec /sbin/ldconfig -m %D/lib @unexec /sbin/ldconfig -R
絶対に引数なしでただ ldconfig とだけ書いてある行を Makefile や pkg/PLIST ファイルに入れないでください. このコマンドを実行すると, 共有ライブラリのキャッシュが /usr/lib の内容のみとなり, ユーザのマシンにさまざまな問題をもたらします (「ぎゃぁ! このportをインストールしたら xinit が使えなくなっちゃった!」). この掟を破った者は, 永久に地獄の底で苦しみ続けるように, 閻魔様に頼んでおきます.
FreeBSD は 3.0-RELEASE で ELF に移行しましたので, シェアードライブラリを作成するたくさんの port を ELF 対応 にする必要があります. 3.0 システムは ELF としても a.out としてmも 動作しますし, 我々は非公式ではありますが, できるだけ長い間 2.2 システムのサポートをしたいと思っていますので, 複雑な状況です. 以下は a.out のみに対応している port をどのように a.out と ELF 両方に対応させるかのガイドライ ンです.
このリストの一部は, 移行時にしかあてはまらないものもありますが, 古い port をアップグレードしたい場合に参考になるように, しばらくのあいだは残しておきます.
a.out ライブラリは, /usr/local/lib から, aout サブディレクトリ に移動しなくはなりません. (もし移動しないと, ELF ports がそれらをあっさり上書きして しまいます.) 3.0-CURRENT の src/Makefile にある move-aout-libs ターゲット (aout-to-elf から呼ばれます) がその移動をしてくれます. a.out ライブラリを移動するだけなので, ELF と a.out の両方のライブラリが標準的な ディレクトリにあるシステムでは, このターゲットを実行しても安全です.
port ツリーは package をそのマシンのフォーマットで作成します. つまり, 2.2 では a.out, また 3.0 では `objformat` の結果によって, a.out か ELF になります. また, いったん a.out ライブラリをサブディレクトリに移動すると a.out ライブラリの作成はサポートされません. (つまり, あなたがにをすれば良いのかを理解しているのならば, うまく作成できるかもしれませんが, 自力でやらなければならないということです)
Note: もし port が aout でしか動作しないのなら, BROKEN_ELF に原因を説明する文字列を設定してください. この変数が設定された port は, ELF システム上でのビルドの際スキップされます.
bsd.port.mk において PORTOBJFORMAT は aout か elf に設定され, 環境変数 CONFIGURE_ENV, SCRIPTS_ENV, MAKE_ENV の中で export されます. (2.2-STABLE では常に aout になります). また, PORTOBJFORMAT=${PORTOBJFORMAT} として PLIST_SUB に渡されます. (以下にある ldconfig に関するコメントを参照して下さい.)
この変数は, 以下のようにして bsd.port.mk 中で設定されます.
PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout
この変数を使って, port の make の過程で何をすべきかを決定すべきですが, もし port の configure スクリプトが元々, ELF システムを自動的に検出するのであれば, PORTOBJFORMAT を参照する必要はありません.
以下は, a.out と ELF での共有ライブラリの扱いの違いです.
共有ライブラリのバージョン
ELF の共有ライブラリは, libfoo.so.M という名前になっていなければなりません. ここで M は単一の バージョン番号を表します. 一方 a.out のライブラリは libfoo.so.M. N という名前で, M はメジャーバージョン番号, N はマイナーバージョン番号になっている必要があります. これらを混同しないでください. libfoo.so.N. M という名のELF 共有ライブラリや libfoo.so.N という名の a.out 共有ライブラリ (あるいはシンボリックリンク) は 絶対にinstallしないでください.
リンカコマンドライン
直接 ld を使用せずに, cc -shared を使用してください. たった一つの違いは, ELF には, -Wl,-soname,libfoo.so.M コマンドラインにを加える必要があることです.
ELF のリンカを満足させるためには, libfoo.so から libfoo.so.N へのシンボリックリンクを作る必要があります. これは, PLIST にも加えなくては いけませんし, a.out の場合でも害にはならないので (一部の port ではダイナミックリンクローディングのために 必要でもあります), PORTOBJFORMAT の設定を気にせずに, ただ単純にリンクを作成してください.
すべての port の Makefile を編集して, LIB_DEPENDS からマイナー番号を除去する必要があり, 正規表現のサポートも除去する必要があります. (例えば, foo\\.1\\.\\(33|40\\) から foo.2) マッチングは grep -wF を使って行われます.
PLIST は, a.out のマイナー番号が0であれば, 短い (ELFの) 共有ライブラリの名前を含み, さもなくば長い (a.outの) 名前を含んでいる必要があります. bsd.port.mk は 自動的に, PORTOBJFORMAT が aout であれば, .0 を 短い共有ライブラリの名前の行に付け加え, PORTOBJFORMAT が elf であれば, マイナー番号を 長い共有ライブラリの名前から削除します.
ELF システムで 2 つのバージョン番号を持つ共有ライブラリを インストールしたり, aout システムで 1 つのバージョン番号しか持たない共有ライブラリを インストールするのが避けられない場合 (例えば他のオペレーティングシステム用の 互換ライブラリをインストールする port など), NO_FILTER_SHLIBS 変数を定義すれば, 前節で説明されている PLIST 編集の機能が停止されます.
Makefile 中の ldconfig の行は以下のようになります.
${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....
また PLIST 中では:
@exec /usr/bin/env OBJFORMAT=%%PORTOBJFORMAT%% /sbin/ldconfig -m ... @unexec /usr/bin/env OBJFORMAT=%%PORTOBJFORMAT%% /sbin/ldconfig -R
となります. これは, システムのデフォルトフォーマットではなく パッケージのフォーマットに応じて, 正しい ldconfig が呼ばれることを保証するためのものです.
もし, あなたの port が 変数(例えば 解像度とか紙のサイズなど)を変えたりした, ちょっと違うバージョンを作成する必要があるときには, ユーザが分りやすいように, package ごとに別々のサブディレクトリを作成し, ただし, できるだけ port 間でファイルを共有するようにしてください. 典型的な例では, うまく変数を使えば, とても短いMakefileだけ, 1つ以外のすべてのディレクトリに置くだけで済みます. その短い Makefile には MASTERDIR を使って, 残りのファイルがあるディレクトリを指定できます. また PKGNAME の一部に変数に使って, package が別々の名前を持つようにしてください.
以下が, とても良い例になるでしょう. これは 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 ファイルももっています. そこで, make と入力すると, デフォルトの解像度(300)を使って, 普通に port の作成を行います.
他の解像度に関してですが, これが, xdvi118/Makefile の(コメントを除いた) すべてです.
RESOLUTION= 118
MASTERDIR= ${.CURDIR}/../xdvi300
.include ${MASTERDIR}/Makefile
(xdvi240/Makefile と xdvi400/Makefile も同様です). MASTERDIR が bsd.port.mk に PATCHDIR や PKGDIR などの通常のサブディレクトリが xdvi300 にあることを教えます. RESOLUTION=118 の行が, xdvi300/Makefile の RESOLUTION=300 の行を無効にし, port は解像度を118として作成されます.
まず, 共有ライブラリのバージョンについての指針 を読んで, 共有ライブラリのバージョンを 一般的にどうすれば良いかを理解してください. 盲目的に, ソフトウエアの作者がちゃんと理解していると 信じててはいけません, 多くの場合違います. 細い点まで考慮することは大変重要なことです, なぜなら我々は互換性がないかもしれない大量の ソフトウェアを共存させようとする, 特殊な状況にあるからです. 不注意な port の導入が共有ライブラリに関して, 多大な問題を引き起したことが過去にあります (今まで, jpeg-6b がなぜ 9.0 といバージョン番号を持っているか不思議に 思ったことはありませんか?). もし, 疑問があれば, FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG> にメールを送ってください. ほとんどの時間は, 正しいシェアードライブラリのバージョンを決めることと, それを実現するためのパッチを作成することに終始します.
しかしながら, が同じソフトウェアの違ったバージョンの ソフトウェアが既にツリーにあるばあいには, 状況は非常に複雑です. つまり, FreeBSD では, ユーザがリンカにどのバージョンの共有ライブラリを 使用するかを指定できないからです (リンカは常にもっとも高いバージョンを選びます). これは, もし, libfoo.so.3.2 と libfoo.so.4.0 がシステムに存在するときには, リンカに特別なアプリケーションだけ libfoo.so.3.2 をリンクするように指示する方法がないことを意味します. これは, コンパイル時のリンクという意味では完全に見劣りします. この場合の唯一の解決方法は, 共有ファイルの名前の ベース 部分を変えることです. 例えば, libfoo.so.4.0 を libfoo4.so.1.0 へ変えることによって, バージョン 3.2 とバージョン 4.0 共に他の port からリンクされることができるようになります.
MAN[1-9LN] 変数を使用すると, 自動的にすべてのマニュアルを pkg/PLIST に加えます (つまり, マニュアルを PLIST に加えては いけません --- PLIST の生成 を参照してください). またマニュアルを /etc/make.conf 中の NOMANCOMPRESS の設定に応じて, install時に自動的に圧縮したり伸長したりします.
マニュアルをインストール時に圧縮するかどうかを 指定するには, MANCOMPRESSED 変数を使用します. この変数は, 3つの値をとることができます, yes, no そして maybe です. yes はマニュアルが既に圧縮されて インストールされている, no はされていない, maybe はそのソフトウェアがすでに, NOMANCOMPRESS に合わせており bsd.port.mk が特別なにもする必要がないことを意味します.
USE_IMAKE がセットされていて, NO_INSTALL_MANPAGES がセットされていなければ, MANCOMPRESSED は自動的に yes に設定され, それ以外の場合には, no になります. デフォルトがあなたの port に合わない場合以外は明示的に設定する必要がありません.
PREFIX 以外のディレクトリの下に マニュアルを置くような port では MANPREFIX を指定することができます. さらに, 特定のセクションのマニュアルだけ, 標準ではない場所にインストールする場合, 例えばいくつかの Perl のモジュールの ports など, には個々のマニュアルのパスを MANsectPREFIX (sect は, 1-9, または, L か N を表わします) によって指定できます. ができます.
マニュアルが, 言語特有のサブディレクトリに 置かれる場合には, 言語名を MANLANG に設定してください. この変数のデフォルト値は, "" になっています (つまり, 英語のみ).
これは, 全部をまとめた例です.
MAN1= foo.1
MAN3= bar.3
MAN4= baz.4
MANLANG= "" ja
MAN3PREFIX= ${PREFIX}/share/foobar
MANCOMPRESSED= yes
以下の6個のファイルがこの port でインストールされます.
${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 を必要とするアプリケーションが増えて きました. (Motif自体は有料のものがいくつかの会社から手に入りま すし, 多くのアプリケーションがコンパイル可能な無料の互換ライブラリ が x11-toolkits/lesstifにあります) Motifはかなり広く使われていますし, 製品のライ センスではライブラリを静的にリンクした 実行形式は再配布が認めら れている場合が多いので, Motifを必要とするソフトウェアを簡単に 動的(port からコンパイルする人々のために)/静的(package を配布 する人々のために)にリンクできるような しくみが用意されています.
Motif がないとコンパイルできないportのMakefileではこの変 数を指定してください. これによって, Motifを持っていない人が このportをコンパイルしようとするのを未然に防ぎます.
この変数は bsd.port.mk によって Motif ライブラリの指 定に置き換えられます. ソース内のMakefileやImakefileで Motif ライブラリを指定しているところをこの変数に置き換えるよ うにパッチをあててください.
代表的な例としては以下の二つがあげられます:
MakefileかImakefileの中でMotifライブラリが -lXm として使われている場合には, かわりに MOTIFLIB と書いてください.
Imakefileの中で XmClientLibs が使われている 場合には, それを ${MOTIFLIB} ${XTOOLLIB} ${XLIB} と書きかえてください.
Note: MOTIFLIB は通常 -L/usr/X11R6/lib -lXm か /usr/X11R6/lib/libXm.a に置き換えら れます. したがって前に -L や -l をつけ る必要はありません.
もし, あなたの port が X window system のフォントをインストールするのであれば, それらを X11BASE/lib/X11/fonts/local に置くようにしてください. このディレクトリは XFree86 release 3.3.3 で新設されたものです. もし, それが存在しなければ作成し, ユーザに XFree86 を 3.3.3 かそれより新しいものに更新か, すくなくとも, このディレクトリを /etc/XF86Config の font path に加えるように促すメッセージを出力するようにしてください.
新しい版の texinfo(2.2.2-RELEASE およびそれ以降に入っています) には, install-info というコマンドが含まれており, dir ファイルに項目を追加したり, 削除したりすることがで きます. もし, あなたの port が info ドキュメントをインストー ルするのであれば, 以下の指示に従って, その port および package が正しく, ユーザの ${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
という節に置く.)
:
Note: このプログラムは, 実際には info ファイルをインストール しません, 単に dir ファイルにエントリーを挿入したり削除し たりするだけです.
これから, install-info を使用するように, ports を変換す る7段階の工程を示します. 例として editors/emacsを 使用します.
まず, texinfo のソースを見て, @dircategory と @direntry 文がないファイルについて, それらを追加するパッチを作成します. 以下は, ここでの例での patchの一部です:
--- ./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 :
フォーマットについては見ればわかると思います. dir というファイルに必要な項目を書いておいてくれる作者 も多いので, まず自分で書く前にさがしてみてください. また, 関係 する ports も調べて, 節(section)の名前や, インデントなどが きちんと合っているかどうかを確認してください (項目のテキスト は, すべて4つめのタブ・ストップ(tab stop)から始めることを推 奨します).
Note: 1つのファイルに対して1つの info の項目しか書けないことに注 意してください, これは, install-info --delete が, そのバグにより, <@direntry> セクションに複数の項目を書 いても, 初めの1つの項目しか削除してくれないからです.
texinfo のソースにパッチをあてるかわりに, dir の項目 を install-info の 引数((--section, --entry) として与えることもできます. これはあまり良い方法とは 思えません, なぜなら, 同じ情報を3ヶ所(Makefile, PLIST の @exec/@unexec: 以下参照) に重複して, 書く必要があるからです. しかしながら, もし日本語(あるいは, 他のマルチバイト文字)の info ファイルがあるのならば, install-info の特別な引数を使用する必要があるでしょう, なぜならば, makeinfo がこのような texinfo ソースファイル を扱えないからです. (このようなものをどう扱うかの例としては, japanese/skk の Makefile と PLIST を見て ください.)
portのディレクトリに戻って, make clean; make をして, info ファイルが texinfo ソースファイルから再び生成さ れることを確認してください. texinfo ソースファイルのほうが info ファイルよりも新しいので, make とタイプすれば, info ファイルは再構築されるはずですが, 多くの Makefile には info ファイルの正しい依存関係が書かれていません. emacs の場合, info ファイルの再構築ため, man サブディレクトリ に降りていくようにするために, メインの Makefile.in にパッ チをあてる必要がありました.
--- ./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)
man サブディレクトリでのデフォルトターゲットは, info で呼ばれるのに対して, メインの Makefile では, all で呼びたいので, 2つめのpatchが必要でした. また, info info ファイルのインストールも削除しました, なぜなら, 同じものが同じ名前で既に /usr/share/info にあるからです. (このパッチはここにはありません.)
もし, Makefile に dir ファイルをインストールす る個所があれば, 削除します. あなたの port がインストー ルしてはいけません. また, dir ファイルを壊してしまうよう なコマンドの類も削除します.
--- ./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
post-install ターゲットを Makefile に加えて, dir ファイルが存在しなければ作成するようにします. また, インストールされた info ファイルについては, install-info を実行するようします.
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 <bsd.port.mk>
新しい info ファイルを作成するのに, /usr/share/info/dir と上のコマンド, 以外は使用しな いでください. 実際のところ, もし port する人がこれに関して PLIST に自らまったく手を加える必要がないのであれば, 上 のパッチのはじめの3行を bsd.port.mk に加えたでしょう.
PLIST を編集して, 同じ働きをする @exec 文, そ れにpkg_delete のために @unexec 文を加えてくださ い. @unexec を使用して 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
Note: @unexec install-info --delete コマンドは, info ファイル自身より先に置き, コマンドがファイルを読めるようにし ておかなければならないことに注意してください. また, @exec install-info コマンドは info ファイルおよび dir ファイルを作る @exec コマンドより後に おかなければなりません.
テスト をして出来栄えに感服しましょう :) 各段階の前後に, dir ファイルをチェックしましょう.
まだ触れていない, いくつかのこつが pkg/ サブディレクトリにはあり, 時として便利でしょう.
もし, インストールする人にメッセージを表示する 必要がある場合には, そのメッセージを pkg/MESSAGE に置けます. この機能は, pkg_add の後の追加のインストール手続きを表示するときなどに, 重宝します.
Note: pkg/MESSAGE ファイルは pkg/PLIST に加える必要はありません. また, もしユーザが package ではなく port を使用して いる場合には自動的には表示されませんので, 明示的に post-install で表示するようにするべきでしょう.
バイナリパッケージが pkg_add でインストールされるときに, 実行される必要がある コマンドがあれば, pkg/INSTALL スクリプトを使って実行することができます. このスクリプトは自動的に package に加えられ, pkg_add によって2度実行されます. はじめは INSTALL ${PKGNAME} PRE-INSTALL と実行され, 2度目には, INSTALL ${PKGNAME} POST-INSTALL と実行されます. どちらのモードで実行されているかは, $2 を調べることによってわかります. 環境変数 PKG_PREFIX には package がインストールされるディレクトリが設定されます. 詳細は pkg.add(1) を見てください.
Note: port を make install で インストールするときには, このスクリプトは自動的に実行されません. もし, 実行される必要があるならば, port の Makefile から明示的に呼ぶ必要があります.
port が(インストールされるシステムの状態によって) インストールされるべきか, されないべきか区別する必要が あるときには, ``要件(requirements)'' スクリプト pkg/REQ を作ることができます. これは, インストール及びデインストール (package の削除)の時に自動的に実行され, それらが処理されるべきかを決定します.
いくつかの port, 特に p5- portsなど, は configure のオプション (あるいは, p5- ports の場合は perl のバージョン)によって, PLIST を変える必要があります. これを容易に実現するために, PLIST 中の %%OSREL%%, %%PERL_VER%%, %%PERL_VERSION%% は, 適切に置き換えられるようになっています. %%OSREL%% の値は, オペレーティングシステムの数字で表されたリビジョンです (例えば, 2.2.7). %%PERL_VERSION%% は perl のバージョン番号全体(例えば, 5.00502 )で, %%PERL_VER%% はバージョン番号から, パッチレベルを引いてものです(例えば, 5.005).
他の置き換えが必要であれば, PLIST_SUB 変数に VAR=VALUE という形式のペアのリストを設定することによって, PLIST 中の %%VAR%% は VALUE に置き換えられます. 例えば, バージョンに固有の沢山のファイルを インストールする場合には, Makefile に
OCTAVE_VERSION= 2.0.13
PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}
と書いて, PLIST 中のバージョン番号が表われるすべてのところに, %%OCTAVE_VERSION%% と書きます. このようにしておけば, port をアップグレードするときに, 何十行(ときとして, 何百行)も PLIST を書き替えないですみます.
この書き換えは ( マニュアル の追加も) do-install と post-install ターゲット のあいだに, PLIST を読み TMPPLIST (デフォルトは, WRKDIR/.PLIST.mktmp ) に書き込むことによって行なわれます. もし, あなたの port が PLIST を実行時に生成するのであれば, do-install のあいだか, その前に行うようにしてください. また, 書きかえられたあとのファイルを編集する必要がある場合には, post-install で, TMPPLIST を書きかえてください.
pkg サブディレクトリにあるファイルは全て, 変数を 使用して定義されていますので, 必要であれば Makefile 中で 変更可能です. いくつかの ports で 一つの pkg サブディレクトリを共有する場合や, 上記のファイルに書き込む 必要があるときなど, 特に便利です. (pkg サブディレクトリに直接書き込むのが良くない理由に ついては WRKDIR 以外への書きこみ を参照してください.)
以下が変数名とそのデフォルト値の表です.
| Variable | Default value |
|---|---|
| COMMENT | ${PKGDIR}/DESCR |
| DESCR | ${PKGDIR}/DESCR |
| PLIST | ${PKGDIR}/PLIST |
| PKGINSTALL | ${PKGDIR}/PKGINSTALL |
| PKGDEINSTALL | ${PKGDIR}/PKGDEINSTALL |
| PKGREQ | ${PKGDIR}/REQ |
| PKGMESSAGE | ${PKGDIR}/MESSAGE |
PKG_ARGSを上書きせずに, これらの変数を変更 するようにしてください. PKG_ARGSを変更すると これらのファイルは port から正しく /var/db/pkg にインストールされなくなります.
ソフトウェアによっては制限の厳しい ライセンスがついてきたり, 法律的に問題があるかもしれません. (PKPの公開鍵暗号化, ITAR (暗 号化ソフトウェアの輸出) などが例としてあげられます). それらを どう扱えばいいかはライセンスの文面によって さまざまな場合があり ます.
Note: ソフトウェア移植者として, あなたにはライセンスをよく読み, FreeBSD プロジェクトが FTP または CD-ROM で配布してはいけないソフ トウェアを配布してしまうことのないよう, 注意する義務があります. なにか疑問がある場合には, FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG>に聞いてみてください.
よく見られるケースに対処するために, 二つの変数が用意されてい ます:
ソフトウェアに ``有償再配布を禁ずる'' という趣旨のライセン スがついてきた場合には NO_CDROM という変数にその理由を記述して ください. 私たちはこれがついているportはCD-ROMリリースに入 れないようにしますが, オリジナルのソースファイルとpackage はFTPでは取れるようにしておきます.
もしも, 生成される package が個々のサイトで独自に構築さ れる必要があったり, ライセンスによって生成されるバイナリが 配布できない場合には, NO_PACKAGE 変数にその理由を記述してくだ さい. そのような package が FTP サイトに置かれたり, リリース 時の CD-ROM へ入らないようにします. ただし, いずれの場合も distfile は(FTP や CD-ROM に)含まれるようになります.
Portが, 使用者によっては法律上の問題が生じる時 (暗号化ソフ トウェアなど), または``商用利用を禁ずる''とライセンスに書い てある場合には RESTRICTEDという変数にその理由を入れ てください. この場合には, ソースファイルやpackageは私たちの FTPサイトにも置かれません.
Note: GNU一般公有使用許諾書 (GPL) はバージョン1, 2とも port作成上は何ら問題にはなりません.
Note: もしあなたが，ソースツリー管理者 (committer) であれば， ソースツリーにこのようなportを入れる際に, ports/LEGAL ファイルを書き換えるのを忘れないようにし てください.
Port のバージョンが原作者からのものに比べて古いことに気がつ いたら, まずはあなたの持っているportが私たちの最新のもの (ミラー サイトの ports/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(1) (カテゴリーは, ports)に diff の出力結果を添えて, 私たちに送ってもらうのが一 番よいです. commit する際に CVS に明確に記述しなければならない ので, 付け加えたり削除したりしたファイルがあったら, それについ て書いておいてください. もし diff の大きさが 20 KB 程度を 超えるようであれば, 圧縮したものを uuencode して下さい. そうでなければそのまま PR に入れるだけでいいです.
繰り返しになりますが, ports の変更を送るときには, shar(1) ではなく diff(1) を使用してください.
この節では, ソフトウェアをportする上でよくある落し穴などにつ いて説明します. このリストを使って, あなた自身が作成した port のチェックはもとより, PR データベースにある, 他の人が作成した port のチェックもできます. あなたがチェックした port について のコメントを バグ報告と一般的な論評 にしたがって, 送ってください. PR データベースにある port を チェックすることによって, 私達がそれらを commit するのを早くし, あなたが何をしているか理解していることも示します.
バイナリは strip してください. オリジナルのソースがバイナリを strip してくれる場合は良いですが, そうでない場合には post-install ターゲットを指定して strip するようにするとよいでしょう. 例えば, こんな風になります:
post-install:
strip ${PREFIX}/bin/xdl
インストールされた実行形式がすでに strip されているかどうかは file コマンドで確認できます. これが`not stripped'と言わなければ, stripされているということです.
あなた自身の *-install ターゲットでファイルの正しいモードと オーナを保証するために, 必ずbsd.port.mkで提供されて いるマクロを使用してください. マクロは以下のようなものがあります.
${INSTALL_PROGRAM} は実行可能なバイナリを インストールするコマンドです.
${INSTALL_SCRIPT} は実行可能なスクリプトを インストールするコマンドです.
${INSTALL_DATA} は共有可能なデータを インストールするコマンドです.
${INSTALL_MAN} はマニュアルとその他のドキュメ ントをインストールするコマンドです. (圧縮はしません)
これらは基本的に install コマンドに適当なフラグを与え たものです. どのようにこれらを使用するかは以下の例を見てください.
WKRDIR の外のファイルにはなにも書き込まないように してください. WRKDIR は ports のビルド中に書き込こめる ことが保証されている唯一の場所です( CDROM から ports をコンパイルを参照). PKGDIR にあるファイルを修正する必要がある ときには, 変数の再定義 によって行ない, 上書きはしないでください.
WRKDIRPREFIX を尊重していることを確認してください. 特に, 別の port の WRKDIR を参照している ときには気を付けてください. 正しい場所は, WRKDIRPREFIX PORTSDIR /subdir/ name/work, です, PORTSDIR/subdir/ name/work とか .CURDIR/../../subdir /name/work とかではありません.
また, 自分で WRKDIR 定義するときには, 頭に ${WRKDIRPREFIX}${.CURDIR} が付いている 事を確認してください.
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 <sys/param.h> #endif
これらの 2 つのシンボルが定義されているすべてのシステムには sys/param.h があるはずです. もし, そうでないシステムを発見したら我々にも教えてください. FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG> までメールを送ってください.
あるいは, GNU の Autoconf のスタイルを使用することもできます,
#ifdef HAVE_SYS_PARAM_H #include <sys/param.h> #endif
この方法を使用するときには, Makefile 中の CFLAGSに -DHAVE_SYS_PARAM_H を加えることを忘れないようにしてください.
いったん sys/param.h がインクルードされると,
#if (defined(BSD) && (BSD >= 199103))
このようにしてそのコードが 4.3 Net2 コードベース, またはそれより新しいもの (例: FreeBSD 1.x, 4.3/Reno, NetBSD 0.9, 386BSD, BSD/386 1.1とそれ以前) の上でコンパイルされているかを検出できます.
#if (defined(BSD) && (BSD >= 199306))
これは, 4.4コードベース, またはそれより新しいもの (例: FreeBSD 2.x, 4.4, NetBSD 1.0, BSD/386 2.0とそれ以後) の上でコンパイルされているかどうかを 検出するために使用します.
4.4BSD-Lite2 コードベースでは, BSD マクロの値は 199506 になっています. これは参考程度の意味合いしかありません. 4.4-Lite ベースの FreeBSD と 4.4-Lite2 での変更がマージされたバージョンとを 区別するのに使用するべきものではありません. この目的のためには, __FreeBSD__ マクロをかわりに使用してください.
以下は控え目に使ってください.
__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 <osreldate.h>
# if __FreeBSD_version >= 199504
/* 2.0.5+ release specific code here */
# endif
#endif
| Release | _FreeBSD_version |
|---|---|
| 2.0-RELEASE | 119411 |
| 2.1-CURRENT's | 199501, 199503 |
| 2.0.5-RELEASE | 199504 |
| 2.1 以前の 2.2-CURRENT | 199508 |
| 2.1.0-RELEASE | 199511 |
| 2.1.5 以前の 2.2-CURRENT | 199512 |
| 2.1.5-RELEASE | 199607 |
| 2.1.6 以前の 2.2-CURRENT | 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.1-RELEASE 以後の 2.2-STABLE | 220000 (これも同じです) |
| texinfo-3.9 以後の 2.2-STABLE | 221001 |
| top 導入以後の 2.2-STABLE | 221002 |
| 2.2.2-RELEASE | 222000 |
| 2.2.2-RELEASE 以後の 2.2-STABLE | 222001 |
| 2.2.5-RELEASE | 225000 |
| 2.2.5-RELEASE 以後の 2.2-STABLE | 225001 |
| ldconfig -R 以後の 2.2-STABLE | 225002 |
| 2.2.6-RELEASE | 226000 |
| 2.2.7-RELEASE | 227000 |
| 2.2.7-RELEASE 以後の 2.2-STABLE | 227001 |
| semctl(2) 変更後の 2.2-STABLE | 227002 |
| 2.2.8-RELEASE | 228000 |
| 2.2.8-RELEASE 以後の 2.2-STABLE | 228001 |
| mount(2) 変更以前の 3.0-CURRENT | 300000 |
| mount(2) 変更以後の 3.0-CURRENT | 300001 |
| semctl(2) 変更以後の 3.0-CURRENT | 300002 |
| ioctl 引数変更後の 3.0-CURRENT | 300003 |
| ELF 移行後の 3.0-CURRENT | 300004 |
| 3.0-RELEASE | 300005 |
| 3.0-RELEASE 以後の 3.0-CURRENT | 300006 |
| 3/4 の分岐後の 3.0-STABLE | 300007 |
| 3.1-RELEASE | 310000 |
| 3.1-RELEASE 以後の 3.1-STABLE | 310001 |
| 3/4 の分岐後の 4.0-CURRENT | 400000 |
Note: (2.2-STABLE は, 2.2.5-RELESE 以後, ``2.2.5-STABLE'' と呼ばれることがあります.) 見ての通り, これは年・月というフォーマットになっていましたが, バージョン 2.2 から, より直接的にメジャー/マイナー番号を使う ように変更になりました. 並行していくつかのブランチ(枝分かれし たバージョン)を開発する場合には, リリースされた日付でそれらの リリースを分類することが不可能だからです. (あなたが今 port を作成するときに, 古い -CURRENT 達について心配 する必要はありません. これは参考のために挙げられているにすぎま せん.)
これまで, 何百ものportが作られてきましたが, __FreeBSD__ が正しく使われたのは, 1つか2つの場合だけでしょう. 以前のportが誤った場所でそのマクロを使っているからと いって, それをまねする理由はありません.
.include <bsd.port.mk> の行の後には なにも書かないようにしてください. 大抵の場合は Makefile の 中程のどこかで, bsd.port.pre.mk を include して, 最後に bsd.port.pre.mk を include することによって避けることができます.
Note: pre.mk/post.mk のペアか bsd.port.mk だけのどちらかだけを include してください. 2つを混ぜないでください.
前者は, いくつかの変数の定義だけ をして, Makefile でのテストに使用し, 後者は残りを定義します.
以下は bsd.port.pre.mk で定義される重要な変数です. (これは, すべてではありません. 完全なリストは bsd.port.mk を参照してください.)
| 変数名 | 解説 |
|---|---|
| ARCH | uname -m で返される アーキテクチャ. (例, i386). |
| OPSYS | uname -s で返される オペレーティングシステム (例, FreeBSD). |
| OSREL | オペレーティングシステムの リリースバージョン (例., 2.1.5, 2.2.7). |
| OSVERSION | 数字形式のオペレーティングシステム のバージョン, 上記の __FreeBSD_version と同じです. |
| PORTOBJFORMAT | システムのオブジェクト フォーマット (aout あるいは elf). |
| LOCALBASE | ``local'' ツリーのベース. (例, /usr/local/). |
| X11BASE | ``X11'' ツリーのベース. (例, /usr/X11R6/). |
| PREFIX | portsのインストール先 ( PREFIXについてを参照). |
Note: USE_IMAKE, USE_X_PREFIX あるいは MASTERDIR などの変数を定義する必要がある場合には, bsd.port.pre.mk を include する前に定義してください. 他のものは, bsd.port.pre.mk の前でも後でもかまいません.
以下は bsd.port.pre.mk の後に書けるものの例です:
# 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}${PREFIX}/share/doc/xv
${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${PREFIX}/share/doc/xv
.endif
これらのファイルを pkg/PLIST に入れるのを忘れないよ うにしてください. (packageが/etc/make.conf内の 変数を読む方法は今のところ存在しませんので, NOPORTDOCS については気にしないでください.)
インストール時に pkg/MESSAGE ファイルを利用して, メッセージを表示することができます. 詳細は pkg/MESSAGE を使う の節を参照してください.
Note: MESSAGE ファイルは pkg/PLIST に加える必要はありま せん.
/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を使うようにしてください.)
Note: この変数はMakefile中で明示的に指定された MASTER_SITES には影響しないことに注意して ください.
RCS が特別な意味を与えている文字列をパッチ内に入れないように してください. ファイルを私たちのソースツリーに入れる時にこれら の文字列はCVSによって書き換えられてしまい, あとでまたパッチ を使おうとした時にうまくいかないことがあります. RCS文字列は ドル記号 ($) で囲まれており, $Id や $RCS などで始まり ます.
diffの再帰 (-r) フラグを使って再帰的なパッ チを作るのは大変結構なのですが, でき上がったパッチは必ず目で チェックして余計なゴミが入っていないことを確認してくださ い. よくあるのはバックアップファイル同士の変更点, あるいは Imake や GNU configure を使うソフトウェアの Makefile の変更点が入っている場合などです. また, configure.in を編集して, autoconf を使って configure を作り直す ときには, configure の diff は含めずに (それらは, 数千行になることもしばしばです), USE_AUTOCONF=yes を定義して, configure.in の diff をとってください.
ファイルをまるごと消す場合にはパッチを使わずに post-extract ターゲットで消す方が簡単です. できあがった 差分に満足したら, それらをソースのファイルごとに別々の パッチファイルに分割してください.
なるべく 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 は デインストール(削除) の際には, 自分自身を消去したあとに, (ディレクトリの) 除去をするようにしてください. これは, 大抵の場合 @dirrm の行を ports が作成するすべてのディレクトリについて 加えることによって実現できます. 親ディレクトリは, 子ディレクトリを先に消さないと 消せないことに気をつけて下さい.
: lib/X11/oneko/pixmaps/cat.xpm lib/X11/oneko/sounds/cat.au : @dirrm lib/X11/oneko/pixmals @dirrm lib/X11/oneko/sounds @dirrm lib/X11/oneko
といった感じです.
しかし, ときとして, 他の port をディレクトリを共有しているために @dirrm がエラーを返すことがあります. rmdir を @unexec から呼びだすことによって, 警告(warning)なしで 空のディレクトリのみを削除することができます:
@unexec rmdir %D/share/doc/gimp 2>/dev/null || true
これを使えば, たとえ, 他の port がファイルを インストールしていて, PREFIX/share/doc/gimp が空でない場合でも エラーメッセージは表示されませんし, pkg_delete が異常終了することもありません.
もしあなたの 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 の予約に関する注意書きをつけてください.
Makefile は単純かつ適切であるべきです. もし, Makefile を数行短かくできたり, もっと読みやすくできるのであれば, そうしてください. 例えば, shell の if 構文を使う代りに, make の .if 構文を使う, EXTRACT* の再定義で代用できるのであれば, do-extract を再定義しない, CONFIGURE_ARGS += --prefix=${PREFIX} とするかわりに, GNU_CONFIGURE とする, などです.
CFLAGS 変数は尊重すべきです. その port がこれを無視するのであれば, NO_PACKAGE=ignores cflags を Makefile に加えてください.
もしあなたの port が設定ファイルを PREFIX/etc に置く必要がある場合には, それを単純にインストールしたり, pkg/PLIST に加えてはいけません. こうしてしまうと, pkg_delete が ユーザが苦労して作ったファイルを消してしまったり, 新しく インストールすると上書きされてしまったりします.
代りに, 見本となるファイルを suffix ( filename.sample が良いでしょう) を付けて インストールして, message を表示して, ソフトウエアを動かす前に, ユーザがそのファイル をコピーして編集をしなければならないことを知らせましょう.
Portを作るためにソフトウェアに変更を加えたら, なるべく原作者にその旨を伝えてパッチ等を送ってください. これらが次のリリースに取り入れられれば, アップグレードが楽になります.
pkg/DESCR, pkg/COMMENT, pkg/PLIST などのファイルは, それぞれ2重にチェックしてください. 再検討してもっと良い記述があれば, それに置きかえてください.
GNU General Public License (GNU一般公有使用許諾)のコピーは (すでにあるので)コピーしないでください, おねがいします.
法律に関することには, 十分注意をはらってください. 私達に法律に反するような形でソフトフェアの配布をさせない でください!
私たちに質問を送る前に, 既存のportの例とbsd.port.mkを ちゃんと読んでください! ;)
それでもわからないことがあったら, 一人で悩まないでどんどん 質問してください! :)
これはportの Makefile を作る際のお手本です. かぎかっこ ([])内のコメントは忘れずに取ってください.
変数の順番, 段落の間の空行など, Makefile を作るときはなるべくこ の形式にしたがってください. この形式は重要な情報が簡単に見つけられるように 設計されています. portlint を使って 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 <asami@FreeBSD.ORG>
#
# $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 <bsd.port.mk>
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.0.2 | xmris-4.0.2 | 同上 |
| 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 のカテゴリーのリストです. アスタリスク(*) が付いているものは, バーチャル(virtual) カテゴリです -- これらには対応するサブディレクトリが port ツリーにはありません.
Note: バーチャルカテゴリでないものは, そのサブディレクトリ内の pkg/COMMENT に1行の記述があります (例, archivers/pkg/COMMENT).
| Category | Description |
|---|---|
| afterstep* | Ports to support AfterStep window manager |
| archivers | Archiving tools. |
| astro | Astronomical ports. |
| audio | Sound support. |
| benchmarks | Benchmarking utilities. |
| biology | Biology-related software. |
| cad | Computer aided design tools. |
| chinese | Chinese language support. |
| comms | Communication software. Mostly software to talk to your serial port. |
| converters | Character code converters. |
| databases | Databases. |
| deskutils | Things that used to be on the desktop before computers were invented. |
| devel | 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. |
| editors | General editors. Specialized editors go in the section for those tools (e.g., a mathematical-formula editor will go in math). |
| elisp | Emacs-lisp ports. |
| emulators | Emulators for other operating systems. Terminal emulators do not belong here---X-based ones should go to x11 and text-based ones to either comms or misc, depending on the exact functionality. |
| games | Games. |
| german | German language support. |
| graphics | Graphics utilities. |
| japanese | Japanese language support. |
| kde* | Ports that form the K Desktop Environment (kde). |
| korean | Korean language support. |
| lang | Programming languages. |
| Mail software. | |
| math | Numerical computation software and other utilities for mathematics. |
| mbone | MBone applications. |
| misc | Miscellaneous utilities---basically things that doesn't belong to anywhere else. This is the only category that should not appear with any other non-virtual category. If you have misc with something else in your CATEGORIES line, that means you can safely delete misc and just put the port in that other subdirectory! |
| net | Miscellaneous networking software. |
| news | USENET news software. |
| offix* | Ports from the OffiX suite. |
| palm | Software support for the 3Com Palm(tm) series. |
| perl5* | Ports that require perl version 5 to run. |
| plan9* | Various programs from Plan9. |
| Printing software. Desktop publishing tools (previewers, etc.) belong here too. | |
| python* | Software written in python. |
| russian | Russian language support. |
| security | Security utilities. |
| shells | Command line shells. |
| sysutils | System utilities. |
| tcl75* | Ports that use tcl version 7.5 to run. |
| tcl76* | Ports that use tcl version 7.6 to run. |
| tcl80* | Ports that use tcl version 8.0 to run. |
| tcl81* | Ports that use tcl version 8.1 to run. |
| textproc | Text processing utilities. It does not include desktop publishing tools, which go to print/. |
| tk41* | Ports that use tk version 4.1 to run. |
| tk42* | Ports that use tk version 4.2 to run. |
| tk80* | Ports that use tk version 8.0 to run. |
| tk81* | Ports that use tk version 8.1 to run. |
| vietnamese | Vietnamese language support. |
| windowmaker* | Ports to support the WindowMaker window manager |
| www | Software related to the World Wide Web. HTML language support belong here too. |
| x11 | The X window system and friends. This category is only for software that directly support the window system. Do not put regular X applications here. If your port is an X application, define USE_XLIB (implied by USE_IMAKE) and put it in appropriate categories. Also, many of them go into other x11-* categories (see below). |
| x11-clocks | X11 clocks. |
| x11-fm | X11 file managers. |
| x11-fonts | X11 fonts and font utilities. |
| x11-toolkits | X11 toolkits. |
| x11-wm | X11 window managers. |
多くのカテゴリに重なるので, どれを '第一' カテゴリにするかを決めなければならないことが たびたびあるでしょう. これを うまく決めるルールがいくつかあります. 以下はその優先順のリストで, 優先度の高いものから 低いものの順に書いてあります.
言語特有のカテゴリがまず最初です. 例えば日本語の X11 のフォントをインストールする port の場合, CATEGORIES 行は japanese x11-fonts となるでしょう.
より特徴的なカテゴリが, 一般的なカテゴリより 優先されます. 例えば, HTML エディタの場合は www editors となり, 逆順にはしないでください. また, port が mail, mbone, news, security, www のいづれかに属するとには, net は必要ありません.
x11 を第2カテゴリにするのは, 第1カテゴリが自然言語の場合のみにしてください. 特に X のアプリケーションには x11 を指定しないでください.
もし, あなたの port が他のどのカテゴリにも 属しないばあいには, misc にしてください.
もし, あなたがカテゴリについて自信が持てない場合には, そのことを send-pr するときに 書き加えてください. そうすれば import するまえに それについて議論できます. (もしあなたが commiter であれば, そのことを FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG> に送って, 先に議論 するようにしてください --- 新しい port が間違ったカテゴリに import されて, すぐ移動されることが多いので.)
もしあなたが, たくさんの ports の保守を しているのであれば, FreeBSD ports mailing list <freebsd-ports@FreeBSD.ORG> メーリングリストの内容を フォロウすることを考えてください. Ports のしくみについての重要な変更点はここに アナウンスされます. 最新の変更点については, いつでも, the bsd.port.mk CVS log で詳細な情報を得ることができます.
いやはや, 長い文章ですみません. ここまで読んでくださった方に は感謝, 感謝でございます. (_ _)
さあ, portの作り方がわかったところで, 世界中のソフトウェア をport化しましょう. FreeBSDプロジェクトに貢献するには, それ がもっとも簡単な方法です! :)
FreeBSD プロジェクトの目的を進めるための寄付や, 私たちと同じような ボランティアの細く長い ! 努力を, 私たちは常に喜んで受け入れています. また一般的に私たちは自分達で 周辺機器を買う資金が不足しているため, 周辺機器のサポートを充実させるのに ハードウェアの寄付はとても重要です.
FreeBSD プロジェクトは501(C3) (非営利) 企業ではないため, いかなる寄 付に対しても特別な税金の優遇措置を提供することができません. このような 寄付はプロジェクトを代表して FreeBSD, Inc により感謝をもって受け入れら れるでしょう.
FreeBSD, Inc.は FreeBSD プロジェクトの推進とプロジェクトに企業とし ての最小限の体裁を持たせることを目的として, 1995年の初めに Jordan K. Hubbard <jkh@FreeBSD.ORG> と David Greenman <dg@FreeBSD.ORG> により設立されました. 寄付されたすべての資金は (最終的に FreeBSD, Inc.によりもたらされるであろうすべての利益も同様に) プロジェク トの目標を推進するためだけに使われるでしょう.
支払い先を FreeBSD, Inc. とした小切手を, 次の住所気付けで送ってください:
��FreeBSD, Inc.
��c/o Jordan Hubbard
��4041 Pike Lane, Suite F
��Concord
��CA,�94520
[現在 私書箱が開設されるまで一時的に Walnut Creek CDROM の住所を使用]
電信振替は次の所まで直接送れるでしょう:
��Bank Of America
��Concord Main Office
��P.O. Box 37176
��San Francisco
��CA,�94137-5176
��Routing #:
121-000-358
��Account #: 01411-07441
(FreeBSD, Inc.)
寄付に関することは全て電子メールもしくは上記 FreeBSD, Inc. の住所宛の郵政省メールにて Jordan Hubbard <jkh@FreeBSD.org> までお送りくださるようお願いします.
もし 寄贈者ギャラリー の節で匿名を希望される 方は, 寄付の際にその旨お伝えください. Thanks!
FreeBSD プロジェクトは, 次の3つのカテゴリのどんなハードウェアの寄贈 も, 喜んで受け付けます:
ディスクドライブ, メモリまたは完全なシステムといった一般用途のハー ドウェアは, 資金の寄付の節にある FreeBSD, Inc. の住所まで送っ てください.
進行中の受け入れテストのための ハードウェアが必要とされていま す. 新たなリリース毎に適切な逆行テストができるように, 私たちは現在, FreeBSD がサポートするすべてのコンポーネントの テストラボを設置しよう としています. 私たちにはまだ, たくさんの重要な部品 (ネットワークカード, マザーボードなど) が不足していますので, このような寄贈をしたいと思って いるならば, David Greenman <dg@FreeBSD.ORG> へコンタクトしてどの部品がまだ必要とされているか の情報を得てください.
現在 FreeBSD にサポートされていないハードウェアで, サポートに追 加して欲しいもの. 私たちが新しいハードウェアを受けとる前にそのタスクを 引き受けてくれる開発者を探す必要があるため, その部品を送る前に FreeBSD core team <freebsd-core@FreeBSD.ORG> にコンタクトを取ってください.
私たちは常に FTP, WWW や cvsup の新しいミラーサイトを募集しています. ミラーサイトになりたい場合には the FreeBSD project administrators <admin@FreeBSD.ORG> にコンタクトを取って, 詳し い情報を手に入れてください.