Trawl

简单 Xresources 风格的基于 Linux 的配置系统，与发行版/显示后端（Wayland / X11 等）无关。

构建说明

请确保已安装 Rust 工具链（版本 >= 1.62）。使用以下命令构建所有二进制文件

git clone https://github.com/regolith-linux/trawl.git
cd trawl
make

注意 1：将 cargo build 替换为 cargo build --release 以在发布模式下构建二进制文件。

注意 2：二进制文件位于 target/debug 目录中（如果以发布模式构建，则为 target/release）。

注意 3：首次运行 make setup 命令时会失败。这是因为在此步骤中生成 dbus-interface 的代码。您可以忽略此错误并继续以下命令。

安装说明

git clone https://github.com/regolith-linux/trawl.git
cd trawl
# enable the "install" target in the Makefile
make install
systemctl daemon-reload
systemctl enable --now trawld

注意：首次运行 make setup 命令时会失败。这是因为在此步骤中生成 dbus-interface 的代码。您可以忽略此错误并继续以下命令。

特性

• Xresources 像的基于文件的配置系统。
• 与现有的 Xresources 文件兼容。
• 独立于显示后端和发行版。
• 轻量级且 简单 易用。
• 使用 DBus 会话总线 建立IPC。这允许每个用户运行他们自己的配置管理器实例。

用法

将二进制文件前缀为构建目录路径（target/debug 或 target/release）以使用，无需安装。

资源文件/配置文件格式

• 资源文件中的每一行都是一个由冒号（':')分隔的键值对。例如：

  key1: value1
  key2: value2
  

• 有效的键是一个没有空格的ASCII字母数字字符串，但可以包含以下特殊字符 — ' - ', ' . ', ' _ '。例如：

  sway-wm.screen_timeout: 100
  

• 如果一行中包含多个冒号（':'), 则第一个冒号之前的内容被视为键，第一个冒号之后的内容被视为值。例如：

  swaywm.workspace.1.name: 1: Shell
  

• 值可以是任何UTF-8字符串。
• 注释以'//'开头，将被忽略。
• 默认情况下，预处理指令（以'#'开头）由C预处理程序处理。如果指令不被识别，则会被忽略。
• 预处理指令可以用于包含其他文件。指令的形式为 #include <file>。文件相对于资源文件。

  #include <config.d/swayidle>
  

• 预处理指令可以用于定义宏。指令的形式为 #define <macro> <value>。宏是一个字符串，值也是一个字符串。宏在资源文件中定义。

  #define USERNAME "John Doe"
  

• 与C语言类似，资源文件的部分可以使用 #ifdef 和 ifndef 指令有条件地忽略或包含。

  #ifdef USERNAME
  swaylock.greeter.user USERNAME // USERNAME is replaced with John Doe
  #endif
  

启动配置管理器（trawld）

运行 trawld 以启动配置守护进程。您可以向守护进程传递可选参数以自定义行为或更改日志级别。运行 trawld --help 获取更多信息。

使用CLI客户端（《em>trawldb）

CLI客户端允许用户与配置管理器交互。客户端的主要功能包括从文件加载配置。运行 trawldb --help 获取更多信息。

示例

1. 加载文件

   # load a file (doesn't overwrite existing resources)
   trawldb --load example/resources
   # load a file without preprocessing
   resrdb --load example/resources --nocpp
   

2. 合并来自文件的资源

   # merge resource from a file (overrides existing resources)
   trawldb --merge example/resources
   # merge resource from a file without preprocessing
   trawldb --merge example/resources --nocpp
   

3. 将当前加载的资源保存到文件

   # if file exists it is backed up to a file with the same name but with a .bak extension
   trawldb --edit all_resources
   # specify suffix for -edit [.bak]
   trawldb --edit all_resources --backup .old
   

4. 查询资源

   # query all resources
   trawldb --query
   # query a specific resource (partial matches are also shown)
   trawldb --query key1
   

5. 获取资源值

   # get the value for the resouource whose name is 'key1'
   trawldb --get key1
   

获取资源值（trawlcat）

trawlcat 是 xrescat 的直接替代品，并打印请求的资源值。更多详细信息，请参阅 (xrerscat) 文档。

C语言客户端API

DBus接口的头文件和实现文件在 service.xml 文件中自动生成，在 meson 构建期间。 client_api.h 头文件提供了一个简单的封装API。所有DBus方法名称均为蛇形命名法，并以前缀 conf_client 开头。

Rust客户端库

在 Cargo.toml 文件中包含 trawldb crate。然后，您可以使用Rust客户端库与配置管理器交互。

[dependencies]
trawldb = { path = "/path/to/trawldb" }