XKB-SWITCH 技术文档

本文档旨在帮助用户安装、使用和深入了解 XKB-SWITCH 项目。以下是项目的安装指南、使用说明以及 API 使用文档。

安装指南

在开始安装之前，请确保您的系统中安装了 libxkbfile-dev（对于 Fedora 系统是 libxkbfile-devel）。

以下是手动编译程序的步骤：

1. 解压源代码压缩包并进入源代码目录。
2. 使用 nix-shell 或 nix-build 进行编译（针对 Nix 用户）。
3. 对于其他发行版，使用以下命令编译和安装程序：

$ mkdir build && cd build
$ cmake ..
$ make

可选地，运行 ./test.sh 脚本测试基本功能。脚本最后应输出 OK 并返回零退出码。

$ ../test.sh 2>&1 | tee test.log
$ tail -n 1 test.log | grep OK || echo "测试失败！"

为了系统范围的安装，使用系统包管理器或以下命令：

$ sudo make install                    # 系统范围安装
$ make DESTDIR=$HOME/.local install    # 用户安装

在某些发行版上，如果是第一次安装该程序，可能需要更新程序缓存：

$ sudo ldconfig

使用说明

以下是 xkb-switch 的命令行用法：

$ xkb-switch --help

使用：xkb-switch -s ARG            设置当前布局组为 ARG
       xkb-switch -l|--list         显示所有布局组
       xkb-switch -h|--help         显示此帮助信息
       xkb-switch -v|--version      显示版本号
       xkb-switch -w|--wait [-p]    等待组变化并退出
       xkb-switch -W                无限等待组变化
       xkb-switch -n|--next         切换到下一个布局组
       xkb-switch [-p]              显示当前布局组

注意：xkb-switch -x 命令行选项已被移除。请使用 setxkbmap -query 或 setxkbmap -print 获取调试信息。

项目 API 使用文档

Xkb-switch 提供了一个库 libxkbswitch.so，可以在 Vim 脚本中调用，如下所示：

let g:XkbSwitchLib = "/path/to/libxkbswitch.so"
echo libcall(g:XkbSwitchLib, 'Xkb_Switch_getXkbLayout', '')
call libcall(g:XkbSwitchLib 'Xkb_Switch_setXkbLayout', 'us')

项目安装方式

项目的安装方式已在“安装指南”部分中详细说明。请按照上述步骤进行操作。

以上内容将帮助用户顺利安装和使用 XKB-SWITCH 项目，并提供了相关的 API 文档以便更深入地使用该项目。