Module: Network

Note

This page is auto-generated from man/waybar-network.5.scd on the master branch. Do not edit it here — changes will be overwritten on the next sync. To update it, edit the man page(s) and open a PR.

DESCRIPTION

The network module displays information about the current network connections.

CONFIGURATION

Addressed by network

Option	Typeof	Default	Description
interface	string		Use the defined interface instead of auto-detection. Accepts wildcard.
rfkill	bool	true	If enabled, the disabled format will be used when rfkill is blocking wlan interfaces.
interval	integer	60	The interval in which the network information gets polled (e.g. signal strength).
family	string	ipv4	The address family that is used for the format replacement {ipaddr} and to determine if a network connection is present. Set it to ipv4_6 to display both.
format	string	{ifname}	The format, how information should be displayed. This format is used when other formats aren't specified.
format-ethernet	string		This format is used when an ethernet interface is displayed.
format-wifi	string		This format is used when a wireless interface is displayed.
format-linked	string		This format is used when a linked interface with no IP address is displayed.
format-disconnected	string		This format is used when the displayed interface is disconnected.
format-disabled	string		This format is used when rfkill is blocking wlan interfaces.
format-alt	string		On click, toggle between this format and the regular format. The click button is set with format-alt-click (defaults to the left button).
format-icons	array/object		Based on the current signal strength, the corresponding icon gets selected. The order is low to high. Or by the state if it is an object.
rotate	integer		Positive value to rotate the text label (in 90 degree increments).
max-length	integer		The maximum length in character the module should display.
min-length	integer		The minimum length in characters the module should accept.
align	float		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.
justify	string		The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
on-click	string		Command to execute when clicked on the module.
on-click-middle	string		Command to execute when middle-clicked on the module using mousewheel.
on-click-right	string		Command to execute when you right-click on the module.
on-update	string		Command to execute when the module is updated.
on-scroll-up	string		Command to execute when scrolling up on the module.
on-scroll-down	string		Command to execute when scrolling down on the module.
smooth-scrolling-threshold	double		Threshold to be used when scrolling.
tooltip	bool	true	Option to disable tooltip on hover.
tooltip-format	string		The format, how information should be displayed in the tooltip. This format is used when other formats aren't specified.
tooltip-format-ethernet	string		This format is used when an ethernet interface is displayed.
tooltip-format-wifi	string		This format is used when a wireless interface is displayed.
tooltip-format-disconnected	string		This format is used when the displayed interface is disconnected.
tooltip-format-disabled	string		This format is used when rfkill is blocking wlan interfaces.
menu	string		Action that popups the menu.
menu-file	string		Location of the menu descriptor file. There need to be an element of type GtkMenu with id menu
menu-actions	array		The actions corresponding to the buttons of the menu.
expand	bool	false	Enables this module to consume all left over space dynamically.

FORMAT REPLACEMENTS

{ifname}: Name of the network interface.

{ipaddr}: The first IP of the interface.

{gwaddr}: The default gateway for the interface

{netmask}: The subnetmask corresponding to the IP(V4).

{netmask6}: The subnetmask corresponding to the IP(V6).

{cidr}: The subnetmask corresponding to the IP(V4) in CIDR notation.

{cidr6}: The subnetmask corresponding to the IP(V6) in CIDR notation.

{essid}: Name (SSID) of the wireless network.

{bssid}: MAC address (BSSID) of the wireless access point.

{signalStrength}: Signal strength of the wireless network.

{signaldBm}: Signal strength of the wireless network in dBm.

{signalStrengthApp}: Human-readable descriptor of the wireless connectivity derived from the signal strength (e.g. "Great Connectivity", "Streaming", "Poor Connectivity").

{frequency}: Frequency of the wireless network in GHz.

{bandwidthUpBits}: Instant up speed in bits/seconds.

{bandwidthDownBits}: Instant down speed in bits/seconds.

{bandwidthTotalBits}: Instant total speed in bits/seconds.

{bandwidthUpOctets}: Instant up speed in octets/seconds.

{bandwidthDownOctets}: Instant down speed in octets/seconds.

{bandwidthTotalOctets}: Instant total speed in octets/seconds.

{bandwidthUpBytes}: Instant up speed in bytes/seconds.

{bandwidthDownBytes}: Instant down speed in bytes/seconds.

{bandwidthUpBytesCompact}: Instant up speed in bytes/seconds, formatted compactly (e.g. 1.2K).

{bandwidthDownBytesCompact}: Instant down speed in bytes/seconds, formatted compactly (e.g. 1.2K).

{bandwidthTotalBytes}: Instant total speed in bytes/seconds.

{txBitrate}: Link transmit bitrate (e.g., 866.7 Mb/s).

{rxBitrate}: Link receive bitrate (e.g., 866.7 Mb/s).

{linkSpeed}: Ethernet link speed.

{icon}: Icon, as defined in format-icons.

NUMBER FORMAT MODIFIERS

The bandwidth/bitrate replacements above ({bandwidth*}, {txBitrate}, {rxBitrate}, {linkSpeed}) auto-scale the number with an SI prefix (k, M, G, …). Their rendering can be tuned with fmt-style modifiers, e.g. "{bandwidthDownBits:>}" or "{bandwidthDownBits:M}". Modifiers may be combined in any order:

<, =, >: Alignment/padding (left, column-align, right) — as before.

u / U: Hide (u) or show (U) the unit suffix. The unit is shown by default with an auto scale and hidden by default when a scale is forced (see below).

#, k, M, G, T, P: Force a fixed scale instead of auto-selecting one (# = base scale, no prefix). Forcing a scale hides the scale prefix and, by default, the unit (re-enable it with U). E.g. "{bandwidthDownBits:M}" always shows the value in megabits.

i: Force integer display (no decimals).

b / B: Force decimal base 1000 (b) or binary base 1024 with an i marker (B), overriding the module default.

A trailing number is a fixed width for the coefficient when a scale is forced; if the value does not fit, it is shown as # characters (e.g. "{bandwidthDownBits:=3#}" → ###). Without a forced scale the number is ignored (kept for config compatibility).

EXAMPLES

"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
}

STYLE

• #network

• #network.disconnected

• #network.disabled

• #network.linked

• #network.ethernet

• #network.wifi