From 53614ab50c9130150fb8a1f4d4c33ef9d98e9efd Mon Sep 17 00:00:00 2001 From: Michael Aquilina Date: Mon, 26 Aug 2019 13:23:11 +0100 Subject: [PATCH] Add waybar-cpu(5) --- man/waybar-cpu.5.scd | 78 ++++++++++++++++++++++++++++++++++++++++++++ meson.build | 1 + 2 files changed, 79 insertions(+) create mode 100644 man/waybar-cpu.5.scd diff --git a/man/waybar-cpu.5.scd b/man/waybar-cpu.5.scd new file mode 100644 index 0000000..9aa61e1 --- /dev/null +++ b/man/waybar-cpu.5.scd @@ -0,0 +1,78 @@ +waybar-cpu(5) + +# NAME + +waybar - cpu module + +# DESCRIPTION + +The *cpu* module displays the current cpu utilization. + +# CONFIGURATION + +*interval*: ++ + typeof: integer ++ + default: 10 ++ + The interval in which the information gets polled. + +*format*: ++ + typeof: string ++ + default: {usage}% ++ + The format, how information should be displayed. On {} data gets inserted. + +*max-length*: ++ + typeof: integer ++ + The maximum length in character the module should display. + +*rotate*: ++ + typeof: integer ++ + Positive value to rotate the text label. + +*states*: ++ + typeof: array ++ + A number of cpu usage states which get activated on certain usage levels. See *waybar-states(5)*. + +*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. + +# FORMAT REPLACEMENTS + +*{load}*: Current cpu load. + +*{usage}*: Current cpu usage. + +# EXAMPLE + +``` +"cpu": { + "interval": 10, + "format": "{}% ", + "max-length": 10 +} +``` + +# STYLE + +- *#cpu* diff --git a/meson.build b/meson.build index 49e70ae..1765290 100644 --- a/meson.build +++ b/meson.build @@ -164,6 +164,7 @@ if scdoc.found() 'waybar-backlight.5.scd', 'waybar-battery.5.scd', 'waybar-clock.5.scd', + 'waybar-cpu.5.scd', ] foreach filename : man_files