doc: Add basic documentation for the custom rules properties.

In the lack of a better documentation.
This commit is contained in:
Emmanuel Lepage Vallee 2017-02-04 23:11:12 -05:00
parent 477df4a35b
commit 69f292a31f

View file

@ -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