diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/misc/mediatomb.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/misc/mediatomb.nix | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/nixpkgs/nixos/modules/services/misc/mediatomb.nix b/nixpkgs/nixos/modules/services/misc/mediatomb.nix index ee5c0ef8d277..8cac87f53266 100644 --- a/nixpkgs/nixos/modules/services/misc/mediatomb.nix +++ b/nixpkgs/nixos/modules/services/misc/mediatomb.nix @@ -15,19 +15,19 @@ let options = { path = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Absolute directory path to the media directory to index. ''; }; recursive = mkOption { type = types.bool; default = false; - description = "Whether the indexation must take place recursively or not."; + description = lib.mdDoc "Whether the indexation must take place recursively or not."; }; hidden-files = mkOption { type = types.bool; default = true; - description = "Whether to index the hidden files or not."; + description = lib.mdDoc "Whether to index the hidden files or not."; }; }; }; @@ -202,7 +202,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Gerbera/Mediatomb DLNA server. ''; }; @@ -210,7 +210,7 @@ in { serverName = mkOption { type = types.str; default = "Gerbera (Mediatomb)"; - description = '' + description = lib.mdDoc '' How to identify the server on the network. ''; }; @@ -219,7 +219,7 @@ in { type = types.package; default = pkgs.gerbera; defaultText = literalExpression "pkgs.gerbera"; - description = '' + description = lib.mdDoc '' Underlying package to be used with the module. ''; }; @@ -227,7 +227,7 @@ in { ps3Support = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable ps3 specific tweaks. WARNING: incompatible with DSM 320 support. ''; @@ -236,7 +236,7 @@ in { dsmSupport = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable D-Link DSM 320 specific tweaks. WARNING: incompatible with ps3 support. ''; @@ -245,7 +245,7 @@ in { tg100Support = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Telegent TG100 specific tweaks. ''; }; @@ -253,7 +253,7 @@ in { transcoding = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable transcoding. ''; }; @@ -262,7 +262,7 @@ in { type = types.path; default = "/var/lib/${name}"; defaultText = literalExpression ''"/var/lib/''${config.${opt.package}.pname}"''; - description = '' + description = lib.mdDoc '' The directory where Gerbera/Mediatomb stores its state, data, etc. ''; }; @@ -270,7 +270,7 @@ in { pcDirectoryHide = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to list the top-level directory or not (from upnp client standpoint). ''; }; @@ -278,19 +278,19 @@ in { user = mkOption { type = types.str; default = "mediatomb"; - description = "User account under which the service runs."; + description = lib.mdDoc "User account under which the service runs."; }; group = mkOption { type = types.str; default = "mediatomb"; - description = "Group account under which the service runs."; + description = lib.mdDoc "Group account under which the service runs."; }; port = mkOption { type = types.int; default = 49152; - description = '' + description = lib.mdDoc '' The network port to listen on. ''; }; @@ -298,7 +298,7 @@ in { interface = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' A specific interface to bind to. ''; }; @@ -306,12 +306,12 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If false (the default), this is up to the user to declare the firewall rules. If true, this opens port 1900 (tcp and udp) and the port specified by - <option>sercvices.mediatomb.port</option>. + {option}`sercvices.mediatomb.port`. - If the option <option>services.mediatomb.interface</option> is set, + If the option {option}`services.mediatomb.interface` is set, the firewall rules opened are dedicated to that interface. Otherwise, those rules are opened globally. ''; @@ -320,7 +320,7 @@ in { uuid = mkOption { type = types.str; default = "fdfc8a4e-a3ad-4c1d-b43d-a2eedb03a687"; - description = '' + description = lib.mdDoc '' A unique (on your network) to identify the server by. ''; }; @@ -328,7 +328,7 @@ in { mediaDirectories = mkOption { type = with types; listOf (submodule mediaDirectory); default = []; - description = '' + description = lib.mdDoc '' Declare media directories to index. ''; example = [ @@ -340,12 +340,12 @@ in { customCfg = mkOption { type = types.bool; default = false; - description = '' - Allow the service to create and use its own config file inside the <literal>dataDir</literal> as - configured by <option>services.mediatomb.dataDir</option>. + description = lib.mdDoc '' + Allow the service to create and use its own config file inside the `dataDir` as + configured by {option}`services.mediatomb.dataDir`. Deactivated by default, the service then runs with the configuration generated from this module. Otherwise, when enabled, no service configuration is generated. Gerbera/Mediatomb then starts using - config.xml within the configured <literal>dataDir</literal>. It's up to the user to make a correct + config.xml within the configured `dataDir`. It's up to the user to make a correct configuration file. ''; }; |