配置文件

配置文件自定义了安装程序的 UI 和行为。文件通常称为 config.xml 并位于 config 目录中。

最小配置文件由一个具有 <Name> 和 <Version> 子元素作为子元素的 <Installer> 根元素组成。所有其他元素都是可选的，可以按任意顺序出现。

以下是一个典型的配置文件示例。

<?xml version="1.0"?>
<Installer>
    <Name>Some Application</Name>
    <Version>1.0.0</Version>
    <Title>Some Application Setup</Title>
    <Publisher>Your Company</Publisher>
    <ProductUrl>http://www.your-fantastic-company.com</ProductUrl>
    <InstallerWindowIcon>installericon</InstallerWindowIcon>
    <InstallerApplicationIcon>installericon</InstallerApplicationIcon>
    <Logo>logo.png</Logo>
    <Watermark>watermark.png</Watermark>
    <RunProgram>@TargetDir@/YourAppToRun</RunProgram>
    <RunProgramArguments>
        <Argument>Argument 1</Argument>
        <Argument>Argument 2</Argument>
    </RunProgramArguments>
    <RunProgramDescription>My nice application</RunProgramDescription>
    <StartMenuDir>Some Application Entry Dir</StartMenuDir>
    <MaintenanceToolName>SDKMaintenanceTool</MaintenanceToolName>
    <AllowNonAsciiCharacters>true</AllowNonAsciiCharacters>
    <Background>background.png</Background>

    <TargetDir>@HomeDir@/testinstall</TargetDir>
    <AdminTargetDir>@RootDir@/testinstall</AdminTargetDir>
    <RemoteRepositories>
        <Repository>
            <Url>http://www.your-repo-location/packages/</Url>
        </Repository>
    </RemoteRepositories>
    <AliasDefinitionsFile>aliases.xml</AliasDefinitionsFile>
</Installer>

配置文件元素摘要

以下表格总结了配置文件中的元素。

注意： 我们建议将配置文件中提到的所有文件放置在 config 目录中。但是，您也可以使用相对路径，工具将相对路径解析为 config.xml 文件的当前位置。

注意： 引用文件的文件名必须是唯一的。也就是说，如果您想为 <Logo> 和 <Watermark> 使用相同的图像，您必须添加两个带有不同文件名的图像文件副本。

您可以使用预定义变量（嵌入 @ 字符中）作为元素的值。有关更多信息，请参阅预定义变量。

元素	描述
Name	要安装的产品名称。这是必需的。
Version	以下格式的产品安装版本：[0-9]+((\.\|-)[0-9]+)* 例如 1-1; 1.2-2; 3.4.7。这是必需的。
Title	需要在标题栏上显示的安装程序名称。
Publisher	软件的发布者（如图形显示在 Windows 控制面板中）。
ProductUrl	指向包含您的网站上产品信息的页面的 URL。
InstallerApplicationIcon	自定义安装程序图标的文件名。通过在文件名附加 '.icns'（macOS）、'.ico'（Windows）后缀来查找实际文件。在 Unix 上没有功能。
InstallerWindowIcon	用于安装程序应用程序的 PNG 格式自定义窗口图标的文件名。在 Windows 和 Linux 上使用，在 macOS 上没有功能。
Logo	用作 `QWizard::LogoPixmap` 的 PNG 格式标志的文件名。
Watermark	用作 `QWizard::WatermarkPixmap` 的 PNG 格式水印的文件名。如果 `<WizardShowPageList>` 设置为 `true`，则水印被隐藏。
Banner	用作 `QWizard::BannerPixmap` 的 PNG 格式横幅的文件名（仅由 ModernStyle 使用）。
Background	用作 `QWizard::BackgroundPixmap` 的 PNG 格式背景图像的文件名（仅由 MacStyle 使用）。如果 `<WizardShowPageList>` 设置为 `true`，则背景被隐藏。
PageListPixmap	在安装程序页面列表上方显示的 PNG 格式图像的文件名。如果 `<WizardShowPageList>` 也设置为 `true`，则显示图像。
向导风格	设置要使用的向导风格（"现代", "Mac", "Aero" 或 "经典"）。
样式表	设置样式表文件。
向导默认宽度	设置向导的默认宽度（以像素为单位）。设置横幅图像将覆盖此设置。您可以将 `em` 或 `ex` 后缀添加到指定值以使用 em 或 ex 单位，就像在 CSS 文件中一样。
向导默认高度	设置向导的默认高度（以像素为单位）。设置水印图像将覆盖此设置。您可以将 `em` 或 `ex` 后缀添加到指定值以使用 em 或 ex 单位，就像在 CSS 文件中一样。
向导最小宽度	设置向导的最小宽度（以像素为单位）。您可以将 `em` 或 `ex` 后缀添加到指定值以使用 em 或 ex 单位，就像在 CSS 文件中一样。
向导最小高度	设置向导的最小高度（以像素为单位）。您可以将 `em` 或 `ex` 后缀添加到指定值以使用 em 或 ex 单位，就像在 CSS 文件中一样。
向导显示页面列表	如果要在向导的左侧不显示小部件安装页面，请设置为 `false`。默认为 `true`。如果可见，此小部件将在 `QWizard::ClassicStyle` 和 `QWizard::ModernStyle` 上隐藏 `QWizard::WatermarkPixmap`，在 `QWizard::MacStyle` 上隐藏 `QWizard::BackgroundPixmap`。
产品图像	要在 `PerformInstallationPage` 上显示的图像列表。此元素可以有一个或多个 `<ProductImage>` 子元素，其中包含一个 `<Image>` 子元素和一个可选的 `<Url>` 子元素。The `<Image>` 元素指定了一个 PNG 格式的图像的文件名。对于每个图像都可以指定可选的 `<Url>`。点击图像将在浏览器中打开 `<Url>`。如果 `<Url>` 是对文件的引用，它将以合适的应用程序打开，而不是网页浏览器。
标题颜色	设置标题和副标题的颜色（接受 HTML 颜色代码，例如 "#88FF33"）。
运行程序	如果用户接受操作，则在安装程序完成后执行的命令。提供应用程序的完整路径。
运行程序参数	传递给 `<RunProgram>` 中指定的程序的参数。您可以添加多个 `<Argument>` 子元素，每个子元素指定一个 `<RunProgram>` 参数。
运行程序描述	运行程序旁边的文本，在安装后运行程序。如果设置了 `<RunProgram>` 但没有提供描述，UI 将显示立即运行 <名称>。
开始菜单目录	产品在 Windows 开始菜单中的默认程序组名称。
目标目录	安装的默认目标目录。在 Linux 上，这通常是用户的家目录。
管理员目标目录	带管理员权限安装的默认目标目录。仅在 Linux 上可用，您通常不想在管理员用户的家目录中安装。
本地缓存目录	存储元数据缓存的目录名称。这不包括自动根据存储缓存文件的合适平台特定位置确定的引导目录。用户可以从安装程序设置中覆盖路径。默认值是从安装的产品名称生成的 UUID。
持久本地缓存	如果要从本地缓存中删除获取的元数据，请设置为 `false`。否则，为了加速后续获取，将保持缓存内容。默认为 `true`。
远程仓库	远程仓库列表。此元素可以包含多个 `<Repository>` 子元素，每个子元素都包含一个 `<Url>` 子元素，指定访问仓库的URL。有关更多信息，请参阅配置仓库。
仓库类别	可以包含一系列 `<RemoteRepositories>` 子元素的类别名称。有关更多信息，请参阅配置仓库类别。
维护工具名称	生成的维护工具的文件名。默认为 maintenancetool。追加特定平台的可执行文件扩展名。
维护工具ini文件	为生成的维护工具配置的文件名。默认为 MaintenanceToolName.ini。
维护工具别名	维护工具别名的文件名，将创建到应用程序目录中。可选。仅在macOS上使用。
移除目标目录	如果应在卸载时不应删除目标目录，则设置为 `false`。
允许非ASCII字符	如果安装路径可以包含非ASCII字符，则设置为 `true`。
禁用授权回退	如果应在出现授权错误时立即中止安装而不是提示用户运行授权回退，则设置为 `true`。
禁用命令行界面	如果应禁用命令行界面功能，则设置为 `true`。这阻止用户将任何消费者命令（如 `install`、`update` 和 `remove`）传递给安装程序。其他选项仍可按常规使用。默认为 `false`。
仓库设置页面可见	若要隐藏设置对话框中的仓库设置页面，请设置为 `false`。
允许为离线安装程序使用仓库	若要禁用使用任何临时或用户配置的仓库（离线安装程序设置的仓库），则设置为 `false`。由离线安装程序编写的维护工具仍可以访问仓库。默认为 `true`。
允许路径中包含空格	如果安装路径不能包含空格字符，则设置为 `false`。
依赖于本地安装程序二进制文件	如果您想禁止从外部资源（例如网络驱动器）安装，则设置为 `true`。这对于非常大的安装程序可能是有意义的。此选项仅在Windows上使用。
目标配置文件	目标上的配置文件的文件名。默认为 components.xml。
别名定义文件	包含组件别名定义的XML文档的文件名。有关如何在文件中声明组件别名的信息，请参阅别名定义文件。
翻译	要用于翻译用户界面的翻译文件列表。要添加多个翻译文件，请指定多个 `<Translation>` 子元素，每个子元素指定一个翻译的名称。可选。有关更多信息，请参阅翻译页面和配置和覆盖默认翻译。
URL查询字符串	此字符串需要采用 "key=value" 的形式，并将附加到存档下载请求中。这可用于将信息传输到托管仓库的web服务器。
控制脚本	自定义安装程序控制脚本的文件名。请参阅控制器脚本。
创建本地仓库	若要在安装目录内创建本地仓库，请设置为 `true`。此选项对在线安装程序没有效果。该仓库将自动添加到默认仓库列表中。
安装操作列可见	设置为 `true` 以在组件树中添加一个显示安装操作的额外列。该额外列指示一个组件是否将要安装或卸载，或者只是保持安装或卸载状态。
SupportsModify	如果产品不支持修改现有安装，则设置为 `false`。
SaveDefaultRepositories	如果默认仓库 `<RemoteRepositories>` 应该不保存到 MaintenanceToolName.ini 中，则设置为 `false`。默认情况下会保存仓库。不保存仓库意味着在运行 maintenancetool 时将不会使用默认仓库。
AllowUnstableComponents	如果允许安装不稳定组件，则设置为 `true`。组件如果缺少依赖项、脚本中存在错误等，则视为不稳定。不稳定组件在组件树中会变灰色，因此无法选择。默认情况下，该值设置为 `false`，这意味着如果发现不稳定组件，安装将被终止。

命令行界面包目录