i3-quickterm 开源项目安装与使用指南
项目概述
i3-quickterm 是一个专为 i3 和 sway 窗口管理器设计的小巧弹出式终端。它允许用户快速启动自定义的终端 emulator,并通过 dmenu 或 rofi 实现shell选择,适应不同的屏幕宽度和多显示器环境。
目录结构及介绍
以下是对项目主要目录和文件的简要说明:
i3-quickterm/
│
├── setup.py # 项目设置文件,用于打包发布
├── README.md # 项目介绍和快速入门文档
├── LICENSE.txt # 许可证文件
├── requirements-dev.txt # 开发所需的依赖库列表
├── ruff.toml # 代码规范配置文件
├── setup.cfg # 配置文件,用于Python包的配置
├── i3-quickterm # 主程序文件夹
│ └── ... # 包含主程序逻辑的Python文件
├── tests # 测试代码目录
│ └── ... # 各种测试案例
├── typings # 类型定义或接口文件,可能是与i3ipc相关的
│ └── i3ipc # 具体类型定义
└── gitignore # Git忽略文件配置
项目启动文件介绍
setup.py: 这个文件是Python项目的关键构建脚本,包含了项目的元数据(如版本、描述、作者信息等)以及如何打包和分发项目到PyPI这样的仓库。用户通常不需要直接交互这个文件来使用i3-quickterm,但它对开发者来说非常重要,因为它控制了安装过程和项目的部署。
启动i3-quickterm并非直接执行某个Python脚本,而是通过命令行工具安装后,使用i3绑定或者直接命令调用来激活。例如,安装后可以通过以下i3配置绑定启动它:
bindsym $mod+p exec i3-quickterm
项目的配置文件介绍
i3-quickterm的配置读取来自用户的配置目录下的特定文件,默认路径可以是~/.config/i3-quickterm/config.json
或 ~/.config/i3/i3-quickterm.json
。这些配置文件允许用户自定义如下选项:
- menu: 指定使用的菜单应用,需兼容dmenu。
- term: 默认的终端模拟器。
- history: 保存最近使用的shell记录的文件路径,设置为null可禁用历史记录。
- ratio: 终端窗口占据屏幕高度的百分比。
配置示例:
{
"menu": "dmenu",
"term": "urxvt",
"history": "~/.config/i3-quickterm/history.txt",
"ratio": 0.5
}
确保修改配置前已理解各参数含义,并依据个人偏好定制。通过这种方式,用户可以根据自己的工作流程调整i3-quickterm的行为。