RPJosh
/
Waybar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #541 from jomority/man 

man: adding and clarification of configuration options
pull/540/head
Alex 2020-01-06 11:47:23 +01:00 committed by GitHub
parent d18ece13f2 1125119dc6
commit c0d4867421
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
man/waybar-battery.5.scd
View File

@ -37,32 +37,32 @@ The *battery* module displays the current capacity and state (eg. charging) of y
default: {H} h {M} min ++ default: {H} h {M} min ++
The format, how the time should be displayed. The format, how the time should be displayed.
*format-icons* *format-icons*: ++
typeof: array/object typeof: array/object ++
Based on the current capacity, the corresponding icon gets selected. ++ Based on the current capacity, the corresponding icon gets selected. ++
The order is *low* to *high*. Or by the state if it is an object. The order is *low* to *high*. Or by the state if it is an object.
*max-length* ++ *max-length*: ++
typeof: integer++ typeof: integer++
The maximum length in character the module should display. The maximum length in character the module should display.
*rotate* ++ *rotate*: ++
typeof: integer++ typeof: integer++
Positive value to rotate the text label. Positive value to rotate the text label.
*on-click* ++ *on-click*: ++
typeof: string ++ typeof: string ++
Command to execute when clicked on the module. Command to execute when clicked on the module.
*on-click-right* ++ *on-click-right*: ++
typeof: string ++ typeof: string ++
Command to execute when you right clicked on the module. Command to execute when you right clicked on the module.
*on-scroll-up* ++ *on-scroll-up*: ++
typeof: string ++ typeof: string ++
Command to execute when scrolling up on the module. Command to execute when scrolling up on the module.
*on-scroll-down* ++ *on-scroll-down*: ++
typeof: string ++ typeof: string ++
Command to execute when scrolling down on the module. Command to execute when scrolling down on the module.

12
man/waybar-network.5.scd
View File

@ -21,6 +21,11 @@ Addressed by *network*
default: 60 ++ default: 60 ++
The interval in which the network information gets polled (e.g. signal strength). The interval in which the network information gets polled (e.g. signal strength).
*family*: ++
typeof: string ++
default: *ipv4* ++
The address family that is used for the format replacement {ipaddr} and to determine if a network connection is present.
*format*: ++ *format*: ++
typeof: string ++ typeof: string ++
default: *{ifname}* ++ default: *{ifname}* ++
@ -42,6 +47,11 @@ Addressed by *network*
typeof: string ++ typeof: string ++
This format is used when the displayed interface is disconnected. This format is used when the displayed interface is disconnected.
*format-icons*: ++
typeof: array/object ++
Based on the current signal strength, the corresponding icon gets selected. ++
The order is *low* to *high*. Or by the state if it is an object.
*rotate*: ++ *rotate*: ++
typeof: integer ++ typeof: integer ++
Positive value to rotate the text label. Positive value to rotate the text label.
@ -117,6 +127,8 @@ Addressed by *network*
*{bandwidthDownOctets}*: Instant down speed in octets/seconds. *{bandwidthDownOctets}*: Instant down speed in octets/seconds.
*{icon}*: Icon, as defined in *format-icons*.
# EXAMPLES # EXAMPLES
``` ```

9
man/waybar.5.scd
View File

@ -23,7 +23,8 @@ Also a minimal example configuration can be found on the at the bottom of this m
*layer* ++ *layer* ++
typeof: string ++ typeof: string ++
default: bottom ++ default: bottom ++
Decide if the bar is displayed in front of the windows or behind them. Decide if the bar is displayed in front (*top*) of the windows or behind (*bottom*)
them.
*output* ++ *output* ++
typeof: string|array ++ typeof: string|array ++
@ -66,6 +67,12 @@ Also a minimal example configuration can be found on the at the bottom of this m
typeof: string ++ typeof: string ++
Optional name added as a CSS class, for styling multiple waybars. Optional name added as a CSS class, for styling multiple waybars.
*gtk-layer-shell* ++
typeof: bool ++
default: true ++
Option to disable the use of gtk-layer-shell for popups.
Only functional if compiled with gtk-layer-shell support.
# MODULE FORMAT # MODULE FORMAT
You can use PangoMarkupFormat (See https://developer.gnome.org/pango/stable/PangoMarkupFormat.html#PangoMarkupFormat). You can use PangoMarkupFormat (See https://developer.gnome.org/pango/stable/PangoMarkupFormat.html#PangoMarkupFormat).