X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=man%2Fi3status.man;h=0fccb7e417376be1bb5bb0d85a2f3cf428a6a47d;hb=5e0b8812bfdd3c128bdbfc022d4eb25a4b0d2490;hp=8cac1bb7c9196eb83e694e783c8d098207c1a21d;hpb=192c38466d12ab0fc94c68ce1f826555942d1ae1;p=i3%2Fi3status diff --git a/man/i3status.man b/man/i3status.man index 8cac1bb..0fccb7e 100644 --- a/man/i3status.man +++ b/man/i3status.man @@ -1,7 +1,7 @@ i3status(1) =========== -Michael Stapelberg -v2.4, December 2011 +Michael Stapelberg +v2.6, October 2012 == NAME @@ -56,7 +56,8 @@ order += "ethernet eth0" order += "battery 0" order += "cpu_temperature 0" order += "load" -order += "time" +order += "tztime local" +order += "tztime berlin" wireless wlan0 { format_up = "W: (%quality at %essid, %bitrate) %ip" @@ -71,7 +72,9 @@ ethernet eth0 { battery 0 { format = "%status %percentage %remaining %emptytime" + format_down = "No battery" path = "/sys/class/power_supply/BAT%d/uevent" + low_threshold = 10 } run_watch DHCP { @@ -82,8 +85,13 @@ run_watch VPN { pidfile = "/var/run/vpnc/pid" } -time { - format = "%Y-%m-%d %H:%M:%S" +tztime local { + format = "%Y-%m-%d %H:%M:%S" +} + +tztime berlin { + format = "%Y-%m-%d %H:%M:%S %Z" + timezone = "Europe/Berlin" } load { @@ -142,6 +150,11 @@ none:: Does not use any color codes. Separates values by the pipe symbol. This should be used with i3bar and can be used for custom scripts. +It's 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. + === IPv6 This module gets the IPv6 address used for outgoing connections (that is, the @@ -155,10 +168,15 @@ best available public IPv6 address on your computer). Gets used, free, available and total amount of bytes on the given mounted filesystem. +These values can also be expressed in percentages with the percentage_used, +percentage_free, percentage_avail and percentage_used_of_avail formats. + *Example order*: +disk /mnt/usbstick+ *Example format*: +%free (%avail)/ %total+ +*Example format*: +%percentage_used used, %percentage_free free, %percentage_avail avail+ + === Run-watch Expands the given path to a pidfile and checks if the process ID found inside @@ -191,33 +209,49 @@ it using +setcap cap_net_admin=ep $(which i3status)+. === Battery -Gets the status (charging, discharging, running), percentage and remaining -time of the given battery and when it's 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 +Gets the status (charging, discharging, running), percentage, remaining +time and power consumption (in Watts) of the given battery and when it's +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+. +If you want the battery percentage to be shown without decimals, add ++integer_battery_capacity = true+. + If your battery is represented in a non-standard path in /sys, be sure to modify the "path" property accordingly. The first occurence of %d gets replaced with the battery number, but you can just hard-code a path as well. +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. + *Example order*: +battery 0+ -*Example format*: +%status %remaining (%emptytime)+ +*Example format*: +%status %remaining (%emptytime %consumption)+ + +*Example low_threshold*: +30+ + +*Example threshold_type*: +time+ === CPU-Temperature -Gets the temperature of the given thermal zone. +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. *Example order*: +cpu_temperature 0+ *Example format*: +T: %degrees °C+ +*Example max_threshold*: +42+ + === CPU Usage -Gets the percentual CPU usage from +/proc/stat+. +Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD). *Example order*: +cpu_usage+ @@ -226,20 +260,43 @@ Gets the percentual CPU usage from +/proc/stat+. === Load Gets the system load (number of processes waiting for CPU time in the last -1, 5 and 15 minutes). +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. *Example order*: +load+ *Example format*: +%1min %5min %15min+ +*Example max_threshold*: 5 + === Time -Formats the current system time. See +strftime(3)+ for the format. +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. *Example order*: +time+ *Example format*: +%Y-%m-%d %H:%M:%S+ +=== TzTime + +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's 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. + +*Example order*: +tztime berlin+ + +*Example format*: +%Y-%m-%d %H:%M:%S %Z+ + +*Example timezone*: +Europe/Berlin+ + === DDate Outputs the current discordian date in user-specified format. See +ddate(1)+ for @@ -254,6 +311,10 @@ details on the format string. Outputs the volume of the specified mixer on the specified device. Works only on Linux because it uses ALSA. +A simplified configuration can be used on FreeBSD and OpenBSD due to +the lack of ALSA, the +device+, +mixer+ and +mixder_idx+ options can be +ignored on these systems. On these systems the OSS API is used instead to +query +/dev/mixer+ directly. *Example order*: +volume master+ @@ -346,6 +407,16 @@ done Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i3status. +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 http://code.i3wm.org/i3status/tree/contrib + +== SIGNALS + +When receiving +SIGUSR1+, i3status’s 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. + == SEE ALSO +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+