statnot 技术文档

本文档将详细介绍如何安装、使用以及配置 statnot 项目。

1. 安装指南

首先，您需要安装以下依赖项：

• Python 3.5 或更高版本
• dbus-python
• PyGObject
• gtk3（不用于 GUI 支持）

请按照PyGObject 安装说明在您的系统上安装这些依赖项。

接下来，调整 config.mk 文件中的目标目录以适应您的设置。

安装时，以 root 用户身份运行以下命令：

# make install

最后，确保 statnot 与窗口管理器一起启动。您可以将以下内容添加到 .xinitrc 文件中：

killall notification-daemon &> /dev/null
statnot &

请注意，statnot 需要是唯一运行的通知工具。上述示例确保 notification-daemon 不在运行。

2. 项目的使用说明

statnot 可以作为 lightweight window managers（如 dwm 和 wmii）的通知守护进程替代品。它接收并显示遵循 Desktop Notifications 规范的通知。

您可以通过将以下内容添加到 .xinitrc 文件中，来启动 statnot：

killall notification-daemon &> /dev/null
statnot &

3. 项目API使用文档

statnot 的配置主要通过修改 $HOME/.statusline.sh 脚本和传递给 statnot 的配置文件来完成。

• $HOME/.statusline.sh 脚本用于定义状态栏上显示的消息格式。
• 通过命令行传递给 statnot 的配置文件可以覆盖默认设置。

配置文件示例：

# 默认通知显示时间（除非在通知中指定）
DEFAULT_NOTIFY_TIMEOUT = 3000  # 毫秒

# 通知允许显示的最大时间
MAX_NOTIFY_TIMEOUT = 5000  # 毫秒

# 通知中允许的最大字符数
NOTIFICATION_MAX_LENGTH = 100  # 字符数

# 状态更新间隔时间
STATUS_UPDATE_INTERVAL = 2.0  # 秒

# 获取状态文本的命令
import os
STATUS_COMMAND = ['/bin/sh', f'{os.getenv("HOME")}/.statusline.sh']

# 是否总是显示来自 STATUS_COMMAND 的文本
USE_STATUSTEXT = True

# 是否将传入的通知放入队列中，以便逐个显示
QUEUE_NOTIFICATIONS = True

# 更新文本的函数
def update_text(text):
    # 获取第一行
    first_line = text.splitlines()[:-1]
    subprocess.call(["xsetroot", "-name", first_line])

4. 项目安装方式

请参考安装指南部分的内容，以下为简要步骤：

• 安装依赖项
• 调整 config.mk 文件中的目标目录
• 以 root 用户身份运行 make install
• 确保 statnot 与窗口管理器一起启动

通过以上步骤，您可以成功安装并使用 statnot 项目。