Skip to content

Commit

Permalink
docs: update i3status manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
stapelberg committed Nov 5, 2024
1 parent 2d25b2c commit 083acb1
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 66 deletions.
24 changes: 18 additions & 6 deletions _docs/i3status.man
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
i3status(1)
===========
Michael Stapelberg <michael@i3wm.org>
v2.14, November 2021
v2.15, August 2024

== NAME

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

== SYNOPSIS

i3status [-c configfile] [-h] [-v]
i3status [-c configfile] [-h] [-v] [--run-once]

== OPTIONS

-c::
-c --config::
Specifies an alternate configuration file path. By default, i3status looks for
configuration files in the following order:

Expand All @@ -22,6 +22,16 @@ configuration files in the following order:
3. ~/.i3status.conf
4. /etc/i3status.conf

-h --help::
Print the verison and a minimal syntax.

-v --version::
Print the version and any build configuration.

--run-once::
Only run once instead of looping.


== DESCRIPTION

i3status is a small program for generating a status bar for i3bar, dzen2,
Expand Down Expand Up @@ -77,6 +87,7 @@ battery 0 {
status_bat = "🔋 BAT"
status_unk = "? UNK"
status_full = "☻ FULL"
status_idle = "☻ IDLE"
path = "/sys/class/power_supply/BAT%d/uevent"
low_threshold = 10
}
Expand Down Expand Up @@ -225,9 +236,10 @@ disk "/" {
=== IPv6

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

*Example format_up*: +%ip+
*Example format_up*: +%iface: %ip+

*Example format_down*: +no IPv6+

Expand Down Expand Up @@ -374,7 +386,7 @@ the number indicates the battery index as reported in /sys.

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, unknown, full)
for each state (charging, discharging, unknown, full).
Of course it will also work with special iconic fonts, such as FontAwesome.
If any of these special status strings are omitted, the default (CHR, BAT, UNK,
FULL) is used.
Expand Down
Loading

0 comments on commit 083acb1

Please sign in to comment.