About

bzmenu (BlueZ Menu) manages Bluetooth through your launcher of choice.

Dependencies

Build

• Rust (includes cargo)
• pkg-config – For detecting required libraries
• dbus – For D-Bus integration headers

Runtime

• bluetoothd – BlueZ daemon
• dbus – For communicating with bluetoothd
• A launcher with stdin mode support
• Notification daemon – For pairing confirmations and other system notifications (e.g. dunst, fnott, included with DEs or can be installed manually)

Optional

• NerdFonts – For font-based icons (default mode)
• XDG icon theme – For image-based icons (used with -i xdg, included with DEs or can be installed manually)

Compatibility

[!TIP] If your preferred launcher isn't directly supported, use custom mode with appropriate command flags.

Installation

Build from source

Run the following commands:

git clone https://github.com/e-tho/bzmenu
cd bzmenu
cargo build --release

An executable file will be generated at target/release/bzmenu, which you can then copy to a directory in your $PATH.

Nix

Install from nixpkgs:

{ pkgs, ... }:
{
  environment.systemPackages = [ pkgs.bzmenu ];
}

inputs.bzmenu.url = "github:e-tho/bzmenu";

{ inputs, ... }:
{
  environment.systemPackages = [ inputs.bzmenu.packages.${pkgs.system}.default ];
}

Alpine Linux

Install from the testing repository:

apk add bzmenu

Arch Linux

Install from AUR with your favorite helper:

paru -S bzmenu # or bzmenu-git

Gentoo Linux

Install from GURU repository:

eselect repository enable guru
emaint sync -r guru
emerge --ask net-wireless/bzmenu

Usage

Supported launchers

Specify an application using -l or --launcher flag.

bzmenu -l fuzzel

Custom launchers

Specify custom as the launcher and set your command using the --launcher-command flag. Ensure your launcher supports stdin mode, and that it is properly configured in the command.

bzmenu -l custom --launcher-command "my_custom_launcher --flag"

Prompt and Placeholder support

Use {hint} as the value for the relevant flag in your command; it will be substituted with the appropriate text as needed.

bzmenu -l custom --launcher-command "my_custom_launcher --placeholder-flag '{hint}'" # or --prompt-flag '{hint}:'

Example to enable all features

This example demonstrates enabling all available features in custom mode with fuzzel.

bzmenu -l custom --launcher-command "fuzzel -d --placeholder '{hint}'"

Available Options

Contributing

Please see CONTRIBUTING.md for contribution guidelines.

License

This project is licensed under the terms of the GNU General Public License version 3, or (at your option) any later version.

Support this project

If you find this project useful and would like to help me dedicate more time to its development, consider supporting my work.