wiki: Add miscellaneous

This commit is contained in:
Ivan Molodetskikh
2024-03-28 20:53:15 +04:00
parent 0f19003611
commit 83bd2317ee
3 changed files with 116 additions and 22 deletions
-22
View File
@@ -189,22 +189,6 @@ layout {
// which may be more convenient to use. // which may be more convenient to use.
// spawn-at-startup "alacritty" "-e" "fish" // spawn-at-startup "alacritty" "-e" "fish"
// You can override environment variables for processes spawned by niri.
environment {
// Set a variable like this:
// QT_QPA_PLATFORM "wayland"
// Remove a variable by using null as the value:
// DISPLAY null
}
cursor {
// Change the theme and size of the cursor as well as set the
// `XCURSOR_THEME` and `XCURSOR_SIZE` env variables.
// xcursor-theme "default"
// xcursor-size 24
}
// Uncomment this line to ask the clients to omit their client-side decorations if possible. // Uncomment this line to ask the clients to omit their client-side decorations if possible.
// If the client will specifically ask for CSD, the request will be honored. // If the client will specifically ask for CSD, the request will be honored.
// Additionally, clients will be informed that they are tiled, removing some rounded corners. // Additionally, clients will be informed that they are tiled, removing some rounded corners.
@@ -218,12 +202,6 @@ screenshot-path "~/Pictures/Screenshots/Screenshot from %Y-%m-%d %H-%M-%S.png"
// You can also set this to null to disable saving screenshots to disk. // You can also set this to null to disable saving screenshots to disk.
// screenshot-path null // screenshot-path null
// Settings for the "Important Hotkeys" overlay.
hotkey-overlay {
// Uncomment this line if you don't want to see the hotkey help at niri startup.
// skip-at-startup
}
// Animation settings. // Animation settings.
// The wiki explains how to configure individual animations: // The wiki explains how to configure individual animations:
// https://github.com/YaLTeR/niri/wiki/Configuration:-Animations // https://github.com/YaLTeR/niri/wiki/Configuration:-Animations
+115
View File
@@ -0,0 +1,115 @@
### Overview
This page documents all top-level options that don't otherwise have dedicated pages.
Here are all of these options at a glance:
```
spawn-at-startup "waybar"
spawn-at-startup "alacritty"
prefer-no-csd
screenshot-path "~/Pictures/Screenshots/Screenshot from %Y-%m-%d %H-%M-%S.png"
environment {
QT_QPA_PLATFORM "wayland"
DISPLAY null
}
cursor {
xcursor-theme "breeze_cursors"
xcursor-size 48
}
hotkey-overlay {
skip-at-startup
}
```
### `spawn-at-startup`
Add lines like this to spawn processes at startup.
`spawn-at-startup` accepts a path to the program binary as the first argument, followed by arguments to the program.
This option works the same way as the `spawn` key binding action, so please read about all the subtleties on the [key bindings](./Configuration:-Key-Bindings.md) page.
Note that running niri as a systemd session supports xdg-desktop-autostart out of the box, which may be more convenient to use.
Thanks to this, apps that you configured to autostart in GNOME will also "just work" in niri, without any manual `spawn-at-startup` configuration.
```
spawn-at-startup "waybar"
spawn-at-startup "alacritty"
```
### `prefer-no-csd`
This flag will make niri ask the applications to omit their client-side decorations.
If an application will specifically ask for CSD, the request will be honored.
Additionally, clients will be informed that they are tiled, removing some rounded corners.
With `prefer-no-csd` set, applications that negotiate server-side decorations through the xdg-decoration protocol will have focus ring and border drawn around them without a solid colored background.
> [!NOTE]
> Unlike most other options, `prefer-no-csd` currently only affects applications started *after* the config was saved.
> This mainly has to do with niri working around a [bug in SDL2](https://github.com/libsdl-org/SDL/issues/8173) that prevents SDL2 applications from starting.
```
prefer-no-csd
```
### `screenshot-path`
Set the path where screenshots are saved.
A `~` at the front will be expanded to the home directory.
The path is formatted with `strftime(3)` to give you the screenshot date and time.
```
screenshot-path "~/Pictures/Screenshots/Screenshot from %Y-%m-%d %H-%M-%S.png"
```
You can also set it to `null` to disable saving screenshots to disk.
```
screenshot-path null
```
### `environment`
Override environment variables for processes spawned by niri.
```
environment {
// Set a variable like this:
// QT_QPA_PLATFORM "wayland"
// Remove a variable by using null as the value:
// DISPLAY null
}
```
### `cursor`
Change the theme and size of the cursor as well as set the `XCURSOR_THEME` and `XCURSOR_SIZE` environment variables.
```
cursor {
xcursor-theme "breeze_cursors"
xcursor-size 48
}
```
### `hotkey-overlay`
Settings for the "Important Hotkeys" overlay.
Set the `skip-at-startup` flag if you don't want to see the hotkey help at niri startup.
```
hotkey-overlay {
skip-at-startup
}
```
+1
View File
@@ -11,6 +11,7 @@
* [Outputs](./Configuration:-Outputs.md) * [Outputs](./Configuration:-Outputs.md)
* [Key Bindings](./Configuration:-Key-Bindings.md) * [Key Bindings](./Configuration:-Key-Bindings.md)
* [Layout](./Configuration:-Layout.md) * [Layout](./Configuration:-Layout.md)
* [Miscellaneous](./Configuration:-Miscellaneous.md)
* [Window Rules](./Configuration:-Window-Rules.md) * [Window Rules](./Configuration:-Window-Rules.md)
* [Animations](./Configuration:-Animations.md) * [Animations](./Configuration:-Animations.md)
* [Debug Options](./Configuration:-Debug-Options.md) * [Debug Options](./Configuration:-Debug-Options.md)