File: i3status.1

package info (click to toggle)
i3status 2.11-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 424 kB
  • ctags: 340
  • sloc: ansic: 4,014; python: 125; makefile: 121; sh: 55; perl: 14
file content (689 lines) | stat: -rw-r--r-- 27,235 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
'\" t
.\"     Title: i3status
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 01/21/2017
.\"    Manual: i3 Manual
.\"    Source: i3status v2.11
.\"  Language: English
.\"
.TH "I3STATUS" "1" "01/21/2017" "i3status v2\&.11" "i3 Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
i3status \- Generates a status line for i3bar, dzen2, xmobar or lemonbar
.SH "SYNOPSIS"
.sp
i3status [\-c configfile] [\-h] [\-v]
.SH "OPTIONS"
.PP
\-c
.RS 4
Specifies an alternate configuration file path\&. By default, i3status looks for configuration files in the following order:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
~/\&.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
/etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
~/\&.i3status\&.conf
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  4." 4.2
.\}
/etc/i3status\&.conf
.RE
.RE
.SH "DESCRIPTION"
.sp
i3status is a small program (about 1500 SLOC) for generating a status bar for i3bar, dzen2, xmobar, lemonbar or similar programs\&. It is designed to be very efficient by issuing a very small number of system calls, as one generally wants to update such a status line every second\&. This ensures that even under high load, your status bar is updated correctly\&. Also, it saves a bit of energy by not hogging your CPU as much as spawning the corresponding amount of shell commands would\&.
.SH "CONFIGURATION"
.sp
The basic idea of i3status is that you can specify which "modules" should be used (the order directive)\&. You can then configure each module with its own section\&. For every module, you can specify the output format\&. See below for a complete reference\&.
.PP
\fBSample configuration\fR. 
.sp
.if n \{\
.RS 4
.\}
.nf
general {
        output_format = "dzen2"
        colors = true
        interval = 5
}

order += "ipv6"
order += "disk /"
order += "run_watch DHCP"
order += "run_watch VPNC"
order += "path_exists VPN"
order += "wireless wlan0"
order += "ethernet eth0"
order += "battery 0"
order += "cpu_temperature 0"
order += "load"
order += "tztime local"
order += "tztime berlin"

wireless wlan0 {
        format_up = "W: (%quality at %essid, %bitrate) %ip"
        format_down = "W: down"
}

ethernet eth0 {
        # if you use %speed, i3status requires the cap_net_admin capability
        format_up = "E: %ip (%speed)"
        format_down = "E: down"
}

battery 0 {
        format = "%status %percentage %remaining %emptytime"
        format_down = "No battery"
        status_chr = "⚡ CHR"
        status_bat = "🔋 BAT"
        status_unk = "? UNK"
        status_full = "☻ FULL"
        path = "/sys/class/power_supply/BAT%d/uevent"
        low_threshold = 10
}

run_watch DHCP {
        pidfile = "/var/run/dhclient*\&.pid"
}

run_watch VPNC {
        # file containing the PID of a vpnc process
        pidfile = "/var/run/vpnc/pid"
}

path_exists VPN {
        # path exists when a VPN tunnel launched by nmcli/nm\-applet is active
        path = "/proc/sys/net/ipv4/conf/tun0"
}

tztime local {
        format = "%Y\-%m\-%d %H:%M:%S"
}

tztime berlin {
        format = "%Y\-%m\-%d %H:%M:%S %Z"
        timezone = "Europe/Berlin"
}

load {
        format = "%5min"
}

cpu_temperature 0 {
        format = "T: %degrees \(deC"
        path = "/sys/devices/platform/coretemp\&.0/temp1_input"
}

disk "/" {
        format = "%free"
}
.fi
.if n \{\
.RE
.\}
.sp
.SS "General"
.sp
The colors directive will disable all colors if you set it to false\&. You can also specify the colors that will be used to display "good", "degraded" or "bad" values using the color_good, color_degraded or color_bad directives, respectively\&. Those directives are only used if color support is not disabled by the colors directive\&. The input format for color values is the canonical RGB hexadecimal triplet (with no separators between the colors), prefixed by a hash character ("#")\&.
.sp
\fBExample configuration\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
color_good = "#00FF00"
.fi
.if n \{\
.RE
.\}
.sp
Likewise, you can use the color_separator directive to specify the color that will be used to paint the separator bar\&. The separator is always output in color, even when colors are disabled by the colors directive\&. This option has no effect when output_format is set to i3bar or none\&.
.sp
The interval directive specifies the time in seconds for which i3status will sleep before printing the next status line\&.
.sp
Using output_format you can chose which format strings i3status should use in its output\&. Currently available are:
.PP
i3bar
.RS 4
i3bar comes with i3 and provides a workspace bar which does the right thing in multi\-monitor situations\&. It also comes with tray support and can display the i3status output\&. This output type uses JSON to pass as much meta\-information to i3bar as possible (like colors, which blocks can be shortened in which way, etc\&.)\&.
.RE
.PP
dzen2
.RS 4
Dzen is a general purpose messaging, notification and menuing program for X11\&. It was designed to be scriptable in any language and integrate well with window managers like dwm, wmii and xmonad though it will work with any windowmanger
.RE
.PP
xmobar
.RS 4
xmobar is a minimalistic, text based, status bar\&. It was designed to work with the xmonad Window Manager\&.
.RE
.PP
lemonbar
.RS 4
lemonbar is a lightweight bar based entirely on XCB\&. It has full UTF\-8 support and is EWMH compliant\&.
.RE
.PP
term
.RS 4
Use ANSI Escape sequences to produce a terminal\-output as close as possible to the graphical outputs\&. This makes debugging your config file a little bit easier because the terminal\-output of i3status becomes much more readable, but should only used for such quick glances, because it will only support very basic output\-features (for example you only get 3 bits of color depth)\&.
.RE
.PP
none
.RS 4
Does not use any color codes\&. Separates values by the pipe symbol by default\&. This should be used with i3bar and can be used for custom scripts\&.
.RE
.sp
It\(cqs also possible to use the color_good, color_degraded, color_bad directives to define specific colors per module\&. If one of these directives is defined in a module section its value will override the value defined in the general section just for this module\&.
.sp
If you don\(cqt fancy the vertical separators between modules i3status/i3bar uses by default, you can employ the separator directive to configure how modules are separated\&. You can either disable the default separator altogether setting it to the empty string\&. You might then define separation as part of a module\(cqs format string\&. This is your only option when using the i3bar output format as the separator is drawn by i3bar directly otherwise\&. For the other output formats, the provided non\-empty string will be automatically enclosed with the necessary coloring bits if color support is enabled\&.
.sp
i3bar supports Pango markup, allowing your format strings to specify font color, size, etc\&. by setting the markup directive to "pango"\&. Note that the ampersand ("&"), less\-than ("<"), greater\-than (">"), single\-quote ("\*(Aq"), and double\-quote (""") characters need to be replaced with "&amp;", "&lt;", "&gt;", "&apos;", and "&quot;" respectively\&. This is done automatically for generated content (e\&.g\&. wireless ESSID, time)\&.
.sp
\fBExample configuration\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
general {
    output_format = "xmobar"
    separator = "  "
}

order += "load"
order += "disk /"

load {
    format = "[ load: %1min, %5min, %15min ]"
}
disk "/" {
    format = "%avail"
}
.fi
.if n \{\
.RE
.\}
.SS "IPv6"
.sp
This module gets the IPv6 address used for outgoing connections (that is, the best available public IPv6 address on your computer)\&.
.sp
\fBExample format_up\fR: %ip
.sp
\fBExample format_down\fR: no IPv6
.SS "Disk"
.sp
Gets used, free, available and total amount of bytes on the given mounted filesystem\&.
.sp
These values can also be expressed in percentages with the percentage_used, percentage_free, percentage_avail and percentage_used_of_avail formats\&.
.sp
Byte sizes are presented in a human readable format using a set of prefixes whose type can be specified via the "prefix_type" option\&. Three sets of prefixes are available:
.PP
binary
.RS 4
IEC prefixes (Ki, Mi, Gi, Ti) represent multiples of powers of 1024\&. This is the default\&.
.RE
.PP
decimal
.RS 4
SI prefixes (k, M, G, T) represent multiples of powers of 1000\&.
.RE
.PP
custom
.RS 4
The custom prefixes (K, M, G, T) represent multiples of powers of 1024\&.
.RE
.sp
It is possible to define a low_threshold that causes the disk text to be displayed using color_bad\&. The low_threshold type can be of threshold_type "bytes_free", "bytes_avail", "percentage_free", or "percentage_avail", where the former two can be prepended by a generic prefix (k, m, g, t) having prefix_type\&. So, if you configure low_threshold to 2, threshold_type to "gbytes_avail", and prefix_type to "binary", and the remaining available disk space is below 2 GiB, it will be colored bad\&. If not specified, threshold_type is assumed to be "percentage_avail" and low_threshold to be set to 0, which implies no coloring at all\&. You can customize the output format when below low_threshold with format_below_threshold\&.
.sp
You can define a different format with the option "format_not_mounted" which is used if the path does not exist or is not a mount point\&. Defaults to ""\&.
.sp
\fBExample order\fR: disk /mnt/usbstick
.sp
\fBExample format\fR: %free (%avail)/ %total
.sp
\fBExample format\fR: %percentage_used used, %percentage_free free, %percentage_avail avail
.sp
\fBExample prefix_type\fR: custom
.sp
\fBExample low_threshold\fR: 5
.sp
\fBExample format_below_threshold\fR: Warning: %percentage_avail
.sp
\fBExample threshold_type\fR: percentage_free
.SS "Run\-watch"
.sp
Expands the given path to a pidfile and checks if the process ID found inside is valid (that is, if the process is running)\&. You can use this to check if a specific application, such as a VPN client or your DHCP client is running\&. There also is an option "format_down"\&. You can hide the output with format_down=""\&.
.sp
\fBExample order\fR: run_watch DHCP
.sp
\fBExample format\fR: %title: %status
.SS "Path\-exists"
.sp
Checks if the given path exists in the filesystem\&. You can use this to check if something is active, like for example a VPN tunnel managed by NetworkManager\&. There also is an option "format_down"\&. You can hide the output with format_down=""\&.
.sp
\fBExample order\fR: path_exists VPN
.sp
\fBExample format\fR: %title: %status
.SS "Wireless"
.sp
Gets the link quality, frequency and ESSID of the given wireless network interface\&. You can specify different format strings for the network being connected or not connected\&.
.sp
The special interface name _first_ will be replaced by the first wireless network interface found on the system (excluding devices starting with "lo")\&.
.sp
\fBExample order\fR: wireless wlan0
.sp
\fBExample format\fR: W: (%quality at %essid, %bitrate / %frequency) %ip
.SS "Ethernet"
.sp
Gets the IP address and (if possible) the link speed of the given ethernet interface\&. Getting the link speed requires the cap_net_admin capability\&. Set it using setcap cap_net_admin=ep $(which i3status)\&.
.sp
The special interface name _first_ will be replaced by the first non\-wireless network interface found on the system (excluding devices starting with "lo")\&.
.sp
\fBExample order\fR: ethernet eth0
.sp
\fBExample format\fR: E: %ip (%speed)
.SS "Battery"
.sp
Gets the status (charging, discharging, unknown, full), percentage, remaining time and power consumption (in Watts) of the given battery and when it\(cqs estimated to be empty\&. If you want to use the last full capacity instead of the design capacity (when using the design capacity, it may happen that your battery is at 23% when fully charged because it\(cqs old\&. In general, I want to see it this way, because it tells me how worn off my battery is\&.), just specify last_full_capacity = true\&. You can hide seconds in the remaining time and empty time estimations by setting hide_seconds = true\&.
.sp
If you want the battery percentage to be shown without decimals, add integer_battery_capacity = true\&.
.sp
If your battery is represented in a non\-standard path in /sys, be sure to modify the "path" property accordingly, i\&.e\&. pointing to the uevent file on your system\&. The first occurrence of %d gets replaced with the battery number, but you can just hard\-code a path as well\&.
.sp
It is possible to define a low_threshold that causes the battery text to be colored red\&. The low_threshold type can be of threshold_type "time" or "percentage"\&. So, if you configure low_threshold to 10 and threshold_type to "time", and your battery lasts another 9 minutes, it will be colored red\&.
.sp
To show an aggregate of all batteries in the system, use "all" as the number\&. In this case (for Linux), the /sys path must contain the "%d" sequence\&. Otherwise, the number indicates the battery index as reported in /sys\&.
.sp
Optionally custom strings including any UTF\-8 symbols can be used for different battery states\&. This makes it possible to display individual symbols for each state (charging, discharging, unknown, full) Of course it will also work with special iconic fonts, such as FontAwesome\&. If any of these special status strings are omitted, the default (CHR, BAT, UNK, FULL) is used\&.
.sp
\fBExample order (for the first battery)\fR: battery 0
.sp
\fBExample order (aggregate of all batteries)\fR: battery all
.sp
\fBExample format\fR: %status %remaining (%emptytime %consumption)
.sp
\fBExample format_down\fR: No battery
.sp
\fBExample status_chr\fR: ⚡ CHR
.sp
\fBExample status_bat\fR: 🔋 BAT
.sp
\fBExample status_unk\fR: ? UNK
.sp
\fBExample status_full\fR: ☻ FULL
.sp
\fBExample low_threshold\fR: 30
.sp
\fBExample threshold_type\fR: time
.sp
\fBExample path (%d replaced by title number)\fR: /sys/class/power_supply/CMB%d/uevent
.sp
\fBExample path (ignoring the number)\fR: /sys/class/power_supply/CMB1/uevent
.SS "CPU\-Temperature"
.sp
Gets the temperature of the given thermal zone\&. It is possible to define a max_threshold that will color the temperature red in case the specified thermal zone is getting too hot\&. Defaults to 75 degrees C\&. The output format when above max_threshold can be customized with format_above_threshold\&.
.sp
\fBExample order\fR: cpu_temperature 0
.sp
\fBExample format\fR: T: %degrees \(deC
.sp
\fBExample max_threshold\fR: 42
.sp
\fBExample format_above_threshold\fR: Warning T above threshold: %degrees \(deC
.sp
\fBExample path\fR: /sys/devices/platform/coretemp\&.0/temp1_input
.SS "CPU Usage"
.sp
Gets the percentual CPU usage from /proc/stat (Linux) or sysctl(3) (FreeBSD/OpenBSD)\&.
.sp
It is possible to define a max_threshold that will color the load value red in case the CPU average over the last interval is getting higher than the configured threshold\&. Defaults to 95\&. The output format when above max_threshold can be customized with format_above_threshold\&.
.sp
It is possible to define a degraded_threshold that will color the load value yellow in case the CPU average over the last interval is getting higher than the configured threshold\&. Defaults to 90\&. The output format when above degraded threshold can be customized with format_above_degraded_threshold\&.
.sp
\fBExample order\fR: cpu_usage
.sp
\fBExample format\fR: %usage
.sp
\fBExample max_threshold\fR: 75
.sp
\fBExample format_above_threshold\fR: Warning above threshold: %usage
.sp
\fBExample degraded_threshold\fR: 25
.sp
\fBExample format_above_degraded_threshold\fR: Warning above degraded threshold: %usage
.SS "Load"
.sp
Gets the system load (number of processes waiting for CPU time in the last 1, 5 and 15 minutes)\&. It is possible to define a max_threshold that will color the load value red in case the load average of the last minute is getting higher than the configured threshold\&. Defaults to 5\&. The output format when above max_threshold can be customized with format_above_threshold\&.
.sp
\fBExample order\fR: load
.sp
\fBExample format\fR: %1min %5min %15min
.sp
\fBExample max_threshold\fR: "0,1"
.sp
\fBExample format_above_threshold\fR: Warning: %1min %5min %15min
.SS "Time"
.sp
Outputs the current time in the local timezone\&. To use a different timezone, you can set the TZ environment variable, or use the tztime module\&. See strftime(3) for details on the format string\&.
.sp
\fBExample order\fR: time
.sp
\fBExample format\fR: %Y\-%m\-%d %H:%M:%S
.SS "TzTime"
.sp
Outputs the current time in the given timezone\&. If no timezone is given, local time will be used\&. See strftime(3) for details on the format string\&. The system\(cqs timezone database is usually installed in /usr/share/zoneinfo\&. Files below that path make for valid timezone strings, e\&.g\&. for /usr/share/zoneinfo/Europe/Berlin you can set timezone to Europe/Berlin in the tztime module\&. To override the locale settings of your environment, set the locale option\&.
.sp
\fBExample order\fR: tztime berlin
.sp
\fBExample format\fR: %Y\-%m\-%d %H:%M:%S %Z
.sp
\fBExample timezone\fR: Europe/Berlin
.sp
\fBExample locale\fR: de_DE\&.UTF\-8
.sp
If you would like to use markup in this section, there is a separate format_time option that is automatically escaped\&. Its output then replaces %time in the format string\&.
.sp
\fBExample configuration (markup)\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
tztime berlin {
        format = "<span foreground=\*(Aq#ffffff\*(Aq>time:</span> %time"
        format_time = "%H:%M %Z"
        timezone = "Europe/Berlin"
}
.fi
.if n \{\
.RE
.\}
.SS "DDate"
.sp
Outputs the current discordian date in user\-specified format\&. See ddate(1) for details on the format string\&. \fBNote\fR: Neither \fB%\&.\fR nor \fB%X\fR are implemented yet\&.
.sp
\fBExample order\fR: ddate
.sp
\fBExample format\fR: %{%a, %b %d%}, %Y%N \- %H
.SS "Volume"
.sp
Outputs the volume of the specified mixer on the specified device\&. PulseAudio and ALSA (Linux only) are supported\&. If PulseAudio is absent, a simplified configuration can be used on FreeBSD and OpenBSD due to the lack of ALSA, the device and mixer options can be ignored on these systems\&. On these systems the OSS API is used instead to query /dev/mixer directly if mixer_idx is \-1, otherwise /dev/mixer+mixer_idx+\&.
.sp
To get PulseAudio volume information, one must use the following format in the device line:
.sp
.if n \{\
.RS 4
.\}
.nf
device = "pulse"
.fi
.if n \{\
.RE
.\}
.sp
or
.sp
.if n \{\
.RS 4
.\}
.nf
device = "pulse:N"
.fi
.if n \{\
.RE
.\}
.sp
where N is the index or name of the PulseAudio sink\&. You can obtain the name of the sink with the following command:
.sp
.if n \{\
.RS 4
.\}
.nf
$ pacmd list\-sinks | grep name:
           name: <alsa_output\&.pci\-0000_00_14\&.2\&.analog\-stereo>
.fi
.if n \{\
.RE
.\}
.sp
The name is what\(cqs inside the angle brackets, not including them\&. If no sink is specified the default sink is used\&. If the device string is missing or is set to "default", PulseAudio will be tried if detected and will fallback to ALSA (Linux) or OSS (FreeBSD/OpenBSD)\&.
.sp
\fBExample order\fR: volume master
.sp
\fBExample format\fR: ♪: %volume
.sp
\fBExample format_muted\fR: ♪: 0%%
.sp
\fBExample configuration\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
volume master {
        format = "♪: %volume"
        format_muted = "♪: muted (%volume)"
        device = "default"
        mixer = "Master"
        mixer_idx = 0
}
.fi
.if n \{\
.RE
.\}
.sp
\fBExample configuration (PulseAudio)\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
volume master {
        format = "♪: %volume"
        format_muted = "♪: muted (%volume)"
        device = "pulse:1"
}
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
volume master {
        format = "♪: %volume"
        format_muted = "♪: muted (%volume)"
        device = "pulse:alsa_output\&.pci\-0000_00_14\&.2\&.analog\-stereo"
}
.fi
.if n \{\
.RE
.\}
.SH "UNIVERSAL MODULE OPTIONS"
.sp
When using the i3bar output format, there are a few additional options that can be used with all modules to customize their appearance:
.PP
align
.RS 4
The alignment policy to use when the minimum width (see below) is not reached\&. Either
center
(default),
right
or
left\&.
.RE
.PP
min_width
.RS 4
The minimum width (in pixels) the module should occupy\&. If the module takes less space than the specified size, the block will be padded to the left and/or the right side, according to the defined alignment policy\&. This is useful when you want to prevent the whole status line from shifting when values take more or less space between each iteration\&. The option can also be a string\&. In this case, the width of the given text determines the minimum width of the block\&. This is useful when you want to set a sensible minimum width regardless of which font you are using, and at what particular size\&. Please note that a number enclosed with quotes will still be treated as a number\&.
.RE
.PP
separator
.RS 4
A boolean value which specifies whether a separator line should be drawn after this block\&. The default is true, meaning the separator line will be drawn\&. Note that if you disable the separator line, there will still be a gap after the block, unless you also use separator_block_width\&.
.RE
.PP
separator_block_width
.RS 4
The amount of pixels to leave blank after the block\&. In the middle of this gap, a separator symbol will be drawn unless separator is disabled\&. This is why the specified width should leave enough space for the separator symbol\&.
.RE
.sp
\fBExample configuration\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
disk "/" {
    format = "%avail"
    align = "left"
    min_width = 100
    separator = false
    separator_block_width = 1
}
.fi
.if n \{\
.RE
.\}
.SH "USING I3STATUS WITH DZEN2"
.sp
After installing dzen2, you can directly use it with i3status\&. Just ensure that output_format is set to dzen2\&.
.sp
\fBExample for usage of i3status with dzen2\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
i3status | dzen2 \-fg white \-ta r \-w 1280 \e
\-fn "\-misc\-fixed\-medium\-r\-normal\-\-13\-120\-75\-75\-C\-70\-iso8859\-1"
.fi
.if n \{\
.RE
.\}
.SH "USING I3STATUS WITH XMOBAR"
.sp
To get xmobar to start, you might need to copy the default configuration file to ~/\&.xmobarrc\&. Also, ensure that the output_format option for i3status is set to xmobar\&.
.sp
\fBExample for usage of i3status with xmobar\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
i3status | xmobar \-o \-t "%StdinReader%" \-c "[Run StdinReader]"
.fi
.if n \{\
.RE
.\}
.SH "WHAT ABOUT MEMORY USAGE OR CPU FREQUENCY?"
.sp
While talking about two specific things, please understand this section as a general explanation why your favorite information is not included in i3status\&.
.sp
Let\(cqs talk about memory usage specifically\&. It is hard to measure memory in a way which is accurate or meaningful\&. An in\-depth understanding of how paging and virtual memory work in your operating system is required\&. Furthermore, even if we had a well\-defined way of displaying memory usage and you would understand it, I think that it\(cqs not helpful to repeatedly monitor your memory usage\&. One reason for that is that I have not run out of memory in the last few years\&. Memory has become so cheap that even in my 4 year old notebook, I have 8 GiB of RAM\&. Another reason is that your operating system will do the right thing anyway: Either you have not enough RAM for your workload, but you need to do it anyway, then your operating system will swap\&. Or you don\(cqt have enough RAM and you want to restrict your workload so that it fits, then the operating system will kill the process using too much RAM and you can act accordingly\&.
.sp
For CPU frequency, the situation is similar\&. Many people don\(cqt understand how frequency scaling works precisely\&. The generally recommended CPU frequency governor ("ondemand") changes the CPU frequency far more often than i3status could display it\&. The display number is therefore often incorrect and doesn\(cqt tell you anything useful either\&.
.sp
In general, i3status wants to display things which you would look at occasionally anyways, like the current date/time, whether you are connected to a WiFi network or not, and if you have enough disk space to fit that 4\&.3 GiB download\&.
.sp
However, if you need to look at some kind of information more than once in a while (like checking repeatedly how full your RAM is), you are probably better off with a script doing that, which pops up an alert when your RAM usage reaches a certain threshold\&. After all, the point of computers is not to burden you with additional boring tasks like repeatedly checking a number\&.
.SH "EXTERNAL SCRIPTS/PROGRAMS WITH I3STATUS"
.sp
In i3status, we don\(cqt want to implement process management again\&. Therefore, there is no module to run arbitrary scripts or commands\&. Instead, you should use your shell, for example like this:
.sp
\fBExample for prepending the i3status output\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
#!/bin/sh
# shell script to prepend i3status with more stuff

i3status | while :
do
        read line
        echo "mystuff | $line" || exit 1
done
.fi
.if n \{\
.RE
.\}
.sp
Put that in some script, say \&.bin/my_i3status\&.sh and execute that instead of i3status\&.
.sp
Note that if you want to use the JSON output format (with colors in i3bar), you need to use a slightly more complex wrapper script\&. There are examples in the contrib/ folder, see https://github\&.com/i3/i3status/tree/master/contrib
.SH "SIGNALS"
.sp
When receiving SIGUSR1, i3status\(cqs nanosleep() will be interrupted and thus you will force an update\&. You can use killall \-USR1 i3status to force an update after changing the system volume, for example\&.
.SH "SEE ALSO"
.sp
strftime(3), date(1), glob(3), dzen2(1), xmobar(1)
.SH "AUTHORS"
.sp
Michael Stapelberg and contributors
.sp
Thorsten Toepper
.sp
Baptiste Daroussin
.sp
Axel Wagner
.sp
Fernando Tarlá Cardoso Lemos