+--
+-- | Name |
+-- Description |
+--
+-- | placement | The client default placement on the screen |
+-- | honor\_padding | When applying the placement, honor the screen padding |
+-- | honor\_workarea | When applying the placement, honor the screen work area |
+-- | tag | The client default tag |
+-- | tags | The client default tags |
+-- | new\_tag | Create a new tag for this client |
+-- | switch\_to\_tags | Unselect the current tags and select this client tags |
+-- | focus | Define if the client should grab focus by default |
+-- | titlebars\_enabled | Should this client have a titlebar by default |
+-- | callback | A function to call when this client is ready |
+-- | marked | If a client is marked or not |
+-- | is\_fixed | Return if a client has a fixed size or not |
+-- | immobilized | Is the client immobilized horizontally? |
+-- | immobilized | Is the client immobilized vertically? |
+-- | floating | The client floating state |
+-- | x | The x coordinates |
+-- | y | The y coordinates |
+-- | width | The width of the client |
+-- | height | The height of the client |
+-- | dockable | If the client is dockable |
+-- | requests\_no\_titlebar | If the client requests not to be decorated with a titlebar |
+-- | shape | Set the client shape |
+-- | window | The X window id |
+-- | name | The client title |
+-- | skip\_taskbar | True if the client does not want to be in taskbar |
+-- | type | The window type |
+-- | class | The client class |
+-- | instance | The client instance |
+-- | pid | The client PID, if available |
+-- | role | The window role, if available |
+-- | machine | The machine client is running on |
+-- | icon\_name | The client name when iconified |
+-- | icon | The client icon as a surface |
+-- | icon\_sizes | The available sizes of client icons |
+-- | screen | Client screen |
+-- | hidden | Define if the client must be hidden, i |
+-- | minimized | Define it the client must be iconify, i |
+-- | size\_hints\_honor | Honor size hints, e |
+-- | border\_width | The client border width |
+-- | border\_color | The client border color |
+-- | urgent | The client urgent state |
+-- | content | A cairo surface for the client window content |
+-- | opacity | The client opacity |
+-- | ontop | The client is on top of every other windows |
+-- | above | The client is above normal windows |
+-- | below | The client is below normal windows |
+-- | fullscreen | The client is fullscreen or not |
+-- | maximized | The client is maximized (horizontally and vertically) or not |
+-- | maximized\_horizontal | The client is maximized horizontally or not |
+-- | maximized\_vertical | The client is maximized vertically or not |
+-- | transient\_for | The client the window is transient for |
+-- | group\_window | Window identification unique to a group of windows |
+-- | leader\_window | Identification unique to windows spawned by the same command |
+-- | size\_hints | A table with size hints of the client |
+-- | motif\_wm\_hints | The motif WM hints of the client |
+-- | sticky | Set the client sticky, i |
+-- | modal | Indicate if the client is modal |
+-- | focusable | True if the client can receive the input focus |
+-- | shape\_bounding | The client's bounding shape as set by awesome as a (native) cairo surface |
+-- | shape\_clip | The client's clip shape as set by awesome as a (native) cairo surface |
+-- | shape\_input | The client's input shape as set by awesome as a (native) cairo surface |
+-- | client\_shape\_bounding | The client's bounding shape as set by the program as a (native) cairo surface |
+-- | client\_shape\_clip | The client's clip shape as set by the program as a (native) cairo surface |
+-- | startup\_id | The FreeDesktop StartId |
+-- | valid | If the client that this object refers to is still managed by awesome |
+-- | first\_tag | The first tag of the client |
+--
diff --git a/docs/load_ldoc.cmake b/docs/load_ldoc.cmake
index a783e7db4..161d49e02 100644
--- a/docs/load_ldoc.cmake
+++ b/docs/load_ldoc.cmake
@@ -1,23 +1,23 @@
# To avoid copy pasting, some documentation is stored in reusable files
set(SHAPE_FILE "${SOURCE_DIR}/docs/common/${SHAPE_NAME}.lua")
-set(path "${SOURCE_DIR}/docs/common/")
+foreach(path ${BUILD_DIR}/docs/common/;${SOURCE_DIR}/docs/common/)
+ # Get the documentation file list
+ file(GLOB doc_files RELATIVE "${path}" "${path}/*.ldoc")
-# Get the documentation file list
-file(GLOB doc_files RELATIVE "${path}" "${path}/*.ldoc")
+ foreach(doc_file_name ${doc_files})
+ # Read the file
+ file(READ "${path}/${doc_file_name}" doc_file_content)
-foreach(doc_file_name ${doc_files})
- # Read the file
- file(READ "${path}/${doc_file_name}" doc_file_content)
+ # Remove the file extension
+ string(REGEX REPLACE "\\.ldoc" "" DOC_FILE_NAME ${doc_file_name})
- # Remove the file extension
- string(REGEX REPLACE "\\.ldoc" "" DOC_FILE_NAME ${doc_file_name})
+ # There is a trailing \n, remove it or it cannot be included in existing blocks
+ string(REGEX REPLACE "\n$" "" doc_file_content "${doc_file_content}")
- # There is a trailing \n, remove it or it cannot be included in existing blocks
- string(REGEX REPLACE "\n$" "" doc_file_content "${doc_file_content}")
-
- # Create a new variable usable from lua files
- set(DOC_${DOC_FILE_NAME}_COMMON "${doc_file_content}")
+ # Create a new variable usable from lua files
+ set(DOC_${DOC_FILE_NAME}_COMMON "${doc_file_content}")
+ endforeach()
endforeach()
# vim: filetype=cmake:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80:foldmethod=marker
diff --git a/lib/awful/rules.lua b/lib/awful/rules.lua
index f16741879..6b5684201 100644
--- a/lib/awful/rules.lua
+++ b/lib/awful/rules.lua
@@ -8,17 +8,15 @@
-- 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:
+-- Applicable client properties
+-- ===
--
--- * placement
--- * honor_padding
--- * honor_workarea
--- * tag
--- * new_tag
--- * switch_to_tags (also called switchtotag)
--- * focus
--- * titlebars_enabled
--- * callback
+-- The table below holds the list of default client properties along with
+-- some extra properties that are specific to the rules. Note that any property
+-- can be set in the rules and interpreted by user provided code. This table
+-- only represent those offered by default.
+--
+--@DOC_rules_index_COMMON@
--
-- @author Julien Danjou <julien@danjou.info>
-- @copyright 2009 Julien Danjou