diff options
| -rw-r--r-- | README.md | 17 | ||||
| -rw-r--r-- | wiki/IPC.md | 12 | ||||
| -rw-r--r-- | wiki/_Sidebar.md | 1 |
3 files changed, 14 insertions, 16 deletions
@@ -85,7 +85,7 @@ Then, build niri with `cargo build --release`. ### NixOS/Nix We have a community-maintained flake which provides a devshell with required dependencies. Use `nix build` to build niri, and then run `./results/bin/niri`. - + If you're not on NixOS, you may need [NixGL](https://github.com/nix-community/nixGL) to run the resulting binary: ``` @@ -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`. diff --git a/wiki/IPC.md b/wiki/IPC.md new file mode 100644 index 00000000..853c3c3f --- /dev/null +++ b/wiki/IPC.md @@ -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. diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md index 23aa65cb..da8566f1 100644 --- a/wiki/_Sidebar.md +++ b/wiki/_Sidebar.md @@ -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) |