create-dmg 使用与技术文档

1. 安装指南

使用 Homebrew 安装

首先，确保您的系统中已经安装了 Homebrew。如果尚未安装，可以访问 Homebrew 官网 了解安装方法。安装 Homebrew 后，在终端中运行以下命令安装 create-dmg：

brew install create-dmg

手动安装

1. 访问 create-dmg 的最新发布页面，下载最新版本的 create-dmg。
2. 将下载的文件解压，然后在终端中进入解压后的文件夹。
3. 运行以下命令安装：

make install

克隆仓库

您也可以直接克隆整个仓库并在本地运行：

git clone https://github.com/create-dmg/create-dmg.git

2. 使用说明

使用 create-dmg 创建 DMG 文件的基本命令格式如下：

create-dmg [选项 ...] <输出文件名.dmg> <源文件夹>

源文件夹 中的所有内容将被复制到 DMG 映像中。

选项

• --volname <名称>：设置卷名称（在 Finder 侧边栏和窗口标题中显示）
• --volicon <图标.icns>：设置卷图标
• --background <图片.png>：设置文件夹背景图片（提供 png、gif、jpg 格式）
• --window-pos <x> <y>：设置文件夹窗口位置
• --window-size <宽度> <高度>：设置文件夹窗口大小
• --text-size <字体大小>：设置窗口文本大小（10-16）
• --icon-size <图标大小>：设置窗口图标大小（最大 128）
• --icon <文件名> <x> <y>：设置文件图标位置
• --hide-extension <文件名>：隐藏文件的扩展名
• --app-drop-link <x> <y>：创建指向 Applications 的拖放链接，位于 x, y 位置
• --ql-drop-link <x> <y>：创建指向 /Library/QuickLook 的拖放链接，位于 x, y 位置
• --eula <许可文件>：将许可文件附加到 DMG
• --rez <Rez 路径>：指定 Rez 工具的自定义路径，用于包含许可文件
• --no-internet-enable：禁用自动挂载和复制
• --format：指定最终映像格式（UDZO|UDBZ|ULFO|ULMO）（默认为 UDZO）
• --filesystem：指定映像文件系统（HFS+|APFS）（默认为 HFS+，APFS 支持 macOS 10.13 或更高版本）
• --encrypt：为生成的磁盘映像启用加密（AES-256 - 将在压缩阶段提示输入密码）
• --encrypt-aes128：为生成的磁盘映像启用加密（AES-128 - 将在压缩阶段提示输入密码）
• --add-file <目标名称> <文件|文件夹> <x> <y>：添加额外的文件或文件夹（可多次使用）
• --disk-image-size <x>：手动设置磁盘映像大小为 x MB
• --hdiutil-verbose：以详细模式执行 hdiutil
• --hdiutil-quiet：以静默模式执行 hdiutil
• --bless：祝福挂载文件夹（已弃用，需要 macOS 12.2.1 或更低版本，#127）
• --codesign <签名>：使用指定的签名对磁盘映像进行签名
• --notarize <凭证>：使用存储在钥匙串中的凭证对磁盘映像进行公证（等待并盖章）
• --skip-jenkins：跳过 Finder 美化 AppleScript，在沙盒和非 GUI 环境中很有用，#72
• --sandbox-safe：hdiutil 沙盒兼容性，不祝福，不执行美化 AppleScript（APFS 磁盘映像不支持）
• --version：显示工具版本号
• -h, --help：显示帮助

3. 项目 API 使用文档

create-dmg 的命令行选项即为项目提供的 API，具体使用方法已在“使用说明”部分详细描述。

4. 项目安装方式

请参考上文“安装指南”部分，介绍了使用 Homebrew 安装、手动安装以及克隆仓库的三种安装方式。