---
url: /zh/api/description/xpack-interfaces.md
---
# 打包接口 {#xpack-interfaces}

Xpack 作为插件形式提供，它的所有 API 我们需要通过 `includes("@builtin/xpack")` 方式来引入。

```lua
includes("@builtin/xpack")

xpack("test")
    set_version("1.0")
    set_homepage("https://xmake.io")
    add_installfiles("...")
```

## set\_version

* 设置包版本

#### 函数原型

::: tip API

```lua
set_version(version: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| version | 包版本字符串 |

#### 用法说明

这个接口用于设置生成的安装包的版本：

```lua
xpack("test")
    set_version("1.0")
    -- ...
```

如果我们没有设置，但是通过 `add_targets` 绑定了安装的目标程序，那么也会使用 target 中的版本配置。

```lua
target("foo")
    set_version("1.0")

xpack("test")
    add_targets("foo")
    -- ...
```

我们也可以使用全局工程的版本，如果没有绑定任何 targets。

```lua
set_version("1.0")

xpack("xmake")
    -- ...
```

## set\_homepage

* 设置主页信息

#### 函数原型

::: tip API

```lua
set_homepage(homepage: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| homepage | 主页地址字符串 |

#### 用法说明

```lua
xpack("xmake")
    set_homepage("https://xmake.io")
```

## set\_title

* 设置标题信息

#### 函数原型

::: tip API

```lua
set_title(title: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| title | 包标题字符串 |

#### 用法说明

通常用于配置安装包的简单描述，相比 `set_description` 更加简短。

```lua
xpack("xmake")
    set_title("Xmake build utility ($(arch))")
```

## set\_description

* 设置详细描述

#### 函数原型

::: tip API

```lua
set_description(description: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| description | 包详细描述字符串 |

#### 用法说明

这个接口可以设置安装包更加详细的描述信息，可以用一到两句话详细描述下包。

```lua
xpack("xmake")
    set_description("A cross-platform build utility based on Lua.")
```

## set\_author

* 设置作者信息

#### 函数原型

::: tip API

```lua
set_author(author: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| author | 作者信息字符串 |

#### 用法说明

我们可以设置邮箱，姓名等来描述这个包的作者。

```lua
xpack("xmake")
    set_author("waruqi@gmail.com")
```

## set\_maintainer

* 设置维护者信息

#### 函数原型

::: tip API

```lua
set_maintainer(maintainer: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| maintainer | 维护者信息字符串 |

#### 用法说明

我们可以设置邮箱，姓名等来描述这个包的维护者。

维护者跟作者有可能是同一个人，也可能不是一个人。

```lua
xpack("xmake")
    set_maintainer("waruqi@gmail.com")
```

## set\_copyright

* 设置包的版权信息

#### 函数原型

::: tip API

```lua
set_copyright(copyright: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| copyright | 版权信息字符串 |

#### 用法说明

```lua
xpack("xmake")
    set_copyright("Copyright (C) 2015-present, TBOOX Open Source Group")
```

## set\_license

* 设置包的 License

#### 函数原型

::: tip API

```lua
set_license(license: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| license | License名称字符串 |

#### 用法说明

目前像 srpm/rpm/deb 等包会用到，用于设置 License 名。

```lua
set_license("Apache-2.0")
```

## set\_licensefile

* 设置包的 License 文件

#### 函数原型

::: tip API

```lua
set_licensefile(licensefile: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| licensefile | License文件路径字符串 |

#### 用法说明

我们可以设置 LICENSE 所在的文件路径，像 NSIS 的安装包，它还会额外将 LICENSE 页面展示给安装用户。

```lua
xpack("xmake")
    set_licensefile("../LICENSE.md")
```

## set\_company

* 设置包所属的公司

#### 函数原型

::: tip API

```lua
set_company(company: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| company | 公司名称字符串 |

#### 用法说明

我们可以用这个接口设置包所属的公司和组织名。

```lua
xpack("xmake")
    set_company("tboox.org")
```

## set\_inputkind

* 设置打包的输入源类型

#### 函数原型

::: tip API

```lua
set_inputkind(inputkind: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| inputkind | 输入源类型: "binary" 或 "source" |

#### 用法说明

这是个可选接口，可用于标识当前打包的输入源类型

* binary: 从二进制文件作为输入源打包，通常使用 `add_installfiles`
* source: 从源文件作为输入源开始打包，通常使用 `add_sourcefiles`

这一般用于自定义的打包格式，而对于内置的格式，比如: nsis, zip, srczip 等等，
其实已经能够判断获取到当前打包的输入源是从源码开始打包，还是直接从二进制源开始打包。

因此，除非必要（比如要自定义打包格式），通常我们不需要设置它。

而我们在脚本域中，也可以通过 `package:from_source()` 和 `package:from_binary()` 来判断当前的输入源。

```lua
xpack("test")
    set_formats("nsis", "zip", "targz", "srczip", "srctargz", "runself")
    add_installfiles("src/(assets/*.png)", {prefixdir = "images"})
    add_sourcefiles("(src/**)")
    on_load(function (package)
        if package:from_source() then
            package:set("basename", "test-$(plat)-src-v$(version)")
        else
            package:set("basename", "test-$(plat)-$(arch)-v$(version)")
        end
    end)
```

如果上面的打包配置，如果是 nsis 包，默认从二进制文件作为输入源，进行打包，会去打包 `add_installfiles` 配置的文件。

而 `srczip`, `srctargz` 和 `runself` 是从源文件开始打包，会去打包 `add_sourcefiles` 中的文件，然后再执行打包脚本。

## set\_formats

* 设置打包格式

#### 函数原型

::: tip API

```lua
set_formats(formats: <string|array>, ...)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| formats | 打包格式名称字符串或数组 |
| ... | 可变参数，可传递多个格式名称 |

#### 用法说明

配置当前 XPack 包需要生成的打包格式，可以同时配置多个，`xmake pack` 命令会一次性全部生成。

::: tip 注意
有些格式如果当前平台不支持生成，会自动忽略。
:::

```lua
xpack("test")
    set_formats("nsis", "zip", "targz", "srczip", "srctargz", "runself")
```

我们也可以通过命令，指定生成其中部分格式，而不是一次性全部生成。

```sh
$ xmake pack -f "nsis,zip"
```

通过逗号分隔，指定生成 NSIS 和 zip 包，暂时忽略其他格式包。

目前支持的格式有：

| 格式     | 说明                              |
| ----     | ----                              |
| nsis     | Windows NSIS 安装包，二进制安装   |
| zip      | 二进制 zip 包，不包含安装脚本     |
| targz    | 二进制 tar.gz 包，不包含安装脚本  |
| srczip   | zip 源码包                        |
| srctargz | tar.gz 源码包                     |
| runself  | 自运行 shell 脚本包，源码编译安装 |
| rpm      | rpm 二进制安装包                  |
| srpm     | rpm 源码安装包                    |
| deb      | deb 二进制安装包 （待支持）       |
| 其他     | 可自定义格式和安装脚本            |

## set\_basename

* 设置包文件名

#### 函数原型

::: tip API

```lua
set_basename(basename: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| basename | 包文件名字符串（不含扩展名） |

#### 用法说明

设置生成包的文件名，但不包含后缀名。

```lua
xpack("xmake")
    set_basename("xmake-v$(version)")
```

我们也可以在其中配置 `$(version)`, `$(plat)`, `$(arch)` 等变量。

另外，想要更灵活的配置，可以再 on\_load 脚本中去配置它。

```lua
xpack("xmake")
    on_load(function (package)
        package:set("basename", "xmake-v" .. package:version())
    end)
```

## set\_extension

* 设置安装包的扩展名

#### 函数原型

::: tip API

```lua
set_extension(extension: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| extension | 包扩展名字符串 |

#### 用法说明

通常我们并不需要修改生成包的扩展名，因为指定了 `nsis`, `zip` 等格式后，都会有一个默认的后缀名，例如：`.exe`, `.zip`。

但是，如果我们正在自定义包格式，需要生成一个自定义的包，那么我们可能需要配置它。

```lua
xpack("mypack")
    set_format("myformat")
    set_extension(".myf")
    on_package(function (package)
        local outputfile = package:outputfile()
        -- TODO
    end)
```

例如，这里我们自定义了一个 myformat 包格式，采用 `.myf` 的自定义后缀名，然后我们就可以在 on\_package 中生成它，

`package:outputfile()` 返回的包输出文件名中就会包含这个后缀名。

## add\_targets

* 关联目标程序

#### 函数原型

::: tip API

```lua
add_targets(targets: <string|array>, ...)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| targets | 目标名称字符串或数组 |
| ... | 可变参数，可传递多个目标名称 |

#### 用法说明

我们可以通过这个接口，配置关联需要被安装的目标 target。

```lua
target("foo")
    set_kind("shared")
    add_files("src/*.cpp")
    add_headerfiles("include/(*.h)")

xpack("test")
    set_formats("nsis")
    add_targets("foo")
```

当生成 test 安装包的时候，被关联的 foo 目标的可执行程序，动态库等待都会被一起打包安装。
另外，target 中通过 `add_headerfiles` 和 `add_installfiles` 配置的自定义安装文件也会被打入安装包，一起被安装。

而且我们还可以在 target 和它的 rules 中通过 `on_installcmd`, `after_installcmd` 等自定义打包安装脚本，也会被一起执行。

## add\_components

* 添加安装包组件

#### 函数原型

::: tip API

```lua
add_components(components: <string|array>, ...)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| components | 组件名称字符串或数组 |
| ... | 可变参数，可传递多个组件名称 |

#### 用法说明

我们也支持为安装包添加自定义组件，按组件模式进行选择安装。目前仅仅对 NSIS 包会有比较的支持效果。

我们可以通过 `xpack_component()` 定义一个组件域，然后使用 `add_components()` 加指定的组件跟包进行关联绑定。

而在组件中，我们可以通过 `on_installcmd()` 编写一些自定义的安装脚本，只有当这个组件被启用的情况下，才会被执行安装。

```lua
xpack("test")
    add_components("LongPath")

xpack_component("LongPath")
    set_default(false)
    set_title("Enable Long Path")
    set_description("Increases the maximum path length limit, up to 32,767 characters (before 256).")
    on_installcmd(function (component, batchcmds)
        batchcmds:rawcmd("nsis", [[
  ${If} $NoAdmin == "false"
    ; Enable long path
    WriteRegDWORD ${HKLM} "SYSTEM\CurrentControlSet\Control\FileSystem" "LongPathsEnabled" 1
  ${EndIf}]])
    end)
```

这里，我们使用 `batchcmds:rawcmd("nsis", "...")` 添加了一个 nsis 特有的安装命令，开启长路径支持。效果如下：

![](/assets/img/manual/nsis_4.png)

只有当我们勾选 LongPath 后，才会启用，当然，我们也可以通过 `set_default()` 配置组件默认是否处于启用状态。

除了 NSIS 包，其他包尽管没有对组件有完善的支持，但是同样会执行组件里面的脚本实现打包，仅仅可能无法显示对应的组件 UI 和勾选框。

## set\_bindir

* 设置包的二进制安装目录

#### 函数原型

::: tip API

```lua
set_bindir(bindir: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| bindir | 二进制安装目录字符串 |

#### 用法说明

通常生成的安装包都会有一个安装根目录，而我们可以通过这个配置指定安装目录下的 bin 目录位置。

如果没有指定，默认在 `installdir/bin`。

如果配置了

```lua
xpack("xmake")
    set_bindir("mybin")
```

那么会将可执行文件安装在 `installdir/mybin` 下面，如果是 NSIS 包，安装后，还会自动设置此路径到 `%PATH%`。

## set\_libdir

* 设置包的库安装目录

#### 函数原型

::: tip API

```lua
set_libdir(libdir: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| libdir | 库安装目录字符串 |

#### 用法说明

通常生成的安装包都会有一个安装根目录，而我们可以通过这个配置指定安装目录下的 lib 目录位置。

如果没有指定，默认在 `installdir/lib`。

如果配置了

```lua
xpack("xmake")
    set_libdir("mylib")
```

那么会将静态库文件安装在 `installdir/mylib` 下面。

## set\_includedir

* 设置包的头文件安装目录

#### 函数原型

::: tip API

```lua
set_includedir(includedir: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| includedir | 头文件安装目录字符串 |

#### 用法说明

通常生成的安装包都会有一个安装根目录，而我们可以通过这个配置指定安装目录下的 include 目录位置。

如果没有指定，默认在 `installdir/include`。

如果配置了

```lua
xpack("xmake")
    set_includedir("myinc")
```

那么会将头文件安装在 `installdir/myinc` 下面。

## set\_prefixdir

* 设置包的安装前缀目录

#### 函数原型

::: tip API

```lua
set_prefixdir(prefixdir: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| prefixdir | 安装前缀目录字符串 |

#### 用法说明

如果配置了

```lua
xpack("xmake")
    set_prefixdir("prefix")
```

那么会将所有安装文件，安装在 `installdir/prefix` 下面，例如：

```
installdir
  - prefix
    - include
    - lib
    - bin
```

## set\_specfile

* 设置包 spec 文件路径

#### 函数原型

::: tip API

```lua
set_specfile(specfile: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| specfile | spec文件路径字符串 |

#### 用法说明

有些包格式的生成，需要先生成特定的 spec 文件，然后才能调用第三方打包工具去生成包。

比如 NSIS 包，需要先通过 xmake 根据 xpack 配置，生成 NSIS 特有的 `.nsi` 配置文件，然后 xmake 会再调用 `makensis.exe` 去根据这个 `.nsi` 文件生成 NSIS 包。

而 deb/rpm 等包都有特定的 spec 文件。

xmake 在打包的时候，默认会自动生成一个 spec 文件，但是如果我们想更加深度定制化一些特有包的配置，可以通过这个接口，

配置一个自己的 spec 文件，里面用户自己维护了一些包配置定义，然后可以在里面定义一些 `${PACKAGE_NAME}`, `${VERSION}` 包特有的内置变量，就可以实现包信息替换。

```lua
xpack("xmake")
    set_formats("nsis")
    set_specfile("makensis.nsi")
```

makensis.nsi

```
VIProductVersion                         "${VERSION}.0"
VIFileVersion                            "${VERSION}.0"
VIAddVersionKey /LANG=0 ProductName      "${PACKAGE_NAME}"
VIAddVersionKey /LANG=0 Comments         "${PACKAGE_DESCRIPTION}"
VIAddVersionKey /LANG=0 CompanyName      "${PACKAGE_COMPANY}"
VIAddVersionKey /LANG=0 LegalCopyright   "${PACKAGE_COPYRIGHT}"
VIAddVersionKey /LANG=0 FileDescription  "${PACKAGE_NAME} Installer - v${VERSION}"
VIAddVersionKey /LANG=0 OriginalFilename "${PACKAGE_FILENAME}"
```

下面是一些内置的常用包变量：

| 变量名 | 描述 |
| ------ | ---- |
| PACKAGE\_ARCH        | 包二进制文件的架构 |
| PACKAGE\_PLAT        | 包二进制文件的平台 |
| PACKAGE\_NAME        | 包名 |
| PACKAGE\_TITLE       | 包的简单描述 |
| PACKAGE\_DESCRIPTION | 包的详细描述 |
| PACKAGE\_FILENAME    | 包文件名 |
| PACKAGE\_AUTHOR      | 包作者 |
| PACKAGE\_MAINTAINER  | 包维护者 |
| PACKAGE\_HOMEPAGE    | 包主页地址 |
| PACKAGE\_COPYRIGHT   | 包的版权信息 |
| PACKAGE\_COMPANY     | 包所属的公司名 |
| PACKAGE\_ICONFILE    | 包的图标文件路劲 |
| PACKAGE\_LICENSEFILE | 包的 LICENSE 文件路径 |
| PACKAGE\_VERSION\_MAJOR | 包的 major 版本 |
| PACKAGE\_VERSION\_MINOR | 包的 minor 版本 |
| PACKAGE\_VERSION\_ALTER | 包的 alter 版本 |
| PACKAGE\_VERSION\_BUILD | 包的 build 版本 |

除了内置变量，我们也可以通过 `set_specvar` 接口去配置一些自定义的模版变量。

## set\_specvar

* 设置包 spec 文件的自定义变量

#### 函数原型

::: tip API

```lua
set_specvar(name: <string>, value: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| name | 变量名称字符串 |
| value | 变量值字符串 |

#### 用法说明

通常配合 `set_specfile` 接口一起使用，用于在自定义的 spec 模版文件里面，设置一些自定义的包变量。

```lua
xpack("xmake")
    set_formats("nsis")
    set_specfile("makensis.nsi")
    set_specvar("FOO", "hello")
```

makensis.nsi

```
VIAddVersionKey /LANG=0 ProductName      "${FOO}"
```

在生成包之前，xmake 会替换 `${FOO}` 成 hello，然后再调用 `makensis.exe` 命令根据这个文件生成 NSIS 安装包。

## set\_iconfile

* 设置图标文件路径

#### 函数原型

::: tip API

```lua
set_iconfile(iconfile: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| iconfile | 图标文件路径字符串 |

#### 用法说明

我们可以额外配置一个 ico 的图标文件，可以用于设置 NSIS 等一些支持图标自定义的安装包的图标。

```lua
xpack("xmake")
    set_iconfile("xmake.ico")
```

## add\_sourcefiles

* 添加源文件

#### 函数原型

::: tip API

```lua
add_sourcefiles(files: <string|array>, ..., {
    prefixdir = <string>,
    rootdir = <string>,
    filename = <string>
})
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| files | 源文件模式字符串或数组 |
| ... | 可变参数，可传递多个文件模式 |
| prefixdir | 安装前缀目录 |
| rootdir | 源文件根目录 |
| filename | 目标文件名 |

#### 用法说明

这通常用于源码包，也就是 `srczip`, `srctargz` 这种纯源码包，以及 `runself` 格式的源码安装包。

如果是自定义的包格式，我们需要配置 `set_inputkind("source")` 开启源码包。

通过这个接口，可以自定义配置那些源文件需要被打入包中，用于后期的编译安装。

它的详细用法跟 `add_installfiles` 类似，可以参考它的文档描述。

## add\_installfiles

* 添加二进制文件

#### 函数原型

::: tip API

```lua
add_installfiles(files: <string|array>, ..., {
    prefixdir = <string>,
    rootdir = <string>,
    filename = <string>
})
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| files | 安装文件模式字符串或数组 |
| ... | 可变参数，可传递多个文件模式 |
| prefixdir | 安装前缀目录 |
| rootdir | 源文件根目录 |
| filename | 目标文件名 |

#### 用法说明

这通常用于二进制包，也就是 `nsis`, `deb` 等格式的包，这些包会直接安装二进制文件。

因此，我们可以通过这个接口额外配置一些需要被安装的二进制文件，比如：可执行文件，资源文件等等。

比如我们可以指定安装各种类型的文件到安装目录：

```lua
xpack("test")
    add_installfiles("src/*.h")
    add_installfiles("doc/*.md")
```

我们也可以指定安装到特定子目录：

```lua
xpack("test")
    add_installfiles("src/*.h", {prefixdir = "include"})
    add_installfiles("doc/*.md", {prefixdir = "share/doc"})
```

上面的设置，我们会安装到`installdir/include/*.h`, `installdir/share/doc/*.md`。

注：默认安装不会保留目录结构，会完全展开，当然我们也可以通过`()`去提取源文件中的子目录结构来安装，例如：

```lua
xpack("test")
    add_installfiles("src/(tbox/*.h)", {prefixdir = "include"})
    add_installfiles("doc/(tbox/*.md)", {prefixdir = "share/doc"})
```

在 v3.1.0 之后，文件模式中的内置变量也会被展开，因此可以直接使用 `$(projectdir)`、`$(builddir)` 这类变量，以及 xpack 自身的 `$(version)` 等值。

```lua
xpack("test")
    set_version("1.0.0")
    add_installfiles("$(projectdir)/assets/(**.png)", {prefixdir = "share"})
    add_installfiles("$(builddir)/test-$(version).txt")
```

变量展开发生在解析 `()` 根目录标记之前，所以内置变量语法和路径分组语法可以正常共存。

## add\_buildrequires

* 添加包的构建依赖

#### 函数原型

::: tip API

```lua
add_buildrequires(requires: <string|array>, ...)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| requires | 构建依赖名称字符串或数组 |
| ... | 可变参数，可传递多个依赖名称 |

#### 用法说明

添加包的构建依赖，用于指定包构建时需要的依赖项。

这通常用于一些源码包，例如 srpm。这些源码包在安装之前，需要先构建源码，而构建源码可能会需要用到一些其他的依赖包。

我们可以通过这个接口去配置它们。

```lua
xpack("test")
    set_formats("srpm")
    on_load(function (package)
        local format = package:format()
        if format == "srpm" then
            package:add("buildrequires", "make")
            package:add("buildrequires", "gcc")
            package:add("buildrequires", "gcc-c++")
        end
    end)
    on_buildcmd(function (package, batchcmds)
        batchcmds:runv("make")
    end)
```

由于不同的安装包，它的依赖包名会有一些差异，所以我们需要在 on\_load 脚本域针对不同的包格式，去配置它们。

## on\_load

* 自定义加载脚本

#### 函数原型

::: tip API

```lua
on_load(script: <function (package)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 加载脚本函数，参数为package |

#### 用法说明

如果在描述域中配置无法满足我们的需求，还可以在 on\_load 自定义脚本域中，进一步灵活的配置包。

这个接口会在每个 XPack 包初始化加载期间就被调用，可以在里面做一些基础配置。

例如在里面动态地修改包文件名：

```lua
xpack("test")
    on_load(function (package)
        package:set("basename", "test-" .. package:version())
    end)
```

## before\_package

* 自定义打包之前的脚本

#### 函数原型

::: tip API

```lua
before_package(script: <function (package)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 打包前脚本函数，参数为package |

#### 用法说明

我们可以通过这个接口配置打包之前的自定义脚本。

```lua
xpack("test")
    before_package(function (package)
        -- TODO
    end)
```

## on\_package

* 自定义打包脚本

#### 函数原型

::: tip API

```lua
on_package(script: <function (package)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 打包脚本函数，参数为package |

#### 用法说明

自定义打包脚本，用于实现特定的打包逻辑。

我们可以通过这个接口配置打包自定义脚本，这将会重写整个内置的打包逻辑。通常用于自定义包格式。

```lua
xpack("test")
    set_formats("xxx")
    on_package(function (package)
        -- TODO
    end)
```

## after\_package

* 自定义打包之后的脚本

#### 函数原型

::: tip API

```lua
after_package(script: <function (package)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 打包后脚本函数，参数为package |

#### 用法说明

在打包完成后执行的自定义脚本，用于后处理操作。

我们可以通过这个接口配置打包之后的自定义脚本。

```lua
xpack("test")
    after_package(function (package)
        -- TODO
    end)
```

## before\_installcmd

* 添加安装之前的脚本

#### 函数原型

::: tip API

```lua
before_installcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 安装前脚本函数，参数为package和batchcmds |

#### 用法说明

在安装之前执行的自定义脚本，用于准备安装环境。

它不会重写整个安装脚本，但是会在现有的安装脚本执行之前，新增一些自定义的安装脚本：

```lua
xpack("test")
    before_installcmd(function (package, batchcmds)
        batchcmds:mkdir(package:installdir("resources"))
        batchcmds:cp("src/assets/*.txt", package:installdir("resources"), {rootdir = "src"})
        batchcmds:mkdir(package:installdir("stub"))
    end)
```

需要注意的是，通过 `batchcmds` 添加的 cp, mkdir 等命令都不会被立即执行，而是仅仅生成一个命令列表，后面实际生成包的时候，会将这些命令，翻译成打包命令。

## on\_buildcmd

* 自定义构建脚本

#### 函数原型

::: tip API

```lua
on_buildcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 构建脚本函数，参数为package和batchcmds |

#### 用法说明

自定义构建脚本，用于实现特定的构建逻辑。

对于一些源码构建包，在安装之前，我们需要先构建源码，例如 srpm 包。

因此，我们可以通过这个接口，自定义构建脚本，例如：

```lua
xpack("test")
    set_formats("srpm")
    add_sourcefiles("src/*.c")
    add_sourcefiles("./configure")
    on_buildcmd(function (package, batchcmds)
        batchcmds:runv("./configure")
        batchcmds:runv("make")
    end)
```

如果我们通过 add\_targets 关联了目标程序，即使我们没有配置 `on_buildcmd`，xpack 也会默认执行 `xmake build` 命令去构建它们。

```lua
xpack("test")
    set_formats("srpm")
    add_sourcefiles("src/*.c")
    add_sourcefiles("./xmake.lua")
```

另外，我们也可以使用 `add_buildrequires` 去配置一些构建依赖。

## before\_buildcmd

* 自定义构建之前的脚本

#### 函数原型

::: tip API

```lua
before_buildcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 构建前脚本函数，参数为package和batchcmds |

#### 用法说明

在构建之前执行的自定义脚本，用于准备构建环境。

通过这个接口，我们可以配置构建之前的脚本。

```lua
xpack("test")
    set_formats("srpm")
    before_buildcmd(function (package, batchcmds)
        -- TODO
    end)
```

## after\_buildcmd

* 自定义构建之后的脚本

#### 函数原型

::: tip API

```lua
after_buildcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 构建后脚本函数，参数为package和batchcmds |

#### 用法说明

在构建完成后执行的自定义脚本，用于后处理操作。

通过这个接口，我们可以配置构建之后的脚本。

```lua
xpack("test")
    set_formats("srpm")
    after_buildcmd(function (package, batchcmds)
        -- TODO
    end)
```

## on\_installcmd

* 自定义安装脚本

#### 函数原型

::: tip API

```lua
on_installcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 安装脚本函数，参数为package和batchcmds |

#### 用法说明

自定义安装脚本，用于实现特定的安装逻辑。

这回完全重写内置默认的安装脚本，包括内部对 `add_installfiles` 配置的文件的自动安装，用户需要完全自己处理所有的安装逻辑。

## after\_installcmd

* 添加安装之后的脚本

#### 函数原型

::: tip API

```lua
after_installcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 安装后脚本函数，参数为package和batchcmds |

#### 用法说明

在安装完成后执行的自定义脚本，用于后处理操作。

它不会重写整个安装脚本，但是会在现有的安装脚本执行之后，新增一些自定义的安装脚本：

```lua
xpack("test")
    after_installcmd(function (package, batchcmds)
        batchcmds:mkdir(package:installdir("resources"))
        batchcmds:cp("src/assets/*.txt", package:installdir("resources"), {rootdir = "src"})
        batchcmds:mkdir(package:installdir("stub"))
    end)
```

需要注意的是，通过 `batchcmds` 添加的 cp, mkdir 等命令都不会被立即执行，而是仅仅生成一个命令列表，后面实际生成包的时候，会将这些命令，翻译成打包命令。

## before\_uninstallcmd

* 添加卸载之前的脚本

#### 函数原型

::: tip API

```lua
before_uninstallcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 卸载前脚本函数，参数为package和batchcmds |

#### 用法说明

在卸载之前执行的自定义脚本，用于准备卸载环境。

跟 before\_installcmd 类似，请参考 before\_installcmd 说明。

## on\_uninstallcmd

* 自定义卸载脚本

#### 函数原型

::: tip API

```lua
on_uninstallcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 卸载脚本函数，参数为package和batchcmds |

#### 用法说明

自定义卸载脚本，用于实现特定的卸载逻辑。

跟 on\_installcmd 类似，请参考 on\_installcmd 说明。

## after\_uninstallcmd

* 添加卸载之后的脚本

#### 函数原型

::: tip API

```lua
after_uninstallcmd(script: <function (package, batchcmds)>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| script | 卸载后脚本函数，参数为package和batchcmds |

#### 用法说明

在卸载完成后执行的自定义脚本，用于后处理操作。

跟 after\_installcmd 类似，请参考 after\_installcmd 说明。

## set\_nsis\_displayicon

* 设置 NSIS 的显示图标

#### 函数原型

::: tip API

```lua
set_nsis_displayicon(iconfile: <string>)
```

:::

#### 参数说明

| 参数 | 描述 |
|------|------|
| iconfile | 图标文件路径字符串 |

#### 用法说明

这是一个 NSIS 专有 API，可以用于配置 NSIS 的显示图标：

```lua
xpack("test")
    set_nsis_displayicon("bin/foo.exe")
```

我们需要配置带有 icon 的可执行文件路径，这是使得安装包的显示 icon 跟它保持一致。

这是一个可选配置，即使我们不配置它，xmake 也会默认使用被关联的 target 中的可执行文件中图标。