hyprland-wiki/pages/Configuring/Workspace-Rules.md
levnikmyskin 2cfac6c3af
Added documentation for workspace rules (#208)
* added documentation for workspace rules

* added ref from Monitors.md + fixed reflinks

* fixed workspace-rules table

---------

Co-authored-by: Alessio Molinari <alessiomolinari@gmail.com>
2023-05-01 22:28:16 +01:00

41 lines
No EOL
1.8 KiB
Markdown

# Table of contents
{{< toc >}}
# Workspace Rules
You can set workspace rules to achieve workspace-specific behaviors. For instance, you can define a workspace where all windows are drawn without borders or gaps.
## Syntax
```ini
workspace=MONITOR,WORKSPACE,RULES
```
- MONITOR is a valid monitor identifier (see [Monitors](../Monitors)). You can use this rule to set the default workspace for the given monitor (see [Monitors->Default Workspace](../Monitors#default-workspace)). This field is optional and can be omitted entirely;
- WORKSPACE is a valid workspace identifier (see [Dispatchers->Workspaces](../Dispatchers#workspaces)). This field is mandatory;
- RULES is one (or more) rule(s) as described here in [rules](#rules).
### Examples
```ini
workspace=name:myworkspace,gapsin:0,gapsout:0
workspace=DP-1,3,rounding:false,bordersize:0
```
## Rules
| Rule | Description | type|
| ---- | ----------- | ----|
| gapsin:[x] | Set the gaps between windows (equivalent to [General->gaps_in](../Variables#general)) | int |
| gapsout:[x] | Set the gaps between windows and monitor edges (equivalent to [General->gaps_out](../Variables#general)) | int |
| bordersize:[x] | Set the border size around windows (equivalent to [General->border_size](../Variables#general)) | int |
| border:[b]| Whether to draw borders or not| bool |
| rounding:[b] |Whether to draw rounded windows or not | bool |
| decorate:[b] | Whether to draw window decorations or not | bool |
| monitor:[m] | Monitor identifier. This is equivalent to the first MONITOR argument. See [syntax](#syntax) and [Monitors](../Monitors).| string |
### Example Rules
```ini
workspace=3, rounding:false, decorate:false
workspace=name:coding, rounding:false, decorate:false, gapsin:0, gapsout:0, border:false, decorate:false, monitor:DP-1
workspace=DP-1, 2
workspace=8,bordersize:8
```