]> git.sur5r.net Git - i3/i3status/blobdiff - man/i3status.man
fix ethernet speed display for 100 Gbit/s cards
[i3/i3status] / man / i3status.man
index 396fb0a4daa108f1b65e29b42453910a5452cf03..4bc7d0aecb5817778838483bf6fc98356445c2ae 100644 (file)
@@ -97,6 +97,7 @@ path_exists VPN {
 
 tztime local {
         format = "%Y-%m-%d %H:%M:%S"
+        hide_if_equals_localtime = true
 }
 
 tztime berlin {
@@ -299,7 +300,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").
@@ -310,6 +312,8 @@ 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
@@ -486,7 +490,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+
 
@@ -511,6 +515,8 @@ 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.
+To display time only when the set timezone has different time from localtime, set
++hide_if_equals_localtime+ to true.
 
 *Example order*: +tztime berlin+
 
@@ -530,6 +536,7 @@ tztime berlin {
        format = "<span foreground='#ffffff'>time:</span> %time"
        format_time = "%H:%M %Z"
        timezone = "Europe/Berlin"
+       hide_if_equals_localtime = true
 }
 -------------------------------------------------------------
 
@@ -574,9 +581,9 @@ to "default", PulseAudio will be tried if detected and will fallback to ALSA
 
 *Example order*: +volume master+
 
-*Example format*: +♪: %volume+
+*Example format*: +♪ (%devicename): %volume+
 
-*Example format_muted*: +♪: 0%%+
+*Example format_muted*: +♪ (%devicename): 0%%+
 
 *Example configuration*:
 -------------------------------------------------------------
@@ -647,7 +654,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*:
 --------------------------------------------------------------
@@ -659,32 +666,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
@@ -696,10 +690,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