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).
This commit is contained in:
maxz
2022-04-11 19:38:32 +02:00
committed by GitHub
parent 70fbce71ec
commit 7c76d40a4d
23 changed files with 343 additions and 513 deletions

View File

@@ -1,13 +1,13 @@
The cryptic 'peer status' is shown in transmission-remote's `--peers` argument and in the Peers tab of the GTK+ Client's Details dialog. It's explained in a tooltip if you have GTK+ 2.12 or higher, and here if you don't:
The cryptic "peer status" is shown in transmission-remote's `--peers` argument and in the peers tab of the GTK+ client's details dialog. It is explained in a tooltip if you have GTK+ 2.12 or higher, and here if you do not:
<table>
<tr><td><tt>O</tt></td><td>Optimistic unchoke</td></tr>
<tr><td><tt>D</tt></td><td>Downloading from this peer</td></tr>
<tr><td><tt>d</tt></td><td>We would download from this peer if they'd let us</td></tr>
<tr><td><tt>d</tt></td><td>We would download from this peer if they would let us</td></tr>
<tr><td><tt>U</tt></td><td>Uploading to peer</td></tr>
<tr><td><tt>u</tt></td><td>We would upload to this peer if they'd ask</td></tr>
<tr><td><tt>K</tt></td><td>Peer has unchoked us, but we're not interested</td></tr>
<tr><td><tt>?</tt></td><td>We unchoked this peer, but they're not interested</td></tr>
<tr><td><tt>u</tt></td><td>We would upload to this peer if they would ask</td></tr>
<tr><td><tt>K</tt></td><td>Peer has unchoked us, but we are not interested</td></tr>
<tr><td><tt>?</tt></td><td>We unchoked this peer, but they are not interested</td></tr>
<tr><td><tt>E</tt></td><td>Encrypted Connection</td></tr>
<tr><td><tt>H</tt></td><td>Peer was discovered through Distributed Hash Table (DHT)</td></tr>
<tr><td><tt>X</tt></td><td>Peer was discovered through Peer Exchange (PEX)</td></tr>