keyd 项目安装与使用教程

1. 项目目录结构及介绍

keyd 项目的目录结构如下：

keyd/
├── data/
├── docs/
├── examples/
├── layouts/
├── scripts/
├── src/
├── .gitattributes
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
└── TODO

目录介绍

• data/: 存放项目的数据文件。
• docs/: 存放项目的文档文件。
• examples/: 存放项目的示例配置文件。
• layouts/: 存放键盘布局文件。
• scripts/: 存放项目的脚本文件。
• src/: 存放项目的源代码文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍文件。
• TODO: 项目待办事项文件。

2. 项目启动文件介绍

keyd 项目的启动文件是 keyd.service，它是一个 systemd 服务文件，用于在系统启动时自动启动 keyd 服务。

keyd.service 文件内容

[Unit]
Description=A key remapping daemon for linux

[Service]
ExecStart=/usr/local/bin/keyd
Restart=always

[Install]
WantedBy=multi-user.target

启动 keyd 服务

1. 安装 keyd：

   git clone https://github.com/rvaiya/keyd
   cd keyd
   make && sudo make install
   

2. 启动 keyd 服务：

   sudo systemctl enable keyd
   sudo systemctl start keyd
   

3. 项目配置文件介绍

keyd 的配置文件位于 /etc/keyd/default.conf，配置文件的格式如下：

[ids]
*

[main]
# 将 CapsLock 映射为 Escape 和 Control
capslock = overload(control, esc)

# 将 Escape 键映射为 CapsLock
esc = capslock

配置文件说明

• [ids]: 定义键盘设备的 ID，* 表示匹配所有设备。
• [main]: 定义主配置，包括按键映射和功能定义。

常用配置示例

[ids]
*

[main]
# 将 CapsLock 映射为 Escape 和 Control
capslock = overload(control, esc)

# 将 Escape 键映射为 CapsLock
esc = capslock

# 将左 Shift 键设置为 oneshot Shift
leftshift = oneshot(shift)

重新加载配置

修改配置文件后，可以通过以下命令重新加载配置：

sudo keyd reload

查看配置错误

如果配置文件有错误，错误信息会记录在系统日志中，可以通过以下命令查看：

sudo journalctl -eu keyd

通过以上步骤，您可以成功安装、配置并启动 keyd 项目，实现按键的自定义映射。