1
0
mirror of https://github.com/nix-community/home-manager synced 2024-07-07 22:03:27 +02:00
home-manager/modules/services/window-managers/fluxbox.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

115 lines
3.2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.xsession.windowManager.fluxbox;
in {
meta.maintainers = [ maintainers.AndersonTorres ];
options = {
xsession.windowManager.fluxbox = {
enable = mkEnableOption (lib.mdDoc "Fluxbox window manager");
package = mkPackageOptionMD pkgs "fluxbox" { };
init = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Init configuration for Fluxbox, written to
{file}`~/.fluxbox/init`. Look at the
{manpage}`fluxbox(1)` manpage for details.
'';
};
apps = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Apps configuration for Fluxbox, written to
{file}`~/.fluxbox/apps`. Look at the
{manpage}`fluxbox(1)` manpage for details.
'';
};
keys = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Keyboard shortcuts configuration for Fluxbox, written to
{file}`~/.fluxbox/keys`. Look at the
{manpage}`fluxbox-keys(1)` manpage for details.
'';
};
menu = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Menu configuration for Fluxbox, written to
{file}`~/.fluxbox/menu`. Look at the
{manpage}`fluxbox-menu(1)` manpage for details.
'';
};
slitlist = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Slitlist configuration for Fluxbox, written to
{file}`~/.fluxbox/slitlist`. Look at the
{manpage}`fluxbox(1)` manpage for details.
'';
};
windowmenu = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Window menu configuration for Fluxbox, written to
{file}`~/.fluxbox/windowmenu`. Look at the
{manpage}`fluxbox-menu(1)`
manpage for details.
'';
};
extraCommandLineArgs = mkOption {
type = with types; listOf str;
default = [ ];
example = [ "-log" "/tmp/fluxbox.log" ];
description = lib.mdDoc ''
Extra command line arguments to pass to {command}`fluxbox`.
Look at the
{manpage}`fluxbox(1)` manpage for details.
'';
};
};
};
config = mkIf cfg.enable {
assertions = [
(hm.assertions.assertPlatform "xsession.windowManager.fluxbox" pkgs
platforms.linux)
];
home.packages = [ cfg.package ];
home.file = {
".fluxbox/init" = mkIf (cfg.init != "") { text = cfg.init; };
".fluxbox/apps" = mkIf (cfg.apps != "") { text = cfg.apps; };
".fluxbox/keys" = mkIf (cfg.keys != "") { text = cfg.keys; };
".fluxbox/menu" = mkIf (cfg.menu != "") { text = cfg.menu; };
".fluxbox/slitlist" = mkIf (cfg.slitlist != "") { text = cfg.slitlist; };
".fluxbox/windowmenu" =
mkIf (cfg.windowmenu != "") { text = cfg.windowmenu; };
};
xsession.windowManager.command = concatStringsSep " "
([ "${cfg.package}/bin/fluxbox" ]
++ escapeShellArgs (remove "" cfg.extraCommandLineArgs));
};
}