add format_quality option in wireless

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 9569828c774a7a5fe6cda458191100d10df08e64..86f6216b4fa0f3d81506ae921e790f73d63f9252 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael@i3wm.org>
 i3status(1)
 ===========
 Michael Stapelberg <michael@i3wm.org>

-v2.11, January 2017
+v2.12, May 2018

 
 == NAME
 
 
 == NAME
 


@@ -24,13 +24,12 @@ configuration files in the following order:
 
 == DESCRIPTION
 
 
 == 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
 
 
 == CONFIGURATION
 


@@ -56,6 +55,7 @@ order += "wireless wlan0"
 order += "ethernet eth0"
 order += "battery 0"
 order += "cpu_temperature 0"
 order += "ethernet eth0"
 order += "battery 0"
 order += "cpu_temperature 0"

+order += "memory"

 order += "load"
 order += "tztime local"
 order += "tztime berlin"
 order += "load"
 order += "tztime local"
 order += "tztime berlin"


@@ -114,6 +114,12 @@ cpu_temperature 0 {
        path = "/sys/devices/platform/coretemp.0/temp1_input"
 }
 
        path = "/sys/devices/platform/coretemp.0/temp1_input"
 }
 

+memory {
+        format = "%used"
+        threshold_degraded = "10%"
+        format_degraded = "MEMORY: %free"
+}
+

 disk "/" {
        format = "%free"
 }
 disk "/" {
        format = "%free"
 }


@@ -154,7 +160,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
 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.
 xmobar::
 xmobar is a minimalistic, text based, status bar. It was designed to work
 with the xmonad Window Manager.


@@ -193,6 +199,7 @@ double-quote (""") characters need to be replaced with "`&amp;`", "`&lt;`",
 for generated content (e.g. wireless ESSID, time).
 
 *Example configuration*:
 for generated content (e.g. wireless ESSID, time).
 
 *Example configuration*:

+

 -------------------------------------------------------------
 general {
     output_format = "xmobar"
 -------------------------------------------------------------
 general {
     output_format = "xmobar"


@@ -293,14 +300,19 @@ 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
 
 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").
 
 *Example order*: +wireless wlan0+
 
 
 The special interface name `_first_` will be replaced by the first wireless
 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+
+
+*Example format_quality*: +"%03d%s"+

 
 === Ethernet
 
 
 === Ethernet
 


@@ -314,7 +326,9 @@ network interface found on the system (excluding devices starting with "lo").
 
 *Example order*: +ethernet eth0+
 
 
 *Example order*: +ethernet eth0+
 

-*Example format*: +E: %ip (%speed)+
+*Example format_up*: +E: %ip (%speed)+
+
+*Example format_down*: +E: down+

 
 === Battery
 
 
 === Battery
 


@@ -425,6 +439,45 @@ starting from %cpu0. This feature is currently not supported in FreeBSD.
 
 *Example format_above_degraded_threshold*: +Warning above degraded threshold: %usage+
 
 
 *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
 === Load
 
 Gets the system load (number of processes waiting for CPU time in the last