diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/torrent/transmission.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/torrent/transmission.nix | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/nixpkgs/nixos/modules/services/torrent/transmission.nix b/nixpkgs/nixos/modules/services/torrent/transmission.nix index a9fb123b981e..52b472631dcf 100644 --- a/nixpkgs/nixos/modules/services/torrent/transmission.nix +++ b/nixpkgs/nixos/modules/services/torrent/transmission.nix @@ -24,8 +24,8 @@ in ]; options = { services.transmission = { - enable = mkEnableOption (lib.mdDoc "transmission") // { - description = lib.mdDoc '' + enable = mkEnableOption "transmission" // { + description = '' Whether to enable the headless Transmission BitTorrent daemon. Transmission daemon can be controlled via the RPC interface using @@ -38,7 +38,7 @@ in }; settings = mkOption { - description = lib.mdDoc '' + description = '' Settings whose options overwrite fields in `.config/transmission-daemon/settings.json` (each time the service starts). @@ -53,13 +53,13 @@ in type = types.path; default = "${cfg.home}/${downloadsDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${downloadsDir}"''; - description = lib.mdDoc "Directory where to download torrents."; + description = "Directory where to download torrents."; }; options.incomplete-dir = mkOption { type = types.path; default = "${cfg.home}/${incompleteDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${incompleteDir}"''; - description = lib.mdDoc '' + description = '' When enabled with services.transmission.home [](#opt-services.transmission.settings.incomplete-dir-enabled), @@ -71,22 +71,22 @@ in options.incomplete-dir-enabled = mkOption { type = types.bool; default = true; - description = lib.mdDoc ""; + description = ""; }; options.message-level = mkOption { type = types.ints.between 0 6; default = 2; - description = lib.mdDoc "Set verbosity of transmission messages."; + description = "Set verbosity of transmission messages."; }; options.peer-port = mkOption { type = types.port; default = 51413; - description = lib.mdDoc "The peer port to listen for incoming connections."; + description = "The peer port to listen for incoming connections."; }; options.peer-port-random-high = mkOption { type = types.port; default = 65535; - description = lib.mdDoc '' + description = '' The maximum peer port to listen to for incoming connections when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled. ''; @@ -94,7 +94,7 @@ in options.peer-port-random-low = mkOption { type = types.port; default = 65535; - description = lib.mdDoc '' + description = '' The minimal peer port to listen to for incoming connections when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled. ''; @@ -102,13 +102,13 @@ in options.peer-port-random-on-start = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Randomize the peer port."; + description = "Randomize the peer port."; }; options.rpc-bind-address = mkOption { type = types.str; default = "127.0.0.1"; example = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Where to listen for RPC connections. Use `0.0.0.0` to listen on all interfaces. ''; @@ -116,12 +116,12 @@ in options.rpc-port = mkOption { type = types.port; default = 9091; - description = lib.mdDoc "The RPC port to listen to."; + description = "The RPC port to listen to."; }; options.script-torrent-done-enabled = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to run [](#opt-services.transmission.settings.script-torrent-done-filename) at torrent completion. @@ -130,12 +130,12 @@ in options.script-torrent-done-filename = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc "Executable to be run at torrent completion."; + description = "Executable to be run at torrent completion."; }; options.umask = mkOption { type = types.int; default = 2; - description = lib.mdDoc '' + description = '' Sets transmission's file mode creation mask. See the umask(2) manpage for more information. Users who want their saved torrents to be world-writable @@ -147,7 +147,7 @@ in options.utp-enabled = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable [Micro Transport Protocol (µTP)](https://en.wikipedia.org/wiki/Micro_Transport_Protocol). ''; }; @@ -155,19 +155,19 @@ in type = types.path; default = "${cfg.home}/${watchDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${watchDir}"''; - description = lib.mdDoc "Watch a directory for torrent files and add them to transmission."; + description = "Watch a directory for torrent files and add them to transmission."; }; options.watch-dir-enabled = mkOption { type = types.bool; default = false; - description = lib.mdDoc ''Whether to enable the + description = ''Whether to enable the [](#opt-services.transmission.settings.watch-dir). ''; }; options.trash-original-torrent-files = mkOption { type = types.bool; default = false; - description = lib.mdDoc ''Whether to delete torrents added from the + description = ''Whether to delete torrents added from the [](#opt-services.transmission.settings.watch-dir). ''; }; @@ -180,7 +180,7 @@ in type = with types; nullOr str; default = null; example = "770"; - description = lib.mdDoc '' + description = '' If not `null`, is used as the permissions set by `system.activationScripts.transmission-daemon` on the directories [](#opt-services.transmission.settings.download-dir), @@ -194,7 +194,7 @@ in home = mkOption { type = types.path; default = "/var/lib/transmission"; - description = lib.mdDoc '' + description = '' The directory where Transmission will create `${settingsDir}`. as well as `${downloadsDir}/` unless [](#opt-services.transmission.settings.download-dir) is changed, @@ -206,18 +206,18 @@ in user = mkOption { type = types.str; default = "transmission"; - description = lib.mdDoc "User account under which Transmission runs."; + description = "User account under which Transmission runs."; }; group = mkOption { type = types.str; default = "transmission"; - description = lib.mdDoc "Group account under which Transmission runs."; + description = "Group account under which Transmission runs."; }; credentialsFile = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Path to a JSON file to be merged with the settings. Useful to merge a file which is better kept out of the Nix store to set secret config parameters like `rpc-password`. @@ -230,17 +230,17 @@ in type = types.listOf types.str; default = []; example = [ "--log-debug" ]; - description = lib.mdDoc '' + description = '' Extra flags passed to the transmission command in the service definition. ''; }; - openPeerPorts = mkEnableOption (lib.mdDoc "opening of the peer port(s) in the firewall"); + openPeerPorts = mkEnableOption "opening of the peer port(s) in the firewall"; - openRPCPort = mkEnableOption (lib.mdDoc "opening of the RPC port in the firewall"); + openRPCPort = mkEnableOption "opening of the RPC port in the firewall"; - performanceNetParameters = mkEnableOption (lib.mdDoc "performance tweaks") // { - description = lib.mdDoc '' + performanceNetParameters = mkEnableOption "performance tweaks" // { + description = '' Whether to enable tweaking of kernel parameters to open many more connections at the same time. @@ -256,7 +256,7 @@ in type = types.nullOr types.path; default = null; example = "pkgs.flood-for-transmission"; - description = lib.mdDoc '' + description = '' If not `null`, sets the value of the `TRANSMISSION_WEB_HOME` environment variable used by the service. Useful for overriding the web interface files, without overriding the transmission |