From 21cc49bcc8fa1b3da9c975179ba4cf77d65c1ffc Mon Sep 17 00:00:00 2001 From: weixin_45932406 Date: Wed, 10 Sep 2025 15:15:42 +0800 Subject: [PATCH] fix readme Signed-off-by: zhaogan --- README_zh.md | 421 ++++++++++++++++++++++++--------------------------- 1 file changed, 199 insertions(+), 222 deletions(-) diff --git a/README_zh.md b/README_zh.md index ac3fb13..cd12d1e 100644 --- a/README_zh.md +++ b/README_zh.md @@ -15,8 +15,6 @@ foundation/bundlemanager/bundle_tool ### bm工具命令 - **表1** bm工具命令列表 - | 命令 | 描述 | | -------- | -------- | | help | 帮助命令，显示bm支持的命令信息。 | @@ -38,7 +36,7 @@ foundation/bundlemanager/bundle_tool | dump-target-overlay | 打印目标应用的所有关联overlay应用的overlayModuleInfo。 | -#### 帮助命令 +#### 帮助命令（help） ```bash bm help ``` @@ -49,74 +47,62 @@ bm help | ------- | ---------- | | bm help | 显示bm工具的能够支持的命令信息。 | -示例： - - -```bash -# 显示帮助信息 -bm help -``` - -#### 安装命令 +#### 安装命令（install） ```bash -bm install [-h] [-p filePath] [-u userId] [-r] [-w waitingTime] [-s hspDirPath] +bm install [-h] [-p filePath] [-r] [-w waitingTime] [-s hspDirPath] [-u userId] ``` -安装命令可以组合，下面列出部分命令。 + **安装命令参数列表** - **表3** 安装命令列表 - -| 命令 | 描述 | -| ----------------------------------- | -------------------------- | -| bm install -h | 显示install支持的命令信息。-h为非必选字段。 | -| bm install -p \ | 安装应用，支持指定路径和多个hap、hsp同时安装。安装应用时，-p为必选字段。 | -| bm install -p \ -u \ |给指定用户安装一个应用。-u非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下安装。
**说明：**
如果当前活跃用户是100，使用命令`bm install -p /data/app/ohos.app.hap -u 102`安装时，只会在当前活跃用户100下安装应用。 | -| bm install -p \ -r | 覆盖安装一个应用，-r为非必选字段，默认支持覆盖安装。 | -| bm install -p \ -r -u \ | 给指定用户覆盖安装一个应用。 | -| bm install -p \ -r -u \ -w \ | 安装时指定bm工具等待时间，-w非必选字段，最小的等待时长为180s，最大的等待时长为600s，默认缺省为5s。 | -| bm install -s \ | 安装应用间共享库， 每个路径目录下只能存在一个同包名的HSP。-s为安装应用间HSP时为必选字段，其他场景为可选字段。 | -| bm install -p \ -s \ | 同时安装使用方应用和其依赖的应用间共享库。 | +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -p | 可选参数，指定HAP路径，多HAP应用可指定多HAP所在文件夹路径。 | +| -r | 可选参数，覆盖安装一个HAP。默认值为覆盖安装。 | +| -s | 根据场景判断，安装应用间HSP时为必选参数，其他场景为可选参数。安装应用间共享库， 每个路径目录下只能存在一个同包名的HSP。 | +| -w | 可选参数，安装HAP时指定bm工具等待时间，最小的等待时长为5s，最大的等待时长为600s, 默认缺省为180s。 | +| -u | 可选参数，指定[用户](#userid)，默认在当前活跃用户下安装应用。仅支持在当前活跃用户或0用户下安装。
**说明：**
如果当前活跃用户是100，使用命令`bm install -p /data/local/tmp/ohos.app.hap -u 102`安装时，只会在当前活跃用户100下安装应用。 | 示例： ```bash # 安装一个hap -bm install -p /data/app/ohos.app.hap -# 在用户100下安装一个hap -bm install -p /data/app/ohos.app.hap -u 100 +bm install -p /data/local/tmp/ohos.app.hap +# 在100用户下安装一个hap +bm install -p /data/local/tmp/ohos.app.hap -u 100 # 覆盖安装一个hap -bm install -p /data/app/ohos.app.hap -r +bm install -p /data/local/tmp/ohos.app.hap -r # 安装一个应用间共享库 bm install -s xxx.hsp -# 同时安装多个应用间共享库 -bm install -s xxx.hsp yyy.hsp # 同时安装使用方应用和其依赖的应用间共享库 bm install -p aaa.hap -s xxx.hsp yyy.hsp +# 同时安装HAP和应用内共享库 +bm install -p /data/local/tmp/hapPath/ +# 安装一个hap,等待时间为180s +bm install -p /data/local/tmp/ohos.app.hap -w 180 ``` -#### 卸载命令 +#### 卸载命令（uninstall） ```bash -bm uninstall [-h] [-n bundleName] [-m moduleName] [-u userId] [-k] [-s] [-v versionCode] +bm uninstall [-h] [-n bundleName] [-m moduleName] [-k] [-s] [-v versionCode] [-u userId] ``` -命令可以组合，下面列出部分命令。 + **卸载命令参数列表** +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -n | 必选参数，指定Bundle名称卸载应用。| +| -m | 可选参数，应用模块名称，指定卸载应用的一个模块。默认卸载所有模块。 | +| -k | 可选参数，卸载应用时保存应用数据。默认卸载应用时不保存应用数据。 | +| -s | 根据场景判断，卸载应用间HSP时必选参数，其他场景为可选参数。卸载指定的共享库。| +| -v | 可选参数，指定共享包的版本号。默认卸载同包名的所有共享包。 | +| -u | 可选参数，指定[用户](#userid)，默认在当前活跃用户下卸载应用。仅支持在当前活跃用户或0用户下卸载应用。
**说明：**
如果当前活跃用户是100，使用命令`bm uninstall -n com.ohos.app -u 102`卸载时，只会在当前活跃用户100下卸载应用。 | - **表4** 卸载命令列表 - -| 命令 | 描述 | -| ----------------------------- | ------------------------ | -| bm uninstall -h | 显示uninstall支持的命令信息。-h为非必选字段。 | -| bm uninstall -n \ | 通过指定包名卸载应用。-n为必选字段。 | -| bm uninstall -n \ -u \| 通过指定包名和用户卸载应用。-u非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下卸载应用。
**说明：**
如果当前活跃用户是100，使用命令`bm uninstall -n com.ohos.app -u 102`卸载时，只会在当前活跃用户100下卸载应用。 | -| bm uninstall -n \ -u \ -k| 通过指定包名和用户以保留用户数据方式卸载应用。-k为非必选字段。 | -| bm uninstall -n \ -m \ | 通过指定包名卸载应用的一个模块。-m为非必选字段。 | -| bm uninstall -n \ -s | 卸载指定的shared bundle。-s为非必选字段，卸载共享库应用时为必选字段。 | -| bm uninstall -n \ -s -v \ | 卸载指定的shared bundle的指定版本。-v为非必选字段。 | 示例： @@ -135,44 +121,43 @@ bm uninstall -n com.ohos.example -s -v 100001 bm uninstall -n com.ohos.app -k ``` -#### 安装插件命令 +#### 安装插件命令（install-plugin） ```bash bm install-plugin [-h] [-n hostBundleName] [-p filePath] ``` -命令可以组合，下面列出部分命令。 - - - **表4** 安装插件命令列表 - -| 命令 | 描述 | -| ----------------------------- | ------------------------ | -| bm install-plugin -h | 显示install-plugin支持的命令信息。-h为非必选字段。 | -| bm install-plugin -n \ -p \| 通过指定主体应用包名和插件文件路径安装插件应用。-n为必选字段，-p为必选字段| +**install-plugin命令参数列表** +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -n | 必选参数，指定待安装插件的应用包名。| +| -p | 必选参数，指定插件文件路径。| 示例： ```bash # 安装一个插件 -bm install-plugin -n com.ohos.app -p /data/app/plugin.hsp +bm install-plugin -n com.ohos.app -p /data/plugin.hsp ``` +> **说明：** +> +> 在同一个应用中安装同一个插件，则视作插件版本更新，插件不支持降级安装；插件版本更新后，需要重启应用插件才能生效。 +> +> 不推荐安装与宿主应用模块同名的插件，目前运行态暂不支持。 -#### 卸载插件命令 +#### 卸载插件命令（uninstall-plugin） ```bash bm uninstall-plugin [-h] [-n hostBundleName] [-p pluginBundleName] ``` -命令可以组合，下面列出部分命令。 - - - **表4** 卸载插件命令列表 - -| 命令 | 描述 | -| ----------------------------- | ------------------------ | -| bm uninstall-plugin -h | 显示 uninstall-plugin 支持的命令信息。-h为非必选字段。 | -| bm uninstall-plugin -n \ -p \| 通过指定主体应用包名和插件应用包名卸载插件应用。-n为必选字段，-p为必选字段| +**uninstall-plugin命令参数列表** +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -n | 必选参数，指定应用包名。| +| -p | 必选参数，指定插件的包名。| 示例： @@ -181,28 +166,24 @@ bm uninstall-plugin [-h] [-n hostBundleName] [-p pluginBundleName] bm uninstall-plugin -n com.ohos.app -p com.ohos.plugin ``` -#### 查询应用信息命令 +#### 查询应用信息命令（dump） ```bash -bm dump [-h] [-a] [-g] [-n bundleName] [-s shortcutInfo] [-u userId] [-d deviceId] +bm dump [-h] [-a] [-g] [-n bundleName] [-s shortcutInfo] [-d deviceId] [-l label] [-u userId] ``` -命令可以组合，下面列出部分命令。 + **查询命令参数列表** - **表5** 查询命令列表 - -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm dump -h | 显示dump支持的命令信息。-h为非必选字段。 | -| bm dump -a | 查询系统已经安装的所有应用包名。-a为非必选字段。 | -| bm dump -a -u \ | 查询系统指定用户下已经安装的所有应用包名。-u为非必选字段，仅支持当前活跃用户或0用户下的查询。
**说明：**
如果当前活跃用户是100，使用命令`bm dump -a -u 102`查询时，只会返回当前活跃用户100下所有应用包名。 | -| bm dump -g | 查询系统中签名为调试类型的应用包名。-g为非必选字段。 | -| bm dump -n \ | 查询指定包名的详细信息。-n为非必选字段。 | -| bm dump -n \ -s | 查询指定包名下的快捷方式信息。-s为非必选字段。 | -| bm dump -n \ -d \ | 跨设备查询包信息。-d为非必选字段。 | -| bm dump -n \ -u \ | 查询指定用户下指定包名的详细信息。-u为非必选字段，仅支持当前活跃用户或0用户下的查询。
**说明：**
如果当前活跃用户是100，使用命令`bm dump -n com.ohos.app -u 102`查询时，只会返回当前活跃用户100下的应用信息。 | -| bm dump -n \ -l | 查询指定Bundle名称的label值（应用的名称）。-l为非必选字段。*注*：在命令行里输出的结果若包含特殊字符，可以在退出hdc shell命令行（`exit`）以后使用`chcp 65001`命令设置命令行的字符集。 | -| bm dump -a -l| 所有已安装应用的bundle名称和label值（应用的名称）。-l为非必选字段。*注*：在命令行里输出的结果若包含特殊字符，可以在退出hdc shell命令行（`exit`）以后使用`chcp 65001`命令设置命令行的字符集。 | +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -a | 可选参数，查询系统已经安装的所有应用。 | +| -g | 可选参数，查询系统中签名为调试类型的应用包名。 | +| -n | 可选参数，查询指定Bundle名称的详细信息。 | +| -s | 可选参数，查询指定Bundle名称下的快捷方式信息。 | +| -d | 可选参数，查询指定设备中的包信息。默认查询当前设备。 | +| -l | 可选参数，用于查询指定Bundle名称的label值（应用的名称），需要与`-n`或`-a`参数组合使用。
**说明**：
从API version 20开始支持该命令。如果在Windows环境下输出结果包含特殊字符或中文乱码，需在cmd控制台中手动执行命令`chcp 65001`，将cmd控制台编码修改为UTF-8。 | +| -u | 可选参数，查询指定[用户](#userid)下的应用信息，默认在当前活跃用户下查询应用信息。仅支持在当前活跃用户或0用户下查询。
**说明：**
如果当前活跃用户是100，使用命令`bm dump -n com.ohos.app -u 102`查询时，只会在当前活跃用户100下查询应用。 | 示例： @@ -210,122 +191,122 @@ bm dump [-h] [-a] [-g] [-n bundleName] [-s shortcutInfo] [-u userId] [-d deviceI ```bash # 显示所有已安装的Bundle名称 bm dump -a -# 显示用户0下所有已安装的Bundle名称 -bm dump -a -u 0 -# 显示当前活跃用户100下所有已安装的Bundle名称 -bm dump -a -u 100 # 查询系统中签名为调试类型的应用包名 bm dump -g # 查询该应用的详细信息 +bm dump -n com.ohos.app +# 在用户100下查询该应用的详细信息 bm dump -n com.ohos.app -u 100 # 查询该应用的快捷方式信息 -bm dump -s -n com.ohos.app -u 100 +bm dump -s -n com.ohos.app # 查询跨设备应用信息 bm dump -n com.ohos.app -d xxxxx # 查询该应用的label值（应用的名称） bm dump -n com.ohos.app -l -# 查询当前0用户下的应用信息 -bm dump -n com.ohos.app -u 0 -# 查询当前活跃用户100下的应用数据 -bm dump -n com.ohos.app -u 100 # 显示所有已安装应用的bundle名称和label值（应用的名称） bm dump -a -l ``` -#### 清理命令 +#### 清理命令（clean） ```bash -bm clean [-h] [-c] [-n bundleName] [-d] [-u userId] [-i appIndex] +bm clean [-h] [-c] [-n bundleName] [-d] [-i appIndex] [-u userId] ``` +**清理命令参数列表** + +| 参数 | 参数说明 | +| -------- | --------- | +| -h | 帮助信息。 | +| -c -n | -n为必选参数，-c为可选参数。清除指定Bundle名称的缓存数据。 | +| -d -n | -n为必选参数，-d为可选参数。清除指定Bundle名称的数据目录。 | +| -i | 可选参数，清除分身应用的数据目录。默认为0。| +| -u | 可选参数，清理指定[用户](#userid)下的数据，默认在当前活跃用户下清理数据。仅支持在当前活跃用户或0用户下清理数据。
**说明：**
如果当前活跃用户是100，使用命令`bm clean -c -n com.ohos.app -u 102`清理数据时，只会在当前活跃用户100下清理。 | - **表6** 清理命令列表 -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm clean -h | 显示clean支持的命令信息。-h为非必选字段。 | -| bm clean -n \ -c | 清除指定包名的缓存数据。-n为必选字段，-c为非必选字段。 | -| bm clean -n \ -d | 清除指定包名的数据目录。-d为非必选字段。 | -| bm clean -n \ -c -u \ | 清除指定用户下包名的缓存数据。-u为非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下缓存数据。
**说明：**
如果当前活跃用户是100，使用命令`bm clean -n com.ohos.app -c -u 102`缓存数据时，只会在当前活跃用户100下缓存数据。 | -| bm clean -n \ -d -u \ | 清除指定用户下包名的数据目录。 | -| bm clean -n \ -d -u \ -i \ | 清除指定用户下分身应用的数据目录。-i为非必选字段，默认为0。 | 示例： ```bash # 清理该应用下的缓存数据 +bm clean -c -n com.ohos.app +# 在用户100下清理该应用下的缓存数据 bm clean -c -n com.ohos.app -u 100 # 清理该应用下的用户数据 -bm clean -d -n com.ohos.app -u 100 -// 执行结果 +bm clean -d -n com.ohos.app +# 执行结果 clean bundle data files successfully. ``` -#### 使能命令 +#### 使能命令（enable） ```bash bm enable [-h] [-n bundleName] [-a abilityName] [-u userId] ``` - **表7** 使能命令列表 + **使能命令参数列表** -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm enable -h | 显示enable支持的命令信息。-h为非必选字段。 | -| bm enable -n \ | 使能指定包名的应用。-n为必选字段。 | -| bm enable -n \ -a \ | 使能指定包名下的元能力模块。-a为非必选字段。 | -| bm enable -n \ -u \| 使能指定用户和包名的应用。-u为非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下使能。
**说明：**
如果当前活跃用户是100，使用命令`bm enable -n com.ohos.app -u 102`使能应用时，只会在当前活跃用户100下使能应用。 | +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -n | 必选参数，使能指定Bundle名称的应用。 | +| -a | 可选参数，使能指定Bundle名称下的元能力模块。 | +| -u | 可选参数，使能指定[用户](#userid)下的应用，默认在当前活跃用户下使能应用。仅支持在当前活跃用户或0用户下使能应用。
**说明：**
如果当前活跃用户是100，使用命令`bm enable -n com.ohos.app -u 102`使能应用时，只会在当前活跃用户100下使能应用。 | 示例： ```bash # 使能该应用 -bm enable -n com.ohos.app -a com.ohos.app.EntryAbility -u 100 -// 执行结果 +bm enable -n com.ohos.app -a com.ohos.app.EntryAbility +# 在用户100下使能该应用 +bm enable -n com.ohos.app -u 100 +# 执行结果 enable bundle successfully. ``` -#### 禁用命令 +#### 禁用命令（disable） ```bash bm disable [-h] [-n bundleName] [-a abilityName] [-u userId] ``` - **表8** 禁用命令列表 + **禁用命令参数列表** -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm disable -h | 显示disable支持的命令信息。-h为非必选字段。 | -| bm disable -n \ | 禁用指定包名的应用。-n为必选字段。 | -| bm disable -n \ -a \ | 禁用指定包名下的元能力模块。-a为非必选字段。 | -| bm disable -n \ -u \| 禁用指定用户和包名下的应用。-u为非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下禁用。
**说明：**
如果当前活跃用户是100，使用命令`bm disable -n com.ohos.app -u 102`禁用应用时，只会在当前活跃用户100下禁用应用。 | +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -n | 必选参数，禁用指定Bundle名称的应用。 | +| -a | 可选参数，禁用指定Bundle名称下的元能力模块。 | +| -u | 可选参数，禁用指定[用户](#userid)下的应用，默认在当前活跃用户下禁用应用。仅支持在当前活跃用户或0用户下禁用应用。
**说明：**
如果当前活跃用户是100，使用命令`bm disable -n com.ohos.app -u 102`禁用应用时，只会在当前活跃用户100下禁用应用。 | 示例： ```bash # 禁用该应用 -bm disable -n com.ohos.app -a com.ohos.app.EntryAbility -u 100 -// 执行结果 +bm disable -n com.ohos.app -a com.ohos.app.EntryAbility +# 在用户100下禁用该应用 +bm disable -n com.ohos.app -u 100 +# 执行结果 disable bundle successfully. ``` -#### 获取udid命令 +#### 获取udid命令（get） ```bash bm get [-h] [-u] ``` - **表9** 获取udid命令列表 + **获取udid命令参数列表** -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm get -h | 显示get支持的命令信息。-h为非必选字段。 | -| bm get -u | 获取设备的udid。-u为必选字段。 | +| 参数 | 参数说明 | +| -------- | -------- | +| -h |帮助信息。 | +| -u | 必选参数，获取设备的udid。| 示例： @@ -333,30 +314,29 @@ bm get [-h] [-u] ```bash # 获取设备的udid bm get -u -// 执行结果 +# 执行结果 udid of current device is : 23CADE0C ``` -#### 快速修复命令 +#### 快速修复命令（quickfix） ```bash -bm quickfix [-h] [-a -f filePath [-t targetPath] [-d]] [-q -b bundleName] [-r -b bundleName] +bm quickfix [-h] [-a -f filePath [-t targetPath] [-d] [-o]] [-q -b bundleName] [-r -b bundleName] ``` -注：hqf文件制作方式可参考[HQF打包指令](packing-tool.md#hqf打包指令)。 + **快速修复命令参数列表** +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -a -f | -a为可选参数，指定-a后，-f为必选参数。执行快速修复补丁安装命令，file-path对应hqf文件，支持传递1个或多个hqf文件，或传递hqf文件所在的目录。 | +| -q -b | -q为可选参数，指定-q后，-b为必选参数。根据包名查询补丁信息。 | +| -r -b | -r为可选参数，指定-r后，-b为必选参数。根据包名卸载未使能的补丁。| +| -t | 可选参数，快速修复应用到指定目标路径。| +| -d | 可选参数，应用快速修复调试模式。| +| -o | 可选参数，应用快速修复覆盖模式，该模式下so将被解压覆盖到应用的so目录中。| - **表10** 快速修复命令列表 -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm quickfix -h | 显示quickfix支持的命令信息。-h为非必选字段。 | -| bm quickfix -a -f \ | 执行补丁安装命令。-a非必选字段，指定后，-f为必选字段，未指定-a，则-f为非必选字段。 | -| bm quickfix -q -b \ | 根据包名查询补丁包信息。-q为非必选字段，指定后，-b为必选字段，未指定-q，则-b为非必选字段。 | -| bm quickfix -a -f \ -d | 选择debug模式执行补丁安装命令。-d为非必选字段。 | -| bm quickfix -a -f \ -o | 选择覆盖模式执行补丁安装命令。-o为非必选字段。 | -| bm quickfix -a -f \ -t \ | 指定补丁安装目录，且不使能。-t为非必选字段。 | -| bm quickfix -r -b \ | 根据包名卸载未使能的补丁。-r为非必选字段，指定后，-b为必选字段，未指定-r，则-b为非必选字段。 | 示例： @@ -364,41 +344,41 @@ bm quickfix [-h] [-a -f filePath [-t targetPath] [-d]] [-q -b bundleName] [-r -b ```bash # 根据包名查询补丁包信息 bm quickfix -q -b com.ohos.app -// 执行结果 -// Information as follows: -// ApplicationQuickFixInfo: -// bundle name: com.ohos.app -// bundle version code: xxx -// bundle version name: xxx -// patch version code: x -// patch version name: -// cpu abi: -// native library path: -// type: +# 执行结果 +# Information as follows: +# ApplicationQuickFixInfo: +# bundle name: com.ohos.app +# bundle version code: xxx +# bundle version name: xxx +# patch version code: x +# patch version name: +# cpu abi: +# native library path: +# type: + # 快速修复补丁安装 bm quickfix -a -f /data/app/ -// 执行结果 +# 执行结果 apply quickfix succeed. # 快速修复补丁卸载 bm quickfix -r -b com.ohos.app -// 执行结果 +# 执行结果 delete quick fix successfully ``` -#### 共享库查询命令 +#### 共享库查询命令（dump-shared） ```bash -bm dump-shared [-h] [-a] [-n bundleName] [-m moduleName] +bm dump-shared [-h] [-a] [-n bundleName] ``` - **表11** 共享库查询命令列表 + **共享库查询命令参数列表** -| 命令 | 描述 | -| ------------------------------------------------ | -------------------------------------- | -| bm dump-shared -h | 显示dump-shared支持的命令信息。-h为非必选字段。 | -| bm dump-shared -a | 查询系统中已安装所有共享库。-a为非必选字段。 | -| bm dump-shared -n \ | 查询指定共享库包名的详细信息。-n为非必选字段。 | -| bm dump-shared -n \ -m \ | 查询指定共享库包名和模块名的详细信息。-m为非必选字段。 | +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -a | 可选参数，查询系统中所有已安装的共享库。| +| -n | 可选参数，查询指定包名的共享库详细信息。| 示例： @@ -410,42 +390,39 @@ bm dump-shared -a bm dump-shared -n com.ohos.lib ``` -#### 共享库依赖关系查询命令 +#### 共享库依赖关系查询命令（dump-dependencies） -显示指定应用和指定模块依赖的共享库信息 ```bash bm dump-dependencies [-h] [-n bundleName] [-m moduleName] ``` - **表12** 共享库依赖关系查询命令列表 -| 命令 | 描述 | -| ---------- | -------------------------- | -| bm dump-dependencies -h | 显示bm dump-dependencies支持的命令信息。-h为非必选字段。 | -| bm dump-dependencies -n \ | 查询指定应用依赖的共享库信息。-n为必选字段。 | -| bm dump-dependencies -n \ -m \ | 查询指定应用指定模块依赖的共享库信息。-m为非必选字段。 | +**共享库依赖关系查询命令参数列表** +| 参数 | 参数说明 | +| -------- | -------- | +| -h | 帮助信息。 | +| -n | 必选参数，查询指定应用依赖的共享库信息。| +| -m | 可选参数，查询指定应用指定模块依赖的共享库信息。| -* 示例 +示例： ```Bash -# 显示指定应用指定模块依赖的共享库信息 +# 查询指定应用指定模块依赖的共享库信息 bm dump-dependencies -n com.ohos.app -m entry ``` -#### 应用执行编译AOT命令 +#### 应用执行编译AOT命令（compile） -应用执行编译AOT命令 ```bash -bm compile [-h] [-m mode] [-r bundleName] +bm compile [-h] [-m mode] [-r bundleName] [-a] ``` - **表13** compile命令列表 +**compile命令参数列表** -| 命令 | 描述 | +| 参数 | 参数说明 | | -------- | -------- | -| bm compile -h| 显示compile支持的命令信息。-h为非必选字段。 | -| bm compile -m \| 根据包名编译应用。-m为非必选字段，可选值为partial或者full。 | -| bm compile -m \ -a| 编译所有应用。-a为非必选字段。 | -| bm compile -r -a| 移除所有编译应用的结果。-r为非必选字段。 | -| bm compile -r \| 移除应用的结果。 | +| -h | 帮助信息。 | +| -a | 可选参数，编译所有应用。| +| -m | 可选参数，可选值为partial或者full。根据包名编译应用。| +| -r | 可选参数，移除应用的结果。| 示例： @@ -454,21 +431,21 @@ bm compile [-h] [-m mode] [-r bundleName] bm compile -m partial com.example.myapplication ``` -#### 拷贝ap文件命令 +#### 拷贝ap文件命令（copy-ap） -拷贝ap文件到指定应用的/data/local/pgo路径 +拷贝ap文件到指定应用的/data/local/pgo路径。 ```bash bm copy-ap [-h] [-a] [-n bundleName] ``` -**表14** copy-ap命令列表 +**copy-ap命令参数列表** -| 命令 | 描述 | +| 参数 | 参数说明 | | -------- | -------- | -| bm copy-ap -h| 显示copy-ap支持的命令信息。-h为非必选字段。 | -| bm copy-ap -a| 拷贝所有包相关ap文件。-a为非必选字段。 | -| bm copy-ap -n \| 根据包名拷贝对应包相关的ap文件。-n为非必选字段。 | +| -h | 帮助信息。 | +| -a | 可选参数，默认所有包相关ap文件。拷贝所有包相关ap文件。| +| -n | 可选参数，默认当前应用包名。根据包名拷贝对应包相关的ap文件。| 示例： @@ -477,21 +454,20 @@ bm copy-ap [-h] [-a] [-n bundleName] bm copy-ap -n com.example.myapplication ``` -#### 查询overlay应用信息命令 +#### 查询overlay应用信息命令（dump-overlay） -打印overlay应用的overlayModuleInfo ```bash -bm dump-overlay [-h] [-b bundleName] [-m moduleName] [-u userId] [-t targetModuleName] +bm dump-overlay [-h] [-b bundleName] [-m moduleName] [-t targetModuleName] [-u userId] ``` -**表15** dump-overlay命令列表 -| 命令 | 描述 | +**dump-overlay命令参数列表** +| 参数 | 参数说明 | | -------- | -------- | -| bm dump-overlay -h| 显示dump-overlay支持的命令信息。-h为非必选字段。 | -| bm dump-overlay -b \| 获取指定应用的所有OverlayModuleInfo信息。-b为必选字段。 | -| bm dump-overlay -b \ -m \| 根据指定的包名和module名查询OverlayModuleInfo信息。-m为非必选字段。 | -| bm dump-overlay -b \ -t \| 根据指定的包名和目标module名查询OverlayModuleInfo信息。-t为非必选字段。 | -| bm dump-overlay -b \ -t \ -u \| 根据指定的包名\目标module名和用户查询OverlayModuleInfo信息。-u为非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下查询OverlayModuleInfo信息。
**说明：**
如果当前活跃用户是100，使用命令`bm dump-overlay -b com.ohos.app -t feature -u 102`查询时，只会返回当前活跃用户100下的OverlayModuleInfo信息。 | +| -h | 帮助信息。 | +| -b | 必选参数，获取指定Overlay应用的所有OverlayModuleInfo信息。| +| -m | 可选参数，根据指定Overlay特征module的名称查询OverlayModuleInfo信息，默认当前Overlay应用主模块名。| +| -t | 可选参数，根据指定目标module的名称查询OverlayModuleInfo信息，默认参数为空。| +| -u | 可选参数，在指定[用户](#userid)下查询OverlayModuleInfo信息，默认在当前活跃用户下查询。仅支持在当前活跃用户或0用户下查询。
**说明：**
如果当前活跃用户是100，使用命令`bm dump-overlay -b com.ohos.app -u 102`查询OverlayModuleInfo信息，只会返回当前活跃用户100下的OverlayModuleInfo信息。 | 示例： @@ -499,17 +475,17 @@ bm dump-overlay [-h] [-b bundleName] [-m moduleName] [-u userId] [-t targetModul # 根据包名来获取overlay应用com.ohos.app中的所有OverlayModuleInfo信息 bm dump-overlay -b com.ohos.app -# 根据包名和module来获取overlay应用com.ohos.app中overlay module为entry的所有OverlayModuleInfo信息 -bm dump-overlay -b com.ohos.app -m entry +# 在用户100下，根据包名来获取overlay应用com.ohos.app中的所有OverlayModuleInfo信息 +bm dump-overlay -b com.ohos.app -u 100 -# 根据包名和module来获取overlay应用com.ohos.app中目标module为feature的所有OverlayModuleInfo信息 -bm dump-overlay -b com.ohos.app -m feature +# 根据包名和module来获取overlay应用com.ohos.app中overlay module为libraryModuleName的所有OverlayModuleInfo信息 +bm dump-overlay -b com.ohos.app -m libraryModuleName -# 在用户100下，根据包名com.ohos.app和module来获取overlay应用com.ohos.app中目标module为feature的OverlayModuleInfo信息 -bm dump-overlay -b com.ohos.app -t feature -u 100 +# 根据目标包名和module来获取overlay应用com.ohos.app中目标module为entryModuleName的所有OverlayModuleInfo信息 +bm dump-overlay -b com.ohos.app -t entryModuleName ``` -#### 查询应用的overlay相关信息命令 +#### 查询应用的overlay相关信息命令（dump-target-overlay） 查询目标应用的所有关联overlay应用的overlayModuleInfo信息。 @@ -517,26 +493,27 @@ bm dump-overlay -b com.ohos.app -t feature -u 100 bm dump-target-overlay [-h] [-b bundleName] [-m moduleName] [-u userId] ``` -**表16** dump-overlay命令列表 -| 命令 | 描述 | +**dump-target-overlay命令参数列表** +| 参数 | 参数说明 | | -------- | -------- | -| bm dump-target-overlay -h| 显示dump-target-overlay支持的命令信息。-h为非必选字段。 | -| bm dump-target-overlay -b \ | 获取指定目标应用的所有OverlayBundleInfo信息。-b为必选字段。 | -| bm dump-target-overlay -b \ -m \ | 根据指定的目标应用的包名和module名查询OverlayModuleInfo信息。-m为非必选字段。 | -| bm dump-target-overlay -b \ -m \ -u \ | 根据指定的目标应用的包名、module名和用户查询OverlayModuleInfo信息。-u为非必选字段，默认为当前活跃用户。仅支持在当前活跃用户或0用户下查询OverlayModuleInfo信息。
**说明：**
如果当前活跃用户是100，使用命令`bm dump-target-overlay -b com.ohos.app -m feature -u 102`查询时，只会返回当前活跃用户100下的OverlayModuleInfo信息。 | +| -h | 帮助信息。 | +| -b | 必选参数，获取指定应用的所有OverlayBundleInfo信息。| +| -m | 可选参数，默认当前应用主模块名。根据指定的包名和module名查询OverlayModuleInfo信息。| +| -u | 可选参数，在指定[用户](#userid)下查询OverlayModuleInfo信息，默认在当前活跃用户下查询。仅支持在当前活跃用户或0用户下查询。
**说明：**
如果当前活跃用户是100，使用命令`bm dump-target-overlay -b com.ohos.app -u 102`查询目标应用com.ohos.app中的所有关联的OverlayBundleInfo信息，只会返回当前活跃用户100下的OverlayModuleInfo信息。 | 示例： ```bash # 根据包名来获取目标应用com.ohos.app中的所有关联的OverlayBundleInfo信息 -bm dump-target-overlay-b com.ohos.app +bm dump-target-overlay -b com.ohos.app + +# 在用户100下，根据包名来获取目标应用com.ohos.app中的所有关联的OverlayBundleInfo信息 +bm dump-target-overlay -b com.ohos.app -u 100 # 根据包名和module来获取目标应用com.ohos.app中目标module为entry的所有关联的OverlayModuleInfo信息 bm dump-target-overlay -b com.ohos.app -m entry - -# 在用户100下，根据包名和module来获取目标应用com.ohos.app中目标module为entry的所有关联的OverlayModuleInfo信息 -bm dump-target-overlay -b com.ohos.app -m entry -u 100 ``` + ## 相关仓 [bundlemanager_bundle_framework](https://gitee.com/openharmony/bundlemanager_bundle_framework) -- Gitee