]> git.sur5r.net Git - i3/i3status/blobdiff - man/i3status.man
man: fix typo for max_threshold in load
[i3/i3status] / man / i3status.man
index 01fa9ce5cd2d8b5030dfdf98e20a44587e556e69..7d27ae32ad043ecb8c74bd3671ba33ae86296f69 100644 (file)
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael@i3wm.org>
-v2.11, January 2017
+v2.12, May 2018
 
 == NAME
 
@@ -55,6 +55,7 @@ order += "wireless wlan0"
 order += "ethernet eth0"
 order += "battery 0"
 order += "cpu_temperature 0"
+order += "memory"
 order += "load"
 order += "tztime local"
 order += "tztime berlin"
@@ -65,7 +66,6 @@ wireless wlan0 {
 }
 
 ethernet eth0 {
-        # if you use %speed, i3status requires the cap_net_admin capability
         format_up = "E: %ip (%speed)"
         format_down = "E: down"
 }
@@ -113,6 +113,12 @@ cpu_temperature 0 {
        path = "/sys/devices/platform/coretemp.0/temp1_input"
 }
 
+memory {
+        format = "%used"
+        threshold_degraded = "10%"
+        format_degraded = "MEMORY: %free"
+}
+
 disk "/" {
        format = "%free"
 }
@@ -153,7 +159,7 @@ etc.).
 dzen2::
 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
+managers like dwm, wmii and xmonad though it will work with any window manager
 xmobar::
 xmobar is a minimalistic, text based, status bar. It was designed to work
 with the xmonad Window Manager.
@@ -192,6 +198,7 @@ double-quote (""") characters need to be replaced with "`&amp;`", "`&lt;`",
 for generated content (e.g. wireless ESSID, time).
 
 *Example configuration*:
+
 -------------------------------------------------------------
 general {
     output_format = "xmobar"
@@ -292,7 +299,8 @@ There also is an option "format_down". You can hide the output with
 
 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.
+connected or not connected. The quality is padded with leading zeroes by
+default; to pad with something else use +format_quality+.
 
 The special interface name `_first_` will be replaced by the first wireless
 network interface found on the system (excluding devices starting with "lo").
@@ -303,12 +311,13 @@ network interface found on the system (excluding devices starting with "lo").
 
 *Example format_down*: +W: down+
 
+*Example format_quality*: +"%03d%s"+
+
 === Ethernet
 
 Gets the IP address and (if possible) the link speed of the given ethernet
 interface. If no IPv4 address is available and an IPv6 address is, it will be
-displayed. Getting the link speed requires the cap_net_admin capability.
-Set it using +setcap cap_net_admin=ep $(which i3status)+.
+displayed.
 
 The special interface name `_first_` will be replaced by the first non-wireless
 network interface found on the system (excluding devices starting with "lo").
@@ -327,8 +336,8 @@ 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’s 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+.
++last_full_capacity = true+. You can show seconds in the remaining time and
+empty time estimations by setting +hide_seconds = false+.
 
 If you want the battery percentage to be shown without decimals, add
 +integer_battery_capacity = true+.
@@ -428,6 +437,45 @@ starting from %cpu0. This feature is currently not supported in FreeBSD.
 
 *Example format_above_degraded_threshold*: +Warning above degraded threshold: %usage+
 
+=== Memory
+
+Gets the memory usage from system on a Linux system from +/proc/meminfo+. Other
+systems are currently not supported.
+
+As format placeholders, +total+, +used+, +free+, +available+ and +shared+ are
+available. These will print human readable values. It's also possible to prefix
+the placeholders with +percentage_+ to get a value in percent.
+
+It's possible to define a +threshold_degraded+ and a +threshold_critical+ to
+color the status bar output in yellow or red, if the available memory falls
+below the given threshold. Possible values of the threshold can be any integer,
+suffixed with an iec symbol (+T+, +G+, +M+, +K+). Alternatively, the integer
+can be suffixed by a percent sign, which then rets evaluated relatively to
+total memory.
+
+If the +format_degraded+ parameter is given and either the critical or the
+degraded threshold applies, +format_degraded+ will get used as format string.
+It acts equivalently to +format+.
+
+As Linux' meminfo doesn't expose the overall memory in use, there are multiple
+methods to distinguish the actually used memory. 
+
+*Example memory_used_method*: +memavailable+ ("total memory" - "MemAvailable", matches +free+ command)
+
+*Example memory_used_method*: +classical+ ("total memory" - "free" - "buffers" - "cache", matches gnome system monitor)
+
+*Example order*: +memory+
+
+*Example format*: +%free %available (%used) / %total+
+
+*Example format*: +%percentage_used used, %percentage_free free, %percentage_shared shared+
+
+*Example threshold_degraded*: +10%+
+
+*Example threshold_critical*: +5%+
+
+*Example format_degraded*: +Memory LOW: %free+
+
 === Load
 
 Gets the system load (number of processes waiting for CPU time in the last
@@ -441,7 +489,7 @@ format_above_threshold.
 
 *Example format*: +%1min %5min %15min+
 
-*Example max_threshold*: +"0,1"+
+*Example max_threshold*: +"0.1"+
 
 *Example format_above_threshold*: +Warning: %1min %5min %15min+
 
@@ -602,7 +650,7 @@ disk "/" {
 == Using i3status with dzen2
 
 After installing dzen2, you can directly use it with i3status. Just ensure that
-+output_format+ is set to +dzen2+.
++output_format+ is set to +dzen2+. *Note*: +min_width+ is not supported.
 
 *Example for usage of i3status with dzen2*:
 --------------------------------------------------------------
@@ -614,32 +662,19 @@ i3status | dzen2 -fg white -ta r -w 1280 \
 
 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+.
+is set to +xmobar+. *Note*: +min_width+ is not supported.
 
 *Example for usage of i3status with xmobar*:
 ---------------------------------------------------------------------
 i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
 ---------------------------------------------------------------------
 
-== What about memory usage or CPU frequency?
+== What about CPU frequency?
 
-While talking about two specific things, please understand this section as a
+While talking about specific things, please understand this section as a
 general explanation why your favorite information is not included in i3status.
 
-Let’s 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’s 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’t 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.
-
-For CPU frequency, the situation is similar. Many people don’t understand how
+Let’s talk about CPU frequency specifically. Many people don’t 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’t
@@ -651,10 +686,9 @@ a WiFi network or not, and if you have enough disk space to fit that 4.3 GiB
 download.
 
 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.
+while, you are probably better off with a script doing that, which pops up.
+After all, the point of computers is not to burden you with additional boring
+tasks like repeatedly checking a number.
 
 == External scripts/programs with i3status