X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=man%2Fi3status.man;h=afe4fda9ff2776154f9fed1ee613263f6df3b095;hb=aa05cd73a77057fab43e04740259d0736729c731;hp=d73c6cc3edb3c8329cbe115c4c78f4424e527530;hpb=1815ea410db7439b7d0c574cb49bd017776da0fd;p=i3%2Fi3status diff --git a/man/i3status.man b/man/i3status.man index d73c6cc..afe4fda 100644 --- a/man/i3status.man +++ b/man/i3status.man @@ -1,7 +1,7 @@ i3status(1) =========== Michael Stapelberg -v2, October 2009 +v2.2, September 2010 == NAME @@ -21,7 +21,7 @@ or ~/.i3status.conf). i3status is a small program (less than 1000 SLOC) for generating a status bar for dzen2, xmobar or similar programs. It is designed to be very efficient by -issuing a very small number of systemcalls, as one generally wants to update +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. @@ -40,8 +40,9 @@ for a complete reference. .Sample configuration ------------------------------------------------------------- general { + output_format = "dzen2" colors = true - interval = 5 + interval = 5 } order = "ipv6" @@ -56,17 +57,17 @@ order += "load" order += "time" wireless wlan0 { - format_up = "W: (%quality at %essid) %ip" + format_up = "W: (%quality at %essid, %bitrate) %ip" format_down = "W: down" } ethernet eth0 { - # if you use %speed, i3status requires root privileges + # if you use %speed, i3status requires the cap_net_admin capability format = "E: %ip (%speed)" } battery 0 { - format = "%status %remaining" + format = "%status %percentage %remaining" } run_watch DHCP { @@ -96,24 +97,52 @@ disk "/" { === General -The colors directive will disable all colors if you set it to +false+. -+interval+ is the time in seconds which i3status will sleep until printing -the next status line. +The +colors+ directive will disable all colors if you set it to +false+. You can +also specify the colors that will be used to display "good", "degraded" or "bad" +values using the +color_good+, +color_degraded+ or +color_bad+ directives, +respectively. Those directives are only used if color support is not disabled by +the +colors+ directive. The input format for color values is the canonical RGB +hexadecimal triplet (with no separators between the colors), prefixed by a hash +character ("#"). + +*Example color_good*: +#00FF00+ + +Likewise, you can use the +color_separator+ directive to specify the color that +will be used to paint the separator bar. The separator is always output in +color, even when colors are disabled by the +colors+ directive. + +The +interval+ directive specifies the time in seconds for which i3status will +sleep before printing the next status line. + +Using +output_format+ you can chose which format strings i3status should +use in its output. Currently available are: + +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 +xmobar:: +xmobar is a minimalistic, text based, status bar. It was designed to work +with the xmonad Window Manager. +none:: +Does not use any color codes. Separates values by the pipe symbol. === IPv6 This module gets the IPv6 address used for outgoing connections (that is, the best available public IPv6 address on your computer). -*Example format*: +%ip+ +*Example format_up*: +%ip+ + +*Example format_down* +no IPv6+ === Disk -Gets used, free and total amount of bytes on the given mounted filesystem. +Gets used, free, available and total amount of bytes on the given mounted filesystem. *Example order*: +disk /mnt/usbstick+ -*Example format*: +%free / %total+ +*Example format*: +%free (%avail)/ %total+ === Run-watch @@ -131,12 +160,13 @@ connected. *Example order*: +wireless wlan0+ -*Example format*: +W: (%quality at %essid) %ip+ +*Example format*: +W: (%quality at %essid, %bitrate) %ip+ === Ethernet Gets the IP address and (if possible) the link speed of the given ethernet -interface. Getting the link speed requires root privileges. +interface. Getting the link speed requires the cap_net_admin capability. Set +it using +setcap cap_net_admin=ep $(which i3status)+. *Example order*: +ethernet eth0+ @@ -145,7 +175,11 @@ interface. Getting the link speed requires root privileges. === Battery Gets the status (charging, discharging, running), percentage and remaining -time of the given battery. +time of the given battery. 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+. *Example order*: +battery 0+ @@ -176,6 +210,35 @@ Formats the current system time. See +strftime(3)+ for the format. *Example format*: +%Y-%m-%d %H:%M:%S+ +=== DDate + +Outputs the current discordian date in user-specified format. See +ddate(1)+ for +details on the format string. +*Note*: Neither *%.* nor *%X* are implemented yet. + +*Example order*: +ddate+ + +*Example format*: +%{%a, %b %d%}, %Y%N - %H+ + +=== Volume + +Outputs the volume of the specified mixer on the specified device. Works only +on Linux because it uses ALSA. + +*Example order*: +volume master+ + +*Example format*: +♪: %volume+ + +*Example configuration*: +------------------------------------------------------------- +volume master { + format = "♪: %volume" + device = "default" + mixer = "Master" + mixer_idx = 0 +} +------------------------------------------------------------- + == Using i3status with dzen2 After installing dzen2, you can directly use it with i3status: