From 87392ef653ecb7c4bbc61c6299c94b364190bde7 Mon Sep 17 00:00:00 2001 From: Michael Aquilina Date: Mon, 26 Aug 2019 15:06:20 +0100 Subject: [PATCH] Add waybar-idle-inhibitor(5) --- man/waybar-idle-inhibitor.5.scd | 71 +++++++++++++++++++++++++++++++++ meson.build | 1 + 2 files changed, 72 insertions(+) create mode 100644 man/waybar-idle-inhibitor.5.scd diff --git a/man/waybar-idle-inhibitor.5.scd b/man/waybar-idle-inhibitor.5.scd new file mode 100644 index 0000000..d621288 --- /dev/null +++ b/man/waybar-idle-inhibitor.5.scd @@ -0,0 +1,71 @@ +waybar-idle_inhibitor(5) + +# NAME + +waybar - idle_inhibitor module + +# DESCRIPTION + +The *idle_inhibitor* module can inhibiting the idle behavior such as screen blanking, locking, and +screensaving, also known as "presentation mode". + +# CONFIGURATION + +*format*: ++ + typeof: string ++ + The format, how the state should be displayed. + +*format-icons*: ++ + typeof: array ++ + Based on the current state, the corresponding icon gets selected. + +*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. A click also toggles the state + +*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. + +# FORMAT REPLACEMENTS + +*{status}*: status (*activated* or *deactivated*) + +*{icon}*: Icon, as defined in *format-icons* + +# EXAMPLE + +``` +"idle_inhibitor": { + "format": "{icon}", + "format-icons": { + "activated": "", + "deactivated": "" + } +} +``` diff --git a/meson.build b/meson.build index a3cf2ed..d981848 100644 --- a/meson.build +++ b/meson.build @@ -166,6 +166,7 @@ if scdoc.found() 'waybar-clock.5.scd', 'waybar-cpu.5.scd', 'waybar-custom.5.scd', + 'waybar-idle-inhibitor.5.scd', ] foreach filename : man_files