Qt Installer Framework翻译(7-5)

操作

这些操作由组件和控制脚本准备,并由安装程序执行。

注意:操作是通过线程执行的。

在内部,每个操作都有一个DO步骤,包含有关安装程序的说明,以及一个UNDO步骤,包含有关卸载程序的说明。

操作总结

下表总结了可用的操作及其语法。

操作 语法 使用
Copy "Copy" source target 将文件从源拷贝到目标。
Move "Move" source target 将文件从源移动到目标。
SimpleMoveFile "SimpleMoveFile" source target 将文件从源移动到目标。
Delete "Delete" filename 删除filename指定的文件。
Mkdir "Mkdir" path 创建文件夹路径path
Rmdir "Rmdir" path 移除文件夹路径path
CopyDirectory "CopyDirectory" sourcePath targetPath 将目录从源路径复制到目标路径。
AppendFile "AppendFile" filename text 将文本追加到filename指定的文件中。 文本被视为ASCII文本。
PrependFile "PrependFile" filename text 将文本前插到filename指定的文件中。 文本被视为ASCII文本。
Replace "Replace" file search replace 打开文件以查找search字符串,然后将其替换为replace字符串。
LineReplace "LineReplace" file search replace 打开文件以查找以search字符串开头的行,并将其替换为replace字符串。 行在搜索之前会修剪(开头结尾处移除空白)。
Execute "Execute" [{exitcodes}] command [parameter1 [parameter... [parameter10]]] 执行command指定的命令。 最多可以传递10个参数。 如果这还不够,则可以使用JavaScript字符串数组。
可选的,您可以在大括号({})列出以逗号分隔的退出代码列表,并作为第一个参数进行传递,以指定成功执行时的退出代码。 默认为"{0}"。
其他可选的命名参数为:"workingdirectory="; "errormessage="
另外,一个特殊的参数,UNDOEXECUTE,将操作的DO步骤与UNDO步骤分开。
示例:component.addOperation("Execute", "touch", "test.txt", "UNDOEXECUTE", "rm", "test.txt")
CreateShortcut "CreateShortcut" filename linkname [arguments] 创建从filename指定的文件到linkname的快捷方式。在Windows上,这将创建一个可以包含参数的.lnk文件。此外,filename可以是HTTP或FTP URL,在这种情况下会创建URL快捷方式。当前该操作未在其他平台上实现。
CreateDesktopEntry "CreateDesktopEntry" filename "key=value[ key2=value2[ key3=value3]]]" 创建一个由freedesktop.org指定的.desktop初始化文件。 如果filename是绝对的,则桌面条目将存储在此处。否则,它将存储在$XDG_DATA_HOME/applications中指定的位置,包括由freedesktop.org定义的默认路径。 键值对将写入文件。该文件使用UTF-8编码。
InstallIcons "InstallIcons" directory [Vendorprefix] 将目录的内容安装到freedesktop.org指定的位置。也就是说,进入$XDG_DATA_HOME/icons或$HOME/.local/share/icons。文件将从其初始位置中删除。确保在从存档中提取文件的操作之后添加此操作。如果提供了Vendorprefix,它将使用该前缀替换图标文件名中第一个破折号(-)之前的所有字符。
Extract "Extract" archive targetdirectory 提取存档文件到目标文件夹
GlobalConfig "GlobalConfig" company application key valueor"GlobalConfig" scope company application key valueor"GlobalConfig" filename key value 将键值存储在配置文件中。配置文件可以通过文件名(使用QSettings::NativeFormat,这可能是Windows注册表)来指定,也可以通过应用程序和公司名称来指定。将范围设置为"SystemScope"以在系统范围中创建一个条目。
注意:该操作使用QSettings存储键值对。 QSettings始终将反斜杠视为特殊字符,并且不提供用于读取或写入此类条目的API。在节或键名中不要使用斜杠("/"和"");反斜杠字符用于分隔子键。在Windows上,QSettings将'\'转换为'/',从而使它们相同。由于QSettings使用反斜杠字符来分隔子键,因此您不能读取或写入包含斜杠或反斜杠的Windows注册表项。如果需要,您应该使用Windows系统原生API。
EnvironmentVariable "EnvironmentVariable" key value [persistent [system]] 将环境变量键key设置为值value。如果persistent设置为true,则变量将被永久设置。当前仅在Windows上支持。如果system设置为true,则永久变量将设置为系统范围的,而不仅仅是当前用户。请注意,如果将路径设置为环境变量,请使用'\'作为分隔符,例如:@Targetdir@\lib\system。
RegisterFileType "RegisterFileType" extension command [description [contentType [icon]]]. 用extension注册要通过command打开的文件类型。可选的,您可以指定描述,内容类型和图标。当前仅在Windows上支持。
ConsumeOutput "ConsumeOutput" installerKeyName executablePath processArguments 将运行带有参数processArguments的路径executePath上的可执行文件的输出保存到installerKeyName指定的安装程序键。可以传递其他参数。
CreateLink "CreateLink" linkPath targetPath 在linkPath指定的位置中创建一个链接,该链接指向targetPath指定的位置。
CreateLocalRepository "CreateLocalRepository" binaryPath repoPath 在repoPath指定的目录中创建本地存储库。对于离线安装程序,将二进制数据存储在binaryPath指定的目录中。
FakeStopProcessForUpdate "FakeStopProcessForUpdate" processlist 在卸载过程中,将正在运行的进程与进程列表processlist中以逗号分隔的条目进行匹配。如果找到匹配项,则会显示一个消息框,要求用户在继续之前停止这些进程。
License "License" licenses 将licenses指定的许可证文件复制到目标文件夹中名为Licenses的子文件夹。对于在包描述文件中声明的包,将自动添加此操作。
MinimumProgress "MinimumProgress" 将进度值增加一。
SelfRestart "SelfRestart" core 重启core指定的更新程序或包管理器。
Settings "Settings" path method key value 设置或删除位于路径path中的设置文件的键值key和value,依赖以下method的值:set, remove, add_array_value, and remove_array_value.

对于满足没有覆写component::createOperations()方法的组件,会自动添加Extract,License和MinimumProgress操作。另请参见component::autoCreateOperations。

如果发生错误,您可以使用devtool手动测试操作。但是,变量无法解析,因此您需要使用绝对值。

例如,要测试复制文件:

devtool --operation DO,Copy,<source>,<target>
上一篇:Qt Installer Framework翻译(7-4)


下一篇:Qt Installer Framework翻译(6-0)