From 14550440dde33328d94e0bec0929fe758cdc924f Mon Sep 17 00:00:00 2001 From: oob <> Date: Sun, 27 Aug 2023 12:48:56 +0000 Subject: [PATCH] Minor documentation update --- README.md | 3 ++- doc/meson.build | 1 + doc/yambar-modules-network.5.scd | 2 +- doc/yambar-modules.5.scd | 12 ++++++++++++ 4 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 759f667..ca90ae9 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ Available modules: * mem * mpd * network +* pipewire * pulse * removables * river @@ -106,7 +107,7 @@ mkdir -p bld/release && cd bld/release Second, configure the build (if you intend to install it globally, you might also want `--prefix=/usr`): ```sh -meson --buildtype=release ../.. +meson setup --buildtype=release .. ``` Optionally, explicitly disable a backend (or enable, if you want a diff --git a/doc/meson.build b/doc/meson.build index 0b4e13a..e5728ab 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -36,6 +36,7 @@ if plugin_mpd_enabled endif if plugin_i3_enabled plugin_pages += ['yambar-modules-i3.5.scd'] + plugin_pages += ['yambar-modules-sway.5.scd'] endif if plugin_label_enabled plugin_pages += ['yambar-modules-label.5.scd'] diff --git a/doc/yambar-modules-network.5.scd b/doc/yambar-modules-network.5.scd index 8b8b507..2aefc89 100644 --- a/doc/yambar-modules-network.5.scd +++ b/doc/yambar-modules-network.5.scd @@ -73,7 +73,7 @@ address. : int : no : Periodically (in milliseconds) update the signal, rx+tx bitrate, and - ul+dl speed tags. Setting it to 0 disables updates. Cannot be less + ul+dl speed tags (default=0). Setting it to 0 disables updates. Cannot be less than 250ms. diff --git a/doc/yambar-modules.5.scd b/doc/yambar-modules.5.scd index e8c388c..765d06f 100644 --- a/doc/yambar-modules.5.scd +++ b/doc/yambar-modules.5.scd @@ -142,14 +142,26 @@ Available modules have their own pages: *yambar-modules-clock*(5) +*yambar-modules-cpu*(5) + +*yambar-modules-disk-io*(5) + +*yambar-modules-dwl*(5) + +*yambar-modules-foreign-toplevel*(5) + *yambar-modules-i3*(5) *yambar-modules-label*(5) +*yambar-modules-mem*(5) + *yambar-modules-mpd*(5) *yambar-modules-network*(5) +*yambar-modules-pipewire*(5) + *yambar-modules-pulse*(5) *yambar-modules-removables*(5)