diff --git a/nixos/modules/image/repart.nix b/nixos/modules/image/repart.nix index 544779cd6e9b..c2963c816533 100644 --- a/nixos/modules/image/repart.nix +++ b/nixos/modules/image/repart.nix @@ -56,7 +56,7 @@ let }; description = '' Specify the repart options for a partiton as a structural setting. - See + See {manpage}`repart.d(5)` for all available options. ''; }; diff --git a/nixos/modules/misc/version.nix b/nixos/modules/misc/version.nix index 5610afc8168d..2a7c028a2b38 100644 --- a/nixos/modules/misc/version.nix +++ b/nixos/modules/misc/version.nix @@ -189,9 +189,9 @@ in description = '' Image identifier. - This corresponds to the IMAGE_ID field in os-release. See the + This corresponds to the `IMAGE_ID` field in {manpage}`os-release(5)`. See the upstream docs for more details on valid characters for this field: - https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_ID= + You would only want to set this option if you're build NixOS appliance images. ''; @@ -203,9 +203,9 @@ in description = '' Image version. - This corresponds to the IMAGE_VERSION field in os-release. See the + This corresponds to the `IMAGE_VERSION` field in {manpage}`os-release(5)`. See the upstream docs for more details on valid characters for this field: - https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_VERSION= + You would only want to set this option if you're build NixOS appliance images. ''; diff --git a/nixos/modules/services/games/mchprs.nix b/nixos/modules/services/games/mchprs.nix index cb59aa089f58..f1276aec911c 100644 --- a/nixos/modules/services/games/mchprs.nix +++ b/nixos/modules/services/games/mchprs.nix @@ -77,7 +77,7 @@ in description = '' Automatically restart the server after {option}`services.mchprs.maxRuntime`. - The time span format is described here: + The {manpage}`systemd.time(7)` time span format is described here: . If `null`, then the server is not restarted automatically. ''; diff --git a/nixos/modules/services/networking/networkd-dispatcher.nix b/nixos/modules/services/networking/networkd-dispatcher.nix index 49d5cd545656..13013a51d366 100644 --- a/nixos/modules/services/networking/networkd-dispatcher.nix +++ b/nixos/modules/services/networking/networkd-dispatcher.nix @@ -63,7 +63,7 @@ in default = null; description = '' List of names of the systemd-networkd operational states which - should trigger the script. See + should trigger the script. See {manpage}`networkctl(1)` for a description of the specific state type. ''; }; diff --git a/nixos/modules/services/web-servers/static-web-server.nix b/nixos/modules/services/web-servers/static-web-server.nix index 0db154167941..c999bb161f82 100644 --- a/nixos/modules/services/web-servers/static-web-server.nix +++ b/nixos/modules/services/web-servers/static-web-server.nix @@ -18,7 +18,7 @@ in default = "[::]:8787"; type = lib.types.str; description = '' - The "ListenStream" used in static-web-server.socket. + The {manpage}`systemd.socket(5)` "ListenStream" used in static-web-server.socket. This is equivalent to SWS's "host" and "port" options. See here for specific syntax: ''; diff --git a/nixos/modules/system/boot/systemd/journald.nix b/nixos/modules/system/boot/systemd/journald.nix index 97b72a6c97f5..c30630e04e4b 100644 --- a/nixos/modules/system/boot/systemd/journald.nix +++ b/nixos/modules/system/boot/systemd/journald.nix @@ -64,8 +64,7 @@ in Note that the effective rate limit is multiplied by a factor derived from the available free disk space for the journal as described on - [ - journald.conf(5)](https://www.freedesktop.org/software/systemd/man/journald.conf.html). + {manpage}`journald.conf(5)`. Note that the total amount of logs stored is limited by journald settings such as `SystemMaxUse`, which defaults to 10% the file system size diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix index 9f3b5fb9e546..80457e51d216 100644 --- a/nixos/modules/system/boot/systemd/logind.nix +++ b/nixos/modules/system/boot/systemd/logind.nix @@ -42,10 +42,10 @@ in when the user logs out. If true, the scope unit corresponding to the session and all processes inside that scope will be terminated. If false, the scope is "abandoned" - (see [systemd.scope(5)](https://www.freedesktop.org/software/systemd/man/systemd.scope.html#)), + (see {manpage}`systemd.scope(5)`), and processes are not killed. - See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=) + See {manpage}`logind.conf(5)` for more details. ''; }; diff --git a/nixos/modules/system/boot/systemd/repart.nix b/nixos/modules/system/boot/systemd/repart.nix index 283d3ca05245..869172ceca6e 100644 --- a/nixos/modules/system/boot/systemd/repart.nix +++ b/nixos/modules/system/boot/systemd/repart.nix @@ -109,8 +109,7 @@ in description = '' Specify partitions as a set of the names of the definition files as the key and the partition configuration as its value. The partition - configuration can use all upstream options. See + configuration can use all upstream options. See {manpage}`repart.d(5)` for all available options. ''; }; diff --git a/nixos/modules/system/boot/systemd/sysupdate.nix b/nixos/modules/system/boot/systemd/sysupdate.nix index dff4a6066ec0..4c71b1714954 100644 --- a/nixos/modules/system/boot/systemd/sysupdate.nix +++ b/nixos/modules/system/boot/systemd/sysupdate.nix @@ -24,9 +24,7 @@ in If enabled, updates are triggered in regular intervals via a `systemd.timer` unit. - Please see - - for more details. + Please see {manpage}`systemd-sysupdate(8)` for more details. ''; }; @@ -108,8 +106,7 @@ in description = '' Specify transfers as a set of the names of the transfer files as the key and the configuration as its value. The configuration can use all - upstream options. See - + upstream options. See {manpage}`sysupdate.d(5)` for all available options. ''; }; diff --git a/nixos/modules/system/boot/systemd/tmpfiles.nix b/nixos/modules/system/boot/systemd/tmpfiles.nix index 8e2166785e9f..1fbb5f2621f5 100644 --- a/nixos/modules/system/boot/systemd/tmpfiles.nix +++ b/nixos/modules/system/boot/systemd/tmpfiles.nix @@ -43,7 +43,7 @@ let Please see the upstream documentation for the available types and more details: - + {manpage}`tmpfiles.d(5)` ''; }; options.mode = mkOption { @@ -102,7 +102,7 @@ let Please see the upstream documentation for the meaning of this parameter in different situations: - + {manpage}`tmpfiles.d(5)` ''; }; })))); diff --git a/nixos/modules/system/boot/timesyncd.nix b/nixos/modules/system/boot/timesyncd.nix index b13b16f74de5..4a4e39c07e41 100644 --- a/nixos/modules/system/boot/timesyncd.nix +++ b/nixos/modules/system/boot/timesyncd.nix @@ -53,8 +53,7 @@ in ''; description = '' Extra config options for systemd-timesyncd. See - [ - timesyncd.conf(5)](https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html) for available options. + {manpage}`timesyncd.conf(5)` for available options. ''; }; };