nixos/doc: convert links to manpages

Changed files
+17 -23
nixos
+1 -1
nixos/modules/image/repart.nix
···
};
description = ''
Specify the repart options for a partiton as a structural setting.
-
See <https://www.freedesktop.org/software/systemd/man/repart.d.html>
for all available options.
'';
};
···
};
description = ''
Specify the repart options for a partiton as a structural setting.
+
See {manpage}`repart.d(5)`
for all available options.
'';
};
+4 -4
nixos/modules/misc/version.nix
···
description = ''
Image identifier.
-
This corresponds to the IMAGE_ID field in os-release. 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.
'';
···
description = ''
Image version.
-
This corresponds to the IMAGE_VERSION field in os-release. 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.
'';
···
description = ''
Image identifier.
+
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.
'';
···
description = ''
Image version.
+
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.
'';
+1 -1
nixos/modules/services/games/mchprs.nix
···
description = ''
Automatically restart the server after
{option}`services.mchprs.maxRuntime`.
-
The time span format is described here:
<https://www.freedesktop.org/software/systemd/man/systemd.time.html#Parsing%20Time%20Spans>.
If `null`, then the server is not restarted automatically.
'';
···
description = ''
Automatically restart the server after
{option}`services.mchprs.maxRuntime`.
+
The {manpage}`systemd.time(7)` time span format is described here:
<https://www.freedesktop.org/software/systemd/man/systemd.time.html#Parsing%20Time%20Spans>.
If `null`, then the server is not restarted automatically.
'';
+1 -1
nixos/modules/services/networking/networkd-dispatcher.nix
···
default = null;
description = ''
List of names of the systemd-networkd operational states which
-
should trigger the script. See <https://www.freedesktop.org/software/systemd/man/networkctl.html>
for a description of the specific state type.
'';
};
···
default = null;
description = ''
List of names of the systemd-networkd operational states which
+
should trigger the script. See {manpage}`networkctl(1)`
for a description of the specific state type.
'';
};
+1 -1
nixos/modules/services/web-servers/static-web-server.nix
···
default = "[::]:8787";
type = lib.types.str;
description = ''
-
The "ListenStream" used in static-web-server.socket.
This is equivalent to SWS's "host" and "port" options.
See here for specific syntax: <https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=>
'';
···
default = "[::]:8787";
type = lib.types.str;
description = ''
+
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: <https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=>
'';
+1 -2
nixos/modules/system/boot/systemd/journald.nix
···
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).
Note that the total amount of logs stored is limited by journald settings
such as `SystemMaxUse`, which defaults to 10% the file system size
···
Note that the effective rate limit is multiplied by a factor derived
from the available free disk space for the journal as described on
+
{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
+2 -2
nixos/modules/system/boot/systemd/logind.nix
···
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#)),
and processes are not killed.
-
See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=)
for more details.
'';
};
···
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 {manpage}`systemd.scope(5)`),
and processes are not killed.
+
See {manpage}`logind.conf(5)`
for more details.
'';
};
+1 -2
nixos/modules/system/boot/systemd/repart.nix
···
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 <link
-
xlink:href="https://www.freedesktop.org/software/systemd/man/repart.d.html"/>
for all available options.
'';
};
···
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 {manpage}`repart.d(5)`
for all available options.
'';
};
+2 -5
nixos/modules/system/boot/systemd/sysupdate.nix
···
If enabled, updates are triggered in regular intervals via a
`systemd.timer` unit.
-
Please see
-
<https://www.freedesktop.org/software/systemd/man/systemd-sysupdate.html>
-
for more details.
'';
};
···
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
-
<https://www.freedesktop.org/software/systemd/man/sysupdate.d.html>
for all available options.
'';
};
···
If enabled, updates are triggered in regular intervals via a
`systemd.timer` unit.
+
Please see {manpage}`systemd-sysupdate(8)` for more details.
'';
};
···
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 {manpage}`sysupdate.d(5)`
for all available options.
'';
};
+2 -2
nixos/modules/system/boot/systemd/tmpfiles.nix
···
Please see the upstream documentation for the available types and
more details:
-
<https://www.freedesktop.org/software/systemd/man/tmpfiles.d>
'';
};
options.mode = mkOption {
···
Please see the upstream documentation for the meaning of this
parameter in different situations:
-
<https://www.freedesktop.org/software/systemd/man/tmpfiles.d>
'';
};
}))));
···
Please see the upstream documentation for the available types and
more details:
+
{manpage}`tmpfiles.d(5)`
'';
};
options.mode = mkOption {
···
Please see the upstream documentation for the meaning of this
parameter in different situations:
+
{manpage}`tmpfiles.d(5)`
'';
};
}))));
+1 -2
nixos/modules/system/boot/timesyncd.nix
···
'';
description = ''
Extra config options for systemd-timesyncd. See
-
[
-
timesyncd.conf(5)](https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html) for available options.
'';
};
};
···
'';
description = ''
Extra config options for systemd-timesyncd. See
+
{manpage}`timesyncd.conf(5)` for available options.
'';
};
};