Velox 项目技术文档

1. 安装指南

依赖项

在安装 Velox 之前，请确保系统中已安装以下依赖项：

• swc：Velox 基于 swc 构建，因此需要先安装 swc。
• xkbcommon：用于键盘映射。
• wayland：用于窗口管理。

安装步骤

1. 克隆仓库：

   git clone https://github.com/your-repo/velox.git
   cd velox
   

2. 编译项目：

   make
   

3. 安装：

   sudo make install
   

4. 配置文件： 安装完成后，Velox 会自动搜索配置文件。默认情况下，它会先查找 ${HOME}/.velox.conf，然后是 /etc/velox.conf。

2. 项目的使用说明

启动 Velox

在终端中运行以下命令启动 Velox：

velox

基本操作

• 切换标签：使用配置文件中定义的快捷键切换标签。
• 移动窗口：通过选择不同屏幕上的标签，可以将窗口移动到其他屏幕。
• 关闭窗口：使用快捷键关闭当前聚焦的窗口。

配置文件

Velox 的配置文件是一个文本文件，格式简单。每行由一个命令和相应的参数组成。常见的命令包括 set、action、key、button 和 rule。

示例配置

set window.border_width 2
action my_action spawn xterm
key a ctrl:alt focus_next
rule title st tag.2.apply

3. 项目API使用文档

配置文件命令

set 命令

用于设置属性的值。

set <property> <value>

例如：

set window.border_color_active #ffffff

action 命令

创建一个新的动作，可以通过快捷键触发。

action <identifier> <type> <type-specific-arguments>

例如：

action my_action spawn xterm

key 命令

注册一个快捷键绑定。

key <keysym> <modifier-list> <action-when-pressed>[:<action-when-released>]

例如：

key a ctrl:alt focus_next

button 命令

与 key 命令类似，但用于鼠标按钮。

button <button> <modifier-list> <action-when-pressed>[:<action-when-released>]

例如：

button left ctrl:alt focus_next

rule 命令

创建一个新的规则，用于匹配新创建的窗口。

rule <type> <identifier> action

例如：

rule title st tag.2.apply

4. 项目安装方式

源码安装

1. 克隆仓库：

   git clone https://github.com/your-repo/velox.git
   cd velox
   

2. 编译项目：

   make
   

3. 安装：

   sudo make install
   

配置文件

安装完成后，Velox 会自动搜索配置文件。默认情况下，它会先查找 ${HOME}/.velox.conf，然后是 /etc/velox.conf。

启动 Velox

在终端中运行以下命令启动 Velox：

velox

通过以上步骤，您可以成功安装并使用 Velox 窗口管理器。