Crate jay_config

source
Expand description

This crate allows you to configure the Jay compositor.

A minimal example configuration looks as follows:

use jay_config::{config, quit, reload};
use jay_config::input::get_default_seat;
use jay_config::keyboard::mods::ALT;
use jay_config::keyboard::syms::{SYM_q, SYM_r};

fn configure() {
    let seat = get_default_seat();
    // Create a key binding to exit the compositor.
    seat.bind(ALT | SYM_q, || quit());
    // Reload the configuration.
    seat.bind(ALT | SYM_r, || reload());
}

config!(configure);

You should configure your crate to be compiled as a shared library:

[lib]
crate-type = ["cdylib"]

After compiling it, copy the shared library to $HOME/.config/jay/config.so and restart the compositor. It should then use your configuration file.

Note that you do not have to restart the compositor every time you want to reload your configuration afterwards. Instead, simply invoke the reload function via a shortcut.

Modules§

  • embedded
    Tools to configure the compositor in embedded environments.
  • exec
    Tools for spawning programs.
  • input
    Tools for configuring input devices.
  • io
    Tools for IO operations.
  • keyboard
    Tools affecting the keyboard behavior.
  • logging
    Tools for modifying the logging behavior of the compositor.
  • status
    Knobs for changing the status text.
  • tasks
    Tools for async task management.
  • theme
    Tools for configuring the look of the compositor.
  • timer
    Timers for one-time or repeated actions.
  • video
    Tools for configuring graphics cards and monitors.

Macros§

  • config
    Declares the entry point of the configuration.

Structs§

Enums§

Functions§