X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=man%2Fi3status.man;h=fecd0791ea95ed97ff8ef953a59a684dce7ba314;hb=a916481aab2d81b1882a25da34a2fe327d74cff4;hp=d1d62030130fcea8448830b9db6a67f4b5109ba5;hpb=35bb9a06fb102574b68a443ccfba470a6150ba52;p=i3%2Fi3status diff --git a/man/i3status.man b/man/i3status.man index d1d6203..fecd079 100644 --- a/man/i3status.man +++ b/man/i3status.man @@ -1,7 +1,7 @@ i3status(1) =========== Michael Stapelberg -v2.11, January 2017 +v2.12, May 2018 == NAME @@ -24,13 +24,12 @@ configuration files in the following order: == DESCRIPTION -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. +i3status is a small program 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. == CONFIGURATION @@ -56,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" @@ -66,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" } @@ -114,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" } @@ -154,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. @@ -193,6 +198,7 @@ double-quote (""") characters need to be replaced with "`&`", "`<`", for generated content (e.g. wireless ESSID, time). *Example configuration*: + ------------------------------------------------------------- general { output_format = "xmobar" @@ -300,20 +306,24 @@ network interface found on the system (excluding devices starting with "lo"). *Example order*: +wireless wlan0+ -*Example format*: +W: (%quality at %essid, %bitrate / %frequency) %ip+ +*Example format_up*: +W: (%quality at %essid, %bitrate / %frequency) %ip+ + +*Example format_down*: +W: down+ === Ethernet 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)+. +interface. If no IPv4 address is available and an IPv6 address is, it will be +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"). *Example order*: +ethernet eth0+ -*Example format*: +E: %ip (%speed)+ +*Example format_up*: +E: %ip (%speed)+ + +*Example format_down*: +E: down+ === Battery @@ -424,6 +434,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