diff --git a/man/waybar-sway-mode.5.scd b/man/waybar-sway-mode.5.scd new file mode 100644 index 0000000..64d9a3e --- /dev/null +++ b/man/waybar-sway-mode.5.scd @@ -0,0 +1,64 @@ +waybar-sway-mode(5) + +# NAME + +waybar - sway mode module + +# DESCRIPTION + +The *mode* module displays the current binding mode of Sway + +# CONFIGURATION + +Addressed by *sway/mode* + +*format*: ++ + typeof: string ++ + default: {} ++ + The format, how information should be displayed. On {} data gets inserted. + +*rotate*: ++ + typeof: integer ++ + Positive value to rotate the text label. + +*max-length*: ++ + typeof: integer ++ + The maximum length in character the module should display. + +*on-click*: ++ + typeof: string ++ + Command to execute when clicked on the module. + +*on-click-right*: ++ + typeof: string ++ + Command to execute when you right clicked on the module. + +*on-scroll-up*: ++ + typeof: string ++ + Command to execute when scrolling up on the module. + +*on-scroll-down*: ++ + typeof: string ++ + Command to execute when scrolling down on the module. + +*smooth-scrolling-threshold*: ++ + typeof: double ++ + Threshold to be used when scrolling. + +*tooltip*: ++ + typeof: bool ++ + default: true ++ + Option to disable tooltip on hover. + +# EXAMPLES + +``` +"sway/window": { + "format": " {}", + "max-length": 50 +} +``` + +# STYLE + +- *#mode* diff --git a/meson.build b/meson.build index 56d402f..3dbf28d 100644 --- a/meson.build +++ b/meson.build @@ -171,6 +171,7 @@ if scdoc.found() 'waybar-mpd.5.scd', 'waybar-network.5.scd', 'waybar-pulseaudio.5.scd', + 'waybar-sway-mode.5.scd', ] foreach filename : man_files