3.1 编写 Makefile

　　最简单的 Makefile 应该是这个样子的：

# New ports collection makefile for:   oneko
# Date created:        5 December 1994
# Whom:                asami
#
# $FreeBSD$
#

PORTNAME=      oneko
PORTVERSION=   1.1b
CATEGORIES=    games
MASTER_SITES=  ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/

MAINTAINER=    [email protected]
COMMENT=       A cat chasing a mouse all over the screen

MAN1=          oneko.1
MANCOMPRESSED= yes
USE_IMAKE=     yes

.include <bsd.port.mk>

　　看看您是否能够看懂。 不必担心 $FreeBSD$ 那一行， 当这个 port 被导入到 ports 树里的时候， CVS 会自动填写它。 您可以在 示范的 Makefile那章找到更多的细节。

3.2 创建描述文件

　　有 2 个描述文件对于任何一个 port 来说是必须的， 不论它是不是打算成为 package。 它们是 pkg-descr 和 pkg-plist。 这两个文件使用 pkg- 前缀以区别于其它文件。

This is a port of oneko, in which a cat chases a poor mouse all over
the screen.
 :
(etc.)

WWW: http://www.oneko.org/

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

PLIST_FILES=    bin/oneko \
                lib/X11/app-defaults/Oneko \
                lib/X11/oneko/cat1.xpm \
                lib/X11/oneko/cat2.xpm \
                lib/X11/oneko/mouse.xpm
PLIST_DIRS=     lib/X11/oneko

3.3 创建校验和文件

　　只要键入 make makesum， port 便会自动创建 distinfo文件。

　　如果下载的文件的校验和经常变化， 而您又能确保它们的来源可靠 (比如， 来自于CD制造商， 或每天构建生成的文档文件)， 就应该在 IGNOREFILES 里面标明这些文件。 这样， 再运行 make makesum 的时候便不会把这些标记 IGNORE 的文件计算在内了。

3.4 测试 port

　　应当确定您的 port 确实做了您希望它们做的事情， 包括打包。下面是需要重点检查的一些重要的工作。

• pkg-plist 中没有包括任何不想安装的文件

• pkg-plist 包含了所有应该安装的文件

• 您的 port 能够使用 reinstall 多次安装。

• 您的 port 能在卸载 (deinstall) 时， 自动完成 清理

　　确信在 package 和 deinstall 阶段没有任何警告。 第三步以后， 检查是否所有新建的目录都被正确删除了。 在第四步以后， 试着运行一下所装的软件， 确保当它以 package 方式安装的时候也能正常工作。

3.5 用 portlint 来检查 port

　　请使用 portlint 命令来检查您的 port 是否符合我们的规范。 devel/portlint 程序是 ports collection 的一部分。 这个程序的主要功能是帮助您检查 Makefile 的样式是否符合规范， 以及 package 的命名是否得体。

3.6 提交 port

　　首先， 确信您已经阅读了 该做什么和不该做什么 一节。

　　既然已经对所制作的 port 相当满意了， 剩下的工作， 便是将它放进 FreeBSD 的主 ports 树， 以便让更多的人从中受益。 我们并不需要您的 work 目录以及 pkgname.tgz 包， 因此现在可以删除它们了。 接下来， 只要把 shar `find port_dir` 的输出写到一份 bug 报告中， 并用 send-pr(1) 程序 (参见 Bug Reports and General Commentary 以了解关于 send-pr(1) 的进一步详情) 将其送出。 请务必将您的 bug 报告分类 (category) 为 ports 并把子分类 (class) 设置为 change-request (不要把报告表及为机密的， 即 confidential！)。 此外， 在 PR 的描述 (“Description”) 一栏中， 应该填写您所移植的应用程序的简单介绍， 而 shar 则应放到修正 (“Fix”) 栏中。

　　再次声明， 不要包含原始的distfile， work目录， 或者您用 make package 制作的包。

　　在您提交的您的 port 以后请耐心等待。 有时在一个 port 正式加入 FreeBSD 之前需要花费好几个月， 尽管也有可能是几天。 您可以查看 正等待被 commit 到 FreeBSD 的 port。

　　一旦我们看过了您的报告， 有必要的话我们会联系您， 并把它放到 ports 树里。 您的名字也会出现在 Additional FreeBSD Contributors 和其它的文件。 不是很棒吗!? :-)

4.1 整个系统是如何运转的?

　　首先， 这一系列的动作是由用户在您的 port 目录里敲入 make 后发生的。 您也许会发现在另外的一个窗口里阅读一下 bsd.port.mk 将会有助于您的理解。

　　要是您不是非常明白 bsd.port.mk 是做什么的话， 也不用太担心， 很多人都不知道的... :->

　　以上都是系统默认的步骤。 您也可以定义 pre-something 或者 post-something， 或者把以此命名的脚本放到 scripts 目录， 它们会在默认的动作之前或之后被执行。

　　举个例子， 如果您在您的 Makefile 里定义了post-extract， 并在 script 目录里放了一个 pre-build 脚本， 那么在 tar 包解开之后 post-extract 将被调用， pre-build 脚本会在默认的编译之前被执行。 我们推荐您在 Makefile 定义所有的动作， 如果不是十分复杂的话， 这样， 别人能更容易明白您的 port 需要执行哪些非默认的动作。

　　默认的行为都是由 bsd.port.mk 定义的 do-something 来表示的。 例如， port 中用来解压缩的命令是由 do-extract 来定义的。 如果您对默认的设置不满意， 可以通过在 Makefile 重新定义 do-someting 来做些改变。

　　我们已经介绍了在用户敲入 make 之后会发生哪些事情了。 接下来我们将进行进一步的学习， 来看一看如何创建一个理想的 port。

4.2 获取源代码

　　获取源代码的 tar 包 (通常是 foo.tar.gz 或者 foo.tar.Z) 并把它们放进 DISTDIR。 最好使用 主流 的版本。

　　您需要设置变量 MASTER_SITES 来指向原始 tar 包的获取位置。 您可以在 bsd.sites.mk 里找到一些速度较快的主流站点。 请使用这些站点 ── 和相关的定义 ── 如果可能的话， 应尽量避免在同一个源代码树里出现大量重复的信息。 这些站点会随着时间而变化， 如果每个人都随意加入的话会使维护变得非常困难。

　　如果您找不到一个有很好网络连接的 FTP/HTTP 站点， 或者它们使用了非标准的格式， 您也许就会想在您自己的 FTP 或 HTTP 服务器上放上一份副本。

　　如果您找不到可靠的地方放置 distfiles， 我们也可以提供给您一些空间来保存它。 我们自己的 ftp.FreeBSD.org； 然而这只是一个折衷的办法。 distfile 必须放进某人在 freefall 上的 ~/public_distfiles/ 目录中。 可以要求帮助您 commit port 的人来放这个 distfile， 而这个人也需要把 MASTER_SITES、 MASTER_SITE_LOCAL 以及 MASTER_SITE_SUBDIR 的设置， 改为在 freefall 上的用户名。

　　如果您的 port 的 distfile 一直在变化， 而作者拒绝改变其版本号， 您可以考虑把 distfiles 放在自己的主页， 并在 MASTER_SITES 里把原作者的列为首选位置。 如果可能， 试着与 port 的作者沟通一下让他不要这么做， 这将有助于建立对源代码的控制。 在您的主页上放置您自己的 distfile 会避免用户得到 “checksum mismatch” 的错误， 而且能减轻我们 FTP 站点维护人员的工作量。 如果您的port只有一个主站点的话， 我们建议您在自己的网站上做一份备份， 并他列为 MASTER_SITES的第2项。

　　如果您的 port 需要来自网络上的一些补丁， 请把它们放到 DISTDIR里。 不用担心它们跟源代码不是来自同一站点。 我们有办法处理 (参阅下面的 补丁文件)。

4.3 修改 port

　　解开 tar 包， 对源代码做出合理的修改使得这个 port 能在最新版本的 FreeBSD 上面运行。 一定要 仔细记录 您所做的每处改动， 包括删除、添加、修改的文件等等， 这些修改以后会在您的 port 中以脚本或补丁的方式出现， 并且能通过运行它们来自动完成您对 port 的改动要求。

　　如果您的 port 要求用与用户交互/配置来完成编译或安装的话， 您可以看一下 Larry Wall 的经典的 Configure 脚本， 适当地模仿一下。 Port collection 的目的， 就是使每个 port 占用最少的空间， 并做到软件的 “即插即用”。

4.4 打补丁

　　在您准备制作 port 的过程中， 增加或修改的文件， 都可以通过 diff(1) 来做成补丁。 希望应用到源代码上的每个补丁， 都应保存为单独的文件， 并命名为 patch-*， 其中 * 表示将要修改的文件的完整路径名， 例如 patch-Imakefile 或 patch-src-config.h。 这些文件， 都应保存在 PATCHDIR (通常是 files/)， 这里的补丁都会自动应用到源代码上。 所有的补丁必须是相对于 WRKSRC 的 (一般而言， 您的 port 会将其 tarball 解压缩在那里， 并完成余下的工作)。 为了让修正和升级更容易， 您应避免使用多个 patch 去修改同一个文件 (例如， patch-file 以及 patch-file2 都修改 WRKSRC/foobar.c) 这种情况。

　　只有 [-+._a-zA-Z0-9] 这些字符， 可以出现在补丁的文件名中， 请务必不要使用除这些字符以外的其它字符。 不要把您的补丁命名成 patch-aa 或 patch-ab 等这样的名字， 最好能在补丁名中提到路径和文件名。

　　不要把 RCS 字符串放进补丁。 我们把文件放进 ports 树的时候， CVS 会损坏它们， 当我们再 check out 出来的时候， 它们就会和原来的不一样， 从而导致打补丁失败。 RCS 字符串 是由美元符号 ($) 围绕的， 通常由 $Id 或 $RCS 开头。

　　使用 diff(1) 的递归选项(-r) 很好， 但是请检查一下最后输出的 patch， 确保没有任何的垃圾信息。 特别地， 有 2 种文件不需要 diff， 并且应该删除： 一种是 Makefile， 当您的port使用了Imake， 或者 GNU configure 等等的话。 如果您不得不编辑configure.in 以使 autoconf 去生成 configure， 不要使用 configure 来做 diff (这常常会有好几千行长!)； 请定义 USE_AUTOTOOLS=autoconf:253 并对应 configure.in 来制作 diff。

　　假如需要删除文件， 则应在 post-extract target， 而不是作为补丁的一部分来完成。

　　除此之外， port 的 Makefile 还可以通过 in-place 模式的 sed(1) 来直接进行简单的替换操作。 如果补丁需要使用变量值， 这就非常有用了。 例如：

post-patch:
    @${REINPLACE_CMD} -e 's|for Linux|for FreeBSD|g' ${WRKSRC}/README
    @${REINPLACE_CMD} -e 's|-pthread|${PTHREAD_LIBS}|' ${WRKSRC}/configure

　　往往在移植某些软件的时候会遇到这样一种情况， 特别是这个软件是在 Windows® 上开发的时候， 大多数的源代码都需要进行CR/LF的转换。 这很可能会给以后打补丁带来问题， 还可能触发编译警告， 并给脚本的执行带来麻烦 (/bin/sh^M not found)， 等等。 要迅速将所有文件中的 CR/LF 改为只用 LF， 可以在 port 的 Makefile 中加入 USE_DOS2UNIX=yes。 除此之外， 还可以指定一个需要执行这种转换操作的文件列表：

USE_DOS2UNIX=  util.c util.h

4.5 配置

　　把任何附加的配置命令加进您的 configure 脚本并把它保存到 scripts 子目录。 如前面提到的那样， 您也能在 Makefile 和/或 使用 pre-configure 或 post-configure 的脚本来做同样的事情。

4.6 处理用户输入

　　如果您的 port 要求用户的输入以便配置编译、 或安装配置过程， 就必须在 Makefile 里设置 IS_INTERACTIVE 变量。 如果用户设置了 BATCH 的话， 这将让用户能跳过您的 port 来完成 “通宵编译” (如果用户设置了 INTERACTIVE的话， 那么 只有 那些要求互动的 port 才会被编译) 这将给那些不停编译 ports 的机器省下很多时间。

　　通常我们还建议， 如果对于那些问题能有合理的缺省答案的话， 应检查一下 PACKAGE_BUILDING 变量， 并根据其设置决定是否执行关闭交互脚本。 这将允许我们为 CDROM 和 FTP 来编译 package。

5.1 作者发布的代码

　　放在 DISTDIR 中的是不是标准的用 gzip 压缩的 tar 包， 例如 foozolix-1.2.tar.gz？ 如果是， 可以先略过这一节。 如果不是， 您应当看看是不是要覆盖这些变量： DISTVERSION、 DISTNAME、 EXTRACT_CMD、 EXTRACT_BEFORE_ARGS、 EXTRACT_AFTER_ARGS、 EXTRACT_SUFX， DISTFILES，取决于您 port 的 distfile 格式有多么怪异。 (最常见的一个例子便是 EXTRACT_SUFX=.tar.Z， 一般这是因为 tar 包是用 compress 而不是 gzip 压缩的时候。)

　　最糟的情况是， 您需要自己编写 do-extract 来覆盖默认的定义， 尽管这不常见， 但如果遇到了， 还是需要这么做。

5.2 命名

　　Makefile 的第一部分便是 port 的名字、 版本号， 以及它所属的分类。

PORTNAME=       gtkmumble
PORTVERSION=    0.10

PORTNAME=       gtkmumble
PORTVERSION=    0.10
PORTREVISION=   1

PORTNAME=       gtkmumble
PORTVERSION=    0.2
PORTEPOCH=      1

PORTNAME=       gtkmumble
PORTVERSION=    0.3
PORTEPOCH=      1

5.3 分类

5.4 源码包文件

　　在 Makefile 中的第二部分是描述用于构建 port 所必需下载的文件， 以及到什么地方去下载它们。

MASTER_SITES=         ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR=   applications

DISTNAME=      foo
EXTRACT_SUFX=  .tgz

DISTFILES=     source1.tar.gz source2.tar.gz

DISTFILES=     source.tar.gz manual.html
EXTRACT_ONLY=  source.tar.gz

EXTRACT_ONLY=

DISTFILES=      alpha:0 beta:1

MASTER_SITES=   ftp://ftp.example1.com/:source1 \
        ftp://ftp.example2.com/:source2
DISTFILES=      source1.tar.gz:source1 \
        source2.tar.gz:source2

MASTER_SITES=   ftp://ftp.example1.com/:source1 \
        ftp://ftp.example2.com/:source2
DISTFILES=      source1.tar.gz:source1 \
        source2.tar.gz:source2 \
        source3.tar.gz:source2

.if defined(PACKAGE_BUILDING)
DISTFILES+=             foo.tar.gz
ALWAYS_KEEP_DISTFILES=  yes
.endif

5.5 MAINTAINER (监护人)

　　请在此处写上您的电子邮件地址。 :-)

　　需要注意一点， MAINTAINER 变量的值只能是一个不包括注释部分的电子邮件地址， 其格式应为 [email protected]。 请不要在此处写任何说明性的文字， 例如您的真实姓名 ── 这会给 bsd.port.mk 带来麻烦。

　　监护人有责任保持 port 随时更新， 并确保其能够正确地运行。 详细的 port 监护人职责说明， 请参见 port 监护人面临的挑战 一节。

　　对于 port 的修改， 应被发给 port 的监护人进行复审， 且在 commit 之前需要获得其监护人的同意。 假如某一 port 的监护人没有在两周之内 (不包括主要的公共假日) 响应来自用户的更新请求， 则可视为监护人超时， 在这种情况下可以在没有监护人明确同意的情形下进行更新。 如果监护人在多达三个月的时间内没有进行任何响应， 则可以认为该监护人不辞而别， 允许对出现此类问题的 port 进行监护人变更。 尽管如此， 监护人为 Ports 管理团队 <[email protected]> 或者 Security Officer 团队 <[email protected]> 的 port 不受此限。 对监护人为这些小组的 port 进行未经许可的 commit 是不允许的。

　　我们保留对监护人所提交修正案进行改动的权力， 以便使其更符合现行的 Ports Collection 规范， 而无需提交补丁的人明确批准。 此外， 大规模的基础性修改， 也可能使 port 在没有得到监护人同意的情形下进行修改。 但这类修改都不会影响 port 本身的功能。

　　Ports 管理团队 <[email protected]> 保留以任何原因收回或绕过任何人监护权的权力， 而 Security Officer 团队 <[email protected]> 则保留以安全原因收回或绕过监护权的权力。

5.6 COMMENT (一句话说明)

　　这一变量用于指定 port 的一句话说明。 请 勿将 package 的名字 (或软件的版本) 放在说明中。 这一说明的第一个字母应大写， 结尾不用句点。 下面是一个例子：

COMMENT=       A cat chasing a mouse all over the screen

　　Makefile 中的 COMMENT 变量应该紧接着 MAINTAINER 变量出现。

　　请务必将 COMMENT 这行限制在 70 个字符之内， 因为它的主要目的是向用户展示 port 的一句话简介。

5.7 依赖关系

　　许多 port 会依赖其它 port。 有七个变量用于帮助您确保所需的文件都存在于用户的机器上。 此外， 也提供了用于支持常见情形的依赖关系变量， 以及对依赖关系行为的更多控制。

LIB_DEPENDS=   jpeg.9:${PORTSDIR}/graphics/jpeg

RUN_DEPENDS=   ${LOCALBASE}/etc/innd:${PORTSDIR}/news/inn \
           wish8.0:${PORTSDIR}/x11-toolkits/tk80

 BUILD_DEPENDS=
          unzip:${PORTSDIR}/archivers/unzip

 FETCH_DEPENDS=
          ncftp2:${PORTSDIR}/net/ncftp2

EXTRACT_DEPENDS=
          unzip:${PORTSDIR}/archivers/unzip

 PATCH_DEPENDS=
          ${NONEXISTENT}:${PORTSDIR}/java/jfc:extract
       

p5-Spiffy>=0.26:${PORTSDIR}/devel/p5-Spiffy

BUILD_DEPENDS=   ${NONEXISTENT}:${PORTSDIR}/graphics/jpeg:extract

5.8 MASTERDIR (主 port 所在的目录)

　　如果 port 需要依某些变量的设置 (举例来说， 分辨率或纸型) 来构建略有不同的预编译包， 则可以为每一个这样的包建立不同的目录， 这样可以让用户更容易地看到他们想要安装的版本， 但又能在这些 port 之间共用尽可能多的文件。 一般情况下， 如果运用得当， 除主目录之外都只需要很短的 Makefile。 这些 Makefile 中， 可以用 MASTERDIR 来指定其它文件所在的目录。 另外， 还应使用一个变量作为 PKGNAMESUFFIX 的一部分， 以便为不同的包给出不同的命名。

　　用例子来阐述这些会更为明晰。 以下是 japanese/xdvi300/Makefile 的部分代码：

PORTNAME=       xdvi
PORTVERSION=    17
PKGNAMEPREFIX=  ja-
PKGNAMESUFFIX=  ${RESOLUTION}
 :
# 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 也提供了全部常规的补丁， 以及打包用到的文件等等内容。 如果您在那里输入 make， 它将使用默认的分辨率值 (300) 并正常地构建 port。

　　对于其它分辨率而言， 以下是 完整的 xdvi118/Makefile：

RESOLUTION=     118
MASTERDIR=      ${.CURDIR}/../xdvi300

.include "${MASTERDIR}/Makefile"

　　(xdvi240/Makefile 和 xdvi400/Makefile 是相似的)。 MASTERDIR 定义会告诉 bsd.port.mk 常规的目录， 例如 FILESDIR 以及 SCRIPTDIR 应在 xdvi300 中查找。 RESOLUTION=118 这行将覆盖在 xdvi300/Makefile 中所作的 RESOLUTION=300 设置， 从而 port 将以分辨率为 118 的设置来构建。

5.9 联机手册

　　MAN[1-9LN] 这些变量， 会自动地将联机手册加到 pkg-plist (这也意味着 不能 在 pkg-plist 中列出联机手册 ── 参见 PLIST 的生成 来了解更多细节)。 此外， 这也会让安装阶段自动地根据在 /etc/make.conf 中所作的 NOMANCOMPRESS 设置来自动对联机手册文件执行压缩或解压缩操作。

　　如果 port 尝试通过使用符号连接或硬连接将联机手册安装为多个名字， 就必须使用 MLINKS 变量来予以明示。 由 port 创建的连接， 将由 bsd.port.mk 删除和重建， 以确认它们指向了正确的文件。 任何在 MLINKS 中列出的文件都不应在 pkg-plist 中再出现。

　　要指定是否在安装时对联机手册进行压缩， 可以使用 MANCOMPRESSED 变量。 这一变量可以取三种值， yes、 no 和 maybe 之一。 yes 表示联机手册已经以压缩的形式安装， no 表示还没有， 而 maybe 则表示所安装的软件会尊重 NOMANCOMPRESS 的设置值， 因此 bsd.port.mk 不需要特别做什么事情。

　　如果设置了 USE_IMAKE 而未定义 NO_INSTALL_MANPAGES， MANCOMPRESSED 会自动设为 yes， 反之则是 no。 除非默认值不合适， 否则就不需要在 port 中明确地加以改变。

　　如果 port 将联机手册放到了 PREFIX 之外的其它目录， 则应使用 MANPREFIX 来加以设置。 此外， 如果只有某些部分的联机手册会安装到不标准的位置， 例如某些 perl 模块的 port， 还可以使用 MANsectPREFIX (此处 sect 是 1-9、 L 或 N 之一) 来指定。

　　如果您的联机手册需要装入专用于某一语言专用的子目录， 需要将 MANLANG 设为那种语言的名字。 此变量的默认值是 "" (也就是只有英语)。

　　下面是一个综合的例子。

MAN1=          foo.1
MAN3=          bar.3
MAN4=          baz.4
MLINKS=        foo.1 alt-name.8
MANLANG=       "" ja
MAN3PREFIX=    ${PREFIX}/share/foobar
MANCOMPRESSED= yes

　　这表示 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

　　此外， ${PREFIX}/man/man8/alt-name.8.gz 可能会通过您的 port 安装， 也可能不会。 无论如何， 都会创建一个符号连接， 把 foo(1) 和 alt-name(8) 联机手册连起来。

5.10 Info 文件

　　如果软件包需要安装 GNU 文件， 则需要在 INFO 变量中列出 (不需要指定 .info 后缀)， 这样安装/卸载代码就会自动地在注册包时将它们加入到 pkg-plist 了。

5.11 Makefile 选项

　　某些大型应用程序可以在构建时使用一系列配置选项， 用以在系统中已经安装了某些库或应用程序时增加一些功能。 例如， 选择某种自然 (人类的) 语言， GUI 或命令行界面， 由于并不是所有的用户都希望使用这些库或者应用程序， port 系统提供了一组方便的机制， 来让 port 的作者控制构建时的配置。 支持这些特性可以让用户体验更好， 并达到事半功倍的效果。

OPTIONS=   OPTION  "说明性文字" 默认值 ...

OPTIONS=      FOO "启用 foo 选项" On \
              BAR "支持 bar 功能" Off

.include <bsd.port.pre.mk>

.if defined(WITHOUT_FOO)
CONFIGURE_ARGS+=    --without-foo
.else
CONFIGURE_ARGS+=    --with-foo
.endif

.if defined(WITH_BAR)
RUN_DEPENDS+=   bar:${PORTSDIR}/bar/bar
.endif

.include <bsd.port.post.mk>

5.12 指定工作临时目录

　　每个 port 都会被解压缩到一个工作临时目录中， 这个目录必须是可写的。 ports 系统默认情况下会将 DISTFILES 解压缩到一个叫做 ${DISTNAME} 的目录中。 换言之， 如果设了：

PORTNAME=      foo
PORTVERSION=   1.0

　　则 port 的源码包文件的顶级目录将是 foo-1.0。

　　如果这不是所希望的情形， 您可以修改一系列变量的设置。

WRKSRC=      ${WRKDIR}/foo

WRKSRC=      ${WRKDIR}/${PORTNAME}

NO_WRKSUBDIR= yes

5.13 CONFLICTS (设置与其它包的冲突)

　　如果您的软件包无法与某些其它软件包共存 (由于文件冲突， 运行环境不兼容， 等等)， 将这些包的名字列在 CONFLICTS 变量中。 此处可以使用 shell 通配符， 如 * 和 ?。 列举软件包的名称时， 应采用 /var/db/pkg 中的形式。 请确认 CONFLICTS 不会匹配它本身， 否则将导致 FORCE_PKG_REGISTER 无法正常工作。

6.1 共享库

　　如果您的port安装了一个或多个共享库,那么请定义一个 INSTALLS_SHLIB make 变量， 在post-install标记把它注册进共享库 缓冲时会调用bsd.port.mk去运行 ${LDCONFIG} -m来指向新库的安装目录。 (通常是 PREFIX/lib) 同样，您也可以适当的在您的 pke-plist文件 中定义一组@exec /sbin/ldconfig -m 和@unexec /sbin/ldconfig -R， 那么用户可以在安装后马上 就能使用，并且在卸载软件包后系统也不会认为这些共享库仍然存在。

　　如果您需要把共享库安装在缺省的位置之外， 可以定义 LDCONFIG_DIRS make 变量，它包含安装共享库的目录列表 例如： 如果您的共享库安装到 PREFIX/lib/foo 和 PREFIX/lib/bar directories目录，您可以在您的 Makefile中这样设置:

INSTALLS_SHLIB= yes
LDCONFIG_DIRS=  %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar

　　要时刻谨记， 非标准的目录不会在 (重) 启动时自动传递给 ldconfig(8) ！ 如果有 port 真的需要这样做， 则需要像 x11/kdelibs3 那样安装一个启动脚本。 请务必仔细检查， 通常这是完全不必要的， 或者可以通过 -rpath 或在连接时设置 LD_RUN_PATH 来避免 (参见 lang/moscow_ml 给出的例子)， 或者用一个 shell 封装程序来在执行可执行文件之前设置 LD_LIBRARY_PATH， 类似 www/mozilla 那样。

　　值得注意的是这里 LDCONFIG_DIRS 的内 容就像 pkg-plist 的其它部分一样要通过sed(1)过滤，所 以 PLIST_SUB 置换也会应用。我们推荐您使用 %%PREFIX%% 替换 PREFIX，%%LOCALBASE%% 替换LOCALBASE，%%X11BASE%% 替换X11BASE.

　　尽量将共享库版本号保持为 libfoo.so.0 这样的格式。 我们的运行环境连接器只会检查主 (第一个) 版本数字。

　　如果在更新 port 时升级了其库的主版本号， 则其它所有连接了受影响的库的 port 的 PORTREVISION 都应递增， 以强制它们采用新版本的库重新编译。

　　如果 port 要安装长版本号的共享库， 例如 libfoo.so.0.2.9， 则 ports 构建基础架构会自动尝试重命名这些文件。 如果需要禁用这一行为， 则应定义 NO_FILTER_SHLIBS。

6.2 Ports 的发行限制

　　众多协议，并且其中的一些致力于 限制怎样的应用程序能被打包， 是否能用于销售赢利等等。

　　处于这种情况，就可以设置以下描述 的变量。

6.3 构建机制

6.4 利用 GNU autotools

USE_AUTOTOOLS= 工具:版本[:操作] ...

USE_AUTOTOOLS= libtool:版本[:env]

USE_AUTOTOOLS= libltdl:版本

USE_AUTOTOOLS= autoconf:版本[:env]

USE_AUTOTOOLS= autoheader:版本

USE_AUTOTOOLS= automake:版本[:env]

USE_AUTOTOOLS= aclocal:版本

6.5 使用 perl

6.6 使用 X11

# 使用 X11 库并依赖字体服务和西里尔字体。
RUN_DEPENDS=   ${X11BASE}/bin/xfs:${X_FONTSERVER_PORT} \
               ${X11BASE}/lib/X11/fonts/cyrillic/crox1c.pcf.gz:${X_FONTS_CYRILLIC_PORT}

USE_XLIB=      yes

.if defined(PACKAGE_BUILDING)
BUILD_DEPENDS+= Xvfb:${X_VFBSERVER_PORT} \
                ${X11BASE}/lib/X11/fonts/misc/8x13O.pcf.gz:${X_FONTS_MISC_PORT}
.endif

DESKTOP_ENTRIES=  "NAME" "COMMENT" "ICON" "COMMAND" "CATEGORY" StartupNotify

DESKTOP_ENTRIES=  "ToME" "Roguelike game based on JRR Tolkien's work" \
                  "${DATADIR}/xtra/graf/tome-128.png" \
                  "tome -v -g" "Application;Game;RolePlaying" \
                  false

6.7 使用 GNOME

　　FreeBSD/GNOME 项目组使用一组自己的变量来定义 port 所使用的 GNOME 组件。 这些变量的详细列表 可以在 FreeBSD/GNOME 项目的主页找到。

6.8 使用 KDE

6.9 使用 Java

PLIST_FILES+= %%JAVAJARDIR%%/myport.jar

6.10 使用 Apache 和 PHP

PORTNAME=       Date
PORTVERSION=    1.4.3
CATEGORIES=     devel www pear

MAINTAINER=     [email protected]
COMMENT=        PEAR Date and Time Zone Classes

BUILD_DEPENDS=  ${PEARDIR}/PEAR.php:${PORTSDIR}/devel/pear-PEAR
RUN_DEPENDS=    ${BUILD_DEPENDS}

FILES=          Date.php Date/Calc.php Date/Human.php Date/Span.php     \
                Date/TimeZone.php
TESTS=          test_calc.php test_date_methods_span.php testunit.php   \
                testunit_date.php testunit_date_span.php wknotest.txt   \
                bug674.php bug727_1.php bug727_2.php bug727_3.php       \
                bug727_4.php bug967.php weeksinmonth_4_monday.txt       \
                weeksinmonth_4_sunday.txt weeksinmonth_rdm_monday.txt   \
                weeksinmonth_rdm_sunday.txt
DOCS=           TODO
_DOCSDIR=       .

.include <bsd.port.pre.mk>
.include "${PORTSDIR}/devel/pear-PEAR/Makefile.common"
.include <bsd.port.post.mk>

6.11 使用 Python

　　完整的可用变量列表， 可以在 /usr/ports/Mk/bsd.python.mk 中找到。

6.12 使用 Emacs

　　本节尚有待撰写。

6.13 使用 Ruby

　　下表展示了 ports 系统提供给 port 作者的一些变量。 您应使用这些变量， 以便把文件装到合适的位置。 请尽可能多地在 pkg-plist 中使用它们。 这些变量不应在 port 中重新定义。

　　可用变量的完整列表， 可以在 /usr/ports/Mk/bsd.ruby.mk 中找到。

6.14 使用 SDL

　　变量 USE_SDL 可以用于自动配置 port 的依赖关系， 以适应使用类似 devel/sdl12 和 x11-toolkits/sdl_gui 这些依赖 SDL 的库的情形。

　　目前系统能够识别下列 SDL 库：

• sdl: devel/sdl12

• gfx: graphics/sdl_gfx

• gui: x11-toolkits/sdl_gui

• image: graphics/sdl_image

• ldbad: devel/sdl_ldbad

• mixer: audio/sdl_mixer

• mm: devel/sdlmm

• net: net/sdl_net

• sound: audio/sdl_sound

• ttf: graphics/sdl_ttf

　　因此， 如果 port 需要依赖 net/sdl_net 和 audio/sdl_mixer， 则对应的写法将是：

USE_SDL=        net mixer

　　同时， net/sdl_net 和 audio/sdl_mixer 所依赖的 devel/sdl12 也会被自动地加入。

　　加入您使用 USE_SDL， 它将自动地：

• 将对于 sdl12-config 的依赖关系加入到 BUILD_DEPENDS

• 将变量 SDL_CONFIG 加入到 CONFIGURE_ENV

• 将对所选的库的依赖， 加入到 LIB_DEPENDS

　　要检查某个特定的 SDL 库是否可用， 可以通过 WANT_SDL 变量来达到目的：

WANT_SDL=yes

.include <bsd.port.pre.mk>

.if ${HAVE_SDL:Mmixer}!=""
USE_SDL+=   mixer
.endif

.include <bsd.port.post.mk>

6.15 启动和停止服务 (rc 脚本)

　　rc.d 脚本在系统启动时用于启动服务， 并为管理员提供停止、 启动和重新启动某个服务的标准方法。 Ports 安装的脚本会集成到系统的 rc.d 框架中。 关于如何使用它的说明， 可以在 使用手册的 rc.d 章节 找到。 关于可用命令的详细解释， 则可以在 rc(8) 和 rc.subr(8) 找到。

　　可以安装一或多个 rc 脚本：

USE_RC_SUBR=   doormand.sh

　　这些脚本必须放到 files 目录， 并附加 .in。 与基本系统中的 rc.d 脚本不同， 这种脚本中 . /etc/rc.subr 行必须替换为 . %%RC_SUBR%%， 因为较早版本的 FreeBSD 中并不提供 /etc/rc.subr 文件。 此外， 这里还可以使用标准的 SUB_LIST 替换展开。 除此之外， 我们还强烈推荐使用 %%PREFIX%%、 %%LOCALBASE%%， 以及 %%X11BASE%% 这几个替换展开。 关于 SUB_LIST 的介绍可以在 本书的相关章节 找到。

　　在 FreeBSD 6.1-RELEASE 之前， 与 rcorder(8) 的集成是通过 USE_RCORDER 而不是 USE_RC_SUBR 来完成的。 但是， 这种方法已经被淘汰。

　　从 FreeBSD 6.1-RELEASE 开始， 本地安装的 rc.d 脚本 (包括由 port 安装的脚本) 会纳入基本系统的 rcorder(8)。

　　以下是一个简单的 rc.d 脚本：

#!/bin/sh

# PROVIDE: doormand
# REQUIRE: LOGIN
#
# 在 /etc/rc.conf.local 或 /etc/rc.conf 中增加下述设置可以启用这一服务：
#
# doormand_enable (bool):   默认设为 NO。
#               设为 YES 可以启用 doormand。
# doormand_config (path):   默认设为 %%PREFIX%%/etc/doormand/doormand.cf。
#

. %%RC_SUBR%%

name="doormand"
rcvar=${name}_enable

command=%%PREFIX%%/sbin/${name}
pidfile=/var/run/${name}.pid

load_rc_config $name

: ${doormand_enable="NO"}
: ${doormand_config="%%PREFIX%%/etc/doormand/doormand.cf"}

command_args="-p $pidfile -f $doormand_config"

run_rc_command "$1"

　　这里， 对变量的默认赋值方法应采用 "="， 而非 ":=" 这样的形式。 这是因为， 前一种赋值方法只有在变量未被设置时才设置默认值， 而后一种方法则会在变量没有设置， 或者 其值为空时都设置默认值。 用户非常可能在其 rc.conf.local 中使用类似

doormand_flags=""

7.1 根据 make 变量对 pkg-plist 进行修改

　　某些 port， 特别是 p5- port， 会需要根据配置选项 (或对于 p5- port 而言， perl 的版本) 来修改它们的 pkg-plist。 为简化这一工作， 在 pkg-plist 中的 %%OSREL%%、 %%PERL_VER%%， 以及 %%PERL_VERSION%% 将自动进行相应的替换。 其中， %%OSREL%% 的值是操作系统以数值表示的版本 (例如 4.9)。 %%PERL_VERSION%% 则是 perl 的完整版本号 (例如 5.00502) 而 %%PERL_VER%% 是 perl 的版本去掉 patchlevel 的部分 (例如 5.005)。 许多其它与 port 文档文件有关的 %%变量%% 在 相应章节 中进行了介绍。

　　如果您还需要进行其它的替换， 可以通过将 PLIST_SUB 变量设置为一组 变量=值 对来实现。 其中， %%VAR%% 表示在 pkg-plist 中将被 值 替换的那些文字。

　　举例来说， 如果 port 需要把很多文件放到和版本有关的目录中， 可以在 Makefile 中按照类似下面的例子：

OCTAVE_VERSION= 2.0.13
PLIST_SUB=      OCTAVE_VERSION=${OCTAVE_VERSION}

　　并在 pkg-plist 中将具体的版本替换为 %%OCTAVE_VERSION%%。 这样， 在升级 port 时， 就不需要再到 pkg-plist 中修改那几十 (或者， 有时甚至是上百) 行的内容了。

　　这一替换过程 (以及加入 联机手册 的过程)， 会在 pre-install 和 do-install 两个 target 之间， 通过读取 PLIST 并写入 TMPPLIST (默认情况下， 是： WRKDIR/.PLIST.mktmp) 来完成。 因此， 如果您的 port 动态生成 PLIST， 就需要在 pre-install 之前完成。 另外， 如果您的 port 需要编辑所生成的文件， 则需要在 post-install 中操作名为 TMPPLIST 的那个文件。

　　另一种可行的修改装箱单的方法， 则是根据 PLIST_FILES 和 PLIST_DIRS 这两个变量的设置来进行。 它们的值会作为目录名连同 PLIST 的内容一起写入 TMPPLIST。 在 PLIST_FILES 和 PLIST_DIRS 中列出的名字， 会经历前面所介绍的 %%变量%% 替换过程。 除此之外， 在 PLIST_FILES 中列出的文件， 会不加任何修改第出现在最终的装箱单中， 而 @dirrm 将作为前缀加到 PLIST_DIRS 所列的名字之前。 为了达到目的， PLIST_FILES 和 PLIST_DIRS 必须在写 TMPPLIST 之前， 也就是在 pre-install 或更早的阶段进行设置。

7.2 空目录

 :
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

@dirrmtry share/doc/gimp

@exec mkdir -p %D/share/foo/templates

7.3 配置文件

　　如果 port 需要把一些文件放到 PREFIX/etc， 不要 简单地安装它们， 并将其列入 pkg-plist， 因为这样会导致 pkg_delete(1) 删除用户精心编辑的文件， 而新安装时则又会把这些文件覆盖。

　　因此， 您应把配置文件的例子按其它的后缀来安装 (例如 filename.sample 就是一个不错的选择) 并显示一条 消息 告诉用户如何复制并编辑这个配置文件， 以便让软件能够正确工作。

　　因此， 应按其它的后缀来安装配置文件的例子 (filename.sample 就是一个不错的选择)。 如果实际的配置文件不存在， 则将其复制为实际文件的名字。 卸载时， 如果发现用户没有修改配置文件， 则将其删除。 您需要在 port 的 Makefile， 以及 pkg-plist (对于从 package 安装的情形) 进行处理。

　　示例的 Makefile 部分：

post-install:
    @if [ ! -f ${PREFIX}/etc/orbit.conf ]; then \
        ${CP} -p ${PREFIX}/etc/orbit.conf.sample ${PREFIX}/etc/orbit.conf ; \
    fi

　　示例的 pkg-plist 部分：

@unexec if cmp -s %D/etc/orbit.conf.sample %D/etc/orbit.conf; then rm -f %D/etc/orbit.conf; fi
etc/orbit.conf.sample
@exec if [ ! -f %D/etc/orbit.conf ] ; then cp -p %D/%F %B/orbit.conf; fi

　　另外， 还应显示一条 消息 指出用户应在何处复制并编辑这个文件， 以便让软件能开始正常工作。

7.4 动态装箱单与静态装箱单的对比

　　静态装箱单 是指在 Ports Collection 中以 pkg-plist 文件 (可能包含变量替换)， 或以 PLIST_FILES 和 PLIST_DIRS 的形式嵌入到 Makefile 出现的装箱单。 即使它是由工具或 Makefile 中的某个 target 在经由 committer 加入到 Ports Collection 之前 自动生成的也是如此， 因为可以在不下载或编译源代码包的前提下对其进行检视。

　　动态装箱单 是指在 port 编译并安装时生成的装箱单。 在下载并编译您所移植的应用程序的源代码之前， 或在执行了 make clean 之后， 就无法查看其内容了。

　　尽管使用动态装箱单并不被禁止， 但监护人应尽可能使用静态装箱单， 因为它能够让用户使用 grep(1)来发现所需的 ports， 例如， 它是否会安装某个特定文件。 动态列表主要应用于复杂的， 其装箱单随所选功能会发生巨变 (因而使得维护静态装箱单不再可行)， 或那些随版本而改变装箱单内容的 port (例如， 使用 Javadoc 来生成文档的那些 ports)。

　　我们鼓励那些选择使用动态装箱单的监护人提供一个能够生成 pkg-plist 的 target， 以便于用户检视其内容。

7.5 装箱单 (package list) 的自动化制作

　　首先， 请确认已经基本上完成了 port 的工作， 仅缺 pkg-plist。

　　接下来， 建立一个临时的目录， 以便安装您的 port， 首先在其中安装所有依赖的 port。 对于非 X 的 port， port-type 应该是 local; 而使用 XFree86 4.X 或 X.org 目录结构的对应则是 x11-4， 最后， 如果 port 使用的是 XFree86 3.X， 则应使用 x11。

# mkdir /var/tmp/port-name
# mtree -U -f /etc/mtree/BSD.port-type.dist -d -e -p /var/tmp/port-name
# make depends PREFIX=/var/tmp/port-name

　　将目录结构保存到一新文件中。

# (cd /var/tmp/port-name && find -d * -type d) | sort > OLD-DIRS

　　建立一空白 pkg-plist 文件：

# touch pkg-plist

　　如果您的 port 遵循 PREFIX (应该如此) 则接下来应安装该 port 并创建装箱单。

# make install PREFIX=/var/tmp/port-name
# (cd /var/tmp/port-name && find -d * \! -type d) | sort > pkg-plist

　　此外还应把新建立的目录加入装箱单。

# (cd /var/tmp/port-name && find -d * -type d) | sort | comm -13 OLD-DIRS - | sort -r | sed -e 's#^#@dirrm #' >> pkg-plist

　　最后需要手工整理 packing list； 这一过程不是 完全 自动的。 联机手册应列入 port 的 Makefile 中的 MANn， 而不是装箱单。 用户配置文件应被删除， 或以 filename.sample 这样的名字来安装。 info/dir 文件， 也不应列入， 同时应按照 info 文件 的说明来增加一些 install-info 行。 所有由 port 安装的库， 应按照 动态连接库 小节中介绍的方法处理。

　　另外， 也可以使用 /usr/ports/Tools/scripts/ 中的 plist 脚本来自动创建 package list。 第一步和上面一样， 也就是 mkdir， mtree 并 make depends。 然后构建和安装 port：

# make install PREFIX=/var/tmp/port-name

　　然后让 plist 生成 pkg-plist 文件：

# /usr/ports/Tools/scripts/plist -Md -m /etc/mtree/BSD.port-type.dist /var/tmp/port-name > pkg-plist

　　与前面类似， 如此生成的装箱单也需要手工进行一些清理工作。

8.1 pkg-message (安装预编译包时显示的消息文件)

　　如果您需要在安装时显示一条消息给用户， 可以把这消息放在 pkg-message 中。 这一特性通常可以用于在 pkg_add(1) 之后显示一些附加的安装步骤， 或显示关于授权的信息。

8.2 pkg-install (安装预编译包时执行的脚本文件)

　　如果您的 port 需要在预编译的安装包通过 pkg_add(1) 安装时执行一些命令， 则应通过 pkg-install 脚本来完成。 这个脚本会自动地加入 package， 并被 pkg_add(1) 执行两次： 第一次是 ${SH} pkg-install ${PKGNAME} PRE-INSTALL 而第二次是 ${SH} pkg-install ${PKGNAME} POST-INSTALL。 $2 可被用来检测脚本运行的模式。 环境变量 PKG_PREFIX 将设置为 package 的安装目录。 请参见 pkg_add(1) 以了解更进一步的细节。

8.3 pkg-deinstall (卸载时执行的脚本文件)

　　这一脚本将在 package 被卸载时执行。

　　此脚本会被 pkg_delete(1) 执行两次。 第一次是 ${SH} pkg-deinstall ${PKGNAME} DEINSTALL 而第二次则是 ${SH} pkg-deinstall ${PKGNAME} POST-DEINSTALL。

8.4 pkg-req (安装预编译包时检测是否应执行操作的脚本文件)

　　如果您的 port 需要确定它是否应被安装， 可以创建 pkg-req “requirements” 脚本。 它会在安装/卸载时自动运行， 以决定操作是否应被实施。

　　这个脚本会在使用 pkg_add(1) 安装时以 pkg-req ${PKGNAME} INSTALL 的命令行执行。 卸载时， 它将由 pkg_delete(1) 以 pkg-req ${PKGNAME} DEINSTALL 的命令行执行。

8.5 改变 pkg-* 文件的名字

　　所有 pkg-* 文件的名字， 皆系采用变量予以定义， 因此在需要时可以在您的 Makefile 中加以改变。 当您需要在多个 port 之间共享某些 pkg-* 文件， 或需要写入某些文件时就非常有用了。 (参见 在 WRKDIR 以外的地方写文件， 以了解为什么直接将变更写入 pkg-* 子目录是个糟糕的主意)

　　下面是一组变量以及它们的默认值 (PKGDIR 默认情况下是 ${MASTERDIR}。)

　　请修改这些变量， 而不是直接覆盖 PKG_ARGS 的值。 如果您改变了 PKG_ARGS， 这些文件将无法在安装 port 时正确地复制到 /var/db/pkg 目录。

8.6 使用 SUB_FILES 和 SUB_LIST

　　SUB_FILES 和 SUB_LIST 这两个变量可以用来在 port 文件中使用某些动态的值， 例如 pkg-message 中的 installation PREFIX。

　　使用 SUB_FILES 变量可以指定需要自动修改的文件列表。 在 SUB_FILES 中的每一个 file， 都必须有一个对应的、 存在于 FILESDIR 目录的 file.in 文件。 如果您加入了一些文件， 例如 pkg-message、 pkg-install、 pkg-deinstall 或 pkg-reg， 则相关的 PKG-FILE 变量就应设置为 WRKDIR/pkg-file。

　　用 SUB_FILES 变量， 可以指定需要自动进行修改的文件列表。 在 SUB_FILES 中的每一个 文件， 在 FILESDIR 目录中都必须有一个对应的 文件.in。 修改后的版本将保存在 WRKDIR。 在 USE_RC_SUBR (或已经过时的 USE_RCORDER) 中定义的文件会自动加入到 SUB_FILES 中。 对于 pkg-message、 pkg-install、 pkg-deinstall and pkg-reg， 对应的 Makefile 变量会被自动设置， 以指向处理过的版本。

　　SUB_LIST 这个变量的内容是一系列 VAR=VALUE 对。 SUB_FILES 所列出的文件中所有的 %%VAR%% 都将被替换为 VALUE。 系统自动定义了一些常用的替换对， 包括： PREFIX、 LOCALBASE、 X11BASE、 DATADIR、 DOCSDIR， 以及 EXAMPLESDIR。 替换结果中所有以 @comment 开头的行， 都将在变量替换之后被删去。

　　下面的例子中， 将把 pkg-message 中的 %%ARCH%% 替换为系统所运行的架构名称：

SUB_FILES=     pkg-message
SUB_LIST=      ARCH=${ARCH}

　　注意， 在上述例子中， FILESDIR 里必须有 pkg-message.in 这个文件。

　　下面是一个正确的 pkg-message.in 例子：

Now it is time to configure this package.
Copy %%PREFIX%%/share/examples/putsy/%%ARCH%%.conf into your home directory
as .putsy.conf and edit it.

9.1 运行 make describe

　　许多 FreeBSD port 维护工具， 例如 portupgrade(1)， 会依赖于一个名为 /usr/ports/INDEX 的数据库的正确性， 它提供了关于 port 的相关信息， 例如依赖关系等等。 INDEX 是由顶级的 ports/Makefile 通过 make index 来建立的， 这个命令会进入每一个 port 的子目录， 并在那里执行 make describe。 因此， 如果某个 port 的 make describe 失败， 就没有人能生成 INDEX， 人们很快会变得不高兴。

　　如果 make describe 只是产生一个字符串， 而不是错误信息， 可能就没什么问题。 请参见 bsd.port.mk 以了解所生成的串的意义。

　　最后要说明的是， 新版本的 portlint (在下一节中将进行介绍) 将会自动地运行 make describe。

9.2 Portlint

　　在提交或 commit 之前， 应使用 portlint 来进行检查。 portlint 会对常见的、 包括功能上的和格式上的错误给出警告。 对于新的 (或在 repocopy 代码库中复制的) port， portlint -A 可以完成全面检查； 对于暨存的 port， portlint -C 一般就足够了。

　　由于 portlint 采用启发式方法来检查错误， 有时它会产生误警。 另外， 有时由于 port 框架的限制可能没有办法修正它指出的问题。 如果您有疑虑， 请写信询问 FreeBSD ports 邮件列表。

9.3 PREFIX (安装时的顶级目录名)

　　尽可能让 port 安装到 PREFIX 之下的目录。 (一般情况下， 这个变量的值是 LOCALBASE (默认为 /usr/local)。 如果设置了 USE_X_PREFIX 或 USE_IMAKE， 则 PREFIX 将是 X11BASE (默认为 /usr/X11R6)。 如果设置了 USE_LINUX_PREFIX， PREFIX 将是 LINUXBASE (默认为 /compat/linux)。

　　避免在源代码中的任何地方硬编码 /usr/local 或 /usr/X11R6 这样的路径， 这会让您的 port 灵活许多， 而且能够适应大型站点的需求。 对于使用了 imake 的 X port 而言， 这是自动的； 对于其它 port， 这通常可以通过把在 脚本/Makefile 中出现的 /usr/local (或对于不使用 imake 的 X port， /usr/X11R6) 改为使用 ${PREFIX} 来完成， 因为这个变量会传达到构建和安装的各个步骤。

　　确认一下您的应用程序不会错误地把文件安装到 /usr/local 而非 PREFIX。 简单的测试步骤是：

# make clean; make package PREFIX=/var/tmp/port-name

　　如果有文件安装到了 PREFIX 以外的地方， 打包过程将抱怨找不到这些文件。

　　这一步骤并不能帮助发现内部引用， 或纠正在引用其它 port 中的文件时使用的 LOCALBASE。 您需要在 /var/tmp/port-name 中测试安装好的软件， 才能够达到这样的目的。

　　除非真的需要， 否则不要设置 USE_X_PREFIX (例如， 如果它需要连接或引用 X11BASE 中的 X 库或文件)。

　　您可以在自己的 Makefile 中改变 PREFIX 变量的值， 也可以通过用户环境变量来影响它。 然而， 一般情况下决不应该在 Makefile 中明确设置它的值。

　　此外， 引用其它 port 中的文件时， 应使用前面介绍的变量， 而不要直接指定它们的路径名。 例如， 如果您的 port 需要使用 PAGER 这个宏来指明 less 的完整路径， 应使用下面的编译选项：

-DPAGER=\"${LOCALBASE}/bin/less\"

11.1 安全为何如此重要

　　软件中偶尔会引入 bug。 毋庸置疑， 安全漏洞是最为危险的。 从技术角度看， 这些漏洞可以通过消除导致它们的 bug 来修复。 然而， 处理一般的 bug 和安全漏洞的策略是截然不同的。

　　典型的小 bug 通常只影响那些启用了某些能够触发它的选项组合的用户。 开发人员最终会在发布没有那个问题的新版之后给出一个补丁来修正它， 而用户中的主体并不会立即升级， 因为他们并没有因存在问题而感到苦恼。 严重的 bug 可能会导致数据丢失和其它问题， 无论如何， 谨慎的用户知道， 除了软件 bug 之外还有很多其它事故可能会导致数据丢失， 因此他们会备份重要数据； 此外， 严重的 bug 通常会被很快发现。

　　安全漏洞则完全不同。 第一， 它们可能存在数年而不被发现， 因为它们可能并不导致软件无法正常工作。 第二， 通过利用漏洞， 恶意的一方可能会得到未获授权的访问权限， 并利用这些权限毁掉或修改敏感数据； 而更糟糕的情况则是用户可能根本注意不到损害已经发生。 第三， 暴露出安全漏洞的系统， 往往能够帮助攻击者闯入其它之前不可能进入的系统。 因此， 只是修正安全漏洞是不够的： 必须以清晰和全面的方式通知公众， 这样他们就能够评估风险， 并采取适当的措施。

11.2 修复安全漏洞

　　当说起 port 或 package 时， 安全漏洞往往是出现在原作者的发行包， 或移植过程中加入的文件里。 对于前一种情况， 软件的原作者通常会立刻发布一个补丁甚至新版， 您只需要按照原作者的修正去更新 port 就可以了。 如果由于某种原因修正被延误， 则要么 将 port 标记为 FORBIDDEN， 要么在 port 中加入一个自己的补丁。 如果有存在漏洞的 port， 尽可能尽快修复其漏洞就是。 无论是哪种情况， 您还是需要按照 标准的提交流程 提交， 除非您有直接在 ports tree 上 commit 的权限。

　　在漏洞被修正之后， 一定要同时增加 port 的修订版本号。 这样， 规律性地升级安装的 package 的用户就能够看到他们需要进行升级。 另外， 还应构建预编译的安装包， 并通过 FTP 和 WWW 镜像发布， 以取代有漏洞的版本。 注意要增加 PORTREVISION 数字， 除非在修正问题时 PORTVERSION 发生了变化。 一般来说， 如果在 port 中增加了补丁文件， 就应该增加 PORTREVISION， 但例外的例子是您已经将软件升级到了最新版， 因为这时已经改掉 PORTVERSION 了。 请参见 相关小节 以了解进一步的信息。

11.3 通知整个用户群体

<vuln vid="f4bc80f4-da62-11d8-90ea-0004ac98a7b9"> 
  <topic>Several vulnerabilities found in Foo</topic> 
  <affects>
    <package>
      <name>foo</name> 
      <name>foo-devel</name>
      <name>ja-foo</name>
      <range><ge>1.6</ge><lt>1.9</lt></range> 
      <range><ge>2.*</ge><lt>2.4_1</lt></range>
      <range><eq>3.0b1</eq></range>
    </package>
    <package>
      <name>openfoo</name> 
      <range><lt>1.10_7</lt></range> 
      <range><ge>1.2,1</ge><lt>1.3_1,1</lt></range>
    </package>
  </affects>
  <description>
    <body xmlns="http://www.w3.org/1999/xhtml">
      <p>J. Random Hacker reports:</p> 
      <blockquote
        cite="http://j.r.hacker.com/advisories/1">
        <p>Several issues in the Foo software may be exploited
          via carefully crafted QUUX requests.  These requests will
          permit the injection of Bar code, mumble theft, and the
          readability of the Foo administrator account.</p>
      </blockquote>
    </body>
  </description>
  <references> 
    <freebsdsa>SA-10:75.foo</freebsdsa> 
    <freebsdpr>ports/987654</freebsdpr> 
    <cvename>CAN-2010-0201</cvename> (11)
    <cvename>CAN-2010-0466</cvename>
    <bid>96298</bid> (12)
    <certsa>CA-2010-99</certsa> (13)
    <certvu>740169</certvu> (14)
    <uscertsa>SA10-99A</uscertsa> (15)
    <uscertta>SA10-99A</uscertta> (16)
    <mlist msgid="[email protected]">http://marc.theaimsgroup.com/?l=bugtraq&amp;m=203886607825605</mlist> (17)
    <url>http://j.r.hacker.com/advisories/1</url> (18)
  </references>
  <dates>
    <discovery>2010-05-25</discovery> (19)
    <entry>2010-07-13</entry> (20)
    <modified>2010-09-17</entry> (21)
  </dates>
</vuln>

% packaudit
% portaudit clamav-0.65_6

% cd ${PORTSDIR}/security/vuxml && make validate

% packaudit

% portaudit -f /usr/ports/INDEX -r 74a9541d-5d6c-11d8-80e3-0020ed76ef5a

% portaudit clamav-0.65_6 clamav-0.65_7
Affected package: clamav-0.65_6 (matched by clamav<0.65_7)
Type of problem: clamav remote denial-of-service.
Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.html>

1 problem(s) found.

% mkdir -p ~/public_html/portaudit
% packaudit
% lynx ~/public_html/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.html

12.1 介绍

　　这里是一些在移植软件时可能会遇到的常见问题。 您应按照这个列表检查自己的 port， 同样地， 您也可以帮助检查 PR 数据库 中由其它人提交的 port。 请按照在 问题报告和一般性注释 中介绍的方法提交您的看法。 帮助检查 PR 数据库中的 ports 即能够帮助我们更快地 commit 它们， 也能证明您清楚地了解如何完成这些工作。

12.2 对可执行文件做脱模 (strip) 操作

　　除非不得不进行， 否则不要手工对可执行文件作脱模操作。 所有文件在安装时都应脱模， 但 INSTALL_PROGRAM 宏会在安装的同时对其进行脱模 (参见下一节的内容)。

　　如果您需要对某一文件进行脱模， 但不希望使用 INSTALL_PROGRAM 宏， 则应使用 ${STRIP_CMD} 来处理程序。 一般而言这应该在 post-install target 中进行。 例如：

post-install:
    ${STRIP_CMD} ${PREFIX}/bin/xdl

　　可以使用 file(1) 命令来检查所安装的可执行文件是否进行过脱模。 如果它没有给出 not stripped 的提示， 则表示已经做过脱模了。 另外， strip(1) 不会对已经脱模过的文件重新脱模， 它会直接退出的。

12.3 INSTALL_* 宏

　　您应使用由 bsd.port.mk 提供的宏来完成操作， 以确保您自己的 *-install target 能够正确地设置属主和权限信息。

• INSTALL_PROGRAM 代表用于安装二进制的可执行文件的命令。

• INSTALL_SCRIPT 代表用于安装可执行脚本的命令。

• INSTALL_DATA 代表用于安装普通用户可访问的数据的命令。

• INSTALL_MAN 代表用于安装联机手册， 以及其它文档的命令 (注意， 它并不会对这些文件实施压缩操作)。

　　这些宏基本上就是给出了适当参数的 install 命令。 下面给出了如何使用它们的例子。

12.4 WRKDIR (构建时使用的临时目录)

　　任何时候都不要在 WRKDIR 以外的位置写文件。 WRKDIR 是在 port 构建过程中唯一的一处一定可写的地方 (参见 如何从 CDROM 安装 port 以了解从只读的目录中构建和安装 port 的例子)。 如果您需要改变 pkg-* 文件， 请按照 重新定义某个变量 介绍的方法， 而不是覆盖它们来实现。

12.5 WRKDIRPREFIX (用于构建的临时目录的父目录名)

　　一定要确保您的 port 尊重 WRKDIRPREFIX 的设置。 绝大多数 port 并不需要担心这个。 具体说来， 当引用其它 port 的 WRKDIR 时， 需要注意正确的位置应该是 WRKDIRPREFIXPORTSDIR/subdir/name/work 而不是 PORTSDIR/subdir/name/work 或 .CURDIR/../../subdir/name/work， 或别的什么。

　　另外， 如果您自行定义了 WRKDIR， 也要把 ${WRKDIRPREFIX}${.CURDIR} 放到前面。

12.6 区分不同的操作系统， 以及 OS 的版本

　　在不同版本的 Unix 下可能需要对代码进行一些修改或增加少许编译选项， 才能够正确地编译和运行。 如果您需要根据一些条件来对代码进行修改， 请尽可能让这些修改通用， 这样， 我们就能够将这些代码移植回更早的 FreeBSD 系统， 并交叉移植到其它 BSD 系统， 例如来自 CSRG 的 4.4BSD， BSD/386， 386BSD， NetBSD 和 OpenBSD。

　　推荐的获得 4.3BSD/Reno (1990) 以及更新版本 BSD 代码版本号的方式， 是使用 sys/param.h 中所定义的 BSD 宏的值。 一般来说这个文件已经被引用了； 如果没有的话， 增加下述代码：

#if (defined(__unix__) || defined(unix)) && !defined(USG)
#include <sys/param.h>
#endif

　　到 .c 文件中合适的地方。 我们相信所有定义了这两个符号的系统中， 都提供了 sys/param.h。 如果您发现有不这样做的系统， 请通过致信 FreeBSD ports 邮件列表 让我们了解这一情况。

　　另一种方法是使用 GNU Autoconf 风格的方式：

#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif

　　采用这种方法时， 不要忘了把 -DHAVE_SYS_PARAM_H 加到 Makefile 中的 CFLAGS 里。

　　一旦引用了 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， 则应使用这个宏。 类似 sys_errlist[] 之于 strerror() 这样的移植问题是伯克利代码系公用的， 而并非 FreeBSD 所专有。

• 在 FreeBSD 2.x 中， __FreeBSD__ 定义为 2。 更早版本中， 它曾经是 1。 新的版本都会在主要的版本号变化时变更它。

• 如果您需要区分 FreeBSD 1.x 系统和 FreeBSD 2.x 及更高版本的区别， 通常应使用前述的 BSD 宏来进行。 如果事实上需要一个 FreeBSD 专有的修改 (例如， 在使用 ld 时需要特殊的共享库选项)， 则可以用 __FreeBSD__ 和 #if __FreeBSD__ > 1 来检测 FreeBSD 2.x 和新系统上的变化。 如果需要更细粒度地检测 FreeBSD 2.0-RELEASE 之后版本的变化， 则可以使用：

  #if __FreeBSD__ >= 2
  #include <osreldate.h>
  #    if __FreeBSD_version >= 199504
       /* 适用于 2.0.5+ 版本的代码 */
  #    endif
  #endif
  

　　在已有的数百个 port 中， 只有一两个应该使用 __FreeBSD__。 早期的 port 在不适当的地方使用了它并引发问题， 并不意味着您也必定如此。

12.7 __FreeBSD_version 值

　　下面是在 sys/param.h __FreeBSD_version 中定义的值及其意义的列表， 这里给出以方便您查阅：

12.8 在 bsd.port.mk 之后写一些内容

　　不要在 .include <bsd.port.mk> 这行之后增加任何内容。 这通常可以通过在您的 Makefile 中间的某处引用 bsd.port.pre.mk， 并在结尾的地方引用 bsd.port.post.mk 来避免。

　　bsd.port.pre.mk 只定义了很少的变量， 它们可以在 Makefile 中用于进行一些测试， 而 bsd.port.post.mk 则定义了所有其它的变量。

　　下面是一些由 bsd.port.pre.mk 定义的比较重要的变量 (这并不是一份完整的列表， 您可以阅读 bsd.port.mk 以获得全部变量的名字)。

　　下面是一些在引用 bsd.port.pre.mk 之后可以进行的判断：

# 如果 perl5 已经在系统中提供， 则不必编译 lang/perl5
.if ${OSVERSION} > 300003
BROKEN= perl is in system
.endif

# ELF 只使用一个 shlib 版本
.if ${PORTOBJFORMAT} == "elf"
TCL_LIB_FILE=  ${TCL_LIB}.${SHLIB_MAJOR}
.else
TCL_LIB_FILE=  ${TCL_LIB}.${SHLIB_MAJOR}.${SHLIB_MINOR}
.endif

# 软件会自动为 ELF 创建符号链接， 但 a.out 则需要另行创建
post-install:
.if ${PORTOBJFORMAT} == "aout"
       ${LN} -sf liblinpack.so.1.0 ${PREFIX}/lib/liblinpack.so
.endif

　　您还记得应该在 BROKEN= 和 TCL_LIB_FILE= 后面使用制表符， 而不是空格， 对吧？ :-)

12.9 安装附加的文档

　　如果您的软件包含了标准的联机手册和 info 手册以外的文档， 而且您认为它们对用户会有用， 请把这些文档安装到 PREFIX/share/doc 下。 和前面类似， 这也可以在 post-install target 中完成。

　　为您的 port 建立一个新的目录。 这个目录的名字应该反映它是属于哪个 port 的。 通常建议使用 PORTNAME。 不过， 如果您认为不同版本的 port 可能会同时安装， 也可以用完整的 PKGNAME。

　　另外， 应该让是否安装取决于变量 NOPORTDOCS 的设置， 这样用户就能够在 /etc/make.conf 中禁止安装它。 例如：

post-install:
.if !defined(NOPORTDOCS)
    ${MKDIR} ${DOCSDIR}
    ${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${DOCSDIR}
.endif

　　这里是一些便于使用的变量， 以及它们在 Makefile 中默认的展开方式：

• DATADIR 会展开成 PREFIX/share/PORTNAME。

• DOCSDIR 会展开成 PREFIX/share/doc/PORTNAME。

• EXAMPLESDIR 会展开成 PREFIX/share/examples/PORTNAME。

　　这些变量也会被导出到 PLIST_SUB 中。 只要可能， 它们的值就将在那里以相对于 PREFIX 的路径形式出现。 也就是说， share/doc/PORTNAME 在装箱单中默认情况下会替换掉 %%DOCSDIR%%， 等等。 (更多的 pkg-plist 代换可以在 这里 找到。)

　　所有的安装的文档文件和目录， 都应在 pkg-plist 出现， 并且使用 %%PORTDOCS%% 前缀， 例如：

%%PORTDOCS%%%%DOCSDIR%%/AUTHORS
%%PORTDOCS%%%%DOCSDIR%%/CONTACT
%%PORTDOCS%%@dirrm %%DOCSDIR%%

　　如果不希望在 pkg-plist 中逐个列举文档文件， port 也可以将 PORTDOCS 设置为一组文件及其 shell glob 模式， 通过这种方式来加入到最终的装箱单中。 这些名字应是相对于 DOCSDIR 的。 因此， 使用了 PORTDOCS， 并将文档安装到非标准位置的 port， 应相应地设置 DOCSDIR。 如果有在 PORTDOCS 中列出目录， 或者这一变量中的 glob 模式匹配到了目录， 则整个子树中的文件和目录， 都将被注册到最终的装箱单中。 如果定义了 NOPORTDOCS， 则 PORTDOCS 中定义的文件和目录将不被安装或加入装箱单。 是否安装文档到前面所说的 PORTDOCS 仍取决于 port 本身。 下面是一个典型的使用 PORTDOCS 的例子：

PORTDOCS=       README.* ChangeLog docs/*

12.10 子目录

　　尽可能让 port 将它创建的文件， 放置到 PREFIX 中正确的位置。 一些 port 会把各式各样的东西混在一起， 并放到一个同名的目录中， 这是不对的。 另外， 许多 port 会把除了可执行文件、 头文件和联机手册之外的所有文件， 全都一股脑地放到 lib 中， 这在和 BSD 配合使用时会有问题。 多数文件， 应被放到下列位置之一： etc (安装/配置文件)、 libexec (由系统内部调用的可执行文件)、 sbin (为超级用户/管理员提供的可执行文件)、 info (用于 info 浏览器的文档) 或 share (平台无关的其它文件)。 请参见 hier(7) 以了解进一步的详情； 针对 /usr 的那些规则， 同样也适用于 /usr/local。 例外情况是那些需要和 USENET “news” 打交道的 port， 它们可以选择采用 PREFIX/news 作为文件的目的地。

12.11 在 wrapper 脚本中使用 exec 语句

　　如果 port 安装了用以启动其他程序的脚本， 并且运行其他程序是这些脚本的最后一项操作， 请务必使用 exec 语句来运行这些程序， 例如：

#!/bin/sh
exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"

　　使用 exec 语句表示执行指定的程序来取代 shell 进程。 如果省略了 exec， 则 shell 进程会一直在内存中， 从而不必要地消耗了额外的系统资源。

12.12 UID 和 GID

　　如果您的 port 安装到系统上之前需要一些用户， 请使用 pkg-install 脚本来调用 pw 以便自动地创建它们。 请参见 net/cvsup-mirror 提供的例子。

　　如果您的 port 需要与其编译成安装包时同样的用户/组 ID， 则必须在 50 到 999 之间选择一个未用的 UID。 请参见 japanese/Wnn6 提供的例子。

　　一定不要使用系统或其它 port 已经使用的 UID。

　　下面是目前预留的 50 到 999 之间的 UID。

bind:*:53:53:Bind Sandbox:/:/sbin/nologin
majordom:*:54:54:Majordomo Pseudo User:/usr/local/majordomo:/nonexistent
rdfdb:*:55:55:rdfDB Daemon:/var/db/rdfdb:/bin/sh
spamd:*:58:58:SpamAssassin user:/var/spool/spamd:/sbin/nologin
cyrus:*:60:60:the cyrus mail server:/nonexistent:/nonexistent
gnats:*:61:1:GNATS database owner:/usr/local/share/gnats/gnats-db:/bin/sh
proxy:*:62:62:Packet Filter pseudo-user:/nonexistent:/nonexistent
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:/sbin/nologin
wnn:*:69:7:Wnn:/nonexistent:/nonexistent
pgsql:*:70:70:PostgreSQL pseudo-user:/usr/local/pgsql:/bin/sh
oracle:*:71:71::0:0:Oracle:/usr/local/oracle7:/sbin/nologin
ircd:*:72:72:IRC daemon:/nonexistent:/nonexistent
ircservices:*:73:73:IRC services:/nonexistent:/nonexistent
simscan:*:74:74:Simscan User:/nonexistent:/sbin/nologin
ifmail:*:75:66:Ifmail user:/nonexistent:/nonexistent
www:*:80:80:World Wide Web Owner:/nonexistent:/sbin/nologin
alias:*:81:81:QMail user:/var/qmail/alias:/nonexistent
qmaild:*:82:81:QMail user:/var/qmail:/nonexistent
qmaill:*:83:81:QMail user:/var/qmail:/nonexistent
qmailp:*:84:81:QMail user:/var/qmail:/nonexistent
qmailq:*:85:82:QMail user:/var/qmail:/nonexistent
qmailr:*:86:82:QMail user:/var/qmail:/nonexistent
qmails:*:87:82:QMail user:/var/qmail:/nonexistent
mysql:*:88:88:MySQL Daemon:/var/db/mysql:/sbin/nologin
vpopmail:*:89:89:VPop Mail User:/usr/local/vpopmail:/nonexistent
firebird:*:90:90:Firebird Database Administrator:/usr/local/firebird:/bin/sh
mailman:*:91:91:Mailman User:/usr/local/mailman:/sbin/nologin
gdm:*:92:92:GDM Sandbox:/:/sbin/nologin
jabber:*:93:93:Jabber Daemon:/nonexistent:/nonexistent
p4admin:*:94:94:Perforce admin:/usr/local/perforce:/sbin/nologin
interch:*:95:95:Interchange user:/usr/local/interchange:/sbin/nologin
squeuer:*:96:96:SQueuer Owner:/nonexistent:/bin/sh
mud:*:97:97:MUD Owner:/nonexistent:/bin/sh
msql:*:98:98:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh
rscsi:*:99:99:Remote SCSI:/usr/local/rscsi:/usr/local/sbin/rscsi
squid:*:100:100:squid caching-proxy pseudo user:/usr/local/squid:/sbin/nologin
quagga:*:101:101:Quagga route daemon pseudo user:/usr/local/etc/quagga:/sbin/nologin
ganglia:*:102:102:Ganglia User:/nonexistent:/sbin/nologin
sgeadmin:*:103:103:Sun Grid Engine Admin:/nonexistent:/sbin/nologin
slimserv:*:104:104:Slim Devices SlimServer pseudo-user:/nonexistent:/sbin/nologin
dnetc:*:105:105:distributed.net client and proxy pseudo-user:/nonexistent:/sbin/nologin
clamav:*:106:106:Clamav Antivirus:/nonexistent:/sbin/nologin
cacti:*:107:107:Cacti Sandbox:/nonexistent:/sbin/nologin
webkit:*:108:108:WebKit Default User:/usr/local/www/webkit:/bin/sh
quickml:*:109:109:quickml Server:/nonexistent:/sbin/nologin
vscan:*:110:110:Scanning Virus Account:/var/amavis:/bin/sh
fido:*:111:111:Fido System:/usr/local/fido:/bin/sh
dcc:*:112:112:Distributed Checksum Clearinghouse:/nonexistent:/sbin/nologin
amavis:*:113:113:Amavis-stats Account:/nonexistent:/sbin/nologin
dhis:*:114:114:DHIS Daemon:/nonexistent:/sbin/nologin
_symon:*:115:115:Symon Account:/var/empty:/sbin/nologin
hplip:*:116:116:HPLIP Server:/nonexistent:/sbin/nologin
postfix:*:125:125:Postfix Mail System:/var/spool/postfix:/sbin/nologin
_bgpd:*:130:130:BGP Daemon:/var/empty:/sbin/nologin
_ospfd:*:131:131:OSPF Daemon:/var/empty:/sbin/nologin
rbldns:*:153:153:rbldnsd pseudo-user:/nonexistent:/sbin/nologin
sfs:*:171:171:Self-Certifying File System:/nonexistent:/sbin/nologin
agk:*:172:172:AquaGateKeeper:/nonexistent:/nonexistent
polipo:*:173:173:polipo web cache:/nonexistent:/sbin/nologin
bogomilter:*:174:174:milter-bogom:/nonexistent:/sbin/nologin
moinmoin:*:192:192:MoinMoin User:/nonexistent:/sbin/nologin
sympa:*:200:200:Sympa Owner:/nonexistent:/sbin/nologin
privoxy:*:201:201:Privoxy proxy user:/nonexistent:/sbin/nologin
dspam:*:202:202:Dspam:/nonexistent:/sbin/nologin
shoutcast:*:210:210:Shoutcast sandbox:/nonexistent:/bin/sh
_tor:*:256:256:Tor anonymising router:/var/db/tor:/bin/sh
smxs:*:260:260:Sendmail X SMTPS:/nonexistent:/sbin/nologin
smxq:*:261:261:Sendmail X QMGR:/nonexistent:/sbin/nologin
smxc:*:262:262:Sendmail X SMTPC:/nonexistent:/sbin/nologin
smxm:*:263:263:Sendmail X misc:/nonexistent:/sbin/nologin
smx:*:264:264:Sendmail X other:/nonexistent:/sbin/nologin
mrtg:*:279:279:MRTG daemon:/nonexistent:/sbin/nologin
ldap:*:389:389:OpenLDAP Server:/nonexistent:/sbin/nologin
drweb:*:426:426:Dr.Web Mail Scanner:/nonexistent:/sbin/nologin
courier:*:465:465:Courier Mail Server:/nonexistent:/sbin/nologin
_bbstored:*:505:505::0:0:BoxBackup Store Daemon:/nonexistent:/bin/sh
ejabberd:*:544:544::0:0:ejabberd pseudo user:/var/spool/ejabberd:/bin/sh
qtss:*:554:554:Darwin Streaming Server:/nonexistent:/sbin/nologin
ircdru:*:555:555:Russian hybrid IRC server:/nonexistent:/bin/sh
messagebus:*:556:556:D-BUS Daemon User:/nonexistent:/sbin/nologin
avahi:*:558:558:Avahi Daemon User:/nonexistent:/sbin/nologin
bnetd:*:700:700:Bnetd user:/nonexistent:/sbin/nologin
bopm:*:717:717:Blitzed Open Proxy Monitor:/nonexistent:/bin/sh
bacula:*:910:910:Bacula Daemon:/var/db/bacula:/sbin/nologin

　　下面是目前预留的 GID。

bind:*:53:
rdfdb:*:55:
spamd:*:58:
cyrus:*:60:
proxy:*:62:
authpf:*:63:
uucp:*:66:
xten:*:67:
dialer:*:68:
network:*:69:
pgsql:*:70:
simscan:*:74:
audit:*:77:
www:*:80:
qnofiles:*:81:
qmail:*:82:
mysql:*:88:
vpopmail:*:89:
firebird:*:90:
mailman:*:91:
gdm:*:92:
jabber:*:93:
p4admin:*:94:
interch:*:95:
squeuer:*:96:
mud:*:97:
msql:*:98:
rscsi:*:99:
squid:*:100:
quagga:*:101:
ganglia:*:102:
sgeadmin:*:103:
slimserv:*:104:
dnetc:*:105:
clamav:*:106:
cacti:*:107:
webkit:*:108:
quickml:*:109:
vscan:*:110:
fido:*:111:
dcc:*:112:
amavis:*:113:
dhis:*:114:
_symon:*:115:
postfix:*:125:
maildrop:*:126:
_bgpd:*:130:
_ospfd:*:131:
rbldns:*:153:
sfs:*:171:
agk:*:172:
polipo:*:173:
moinmoin:*:192:
sympa:*:200:
dspam:*:202:
_tor:*:256:
smxs:*:260:
smxq:*:261:
smxc:*:262:
smxm:*:263:
smx:*:264:
mrtg:*:279:
ldap:*:389:
drweb:*:426:
courier:*:465:
_bbstored:*:505:
ejabberd:*:544:
qtss:*:554:
ircdru:*:555:
messagebus:*:556:
realtime:*:557:
avahi:*:558:
bnetd:*:700:
bopm:*:717:
bacula:*:910:

　　如果您的 port 需要在这一范围内预留新的 UID 或 GID 的话， 请在提交 (或升级) 时予以说明。 这样我们就能够让这份列表中的保留 ID 与现实同步了。

12.13 理性行事

　　任何 Makefile 都应该简单并理性地行事。 如果您能让其中的条目更为简单和易读， 一定要这样做。 例如， 使用 make 提供的 .if 结构， 而不要使用 shell 的 if， 只要能重定义 EXTRACT* 就不要重载 do-extract， 尽量使用 GNU_CONFIGURE 而不是 CONFIGURE_ARGS += --prefix=${PREFIX}。

　　如果您在尝试做什么事情的时候发现不得不写大量的代码， 请回过头来复审一下 bsd.port.mk， 看看是否有您正打算做的事情的现成实现。 尽管读起来可能很费劲， 但有很多貌似很难的问题， 在 bsd.port.mk 中都给出了十分简便的解决方案。

12.14 遵循 CC 和 CXX 设置

　　port 应遵循 CC 和 CXX 变量的设置。 这也就是说， port 不应使用绝对的方式来设置这个变量的值， 而罔顾已经存在的设置； 与此相反， 它应该在其值后加入需要的其它值。 这样， 就可以设置全局的构建选项， 令其影响所有的 port 构建过程了。

　　如果实在无法这样做， 请在 Makefile 中加入 NO_PACKAGE=ignores cflags。

　　下面的 Makefile 实例给出了如何遵循 CC 和 CXX 变量的设置。 注意这里用到的 ?=：

CC?= gcc

CXX?= g++

　　下面则是没有遵循 CC 和 CXX 的例子：

CC= gcc

CXX= g++

　　在 FreeBSD 系统中， CC 和 CXX 这两个变量都可以在 /etc/make.conf 中自行定义。 第一个例子只有在 /etc/make.conf 中没有定义时才对这两个变量进行定义， 从而保持了系统范围的配置。 而第二个例子则会覆盖任何现有的配置。

12.15 遵循 CFLAGS

　　您的 port 应遵循 CFLAGS 变量的设置。 这也就是说， port 不应使用绝对的方式来设置这个变量的值， 而罔顾已经存在的设置； 与此相反， 它应该在其值后加入需要的其它值， 这样， 就可以设置全局的构建选项， 令其影响所有的 port 构建过程了。

　　如果实在无法这样做， 请在 Makefile 中加入 NO_PACKAGE=ignores cflags。

　　下面的 Makefile 例子， 可以帮助我们理解如何遵循 CFLAGS 的设置。 注意所用的 +=：

CFLAGS+= -Wall -Werror

　　下面是一个未能遵循 CFLAGS 设置的例子：

CFLAGS= -Wall -Werror

　　一般来说， CFLAGS 在 FreeBSD 系统中是在 /etc/make.conf 里配置的。 第一个例子在 CFLAGS 变量中增加了一些参数， 并保持了所有系统预定义的标志。 而第二个例子， 则会覆盖掉任何先前定义的参数。

　　您应从第三方软件的 Makefile 中去掉特殊的优化设置。 系统的 CFLAGS 给出了全系统范围内的优化设置参数。 下面是一个未经修改的 Makefile 实例：

CFLAGS= -O3 -funroll-loops -DHAVE_SOUND

　　如果使用系统的优化参数， 则 Makefile 中的设置应该类似下面这样：

CFLAGS+= -DHAVE_SOUND

12.16 线程库

　　在 FreeBSD 上， 线程库必须通过特殊的连接器参数 -pthread 连接到可执行文件。 如果 port 一定要直接连接 -lpthread 或 -lc_r， 则应将其改为使用由 ports 框架提供的 PTHREAD_LIBS。 这个变量的值通常是 -pthread， 但在某些特定平台上的 FreeBSD 版本中， 它可能是其它值， 因此， 不要将 -pthread 硬编码到您的补丁中， 而应使用 PTHREAD_LIBS 变量。

12.17 反馈

　　如果进行了一些很好的修改和补丁， 一定要把它们发回给原作者， 或维护者， 以便在下一版本的代码中包含它们。 这会让您在软件发布新版本的时候变得轻松一些。

12.18 README.html

　　不要包含 README.html 文件。 这个文件并非 CVS 代码库中的一部分， 它是由 make readme 命令生成的。

12.19 使用 BROKEN、 FORBIDDEN 或 IGNORE 标记不可安装的 port

　　某些时候会需要阻止用户安装某个 port。 想要告诉用户某个 port 不应被安装， 有许多可以在 port 的 Makefile 中使用的 make 变量。 下列 make 的值， 将是在用户试图安装时得到的提示信息。 务请使用正确的 make 变量， 因为每一个都表达了截然不同的意义， 而且许多自动化系统， 例如 port 构建集群、 FreshPorts， 以及 portsmon， 都依赖于 Makefile 的正确性。

BROKEN= this port is unsupported on FreeBSD 5.x

IGNORE= is unsupported on FreeBSD 5.x

===>  foobar-0.1 is marked as broken: this port is unsupported on FreeBSD 5.x.

===>  foobar-0.1 is unsupported on FreeBSD 5.x.

12.20 可以用 DEPRECATED 或 EXPIRATION_DATE 表示某个 port 将被删除。

　　一定要记得 BROKEN 和 FORBIDDEN 只应作为当某个 port 无法正常工作时的临时解决方案。 永久性地坏掉了的 port 应被从 ports tree 中完全删除。

　　需要时还可以使用 DEPRECATED 和 EXPIRATION_DATE 来通知用户某个 port 不应被使用， 并即将被删除。 前一个变量用来表达为什么计划删除 port； 而后一个是则是一个 ISO 8601 格式的日期 (YYYY-MM-DD)。 两者都会向用户呈现。

　　也可以设置 DEPRECATED 而不给出 EXPIRATION_DATE (例如， 建议使用某个新版本的 port)， 但反之则没有意义。

　　目前还没有确切的关于需要给出多少通知的政策。 当前的实践是， 对于与安全有关的问题为一个月， 而与构建有关的问题则为两个月。 这也让有兴趣的 committer 能够有一点时间来修正问题。

12.21 避免使用 .error 结构

　　在 Makefile 中给出信号， 表示由于某种外界因素 (例如， 用户指定了无效的构建选项) 而无法安装的方法是将变量 IGNORE 设为一非空值。 这个值将被格式化， 并在用户执行 make install 是给出提示。

　　用 .error 实现这一目的是一种常见的误用。 这样做的问题是， 许多在 ports 树上运行的自动化工具会因此而失败。 最常见的情况见于构建 /usr/ports/INDEX 的过程 (参见 第 9.1 节)。 然而， 即使十分普通的命令， 例如 make -V maintainer， 在这种情况下也会失败。 这是不可接受的。

USE_POINTYHAT=yes

.if USE_POINTYHAT
.error "POINTYHAT is not supported"
.endif

.if USE_POINTYHAT
IGNORE=POINTYHAT is not supported
.endif

12.22 一些必要的 workaround

　　有时， 需要绕过一些较早版本的 FreeBSD 中包含软件中的 bug。

• 某些版本的 make(1) 在处理 OSVERSION 的比较时存在问题， 至少对 4.8 和 5.0 是这样。 这经常会导致在 make describe 时发生问题 (因而， ports make index 也会无法正常工作)。 绕过这个问题的方法， 是在判断语句周围增加空格， 例如：

  if ( ${OSVERSION} > 500023 )
  

  请小心， 在 4.9 或 5.2 上测试安装， 是 不能 检测到这个问题的。
  
  

12.23 杂记

　　需要仔细地反复检查 pkg-descr 和 pkg-plist 这两个文件。 如果您正在复审一个 port， 并认为这两个文件应该改进， 请一定要这样做。

　　请不要在系统中复制多份 GNU General Public License。

　　一定要非常小心地处理法律问题！ 不要让我们发布没有得到合法授权的软件！

14.1 FreshPorts

　　最简单的了解已经被 commit 到 ports 中的更新的方法， 是订阅 FreshPorts。 您可以选择多个 ports 并对其进行监视。 强烈建议维护人员订阅它， 这样就不仅能接收到他们自己所做的修改， 而且能看到其它 FreeBSD committer 所做的改动。 (保持与所依赖的 ports 框架同步是必要的──虽然一般来说您会在这样的 commit 之前收到一个礼貌性的通知， 但有时可能会有人没有注意到需要这样做， 或者这样做很困难。 另外， 有些时候通知的修改也可能是微不足道的。 我们希望每一个人能够正确地进行判断。)

　　如果想使用 FreshPorts， 之需要建立一个账号。 如果您注册的邮件地址是 @FreeBSD.org， 您会看到 web 页面右侧的 opt-in 连接。 如果您已经注册了 FreshPorts 账号， 但没有使用 @FreeBSD.org 邮件地址， 则只需把邮件地址改为 @FreeBSD.org， 重新订阅， 并将其改回。

　　FreshPorts 也会对每一个 FreeBSD ports tree 上的 commit 进行自动的合法性检查。 如果您订阅了这项服务， 则如果发现了错误， 就会收到来自 FreshPorts 的检测报告。

14.2 代码库的 Web 访问界面

　　可以通过 web 界面来浏览源代码库中的文件。 影响整个 ports 系统的修改， 现在都会在 CHANGES 文件中说明。 影响某一个 port 的变动， 则在 UPDATING 文件中说明。 尽管如此， 所有问题最为权威的答案， 毫无疑问应该是 bsd.port.mk 的源代码， 以及相关的文件。

14.3 FreeBSD Ports 邮件列表

　　如果您维护了某个或某一些 ports， 则应该考虑订阅 FreeBSD ports 邮件列表。 对于 ports 工作方式的重要修改都会在此宣示， 并提交到 CHANGES。

14.4 位于 pointyhat.FreeBSD.org 的 FreeBSD Port 构建集群

　　FreeBSD 的一个最不为人所知的强项是， 它拥有一个专用于持续构建 Ports Collection 的集群， 这个集群会构建所有主要的 OS 版本在每一个 Tier-1 架构上的 package。 您可以在 package 构建和错误日志 找到其结果。

　　每一个 port 都会被构建， 除非标记为 IGNORE。 标记了 BROKEN 的 port 仍然会被继续尝试， 以了解是否某些依赖关系的变动解决了其问题 (这是通过给 port 的 Makefile 传 TRYBROKEN 参数来完成的)。

14.5 FreeBSD 的 Port Distfile 普查

　　构建集群是一组专门用于构建所有 ports 的最新的版本的机器， 其上已经下载所有的 distfile。 然而， 由于 Internet 在持续地发生变化， distfile 可能很快就消失了。 FreeBSD Ports distfiles 普查 试图查询每一个 port 的所有下载站点， 以期找出这些文件是否依然存在。 维护者应规律性地检查这些报告， 这不仅会提高用户构建的速度， 同时也避免了浪费那些镜像了全部 distfile 的志愿者的带宽。

14.6 FreeBSD 的 Ports 追踪系统

　　另一个非常方便的资源， 就是 FreeBSD Ports 追踪系统 (也被称作 portsmon)。 这个系统包含了一个处理若干信息来源的数据库， 并提供了一个可以通过 web 方式浏览的界面。 目前， 它利用到了和 ports 有关的问题报告 (PR)、 来自构建集群的错误日志， 以及来自 Ports Collection 的文件所提供的信息。 未来， 还会对它进行进一步的扩展， 从而提供包括 distfile 普查， 以及其它来源在内的更多信息。

　　要使用这个工具， 可以从查看关于某一个 port 的全部资料的 Port 的纵览 开始。

　　本文撰写时, 这是唯一一个能够将 GNATS PR 项， 同对应的 port 名字映射起来的资源。 (提交 PR 的用户， 有时并不在 Synopsis (概要) 中指明 port 的名字， 尽管我们希望他们这样做)。 因此， portsmon 在您想要查找是否有人提交某个现存的 port 的 PR， 以及它的构建是否出现了错误； 或在您创建新的 port 之前想要查找一下是否已经有人提交过时， 就非常有用了。