diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/network-filesystems/nfsd.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/network-filesystems/nfsd.nix | 30 |
1 files changed, 14 insertions, 16 deletions
diff --git a/nixpkgs/nixos/modules/services/network-filesystems/nfsd.nix b/nixpkgs/nixos/modules/services/network-filesystems/nfsd.nix index 1b62bfa82035..c9e1cbcbbda4 100644 --- a/nixpkgs/nixos/modules/services/network-filesystems/nfsd.nix +++ b/nixpkgs/nixos/modules/services/network-filesystems/nfsd.nix @@ -26,7 +26,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the kernel's NFS server. ''; }; @@ -34,7 +34,7 @@ in extraNfsdConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options for the [nfsd] section of /etc/nfs.conf. ''; }; @@ -42,28 +42,26 @@ in exports = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Contents of the /etc/exports file. See - <citerefentry><refentrytitle>exports</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> for the format. + {manpage}`exports(5)` for the format. ''; }; hostName = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Hostname or address on which NFS requests will be accepted. - Default is all. See the <option>-H</option> option in - <citerefentry><refentrytitle>nfsd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry>. + Default is all. See the {option}`-H` option in + {manpage}`nfsd(8)`. ''; }; nproc = mkOption { type = types.int; default = 8; - description = '' + description = lib.mdDoc '' Number of NFS server threads. Defaults to the recommended value of 8. ''; }; @@ -71,14 +69,14 @@ in createMountPoints = mkOption { type = types.bool; default = false; - description = "Whether to create the mount points in the exports file at startup time."; + description = lib.mdDoc "Whether to create the mount points in the exports file at startup time."; }; mountdPort = mkOption { type = types.nullOr types.int; default = null; example = 4002; - description = '' + description = lib.mdDoc '' Use fixed port for rpc.mountd, useful if server is behind firewall. ''; }; @@ -87,9 +85,9 @@ in type = types.nullOr types.int; default = null; example = 4001; - description = '' + description = lib.mdDoc '' Use a fixed port for the NFS lock manager kernel module - (<literal>lockd/nlockmgr</literal>). This is useful if the + (`lockd/nlockmgr`). This is useful if the NFS server is behind a firewall. ''; }; @@ -98,8 +96,8 @@ in type = types.nullOr types.int; default = null; example = 4000; - description = '' - Use a fixed port for <command>rpc.statd</command>. This is + description = lib.mdDoc '' + Use a fixed port for {command}`rpc.statd`. This is useful if the NFS server is behind a firewall. ''; }; |