NixOS Module Options

`custom.programs.gnome-calculator.enable`

Enable Gnome calculator application

Type: boolean

Default: false

Example: true

`custom.programs.qbittorrent.enable`

Enable QBittorrent torrent client

Type: boolean

Default: false

Example: true

`custom.programs.default.enable`

Enable default applications

Type: boolean

Default: false

Example: true

`custom.programs.defaultApplications`

Type:

lib.types.attrsOf (lib.types.submodule (_: {
  freeformType = settingsFormat.type;

  options = {
    name = lib.mkOption {
      type = lib.types.str;
    };

    path = lib.mkOption {
      type = lib.types.str;
    };

    wm-class = lib.mkOption {
      type = lib.types.str;
    };
  };
}))

Default: {}

`custom.programs.cantata.enable`

Enable Cantata MPD client

Type: boolean

Default: false

Example: true

`custom.programs.grim.enable`

Enable Grim wayland image grabber

Type: boolean

Default: false

Example: true

`custom.programs.cli.atuin.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.tlp"

`custom.programs.cli.neovim.enable`

Enable NeoVim text editor

Type: boolean

Default: false

Example: true

`custom.programs.cli.bat.enable`

Enable Bat, a cat clone with extra's

Type: boolean

Default: false

Example: true

`custom.programs.cli.default.enable`

Enable default shell applications

Type: boolean

Default: false

Example: true

`custom.programs.cli.tmux.enable`

Enable tmux terminal multiplexer

Type: boolean

Default: false

Example: true

`custom.programs.cli.nix-index.enable`

Enable nix-index database

Type: boolean

Default: false

Example: true

`custom.programs.cli.starship.enable`

Enable Starship prompt

Type: boolean

Default: false

Example: true

`custom.programs.cli.fastfetch.enable`

Enable fastfetch

Type: boolean

Default: false

Example: true

`custom.programs.cli.direnv.enable`

Enable Direnv

Type: boolean

Default: false

Example: true

`custom.programs.cli.git.enable`

Enable Git version control manager client

Type: boolean

Default: false

Example: true

`custom.programs.cli.zsh.enable`

Enable zsh shell

Type: boolean

Default: false

Example: true

`custom.programs.cli.tealdeer.enable`

Enable Teal Deer tldr program

Type: boolean

Default: false

Example: true

`custom.programs.cli.eza.enable`

Enable Eza ls replacement

Type: boolean

Default: false

Example: true

`custom.programs.cli.gpg.enable`

Enable GnuPG

Type: boolean

Default: false

Example: true

`custom.programs.flameshot.enable`

Enable Flameshot screenshot program

Type: boolean

Default: false

Example: true

`custom.programs.eduvpn.enable`

Enable EduVPN client

Type: boolean

Default: false

Example: true

`custom.programs.spotify.enable`

Enable Spotify music application

Type: boolean

Default: false

Example: true

`custom.programs.thunar.enable`

Enable Thunar file explorer

Type: boolean

Default: false

Example: true

`custom.programs.thunderbird.enable`

Enable Thunderbird email client

Type: boolean

Default: false

Example: true

`custom.programs.file-roller.enable`

Enable File roller archive manager

Type: boolean

Default: false

Example: true

`custom.programs.nautilus.enable`

Enable Nautilus file explorer

Type: boolean

Default: false

Example: true

`custom.programs.missioncenter.enable`

Enable Mission center system monitor

Type: boolean

Default: false

Example: true

`custom.programs.openshot.enable`

Enable Openshot video editing software

Type: boolean

Default: false

Example: true

`custom.programs.games.enable`

Enable default game launchers

Type: boolean

Default: false

Example: true

`custom.programs.games.scarab.enable`

Enable Scarab Hollow Knight mod manager

Type: boolean

Default: false

Example: true

`custom.programs.games.emulators.ryujinx.enable`

Enable Ryujinx Open-source Nintendo switch emulator

Type: boolean

Default: false

Example: true

`custom.programs.games.emulators.desmume.enable`

Enable Desmume Open-source Nintendo DS emulator

Type: boolean

Default: false

Example: true

`custom.programs.games.mangohud.enable`

Enable MangoHud game overlay

Type: boolean

Default: false

Example: true

`custom.programs.games.minecraft.enable`

Enable Minecraft launcher

Type: boolean

Default: false

Example: true

`custom.programs.games.heroic.enable`

Enable Heroic games launcher

Type: boolean

Default: false

Example: true

`custom.programs.librewolf.enable`

Enable Librewolf browser

Type: boolean

Default: false

Example: true

`custom.programs.development.unity.enable`

Enable Unity hub

Type: boolean

Default: false

Example: true

`custom.programs.development.vscode.enable`

Enable VSCode development IDE

Type: boolean

Default: false

Example: true

`custom.programs.development.enable`

Enable default development applications

Type: boolean

Default: false

Example: true

`custom.programs.development.bruno.enable`

Enable Bruno API client

Type: boolean

Default: false

Example: true

`custom.programs.development.digital.enable`

Enable Digital logic designer and circuit simulator

Type: boolean

Default: false

Example: true

`custom.programs.ario.enable`

Enable Ario MPD client

Type: boolean

Default: false

Example: true

`custom.programs.loupe.enable`

Enable Loupe image viewer program

Type: boolean

Default: false

Example: true

`custom.programs.mpv.enable`

Enable MPV video player

Type: boolean

Default: false

Example: true

`custom.programs.jellyfin.enable`

Enable Jellyfin client application

Type: boolean

Default: false

Example: true

`custom.programs.kitty.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.tidal.enable`

Enable Tidal music application

Type: boolean

Default: false

Example: true

`custom.programs.evince.enable`

Enable Evince PDF reader program

Type: boolean

Default: false

Example: true

`custom.programs.freetube.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.theming.enable`

Enable default theming options

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.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.office.latex.enable`

Enable Latex

Type: boolean

Default: false

Example: true

`custom.programs.office.enable`

Enable default office applications

Type: boolean

Default: false

Example: true

`custom.programs.office.teams.enable`

Enable Microsoft Teams for Linux

Type: boolean

Default: false

Example: true

`custom.programs.office.libreoffice.enable`

Enable Libre office suite

Type: boolean

Default: false

Example: true

`custom.programs.office.gimp.enable`

Enable Gnu Image Manipulation Program

Type: boolean

Default: false

Example: true

`custom.programs.cheese.enable`

Enable Cheese camera application

Type: boolean

Default: false

Example: true

`custom.programs.parsec.enable`

Enable Parsec remote streaming program

Type: boolean

Default: false

Example: true

`custom.programs.messaging.schildichat.enable`

Enable Schildichat matrix client

Type: boolean

Default: false

Example: true

`custom.programs.messaging.enable`

Enable default messaging applications

Type: boolean

Default: false

Example: true

`custom.programs.messaging.element.enable`

Enable Element matrix client

Type: boolean

Default: false

Example: true

`custom.programs.messaging.whatsapp.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.dorion.enable`

Enable Dorion Discord client

Type: boolean

Default: false

Example: true

`custom.programs.messaging.vesktop.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.fractal.enable`

Enable Fractal Matrix client

Type: boolean

Default: false

Example: true

`custom.nixConfigLocation`

Type: lib.types.str

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

`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`

Enable XDG portals configuration

Type: boolean

Default: false

Example: true

`custom.wm.widgets.eww.enable`

Enable ElKowars wacky widgets

Type: boolean

Default: false

Example: true

`custom.wm.lockscreens.default.name`

The lock screens name

Type: lib.types.str

`custom.wm.lockscreens.default.path`

The path to the lock screens executable file

Type: lib.types.str

`custom.wm.lockscreens.swaylock.enable`

Enable swaylock lock screen

Type: boolean

Default: false

Example: true

`custom.wm.default.name`

The window managers name

Type: lib.types.str

`custom.wm.default.path`

The path to the window managers executable file

Type: lib.types.str

`custom.wm.launchers.rofi.enable`

Enable Rofi start menu

Type: boolean

Default: false

Example: true

`custom.wm.launchers.rofi.terminal`

The default terminal to use

Type: lib.types.str

Default: config.custom.programs.defaultApplications.terminal.path

`custom.wm.launchers.rofi.wayland`

Whether to use the wayland version of rofi

Type: lib.types.bool

Default: config.custom.wm.wayland.enable

`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`

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.docks.nwg-dock.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.enable`

Enable sway window manager

Type: boolean

Default: false

Example: true

`custom.wm.wayland.sway.useFx`

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.terminal`

The default terminal to use

Type: lib.types.str

Default: config.custom.programs.defaultApplications.terminal.path

`custom.wm.wayland.sway.menu`

The default menu application to use

Type: lib.types.str

Default: config.custom.programs.defaultApplications.menu.path

`custom.wm.wayland.sway.file-explorer`

The default file explorer to use

Type: lib.types.str

Default: config.custom.programs.defaultApplications.file-explorer.path

`custom.wm.wayland.sway.lockscreen.enable`

Enable screen locking

Type: lib.types.bool

Default: true

`custom.wm.wayland.sway.lockscreen.path`

The path to the lock screen

Type: lib.types.str

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

`custom.wm.wayland.sway.notification.enable`

Enable notification service

Type: lib.types.bool

Default: false

`custom.wm.wayland.sway.notification.path`

The path to the notification service

Type: lib.types.str

Default: config.custom.wm.notifications.default.path

`custom.wm.wayland.sway.keybinds.screenshot.enable`

Enable screenshot functionality

Type: lib.types.bool

Default: true

`custom.wm.wayland.sway.keybinds.screenshot.path`

Path to screenshot program

Type: lib.types.str

Default: config.custom.programs.defaultApplications.screenshot.path

`custom.wm.wayland.sway.keybinds.media`

Enable media hotkey configuration

Type: lib.types.bool

Default: true

`custom.wm.wayland.sway.keybinds.backlight`

Enable backlight hotkey configuration

Type: lib.types.bool

Default: false

`custom.wm.wayland.sway.keybinds.sound`

Enable sound hotkey configuration

Type: lib.types.bool

Default: true

`custom.wm.wayland.sway.keybinds.osd`

Enable osd for brightness and volume controls

Type: lib.types.bool

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

`custom.wm.wayland.sway.keybinds.wlsr`

Enable WLSR replay saving keybind

Type: lib.types.bool

Default: false

`custom.wm.wayland.sway.keybinds.cliphist`

Enable Cliphist clipboard history menu

Type: lib.types.bool

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

`custom.wm.wayland.sway.startup`

Applications to run at startup

Type:

lib.types.listOf (lib.types.submodule {
  options = {
    path = lib.mkOption {
      type = lib.types.str;
      description = "Path to executable";
    };

    runOnRestart = lib.mkOption {
      type = lib.types.bool;
      default = false;
    };
  };
})

Default: []

`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.wm.wayland.sway.osd.enable`

Enable sway osd

Type: lib.types.bool

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

`custom.wm.notifications.dunst.enable`

Enable Dunst notification service

Type: boolean

Default: false

Example: true

`custom.wm.notifications.mako.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.swaync.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.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.bars.waybar.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.default.name == "sway"

`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.path

`custom.wm.bars.waybar.features.wireguard`

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`

Enable support for the HyperX Cloud Flight series of headsets

Type: boolean

Default: false

Example: true

`custom.services.spotifyd.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

`custom.services.betterlockscreen.enable`

Enable Betterlockscreen service

Type: boolean

Default: false

Example: true

`custom.services.syncthing.enable`

Enable Syncthing file synchronize

Type: boolean

Default: false

Example: true

`custom.services.kdeconnect.enable`

Enable Kdeconnect service

Type: boolean

Default: false

Example: true

`custom.services.poweralertd.enable`

Enable Power Alert daemon, providing power notifications when needed

Type: boolean

Default: false

Example: true

`custom.services.mpd.enable`

Enable MPD

Type: boolean

Default: false

Example: true

`custom.services.vscode-server.enable`

Enable VSCode server protocol

Type: boolean

Default: false

Example: true

`custom.services.mconnect.enable`

Enable MConnect

Type: boolean

Default: false

Example: true

`custom.services.polybar.enable`

Enable Polybar

Type: boolean

Default: false

Example: true

Generated with nix-options-doc