Changed project name: fswww -> swww

Author: LGFae

Cargo.lock

@@ -1,5 +1,5 @@
 [package]
-name = "fswww"
+name = "swww"
 version = "0.1.0"
 authors = ["Leonardo Gibrowski Faé <leonardo.fae44@gmail.com>"]
 edition = "2018"

Cargo.toml

@@ -1,4 +1,4 @@
-# The Final Solution to your Wayland Wallpaper Woes
+# A Solution to your Wayland Wallpaper Woes
 ### Efficient animated wallpaper daemon for wayland, controlled at runtime
 
 ## Dependencies
@@ -15,10 +15,10 @@
   - Up to date stable rustc compiler and cargo
 
 To build, clone this directory and run:
-```bash
+```
 cargo build --release
 ```
-Then, put the binary at `target/release/fswww` in your path.
+Then, put the binary at `target/release/swww` in your path.
 Optionally, autocompletion scripts for bash, zsh, fish and elvish are offered
 in the `completions` directory.
 
@@ -35,12 +35,12 @@ There are two main reasons that compelled me to make this, the first, that
 [oguri](https://github.com/vilhalmer/oguri) hasn't updated in over a year as I
 am writting this (02 Feb 2022), despite there being serious problems with
 excess of memory use while displaying certain gifs (see [this](https://github.com/vilhalmer/oguri/issues/38),
-for example). The best alternative I've found for oguri was [mpvpaper](https://github.com/GhostNaN/mpvpaper), 
+for example). The best alternative I've found for oguri was [mpvpaper](https://github.com/GhostNaN/mpvpaper),
 but if felt like quite the overkill for my purposes.
 
-Comparing to `oguri`, `fswww` uses less cpu power to animate once it has cached
+Comparing to `oguri`, `swww` uses less cpu power to animate once it has cached
 all the frames in the animation. It should also be **significantly** more
-memory efficient (make sure to see the 
+memory efficient (make sure to see the
 [Caveats/Limitations](#CaveatsLimitations) though).
 
 The second is that, to my knowledge, there is no wallpaper daemon for wayland
@@ -52,33 +52,33 @@ makes switch from one image to the next to happen very abruptly.
 ## Usage
 
 Start by initializing the daemon:
-```bash
-fswww init
+```
+swww init
 ```
 Then, simply pass the image you want to display:
-```bash
-fswww img <path/to/img>
+```
+swww img <path/to/img>
 
 # You can also specify outputs:
-fswww img -o <outputs> <path/to/img>
+swww img -o <outputs> <path/to/img>
 
 # Control how smoothly the transition will happen and/or it's frame rate
 # For the step, smaller values = more smooth. Default = 20
 # For the frame rate, default is 30.
-fswww img --transition-step <1 to 255> --transition-fps <1 to 255>
+swww img --transition-step <1 to 255> --transition-fps <1 to 255>
 ```
 If you would like to know the valid values for *\<outputs\>* then you can query
 the daemon. This will also tell you what the current image being displayed is,
 as well as the dimensions detected for the outputs. If you need more detailed
 information, I would recommend using [wlr-randr](https://sr.ht/~emersion/wlr-randr/).
-```bash
-fswww query
+```
+swww query
 ```
 Finally, to stop the daemon, kill it:
-```bash
-fswww kill
 ```
-For a more complete description, run *fswww --help* or *fswww \<subcommand\>
+swww kill
+```
+For a more complete description, run *swww --help* or *swww \<subcommand\>
 --help*.
 
 ## Caveats/Limitations
@@ -87,15 +87,15 @@ I had a glorious name when I started this project, but alas, I couldn't quite
 get there, here are some issues with it:
 
  - To initialize the daemon already displaying and image, use:
- ```bash
- fswww init --img <path/to/img> # Do this
+ ```
+ swww init --img <path/to/img> # Do this
  ```
  Do **NOT** use something like:
- ```bash
- fswww init && fswww img <path/to/img> # Don't do this
+ ```
+ swww init && swww img <path/to/img> # Don't do this
  ```
  As that might straight up not work. In particular, it tends to fail when using
- it in a compositor's init script (which is probably where you will want to 
+ it in a compositor's init script (which is probably where you will want to
  `init` the daemon).
  - Despite trying my best to make this as resource efficient as possible,
  **memory can still be an issue**. From my testing, this seems to be mostly
@@ -104,6 +104,6 @@ get there, here are some issues with it:
  Strangenly, it also seems that openning the same image again will *not*
  increase usage further. Still trying to understand what's going on here.
  - If the daemon exits in an unexpected way (for example, if you send SIGKILL to
- force its shutdown), it will leave a `fswww.socket` file behind in 
- `$XDG_RUNTIME_DIR` (or `/tmp/fswww` if it isn't set). If you want to 
+ force its shutdown), it will leave a `swww.socket` file behind in
+ `$XDG_RUNTIME_DIR` (or `/tmp/swww` if it isn't set). If you want to
  reinitialize the daemon, you will have to remove that file first.

README.md

@@ -6,11 +6,11 @@ use clap_complete::{generate_to, Shell};
 include!("src/cli.rs");
 
 const COMPLETION_DIR: &str = "completions";
-const APP_NAME: &str = "fswww";
+const APP_NAME: &str = "swww";
 
 fn main() -> Result<(), Error> {
     let outdir = completion_dir()?;
-    let mut app = Fswww::command();
+    let mut app = Swww::command();
 
     let shells = [Shell::Bash, Shell::Zsh, Shell::Fish, Shell::Elvish];
     for shell in shells {

build.rs

@@ -2,7 +2,7 @@
 #
 # This is script is necessary because, by default, the output of clap generate
 # will give us an autocomplete file that won't suggest any files when you write
-# <fswww img>
+# <swww img>
 # and then press 'TAB'.
 #
 # Bash seems to be fine, and I haven't tested neither fish nor elvish
@@ -17,5 +17,5 @@ SUPPORTED_FILES="*.png|*.jpg|*.jpeg|*.gif|*.bmp|*.tif|*.tiff|*.ico|*.webp|*.avif
 sed \
 	-e "s/:path .*:/&_files -g \"$SUPPORTED_FILES\"/" \
 	-e "s/:IMG:/&_files -g \"$SUPPORTED_FILES\"/g" \
-	completions/_fswww > completions/tmp \
-	&& mv completions/tmp completions/_fswww
+	completions/_swww > completions/tmp \
+	&& mv completions/tmp completions/_swww

fix_zsh_completion.sh

@@ -31,13 +31,13 @@ impl std::str::FromStr for Filter {
 }
 
 #[derive(Parser, Serialize, Deserialize)]
-#[clap(version, name = "fswww")]
+#[clap(version, name = "swww")]
 ///The Final Solution to your Wayland Wallpaper Woes
 ///
-///Change what your monitors display as a background by controlling the fswww daemon at runtime.
+///Change what your monitors display as a background by controlling the swww daemon at runtime.
 ///Supports animated gifs and putting different stuff in different monitors. I also did my best to
 ///make it as resource efficient as possible.
-pub enum Fswww {
+pub enum Swww {
     ///Fills the specified outputs with the given color.
     ///
     ///Defaults to filling all outputs with black.
@@ -49,7 +49,7 @@ pub enum Fswww {
     /// Initialize the daemon.
     ///
     /// Exits if there is already a daemon running. We check thay by seeing if
-    /// $XDG_RUNTIME_DIR/fswww.socket exists.
+    /// $XDG_RUNTIME_DIR/swww.socket exists.
     Init {
         ///Don't fork the daemon. This will keep it running in the current terminal.
         ///
@@ -76,7 +76,7 @@ pub enum Fswww {
 
     ///Asks the daemon to print output information (names and dimensions).
     ///
-    ///You may use this to find out valid values for the <fswww-img --outputs> option. If you want
+    ///You may use this to find out valid values for the <swww-img --outputs> option. If you want
     ///more detailed information about your outputs, I would recommed trying wlr-randr.
     Query,
 }
@@ -108,10 +108,10 @@ pub struct Img {
     #[clap(short, long, default_value = "")]
     pub outputs: String,
 
-    ///Filter to use when scaling images (run fswww img --help to see options).
+    ///Filter to use when scaling images (run swww img --help to see options).
     ///
     ///Note that image scaling can sometimes significantly increase RAM usage. If you want to use
-    ///as little RAM as possible, I recommend scaling the images before sending them to fswww
+    ///as little RAM as possible, I recommend scaling the images before sending them to swww
     ///
     ///Available options are:
     ///

src/cli.rs

@@ -1,7 +1,7 @@
 //! This module creates the Answer struct to send back stuff from the daemon, and also implements
 //! some helper functions to make communication more streamlined
 use crate::{
-    cli::{Filter, Fswww},
+    cli::{Filter, Swww},
     daemon:: BgInfo
 };
 use serde::{Deserialize, Serialize};
@@ -39,9 +39,9 @@ impl Answer {
     }
 }
 
-impl Fswww {
+impl Swww {
     pub fn send(&mut self, stream: &UnixStream) -> Result<(), String> {
-        if let Fswww::Img(img) = self {
+        if let Swww::Img(img) = self {
             img.path = match img.path.canonicalize() {
                 Ok(p) => p,
                 Err(e) => return Err(format!("Coulnd't get absolute path: {}", e)),
@@ -55,7 +55,7 @@ impl Fswww {
                 img.transition_fps = 1;
             }
         }
-        if let Fswww::Init { img: Some(img), .. } = self {
+        if let Swww::Init { img: Some(img), .. } = self {
             *img = match img.canonicalize() {
                 Ok(p) => p,
                 Err(e) => return Err(format!("Coulnd't get absolute path: {}", e)),

src/communication.rs

@@ -29,7 +29,7 @@ use std::{
     time::Duration,
 };
 
-use crate::cli::{Clear, Fswww, Img};
+use crate::cli::{Clear, Swww, Img};
 use crate::Answer;
 
 mod processor;
@@ -99,7 +99,7 @@ impl Bg {
             &surface,
             Some(output),
             zwlr_layer_shell_v1::Layer::Background,
-            "fswww".to_owned(),
+            "swww".to_owned(),
         );
 
         layer_surface.set_anchor(zwlr_layer_surface_v1::Anchor::all());
@@ -336,7 +336,7 @@ fn get_socket_addr() -> PathBuf {
     let runtime_dir = if let Ok(dir) = std::env::var("XDG_RUNTIME_DIR") {
         dir
     } else {
-        "/tmp/fswww".to_string()
+        "/tmp/swww".to_string()
     };
 
     let runtime_dir = Path::new(&runtime_dir);
@@ -345,7 +345,7 @@ fn get_socket_addr() -> PathBuf {
         fs::create_dir(runtime_dir).expect("Failed to create runtime dir...");
     }
 
-    runtime_dir.join("fswww.socket")
+    runtime_dir.join("swww.socket")
 }
 
 ///bgs and display can't be moved into here because it causes a segfault
@@ -449,15 +449,15 @@ fn recv_socket_msg(
     loop_signal: &calloop::LoopSignal,
     proc: &mut Processor,
 ) -> Result<(), String> {
-    let request = Fswww::receive(&mut stream);
+    let request = Swww::receive(&mut stream);
     let answer = match request {
-        Ok(Fswww::Clear(clear)) => clear_outputs(&mut bgs, clear, proc),
-        Ok(Fswww::Kill) => {
+        Ok(Swww::Clear(clear)) => clear_outputs(&mut bgs, clear, proc),
+        Ok(Swww::Kill) => {
             loop_signal.stop();
             Answer::Ok
         }
-        Ok(Fswww::Img(img)) => send_processor_request(proc, &mut bgs, img),
-        Ok(Fswww::Init { img, color, .. }) => {
+        Ok(Swww::Img(img)) => send_processor_request(proc, &mut bgs, img),
+        Ok(Swww::Init { img, color, .. }) => {
             if let Some(img) = img {
                 let request = Img {
                     path: img,
@@ -474,7 +474,7 @@ fn recv_socket_msg(
                 Answer::Ok
             }
         }
-        Ok(Fswww::Query) => Answer::Info(bgs.iter().map(|bg| bg.info.clone()).collect()),
+        Ok(Swww::Query) => Answer::Info(bgs.iter().map(|bg| bg.info.clone()).collect()),
         Err(e) => Answer::Err(e),
     };
     answer.send(&stream)

src/daemon/mod.rs

@@ -8,12 +8,12 @@ use std::{
 mod cli;
 mod communication;
 mod daemon;
-use cli::Fswww;
+use cli::Swww;
 use communication::Answer;
 
 fn main() -> Result<(), String> {
-    let mut fswww = Fswww::parse();
-    if let Fswww::Init { no_daemon, .. } = fswww {
+    let mut swww = Swww::parse();
+    if let Swww::Init { no_daemon, .. } = swww {
         if get_socket(1, 0).is_err() {
             spawn_daemon(no_daemon)?;
             if no_daemon {
@@ -25,12 +25,12 @@ fn main() -> Result<(), String> {
     }
 
     let mut socket = get_socket(5, 100)?;
-    fswww.send(&socket)?;
+    swww.send(&socket)?;
     match Answer::receive(&mut socket)? {
         Answer::Err(msg) => return Err(msg),
         Answer::Info(info) => info.into_iter().for_each(|i| println!("{}", i)),
         Answer::Ok => {
-            if let Fswww::Kill = fswww {
+            if let Swww::Kill = swww {
                 #[cfg(debug_assertions)]
                 let tries = 20;
                 #[cfg(not(debug_assertions))]
@@ -98,8 +98,8 @@ fn get_socket_path() -> PathBuf {
     let runtime_dir = if let Ok(dir) = std::env::var("XDG_RUNTIME_DIR") {
         dir
     } else {
-        "/tmp/fswww".to_string()
+        "/tmp/swww".to_string()
     };
     let runtime_dir = Path::new(&runtime_dir);
-    runtime_dir.join("fswww.socket")
+    runtime_dir.join("swww.socket")
 }

src/main.rs

@@ -44,7 +44,7 @@ fn make_test_imgs() {
 }
 
 fn cmd() -> Command {
-    Command::cargo_bin("fswww").unwrap()
+    Command::cargo_bin("swww").unwrap()
 }
 
 fn main() {