X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=man%2Fi3status.man;h=0b5b36765b0e7088492a368adc7e7450790b853c;hb=dcd0518e25d7aa84a720780cb70b3f8fca867972;hp=1182e5407b5531c7425caa07d17831c91d395275;hpb=bc0bd8c9e03d92ab133f4dfae52dc202c3e0cbf6;p=i3%2Fi3status diff --git a/man/i3status.man b/man/i3status.man index 1182e54..0b5b367 100644 --- a/man/i3status.man +++ b/man/i3status.man @@ -1,11 +1,11 @@ i3status(1) =========== Michael Stapelberg -v2.8, January 2014 +v2.9, March 2015 == NAME -i3status - Generates a status line for i3bar, dzen2 or xmobar +i3status - Generates a status line for i3bar, dzen2, xmobar or lemonbar == SYNOPSIS @@ -25,7 +25,7 @@ configuration files in the following order: == DESCRIPTION i3status is a small program (about 1500 SLOC) for generating a status bar for -i3bar, dzen2, xmobar or similar programs. It is designed to be very +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 @@ -74,6 +74,9 @@ ethernet eth0 { battery 0 { format = "%status %percentage %remaining %emptytime" format_down = "No battery" + status_chr = "⚇ CHR" + status_bat = "⚡ BAT" + status_full = "☻ FULL" path = "/sys/class/power_supply/BAT%d/uevent" low_threshold = 10 } @@ -132,7 +135,8 @@ 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. +color, even when colors are disabled by the +colors+ directive. This option has +no effect when +output_format+ is set to +i3bar+ or +none+. The +interval+ directive specifies the time in seconds for which i3status will sleep before printing the next status line. @@ -153,6 +157,9 @@ 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. +lemonbar:: +lemonbar is a lightweight bar based entirely on XCB. It has full UTF-8 support +and is EWMH compliant. term:: Use ANSI Escape sequences to produce a terminal-output as close as possible to the graphical outputs. This makes debugging your config file a little bit @@ -177,6 +184,13 @@ format as the separator is drawn by i3bar directly otherwise. For the other output formats, the provided non-empty string will be automatically enclosed with the necessary coloring bits if color support is enabled. +i3bar supports Pango markup, allowing your format strings to specify font +color, size, etc. by setting the +markup+ directive to "pango". Note that the +ampersand ("&"), less-than ("<"), greater-than (">"), single-quote ("'"), and +double-quote (""") characters need to be replaced with "`&`", "`<`", +"`>`", "`'`", and "`"`" respectively. This is done automatically +for generated content (e.g. wireless ESSID, time). + *Example configuration*: ------------------------------------------------------------- general { @@ -233,6 +247,11 @@ space is below 2 GiB, it will be colored bad. If not specified, threshold_type is assumed to be "percentage_avail" and low_threshold to be set to 0, which implies no coloring at all. +You can define a different format with the option "format_not_mounted" +which is used if the path does not exist or is not a mount point. So you can just empty +the output for the given path with adding +format_not_mounted=""+ +to the config section. + *Example order*: +disk /mnt/usbstick+ *Example format*: +%free (%avail)/ %total+ @@ -250,6 +269,8 @@ implies no coloring at all. Expands the given path to a pidfile and checks if the process ID found inside is valid (that is, if the process is running). You can use this to check if a specific application, such as a VPN client or your DHCP client is running. +There also is an option "format_down". You can hide the output with ++format_down=""+. *Example order*: +run_watch DHCP+ @@ -259,6 +280,8 @@ a specific application, such as a VPN client or your DHCP client is running. Checks if the given path exists in the filesystem. You can use this to check if something is active, like for example a VPN tunnel managed by NetworkManager. +There also is an option "format_down". You can hide the output with ++format_down=""+. *Example order*: +path_exists VPN+ @@ -266,13 +289,16 @@ something is active, like for example a VPN tunnel managed by NetworkManager. === Wireless -Gets the link quality and ESSID of the given wireless network interface. You -can specify different format strings for the network being connected or not -connected. +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. + +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) %ip+ +*Example format*: +W: (%quality at %essid, %bitrate / %frequency) %ip+ === Ethernet @@ -280,6 +306,9 @@ 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)+. +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)+ @@ -308,12 +337,25 @@ 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. +Optionally custom strings including any UTF-8 symbols can be used for different +battery states. This makes it possible to display individual symbols +for each state (charging, discharging, full) +Of course it will also work with special iconic fonts, such as FontAwesome. +If any of this special status strings is omitted, the default (CHR, BAT, FULL) +is used. + *Example order*: +battery 0+ *Example format*: +%status %remaining (%emptytime %consumption)+ *Example format_down*: +No battery+ +*Example status_chr*: +⚇ CHR+ + +*Example status_bat*: +⚡ BAT+ + +*Example status_full*: +☻ FULL+ + *Example low_threshold*: +30+ *Example threshold_type*: +time+ @@ -382,6 +424,18 @@ in the +tztime+ module. *Example timezone*: +Europe/Berlin+ +If you would like to use markup in this section, there is a separate ++format_time+ option that is automatically escaped. Its output then replaces +%time in the format string. + +*Example configuration (markup)*: +------------------------------------------------------------- +tztime time { + format = "time: %time" + format_time = "%H:%M %Z" +} +------------------------------------------------------------- + === DDate Outputs the current discordian date in user-specified format. See +ddate(1)+ for @@ -394,17 +448,31 @@ details on the format string. === Volume -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+ and +mixer+ options can be -ignored on these systems. On these systems the OSS API is used instead to -query +/dev/mixer+ directly if +mixer_dix+ is -1, otherwise -+/dev/mixer++mixer_idx+. +Outputs the volume of the specified mixer on the specified device. PulseAudio +and ALSA (Linux only) are supported. If PulseAudio is absent, a simplified +configuration can be used on FreeBSD and OpenBSD due to the lack of ALSA, the ++device+ and +mixer+ options can be ignored on these systems. On these systems +the OSS API is used instead to query +/dev/mixer+ directly if +mixer_idx+ is +-1, otherwise +/dev/mixer++mixer_idx+. + +To get PulseAudio volume information, one must use the following format in the +device line: + + device = "pulse" + +or + + device = "pulse:N" + +where N is the index of the PulseAudio sink. If no sink is specified the +default is used. If the device string is missing or is set to "default", +PulseAudio will be tried if detected and will fallback to ALSA (Linux) +or OSS (FreeBSD/OpenBSD). *Example order*: +volume master+ *Example format*: +♪: %volume+ + *Example format_muted*: +♪: 0%%+ *Example configuration*: @@ -417,6 +485,14 @@ volume master { mixer_idx = 0 } ------------------------------------------------------------- +*Example configuration (PulseAudio)*: +------------------------------------------------------------- +volume master { + format = "♪: %volume" + format_muted = "♪: muted (%volume)" + device = "pulse:1" +} +------------------------------------------------------------- == Universal module options