pkgmogrify

- 映像包管理系统清单变换程序

用法概要

/usr/bin/pkgmogrify [-vi] [-I includedir ...]
    [-D macro=value ...] [-O outputfile]
    [-P printfile] [inputfile ...]

描述

pkgmogrify 允许对软件包清单进行编程式编辑，以简化自动生成软件和自动发布软件包时所需的典型变换。

pkgmogrify 提供：

• 宏替换，以便于在各种体系结构和平台间共享单个清单。

• 包含其他清单或清单片段，例如标准组件和变换。

• 变换软件包操作，包括修改、删除或添加操作属性。

选项

支持以下选项：

-D name= value

将 name 定义为一个宏，其值为 value。宏在输入文件中显示为 $(macro)。将重复执行替换操作，直到再也找不到变换。常见用语包括：

• 通过在行的开头使用特定于体系结构的标记来删除其他体系结构清单中的行。

  $(sparc_ONLY)file ...

  处理 SPARC 体系结构时，该宏将被设置为空字符串。而处理其他体系结构时，该宏在命令行中会被设置为 #，从而从当前体系结构的清单中删除此操作。

• 指定路径名称中特定于平台的部分，例如，可执行文件和库的 64 位体系结构目录的名称：

  file NOHASH path=usr/bin/$(ARCH64)/cputrack ...

  应当将这些宏设置为命令行中所需的值。不存在预定义的宏值。

-I include_directory

将指定目录添加到在命令行中和在嵌入式 include 指令中指定的文件的搜索路径中。

-O outputfile

将清单输出写入指定的文件中。如果出现错误或 transform 指令引起中止操作，则不会写入该文件。缺省情况下，清单输出会写入 stdout。

-P printfile

将 transform 指令输出操作生成的输出写入指定的文件。如果出现错误或 transform 指令引起中止操作，则不会写入该文件。缺省情况下，输出会写入 stdout。

-i

忽略文件中的 include 指令。仅处理在命令行（或 stdin）中指定的文件。

-v

将注释写入显示变换效果的输出清单。该信息可以帮助调试。

--help 或 -?

显示用法消息。

嵌入式指令

清单文件支持两种类型的指令：include 指令和 transform 指令。

Include 指令的格式为：

<include file>

该指令能够使 pkgmogrify 首先在当前目录中搜索名为 file 的文件，然后在 -I 选项指定的目录中搜索该文件。如果找到，则会将该文件的内容插入清单中遇到该指令的位置。如果未找到，pkgmogrify 将退出并显示错误。

Transform 指令的格式为：

<transform matching-criteria -> operation>

这些指令会进行累积（直到将所有输入都读入内存中），然后按遇到这些指令的顺序应用到操作。

匹配条件的格式为：

[action-type ... ] [attribute=<value-regexp> ...]

必须匹配其中一个指定的 action-types。必须匹配所有指定的 attributes。使用的正则表达式语法是 Python 语法。有关 Python 正则表达式语法的更多信息，请使用命令 pydoc re 或参见 http://docs.python.org/dev/howto/regex.html 中的更完整文档。该正则表达式固定于开头而非结尾。因此，通过文件扩展名进行匹配的正则表达式匹配文件必须包含前导 .*，且应当包含尾随 $。

可以指定多个条件，以空格分隔。

有以下操作可用：

add

将值添加到属性中。此操作使用两个参数。第一个参数是属性的名称，第二个参数是对应值。

default

如果不存在属性值，则设置该属性值。此操作与 add 操作使用相同的两个参数。

delete

删除属性值。此操作使用两个参数。第一个参数是属性的名称。第二个参数是要与删除的属性值匹配的正则表达式。与用于匹配操作的正则表达式不同，该正则表达式并不是固定的。

drop

放弃该操作。

edit

修改操作的属性。此操作使用三个参数。第一个参数是属性的名称，第二个参数是与属性值匹配的正则表达式。第三个参数是用于替换正则表达式匹配的部分值的替换字符串。与用于匹配操作的正则表达式不同，该正则表达式并不是固定的。如果在正则表达式中定义了组，则在替换字符串中可以使用 \1、\2 等格式的一般正则表达式向后引用。

emit

向清单输出流中发出一行。此行必须是有效操作字符串、为空（导致空白行）或注释（ # 后面跟有任意文本）。

exit

终止清单处理过程。不输出任何清单，也不应用任何 print 操作。如果给定一个参数，该参数必须是整数并且用作退出代码。缺省为 0。如果给定两个参数，则第一个参数是退出代码，第二个参数是要输出到 stderr 的消息。

print

将消息输出到 -P 指定的输出文件中。

set

设置属性的值。此操作与 add 操作使用相同的两个参数。

除了 delete 和 drop 以外的所有操作都使用其内容输出到输出流的参数（可能是可选的）。这些字符串可能包含三种不同类型的特殊标记，这些标记允许输出包含不基于每种操作的固定变换的信息。

第一种替换通过将属性的名称放置在括号内（跟随在百分号后面），允许操作引用当前操作的属性值。例如，%(alias) 引用操作的 alias 属性的值。

存在几个合成属性。以下两个对 pkgmogrify 而言是唯一的：

• pkg.manifest.filename 引用在其中找到操作的文件的名称。

• pkg.manifest.lineno 引用在其中找到操作的行。

以下三个合成属性类似于 pkg(1) 中使用的属性：

• action.hash 引用操作的散列值（如果该操作携带有效负荷）。对于携带有效负荷的操作， set 操作可以通过对 action.hash 属性进行操作来更改该操作的散列。

• action.key 引用关键属性的值。

• action.name 引用操作类型的名称。

如果请求其值的属性不存在，pkgmogrify 将退出并显示错误。为防止出现错误退出，请在属性名称后面附加 ;notfound= 以及要用于替换属性值的值。例如，如果存在 alias 属性，则 %(alias;notfound='no alias') 输出该属性的值，否则输出 no alias。

如果请求其值的属性具有多个值，则输出每个值，以空格隔开。与 notfound 标记类似，标记 prefix、suffix 和 sep 也可用于更改此行为。由 prefix 表示的字符串放置在每个值之前，由 suffix 表示的字符串放置在每个值之后，而 sep 放置在某个值的后缀与下一个值的前缀之间。

与操作属性类似，pkgmogrify 指令也可以使用花括 （而非圆括号）引用 件包属性：%{pkg.fmri}。应用 transform 指令时，必须已在 set 操作中定义了属性，否则会将其视为 notfound，如上所述。当处理过程到达清单文件（介绍软件包）的结尾处时，将清除下一个软件包的属性。

这不仅在将软件包属性视为操作属性来引用方面，而且在匹配甚至暂时修改这些属性方面，都很有用。因此，在这些情况下都可以使用合成属性名称 pkg（仅在 pkgmogrify 上下文中）。

如果 pkgmogrify 完成读取在命令行中指定的清单并且该清单定义了 pkg.fmri 软件包属性，pkgmogrify 会创建此合成 pkg 操作，其属性为软件包的属性。<transform> 指令随后会对此操作进行匹配（正如任何其他操作类型一样）。

pkg 操作中的操作是特殊的，它们仅在内存中进行，不会直接影响发出的清单。例如，尝试通过 add、default 或 set 操作设置 pkg 操作的属性时，不会使 set 操作添加到清单中，虽然该操作将可用于其他 <transform> 指令进行匹配。尝试 emitpkg 操作会导致错误。要添加软件包属性，改为 emitset 操作。

第三种替换是逆向引用功能。该替换与在 edit 操作中可使用的替换不同，它是对 -> 左侧的变换匹配中列出组的引用。它们由 %<1>、 %<2> 等表示（以在匹配条件中显示的顺序）。

处理顺序如下所示：

1. 从输入文件中读取行。

2. 应用宏。

3. 处理 <include ...> 和 <transform> 指令，从而找到并读取更多文件。

4. 累积所有输入之后，输出中的每行都会转换为操作并应用所有变换。

5. 成功完成处理后，写入输出。

示例

示例 1 将标记添加到 SMF 清单中

将标记添加到服务管理工具 (Service Management Facility, SMF) 清单中，以便在活动系统上安装软件包时导入这些标记。

<transform file path=(var|lib)/svc/manifest/.*\.xml -> \
    add restart_fmri svc:/system/manifest-import:default>

示例 2 移动文件

将文件从 usr/sfw/bin 移至 usr/bin。

<transform file -> edit path usr/sfw/bin usr/bin>

示例 3 指定需要重新引导

将 reboot-needed 标记添加到 /kernel 下 .conf 文件以外的文件中。请注意，以下示例利用了按照在输入文件中看见的顺序将变换应用到每个操作的方式。

<transform file path=kernel/.* -> set reboot-needed true>
<transform file path=kernel/.*\.conf -> delete reboot-needed .*>

这还可以通过包含正则表达式的单个变换规则完成。

示例 4 将 FMRI 属性转换为 Depend 操作

将软件包属性 pkg.fmri 转换为 depend 操作，使其成为集合的一部分。

<transform set name=pkg.fmri -> \
    emit depend type=incorporate fmri=%(value)>
<transform set name=pkg.fmri -> drop>

示例 5 输出错误编号列表

输出带有双引号和前缀的错误编号的逗号分隔列表。

set name=bugs value=12345 value=54321 value=13579 value=97531
<transform set name=bugs -> \
    print %(value;sep=",";prefix="bug='";suffix="'")>

示例 6 允许丢失属性

即使是在丢失属性时，也可以安全输出消息。

<transform driver -> print Found aliases: %(alias;notfound=<none>)>

示例 7 设置缺省值

设置缺省所有者、组以及权限的值。

<transform file dir -> default owner root>
<transform file dir -> default group bin>
<transform file -> default mode 0444>
<transform dir -> default mode 0755>

示例 8 将依赖项添加到未标记为已过时的软件包中

对于未标记为已过时的任何软件包，为提供软件包的合并添加集合的依赖项。必须在读入清单后执行该组变换，否则始终发出依赖项。因为修改 pkg 操作不会永久起作用，所以无需清除匹配 pkg.obsolete=false 的属性。

<transform pkg -> default pkg.obsolete false>
<transform pkg pkg.obsolete=false -> emit depend \
    fmri=consolidation/$(CONS)/$(CONS)-incorporation type=require>

示例 9 发现问题时退出并输出消息

在清单中发现已过时属性时退出并输出错误消息。

<transform file dir link hardlink opensolaris.zone=.* -> \
    exit 1 The opensolaris.zone attribute is obsolete.>

示例 10 设置合适的语言环境侧面

设置适用于正在考虑的路径名称的语言环境侧面。

<transform dir file link hardlink path=.*/locale/([^/]+).* -> \
    default facet.locale.%<1> true>

退出状态

将返回以下退出值：

0

一切正常工作。

1

出现预料中的错误情况。

2

指定的命令行选项无效。

99

意外的处理错误。

文件

/usr/share/pkg/transforms

该目录包含使用有用变换设置侧面、执行器和其他属性的文件。

属性

有关下列属性的说明，请参见 attributes(5)：

另请参见

pkg(1)、pkg(5)

http://hub.opensolaris.org/bin/view/Project+pkg/