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       on-click:
74            typeof: string
75            Command to execute when clicked on the module.
76
77       on-click-middle:
78            typeof: string
79            Command to execute when middle-clicked on the module using mouse‐
80       wheel.
81
82       on-click-right:
83            typeof: string
84            Command to execute when you right clicked on the module.
85
86       on-update:
87            typeof: string
88            Command to execute when the module is updated.
89
90       on-scroll-up:
91            typeof: string
92            Command to execute when scrolling up on the module.
93
94       on-scroll-down:
95            typeof: string
96            Command to execute when scrolling down on the module.
97
98       smooth-scrolling-threshold:
99            typeof: double
100            Threshold to be used when scrolling.
101
102       tooltip:
103            typeof: bool
104            default: true
105            Option to disable tooltip on hover.
106
107       tooltip-format:
108            typeof: string
109            The format, how information should be displayed in the tooltip.
110       This format is used when other formats aren't specified.
111
112       tooltip-format-ethernet:
113            typeof: string
114            This format is used when an ethernet interface is displayed.
115
116       tooltip-format-wifi:
117            typeof: string
118            This format is used when a wireless interface is displayed.
119
120       tooltip-format-disconnected:
121            typeof: string
122            This format is used when the displayed interface is disconnected.
123
124       tooltip-format-disabled:
125            typeof: string
126            This format is used when the displayed interface is disabled.
127

FORMAT REPLACEMENTS

129       {ifname}: Name of the network interface.
130
131       {ipaddr}: The first IP of the interface.
132
133       {netmask}: The subnetmask corresponding to the IP.
134
135       {cidr}: The subnetmask corresponding to the IP in CIDR notation.
136
137       {essid}: Name (SSID) of the wireless network.
138
139       {signalStrength}: Signal strength of the wireless network.
140
141       {signaldBm}: Signal strength of the wireless network in dBm.
142
143       {frequency}: Frequency of the wireless network in MHz.
144
145       {bandwidthUpBits}: Instant up speed in bits/seconds.
146
147       {bandwidthDownBits}: Instant down speed in bits/seconds.
148
149       {bandwidthUpOctets}: Instant up speed in octets/seconds.
150
151       {bandwidthDownOctets}: Instant down speed in octets/seconds.
152
153       {icon}: Icon, as defined in format-icons.
154

EXAMPLES

156           "network": {
157                "interface": "wlp2s0",
158                "format": "{ifname}",
159                "format-wifi": "{essid} ({signalStrength}%) ",
160                "format-ethernet": "{ifname} ",
161                "format-disconnected": "", //An empty format will hide the module.
162                "format-disconnected": "",
163                "tooltip-format": "{ifname}",
164                "tooltip-format-wifi": "{essid} ({signalStrength}%) ",
165                "tooltip-format-ethernet": "{ifname} ",
166                "tooltip-format-disconnected": "Disconnected",
167                "max-length": 50
168           }
169

STYLE

171       ·   #network
172       ·   #network.disconnected
173       ·   #network.disabled
174       ·   #network.linked
175       ·   #network.ethernet
176       ·   #network.wifi
177
178
179
180                                  2021-02-10                 waybar-network(5)