diff options
Diffstat (limited to 'x11-misc/devilspie/files/SYNTAX-0.16')
| -rw-r--r-- | x11-misc/devilspie/files/SYNTAX-0.16 | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/x11-misc/devilspie/files/SYNTAX-0.16 b/x11-misc/devilspie/files/SYNTAX-0.16 new file mode 100644 index 000000000000..f7ec7f7d2710 --- /dev/null +++ b/x11-misc/devilspie/files/SYNTAX-0.16 @@ -0,0 +1,98 @@ +Built-ins +========= + +Types: + - "string": A string. + - 1, 2, 3: Integers + - #t, #f: Booleans. + +Boolean operations: + - (and bool*) -> bool: perform a boolean AND of boolean values + - (or bool*) -> bool: perform a boolean OR of boolean values + +Addition, substraction: + - (+ int*) -> int: add integers + - (+ string*) -> string: concat strings + - (- int int*) -> int: subtract integers from the first + +Types casting: + - (cast-int string|int|bool) -> int: cast to an integer value + - (cast-string string|int|bool) -> string: cast to an string value + +Comparison operators: + - (<|>|= int int) -> bool: compare two integers + - (<|>|= string string) -> bool: compare two strings + +Function flow: + - (if bool func) -> type: execute a function if the condition holds + - (if bool func func) -> type: choose what function to execute depending on the + condition + - (begin func func*) -> type: execute a sequence of functions, and return the + result of the last one + + +Logical operations +================== + +This are predicates you can use to test strings, for instance in "if" +conditions. + + - (is string string) -> bool: return #t if the two strings are the same + Example: (if (is (application_name) "XMMS") ...) + - (contains string string) -> bool: return #t if the second string is a + substring of the first one. + Example: (if (contains (application_name) "term") ...) + - (matches string string) -> bool: return #t if the second string is a regular + expression matching the first one. + Example: (if (matches (window_name) "^Character.+") ...) + + +Matchers +======== + +Matchers are functions which return informations about windows. You can for +instance use them in "if" condition to match some particular windows. + + - (window_name) -> string: return the title of the current window + - (application_name) -> string: return the application name of the current + window, as determined by libwnck + - (window_role) -> string: return the role of the current window, as determined + by the WM_WINDOW_ROLE hint + - (window_class) -> string: return the class of the current window + + +Actions +======= + +Actions are the functions you can use to change some window properties. +All actions return booleans (TRUE on success, FALSE on failure). + + - (debug): debugging function - print informations about current window + - (print args*): print all arguments + - (geometry string): set size and/or position of a window. Examples: + (if ... (geometry "600x600")) + (if ... (geometry "+200+200")) + (if ... (geometry "600x600+200+200")) + - (fullscreen): make the current window fullscreen + - (focus): focus the current window + - (center): center position of current window + - (maximize): maximize the current window + - (maximize_vertically): maximize the current window vertically + - (maximize_horizontally): maximize the current window horizontally + - (minimize): minimize the current window + - (shade): shade ("roll up") the current window + - (unshade): unshade ("roll down") the current window + - (close): close the current window + - (pin): pin the current window to all workspaces + - (unpin): unpin the current window from all workspaces + - (set_workspace int): move the window to a specific workspace number, + counting from 1 + - (skip_pager): remove the current window from the pager + - (skip_tasklist): remove the current window from the window list + - (above): set the current window to be above all normal windows + - (below): set the current window to be below all normal windows + - (undecorate): remove the window manager decorations from the current window + - (wintype string): set the window type of the current window. Accepted values + are: "normal", "dialog", "menu", "toolbar", "splashscreen", "utility", + "dock" and "desktop". + |