Skip to content

NixOS Module Options

custom.xdg.portals.wlr.enable

Enable WLR XDG desktop portal

Type: lib.types.bool

Default: config.custom.wm.wayland.sway.enable

custom.xdg.portals.wlr.settings

Configuration for xdg-desktop-portal-wlr.

See xdg-desktop-portal-wlr(5) for supported values.

Type:

lib.types.submodule {
  freeformType = settingsFormat.type;
}

Default:

{
  screencast = {
    max_fps = 60;
    chooser_type = "simple";
    chooser_cmd = lib.getExe rofiChooser;
  };
}

custom.xdg.portals.enable

Whether to enable Enable XDG portals configuration.

Type: boolean

Default: false

Example: true

custom.wm.bars.waybar.enable

Whether to enable Enable waybar status bar.

Type: boolean

Default: false

Example: true

custom.wm.bars.waybar.font

The font to use

Type: lib.types.str

Default: config.custom.programs.theming.font.serif.name

custom.wm.bars.waybar.font-size

The font size to use

Type: lib.types.int

Default: 16

custom.wm.bars.waybar.features.sway

Enable sway support

Type: lib.types.bool

Default: config.custom.wm.wayland.sway.enable

custom.wm.bars.waybar.features.battery

Enable battery support

Type: lib.types.bool

Default: false

custom.wm.bars.waybar.features.backlight

Enable backlight support

Type: lib.types.bool

Default: false

custom.wm.bars.waybar.features.power-profiles

Enable power profiles support

Type: lib.types.bool

Default: false

custom.wm.bars.waybar.features.media

Enable media management via MPRIS

Type: lib.types.bool

Default: true

custom.wm.bars.waybar.features.lockscreen.enable

Enable screen locking

Type: lib.types.bool

Default: true

custom.wm.bars.waybar.features.lockscreen.path

The path to the lock screen

Type: lib.types.str

Default: config.custom.wm.lockscreens.default.executable

custom.wm.bars.waybar.features.wireguard

Whether to enable Enable wireguard module.

Type: boolean

Default: false

Example: true

custom.wm.bars.waybar.features.mconnect

Enable MConnect module

Type: lib.types.bool

Default: config.custom.services.mconnect.enable

custom.wm.bars.waybar.features.swaync

Enable support for swaync notification hub

Type: lib.types.bool

Default: config.custom.wm.notifications.swaync.enable

custom.wm.bars.waybar.features.tray

Enable tray support

Type: lib.types.bool

Default: true

custom.wm.bars.waybar.features.hcfs

Whether to enable Enable support for the HyperX Cloud Flight series of headsets.

Type: boolean

Default: false

Example: true

custom.wm.widgets.eww.enable

Whether to enable Enable ElKowars wacky widgets.

Type: boolean

Default: false

Example: true

custom.wm.notifications.mako.enable

Whether to enable Enable mako notification service.

Type: boolean

Default: false

Example: true

custom.wm.notifications.mako.font

Type: lib.types.str

Default:

builtins.getAttr "name" (builtins.head config.custom.programs.theming.font.default)

custom.wm.notifications.default.name

The notification managers name

Type: lib.types.str

custom.wm.notifications.default.path

The path to the notification managers executable file

Type: lib.types.str

custom.wm.notifications.hub.path

The path to the notification managers executable file

Type: lib.types.str

custom.wm.notifications.swaync.enable

Whether to enable Enable sway notifaction manager.

Type: boolean

Default: false

Example: true

custom.wm.notifications.swaync.font

Type: lib.types.str

Default:

builtins.getAttr "name" (builtins.head config.custom.programs.theming.font.default)

custom.wm.notifications.dunst.enable

Whether to enable Enable Dunst notification service.

Type: boolean

Default: false

Example: true

custom.wm.launchers.rofi.enable

Whether to enable Enable Rofi start menu.

Type: boolean

Default: false

Example: true

custom.wm.launchers.rofi.font

The font to use for rofi

Type: lib.types.str

Default: config.custom.programs.theming.font.serif.name

custom.wm.x11.i3.enable

Whether to enable Enable i3 wm.

Type: boolean

Default: false

Example: true

custom.wm.x11.i3.mod

The modifier key to be used

Type: lib.types.str

Default: "Mod4"

custom.wm.lockscreens.gtklock.enable

Whether to enable Enable GTK lock screen.

Type: boolean

Default: false

Example: true

custom.wm.lockscreens.default.keybind

Keybind to show the lockscreen

Type: lib.types.str

custom.wm.lockscreens.default.executable

The path to the lock screens executable file

Type: lib.types.path

custom.wm.lockscreens.swaylock.enable

Whether to enable Enable swaylock lock screen.

Type: boolean

Default: false

Example: true

custom.wm.docks.nwg-dock.enable

Whether to enable Enable NWG Dock.

Type: boolean

Default: false

Example: true

custom.wm.docks.nwg-dock.package

Type: lib.types.package

Default: pkgs.nwg-dock

custom.wm.wayland.cliphist.enable

Enable cliphist clipboard manager

Type: lib.types.bool

Default: config.custom.wm.wayland.enable

custom.wm.wayland.enable

Enable Wayland

Type: lib.types.bool

Default: config.custom.wm.wayland.sway.enable

custom.wm.wayland.sway.idle.enable

Enable swayidle

Type: types.bool

Default: config.custom.wm.wayland.sway.enable

custom.wm.wayland.sway.osd.enable

Enable sway osd

Type: lib.types.bool

Default: config.custom.wm.wayland.sway.enable

custom.wm.wayland.sway.enable

Whether to enable Enable sway window manager.

Type: boolean

Default: false

Example: true

custom.wm.wayland.sway.useSwayFx

Use swayFx instead of normal sway

Type: lib.types.bool

Default: true

custom.wm.wayland.sway.modifierKey

The main key for all key combinations

Type: lib.types.str

Default: "Mod4"

custom.wm.wayland.sway.output

Attribute set that defines outputs. See {manpage} sway-input(5) for details

Type: lib.types.attrsOf (lib.types.attrsOf lib.types.str)

Default: {}

custom.wm.wayland.sway.workspaceOutputAssign

Assign workspaces to outputs.

Type:

lib.types.listOf (lib.types.submodule {
  options = {
    output = lib.mkOption {
      type = lib.types.str;
    };

    workspaces = lib.mkOption {
      type = lib.types.listOf lib.types.int;
    };
  };
})

Default: []

custom.wm.wayland.sway.input

An attribute set that defines inputs. See sway-input(5) for details.

Type: lib.types.attrsOf (lib.types.attrsOf lib.types.str)

Default: {}

custom.wm.wayland.sway.font

The font to use for displaying title bar text

Type: lib.types.str

Default: config.custom.programs.theming.font.serif.name

custom.programs.cantata.enable

Whether to enable Enable Cantata MPD client.

Type: boolean

Default: false

Example: true

custom.programs.file-roller.enable

Whether to enable Enable File roller archive manager.

Type: boolean

Default: false

Example: true

custom.programs.wayland-screenshot.enable

Whether to enable Enable Wayland screenshot program.

Type: boolean

Default: false

Example: true

custom.programs.tidal.enable

Whether to enable Enable Tidal music application.

Type: boolean

Default: false

Example: true

custom.programs.feishin.enable

Whether to enable Enable Feishin jellyfin music client.

Type: boolean

Default: false

Example: true

custom.programs.freetube.enable

Whether to enable Enable Freetube Youtube client.

Type: boolean

Default: false

Example: true

custom.programs.freetube.defaultResolution

Default resolution for video player

Type: lib.types.enum ["1080" "1440" "2160"]

Default: "1080"

custom.programs.eduvpn.enable

Whether to enable Enable EduVPN client.

Type: boolean

Default: false

Example: true

custom.programs.missioncenter.enable

Whether to enable Enable Mission center system monitor.

Type: boolean

Default: false

Example: true

custom.programs.gnome-calculator.enable

Whether to enable Enable Gnome calculator application.

Type: boolean

Default: false

Example: true

custom.programs.parsec.enable

Whether to enable Enable Parsec remote streaming program.

Type: boolean

Default: false

Example: true

custom.programs.theming.qt.enable

Enable Qt theming

Type: lib.types.bool

Default: config.custom.programs.theming.enable

custom.programs.theming.qt.style.name

Type: lib.types.str

Default: "adwaita-dark"

custom.programs.theming.enable

Whether to enable Enable default theming options.

Type: boolean

Default: false

Example: true

custom.programs.theming.gtk.enable

Enable GTK 3/4 theming

Type: lib.types.bool

Default: config.custom.programs.theming.enable

custom.programs.theming.gtk.theme.name

Type: lib.types.str

Default: "WhiteSur-Dark"

custom.programs.theming.gtk.iconTheme.name

Type: lib.types.str

Default: "WhiteSur-dark"

custom.programs.nautilus.enable

Whether to enable Enable Nautilus file explorer.

Type: boolean

Default: false

Example: true

custom.programs.messaging.vesktop.enable

Whether to enable Enable Vesktop Discord client.

Type: boolean

Default: false

Example: true

custom.programs.messaging.vesktop.autostart

Whether to autostart this application

Type: lib.types.bool

Default: true

custom.programs.messaging.whatsapp.enable

Whether to enable Enable Whatsapp for Linux.

Type: boolean

Default: false

Example: true

custom.programs.messaging.whatsapp.autostart

Whether to autostart this application

Type: lib.types.bool

Default: true

custom.programs.messaging.element.enable

Whether to enable Enable Element matrix client.

Type: boolean

Default: false

Example: true

custom.programs.messaging.enable

Whether to enable Enable default messaging applications.

Type: boolean

Default: false

Example: true

custom.programs.messaging.dorion.enable

Whether to enable Enable Dorion Discord client.

Type: boolean

Default: false

Example: true

custom.programs.messaging.fractal.enable

Whether to enable Enable Fractal Matrix client.

Type: boolean

Default: false

Example: true

custom.programs.messaging.schildichat.enable

Whether to enable Enable Schildichat matrix client.

Type: boolean

Default: false

Example: true

custom.programs.messaging.mumble.enable

Whether to enable Enable Mumble client.

Type: boolean

Default: false

Example: true

custom.programs.jellyfin-client.enable

Whether to enable Enable Jellyfin client application.

Type: boolean

Default: false

Example: true

custom.programs.games.scarab.enable

Whether to enable Enable Scarab Hollow Knight mod manager.

Type: boolean

Default: false

Example: true

custom.programs.games.emulators.ryujinx.enable

Whether to enable Enable Ryujinx Open-source Nintendo Switch emulator.

Type: boolean

Default: false

Example: true

custom.programs.games.emulators.desmume.enable

Whether to enable Enable Desmume Open-source Nintendo DS emulator.

Type: boolean

Default: false

Example: true

custom.programs.games.heroic.enable

Whether to enable Enable Heroic games launcher.

Type: boolean

Default: false

Example: true

custom.programs.games.enable

Whether to enable Enable default game launchers.

Type: boolean

Default: false

Example: true

custom.programs.games.mangohud.enable

Whether to enable Enable MangoHud game overlay.

Type: boolean

Default: false

Example: true

custom.programs.games.minecraft.enable

Whether to enable Enable Minecraft launcher.

Type: boolean

Default: false

Example: true

custom.programs.flameshot.enable

Whether to enable Enable Flameshot screenshot program.

Type: boolean

Default: false

Example: true

custom.programs.mpv.enable

Whether to enable Enable MPV video player.

Type: boolean

Default: false

Example: true

custom.programs.thunderbird.enable

Whether to enable Enable Thunderbird email client.

Type: boolean

Default: false

Example: true

custom.programs.cheese.enable

Whether to enable Enable Cheese camera application.

Type: boolean

Default: false

Example: true

custom.programs.default.enable

Whether to enable Enable default applications.

Type: boolean

Default: false

Example: true

custom.programs.office.libreoffice.enable

Whether to enable Enable Libre office suite.

Type: boolean

Default: false

Example: true

custom.programs.office.latex.enable

Whether to enable Enable Latex.

Type: boolean

Default: false

Example: true

custom.programs.office.teams.enable

Whether to enable Enable Microsoft Teams for Linux.

Type: boolean

Default: false

Example: true

custom.programs.office.gimp.enable

Whether to enable Enable Gnu Image Manipulation Program.

Type: boolean

Default: false

Example: true

custom.programs.office.enable

Whether to enable Enable default office applications.

Type: boolean

Default: false

Example: true

custom.programs.development.digital.enable

Whether to enable Enable Digital logic designer and circuit simulator.

Type: boolean

Default: false

Example: true

custom.programs.development.enable

Whether to enable Enable default development applications.

Type: boolean

Default: false

Example: true

custom.programs.development.vscode.enable

Whether to enable Enable VSCode development IDE.

Type: boolean

Default: false

Example: true

custom.programs.development.unity.enable

Whether to enable Enable Unity hub.

Type: boolean

Default: false

Example: true

custom.programs.development.zed.enable

Whether to enable Enable Zed development IDE.

Type: boolean

Default: false

Example: true

custom.programs.development.bruno.enable

Whether to enable Enable Bruno API client.

Type: boolean

Default: false

Example: true

custom.programs.openshot.enable

Whether to enable Enable Openshot video editing software.

Type: boolean

Default: false

Example: true

custom.programs.cli.nix-index.enable

Whether to enable Enable nix-index database.

Type: boolean

Default: false

Example: true

custom.programs.cli.zsh.enable

Whether to enable Enable zsh shell.

Type: boolean

Default: false

Example: true

custom.programs.cli.starship.enable

Whether to enable Enable Starship prompt.

Type: boolean

Default: false

Example: true

custom.programs.cli.fastfetch.enable

Whether to enable Enable fastfetch.

Type: boolean

Default: false

Example: true

custom.programs.cli.tmux.enable

Whether to enable Enable tmux terminal multiplexer.

Type: boolean

Default: false

Example: true

custom.programs.cli.default.enable

Whether to enable Enable default shell applications.

Type: boolean

Default: false

Example: true

custom.programs.cli.git.enable

Whether to enable Enable Git version control manager client.

Type: boolean

Default: false

Example: true

custom.programs.cli.atuin.enable

Whether to enable Enable Atuin history sync.

Type: boolean

Default: false

Example: true

custom.programs.cli.atuin.server

The remote Atuin server to connect to

Type: lib.types.str

Default: "https://atuin.sun.guusvanmeerveld.dev"

custom.programs.cli.neovim.enable

Whether to enable Enable NeoVim text editor.

Type: boolean

Default: false

Example: true

custom.programs.cli.direnv.enable

Whether to enable Enable Direnv.

Type: boolean

Default: false

Example: true

custom.programs.cli.eza.enable

Whether to enable Enable Eza ls replacement.

Type: boolean

Default: false

Example: true

custom.programs.cli.bat.enable

Whether to enable Enable Bat, a cat clone with extra's.

Type: boolean

Default: false

Example: true

custom.programs.cli.tealdeer.enable

Whether to enable Enable Teal Deer tldr program.

Type: boolean

Default: false

Example: true

custom.programs.cli.beets.enable

Whether to enable Enable Beets, a music manager program.

Type: boolean

Default: false

Example: true

custom.programs.cli.beets.musicDirectory

The default directory where music will be stored

Type: lib.types.str

Default: "~/Music"

custom.programs.cli.gpg.enable

Whether to enable Enable GnuPG.

Type: boolean

Default: false

Example: true

custom.programs.tauon.enable

Whether to enable Enable Tauon music application.

Type: boolean

Default: false

Example: true

custom.programs.qbittorrent.enable

Whether to enable Enable QBittorrent torrent client.

Type: boolean

Default: false

Example: true

custom.programs.spotify.enable

Whether to enable Enable Spotify music application.

Type: boolean

Default: false

Example: true

custom.programs.ario.enable

Whether to enable Enable Ario MPD client.

Type: boolean

Default: false

Example: true

custom.programs.librewolf.enable

Whether to enable Enable Librewolf browser.

Type: boolean

Default: false

Example: true

custom.programs.loupe.enable

Whether to enable Enable Loupe image viewer program.

Type: boolean

Default: false

Example: true

custom.programs.kitty.enable

Whether to enable Enable Kitty terminal emulator.

Type: boolean

Default: false

Example: true

custom.programs.kitty.font

The font to use for kitty

Type: lib.types.str

Default: config.custom.programs.theming.font.monospace.name

custom.programs.evince.enable

Whether to enable Enable Evince PDF reader program.

Type: boolean

Default: false

Example: true

custom.programs.thunar.enable

Whether to enable Enable Thunar file explorer.

Type: boolean

Default: false

Example: true

custom.nixConfigLocation

Type: lib.types.str

Default: "${config.home.homeDirectory}/Code/nixos-config"

custom.services.vscode-server.enable

Whether to enable Enable VSCode server protocol.

Type: boolean

Default: false

Example: true

custom.services.mpd.enable

Whether to enable Enable MPD.

Type: boolean

Default: false

Example: true

custom.services.kdeconnect.enable

Whether to enable Enable Kdeconnect service.

Type: boolean

Default: false

Example: true

custom.services.mconnect.enable

Whether to enable Enable MConnect.

Type: boolean

Default: false

Example: true

custom.services.ntfy-client.enable

Whether to enable Enable ntfy-client, a service that automatically subscribes to ntfy topics.

Type: boolean

Default: false

Example: true

custom.services.ntfy-client.servers

Type:

lib.types.listOf (lib.types.submodule (_: {
  options = {
    url = lib.mkOption {
      type = lib.types.str;
      description = "The url to the ntfy server";
    };

    topics = lib.mkOption {
      type = lib.types.listOf lib.types.str;
      default = [];
      description = "List of topics to subscribe to";
    };
  };
}))

Default: []

custom.services.playerctld.enable

Whether to enable Enable playerctld.

Type: boolean

Default: false

Example: true

custom.services.poweralertd.enable

Whether to enable Enable Power Alert daemon, providing power notifications when needed.

Type: boolean

Default: false

Example: true

custom.services.spotifyd.enable

Whether to enable Enable spotifyd streaming client.

Type: boolean

Default: false

Example: true

custom.services.spotifyd.client.name

The devices name as shown to spotify

Type: lib.types.str


Generated with nix-options-doc