docs: convert some wiki markup to markdown (#2692)
This commit is contained in:
Charles Kerr
GitHub
parent
a0c25b21af
commit
f7d74095ed
|
|
@ -12,13 +12,13 @@ When you press the "Update Blocklist" button, Transmission will download a new c
|
|||
|
||||
## Adding Other Blocklists ##
|
||||
|
||||
Transmission stores blocklists in a folder named `blocklists` in its [[configuration folder|ConfigFiles]].
|
||||
Transmission stores blocklists in a folder named `blocklists` in its [configuration folder](Configuration-Files.md).
|
||||
|
||||
In that directory, files ending in ".bin" are blocklists that Transmission has parsed into a binary format suitable for quick lookups. When transmission starts, it scans this directory for files not ending in ".bin" and tries to parse them. So to add another blocklist, all you have to do is put it in this directory and restart Transmission. Text and gzip formats are supported.
|
||||
|
||||
## Using Blocklists in transmission-daemon ##
|
||||
|
||||
transmission-daemon doesn't have an "update blocklist" button, so its users have two options. They can either copy blocklists from transmission-gtk's directory to transmission-daemon's directory, or they can download a blocklist by hand, uncompress it, and place it in the daemon's `blocklists` folder. In both cases, the daemon's [[settings.json file|ConfigFiles]] will need to be edited to set "blocklist-enabled" to "true".
|
||||
transmission-daemon doesn't have an "update blocklist" button, so its users have two options. They can either copy blocklists from transmission-gtk's directory to transmission-daemon's directory, or they can download a blocklist by hand, uncompress it, and place it in the daemon's `blocklists` folder. In both cases, the daemon's [settings.json file](Configuration-Files.md) will need to be edited to set "blocklist-enabled" to "true".
|
||||
|
||||
Also in both cases, the daemon is unaware of blocklist updates. Only when it starts it creates new .bin files.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ If you're having trouble with Transmission then the things you should do in orde
|
|||
## Information Required in a Bug Report ##
|
||||
|
||||
* State the version of Transmission you're using (eg Linux/GTK+ 1.80).
|
||||
If you're using a GUI version of Transmission, you can find its version in the `About' dialog in the Help menu.
|
||||
If you're using a GUI version of Transmission, you can find its version in the `About` dialog in the Help menu.
|
||||
**Don't** say _the latest version_ it's ambiguous.
|
||||
* State what operating system and version (eg Mac OS X 10.5.8, Ubuntu 8.04, ...)
|
||||
* Describe the symptoms in a short precise manner.
|
||||
|
|
@ -60,22 +60,24 @@ If these two pieces of information above are too large for your forum post, Past
|
|||
|
||||
### Port Mapping Error ###
|
||||
|
||||
Read the [[Port Forwarding Guide|PortForwardingGuide]] first.
|
||||
Read the [Port Forwarding Guide](Port-Forwarding-Guide.md) first.
|
||||
You then need to include:
|
||||
* what router you're using
|
||||
* that you've confirmed that either UPnP or NAT-PMP is enabled on it
|
||||
* If you're using a custom firmware, tell us which one
|
||||
* Most importantly, post the lines from the Message Log that contain the phrase "Port Mapping". They will look something like this:
|
||||
|
||||
02:12:27 Port Mapping (NAT-PMP): initnatpmp returned success (0)
|
||||
02:12:27 Port Mapping (NAT-PMP): sendpublicaddressrequest returned success (2)
|
||||
02:12:27 Port Mapping: mapping state changed from 'not mapped' to 'mapping'
|
||||
02:12:27 Port Mapping: opened port 55555 to listen for incoming peer connections
|
||||
02:12:35 Port Mapping (NAT-PMP): readnatpmpresponseorretry returned error -7, errno is 111 (Connection refused)
|
||||
02:12:35 Port Mapping (NAT-PMP): If your router supports NAT-PMP, please make sure NAT-PMP is enabled!
|
||||
02:12:35 Port Mapping (NAT-PMP): NAT-PMP port forwarding unsuccessful, trying UPnP next
|
||||
02:12:37 Port Mapping (UPNP): Found Internet Gateway Device 'http://192.168.1.1:5431/uuid:0012-17c3-4e400200b4b4/WANIPConnection:1'
|
||||
02:12:37 Port Mapping (UPNP): Local LAN IP Address is '192.168.1.99'
|
||||
02:12:37 Port Mapping (UPNP): Port forwarding via 'http://192.168.1.1:5431/uuid:0012-17c3-4e400200b4b4/WANIPConnection:1', service 'urn:schemas-upnp-org:service:WANIPConnection:1'. (local address: 192.168.1.99:55555)
|
||||
02:12:37 Port Mapping (UPNP): Port forwarding successful!
|
||||
02:12:37 Port Mapping: mapping state changed from 'mapping' to 'mapped'
|
||||
```
|
||||
02:12:27 Port Mapping (NAT-PMP): initnatpmp returned success (0)
|
||||
02:12:27 Port Mapping (NAT-PMP): sendpublicaddressrequest returned success (2)
|
||||
02:12:27 Port Mapping: mapping state changed from 'not mapped' to 'mapping'
|
||||
02:12:27 Port Mapping: opened port 55555 to listen for incoming peer connections
|
||||
02:12:35 Port Mapping (NAT-PMP): readnatpmpresponseorretry returned error -7, errno is 111 (Connection refused)
|
||||
02:12:35 Port Mapping (NAT-PMP): If your router supports NAT-PMP, please make sure NAT-PMP is enabled!
|
||||
02:12:35 Port Mapping (NAT-PMP): NAT-PMP port forwarding unsuccessful, trying UPnP next
|
||||
02:12:37 Port Mapping (UPNP): Found Internet Gateway Device 'http://192.168.1.1:5431/uuid:0012-17c3-4e400200b4b4/WANIPConnection:1'
|
||||
02:12:37 Port Mapping (UPNP): Local LAN IP Address is '192.168.1.99'
|
||||
02:12:37 Port Mapping (UPNP): Port forwarding via 'http://192.168.1.1:5431/uuid:0012-17c3-4e400200b4b4/WANIPConnection:1', service 'urn:schemas-upnp-org:service:WANIPConnection:1'. (local address: 192.168.1.99:55555)
|
||||
02:12:37 Port Mapping (UPNP): Port forwarding successful!
|
||||
02:12:37 Port Mapping: mapping state changed from 'mapping' to 'mapped'
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,14 +1,6 @@
|
|||
If you are searching for a HOWTO, covering a specific distribution or device (NAS, router, ...), have a look at the [[Running Transmission on a headless machine|HeadlessUsage]] page
|
||||
|
||||
## Getting the Source ##
|
||||
|
||||
#### Recommended ####
|
||||
|
||||
Source code for official releases can be found on our [download page](https://transmissionbt.com/download/).
|
||||
|
||||
#### Experimental ####
|
||||
|
||||
Automated source code tarballs including the newest code [are now available, too!](https://build.transmissionbt.com/job/trunk-linux/)
|
||||
Source code for both official and nightly releases can be found on our [download page](https://transmissionbt.com/download/).
|
||||
|
||||
## On Mac OS X ##
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ If you want to swap between the two applications, all you have to do is pass in
|
|||
|
||||
### Overriding the Defaults
|
||||
|
||||
The per-user configuration folder's location can be overridden by setting `TRANSMISSION_HOME` and/or other [[environment variables|Environment-Variables]].
|
||||
The per-user configuration folder's location can be overridden by setting `TRANSMISSION_HOME` and/or other [environment variables](Environment-Variables.md).
|
||||
|
||||
## Files
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ The configuration folder typically has the following files:
|
|||
|
||||
### settings.json
|
||||
|
||||
This is a json-encoded file that holds all the client's settings and preferences. It's currently only used by the daemon, GTK+ and CLI clients. json was chosen because it's mostly human-readable and -writable, but also allows data hierarchies to be stored. See the [[Editing Configuration Files|Editing-Configuration-Files]] page on how to modify them.
|
||||
This is a json-encoded file that holds all the client's settings and preferences. It's currently only used by the daemon, GTK+ and CLI clients. json was chosen because it's mostly human-readable and -writable, but also allows data hierarchies to be stored. See the [Editing Configuration Files](Editing-Configuration-Files.md) page on how to modify them.
|
||||
|
||||
### stats.json
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
It's not always possible to set all configurations from the GUI, especially on the Daemon or the Web Interface. This guide will try to give an overview of how and what you can change. For the location of these files, look at the [[Configuration Files|ConfigFiles]] page.
|
||||
It's not always possible to set all configurations from the GUI, especially on the Daemon or the Web Interface. This guide will try to give an overview of how and what you can change. For the location of these files, look at the [Configuration Files](Configuration-Files.md) page.
|
||||
|
||||
Note: The client _should_ be closed before making changes, otherwise settings will be reverted to it's previous state.
|
||||
|
||||
|
|
@ -43,7 +43,7 @@ Here is a sample of the three basic types, respectively Boolean, Number and Stri
|
|||
#### Bandwidth
|
||||
|
||||
* **alt-speed-enabled:** Boolean (default = false, aka 'Turtle Mode')
|
||||
_Note: Clicking the "Turtle" in the gui when the [[scheduler|EditConfigFiles#Scheduling]] is enabled, will only temporarily remove the scheduled limit until the next cycle._
|
||||
_Note: Clicking the "Turtle" in the gui when the [scheduler](#Scheduling) is enabled, will only temporarily remove the scheduled limit until the next cycle._
|
||||
* **alt-speed-up:** Number (KB/s, default = 50)
|
||||
* **alt-speed-down:** Number (KB/s, default = 50)
|
||||
* **speed-limit-down:** Number (KB/s, default = 100)
|
||||
|
|
@ -59,8 +59,8 @@ Here is a sample of the three basic types, respectively Boolean, Number and Stri
|
|||
|
||||
#### [Files and Locations](./ConfigFiles.md)
|
||||
|
||||
* **download-dir:** String (default = [[default locations|ConfigFiles#Locations]])
|
||||
* **incomplete-dir:** String (default = [[default locations|ConfigFiles#Locations]]) Directory to keep files in until torrent is complete.
|
||||
* **download-dir:** String (default = [default locations](Configuration-Files.md#Locations))
|
||||
* **incomplete-dir:** String (default = [default locations](Configuration-Files.md#Locations)) Directory to keep files in until torrent is complete.
|
||||
* **incomplete-dir-enabled:** Boolean (default = false) When enabled, new torrents will download the files to **incomplete-dir**. When complete, the files will be moved to **download-dir**.
|
||||
* **preallocation:** Number (0 = Off, 1 = Fast, 2 = Full (slower but reduces disk fragmentation), default = 1)
|
||||
* **rename-partial-files:** Boolean (default = true) Postfix partially downloaded files with ".part".
|
||||
|
|
@ -117,7 +117,7 @@ Here is a sample of the three basic types, respectively Boolean, Number and Stri
|
|||
* **seed-queue-enabled:** Boolean (default = false) When true. Transmission will only seed `seed-queue-size` non-stalled torrents at once.
|
||||
* **seed-queue-size:** Number (default = 10) See seed-queue-enabled.
|
||||
|
||||
#### [[RPC|rpc]]
|
||||
#### [RPC](rpc-spec.md)
|
||||
|
||||
* **rpc-authentication-required:** Boolean (default = false)
|
||||
* **rpc-bind-address:** String (default = "0.0.0.0") Where to listen for RPC connections
|
||||
|
|
@ -195,7 +195,7 @@ Only keys that differ from above are listed here. These options have been repla
|
|||
|
||||
#### 1.3x (and older)
|
||||
|
||||
##### [[RPC|rpc]]
|
||||
##### [RPC](rpc-spec.md)
|
||||
|
||||
* **rpc-access-control-list:** String (Comma-delimited list of IP addresses prefixed with "+" or "-". Wildcards allowed using '\*'. Example: "+127.0.0.\*,-192.168.\*.\*", Default: "+127.0.0.1")
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@ Users can set environmental variables to override Transmission's default behavio
|
|||
|
||||
## Transmission-Specific Variables
|
||||
|
||||
* If `TRANSMISSION_HOME` is set, Transmission will look there for its settings instead of in the [[default location|ConfigFiles#Locations]].
|
||||
* If `TRANSMISSION_WEB_HOME` is set, Transmission will look there for the [[Web Interface|WebInterface]] files, such as the javascript, html, and graphics files.
|
||||
* If `TRANSMISSION_HOME` is set, Transmission will look there for its settings instead of in the [default location](Configuration-Files.md#Locations).
|
||||
* If `TRANSMISSION_WEB_HOME` is set, Transmission will look there for the [Web Interface](Web-Interface.md) files, such as the javascript, html, and graphics files.
|
||||
* If `TR_CURL_VERBOSE` is set, debugging information for libcurl will be enabled. More information about libcurl's debugging mode [is available here](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTVERBOSE).
|
||||
* If `TR_DEBUG_FD` is set to an integer, that integer is treated as a [file descriptor](http://en.wikipedia.org/wiki/File_descriptor) and very verbose debugging information is written to it. For example, here is how to turn on debugging and save it to a file named "runlog" when running Transmission from a bash shell:
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ Users can set environmental variables to override Transmission's default behavio
|
|||
|
||||
## Standard Variables Used By Transmission
|
||||
|
||||
* If `TRANSMISSION_WEB_HOME` is _not_ set, non-Mac platforms will look for the [[Web Interface|WebInterface]] files in `XDG_DATA_HOME` and in `XDG_DATA_DIRS` as described in [the XDG Base Directory Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables). `XDG_DATA_HOME` has a default value of `$HOME/.local/share/`.
|
||||
* If `TRANSMISSION_WEB_HOME` is _not_ set, non-Mac platforms will look for the [Web Interface](Web-Interface.md) files in `XDG_DATA_HOME` and in `XDG_DATA_DIRS` as described in [the XDG Base Directory Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables). `XDG_DATA_HOME` has a default value of `$HOME/.local/share/`.
|
||||
* If `TRANSMISSION_HOME` is _not_ set, Unix-based versions of Transmission will look for their settings in `$XDG_CONFIG_HOME/transmission/`. `XDG_CONFIG_HOME` has a default value of `$HOME/.config/`.
|
||||
* If `HOME` is set, it's used in three ways:
|
||||
1. by the `XDG` variables, as described above
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Transmission is fundamentally a Bit Torrent client and communicates with other Bit Torrent peers.
|
||||
In addition to this Transmission supports network-based remote control, whereby an authorised user may control the Transmission core from another machine via the [[Transmission JSON RPC protocol|rpc]].
|
||||
In addition to this Transmission supports network-based remote control, whereby an authorised user may control the Transmission core from another machine via the [Transmission JSON RPC protocol](rpc-spec.md).
|
||||
To make remote control easier from an arbitrary machine, Transmission Core can also serve a javascript web application to any browser and which in turn makes JSON RPC calls back to the Transmission core.
|
||||
|
||||
The Core components and methods of control are shown below:
|
||||
|
|
@ -24,4 +24,4 @@ The products are:
|
|||
* Transmission Command Line
|
||||
|
||||
The Transmission packages available on various distributions may include one or more of these components.
|
||||
Note. Although the diagram shows "Transmission Desktop Qt" as being Qt GUI + Transmission Core, the Qt component may be packaged on its own as a purely remote tool.
|
||||
Note. Although the diagram shows "Transmission Desktop Qt" as being Qt GUI + Transmission Core, the Qt component may be packaged on its own as a purely remote tool.
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@ A Web Interface is built into all Transmission flavours, enabling them to be con
|
|||
|
||||
## Enabling the Web Interface ##
|
||||
|
||||
Refer to the **Remote Management** links in the [[User Documentation|User-Documentation]] for your client to find out how to enable the Web Interface.
|
||||
Refer to the **Remote Management** links in the [User Documentation](User-Documentation.md) for your client to find out how to enable the Web Interface.
|
||||
|
||||
## Accessing the Web Interface ##
|
||||
Once enabled, open a web browser and direct it to http://ip_address_of_machine_running_transmission:9091/
|
||||
If web browser and Transmission Daemon are on the machine you can use http\://127.0.0.1:9091/
|
||||
9091 is the default remote control port specified in [[Transmission configuration|Editing-Configuration-Files]].
|
||||
9091 is the default remote control port specified in [Transmission configuration](Editing-Configuration-Files.md).
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ If you try to upload to the limit of your connection bandwidth you may block you
|
|||
|
||||
## 7. Is it your ISP?
|
||||
|
||||
If your ISP is one of those that manipulates Bittorrent packets — and even if it isn't — it's often a good idea to enable the [[Blocklist]] and also to tell Transmission to "Ignore Unencrypted Peers" to give your sessions slightly better privacy.
|
||||
If your ISP is one of those that manipulates Bittorrent packets — and even if it isn't — it's often a good idea to enable the [Blocklist](./Blocklist.md) and also to tell Transmission to "Ignore Unencrypted Peers" to give your sessions slightly better privacy.
|
||||
|
||||
Update: Google now has [a free online tool](http://broadband.mpi-sws.org/transparency/bttest.php) to test what your ISP is doing. Follow that link and go down to the "Start testing" button.
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ Connecting to a peer is like telephone calls: either you call up the peer, or th
|
|||
|
||||
Many people don't want to mess with their firewall and/or router, so they decide that dialing out is good enough and leave their port closed. Other people panic and worry too much about getting their port open even if they have a troublesome router. The truth is in the middle — you _can_ get by with a closed port, but on average you'll get much faster speeds if peers can connect to you.
|
||||
|
||||
Opening a closed port is often the most frustrating task in Bittorrent. The good news is that the Transmission wiki has two pages dedicated to this topic: the [[Port Forwarding Guide|PortForwardingGuide]] and the [Why is my port closed](Why-is-my-port-closed.md) page.
|
||||
Opening a closed port is often the most frustrating task in Bittorrent. The good news is that the Transmission wiki has two pages dedicated to this topic: the [Port Forwarding Guide](Port-Forwarding-Guide.md) and the [Why is my port closed](Why-is-my-port-closed.md) page.
|
||||
|
||||
You can also test your port status at [canyouseeme.org](http://www.canyouseeme.org/).
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ Transmission needs an open port to communicate. You can open one manually or let
|
|||
|
||||
## Open ports & forwarding
|
||||
|
||||
For guide on how to open and forward your Transmission port, read the [[Port Forwarding|PortForwardingGuide]] guide.
|
||||
For guide on how to open and forward your Transmission port, read the [Port Forwarding](Port-Forwarding-Guide.md) guide.
|
||||
|
||||
## Possible Problems
|
||||
|
||||
|
|
|
|||
|
|
@ -698,7 +698,7 @@ Method name: `free-space`
|
|||
Request arguments:
|
||||
|
||||
| Key | Value type | Description
|
||||
|:--|:--
|
||||
|:--|:--|:--
|
||||
| `path` | string | the directory to query
|
||||
|
||||
Response arguments:
|
||||
|
|
|
|||
Loading…
Reference in New Issue