marco/i3status
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

format the leftover directives

Browse Source
This commit is contained in:
Mohammed Ismail Ansari 2020-03-29 18:29:28 -05:00 committed by GitHub
parent 15429ef58a
commit 487f0f8da4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
man/i3status.man
View File

@ -235,8 +235,8 @@ best available public IPv6 address on your computer).
Gets used, free, available and total amount of bytes on the given mounted filesystem. 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, These values can also be expressed in percentages with the +percentage_used+,
percentage_free, percentage_avail and percentage_used_of_avail formats. +percentage_free+, +percentage_avail+ and +percentage_used_of_avail+ formats.
Byte sizes are presented in a human readable format using a set of prefixes 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 whose type can be specified via the "prefix_type" option. Three sets of
@ -250,16 +250,16 @@ SI prefixes (k, M, G, T) represent multiples of powers of 1000.
custom:: custom::
The custom prefixes (K, M, G, T) represent multiples of powers of 1024. 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 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 displayed using +color_bad+. The +low_threshold+ type can be of +threshold_type+
"bytes_free", "bytes_avail", "percentage_free", or "percentage_avail", where "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 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 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 "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 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 is assumed to be "percentage_avail" and +low_threshold+ to be set to 0, which
implies no coloring at all. You can customize the output format when below implies no coloring at all. You can customize the output format when below
low_threshold with format_below_threshold. +low_threshold+ with +format_below_threshold.+
You can define a different format with the option "format_not_mounted" 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. Defaults to "". which is used if the path does not exist or is not a mount point. Defaults to "".
@ -283,7 +283,7 @@ which is used if the path does not exist or is not a mount point. Defaults to ""
Expands the given path to a pidfile and checks if the process ID found inside 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 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. 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 There also is an option +format_down+. You can hide the output with
+format_down=""+. +format_down=""+.
*Example order*: +run_watch DHCP+ *Example order*: +run_watch DHCP+
@ -294,7 +294,7 @@ There also is an option "format_down". You can hide the output with
Checks if the given path exists in the filesystem. You can use this to check if 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. 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 There also is an option +format_down+. You can hide the output with
+format_down=""+. +format_down=""+.
*Example order*: +path_exists VPN+ *Example order*: +path_exists VPN+
@ -358,14 +358,15 @@ If you want the battery percentage to be shown in another format, use
+format_percentage = "%.00f%s"+ +format_percentage = "%.00f%s"+
If your battery is represented in a non-standard path in /sys, be sure to If your battery is represented in a non-standard path in /sys, be sure to
modify the "path" property accordingly, i.e. pointing to the uevent file on modify the +path+ property accordingly, i.e. pointing to the uevent file on
your system. The first occurrence of %d gets replaced with the battery number, your system. The first occurrence of %d gets replaced with the battery number,
but you can just hard-code a path as well. 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 It is possible to define a low_threshold that causes the battery text to be
colored +color_bad+. The low_threshold type can be of threshold_type "time" or colored +color_bad+. The +low_threshold+ type can be of +threshold_type+ "time"
"percentage". So, if you configure low_threshold to 10 and threshold_type to or "percentage". So, if you configure +low_threshold+ to 10 and +threshold_type+
"time", and your battery lasts another 9 minutes, it will be colored red. to "time", and your battery lasts another 9 minutes, it will be colored
+color_bad+.
To show an aggregate of all batteries in the system, use "all" as the number. In To show an aggregate of all batteries in the system, use "all" as the number. In
this case (for Linux), the /sys path must contain the "%d" sequence. Otherwise, this case (for Linux), the /sys path must contain the "%d" sequence. Otherwise,
@ -407,10 +408,10 @@ FULL) is used.
=== CPU-Temperature === CPU-Temperature
Gets the temperature of the given thermal zone. It is possible to 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 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. The specified thermal zone is getting too hot. Defaults to 75 degrees C. The
output format when above max_threshold can be customized with output format when above +max_threshold+ can be customized with
format_above_threshold. +format_above_threshold+.
*Example order*: +cpu_temperature 0+ *Example order*: +cpu_temperature 0+
@ -427,17 +428,17 @@ format_above_threshold.
Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+
(FreeBSD/OpenBSD). (FreeBSD/OpenBSD).
It is possible to define a max_threshold that will color the load It is possible to define a +max_threshold+ that will color the load
value with +color_bad+ in case the CPU average over the last interval is getting value with +color_bad+ in case the CPU average over the last interval is getting
higher than the configured threshold. Defaults to 95. The output higher than the configured threshold. Defaults to 95. The output
format when above max_threshold can be customized with format when above +max_threshold+ can be customized with
format_above_threshold. +format_above_threshold+.
It is possible to define a degraded_threshold that will color the load It is possible to define a +degraded_threshold+ that will color the load
value with +color_degraded+ in case the CPU average over the last interval is value with +color_degraded+ in case the CPU average over the last interval is
getting higher than the configured threshold. Defaults to 90. The output format getting higher than the configured threshold. Defaults to 90. The output format
when above degraded threshold can be customized with when above degraded threshold can be customized with
format_above_degraded_threshold. +format_above_degraded_threshold+.
For displaying the Nth CPU usage, you can use the %cpu<N> format string, For displaying the Nth CPU usage, you can use the %cpu<N> format string,
starting from %cpu0. This feature is currently not supported in FreeBSD. starting from %cpu0. This feature is currently not supported in FreeBSD.
@ -512,8 +513,8 @@ 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 1, 5 and 15 minutes). It is possible to define a max_threshold that will
color the load value +color_bad+ in case the load average of the last minute is color the load value +color_bad+ in case the load average of the last minute is
getting higher than the configured threshold. Defaults to 5. The output getting higher than the configured threshold. Defaults to 5. The output
format when above max_threshold can be customized with format when above +max_threshold+ can be customized with
format_above_threshold. +format_above_threshold+.
*Example order*: +load+ *Example order*: +load+
@ -645,9 +646,9 @@ volume master {
Outputs the contents of the specified file. You can use this to check contents Outputs the contents of the specified file. You can use this to check contents
of files on your system, for example /proc/uptime. By default the function only of files on your system, for example /proc/uptime. By default the function only
reads the first 254 characters of the file, if you want to override this set reads the first 254 characters of the file, if you want to override this set
the Max_characters option. It will never read beyond the first 4095 characters. the +Max_characters+ option. It will never read beyond the first 4095
If the file is not found "no file" will be printed, if the file can't be read characters. If the file is not found "no file" will be printed, if the file
"error read" will be printed. can't be read "error read" will be printed.
*Example order*: read_file UPTIME *Example order*: read_file UPTIME
@ -682,7 +683,7 @@ separator::
A boolean value which specifies whether a separator line should be drawn A boolean value which specifies whether a separator line should be drawn
after this block. The default is true, meaning the separator line will be after this block. The default is true, meaning the separator line will be
drawn. Note that if you disable the separator line, there will still be a drawn. Note that if you disable the separator line, there will still be a
gap after the block, unless you also use separator_block_width. gap after the block, unless you also use +separator_block_width+.
separator_block_width:: separator_block_width::
The amount of pixels to leave blank after the block. In the middle of this The amount of pixels to leave blank after the block. In the middle of this
gap, a separator symbol will be drawn unless separator is disabled. This is gap, a separator symbol will be drawn unless separator is disabled. This is