mirror of
https://github.com/hyprwm/hyprland-wiki.git
synced 2025-12-25 06:00:03 +01:00
Configuring/Window Rules: Minor consistency fixes, punctuation and rephrasing (#1150)
* Configuring/Window Rules: Minor consitency fixes, punctuation and rephrasing - regex -> RegEx - Add link for Google's RE2 - Add capitals and periods for descriptions in tables - Add `<br>` to break up longer paragraphs for legibility - `x y` --> `w h` in maxsize and minsize - Add link for nearest neighbour filtering - Enclose notes under dynamic rules and window rule options in a callout
This commit is contained in:
parent
42590707f6
commit
8d45857940
1 changed files with 135 additions and 132 deletions
|
|
@ -8,12 +8,12 @@ title: Window Rules
|
||||||
Window rules are **case sensitive**. (e.g. `firefox` ≠
|
Window rules are **case sensitive**. (e.g. `firefox` ≠
|
||||||
`Firefox`)
|
`Firefox`)
|
||||||
|
|
||||||
As of Hyprland v0.46.0, regexes need to fully match the window values. For
|
As of Hyprland v0.46.0, RegExes need to fully match the window values. For
|
||||||
example, in the case of `kitty`:
|
example, in the case of `kitty`:
|
||||||
|
|
||||||
- `kitty`/`(kitty)`/`^(kitty)$`: Matches.
|
- `kitty`/`(kitty)`/`^(kitty)$`: Matches.
|
||||||
- `tty`: Used to match, now won't. Use `.*tty.*` to make it act like before, or
|
- `tty`: Used to match, now won't. Use `.*tty.*` to make it act like before, or
|
||||||
consider using a more specific regex.
|
consider using a more specific RegEx.
|
||||||
|
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
|
|
@ -29,7 +29,7 @@ windowrule=RULE,PARAMETERS
|
||||||
```
|
```
|
||||||
|
|
||||||
- `RULE` is a [rule](#rules) (and a param if applicable)
|
- `RULE` is a [rule](#rules) (and a param if applicable)
|
||||||
- `PARAMETERS` is a comma-separated list of various things you can match by. See the fields further down.
|
- `PARAMETERS` is a comma-separated list of various window attributes you can match by. See the fields further down.
|
||||||
|
|
||||||
Example rule:
|
Example rule:
|
||||||
```ini
|
```ini
|
||||||
|
|
@ -39,7 +39,7 @@ windowrule = float, class:kitty, title:kitty
|
||||||
{{< callout type=info >}}
|
{{< callout type=info >}}
|
||||||
|
|
||||||
In the case of dynamic window titles such as browser windows, keep in mind how
|
In the case of dynamic window titles such as browser windows, keep in mind how
|
||||||
powerful regex is.
|
powerful RegEx is.
|
||||||
|
|
||||||
For example, a window rule of:
|
For example, a window rule of:
|
||||||
`windowrule = opacity 0.3 override 0.3 override,title:(.*)(- Youtube)` will match
|
`windowrule = opacity 0.3 override 0.3 override,title:(.*)(- Youtube)` will match
|
||||||
|
|
@ -57,10 +57,10 @@ The supported fields for parameters are:
|
||||||
|
|
||||||
| Field | Description |
|
| Field | Description |
|
||||||
| -------------- | --------------- |
|
| -------------- | --------------- |
|
||||||
| class:\[regex\] | Windows with `class` matching `regex`. |
|
| class:\[RegEx\] | Windows with `class` matching `RegEx`. |
|
||||||
| title:\[regex\] | Windows with `title` matching `regex`. |
|
| title:\[RegEx\] | Windows with `title` matching `RegEx`. |
|
||||||
| initialClass:\[regex\] | Windows with `initialClass` matching `regex`. |
|
| initialClass:\[RegEx\] | Windows with `initialClass` matching `RegEx`. |
|
||||||
| initialTitle:\[regex\] | Windows with `initialTitle` matching `regex`. |
|
| initialTitle:\[RegEx\] | Windows with `initialTitle` matching `RegEx`. |
|
||||||
| tag:\[name\] | Windows with matching `tag`. |
|
| tag:\[name\] | Windows with matching `tag`. |
|
||||||
| xwayland:\[0/1\] | Xwayland windows. |
|
| xwayland:\[0/1\] | Xwayland windows. |
|
||||||
| floating:\[0/1\] | Floating windows. |
|
| floating:\[0/1\] | Floating windows. |
|
||||||
|
|
@ -94,10 +94,10 @@ In the output of the `hyprctl clients` command:
|
||||||
|
|
||||||
### RegEx writing
|
### RegEx writing
|
||||||
|
|
||||||
Please note Hyprland uses Google's RE2 for parsing Regex. This means that all operations requiring polynomial
|
Please note Hyprland uses [Google's RE2](https://github.com/google/re2) for parsing RegEx. This means that all operations requiring polynomial
|
||||||
time to compute will not work. See [the re2 wiki](https://github.com/google/re2/wiki/Syntax) for supported extensions.
|
time to compute will not work. See the [RE2 wiki](https://github.com/google/re2/wiki/Syntax) for supported extensions.
|
||||||
|
|
||||||
If you want to _negate_ a regex, as in pass only when the regex _fails_, you can prefix it with `negative:`, e.g.: `negative:kitty`.
|
If you want to _negate_ a ReGex, as in pass only when the RegEx _fails_, you can prefix it with `negative:`, e.g.: `negative:kitty`.
|
||||||
|
|
||||||
## Rules
|
## Rules
|
||||||
|
|
||||||
|
|
@ -107,33 +107,33 @@ Static rules are evaluated once when the window is opened and never again. This
|
||||||
|
|
||||||
{{< callout type=warning >}}
|
{{< callout type=warning >}}
|
||||||
|
|
||||||
It is not possible to `float` (or any other of the static rules) a window based on a change in the `title` after the window has been created. This applies to all static rules listed here.
|
It is not possible to `float` (or any other static rule) a window based on a change in the `title` after the window has been created. This applies to all static rules listed here.
|
||||||
|
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
| Rule | Description |
|
| Rule | Description |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| float | floats a window |
|
| float | Floats a window. |
|
||||||
| tile | tiles a window |
|
| tile | Tiles a window. |
|
||||||
| fullscreen | fullscreens a window |
|
| fullscreen | Fullscreens a window. |
|
||||||
| maximize | maximizes a window |
|
| maximize | Maximizes a window. |
|
||||||
| persistentsize | allows size persistence between application launches for floating windows |
|
| persistentsize | Allows size persistence between application launches for floating windows. |
|
||||||
| fullscreenstate \[internal\] \[client\] | sets the focused window's fullscreen mode and the one sent to the client, where internal and client can be `0` - none, `1` - maximize, `2` - fullscreen, `3` - maximize and fullscreen |
|
| fullscreenstate \[internal\] \[client\] | Sets the focused window's fullscreen mode and the one sent to the client, where internal and client can be `0` - none, `1` - maximize, `2` - fullscreen, `3` - maximize and fullscreen. |
|
||||||
| move \[x\] \[y\] | moves a floating window (x,y -> int or %, e.g. 20% or 100. You are also allowed to do `100%-` for the right/bottom anchor, e.g. `100%-20`. In addition, the option supports the subtraction of the window size with `100%-w-`, e.g. `100%-w-20`. This results in a gap at the right/bottom edge of the screen to the window with the defined subtracted size). Additionally, you can also do `cursor [x] [y]` where x and y are either pixels or percent. Percent is calculated from the window's size. Specify `onscreen` before other parameters to force the window into the screen (e.g. `move onscreen cursor 50% 50%`) |
|
| move \[x\] \[y\] | Moves a floating window (`x, y` -> int or %, e.g. `100` or `20%`.<br>You are also allowed to do `100%-` for the right/bottom anchor, e.g. `100%-20`. In addition, the option supports the subtraction of the window's size with `100%-w-`, e.g. `100%-w-20`. This results in a gap at the right/bottom edge of the screen to the window with the defined subtracted size). <br> Additionally, you can also do `cursor [x] [y]` where x and y are either pixels or percent. Percent is calculated from the window's size. Specify `onscreen` before other parameters to force the window into the screen (e.g. `move onscreen cursor 50% 50%`) |
|
||||||
| size \[w\] \[h\] | resizes a floating window (`w, h` -> (<\/>)int or (<\/>)%, eg `1280, 720` or `50%, 50%`. `<` and `>` may also be prefixed in conjuction, to specify respectively the maximum or minimum allowed size. eg `<1280` or `<40%` -> maximum size, `>300` or `>10%` -> minimum size). Note that int values in pixels will be scaled by your monitor's scaling factor. |
|
| size \[w\] \[h\] | Resizes a floating window (`w, h` -> int or %, e.g. `1280, 720` or `50%, 50%`.<br>`<` and `>` may also be prefixed in conjuction, to specify respectively the maximum or minimum allowed size. (e.g. `<1280` or `<40%` -> maximum size, `>300` or `>10%` -> minimum size).<br>Note that int values in pixels will be scaled by your monitor's scaling factor. |
|
||||||
| center (\[opt\]) | if the window is floating, will center it on the monitor. Set opt as 1 to respect monitor reserved area |
|
| center (\[opt\]) | If the window is floating, will center it on the monitor. Set opt to `1` to respect monitor reserved area. |
|
||||||
| pseudo | pseudotiles a window |
|
| pseudo | Pseudotiles a window. |
|
||||||
| monitor \[id\] | sets the monitor on which a window should open. `id` can be either id or name (either e.g. `1` or e.g. `DP-1`) |
|
| monitor \[id\] | Sets the monitor on which a window should open. `id` can be either the id number or the name (e.g. `1` or `DP-1`). |
|
||||||
| workspace \[w\] | sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../Dispatchers#workspaces)). You can also make \[w\] to `unset`, will unset all previous workspace rules applied to this window. You can also add `silent` after the workspace to make the window open silently. |
|
| workspace \[w\] | Sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../Dispatchers#workspaces)). <br> You can also set \[w\] to `unset`. This will unset all previous workspace rules applied to this window. Additionally you can add `silent` after the workspace to make the window open silently. |
|
||||||
| noinitialfocus | disables the initial focus to the window |
|
| noinitialfocus | Disables the initial focus to the window |
|
||||||
| pin | pins the window (i.e. show it on all workspaces) _note: floating only_ |
|
| pin | Pins the window (i.e. show it on all workspaces). _Note: floating only_. |
|
||||||
| unset | removes all previously set rules for the given parameters. Please note it has to match EXACTLY. |
|
| unset | Removes all previously set rules for the given parameters. Please note it has to match _exactly_. |
|
||||||
| nomaxsize | removes max size limitations. Especially useful with windows that report invalid max sizes (e.g. winecfg) |
|
| nomaxsize | Removes max size limitations. Especially useful with windows that report invalid max sizes (e.g. winecfg). |
|
||||||
| stayfocused | forces focus on the window as long as it's visible |
|
| stayfocused | Forces focus on the window as long as it's visible. |
|
||||||
| group \[options\] | set window group properties. See the note below. |
|
| group \[options\] | Sets window group properties. See the note below. |
|
||||||
| suppressevent \[types...\] | ignores specific events from the window. Events are space separated, and can be: `fullscreen` `maximize` `activate` `activatefocus` `fullscreenoutput` |
|
| suppressevent \[types...\] | Ignores specific events from the window. Events are space separated, and can be: `fullscreen`, `maximize`, `activate`, `activatefocus`, `fullscreenoutput`. |
|
||||||
| content \[none\|photo\|video\|game\] | sets content type |
|
| content \[none\|photo\|video\|game\] | Sets content type. |
|
||||||
| noclosefor \[ms\] | makes the window uncloseable with the `killactive` dispatcher for a given amount of ms on open |
|
| noclosefor \[ms\] | Makes the window uncloseable with the `killactive` dispatcher for a given amount of ms on open. |
|
||||||
|
|
||||||
### Dynamic rules
|
### Dynamic rules
|
||||||
|
|
||||||
|
|
@ -141,109 +141,112 @@ Dynamic rules are re-evaluated every time a property changes.
|
||||||
|
|
||||||
| Rule | Description |
|
| Rule | Description |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| animation \[style\] (\[opt\]) | forces an animation onto a window, with a selected opt. Opt is optional. |
|
| animation \[style\] (\[opt\]) | Forces an animation onto a window, with a selected opt. Opt is optional. |
|
||||||
| bordercolor \[c\] | force the bordercolor of the window. Options for c: `color`/`color ... color angle` -> sets the active border color/gradient OR `color color`/`color ... color angle color ... color [angle]` -> sets the active and inactive border color/gradient of the window. See [variables->colors](../Variables#variable-types) for color definition. |
|
| bordercolor \[c\] | Force the bordercolor of the window. <br> Options for c: `color`/`color ... color angle` -> sets the active border color/gradient OR `color color`/`color ... color angle color ... color [angle]` -> sets the active and inactive border color/gradient of the window. See [variables->colors](../Variables#variable-types) for color definition. |
|
||||||
| idleinhibit \[mode\] | sets an idle inhibit rule for the window. If active, apps like `hypridle` will not fire. Modes: `none`, `always`, `focus`, `fullscreen` |
|
| idleinhibit \[mode\] | Sets an idle inhibit rule for the window. If active, apps like `hypridle` will not fire. Modes: `none`, `always`, `focus`, `fullscreen`. |
|
||||||
| opacity \[a\] | additional opacity multiplier. Options for a: `float` -> sets an overall opacity OR `float float` -> sets activeopacity and inactiveopacity respectively, OR `float float float` -> sets activeopacity, inactiveopacity and fullscreenopacity respectively. |
|
| opacity \[a\] | Additional opacity multiplier. Options for a: `float` -> sets an overall opacity, `float float` -> sets activeopacity and inactiveopacity respectively, `float float float` -> sets activeopacity, inactiveopacity and fullscreenopacity respectively. |
|
||||||
| tag \[name\] | apply tag to the window, use prefix `+`/`-` to set/unset flag, or no prefix to toggle the flag |
|
| tag \[name\] | Applies the tag `name` to the window, use prefix `+`/`-` to set/unset flag, or no prefix to toggle the flag. |
|
||||||
| maxsize \[x\] \[y\] | sets the maximum size (x,y -> int) |
|
| maxsize \[w\] \[h\] | Sets the maximum size (x,y -> int). |
|
||||||
| minsize \[x\] \[y\] | sets the minimum size (x,y -> int) |
|
| minsize \[w\] \[h\] | Sets the minimum size (x,y -> int).|
|
||||||
|
|
||||||
The following rules can also be set with [`setprop`](../Dispatchers#setprop):
|
The following rules can also be set with [`setprop`](../Dispatchers#setprop):
|
||||||
|
|
||||||
| Rule | Description |
|
| Rule | Description |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| bordersize \[int\] | sets the border size |
|
| bordersize \[int\] | Sets the border size. |
|
||||||
| rounding \[int\] | forces the application to have X pixels of rounding, ignoring the set default (in `decoration:rounding`). Has to be an int. |
|
| rounding \[int\] | Forces the application to have X pixels of rounding, ignoring the set default (in `decoration:rounding`). Has to be an int. |
|
||||||
| roundingpower \[float\] | overrides the rounding power for the window (see `decoration:rounding_power`). |
|
| roundingpower \[float\] | Overrides the rounding power for the window (see `decoration:rounding_power`). |
|
||||||
| allowsinput \[on\] | forces an XWayland window to receive input, even if it requests not to do so. (Might fix issues like e.g. Game Launchers not receiving focus for some reason) |
|
| allowsinput \[on\] | Forces an XWayland window to receive input, even if it requests not to do so. (Might fix issues like Game Launchers not receiving focus for some reason) |
|
||||||
| dimaround \[on\] | dims everything around the window . Please note this rule is meant for floating windows and using it on tiled ones may result in strange behavior. |
|
| dimaround \[on\] | Dims everything around the window. Please note that this rule is meant for floating windows and using it on tiled ones may result in strange behavior. |
|
||||||
| decorate \[on\] | whether to draw window decorations or not |
|
| decorate \[on\] | Whether to draw window decorations or not |
|
||||||
| focusonactivate \[on\] | whether Hyprland should focus an app that requests to be focused (an `activate` request) |
|
| focusonactivate \[on\] | Whether Hyprland should focus an app that requests to be focused (an `activate` request). |
|
||||||
| keepaspectratio \[on\] | forces aspect ratio when resizing window with the mouse |
|
| keepaspectratio \[on\] | Forces aspect ratio when resizing window with the mouse. |
|
||||||
| nearestneighbor \[on\] | forces the window to use the nearest neigbor filtering. |
|
| nearestneighbor \[on\] | Forces the window to use [nearest neighbor](https://en.wikipedia.org/wiki/Image_scaling#Nearest-neighbor_interpolation) filtering. |
|
||||||
| noanim \[on\] | disables the animations for the window |
|
| noanim \[on\] | Disables the animations for the window. |
|
||||||
| noblur \[on\] | disables blur for the window |
|
| noblur \[on\] | Disables blur for the window. |
|
||||||
| noborder \[on\] | disables borders for the window |
|
| noborder \[on\] | Disables borders for the window. |
|
||||||
| nodim \[on\] | disables window dimming for the window |
|
| nodim \[on\] | Disables window dimming for the window. |
|
||||||
| nofocus \[on\] | disables focus to the window |
|
| nofocus \[on\] | Disables focus to the window. |
|
||||||
| nofollowmouse \[on\] | prevents the window from being focused when the mouse moves over it when `input:follow_mouse=1` is set |
|
| nofollowmouse \[on\] | Prevents the window from being focused when the mouse moves over it when `input:follow_mouse=1` is set. |
|
||||||
| nomaxsize \[on\] | disables max size for the window |
|
| nomaxsize \[on\] | Disables max size for the window. |
|
||||||
| norounding \[on\] | disables rounding for the window |
|
| norounding \[on\] | Disables rounding for the window. |
|
||||||
| noshadow \[on\] | disables shadows for the window |
|
| noshadow \[on\] | Disables shadows for the window. |
|
||||||
| noshortcutsinhibit \[on\] | disallows the app from [inhibiting your shortcuts](https://wayland.app/protocols/keyboard-shortcuts-inhibit-unstable-v1) |
|
| noshortcutsinhibit \[on\] | Disallows the app from [inhibiting your shortcuts](https://wayland.app/protocols/keyboard-shortcuts-inhibit-unstable-v1). |
|
||||||
| opaque \[on\] | forces the window to be opaque |
|
| opaque \[on\] | Forces the window to be opaque. |
|
||||||
| forcergbx \[on\] | makes Hyprland ignore the alpha channel of all the window's surfaces, effectively making it _actually, fully 100% opaque_ |
|
| forcergbx \[on\] | Forces Hyprland to ignore the alpha channel on the whole window's surfaces, effectively making it _actually, fully 100% opaque_. |
|
||||||
| syncfullscreen \[on\] | whether the fullscreen mode should always be the same as the one sent to the window (will only take effect on the next fullscreen mode change) |
|
| syncfullscreen \[on\] | Whether the fullscreen mode should always be the same as the one sent to the window (will only take effect on the next fullscreen mode change). |
|
||||||
| immediate \[on\] | forces the window to allow to be torn. See [the Tearing page](../Tearing). |
|
| immediate \[on\] | Forces the window to allow tearing. See [the Tearing page](../Tearing). |
|
||||||
| xray \[on\] | sets blur xray mode for the window |
|
| xray \[on\] | Sets blur xray mode for the window. |
|
||||||
| renderunfocused | forces the window to think it's being rendered when it's not visible - see also [Variables - Misc](../Variables/#Misc) for setting ``render_unfocused_fps`` |
|
| renderunfocused | Forces the window to think it's being rendered when it's not visible. See also [Variables - Misc](../Variables/#Misc) for setting `render_unfocused_fps`. |
|
||||||
| scrollmouse \[float\] | forces the window to override the variable `input:scroll_factor` |
|
| scrollmouse \[float\] | Forces the window to override the variable `input:scroll_factor`. |
|
||||||
| scrolltouchpad \[float\] | forces the window to override the variable `input:touchpad:scroll_factor` |
|
| scrolltouchpad \[float\] | Forces the window to override the variable `input:touchpad:scroll_factor`. |
|
||||||
| noscreenshare \[on\] | hides the window and its popups from screen sharing by drawing black rectangles in their place. The rectangles are drawn even if other windows are above. |
|
| noscreenshare \[on\] | Hides the window and its popups from screen sharing by drawing black rectangles in their place. The rectangles are drawn even if other windows are above. |
|
||||||
|
|
||||||
When using window rules, \[on\] can be set to `0` for off, `1` for on or not set
|
{{< callout type=info >}}
|
||||||
for default.
|
|
||||||
|
|
||||||
When using `setprop`, \[on\] can be set to `0` for off, `1` for on,
|
When using window rules, \[on\] can be set to `0` for _disabled_, `1` for _enabled_, or left blank to use the default value.
|
||||||
|
|
||||||
|
When using `setprop`, \[on\] can be set to `0` for _disabled_, `1` for _enabled_,
|
||||||
`toggle` to toggle the state or `unset` to unset previous values.
|
`toggle` to toggle the state or `unset` to unset previous values.
|
||||||
|
|
||||||
When using `setprop`, \[int\] can also be `unset` to unset previous
|
When using `setprop`, \[int\] can also be `unset` to unset previous
|
||||||
values.
|
values.
|
||||||
|
|
||||||
|
{{< /callout >}}
|
||||||
|
|
||||||
### `group` window rule options
|
### `group` window rule options
|
||||||
|
|
||||||
- `set` \[`always`\] - Open window as a group.
|
- `set` \[`always`\] - Open window as a group.
|
||||||
- `new` - Shorthand of `barred set`.
|
- `new` - Shorthand for `barred set`.
|
||||||
- `lock` \[`always`\] - Lock the group that added this window. Use with `set` or
|
- `lock` \[`always`\] - Lock the group that added this window. Use with `set` or
|
||||||
`new` (i.e. `new lock`) to create a new locked group.
|
`new` (e.g. `new lock`) to create a new locked group.
|
||||||
- `barred` - Do not automatically group the window into the focused unlocked group.
|
- `barred` - Do not automatically group the window into the focused unlocked group.
|
||||||
- `deny` - Do not allow window to be toggled as or added to group (see
|
- `deny` - Do not allow the window to be toggled as or added to group (see `denywindowfromgroup` dispatcher).
|
||||||
`denywindowfromgroup` dispatcher).
|
|
||||||
- `invade` - Force open window in the locked group.
|
- `invade` - Force open window in the locked group.
|
||||||
- `override` \[other options\] - Override other `group` rules, e.g. You can make
|
- `override` \[other options\] - Override other `group` rules, e.g. You can make all windows in a particular workspace open as a group, and use `group override barred` to make windows with specific titles open as normal windows.
|
||||||
all windows in a particular workspace open as a group, and use
|
|
||||||
`group override barred` to make windows with specific titles open as normal
|
|
||||||
windows.
|
|
||||||
- `unset` - Clear all `group` rules.
|
- `unset` - Clear all `group` rules.
|
||||||
|
|
||||||
|
{{< callout type=info >}}
|
||||||
|
|
||||||
The `group` rule without options is a shorthand for `group set`.
|
The `group` rule without options is a shorthand for `group set`.
|
||||||
|
|
||||||
By default, `set` and `lock` only affect new windows once. The `always`
|
By default, `set` and `lock` only affect new windows once. The `always`
|
||||||
qualifier makes them always effective.
|
qualifier makes them always effective.
|
||||||
|
|
||||||
|
{{< /callout >}}
|
||||||
|
|
||||||
### Tags
|
### Tags
|
||||||
|
|
||||||
Window may have several tags, either static or dynamic, dynamic tag will have a
|
Window may have several tags, either static or dynamic. Dynamic tags will have a suffix of `*`.
|
||||||
suffix of `*`. You may check window tags with `hyprctl clients`.
|
You may check window tags with `hyprctl clients`.
|
||||||
|
|
||||||
Use `tagwindow` dispatcher to add a static tag to a window:
|
Use the `tagwindow` dispatcher to add a static tag to a window:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hyprctl dispatch tagwindow +code # add tag to current window
|
hyprctl dispatch tagwindow +code # Add tag to current window.
|
||||||
hyprctl dispatch tagwindow -- -code # remove tag from current window (use `--` to protect the leading `-`)
|
hyprctl dispatch tagwindow -- -code # Remove tag from current window (use `--` to protect the leading `-`).
|
||||||
hyprctl dispatch tagwindow code # toggle the tag of current window
|
hyprctl dispatch tagwindow code # Toggle the tag of current window.
|
||||||
|
|
||||||
# or you can tag windows matched with a window regex
|
# Or you can tag windows matched with a window RegEx:
|
||||||
hyprctl dispatch tagwindow +music deadbeef
|
hyprctl dispatch tagwindow +music deadbeef
|
||||||
hyprctl dispatch tagwindow +media title:Celluloid
|
hyprctl dispatch tagwindow +media title:Celluloid
|
||||||
```
|
```
|
||||||
|
|
||||||
Use `tag` rule to add a dynamic tag to a window:
|
Use the `tag` rule to add a dynamic tag to a window:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
windowrule = tag +term, class:footclient # add dynamic tag `term*` to window footclient
|
windowrule = tag +term, class:footclient # Add dynamic tag `term*` to window footclient.
|
||||||
windowrule = tag term, class:footclient # toggle dynamic tag `term*` for window footclient
|
windowrule = tag term, class:footclient # Toggle dynamic tag `term*` for window footclient.
|
||||||
windowrule = tag +code, tag:cpp # add dynamic tag `code*` to window with tag `cpp`
|
windowrule = tag +code, tag:cpp # Add dynamic tag `code*` to window with tag `cpp`.
|
||||||
|
|
||||||
windowrule = opacity 0.8, tag:code # set opacity for window with tag `code` or `code*`
|
windowrule = opacity 0.8, tag:code # Set opacity for window with tag `code` or `code*`.
|
||||||
windowrule = opacity 0.7, tag:cpp # window with tag `cpp` will match both `code` and `cpp`, the last one will override prior match
|
windowrule = opacity 0.7, tag:cpp # Window with tag `cpp` will match both `code` and `cpp`, the last one will override prior match.
|
||||||
windowrule = opacity 0.6, tag:term* # set opacity for window with tag `term*` only, `term` will not be matched
|
windowrule = opacity 0.6, tag:term* # Set opacity for window with tag `term*` only, `term` will not be matched.
|
||||||
|
|
||||||
windowrule = tag -code, tag:term # remove dynamic tag `code*` for window with tag `term` or `term*`
|
windowrule = tag -code, tag:term # Remove dynamic tag `code*` for window with tag `term` or `term*`.
|
||||||
```
|
```
|
||||||
|
|
||||||
Or with keybind for convenience:
|
Or with a keybind for convenience:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
bind = $mod Ctrl, 2, tagwindow, alpha_0.2
|
bind = $mod Ctrl, 2, tagwindow, alpha_0.2
|
||||||
|
|
@ -253,32 +256,30 @@ windowrule = opacity 0.2 override, tag:alpha_0.2
|
||||||
windowrule = opacity 0.4 override, tag:alpha_0.4
|
windowrule = opacity 0.4 override, tag:alpha_0.4
|
||||||
```
|
```
|
||||||
|
|
||||||
The `tag` rule can only manipulate dynamic tags, and the `tagwindow` dispatcher
|
The `tag` rule can only manipulate dynamic tags, and the `tagwindow` dispatcher only works with static tags (i.e. once the dispatcher is called, dynamic tags will be cleared).
|
||||||
only work with static tags (as once the dispatcher is called, dynamic tags will
|
|
||||||
be cleared).
|
|
||||||
|
|
||||||
### Example Rules
|
### Example Rules
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
windowrule = move 100 100, class:kitty # moves kitty to 100 100
|
windowrule = move 100 100, class:kitty # Move kitty to 100 100
|
||||||
windowrule = animation popin, class:kitty # sets the animation style for kitty
|
windowrule = animation popin, class:kitty # Set the animation style for kitty
|
||||||
windowrule = noblur, class:firefox # disables blur for firefox
|
windowrule = noblur, class:firefox # Disable blur for firefox
|
||||||
windowrule = move cursor -50% -50%, class:kitty # moves kitty to the center of the cursor
|
windowrule = move cursor -50% -50%, class:kitty # Move kitty to the center of the cursor
|
||||||
windowrule = bordercolor rgb(FF0000) rgb(880808), fullscreen:1 # set bordercolor to red if window is fullscreen
|
windowrule = bordercolor rgb(FF0000) rgb(880808), fullscreen:1 # Set bordercolor to red if window is fullscreen
|
||||||
windowrule = bordercolor rgb(00FF00), fullscreenstate:* 1 # set bordercolor to green if window's client fullscreen state is 1(maximize) (internal state can be anything)
|
windowrule = bordercolor rgb(00FF00), fullscreenstate:* 1 # Set bordercolor to green if window's client fullscreen state is 1(maximize) (internal state can be anything)
|
||||||
windowrule = bordercolor rgb(FFFF00), title:.*Hyprland.* # set bordercolor to yellow when title contains Hyprland
|
windowrule = bordercolor rgb(FFFF00), title:.*Hyprland.* # Set bordercolor to yellow when title contains Hyprland
|
||||||
windowrule = opacity 1.0 override 0.5 override 0.8 override, class:kitty # set opacity to 1.0 active, 0.5 inactive and 0.8 fullscreen for kitty
|
windowrule = opacity 1.0 override 0.5 override 0.8 override, class:kitty # Set opacity to 1.0 active, 0.5 inactive and 0.8 fullscreen for kitty
|
||||||
windowrule = rounding 10, class:kitty # set rounding to 10 for kitty
|
windowrule = rounding 10, class:kitty # Set rounding to 10 for kitty
|
||||||
windowrule = stayfocused, class:(pinentry-)(.*) # fix pinentry losing focus
|
windowrule = stayfocused, class:(pinentry-)(.*) # Fix pinentry losing focus
|
||||||
```
|
```
|
||||||
|
|
||||||
### Notes
|
### Notes
|
||||||
|
|
||||||
Rules that are marked as _Dynamic_ will be reevaluated if the matching property
|
Rules that are marked as _Dynamic_ will be reevaluated if the matching property
|
||||||
of the window changes. For instance, if a rule is defined that changes the
|
of the window changes.<br>
|
||||||
`bordercolor` of a window when it is floating, then the `bordercolor` will
|
For instance, if a rule is defined that changes the `bordercolor` of a window
|
||||||
change to the requested color when it is set to floating, and revert to the
|
when it is floating, then the `bordercolor` will change to the requested color
|
||||||
default color when it is tiled again.
|
when it is set to floating, and revert to the default color when it is tiled again.
|
||||||
|
|
||||||
Rules will be processed from top to bottom, where the _last_ match will take
|
Rules will be processed from top to bottom, where the _last_ match will take
|
||||||
precedence. i.e.
|
precedence. i.e.
|
||||||
|
|
@ -303,12 +304,14 @@ The rest of the floating windows will have `opacity 0.5`.
|
||||||
{{< callout type=info >}}
|
{{< callout type=info >}}
|
||||||
|
|
||||||
Opacity is a PRODUCT of all opacities by default. For example, setting
|
Opacity is a PRODUCT of all opacities by default. For example, setting
|
||||||
`activeopacity` to 0.5 and `opacity` to 0.5 will result in a total opacity of
|
`activeopacity` to `0.5` and `opacity` to `0.5` will result in a total opacity of
|
||||||
0.25. You are allowed to set opacities over 1, but any opacity product over 1
|
`0.25`. <br>
|
||||||
will cause graphical glitches. For example, using `0.5 * 2 = 1` is fine, but
|
You are allowed to set opacities over `1.0`, but any opacity product over `1.0`
|
||||||
`0.5 * 4 = 2` will cause graphical glitches. You can put `override` after an
|
will cause graphical glitches. <br>
|
||||||
opacity value to override it to an exact value rather than a multiplier. For
|
For example, using `0.5 * 2 = 1` is fine, but `0.5 * 4 = 2` will cause graphical glitches. <br>
|
||||||
example, to set active and inactive opacity to 0.8, and make fullscreen windows
|
You can put `override` after an opacity value to override it to an exact value
|
||||||
|
rather than a multiplier.
|
||||||
|
For example, to set active and inactive opacity to 0.8, and make fullscreen windows
|
||||||
fully opaque regardless of other opacity rules:
|
fully opaque regardless of other opacity rules:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
|
|
@ -322,7 +325,7 @@ windowrule = opacity 0.8 override 0.8 override 1.0 override, class:kitty
|
||||||
Some things in Wayland are not windows, but layers. That includes, for example:
|
Some things in Wayland are not windows, but layers. That includes, for example:
|
||||||
app launchers, status bars, or wallpapers.
|
app launchers, status bars, or wallpapers.
|
||||||
|
|
||||||
Those have specific rules separate from windows:
|
Those have specific rules, separate from windows:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
layerrule = rule, namespace
|
layerrule = rule, namespace
|
||||||
|
|
@ -330,22 +333,22 @@ layerrule = rule, namespace
|
||||||
layerrule = rule, address
|
layerrule = rule, address
|
||||||
```
|
```
|
||||||
|
|
||||||
where `rule` is the rule and `namespace` is the namespace regex (find
|
where `rule` is the rule and `namespace` is the namespace RegEx (find
|
||||||
namespaces in `hyprctl layers`) or `address` is an address in the form of
|
namespaces in `hyprctl layers`) or `address` is an address in the form of
|
||||||
`address:0x[hex]`.
|
`address:0x[hex]`.
|
||||||
|
|
||||||
### Rules
|
### Rules
|
||||||
|
|
||||||
| rule | description |
|
| rule | description |
|
||||||
| --- | --- |
|
| ---- | ----------- |
|
||||||
| unset | removes all layerRules previously set for a select namespace regex. Please note it has to match _exactly_. |
|
| unset | Removes all layerRules previously set for a select namespace RegEx. Please note it has to match _exactly_. |
|
||||||
| noanim | disables animations |
|
| noanim | Disables animations. |
|
||||||
| blur | enables blur for the layer |
|
| blur | Enables blur for the layer. |
|
||||||
| blurpopups | enables blur for the popups |
|
| blurpopups | Enables blur for the popups. |
|
||||||
| ignorealpha \[a\] | makes blur ignore pixels with opacity of `a` or lower. `a` is float value from 0 to 1. `a = 0` if unspecified. |
|
| ignorealpha \[a\] | Makes blur ignore pixels with opacity of `a` or lower. `a` is float value from `0` to `1`. `a = 0` if unspecified. |
|
||||||
| ignorezero | makes blur ignore fully transparent pixels. Same as `ignorealpha 0`. |
|
| ignorezero | Makes blur ignore fully transparent pixels. Same as `ignorealpha 0`. |
|
||||||
| dimaround | dims everything behind the layer |
|
| dimaround | Dims everything behind the layer. |
|
||||||
| xray \[on\] | sets the blur xray mode for a layer. 0 for off, 1 for on, unset for default. |
|
| xray \[on\] | Sets the blur xray mode for a layer. `0` for off, `1` for on, `unset` for default. |
|
||||||
| animation \[style\] | allows you to set a specific animation style for this layer |
|
| animation \[style\] | Allows you to set a specific animation style for this layer. |
|
||||||
| order \[n\] | sets the order relative to other layers. Higher means closer to the edge of the monitor. Can be negative. `n = 0` if unspecified. |
|
| order \[n\] | Sets the order relative to other layers. A higher `n` means closer to the edge of the monitor. Can be negative. `n = 0` if unspecified. |
|
||||||
| abovelock \[interactable\] | renders the layer above the lockscreen when the session is locked. If set to `true`, you can interact with the layer on the lockscreen, otherwise it will only be rendered above it. |
|
| abovelock \[interactable\] | Renders the layer above the lockscreen when the session is locked. If set to `true`, you can interact with the layer on the lockscreen, otherwise it will only be rendered above it. |
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue