update documentation to account for namespace options

CHANGELOG.md

@@ -2,8 +2,15 @@
 
 #### BREAKING
 
+Note: though this are technically breaking changes, they are unlikely to break
+most setups. They are only a problem if you used scripts that relied on
+`swww query` output format, or if you relied on the `swww-daemon` socket file
+name.
+
   * `swww query` now returns information in the following format:
-  `<namespace>: OUTPUT: SIZE, scale: SCALE, currently displaying: IMAGE_OR_COLOR` 
+  `<namespace>: OUTPUT: SIZE, scale: SCALE, currently displaying: IMAGE_OR_COLOR`
+  * we are creating the socket in a slightly different location now:
+  `${XDG_RUNTIME_DIR}/${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`
 
 #### Additions
 

doc/swww-clear.1.scd

@@ -8,6 +8,23 @@ swww-clear
 
 # OPTIONS
 
+*-a*,*--all*
+	Send this command to all active `swww-daemon` namespaces.
+
+*-n*,*--namespace* <namespace>
+	Which wayland namespace to send this command to.
+
+	You can specify this option multiple times to send commands to multiple
+	namespaces at once: `swww clear -n <namespace1> -n <namespace 2>`.
+
+	This affects the name of the `swww-daemon` socket we will use to
+	communicate with. Specifically, our socket name is
+	`${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`.
+
+	Some compositors can have several different wallpapers per output. This
+	allows you to differentiate between them. Most users will probably not have
+	to set anything in this option.
+
 *-o*, *--outputs*
 	Comma separated list of outputs to display the image at. Use *swww query* to
 	know which outputs are currently being used.

doc/swww-daemon.1.scd

@@ -4,7 +4,7 @@ swww-daemon(1)
 swww-daemon
 
 # SYNOPSIS
-swww-daemon [-q|--quiet] [-f|--format <xrgb|xbgr|rgb|bgr>] [--no-cache]
+swww-daemon [OPTIONS]
 
 # OPTIONS
 
@@ -23,6 +23,18 @@ swww-daemon [-q|--quiet] [-f|--format <xrgb|xbgr|rgb|bgr>] [--no-cache]
 	desktoop unusable by simply putting an image on top of everything else. If
 	there is ever a use case for these, we can reconsider it.
 
+*-n*,*--namespace* <namespace>
+	Which wayland namespace to append to `swww-daemon`.
+
+	The result namespace will the `swww-daemon<specified namespace>`. This also
+	affects the name of the `swww-daemon` socket we will use to communicate
+	with the `client`. Specifically, our socket name is
+	`${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`.
+
+	Some compositors can have several different wallpapers per output. This
+	allows you to differentiate between them. Most users will probably not have
+	to set anything in this option.
+
 *--no-cache*
 	Don't search the cache for the last wallpaper for each output.
 	Useful if you always want to select which image 'swww' loads manually using

doc/swww-img.1.scd

@@ -8,6 +8,9 @@ swww-img
 
 # OPTIONS
 
+*-a*,*--all*
+	Send this command to all active `swww-daemon` namespaces.
+
 *-f*, *--filter* <FILTER>
 	Filter to use when scaling images
 
@@ -29,6 +32,20 @@ swww-img
 
 	Default is Lanczos3.
 
+*-n*,*--namespace* <namespace>
+	Which wayland namespace to send this command to.
+
+	You can specify this option multiple times to send commands to multiple
+	namespaces at once: `swww img -n <namespace1> -n <namespace 2>`.
+
+	This affects the name of the `swww-daemon` socket we will use to
+	communicate with. Specifically, our socket name is
+	`${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`.
+
+	Some compositors can have several different wallpapers per output. This
+	allows you to differentiate between them. Most users will probably not have
+	to set anything in this option.
+
 *--no-resize*
 	Do not resize the image. Equivalent to *--resize* _no_.
 

doc/swww-kill.1.scd

@@ -8,6 +8,23 @@ swww-kill
 
 # OPTIONS
 
+*-a*,*--all*
+	Send this command to all active `swww-daemon` namespaces.
+
+*-n*,*--namespace* <namespace>
+	Which wayland namespace to send this command to.
+
+	You can specify this option multiple times to send commands to multiple
+	namespaces at once: `swww kill -n <namespace1> -n <namespace 2>`.
+
+	This affects the name of the `swww-daemon` socket we will use to
+	communicate with. Specifically, our socket name is
+	`${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`.
+
+	Some compositors can have several different wallpapers per output. This
+	allows you to differentiate between them. Most users will probably not have
+	to set anything in this option.
+
 *-h*, *--help*
 	Print help (see a summary with '-h')
 

doc/swww-query.1.scd

@@ -8,6 +8,23 @@ swww-query
 
 # OPTIONS
 
+*-a*,*--all*
+	Send this command to all active `swww-daemon` namespaces.
+
+*-n*,*--namespace* <namespace>
+	Which wayland namespace to send this command to.
+
+	You can specify this option multiple times to send commands to multiple
+	namespaces at once: `swww query -n <namespace1> -n <namespace 2>`.
+
+	This affects the name of the `swww-daemon` socket we will use to
+	communicate with. Specifically, our socket name is
+	`${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`.
+
+	Some compositors can have several different wallpapers per output. This
+	allows you to differentiate between them. Most users will probably not have
+	to set anything in this option.
+
 *-h*, *--help*
 	Print help (see a summary with '-h')
 

doc/swww-restore.1.scd

@@ -8,6 +8,24 @@ swww-restore
 
 # OPTIONS
 
+*-a*,*--all*
+	Send this command to all active `swww-daemon` namespaces.
+
+*-n*,*--namespace* <namespace>
+	Which wayland namespace to send this command to.
+
+	You can specify this option multiple times to send commands to multiple
+	namespaces at once: `swww restore -n <namespace1> -n <namespace 2>`.
+
+	This affects the name of the `swww-daemon` socket we will use to
+	communicate with. Specifically, our socket name is
+	`${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket`.
+
+	Some compositors can have several different wallpapers per output. This
+	allows you to differentiate between them. Most users will probably not have
+	to set anything in this option.
+
+
 *-o*, *--outputs*
 	Comma separated list of outputs to restore. Use *swww query* to know which
 	outputs are currently being used.

doc/swww.1.scd

@@ -53,8 +53,10 @@ protocol*. Typically, _wlr-roots_ based compositors.
 
 # FILES
 *swww* will create the following files in your system:
-	- A socket in _${XDG_RUNTIME_DIR}/swww-${WAYLAND_DISPLAY}.socket_,  or
-	_/tmp/swww/swww-${WAYLAND_DISPLAY}.socket_, if $XDG_RUNTIME_DIR is not set.
+	- A socket in _${XDG_RUNTIME_DIR}/${WAYLAND_DISPLAY}-swww-daemon.<specified
+	namespace>.socket_,  or
+	_/tmp/swww/${WAYLAND_DISPLAY}-swww-daemon.<specificed namespace>.socket_, if
+	$XDG_RUNTIME_DIR is not set.
 	- Cache files in _$XDG_CACHE_HOME/swww_ or _$HOME/.cache/swww_ if
 	  $XDG_CACHE_HOME does not exist. These are used to set the wallpaper to the
 	  previous image when a monitor is (re)connected or turned on.

tests/spell_check.rs

@@ -35,12 +35,12 @@ fn spell_check_code_and_man_pages() {
         }
         Err(e) => match e.kind() {
             std::io::ErrorKind::NotFound => {
-                eprintln!(
+                panic!(
                     "'codespell' not found. Please install in order to do spell checking:
                           `pip install codespell`"
                 );
             }
-            _ => eprintln!("{e}"),
+            _ => panic!("{e}"),
         },
     }
 }