CITRON(1)

💖 NAME 💖

okay so gather round, bestie — this is the citron(1) page from the General Commands Manual, and it's literally about system data via on-demand notifications. it's giving tiny utility, main character energy, no cap 💅

✨ SYNOPSIS ✨

two moods, same icon:

citron [FLAGS]

citron [SUBCOMMAND]

🎀 FLAGS 🎀

• -h, --help — prints help information. the classic "help me help you" moment.
• -V, --version — prints version information.
• -D, --debug — prints debug information. for when you need the tea ☕
• -L — prints a list of available icon themes. iconic for the icon girlies.

🦋 SUBCOMMANDS 🦋

• date — shows a date notification.
• memory — shows a memory notification.
• uptime — shows an uptime notification.
• network — shows a network notification.
• battery — shows a battery notification.
• backlight — shows a backlight notification.

🌸 CONFIGURATION 🌸

citron looks for its config at $XDG_CONFIG_HOME/citron/config.yml, $HOME/.config/citron/config.yml. so cozy, so organized 🫶

• timeout: — defines the amount of time (in seconds) notifications are visible for. Default: 5.
• icon:
  • theme: — defines the name of the icon theme to use, which must be installed beforehand. omitting this disables the usage of icons. the -L flag provides a list of icon themes that this option can be set to. Example: "Papirus-Dark".
• date:
  • title: — defines the title of the notification. Default: "Date".
  • format: — defines the format of the notification's body. See DATE SYMBOLS for more information. Default: "%w, %m %d at %HH:MM %P".
• network:
  • title: — defines the title of the notification. Default: "Network".
  • format: — defines the format of the notification's body. See NETWORK SYMBOLS for more information. Default: "Local IP: %a\nData: %r 🠗 / %t 🠕".
  • interface: — defines the name of the interface whose information will be queried, this is required for citron network to work. Example: "wlan0".
• battery:
  • title: — defines the title of the notification. Default: "Battery".
  • format: — defines the format of the notification's body. See BATTERY SYMBOLS for more information. Default: "Percentage: %p\nState: %s".
• backlight:
  • title: — defines the title of the notification. Default: "Backlight".
• uptime:
  • title: — defines the title of the notification. Default: "Uptime".
• memory:
  • title: — defines the title of the notification. Default: "Memory".

📅 DATE SYMBOLS 📅

the date format girlies know:

• %w — Short weekday, e.g. Thu
• %W — Long weekday, e.g. Thursday
• %m — Short month, e.g. Jan
• %M — Long month, e.g. January
• %d — Day, e.g. 28
• %HH — Hours
• %MM — Minutes
• %P — Meridiem.

%P: if this symbol is omitted, railway time is used instead. noted, bestie 🕰️

🔋 BATTERY SYMBOLS 🔋

• %p — Percentage
• %s — Status
• %S — Status as a symbol

%S: '!' for critical, '-' for low, empty for high and '+' for charging. the little battery mood ring, fr fr 🔋

🌐 NETWORK SYMBOLS 🌐

The following is a list of symbols understood by the format option of the network dictionary.

• %a — Local IP address
• %r — Number of received bytes
• %t — Number of transmitted bytes

👑 AUTHOR 👑

Written and maintained by Aziz Ben Ali <ba.tahaaziz@gmail.com>. absolute icon behavior 👑

🌈 RESOURCES 🌈

This project is hosted at https://git.sr.ht/~grtcdr/citron. Bugs and patches should be submitted via email to ~grtcdr/citron@lists.sr.ht.

okay that's the whole CITRON(1) manual page, bestie — dated 2022-04-29. go forth and get those notifications, mwah 💋