mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/docs/README.md

52 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
# 1. General help #
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
New to Transmission?
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* Try the help in Transmission's "Help" menu.
* simplehelp.net has an introduction for [Transmission on Macs](https://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](https://www.junauza.com/2009/01/how-to-use-bittorrent-in-linux.html).
Wrote a guide on headless usage. (#3049) The guide uses `transmission-daemon` and `transmission-remote`. It makes some basic security recommendations, but it does not include instructions for system integration, i.e. systemd, etc.
2022-05-13 15:20:57 +00:00
* Running Transmission [without a GUI](./Headless-Usage.md)
* Using Transmission [from a web browser](./Web-Interface.md)
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
Want to learn more?
* Visit our [forums](https://forum.transmissionbt.com)
Update README.md (#3517) Replace old IRC chat link
2022-07-24 14:57:50 +00:00
* Visit our [IRC](https://en.wikipedia.org/wiki/IRC) channel: [#transmission on Libera.Chat](https://web.libera.chat/#transmission)
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* Follow us on [Twitter](https://twitter.com/transmissionbt)
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
docs: misc fixes (#2683) * docs: update Scripts documentation Fixes #1159 * docs: fix broken Blocklist links Fixes #913. * docs: remove trailing spaces in markdown * docs: remove link to nonexistent FAQ Fixes #1937. * docs: unbreak the building-trqt-on-win link Fixes #1226. TODO: import that file to these docs * docs: add call for PRs
2022-02-22 18:45:30 +00:00
Want to contribute?
Much of this documentation is out-of-date or could be improved. Pull requests are greatly appreciated!
docs: Add FAQ to Readme.md (#3644)
2022-08-18 17:04:12 +00:00
# 2. FAQ #
* [Can I sequence the files I download?](./Can-I-sequence-the-files-I-download.md)
* [Why are my speeds so slow?](./Why-Are-My-Speeds-So-Slow.md)
* [Why is my port closed?](./Why-is-my-port-closed.md)
Delete dead link and add new section in FAQ (#3687)
2022-08-21 19:59:31 +00:00
* Q: How can I prevent the fragmentation of my downloaded files?
A: Use the [configuration option](./Editing-Configuration-Files.md) "preallocation": 2
docs: Add FAQ to Readme.md (#3644)
2022-08-18 17:04:12 +00:00
# 3. More documentation #
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* [Configuration files](./Configuration-Files.md)
* [Editing configuration files](./Editing-Configuration-Files.md)
* [Environment variables](Environment-Variables.md)
* [Extending Transmission using scripts](./Scripts.md)
docs: misc fixes (#2683) * docs: update Scripts documentation Fixes #1159 * docs: fix broken Blocklist links Fixes #913. * docs: remove trailing spaces in markdown * docs: remove link to nonexistent FAQ Fixes #1937. * docs: unbreak the building-trqt-on-win link Fixes #1226. TODO: import that file to these docs * docs: add call for PRs
2022-02-22 18:45:30 +00:00
* [Blocklists](./Blocklists.md)
fix broken links in main docs page Fixes #151
2022-02-22 04:49:04 +00:00
* [How to build Transmission](Building-Transmission.md)
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* [RPC protocol specification](rpc-spec.md)
fix: some typos (#3904)
2022-10-13 14:35:10 +00:00
* [Transmission's Peer ID and User-Agent headers](Peer-ID-and-User-Agent.md)
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* [Peer status text explained](Peer-Status-Text.md)
docs: link to open source reverse proxy guide on securing transmission (#5867)
2023-11-04 00:04:15 +00:00
* [Securing Transmission's RPC interface with an open-source reverse proxy (External Link)](https://www.pomerium.com/docs/guides/transmission)
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
# 3. Report a problem / request a feature #
fix broken links in main docs page Fixes #151
2022-02-22 04:49:04 +00:00
* [Check](https://github.com/transmission/transmission/issues) whether the problem has already been reported.
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* If you do not 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 are interested in a ticket, the higher its priority.
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
# 4. For contributors #
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
Transmission is a volunteer project and welcomes help.
Please contact us if you are interested in supporting Transmission in any of the following ways:
* Code contribution
* Testing
Update README.md (#3490) Repair "Language translations" link
2022-07-20 15:44:15 +00:00
* [Language translations](Translating.md)
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
* Bug and request management
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* Documentation and Wiki editing
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
* [Donations](https://transmissionbt.com/donate/)
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* If you want to alert us of 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 address.