.\" 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-network" "5" "2024-05-05"
.PP
.SH NAME
.PP
waybar - network module
.PP
.SH DESCRIPTION
.PP
The \fBnetwork\fR module displays information about the current network connections.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBnetwork\fR
.PP
\fBinterface\fR: 
.br
	typeof: string 
.br
	Use the defined interface instead of auto-detection.\& Accepts wildcard.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 60 
.br
	The interval in which the network information gets polled (e.\&g.\& signal strength).\&
.PP
\fBfamily\fR: 
.br
	typeof: string 
.br
	default: \fBipv4\fR 
.br
	The address family that is used for the format replacement {ipaddr} and to determine if a network connection is present.\&
.PP
\fBformat\fR: 
.br
	typeof: string  
.br
	default: \fB{ifname}\fR 
.br
	The format, how information should be displayed.\& This format is used when other formats aren'\&t specified.\&
.PP
\fBformat-ethernet\fR: 
.br
	typeof: string 
.br
	This format is used when an ethernet interface is displayed.\&
.PP
\fBformat-wifi\fR: 
.br
	typeof: string 
.br
	This format is used when a wireless interface is displayed.\&
.PP
\fBformat-linked\fR: 
.br
	typeof: string 
.br
	This format is used when a linked interface with no IP address is displayed.\&
.PP
\fBformat-disconnected\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed interface is disconnected.\&
.PP
\fBformat-disabled\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed interface is disabled.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array/object 
.br
	Based on the current signal strength, the corresponding icon gets selected.\& 
.br
	The order is \fBlow\fR to \fBhigh\fR.\& Or by the state if it is an object.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right-click on the module.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.PP
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.PP
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: \fBtrue\fR 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	The format, how information should be displayed in the tooltip.\& This format is used when other formats aren'\&t specified.\&
.PP
\fBtooltip-format-ethernet\fR: 
.br
	typeof: string 
.br
	This format is used when an ethernet interface is displayed.\&
.PP
\fBtooltip-format-wifi\fR: 
.br
	typeof: string 
.br
	This format is used when a wireless interface is displayed.\&
.PP
\fBtooltip-format-disconnected\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed interface is disconnected.\&
.PP
\fBtooltip-format-disabled\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed interface is disabled.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{ifname}\fR: Name of the network interface.\&
.PP
\fB{ipaddr}\fR: The first IP of the interface.\&
.PP
\fB{gwaddr}\fR: The default gateway for the interface
.PP
\fB{netmask}\fR: The subnetmask corresponding to the IP.\&
.PP
\fB{cidr}\fR: The subnetmask corresponding to the IP in CIDR notation.\&
.PP
\fB{essid}\fR: Name (SSID) of the wireless network.\&
.PP
\fB{signalStrength}\fR: Signal strength of the wireless network.\&
.PP
\fB{signaldBm}\fR: Signal strength of the wireless network in dBm.\&
.PP
\fB{frequency}\fR: Frequency of the wireless network in MHz.\&
.PP
\fB{bandwidthUpBits}\fR: Instant up speed in bits/seconds.\&
.PP
\fB{bandwidthDownBits}\fR: Instant down speed in bits/seconds.\&
.PP
\fB{bandwidthTotalBits}\fR: Instant total speed in bits/seconds.\&
.PP
\fB{bandwidthUpOctets}\fR: Instant up speed in octets/seconds.\&
.PP
\fB{bandwidthDownOctets}\fR: Instant down speed in octets/seconds.\&
.PP
\fB{bandwidthTotalOctets}\fR: Instant total speed in octets/seconds.\&
.PP
\fB{bandwidthUpBytes}\fR: Instant up speed in bytes/seconds.\&
.PP
\fB{bandwidthDownBytes}\fR: Instant down speed in bytes/seconds.\&
.PP
\fB{bandwidthTotalBytes}\fR: Instant total speed in bytes/seconds.\&
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"network": {
	"interface": "wlp2s0",
	"format": "{ifname}",
	"format-wifi": "{essid} ({signalStrength}%) ",
	"format-ethernet": "{ifname} ",
	"format-disconnected": "", //An empty format will hide the module\&.
	"format-disconnected": "",
	"tooltip-format": "{ifname}",
	"tooltip-format-wifi": "{essid} ({signalStrength}%) ",
	"tooltip-format-ethernet": "{ifname} ",
	"tooltip-format-disconnected": "Disconnected",
	"max-length": 50
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#network\fR
.IP \(bu 4
\fB#network.\&disconnected\fR
.IP \(bu 4
\fB#network.\&disabled\fR
.IP \(bu 4
\fB#network.\&linked\fR
.IP \(bu 4
\fB#network.\&ethernet\fR
.IP \(bu 4
\fB#network.\&wifi\fR