From fd306e184a11c20f79d785240dc41c91b4983385 Mon Sep 17 00:00:00 2001 From: Erik Reider <35975961+ErikReider@users.noreply.github.com> Date: Sat, 21 May 2022 12:06:45 +0200 Subject: [PATCH] Added man page --- man/waybar-gamemode.5.scd | 95 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 man/waybar-gamemode.5.scd diff --git a/man/waybar-gamemode.5.scd b/man/waybar-gamemode.5.scd new file mode 100644 index 00000000..b8bd2878 --- /dev/null +++ b/man/waybar-gamemode.5.scd @@ -0,0 +1,95 @@ +waybar-gamemode(5) + +# NAME + +waybar - gamemode module + +# DESCRIPTION + +The *gamemode* module displays if any game or application is running with ++ +Feral Gamemode optimizations. + +# CONFIGURATION + +*format*: ++ + typeof: string ++ + default: {glyph} ++ + The text format. + +*format-alt*: ++ + typeof: string ++ + default: {glyph} {count} ++ + The text format when toggled. + +*tooltip*: ++ + typeof: bool ++ + defualt: true ++ + Option to disable tooltip on hover. + +*tooltip-format*: ++ + typeof: string ++ + default: Games running: {glyph} ++ + The text format of the tooltip. + +*hide-not-running*: ++ + typeof: bool ++ + default: true ++ + Defines if the module should be hidden if no games are running. + +*use-icon*: ++ + typeof: bool ++ + default: true ++ + Defines if the module should display a GTK icon instead of the specified *glyph* + +*glyph*: ++ + typeof: string ++ + default:  ++ + The string icon to display. Only visible if *use-icon* is set to false. + +*icon-name*: ++ + typeof: string ++ + default: input-gaming-symbolic ++ + The GTK icon to display. Only visible if *use-icon* is set to true. + +*icon-size*: ++ + typeof: unsigned integer ++ + default: 20 ++ + Defines the size of the icons. + +*icon-spacing*: ++ + typeof: unsigned integer ++ + default: 4 ++ + Defines the spacing between the icon and the text. + +# FORMAT REPLACEMENTS + +*{glyph}*: The string icon glyph to use instead. + +*{count}*: The amount of games running with gamemode optimizations. + +# TOOLTIP FORMAT REPLACEMENTS + +*{count}*: The amount of games running with gamemode optimizations. + +# EXAMPLES + +``` +"gamemode": { + "format": "{glyph}", + "format-alt": "{glyph} {count}", + "glyph": "", + "hide-not-running": true, + "use-icon": true, + "icon-name": "input-gaming-symbolic", + "icon-spacing": 6, + "icon-size": 30, + "tooltip": true, + "tooltip-format": "Games running: {count}" +} + +``` + +# STYLE + +- *#gamemode* +- *#gamemode.running*