From bcccfee65972c20db6646f86357646b36809ec95 Mon Sep 17 00:00:00 2001
From: Maurice Zhou <yuchen@apvc.uk>
Date: Sun, 16 Apr 2023 23:56:55 +0200
Subject: tmux: add note for tmux-direct in module option

Signed-off-by: Maurice Zhou <yuchen@apvc.uk>
---
 nixos/modules/programs/tmux.nix | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'nixos')

diff --git a/nixos/modules/programs/tmux.nix b/nixos/modules/programs/tmux.nix
index 4fb9175fb8d21..58c9cbc3ed003 100644
--- a/nixos/modules/programs/tmux.nix
+++ b/nixos/modules/programs/tmux.nix
@@ -160,7 +160,10 @@ in {
         default = defaultTerminal;
         example = "screen-256color";
         type = types.str;
-        description = lib.mdDoc "Set the $TERM variable.";
+        description = lib.mdDoc ''
+          Set the $TERM variable. Use tmux-direct if italics or 24bit true color
+          support is needed.
+        '';
       };
 
       secureSocket = mkOption {
-- 
cgit 1.4.1