日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
STYLE.MAKEFILE(5) FreeBSD ファイルフォーマットマニュアル STYLE.MAKEFILE(5)
名称
style.Makefile -- FreeBSD Makefile ファイルのスタイルガイド
解説
このファイルは、FreeBSD ソースツリーの makefile のための望ましいスタイル
を明記しています。
• すべての makefile は、ファイルの最初に部分に SCM ID があるべきで、空
行が続きます。
# $FreeBSD$
• 必要であるなら、.PATH: が次に置かれ、コロンの後に単一の ASCII の空白
があり ``.PATH: '' と綴ります。VPATH 変数を使用しないでください。
• 特殊変数 (すなわち、LIB, SRCS, MLINKS など) は、``product'' (製品) の
順序でリストされ、次にバイナリを構築してインストールします。また、特
殊変数は ``build'' (構築) 順にリストされます: すなわち、主となるプロ
グラム (あるいはライブラリ) が最初になります。一般的な ``product''
(製品) の順序は、次の通りです: PROG/[SH]LIB/SCRIPTS FILES LINKS
[NO_]MAN MLINKS INCS SRCS WARNS CFLAGS DPADD LDADD。一般的な
``build'' (構築) の順序は、次の通りです: PROG/[SH]LIB/SCRIPTS SRCS
WARNS CFLAGS DPADD LDADD INCS FILES LINKS [NO_]MAN MLINKS。
• <bsd.prog.mk> を使用し、PROG と同じと名前が付けられた単一のソースファ
イルがあるとき、SRCS を省略します。
• <bsd.prog.mk> を使用し、マニュアルページが、PROG と同じ名前が付けら
れ、セクション 1 にあるとき、MAN を省略します。
• すべての変数への代入は、``VAR='' と綴られます、すなわち、変数名と =
の間に空白はありません。可能であるなら、アルファベット順にソートされ
た値の状態にしてください。
• 変数は、() でなく、{} で拡張されます。${VARIABLE} のような。
• 1 度だけ設定される変数を設定するために (または、最初に変数を設定する
ために) += を使用しないでください。
• 簡単な makefile の垂直の空白類を使用しないでください、しかし、より複
雑で長いものを局所的に関連するものをグループ化するために、それを使用
します。
• 基本的に、CFLAGS 修飾子であるので、WARNS は、CFLAGS の前に置かれま
す。CFLAGS の後ではなく、CFLAGS の前に置かれるので、WARNS は、重要な
ものであるたくさんの CFLAGS 文で迷いません。コマンド行、または
make.conf(5) で上書きすることができるように、WARNS の使用法は、
``WARNS?= '' と綴られます。
• ``NO_WERROR= yes'' は、使用されるべきではなく、WARNS の目的を無効にし
ます。それは、コマンド行と特別な状況でのみ使用されるべきです。
• CFLAGS は、``CFLAGS+= '' と綴られます。
• CFLAGS の -I の前の -D をリストすることは、アルファベット順に好まれ、
-D を、より見やすくします。-D は、しばしば条件付きコンパイルに影響
し、-I は、かなり長くなる傾向があります。-D と -I の間の長い CFLAGS
の設定を分割します。
• CFLAGS の -g と -Wall のような) GCCism (GCC 的なもの) を使用しませ
ん。
• 通常、カラム 9 で値を始めるために、VAR= と値の間に 1 つの ASCII タブ
があります。ASCII 空白は、カラム 9 を越えて拡張する変数名を許可しま
す。また、空白類の不足は、非常に長い変数名も許可します。
• .include <bsd.*.mk> は、最後に置きます。
• $< と $@ のような時代遅れを使用しません。代わりに、${.IMPSRC} または
${.ALLSRC} と ${.TARGET} を使用します。
• 基本のシステムの ``foo'' 部分を構築しないようにするためには、NOFOO で
はなく NO_FOO を使用します。
• 基本のシステムのなにかをオプションで構築するためには、WANT_FOO または
USE_FOO でなく、ノブ WITH_FOO を綴ります。後者は、FreeBSD Ports (ポー
ト) コレクションのために予約されています。
• defined() でチェックされるだけの変数のために、あらゆる偽造の値を提供
しません。
論理的なグループを表現する要望は、しばしば、上記のうちのいくらかに従わな
いことを意味しています。
使用例
最も簡単なプログラムの Makefile は、次の通りです:
# $FreeBSD$
PROG= foo
.include <bsd.prog.mk>
最もシンプルな、ライブラリの Makefile です:
# $FreeBSD$
LIB= foo
SHLIB_MAJOR= 1
MAN= libfoo.3
SRCS= foo.c
.include <bsd.lib.mk>
関連項目
make(1), make.conf(5), style(9)
歴史
このマニュアルページは、FreeBSD の style(9) マニュアルページと同じソース
から着想されています。
バグ
ここで例外を許さないスタイル規則は、ほとんどありません。多くのもののスタ
イルは、全体の makefile またはそれを取り囲んでいる行の内容に依存しすぎま
す。
FreeBSD 12.2 October 21, 2015 FreeBSD 12.2