mirror of
https://github.com/YaLTeR/niri.git
synced 2024-10-26 11:48:09 +03:00
Move IPC into wiki
This commit is contained in:
parent
092420ec5a
commit
0470a833a1
15
README.md
15
README.md
@ -131,21 +131,6 @@ In particular, it supports file choosers and monitor screencasting (e.g. to [OBS
|
||||
|
||||
[This wiki page](https://github.com/YaLTeR/niri/wiki/Important-Software) explains how to run important software required for normal desktop use, including portals.
|
||||
|
||||
### Xwayland
|
||||
|
||||
See [the wiki page](https://github.com/YaLTeR/niri/wiki/Xwayland) to learn how to use Xwayland with niri.
|
||||
|
||||
### IPC
|
||||
|
||||
You can communicate with the running niri instance over an IPC socket.
|
||||
Check `niri msg --help` for available commands.
|
||||
|
||||
The `--json` flag prints the response in JSON, rather than formatted.
|
||||
For example, `niri msg --json outputs`.
|
||||
|
||||
For programmatic access, check the [niri-ipc sub-crate](./niri-ipc/) which defines the types.
|
||||
The communication over the IPC socket happens in JSON.
|
||||
|
||||
## Configuration
|
||||
|
||||
Niri will load configuration from `$XDG_CONFIG_HOME/.config/niri/config.kdl` or `~/.config/niri/config.kdl`.
|
||||
|
12
wiki/IPC.md
Normal file
12
wiki/IPC.md
Normal file
@ -0,0 +1,12 @@
|
||||
You can communicate with the running niri instance over an IPC socket.
|
||||
Check `niri msg --help` for available commands.
|
||||
|
||||
The `--json` flag prints the response in JSON, rather than formatted.
|
||||
For example, `niri msg --json outputs`.
|
||||
|
||||
For programmatic access, check the [niri-ipc sub-crate](./niri-ipc/) which defines the types.
|
||||
The communication over the IPC socket happens in JSON.
|
||||
|
||||
> [!TIP]
|
||||
> If you're getting parsing errors from `niri msg` after upgrading niri, make sure that you've restarted niri itself.
|
||||
> You might be trying to run a newer `niri msg` against an older `niri` compositor.
|
@ -2,6 +2,7 @@
|
||||
* [Example systemd Setup](./Example-systemd-Setup.md)
|
||||
* [Important Software](./Important-Software.md)
|
||||
* [Layer‐Shell Components](./Layer%E2%80%90Shell-Components.md)
|
||||
* [`niri msg`](./IPC.md)
|
||||
* [VSCode, Chromium, WezTerm](./Application-Issues.md)
|
||||
* [Xwayland](./Xwayland.md)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user