document new ws rule stuff

This commit is contained in:
vaxerski 2023-05-05 15:42:26 +01:00
parent 4cce1c829f
commit 3a150ca7d2
2 changed files with 13 additions and 32 deletions

View file

@ -169,27 +169,8 @@ flipped + 270 degrees -> 7
# Default workspace # Default workspace
You can set the default workspace for a monitor with the `workspace` keyword, e.g.: See [Workspace Rules](../Workspace-Rules).
```ini
workspace = DP-1, 1
workspace = DP-2, name:work
```
Please remember only one default workspace can be created per monitor, subsequent sets for
the same monitor will overwrite the previous.
Notice, you can also use this keyword to set workspace-specific rules. See [Workspace Rules](../Workspace-Rules).
## Binding workspaces to a monitor ## Binding workspaces to a monitor
A workspace can be bound to a monitor, meaning by default it will ALWAYS open
on the selected monitor. You can do this with
```
wsbind=WORKSPACE,MONITOR
```
for example:
```
wsbind=5,DP-1
wsbind=name:secret,DP-2
```
See [Workspace Rules](../Workspace-Rules).

View file

@ -8,10 +8,9 @@ You can set workspace rules to achieve workspace-specific behaviors. For instanc
## Syntax ## Syntax
```ini ```ini
workspace=MONITOR,WORKSPACE,RULES workspace=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; - 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). - RULES is one (or more) rule(s) as described here in [rules](#rules).
@ -24,18 +23,19 @@ workspace=DP-1,3,rounding:false,bordersize:0
## Rules ## Rules
| Rule | Description | type | | Rule | Description | type |
| ---- | ----------- | ---- | | ---- | ----------- | ---- |
| monitor:[m] | Binds a workspace to a monitor See [syntax](#syntax) and [Monitors](../Monitors).| string |
| default:[b] | Whether this workspace should be the default workspace for the given monitor | bool |
| gapsin:[x] | Set the gaps between windows (equivalent to [General->gaps_in](../Variables#general)) | int | | 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 | | 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 | | 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 | | border:[b]| Whether to draw borders or not| bool |
| rounding:[b] | Whether to draw rounded windows or not | bool | | rounding:[b] | Whether to draw rounded windows or not | bool |
| decorate:[b] | Whether to draw window decorations 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 ### Example Rules
```ini ```ini
workspace = 3, rounding:false, decorate:false 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 = 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 workspace = 8,bordersize:8
workspace = name:Hello, monitor:DP-1, default:true
``` ```