From 2d5a1798afd324bedf1b62f1f7a0ff2f777cb77c Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Tue, 15 Nov 2016 01:07:25 -0500 Subject: [PATCH] doc: Document tasklist_plain_task_name It was missing. --- lib/awful/widget/tasklist.lua | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/lib/awful/widget/tasklist.lua b/lib/awful/widget/tasklist.lua index afa0815a7..d5580c172 100644 --- a/lib/awful/widget/tasklist.lua +++ b/lib/awful/widget/tasklist.lua @@ -1,6 +1,29 @@ --------------------------------------------------------------------------- --- Tasklist widget module for awful. -- +-- +-- **Status icons:** +-- +-- By default, the tasklist prepends some symbols in front of the client name. +-- This is used to notify that the client has some specific properties that are +-- currently enabled. This can be disabled using +-- `beautiful.tasklist_plain_task_name`=true in the theme. +-- +-- +-- +-- +-- +-- +-- +-- +-- +-- +-- +-- +-- +-- +--
IconClient property
sticky
ontop
above
below
floating
+maximized
maximized_horizontal
maximized_vertical
+-- -- @author Julien Danjou <julien@danjou.info> -- @copyright 2008-2009 Julien Danjou -- @classmod awful.widget.tasklist @@ -83,10 +106,17 @@ local instances -- @beautiful beautiful.tasklist_bg_image_minimize -- @tparam[opt=nil] string bg_image_minimize --- Disable the tasklist clients icons. +--- Disable the tasklist client icons. -- @beautiful beautiful.tasklist_tasklist_disable_icon -- @tparam[opt=false] boolean tasklist_disable_icon +--- Disable the extra tasklist client property notification icons. +-- +-- See the Status icons section for more details. +-- +-- @beautiful beautiful.tasklist_plain_task_name +-- @tparam[opt=false] boolean tasklist_plain_task_name + --- The tasklist font. -- @beautiful beautiful.tasklist_font -- @tparam[opt=nil] string font