.\" Generated by scdoc 1.11.3
.\" 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 "waybar-upower" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - upower module
.PP
.SH DESCRIPTION
.PP
The \fBupower\fR module displays the main battery capacity with all other upower
compatible devices in the tooltip.\&
.PP
.SH CONFIGURATION
.PP
\fBnative-path\fR: 
.br
	typeof: string 
.br
	default: 
.br
	The battery to monitor.\& Refer to the https://upower.\&freedesktop.\&org/docs/UpDevice.\&html#UpDevice--native-path 
.br
	Can be obtained using `upower --dump`
.PP
\fBmodel\fR: 
.br
	typeof: string 
.br
	default: 
.br
	The battery to monitor, based on the model.\& (this option is ignored if \fBnative-path\fR is given).\& 
.br
	Can be obtained using `upower --dump`
.PP
\fBicon-size\fR: 
.br
	typeof: integer 
.br
	default: 20 
.br
	Defines the size of the icons.\&
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {percentage} 
.br
	The text format.\&
.PP
\fBformat-alt\fR: 
.br
	typeof: string 
.br
	default: {percentage} {time} 
.br
	The text format when toggled.\&
.PP
\fBhide-if-empty\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Defines visibility of the module if no devices can be found.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-spacing\fR: 
.br
	typeof: integer 
.br
	default: 4 
.br
	Defines the spacing between the tooltip device name and device battery 
.br
	status.\&
.PP
\fBtooltip-padding\fR: 
.br
	typeof: integer 
.br
	default: 4 
.br
	Defines the spacing between the tooltip window edge and the tooltip content.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBshow-icon\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable battery icon.\&
.PP
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{percentage}\fR: The battery capacity in percentage
.PP
\fB{time}\fR: An estimated time either until empty or until fully charged 
.br
depending on the charging state.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"upower": {
	"icon-size": 20,
	"hide-if-empty": true,
	"tooltip": true,
	"tooltip-spacing": 20
}

.fi
.RE
.nf
.RS 4
"upower": {
	"native-path": "/org/bluez/hci0/dev_D4_AE_41_38_D0_EF",
	"icon-size": 20,
	"hide-if-empty": true,
	"tooltip": true,
	"tooltip-spacing": 20
}

.fi
.RE
.nf
.RS 4
"upower": {
	"native-path": "battery_sony_controller_battery_d0o27o88o32ofcoee",
	"icon-size": 20,
	"hide-if-empty": true,
	"tooltip": true,
	"tooltip-spacing": 20
}
.fi
.RE
.nf
.RS 4
"upower": {
	"show-icon": false,
	"hide-if-empty": true,
	"tooltip": true,
	"tooltip-spacing": 20
}

.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#upower\fR
.IP \(bu 4
\fB#upower.\&charging\fR
.IP \(bu 4
\fB#upower.\&discharging\fR
.IP \(bu 4
\fB#upower.\&full\fR
.IP \(bu 4
\fB#upower.\&empty\fR
.IP \(bu 4
\fB#upower.\&unknown-status\fR