.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "CITRON" "1" "2022-04-29"
.P
.SH NAME
.P
citron - system data via on-demand notifications.\& 
.P
.SH SYNOPSIS
.P
\fBcitron\fR [FLAGS]
.P
\fBcitron\fR [SUBCOMMAND]
.P
.SH FLAGS
.P
\fB-h, --help\fR
.RS 4
Prints help information.\&
.P
.RE
\fB-V, --version\fR
.RS 4
Prints version information.\&
.P
.RE
\fB-D, --debug\fR
.RS 4
Prints debug information.\&
.P
.RE
\fB-L\fR
.RS 4
Prints a list of available icon themes.\&
.P
.RE
.SH SUBCOMMANDS
.P
\fBdate\fR
.RS 4
Shows a date notification.\&
.P
.RE
\fBmemory\fR
.RS 4
Shows a memory notification.\&
.P
.RE
\fBuptime\fR
.RS 4
Shows an uptime notification.\&
.P
.RE
\fBnetwork\fR
.RS 4
Shows a network notification.\&
.P
.RE
\fBbattery\fR
.RS 4
Shows a battery notification.\&
.P
.RE
\fBbacklight\fR
.RS 4
Shows a backlight notification.\&
.P
.RE
.SH CONFIGURATION
.P
\fB$XDG_CONFIG_HOME/citron/config.\&yml\fR, \fB$HOME/.\&config/citron/config.\&yml\fR.\&
.P
.SS timeout: 
.RS 4
Defines the amount of time (in seconds) notifications are visible for.\&
.P
Default: 5
.P
.RE
.SS icon:
.P
theme:
.RS 4
Defines the name of the icon theme to use, which must be installed
beforehand.\& Omitting this disables the usage of icons.\&
.P
\fB-L\fR flag provides a list of icon themes that this option can be set to.\&
.P
Example: "Papirus-Dark"
.P
.RE
.SS date:
.P
title:
.RS 4
Defines the title of the notification.\&
.P
Default: "Date"
.P
.RE
format:
.RS 4
Defines the format of the notification'\&s body.\&
See DATE SYMBOLS for more information.\&
.P
Default: "%w, %m %d at %HH:MM %P"
.P
.RE
.SS network:
.P
title:
.RS 4
Defines the title of the notification.\&
.P
Default: "Network"
.P
.RE
format:
.RS 4
Defines the format of the notification'\&s body.\&
See NETWORK SYMBOLS for more information.\&
.P
Default: "Local IP: %a\\nData: %r 🠗 / %t 🠕"
.P
.P
.RE
interface:
.RS 4
Defines the name of the interface whose information will be queried, this is
required for \fBcitron network\fR to work.\&
.P
Example: "wlan0"
.P
.RE
.SS battery:
.P
title:
.RS 4
Defines the title of the notification.\&
.P
Default: "Battery"
.P
.RE
format:
.RS 4
Defines the format of the notification'\&s body.\&
See BATTERY SYMBOLS for more information.\&
.P
Default: "Percentage: %p\\nState: %s"
.P
.RE
.SS backlight:
.P
title:
.RS 4
Defines the title of the notification.\&
.P
Default: "Backlight"
.P
.RE
.SS uptime:
.P
title:
.RS 4
Defines the title of the notification.\&
.P
Default: "Uptime"
.P
.RE
.SS memory:
.P
title:
.RS 4
Defines the title of the notification.\&
.P
Default: "Memory"
.P
.RE
.SS DATE SYMBOLS
.P
.TS
allbox;c l
c l
c l
c l
c l
c l
c l
c l
c l.
T{
\fBSymbol\fR
T}	T{
\fBDescription\fR
T}
T{
\fB%w\fR
T}	T{
Short weekday, e.\&g.\& Thu
T}
T{
\fB%W\fR
T}	T{
Long weekday, e.\&g.\& Thursday
T}
T{
\fB%m\fR
T}	T{
Short month, e.\&g.\& Jan
T}
T{
\fB%M\fR
T}	T{
Long month, e.\&g.\& January
T}
T{
\fB%d\fR
T}	T{
Day, e.\&g.\& 28
T}
T{
\fB%HH\fR
T}	T{
Hours
T}
T{
\fB%MM\fR
T}	T{
Minutes
T}
T{
\fB%P\fR
T}	T{
Meridiem.\&
T}
.TE
.sp 1
\fB%P\fR: if this symbol is omitted, railway time is used instead.\&
.P
.SS BATTERY SYMBOLS
.P
.TS
allbox;c l
c l
c l
c l.
T{
\fBSymbol\fR
T}	T{
\fBDescription\fR
T}
T{
\fB%p\fR
T}	T{
Percentage
T}
T{
\fB%s\fR
T}	T{
Status
T}
T{
\fB%S\fR
T}	T{
Status as a symbol
T}
.TE
.sp 1
\fB%S\fR: '\&!\&'\& for critical, '\&-'\& for low, empty for high and '\&+'\& for charging.\&
.P
.SS NETWORK SYMBOLS
.P
The following is a list of symbols understood by the format option of the
network dictionary.\&
.P
.TS
allbox;c l
c l
c l
c l.
T{
\fBSymbol\fR
T}	T{
\fBDescription\fR
T}
T{
\fB%a\fR
T}	T{
Local IP address
T}
T{
\fB%r\fR
T}	T{
Number of received bytes
T}
T{
\fB%t\fR
T}	T{
Number of transmitted bytes
T}
.TE
.sp 1
.SH AUTHOR
.P
Written and maintained by Aziz Ben Ali <ba.\&tahaaziz@gmail.\&com>.\&
.P
.SH RESOURCES
.P
This project is hosted at \fBhttps://git.\&sr.\&ht/~grtcdr/citron\fR.\& Bugs and patches
should be submitted via email to \fB~grtcdr/citron@lists.\&sr.\&ht\fR.\&