mirror/transmission
1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2025-02-20 21:26:53 +00:00
Code Issues Releases Wiki Activity

Merge pull request #2678 from transmission/docs/update-the-docs-directory

Browse source 
docs: misc fixes in the docs/ directory
This commit is contained in:
Charles Kerr 2022-02-21 23:20:21 -06:00 committed by GitHub
commit 9090e3fd6b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/Configuration-Files.md
View file

@ -32,6 +32,8 @@ If you want to swap between the two applications, all you have to do is pass in
<tr><td>Default download folder</td><td><tt>%LOCALAPPDATA%/Downloads</tt></td></tr>
</table>
`%LOCALAPPDATA%` will resolve to `C:\Users[username]\AppData\Local` under a user context, and `C:\Windows\ServiceProfiles\LocalService\AppData\Local` under a service context.
### Overriding the Defaults
The per-user configuration folder's location can be overridden by setting `TRANSMISSION_HOME` and/or other [[environment variables|Environment-Variables]].
@ -62,4 +64,4 @@ This subfolder holds bluetack-formatted blocklists. Files ending in ".bin" are g
## Legacy Versions of Transmission
Older, [pre-XDG](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) [versions](http://trac.transmissionbt.com/ticket/684) of transmission-gtk and transmission-daemon stored their settings in `$HOME/.transmission`. Newer releases try to automatically migrate these files to `$HOME/.config/transmission/`.
Older, [pre-XDG](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) [versions](http://trac.transmissionbt.com/ticket/684) of transmission-gtk and transmission-daemon stored their settings in `$HOME/.transmission`. Newer releases try to automatically migrate these files to `$HOME/.config/transmission/`.

2
docs/Editing-Configuration-Files.md
View file

@ -108,7 +108,7 @@ Here is a sample of the three basic types, respectively Boolean, Number and Stri
* **download-queue-enabled:** Boolean (default = true) When true, Transmission will only download `download-queue-size` non-stalled torrents at once.
* **download-queue-size:** Number (default = 5) See download-queue-enabled.
* **queue-stalled-enabled:** Boolean (default = true) When true, torrents that have not shared data for `queue-stalled-minutes` are treated as 'stalled' and are not counted against the `queue-download-size` and `seed-queue-size` limits.
* **queue-stalled-enabled:** Boolean (default = true) When true, torrents that have not shared data for `queue-stalled-minutes` are treated as 'stalled' and are not counted against the `download-queue-size` and `seed-queue-size` limits.
* **queue-stalled-minutes:** Number (default = 30) See queue-stalled-enabled.
* **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.

3
docs/Environment-Variables.md
View file

@ -5,7 +5,6 @@ Users can set environmental variables to override Transmission's default behavio
* 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 `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).
* `TR_DEBUG` (undocumented).
* 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:
```console
@ -25,4 +24,4 @@ Users can set environmental variables to override Transmission's default behavio
## Standard Variables Used By Other Tools
* Transmission uses the [libcurl](http://curl.haxx.se/libcurl/) library for http- and https-based tracker announces and scrapes. Transmission doesn't support proxies, but libcurl itself honors [a handful of environment variables](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXY) to customize _its_ proxy behavior.
* Transmission uses the [libcurl](http://curl.haxx.se/libcurl/) library for http- and https-based tracker announces and scrapes. Transmission doesn't support proxies, but libcurl itself honors [a handful of environment variables](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXY) to customize _its_ proxy behavior.

34
docs/README.md
View file

@ -5,9 +5,9 @@ New to Transmission?
* Try the Help in Transmission's "Help" menu.
* simplehelp.net has an introduction for [Transmission on Macs](http://www.simplehelp.net/2008/07/17/how-to-use-transmission-as-your-bittorrent-client-os-x/).
* Jun Azua has an introduction for [Transmission GUI on Linux](http://www.junauza.com/2009/01/how-to-use-bittorrent-in-linux.html).
* Running Transmission [[without a GUI|HeadlessUsage]]
* Using Transmission [[from a web browser|Web Interface]]
* Also see our [[Frequently Asked Questions|FrequentlyAskedQuestions]].
* Running Transmission [without a GUI](HeadlessUsage)
* Using Transmission [from a web browser](Web Interface)
* Also see our [Frequently Asked Questions](FrequentlyAskedQuestions)
Want to learn more?
@ -17,22 +17,20 @@ Want to learn more?
# 2. More Documentation #
* [[Configuration Files|Configuration Files]]
* [[Editing Configuration Files|Editing Configuration Files]]
* [[Environment Variables|Environment Variables]]
* [[Extending Transmission using Scripts|Scripts]]
* [[Blocklists]]
* [[How to build Transmission|Building Transmission]]
* [[RPC Protocol Specification|RPC Protocol Specification]]
* [[Transmisson's Peer ID and User-Agent headers|Peer ID and User Agent]]
* [[Peer Status Text explained|Peer Status Text]]
* [Configuration Files](./Configuration-Files.md)
* [Editing Configuration Files](./Editing-Configuration-Files.md)
* [Environment Variables](Environment-Variables.md)
* [Extending Transmission using Scripts](./Scripts.md)
* Blocklists
* [How to build Transmission](Building-Transmission.md)
* [RPC Protocol Specification](rpc-spec.md)
* [Transmisson's Peer ID and User-Agent headers](Peer-ID-and-User-Agent.md)
* [Peer Status Text explained](Peer-Status-Text.md)
# 3. Report a problem / request a feature #
* If you're having trouble with Transmission, check the Troubleshooting section of our [[Frequently Asked Questions|FrequentlyAskedQuestions]].
* Check whether the problem has already been reported:
* [All open issues](https://github.com/transmission/transmission/issues)
* [Search](https://github.com/transmission/transmission/issues)
* If you're having trouble with Transmission, check the Troubleshooting section of our [Frequently Asked Questions](FrequentlyAskedQuestions)
* [Check](https://github.com/transmission/transmission/issues) whether the problem has already been reported.
* If you don't see a ticket matching your problem or feature, read [this post](https://forum.transmissionbt.com/viewtopic.php?f=1&t=3274) about what to write, then [add a new ticket](https://github.com/transmission/transmission/issues/new).
* If you _do_ see an existing ticket, please add a comment there. The more users interested in a ticket, the higher priority it's given.
@ -43,8 +41,8 @@ Please contact us if you are interested in supporting Transmission in any of the
* Code contribution
* Testing
* [[Language Translations|Translating]]
* [Language Translations](Translating)
* Bug and request management
* Documentation and Wiki Editing
* [Donations](https://transmissionbt.com/donate/)
* If you want to alert us to a security vulnerability, please email security@transmissionbt.com. Please note that general support questions belong on the forum, and will be ignored if sent to this email.
* If you want to alert us to a security vulnerability, please email security@transmissionbt.com. Please note that general support questions belong on the forum, and will be ignored if sent to this email.

30
docs/RPC-Protocol-Specification.md
View file

@ -1,30 +0,0 @@
This document explains how to remotely, or locally, connect to a Transmission session programatically using the rpc protocol.
_If you're looking to control a Transmission session non-programatically, you can either use the transmission-remote cli, or the [[Web Interface|Web Interface]]._
## Current
The current and in progress Specification can be found here: [rpc-spec.md](rpc-spec.md).
## Previous
* [Version 2.9x](/transmission/transmission/blob/2.9x/extras/rpc-spec.txt)
* [Version 2.8x](/transmission/transmission/blob/2.8x/extras/rpc-spec.txt)
* [Version 2.7x](/transmission/transmission/blob/2.7x/extras/rpc-spec.txt)
* [Version 2.4x](/transmission/transmission/blob/2.4x/extras/rpc-spec.txt)
* [Version 2.2x](/transmission/transmission/blob/2.2x/extras/rpc-spec.txt)
* [Version 2.1x](/transmission/transmission/blob/2.1x/extras/rpc-spec.txt)
* [Version 2.0x](/transmission/transmission/blob/2.0x/doc/rpc-spec.txt)
* [Version 1.9x](/transmission/transmission/blob/1.9x/doc/rpc-spec.txt)
* [Version 1.8x](/transmission/transmission/blob/1.8x/doc/rpc-spec.txt)
* [Version 1.7x](/transmission/transmission/blob/1.7x/doc/rpc-spec.txt)
* [Version 1.6x](/transmission/transmission/blob/1.6x/doc/rpc-spec.txt)
* [Version 1.5x](/transmission/transmission/blob/1.5x/doc/rpc-spec.txt)
* [Version 1.4x](/transmission/transmission/blob/1.4x/doc/rpc-spec.txt)
* [Version 1.3x](/transmission/transmission/blob/1.3x/doc/rpc-spec.txt)
## Deprecated
Versions before 1.30 used to connect to a Transmission session by writing directly into a socket file. Many not-so-up to date articles on setting up Transmission with a Web Interface (Clutch) may still refer to this technique.
* [Version 1.2x](/transmission/transmission/blob/1.2x/doc/ipcproto.txt)
* [Version 1.1x](/transmission/transmission/blob/1.1x/doc/ipcproto.txt)
* [Version 1.0x](/transmission/transmission/blob/1.0x/doc/ipcproto.txt)
* [Version 0.9x](/transmission/transmission/blob/0.9x/doc/ipcproto.txt)
* [Version 0.8x](/transmission/transmission/blob/0.8x/misc/ipcproto.txt)