diff --git a/tools/yabridgectl/README.md b/tools/yabridgectl/README.md index 6a2e17e9..ea3294de 100644 --- a/tools/yabridgectl/README.md +++ b/tools/yabridgectl/README.md @@ -1,33 +1,32 @@ # yabridgectl -A small, optional utility to set up +A small, optional utility to help set up and update [yabridge](https://github.com/robbert-vdh/yabridge) for several directories at -once and to keep them updated. +once. ## Usage -Yabridgectl can be downloaded from the GitHub releases section, and it can run -from anywhere. All of the information below can also be found by running -`yabridgectl --help`. +Yabridgectl can be downloaded from the GitHub releases section and can run from +anywhere. All of the information below can also be found through `yabridgectl --help`. ### Yabridge path Yabrdgectl will need to know where it can find `libyabridge.so`. By default it will look for it in both `~/.local/share/yabridge` (the recommended installation -directory when using the prebuilt binaries) and in `/usr/lib` (used when using -the AUR packages). You can use the command below to override this behaviour and -to use a custom installation directory instead. +directory when using the prebuilt binaries) and in `/usr/lib`. You can use the +command below to override this behaviour and to use a custom installation +directory instead. ```shell -yabridgectl set --path= +yabridgectl set --path= ``` ### Installation methods By default, yabridgectl will use the copy-based installation method for yabridge -since this installation method works everywhere. If you are using a DAW that -supports individually sandboxed plugins, then you can choose between using -copies and symlinks using the command below. +since this installation method works with any VST host. If you are using a DAW +that supports individually sandboxed plugins such as Bitwig Studio, then you can +choose between using copies and symlinks using the command below. ```shell yabridgectl set --method= @@ -40,23 +39,23 @@ and list directories, or to list the plugins currently installed inside one of those directories, you can use the command below. ```shell -# Add a directory to watch +# Add a location containing plugins # For instance, use the below command for the most common VST2 plugin directory # yabridgectl add "$HOME/.wine/drive_c/Program Files/Steinberg/VstPlugins" yabridgectl add -# No longer watch a directory, this will ask you if you want to remove any leftover yabridge files +# Remove a plugin location, this will ask you if you want to remove any leftover yabridge files yabridgectl rm -# List the currently watched directories +# List the current plugin locations yabridgectl list -# Show the current settings and the installation status for all plugins in the watched directories +# Show the current settings and the installation status for all plugins found yabridgectl status ``` ### Installing and updating -Finally you can set up or update yabridge for all of your plugins at once using -the command below. By default yabridgectl will warn you if it finds `.so` files -without an accompanying `.dll` file, but it will only delete those when using +Finally you can tell yabridgectl to set up or update yabridge for all of your +plugins at once using the commands below. By default yabridgectl will warn you +if it finds leftover `.so` files, but it will only delete those when ran using the `--prune` option. ```shell @@ -95,8 +94,8 @@ find -L "$plugin_dir" -type f -iname '*.dll' -print0 | ## Building -After installing [Rust](https://rustup.rs/), simply run the below to compile and -run: +After installing [Rust](https://rustup.rs/), simply run the command below to +compile and run: ```shell cargo run --release diff --git a/tools/yabridgectl/src/main.rs b/tools/yabridgectl/src/main.rs index e7817a2e..39bc276f 100644 --- a/tools/yabridgectl/src/main.rs +++ b/tools/yabridgectl/src/main.rs @@ -329,10 +329,10 @@ fn do_sync(config: &Config, prune: bool, verbose: bool) { // tries to load them if !orphan_so_files.is_empty() { if prune { - println!("Removing {} leftover '.so' file(s):", orphan_so_files.len()); + println!("Removing {} leftover '.so' files:", orphan_so_files.len()); } else { println!( - "Found {} leftover '.so' file(s), rerun with the '--prune' option to remove them:", + "Found {} leftover '.so' files, rerun with the '--prune' option to remove them:", orphan_so_files.len() ); }