From 03673d1071f414c9116d090032906750b76b0475 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Mon, 23 Mar 2015 09:31:50 +0100 Subject: [PATCH] update header to contain FAQ link, fix issues link (Thanks iosonofabio) fixes #2 --- _docs/conf/i3html.conf | 3 +- docs/buildbot.html | 7 +- docs/debugging-release-version.html | 7 +- docs/debugging.html | 3 +- docs/gsoc2013-ideas.html | 7 +- docs/hacking-howto.html | 3 +- docs/i3-config-wizard.html | 7 +- docs/i3-migrate-config-to-v4.html | 7 +- docs/i3-msg.html | 7 +- docs/i3-nagbar.html | 7 +- docs/i3.html | 7 +- docs/i3bar-protocol.html | 3 +- docs/i3status.html | 249 +++++++++++++++++++++++----- docs/ipc.html | 3 +- docs/layout-saving.html | 3 +- docs/multi-monitor.html | 3 +- docs/repositories.html | 7 +- docs/testsuite.html | 3 +- docs/tshirts.html | 7 +- docs/userguide.html | 3 +- docs/wsbar.html | 3 +- 21 files changed, 269 insertions(+), 80 deletions(-) diff --git a/_docs/conf/i3html.conf b/_docs/conf/i3html.conf index a4e2d44..7ff6f06 100644 --- a/_docs/conf/i3html.conf +++ b/_docs/conf/i3html.conf @@ -611,8 +611,9 @@ endif::latexmath[]
diff --git a/docs/buildbot.html b/docs/buildbot.html index 2e7fd6d..fc4a049 100644 --- a/docs/buildbot.html +++ b/docs/buildbot.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: The i3 buildbot setup @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/debugging-release-version.html b/docs/debugging-release-version.html index 5fc76ae..f0f4664 100644 --- a/docs/debugging-release-version.html +++ b/docs/debugging-release-version.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: Debugging i3: How To (release version) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
diff --git a/docs/debugging.html b/docs/debugging.html index d9e7b43..99ff408 100644 --- a/docs/debugging.html +++ b/docs/debugging.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
diff --git a/docs/gsoc2013-ideas.html b/docs/gsoc2013-ideas.html index 7bef056..2106265 100644 --- a/docs/gsoc2013-ideas.html +++ b/docs/gsoc2013-ideas.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: Google Summer of Code 2013 ideas @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/hacking-howto.html b/docs/hacking-howto.html index 8326751..931f4e7 100644 --- a/docs/hacking-howto.html +++ b/docs/hacking-howto.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/i3-config-wizard.html b/docs/i3-config-wizard.html index bdbee9c..f030f3c 100644 --- a/docs/i3-config-wizard.html +++ b/docs/i3-config-wizard.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3-config-wizard(1) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/i3-migrate-config-to-v4.html b/docs/i3-migrate-config-to-v4.html index 756fd4e..d7016e6 100644 --- a/docs/i3-migrate-config-to-v4.html +++ b/docs/i3-migrate-config-to-v4.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3-migrate-config-to-v4(1) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/i3-msg.html b/docs/i3-msg.html index 26fbd84..36a97cf 100644 --- a/docs/i3-msg.html +++ b/docs/i3-msg.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3-msg(1) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/i3-nagbar.html b/docs/i3-nagbar.html index 7d156a4..a4f4804 100644 --- a/docs/i3-nagbar.html +++ b/docs/i3-nagbar.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3-nagbar(1) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/i3.html b/docs/i3.html index b45f24a..76e49c5 100644 --- a/docs/i3.html +++ b/docs/i3.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3(1) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/i3bar-protocol.html b/docs/i3bar-protocol.html index 2bed449..5092368 100644 --- a/docs/i3bar-protocol.html +++ b/docs/i3bar-protocol.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
diff --git a/docs/i3status.html b/docs/i3status.html index c864268..4c1d257 100644 --- a/docs/i3status.html +++ b/docs/i3status.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3status(1) @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
@@ -31,8 +32,8 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a

i3status(1)

Michael Stapelberg
<michael@i3wm.org>
-version 2.6, -October 2012 +version 2.9, +March 2015
Table of Contents
@@ -41,7 +42,7 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a

1. NAME

-

i3status - Generates a status line for dzen2 or xmobar

+

i3status - Generates a status line for i3bar, dzen2 or xmobar

@@ -119,7 +120,8 @@ for a complete reference.

order += "ipv6" order += "disk /" order += "run_watch DHCP" -order += "run_watch VPN" +order += "run_watch VPNC" +order += "path_exists VPN" order += "wireless wlan0" order += "ethernet eth0" order += "battery 0" @@ -141,6 +143,10 @@ 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 } @@ -149,10 +155,16 @@ run_watch DHCP { pidfile = "/var/run/dhclient*.pid" } -run_watch VPN { +run_watch VPNC { + # file containing the PID of a vpnc process pidfile = "/var/run/vpnc/pid" } +path_exists VPN { + # path exists when a VPN tunnel launched by nmcli/nm-applet is active + path = "/proc/sys/net/ipv4/conf/tun0" +} + tztime local { format = "%Y-%m-%d %H:%M:%S" } @@ -191,7 +203,8 @@ character ("#").

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.

Using output_format you can chose which format strings i3status should @@ -229,12 +242,24 @@ with the xmonad Window Manager.

+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 +easier because the terminal-output of i3status becomes much more readable, but +should only used for such quick glances, because it will only support very +basic output-features (for example you only get 3 bits of color depth). +

+
+
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. +Does not use any color codes. Separates values by the pipe symbol by default. +This should be used with i3bar and can be used for custom scripts.

@@ -242,22 +267,94 @@ be used with i3bar and can be used for custom scripts. 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.

+

If you don’t fancy the vertical separators between modules i3status/i3bar +uses by default, you can employ the separator directive to configure how +modules are separated. You can either disable the default separator altogether +setting it to the empty string. You might then define separation as part of a +module’s format string. This is your only option when using the i3bar output +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.

+

Example configuration:

+
+
+
general {
+    output_format = "xmobar"
+    separator = "  "
+}
+
+order += "load"
+order += "disk /"
+
+load {
+    format = "[ load: %1min, %5min, %15min ]"
+}
+disk "/" {
+    format = "%avail"
+}
+

5.2. IPv6

This module gets the IPv6 address used for outgoing connections (that is, the best available public IPv6 address on your computer).

Example format_up: %ip

-

Example format_down no IPv6

+

Example format_down: no IPv6

5.3. Disk

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.

+

Byte sizes are presented in a human readable format using a set of prefixes +whose type can be specified via the "prefix_type" option. Three sets of +prefixes are available:

+
+
+binary +
+
+

+IEC prefixes (Ki, Mi, Gi, Ti) represent multiples of powers of 1024. +This is the default. +

+
+
+decimal +
+
+

+SI prefixes (k, M, G, T) represent multiples of powers of 1000. +

+
+
+custom +
+
+

+The custom prefixes (K, M, G, T) represent multiples of powers of 1024. +

+
+
+

It is possible to define a low_threshold that causes the disk text to be +displayed using color_bad. The low_threshold type can be of threshold_type +"bytes_free", "bytes_avail", "percentage_free", or "percentage_avail", where +the former two can be prepended by a generic prefix (k, m, g, t) having +prefix_type. So, if you configure low_threshold to 2, threshold_type to +"gbytes_avail", and prefix_type to "binary", and the remaining available disk +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 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

Example format: %percentage_used used, %percentage_free free, %percentage_avail avail

+

Example prefix_type: custom

+

Example low_threshold: 5

+

Example threshold_type: percentage_free

5.4. Run-watch

@@ -268,71 +365,96 @@ a specific application, such as a VPN client or your DHCP client is running.

Example format: %title: %status

-

5.5. 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.

+

5.5. Path-exists

+

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.

+

Example order: path_exists VPN

+

Example format: %title: %status

+
+
+

5.6. Wireless

+

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

-

5.6. Ethernet

+

5.7. Ethernet

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)

-

5.7. Battery

+

5.8. Battery

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.

+last_full_capacity = true. You can hide seconds in the remaining time and +empty time estimations by setting hide_seconds = 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.

+modify the "path" property accordingly, i.e. pointing to the uevent file on +your system. 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.

+

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

+

Example path: /sys/class/power_supply/CMB1/uevent

-

5.8. CPU-Temperature

+

5.9. CPU-Temperature

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

+

Example path: /sys/devices/platform/coretemp.0/temp1_input

-

5.9. CPU Usage

+

5.10. CPU Usage

Gets the percentual CPU usage from /proc/stat (Linux) or sysctl(3) (FreeBSD/OpenBSD).

Example order: cpu_usage

Example format: %usage

-

5.10. Load

+

5.11. Load

Gets the system load (number of processes waiting for CPU time in the last 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

+

Example max_threshold: "0,1"

-

5.11. Time

+

5.12. Time

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. @@ -341,7 +463,7 @@ See strftime(3) for details on the format string.

Example format: %Y-%m-%d %H:%M:%S

-

5.12. TzTime

+

5.13. 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. @@ -354,7 +476,7 @@ in the tztime module.

Example timezone: Europe/Berlin

-

5.13. DDate

+

5.14. 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.

@@ -362,20 +484,23 @@ details on the format string.

Example format: %{%a, %b %d%}, %Y%N - %H

-

5.14. Volume

+

5.15. 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, mixer and mixder_idx options can be +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.

+query /dev/mixer directly if mixer_dix is -1, otherwise +/dev/mixer+mixer_idx+.

Example order: volume master

-

Example format: ♪: %volume

+

Example format: ♪: %volume +Example format_muted: ♪: 0%%

Example configuration:

volume master {
         format = "♪: %volume"
+        format_muted = "♪: muted (%volume)"
         device = "default"
         mixer = "Master"
         mixer_idx = 0
@@ -385,7 +510,51 @@ query /dev/mixer directly.
-

6. Using i3status with dzen2

+

6. Universal module options

+
+

When using the i3bar output format, there are a few additional options that +can be used with all modules to customize their appearance:

+
+
+align +
+
+

+ The alignment policy to use when the minimum width (see below) is not + reached. Either center (default), right or left. +

+
+
+min_width +
+
+

+ The minimum width (in pixels) the module should occupy. If the module takes + less space than the specified size, the block will be padded to the left + and/or the right side, according to the defined alignment policy. This is + useful when you want to prevent the whole status line from shifting when + values take more or less space between each iteration. + The option can also be a string. In this case, the width of the given text + determines the minimum width of the block. This is useful when you want to + set a sensible minimum width regardless of which font you are using, and at + what particular size. Please note that a number enclosed with quotes will + still be treated as a number. +

+
+
+

Example configuration:

+
+
+
disk "/" {
+    format = "%avail"
+    align = "left"
+    min_width = 100
+}
+
+
+
+
+

7. Using i3status with dzen2

After installing dzen2, you can directly use it with i3status. Just ensure that output_format is set to dzen2.

@@ -398,7 +567,7 @@ query /dev/mixer directly.

-

7. Using i3status with xmobar

+

8. Using i3status with xmobar

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 @@ -411,7 +580,7 @@ is set to xmobar.

-

8. What about memory usage or CPU frequency?

+

9. What about memory usage or CPU frequency?

While talking about two specific things, please understand this section as a general explanation why your favorite information is not included in i3status.

@@ -444,7 +613,7 @@ with additional boring tasks like repeatedly checking a number.

-

9. External scripts/programs with i3status

+

10. External scripts/programs with i3status

In i3status, we don’t want to implement process management again. Therefore, there is no module to run arbitrary scripts or commands. Instead, you should @@ -468,7 +637,7 @@ contrib/ folder, see http:/

-

10. SIGNALS

+

11. 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 @@ -476,13 +645,13 @@ after changing the system volume, for example.

-

11. SEE ALSO

+

12. SEE ALSO

strftime(3), date(1), glob(3), dzen2(1), xmobar(1)

-

12. AUTHORS

+

13. AUTHORS

Michael Stapelberg and contributors

Thorsten Toepper

diff --git a/docs/ipc.html b/docs/ipc.html index 7ecaaea..57e5eb1 100644 --- a/docs/ipc.html +++ b/docs/ipc.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/layout-saving.html b/docs/layout-saving.html index 0eabbfc..ec1594c 100644 --- a/docs/layout-saving.html +++ b/docs/layout-saving.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/multi-monitor.html b/docs/multi-monitor.html index 3209372..06f5d37 100644 --- a/docs/multi-monitor.html +++ b/docs/multi-monitor.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/repositories.html b/docs/repositories.html index 2edeb66..485e811 100644 --- a/docs/repositories.html +++ b/docs/repositories.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: Debian and Ubuntu repositories @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
diff --git a/docs/testsuite.html b/docs/testsuite.html index 7897170..8af4a84 100644 --- a/docs/testsuite.html +++ b/docs/testsuite.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/tshirts.html b/docs/tshirts.html index d5cc62b..04df491 100644 --- a/docs/tshirts.html +++ b/docs/tshirts.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3wm T-shirts @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/userguide.html b/docs/userguide.html index 90ec283..05da6d2 100644 --- a/docs/userguide.html +++ b/docs/userguide.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
diff --git a/docs/wsbar.html b/docs/wsbar.html index 8d47446..c7c1db2 100644 --- a/docs/wsbar.html +++ b/docs/wsbar.html @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
-- 2.39.2