summaryrefslogtreecommitdiff
path: root/modules/programs/tmux.nix
diff options
context:
space:
mode:
authorEmily <vcs@emily.moe>2023-06-22 12:21:32 +0100
committerEmily <vcs@emily.moe>2023-06-24 10:48:55 +0100
commite65131e69cab1b18fb49b572b983a18720502e1b (patch)
tree8bfb50580aad1bc01db494a138ac0855bfc518b3 /modules/programs/tmux.nix
parentefe314cdbabaf5cd210d9c658b4ad540437b7ee5 (diff)
treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]; thanks to @pennae for writing this tool! It automatically checks that the resulting documentation doesn't change, although my fork loosens this a little to ignore some irrelevant whitespace and typographical differences. As of this commit there is no DocBook remaining in the options documentation. You can play along at home if you want to reproduce this commit: $ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \ {} + [my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
Diffstat (limited to 'modules/programs/tmux.nix')
-rw-r--r--modules/programs/tmux.nix16
1 files changed, 8 insertions, 8 deletions
diff --git a/modules/programs/tmux.nix b/modules/programs/tmux.nix
index 04dce29..7278479 100644
--- a/modules/programs/tmux.nix
+++ b/modules/programs/tmux.nix
@@ -46,47 +46,47 @@ in
programs.tmux.enable = mkOption {
type = types.bool;
default = false;
- description = "Whether to configure tmux.";
+ description = lib.mdDoc "Whether to configure tmux.";
};
programs.tmux.enableSensible = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Enable sensible configuration options for tmux.";
+ description = lib.mdDoc "Enable sensible configuration options for tmux.";
};
programs.tmux.enableMouse = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Enable mouse support for tmux.";
+ description = lib.mdDoc "Enable mouse support for tmux.";
};
programs.tmux.enableFzf = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Enable fzf keybindings for selecting tmux sessions and panes.";
+ description = lib.mdDoc "Enable fzf keybindings for selecting tmux sessions and panes.";
};
programs.tmux.enableVim = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Enable vim style keybindings for copy mode, and navigation of tmux panes.";
+ description = lib.mdDoc "Enable vim style keybindings for copy mode, and navigation of tmux panes.";
};
programs.tmux.iTerm2 = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Cater to iTerm2 and its tmux integration, as appropriate.";
+ description = lib.mdDoc "Cater to iTerm2 and its tmux integration, as appropriate.";
};
programs.tmux.defaultCommand = mkOption {
type = types.either types.str types.package;
- description = "The default command to use for tmux panes.";
+ description = lib.mdDoc "The default command to use for tmux panes.";
};
programs.tmux.tmuxOptions = mkOption {
@@ -98,7 +98,7 @@ in
programs.tmux.extraConfig = mkOption {
type = types.lines;
default = "";
- description = "Extra configuration to add to <filename>tmux.conf</filename>.";
+ description = lib.mdDoc "Extra configuration to add to {file}`tmux.conf`.";
};
};