技术文档：Mac OS X（macOS）命令与选项键互换工具

本文档将为您详细介绍如何在Mac OS X（macOS）系统中使用命令与选项键互换工具，帮助您更好地理解并使用该项目。

1. 安装指南

1.1 系统要求

• macOS操作系统
• Xcode开发工具（用于编译项目）

1.2 安装步骤

1. 从GitHub上克隆项目代码：

   git clone https://github.com/frobware/cmd-key-happy.git
   

2. 切换到项目目录：

   cd cmd-key-happy
   

3. 编译项目：

   make
   

4. 安装项目（可能需要管理员权限）：

   sudo make install
   

5. 重启计算机以使更改生效。

2. 项目使用说明

本项目允许您在任何应用程序中互换命令键（cmd）和选项键（option），尤其是在Terminal.app中。这对于在使用Bash时进行SSH连接到其他UN*X系统盒子并运行"emacs -nw"非常有用。此外，它还允许您在使用Bash时，使传统的readline导航（例如alt-backspace、alt-f、alt-b等）正常工作。

2.1 功能特点

• 基于可自定义的Lua脚本进行键位互换
• 允许根据应用程序或全局排除特定键组合
• 支持在新版macOS上运行

2.2 使用方法

1. 启动应用程序，根据提示进行操作。

2. 根据需要自定义Lua脚本，以排除特定键组合。

3. 享受命令键与选项键互换带来的便利。

3. 项目API使用文档

本项目基于Lua脚本进行键位互换，用户可以根据需要自定义Lua脚本来实现特定的功能。

3.1 Lua脚本结构

Lua脚本主要包括以下几部分：

• 键位互换设置
• 排除键组合设置
• 功能函数

3.2 示例代码

以下是一个简单的Lua脚本示例：

-- 键位互换设置
keys = {
  cmd = "cmd",
  alt = "alt"
}

-- 排除键组合设置
exclusions = {
  ["cmd-tab"] = true,
  ["cmd-c"] = {app = "Terminal"},
  ["cmd-v"] = {app = "Terminal"}
}

-- 功能函数
function swap_keys(app_name)
  if app_name == "Terminal" then
    -- 在Terminal中互换命令键和选项键
    keys.cmd, keys.alt = keys.alt, keys.cmd
  end
end

4. 项目安装方式

本项目提供了以下几种安装方式：

1. 使用Xcode编译项目并安装。
2. 使用Homebrew安装（如果已添加相关 taps）。

请根据您的需求选择合适的安装方式。