summary refs log tree commit diff
path: root/nixos/modules/services/security/physlock.nix
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2022-08-02 06:02:34 +0000
committerGitHub <noreply@github.com>2022-08-02 06:02:34 +0000
commit0f0010fda33b7082197495df475d02f64d7e5050 (patch)
treedeee10eaf5f1b24afc73804ae70aec24e6fcf2ce /nixos/modules/services/security/physlock.nix
parentad090ff8671dcb957c0bafef4eba9d527d90d957 (diff)
parentd2042f91c1ad953825556be3ec2e53cf9a91fc77 (diff)
downloadnixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.gz
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.bz2
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.lz
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.xz
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.zst
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.zip
Merge master into staging-next
Diffstat (limited to 'nixos/modules/services/security/physlock.nix')
-rw-r--r--nixos/modules/services/security/physlock.nix22
1 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/services/security/physlock.nix b/nixos/modules/services/security/physlock.nix
index 760e80f147f..3db9e0ac445 100644
--- a/nixos/modules/services/security/physlock.nix
+++ b/nixos/modules/services/security/physlock.nix
@@ -17,15 +17,15 @@ in
       enable = mkOption {
         type = types.bool;
         default = false;
-        description = ''
-          Whether to enable the <command>physlock</command> screen locking mechanism.
+        description = lib.mdDoc ''
+          Whether to enable the {command}`physlock` screen locking mechanism.
 
-          Enable this and then run <command>systemctl start physlock</command>
+          Enable this and then run {command}`systemctl start physlock`
           to securely lock the screen.
 
           This will switch to a new virtual terminal, turn off console
           switching and disable SysRq mechanism (when
-          <option>services.physlock.disableSysRq</option> is set)
+          {option}`services.physlock.disableSysRq` is set)
           until the root or user password is given.
         '';
       };
@@ -33,7 +33,7 @@ in
       allowAnyUser = mkOption {
         type = types.bool;
         default = false;
-        description = ''
+        description = lib.mdDoc ''
           Whether to allow any user to lock the screen. This will install a
           setuid wrapper to allow any user to start physlock as root, which
           is a minor security risk. Call the physlock binary to use this instead
@@ -44,7 +44,7 @@ in
       disableSysRq = mkOption {
         type = types.bool;
         default = true;
-        description = ''
+        description = lib.mdDoc ''
           Whether to disable SysRq when locked with physlock.
         '';
       };
@@ -52,7 +52,7 @@ in
       lockMessage = mkOption {
         type = types.str;
         default = "";
-        description = ''
+        description = lib.mdDoc ''
           Message to show on physlock login terminal.
         '';
       };
@@ -62,7 +62,7 @@ in
         suspend = mkOption {
           type = types.bool;
           default = true;
-          description = ''
+          description = lib.mdDoc ''
             Whether to lock screen with physlock just before suspend.
           '';
         };
@@ -70,7 +70,7 @@ in
         hibernate = mkOption {
           type = types.bool;
           default = true;
-          description = ''
+          description = lib.mdDoc ''
             Whether to lock screen with physlock just before hibernate.
           '';
         };
@@ -79,11 +79,11 @@ in
           type = types.listOf types.str;
           default = [];
           example = [ "display-manager.service" ];
-          description = ''
+          description = lib.mdDoc ''
             Other targets to lock the screen just before.
 
             Useful if you want to e.g. both autologin to X11 so that
-            your <filename>~/.xsession</filename> gets executed and
+            your {file}`~/.xsession` gets executed and
             still to have the screen locked so that the system can be
             booted relatively unattended.
           '';