diff --git a/doc/meson.build b/doc/meson.build index 4598ab2..a1550c4 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -6,6 +6,7 @@ scdoc_prog = find_program(scdoc.get_pkgconfig_variable('scdoc'), native: true) foreach man_src : ['yambar.1.scd', 'yambar.5.scd', 'yambar-decorations.5.scd', 'yambar-modules-alsa.5.scd', 'yambar-modules-backlight.5.scd', 'yambar-modules-battery.5.scd', 'yambar-modules-clock.5.scd', + 'yambar-modules-foreign-toplevel.5.scd', 'yambar-modules-i3.5.scd', 'yambar-modules-label.5.scd', 'yambar-modules-mpd.5.scd', 'yambar-modules-network.5.scd', 'yambar-modules-removables.5.scd', 'yambar-modules-river.5.scd', diff --git a/doc/yambar-modules-foreign-toplevel.5.scd b/doc/yambar-modules-foreign-toplevel.5.scd new file mode 100644 index 0000000..bb63024 --- /dev/null +++ b/doc/yambar-modules-foreign-toplevel.5.scd @@ -0,0 +1,74 @@ +yambar-modules-foreign-toplevel(5) + +# NAME +foreign-toplevel - This module provides information about toplevel windows in Wayland + +# DESCRIPTION + +This module uses the _wlr foreign toplevel management_ Wayland +protocol to provide information about currently open windows, such as +their application ID, window title, and their current state +(maximized/minimized/fullscreen/activated). + +The configuration for the foreign-toplevel module specifies a +_template_ particle. This particle will be instantiated once for each +window. + +Note: Wayland only. + + +# TAGS + +[[ *Name* +:[ *Type* +:[ *Description* +| app-id +: string +: The application ID (typically the application name) +| title +: string +: The window title +| maximized +: bool +: True if the window is currently maximized +| minimized +: bool +: True if the window is currently minimized +| fullscreen +: bool +: True if the window is currently fullscreened +| activated +: bool +: True if the window is currently activated (i.e. has focus) + + +# CONFIGURATION + +[[ *Name* +:[ *Type* +:[ *Req* +:[ *Description* +| content +: particle +: yes +: Template particle that will be instantiated once for each window + + +# EXAMPLES + +``` +bar: + left: + - foreign-toplevel: + content: + map: + tag: activated + values: + false: {empty: {}} + true: + - string: {text: "{app-id}: {title}"} +``` + +# SEE ALSO + +*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)