Changes between Version 3 and Version 4 of MovedToGitHub/ConfigurationParameters


Ignore:
Timestamp:
Jan 22, 2010, 1:51:06 PM (12 years ago)
Author:
kim
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MovedToGitHub/ConfigurationParameters

    v3 v4  
    11Refer to [EditingConfigurationParameters Editing Configuration Parameters] for details on setting these parameters.
    2 Note: this page does not include old legacy parameters.
     2Note: this page does not include legacy parameters.[[BR]]
     3For a general overview of the Bit Torrent protocol start at [http://en.wikipedia.org/wiki/BitTorrent_(protocol) Wikipedia: Bit Torrent Protocol] [[BR]]
     4It is strongly recommended that parameters not well understood be left at their default values.
    35
    4 == '''Advanced''' ==
     6= Common Parameters =
     7The following are common to all current versions of Transmission.
     8
     9== Directories ==
    510|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    6 || '''dht-enabled''' || Boolean || true || ||
    7 || '''encryption''' || Number || 1 || 0 = Off, 1 = Preferred, 2 = Forced ||
    8 || '''lazy-bitfield-enabled''' || Boolean || true || ||
    9 || '''open-file-limit''' || Number || 32 || ||
    10 || '''peer-socket-tos''' || Number || 0 || ||
    11 || '''pex-enabled''' || Boolean ||  true || ||
    12 || '''rename-partial-files''' || Boolean || true || Sets wether default Transmission should postfix partially downloaded files with ".part" ||
    13 || '''preallocation''' || Number || 1 || 0 = Off, 1 = Fast, 2 = Full (slower but reduces disk fragmentation) ||
    14 || '''umask''' || Number || 18 || Sets transmission's file mode creation mask.  See [http://developer.apple.com/documentation/Darwin/Reference/ManPages/man2/umask.2.html the umask(2) manpage] for more information.  Users who want their saved torrents to be world-writable may want to set this value to 0.  Bear in mind that the json markup language only accepts numbers in base 10, so the standard umask(2) octal notation "022" is written in settings.json as 18. ||
     11|| '''download-dir''' || String || ''default locations'' || ||
     12|| '''watch-dir''' || String || || Directory to watch for new .torrent files to autoload ||
     13|| '''watch-dir-enabled''' || Boolean || false || Enables directory watching and autoload ||
    1514
    16 == '''Bandwidth''' ==
     15== Bandwidth ==
    1716|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    18 || '''speed-limit-down''' || Number (KB/s) || 100 || ||
    19 || '''speed-limit-down-enabled''' || Boolean || false || ||
    20 || '''speed-limit-up''' || Number (KB/s) || 100 || ||
    21 || '''speed-limit-up-enabled''' || Boolean || false || ||
    22 || '''alt-speed-enabled''' || Boolean || false || aka 'Turtle Mode'. ''Clicking the "Turtle" in the gui when the [wiki:EditConfigFiles#Scheduling scheduler] is enabled, will only temporarily remove the scheduled limit until the next cycle.''||
    23 || '''alt-speed-up''' || Number (KB/s) || 50 || ||
    24 || '''alt-speed-down''' || Number (KB/s) || 50 || ||
     17|| '''speed-limit-down''' || Number (KB/s) || 100 || Standard download speed limit (used if enabled) ||
     18|| '''speed-limit-down-enabled''' || Boolean || false || Flag to enable the use of '''speed-limit-down''' ||
     19|| '''speed-limit-up''' || Number (KB/s) || 100 || Standard upload speed limit (used if enabled). May need to be set for best performance||
     20|| '''speed-limit-up-enabled''' || Boolean || false || Flag to enable the use of '''speed-limit-up''' ||
     21|| '''alt-speed-enabled''' || Boolean || false || Enable alternate Speed limits (aka 'Turtle Mode'). Manual "Turtle" mode changes in the gui when the [wiki:EditConfigFiles#Scheduling scheduler] is enabled, will be reset at the next scheduled speed change.||
     22|| '''alt-speed-up''' || Number (KB/s) || 50 || Alternate upload speed limit ||
     23|| '''alt-speed-down''' || Number (KB/s) || 50 || Alternate download speed limit ||
    2524
    2625== Scheduling ==
    2726|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    28 || '''ratio-limit'''||  Number || 2.0 ||
    29 || '''ratio-limit-enabled''' || Boolean || false ||
     27|| '''ratio-limit'''||  Number || 2.0 || Ratio of uploads:downloads for a torrent before torrent is deemed complete.[[BR]]Ratio should be at least 1.0 for normal use, 2.0 is considered 'good' ||
     28|| '''ratio-limit-enabled''' || Boolean || false || By default torrents will seed forever (ie Ratio -> infinity) ||
    3029|| '''alt-speed-time-enabled''' || Boolean || false || ''Note: When enabled, this will toggle the '''alt-speed-enabled''' setting.'' ||
    3130|| '''alt-speed-time-begin''' || Number || 540 ==9am || Minutes from midnight ||
     
    4544    * '''All Days''': 127 (binary: {{{1111111}}}) ||
    4645
    47 == Misc ==
     46== Peer Management ==
    4847|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    49 || '''blocklist-enabled''' || Boolean || false || ||
     48|| '''peer-limit-global''' ||  Number || 240 || Maximum number of connected peers ||
     49|| '''peer-limit-per-torrent''' ||  Number || 60 || Maximum number of connected peers for an individual torrent ||
     50|| '''blocklist-enabled''' || Boolean || false || Blocks specified remote peers (via IP address). Refer [Blocklists] ||
     51|| '''dht-enabled''' || Boolean || true || Enable Bit Torrent Distributed Hash Table (DHT) operation[[BR]](see http://en.wikipedia.org/wiki/Distributed_hash_table Wikipedia:DHT)||
     52|| '''encryption''' || Number || 1 || Specify encryption mode for Peers: 0 = Off, 1 = Preferred, 2 = Forced ||
     53|| '''peer-socket-tos''' || Number || 0 || ||
     54|| '''pex-enabled''' || Boolean ||  true || Enable Bit Torrent Peer EXchange[[BR]] (see http://en.wikipedia.org/wiki/Peer_exchange Wikipedia:PEX)||
    5055
    51 == Directories ==
     56== Bit Torrent Peer Ports ==
    5257|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    53 || '''download-dir''' || String || ''default locations'' || ||
    54 || '''watch-dir''' || String || || ||
    55 || '''watch-dir-enabled''' || Boolean || false || Note: When watch-dir-enabled is true, only the transmission-daemon, transmission-gtk, and transmission-qt applications will monitor watch-dir for new .torrent files and automatically load them. ||
    56 
    57 == Peers ==
    58 || ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    59 || '''peer-limit-global''' ||  Number || 240 || ||
    60 || '''peer-limit-per-torrent''' ||  Number || 60 ||
    61 
    62 == Bit Torrent (Peer) Ports ==
    63 || ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    64 || '''peer-port''' || Number || 51413 || ||
    65 || '''peer-port-random-enabled''' || Boolean || false || ||
    66 || '''peer-port-random-high''' || Number || 65535 || ||
    67 || '''peer-port-random-low''' || Number || 1024 || ||
    68 || '''port-forwarding-enabled''' ||  Boolean || || ||
     58|| '''peer-port''' || Number || 51413 || Port to listen on for incoming Peer connections||
     59|| '''peer-port-random-enabled''' || Boolean || false || If true then assign a random '''peer-port''' between the '''-low''' and '''-high''' values. ||
     60|| '''peer-port-random-low''' || Number || 1024 || Lowest permitted value for a randomly assigned '''peer-port''' ||
     61|| '''peer-port-random-high''' || Number || 65535 ||  Highest permitted value for a randomly assigned '''peer-port'''||
     62|| '''port-forwarding-enabled''' ||  Boolean || true || Enable uPnP and XXX protocols to try and negotiate opening of selected '''peer-port''' with firewalls that support such negotiation. Security conscious or advanced users may want to disable this feature. ||
    6963
    7064== Proxy ==
    7165|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    72 || '''proxy''' || String || || ||
    73 || '''proxy-enabled''' || Boolean || false || ||
    74 || '''proxy-auth-enabled''' || Boolean || false || ||
    75 || '''proxy-auth-username''' ||  String || || ||
    76 || '''proxy-auth-password''' || String || || ||
    77 || '''proxy-port''' ||  Number || 80 || ||
    78 || '''proxy-type''' || Number || 0 ||  (0 = HTTP, 1 = SOCKS4, 2 = SOCKS5, default = 0) ||
     66|| '''proxy''' || String || || URL of proxy server ||
     67|| '''proxy-enabled''' || Boolean || false || If true operate through the proxy server with the specified settings ||
     68|| '''proxy-auth-enabled''' || Boolean || false || Enable use of proxy authentication (ie username/password) ||
     69|| '''proxy-auth-username''' ||  String || || Username for proxy access ||
     70|| '''proxy-auth-password''' || String || || Password for proxy access ||
     71|| '''proxy-port''' ||  Number || 80 || Port on which to contact the proxy server ||
     72|| '''proxy-type''' || Number || 0 ||  Type of proxy connection: (0 = HTTP, 1 = SOCKS4, 2 = SOCKS5) ||
    7973
    80 == [wiki:rpc JSON RPC Protocol] ==
     74== Remote Control ==
    8175|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
    82 ||'''rpc-authentication-required''' || Boolean || (default = false) || ''If set, then a username and password will be required to access the rpc services.'' ||
    83 || '''rpc-enabled''' || Boolean  || true|| ''If set, then rpc services are enabled.'' ||
    84 || '''rpc-password''' || String || - || ''The ssha1 encrypted password (starts with a '{') to access the rpc services. A new password can be entered in plain text and will replaced with the encrypted version when the configuration file is next saved.'' ||
    85 || '''rpc-port''' || Number || 9091 || ''The port Transmission listens for rpc services on.'' ||
    86 || '''rpc-username''' || String || || ''The username to access the rpc services.'' ||
    87 || '''rpc-whitelist''' || String || "127.0.0.1" || ''Comma-delimited list of IP addresses. Wildcards allowed using '*'. Example: "127.0.0.*,192.168.*.*".'' ||
    88 || '''rpc-whitelist-enabled''' || Boolean || true || ''If set, then the whitelist is used to prevent other IP addresses from accessing Transmission.'' ||
    89  
     76|| '''rpc-enabled''' || Boolean  || true|| Enables remote control services ||
     77||'''rpc-authentication-required''' || Boolean || false || If set, then a username and password are required to access the remote control services ||
     78|| '''rpc-password''' || String || - || The ssha1 encrypted password (starts with a '{') needed for remote access.[[BR]]A new password can be entered via command line utilities or directly in plain text and will replaced with the encrypted version when the configuration file is next saved. ||
     79|| '''rpc-port''' || Number || 9091 || The port Transmission listens on for remote services ||
     80|| '''rpc-username''' || String || ||  The username required to access remote services when '''rpc-authentication-required''' is enabled ||
     81|| '''rpc-whitelist''' || String || "127.0.0.1" || Comma-delimited list of IP addresses from which remote control is permitted.[[BR]]Wildcards are allowed using '*'. Example: "127.0.0.*,192.168.*.*". ||
     82|| '''rpc-whitelist-enabled''' || Boolean || true || If enabled use '''rpc-whitelist'''. Other IP addresses will be denied remote access ||
     83
     84
     85== Advanced ==
     86|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
     87|| '''lazy-bitfield-enabled''' || Boolean || true || ||
     88|| '''open-file-limit''' || Number || 32 || Maximum number of open files XXXX ||
     89|| '''rename-partial-files''' || Boolean || true || If enabled partially downloaded files are appended with ".part" ||
     90|| '''preallocation''' || Number || 1 || 0 = Off, 1 = Fast, 2 = Full (slower but reduces disk fragmentation) ||
     91|| '''umask''' || Number || 18 || Sets transmission's file mode creation mask.  See [http://developer.apple.com/documentation/Darwin/Reference/ManPages/man2/umask.2.html the umask(2) manpage].  For world-writable torrents set umask to 0.[[BR]] Note: JSON only accepts base 10 numbers, so convert standard octal umask to base 10, "022" is thus written as 18. ||
     92
     93
     94== Experimental ==
     95Only available in the the latest developer versions and subject to change/breakage.
     96
     97|| ''Option'' || ''Kind'' || ''Default Value'' || ''Description'' ||
     98|| '''SUFeedURL''' ||  URI || ||      example value: http://transmission.xpjets.com/ZIP/ ||
     99= Flavor Specific Parameters =
     100
     101== Linux/GTK+ Only ==
     102...