clock-rs

一个在现代终端中轻松运行的现代数字时钟。

目录

• 简介
• 安装
• 使用方法
• 配置
  • 字段
  • 示例
• 贡献
• 许可

简介

clock-rs 是一个用 Rust 编写的基于终端的时钟，旨在成为 tty-clock 的新替代品。它提供了一些改进，包括

• 使用单个配置文件来管理其设置，并通过命令行覆盖它们的能力，
• 许多附加功能，如计时器和秒表，
• 以及更大的灵活性和更好的用户体验！

安装

要使用 Cargo 全局安装 clock-rs，只需运行 $ cargo install clock-rs。然后您可以通过 clock-rs 命令运行可执行文件。

使用方法

Usage: clock-rs [OPTIONS] [COMMAND]

Commands:
  clock      Display the current time (default)
  timer      Create a timer
  stopwatch  Start a stopwatch
  help       Print this message or the help of the given subcommand(s)

Options:
  -c, --color <COLOR>        Specify the clock color
  -x, --x-pos <X_POS>        Set the position along the horizontal axis
  -y, --y-pos <Y_POS>        Set the position along the vertical axis
      --fmt <FMT>            Set the date format
  -t                         Use the 12h format
  -i, --interval <INTERVAL>  Set the polling interval in milliseconds
      --utc                  Use UTC time
  -s, --hide-seconds         Do not show seconds
  -B, --blink                Set the colon to blink
  -b, --bold                 Use bold text
  -h, --help                 Print help
  -V, --version              Print version

[!注意] 如果未指定命令，则默认使用 clock 命令。
因此，运行 $ clock-rs clock 或简单地 $ clock-rs 都会显示当前时间。

要退出应用程序，请按 Escape、q 或 Ctrl-C。

配置

clock-rs 使用 TOML 文件格式进行其设置。
默认情况下，配置文件名为 conf.toml，并存储在 OS 配置目录中，在 clock-rs 子目录下。

您可以通过设置 CONF_PATH 环境变量来更改此路径。
如果您希望在运行应用程序时不需要自动使用现有的 conf.toml 文件，可以将 CONF_PATH 设置为 None。
通过命令行传入的任何参数都将覆盖 conf.toml 文件内的设置。

字段

以下是 conf.toml 文件内可用的字段列表。

示例

conf.toml 文件可能看起来像这样

[general]
color = "magenta"
interval = 499
blink = true
bold = true

[position]
horizontal = "start"
vertical = "end"

[date]
fmt = "%A, %B %d, %Y"
use_12h = true
utc = true
hide_seconds = true

默认配置可在此找到 这里。

贡献

欢迎报告错误、建议功能或贡献代码。
任何帮助都将受到欢迎！

许可

版权 © 2024 Oughie

此存储库受 Apache License 2.0 许可 - 更多信息请参阅 此处。