From 768e9819355bcd53bcae54f04a2ba224cee8d062 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tristan=20Dani=C3=ABl=20Maat?= <tm@tlater.net>
Date: Thu, 7 Sep 2023 17:13:10 +0200
Subject: [PATCH] swaylock: document the need for host PAM configuration

---
 modules/programs/swaylock.nix | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/modules/programs/swaylock.nix b/modules/programs/swaylock.nix
index 774ecf705..be577ea80 100644
--- a/modules/programs/swaylock.nix
+++ b/modules/programs/swaylock.nix
@@ -16,7 +16,21 @@ in {
         false otherwise
       '';
       example = true;
-      description = "Whether to enable swaylock.";
+      description = ''
+        Whether to enable swaylock.
+
+        Note that PAM must be configured to enable swaylock to perform
+        authentication. The package installed through home-manager
+        will *not* be able to unlock the session without this
+        configuration.
+
+        On NixOS, this is by default enabled with the sway module, but
+        for other compositors it can currently be enabled using:
+
+        ```nix
+        security.pam.services.swaylock = {};
+        ```
+      '';
     };
 
     package = mkPackageOption pkgs "swaylock" { };