diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/herbstluftwm.txt | 40 |
1 files changed, 31 insertions, 9 deletions
diff --git a/doc/herbstluftwm.txt b/doc/herbstluftwm.txt index 8c4d297d..52ef755a 100644 --- a/doc/herbstluftwm.txt +++ b/doc/herbstluftwm.txt @@ -166,6 +166,10 @@ list_commands:: List currently configured monitors with their index, area (as rectangle), name (if named) and currently viewed tag. +list_rules:: + Lists all active rules. Each line consists of all the parameters the rule + was called with, plus it's id, separated by tabs. + list_keybinds:: Lists all bound keys with their associated command. Each line consists of one key combination and the command with its parameters separated by tabs. @@ -661,13 +665,13 @@ floating [['TAG'] *on*|*off*|*toggle*|*status*]:: is given, floating mode is toggled. If status is given, then *on* or *off* is printed, depending of the floating state on 'TAG'. -rule [\[--]'FLAG'|\[--]'CONDITION'|\[--]'CONSEQUENCE' ...]:: +rule [\[--]'FLAG'|\[--]'ID'|\[--]'CONDITION'|\[--]'CONSEQUENCE' ...]:: Defines a rule which will be applied to all new clients. Its behaviour is described in the <<RULES,*RULES section*>>. -unrule *--all*|*-F*:: - If --all or -F is passed, then all rules are removed. - (It is not possible yet to remove certain rules) +unrule 'ID'|*--all*|*-F*:: + Removes all rules named 'ID'. If --all or -F is passed, then all rules are + removed. fullscreen [*on*|*off*|*toggle*]:: Sets or toggles the fullscreen state of the focused client. If no argument @@ -791,7 +795,9 @@ frame_bg_normal_color (String/Color):: always_show_frame is set) frame_bg_transparent (Integer):: - If set, frames have transparent backgrounds. + If set, frames have transparent backgrounds. *Warning:* Results in ugly + artifacts when used together with a compositing manager. Use + 'frame_active_opacity' and 'frame_normal_opacity' in this case. frame_border_width (Integer):: Border width of a frame @@ -934,11 +940,26 @@ appear. Each rule matches against a certain subset of all clients and defines a set of properties for them (called 'CONSEQUENCE'##s##). A rule can be defined with this command: -+rule+ [\[--]'FLAG'|\[--]'CONDITION'|\[--]'CONSEQUENCE' ...] ++rule+ [\[--]'FLAG'|\[--]'ID'|\[--]'CONDITION'|\[--]'CONSEQUENCE' ...] + +Each rule consists of a list of 'FLAG'##s##, 'CONDITION'##s## 'CONSEQUENCE'##s## +and, optionally, an 'ID'. (each of them can be optionally prefixed with two +dashes (+--+) to provide a more *iptables*(8)-like feeling). + +Each rule can be given a custom identifier by specifying the 'ID' property: + + * +[--]id+='VALUE' + +If multiple id properties are specified, the last one in the list will be +applied. If no ID is given, then the rule will be given an integer name that +represents the index of the rule since the last 'unrule -F' or 'reload' command. + +TIP: Rule ID's default to an incremental index. These default IDs should be +unique, unless you assign a different rule a custom integer ID. Defaulted IDs +can be captured with the 'printid' flag. -Each rule consists of a list of 'FLAG'##s##, 'CONDITION'##s## and -'CONSEQUENCE'##s## (each of them can be optionally prefixed with two dashes -(+--+) to provide a more *iptables*(8)-like feeling). +WARNING: The interface for rule ids may change before the next stable release, +so check the docs after updating the next time. If a new client appears, herbstluftwm tries to apply each rule to this new client as follows: @@ -1034,6 +1055,7 @@ A rule's behaviour can be configured by some special 'FLAGS': * +not+: negates the next 'CONDITION'. * +!+: same as +not+. * +once+: only apply this rule once (and delete it afterwards). + * +printid+: prints the id of the newly created rule to stdout. Examples: |