about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorNaïm Favier <n@monade.li>2022-12-22 15:17:05 +0100
committerNaïm Favier <n@monade.li>2022-12-22 15:17:05 +0100
commit84d8b9a809ff4ece36c31dcec57966f3b34d20b1 (patch)
tree001aa172d3b261bfff3bfc6cf7f4e57c4e2bcefa /nixos
parentb467047119513b2e1c4e2253d9699a8bdc3ff9f3 (diff)
nixos/systemd: document what `scriptArgs` is for
Diffstat (limited to 'nixos')
-rw-r--r--nixos/lib/systemd-unit-options.nix6
1 files changed, 5 insertions, 1 deletions
diff --git a/nixos/lib/systemd-unit-options.nix b/nixos/lib/systemd-unit-options.nix
index 44f26572a23ba..9c7cb34f14b57 100644
--- a/nixos/lib/systemd-unit-options.nix
+++ b/nixos/lib/systemd-unit-options.nix
@@ -324,7 +324,11 @@ in rec {
       scriptArgs = mkOption {
         type = types.str;
         default = "";
-        description = lib.mdDoc "Arguments passed to the main process script.";
+        example = "%i";
+        description = lib.mdDoc ''
+          Arguments passed to the main process script.
+          Can contain specifiers (`%` placeholders expanded by systemd, see {manpage}`systemd.unit(5)`).
+        '';
       };
 
       preStart = mkOption {