From 69f292a31f308a0d0908566a1bb00fa3d996432e Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Sat, 4 Feb 2017 23:11:12 -0500 Subject: [PATCH] doc: Add basic documentation for the custom rules properties. In the lack of a better documentation. --- lib/awful/rules.lua | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/awful/rules.lua b/lib/awful/rules.lua index 85b5f80c..e3e7f1bf 100644 --- a/lib/awful/rules.lua +++ b/lib/awful/rules.lua @@ -1,6 +1,22 @@ --------------------------------------------------------------------------- --- Apply rules to clients at startup. -- +-- All existing `client` properties can be used in rules. It is also possible +-- to add random properties that will be later accessible as `c.property_name` +-- (where `c` is a valid client object) +-- +-- In addition to the existing properties, the following are supported: +-- +-- * placement +-- * honor_padding +-- * honor_workarea +-- * tag +-- * new_tag +-- * switchtotag +-- * focus +-- * titlebars_enabled +-- * callback +-- -- @author Julien Danjou <julien@danjou.info> -- @copyright 2009 Julien Danjou -- @module awful.rules