1waybar-network(5)             File Formats Manual            waybar-network(5)
2
3
4

NAME

6       waybar - network module
7

DESCRIPTION

9       The network module displays information about the current network con‐
10       nections.
11

CONFIGURATION

13       Addressed by network
14
15       interface:
16            typeof: string
17            Use the defined interface instead of auto detection. Accepts wild‐
18       card.
19
20       interval:
21            typeof: integer
22            default: 60
23            The interval in which the network information gets polled (e.g.
24       signal strength).
25
26       family:
27            typeof: string
28            default: ipv4
29            The address family that is used for the format replacement
30       {ipaddr} and to determine if a network connection is present.
31
32       format:
33            typeof: string
34            default: {ifname}
35            The format, how information should be displayed. This format is
36       used when other formats aren't specified.
37
38       format-ethernet:
39            typeof: string
40            This format is used when an ethernet interface is displayed.
41
42       format-wifi:
43            typeof: string
44            This format is used when a wireless interface is displayed.
45
46       format-linked:
47            typeof: string
48            This format is used when a linked interface with no ip address is
49       displayed.
50
51       format-disconnected:
52            typeof: string
53            This format is used when the displayed interface is disconnected.
54
55       format-disabled:
56            typeof: string
57            This format is used when the displayed interface is disabled.
58
59       format-icons:
60            typeof: array/object
61            Based on the current signal strength, the corresponding icon gets
62       selected.
63            The order is low to high. Or by the state if it is an object.
64
65       rotate:
66            typeof: integer
67            Positive value to rotate the text label.
68
69       max-length:
70            typeof: integer
71            The maximum length in character the module should display.
72
73       min-length:
74            typeof: integer
75            The minimum length in characters the module should take up.
76
77       align:
78            typeof: float
79            The alignment of the text, where 0 is left-aligned and 1 is right-
80       aligned. If the module is rotated, it will follow the flow of the text.
81
82       on-click:
83            typeof: string
84            Command to execute when clicked on the module.
85
86       on-click-middle:
87            typeof: string
88            Command to execute when middle-clicked on the module using mouse‐
89       wheel.
90
91       on-click-right:
92            typeof: string
93            Command to execute when you right clicked on the module.
94
95       on-update:
96            typeof: string
97            Command to execute when the module is updated.
98
99       on-scroll-up:
100            typeof: string
101            Command to execute when scrolling up on the module.
102
103       on-scroll-down:
104            typeof: string
105            Command to execute when scrolling down on the module.
106
107       smooth-scrolling-threshold:
108            typeof: double
109            Threshold to be used when scrolling.
110
111       tooltip:
112            typeof: bool
113            default: true
114            Option to disable tooltip on hover.
115
116       tooltip-format:
117            typeof: string
118            The format, how information should be displayed in the tooltip.
119       This format is used when other formats aren't specified.
120
121       tooltip-format-ethernet:
122            typeof: string
123            This format is used when an ethernet interface is displayed.
124
125       tooltip-format-wifi:
126            typeof: string
127            This format is used when a wireless interface is displayed.
128
129       tooltip-format-disconnected:
130            typeof: string
131            This format is used when the displayed interface is disconnected.
132
133       tooltip-format-disabled:
134            typeof: string
135            This format is used when the displayed interface is disabled.
136

FORMAT REPLACEMENTS

138       {ifname}: Name of the network interface.
139
140       {ipaddr}: The first IP of the interface.
141
142       {gwaddr}: The default gateway for the interface
143
144       {netmask}: The subnetmask corresponding to the IP.
145
146       {cidr}: The subnetmask corresponding to the IP in CIDR notation.
147
148       {essid}: Name (SSID) of the wireless network.
149
150       {signalStrength}: Signal strength of the wireless network.
151
152       {signaldBm}: Signal strength of the wireless network in dBm.
153
154       {frequency}: Frequency of the wireless network in MHz.
155
156       {bandwidthUpBits}: Instant up speed in bits/seconds.
157
158       {bandwidthDownBits}: Instant down speed in bits/seconds.
159
160       {bandwidthTotalBits}: Instant total speed in bits/seconds.
161
162       {bandwidthUpOctets}: Instant up speed in octets/seconds.
163
164       {bandwidthDownOctets}: Instant down speed in octets/seconds.
165
166       {bandwidthTotalOctets}: Instant total speed in octets/seconds.
167
168       {bandwidthUpBytes}: Instant up speed in bytes/seconds.
169
170       {bandwidthDownBytes}: Instant down speed in bytes/seconds.
171
172       {bandwidthTotalBytes}: Instant total speed in bytes/seconds.
173
174       {icon}: Icon, as defined in format-icons.
175

EXAMPLES

177           "network": {
178                "interface": "wlp2s0",
179                "format": "{ifname}",
180                "format-wifi": "{essid} ({signalStrength}%) ",
181                "format-ethernet": "{ifname} ",
182                "format-disconnected": "", //An empty format will hide the module.
183                "format-disconnected": "",
184                "tooltip-format": "{ifname}",
185                "tooltip-format-wifi": "{essid} ({signalStrength}%) ",
186                "tooltip-format-ethernet": "{ifname} ",
187                "tooltip-format-disconnected": "Disconnected",
188                "max-length": 50
189           }
190

STYLE

192#network
193#network.disconnected
194#network.disabled
195#network.linked
196#network.ethernet
197#network.wifi
198
199
200
201                                  2023-08-16                 waybar-network(5)
Impressum