1waybar-network(5) File Formats Manual waybar-network(5)
2
6 waybar - network module
7
9 The network module displays information about the current network con‐
10 nections.
11
13 Addressed by network
14 interface:
16 typeof: string
17 Use the defined interface instead of auto detection. Accepts wild‐
18 card.
19 interval:
21 typeof: integer
22 default: 60
23 The interval in which the network information gets polled (e.g.
24 signal strength).
25 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 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 format-ethernet:
39 typeof: string
40 This format is used when a ethernet interface is displayed.
41 format-wifi:
43 typeof: string
44 This format is used when a wireless interface is displayed.
45 format-linked:
47 typeof: string
48 This format is used when a linked interface with no ip address is
49 displayed.
50 format-disconnected:
52 typeof: string
53 This format is used when the displayed interface is disconnected.
54 format-icons:
56 typeof: array/object
57 Based on the current signal strength, the corresponding icon gets
58 selected.
59 The order is low to high. Or by the state if it is an object.
60 rotate:
62 typeof: integer
63 Positive value to rotate the text label.
64 max-length:
66 typeof: integer
67 The maximum length in character the module should display.
68 on-click:
70 typeof: string
71 Command to execute when clicked on the module.
72 on-click-middle:
74 typeof: string
75 Command to execute when middle-clicked on the module using mouse‐
76 wheel.
77 on-click-right:
79 typeof: string
80 Command to execute when you right clicked on the module.
81 on-scroll-up:
83 typeof: string
84 Command to execute when scrolling up on the module.
85 on-scroll-down:
87 typeof: string
88 Command to execute when scrolling down on the module.
89 smooth-scrolling-threshold:
91 typeof: double
92 Threshold to be used when scrolling.
93 tooltip:
95 typeof: bool
96 default: true
97 Option to disable tooltip on hover.
98 tooltip-format:
100 typeof: string
101 The format, how information should be displayed in the tooltip.
102 This format is used when other formats aren't specified.
103 tooltip-format-ethernet:
105 typeof: string
106 This format is used when a ethernet interface is displayed.
107 tooltip-format-wifi:
109 typeof: string
110 This format is used when a wireless interface is displayed.
111 tooltip-format-disconnected:
113 typeof: string
114 This format is used when the displayed interface is disconnected.
115
117 {ifname}: Name of the network interface.
118 {ipaddr}: The first IP of the interface.
120 {netmask}: The subnetmask corresponding to the IP.
122 {cidr}: The subnetmask corresponding to the IP in CIDR notation.
124 {essid}: Name (SSID) of the wireless network.
126 {signalStrength}: Signal strength of the wireless network.
128 {signaldBm}: Signal strength of the wireless network in dBm.
130 {frequency}: Frequency of the wireless network in MHz.
132 {bandwidthUpBits}: Instant up speed in bits/seconds.
134 {bandwidthDownBits}: Instant down speed in bits/seconds.
136 {bandwidthUpOctets}: Instant up speed in octets/seconds.
138 {bandwidthDownOctets}: Instant down speed in octets/seconds.
140 {icon}: Icon, as defined in format-icons.
142
144 "network": {
145 "interface": "wlp2s0",
146 "format": "{ifname}",
147 "format-wifi": "{essid} ({signalStrength}%) ",
148 "format-ethernet": "{ifname} ",
149 "format-disconnected": "", //An empty format will hide the module.
150 "tooltip-format": "{ifname}",
151 "tooltip-format-wifi": "{essid} ({signalStrength}%) ",
152 "tooltip-format-ethernet": "{ifname} ",
153 "tooltip-format-disconnected": "Disconnected",
154 "max-length": 50
155 }
156
158 · #network
159 · #network.disconnected
160 · #network.linked
161 · #network.ethernet
162 · #network.wifi
163 2020-04-11 waybar-network(5)