wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

updated user agent documentation

This commit is contained in:
Arvid Norberg 2006-12-22 16:51:19 +00:00
parent c69479a166
commit 8ab5ba2cf5
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/manual.html
View File

@ -1962,9 +1962,9 @@ is empty, this will be ignored.</p>
<p><tt class="docutils literal"><span class="pre">proxy_login</span></tt> should be the login username for the http proxy, if this <p><tt class="docutils literal"><span class="pre">proxy_login</span></tt> should be the login username for the http proxy, if this
empty, the http proxy will be tried to be used without authentication.</p> empty, the http proxy will be tried to be used without authentication.</p>
<p><tt class="docutils literal"><span class="pre">proxy_password</span></tt> the password string for the http proxy.</p> <p><tt class="docutils literal"><span class="pre">proxy_password</span></tt> the password string for the http proxy.</p>
<p><tt class="docutils literal"><span class="pre">user_agent</span></tt> this is the client identification to the tracker. It will <p><tt class="docutils literal"><span class="pre">user_agent</span></tt> this is the client identification to the tracker.
be followed by the string &quot;(libtorrent)&quot; to identify that this library The recommended format of this string is:
is being used. This should be set to your client's name and version number. &quot;ClientName/ClientVersion libtorrent/libtorrentVersion&quot;.
This name will not only be used when making HTTP requests, but also when This name will not only be used when making HTTP requests, but also when
sending extended headers to peers that support that extension.</p> sending extended headers to peers that support that extension.</p>
<p><tt class="docutils literal"><span class="pre">tracker_completion_timeout</span></tt> is the number of seconds the tracker <p><tt class="docutils literal"><span class="pre">tracker_completion_timeout</span></tt> is the number of seconds the tracker
@ -2551,7 +2551,7 @@ struct peer_error_alert: alert
<div class="section"> <div class="section">
<h2><a id="invalid-request-alert" name="invalid-request-alert">invalid_request_alert</a></h2> <h2><a id="invalid-request-alert" name="invalid-request-alert">invalid_request_alert</a></h2>
<p>This is a debug alert that is generated by an incoming invalid piece request. The <tt class="docutils literal"><span class="pre">handle</span></tt> <p>This is a debug alert that is generated by an incoming invalid piece request. The <tt class="docutils literal"><span class="pre">handle</span></tt>
is a handle to the torrent the peer is a member of. <tt class="docutils literal"><span class="pre">Ïp</span></tt> is the address of the peer and the is a handle to the torrent the peer is a member of. <tt class="docutils literal"><span class="pre">ìp</span></tt> is the address of the peer and the
<tt class="docutils literal"><span class="pre">request</span></tt> is the actual incoming request from the peer. The alert is generated as severity level <tt class="docutils literal"><span class="pre">request</span></tt> is the actual incoming request from the peer. The alert is generated as severity level
<tt class="docutils literal"><span class="pre">debug</span></tt>.</p> <tt class="docutils literal"><span class="pre">debug</span></tt>.</p>
<pre class="literal-block"> <pre class="literal-block">
@ -3137,7 +3137,7 @@ boost::filesystem::path::default_name_check(boost::filesystem::native);
<p>Big thanks to Michael Wojciechowski and Peter Koeleman for making the autotools <p>Big thanks to Michael Wojciechowski and Peter Koeleman for making the autotools
scripts.</p> scripts.</p>
<p>Thanks to Reimond Retz for bugfixes, suggestions and testing</p> <p>Thanks to Reimond Retz for bugfixes, suggestions and testing</p>
<p>Thanks to <a class="reference" href="http://www.cs.umu.se">University of UmeÂ</a> for providing development and test hardware.</p> <p>Thanks to <a class="reference" href="http://www.cs.umu.se">University of Umeå</a> for providing development and test hardware.</p>
<p>Project is hosted by sourceforge.</p> <p>Project is hosted by sourceforge.</p>
<p><a class="reference" href="http://sourceforge.net"><img alt="sf_logo" src="http://sourceforge.net/sflogo.php?group_id=7994" /></a></p> <p><a class="reference" href="http://sourceforge.net"><img alt="sf_logo" src="http://sourceforge.net/sflogo.php?group_id=7994" /></a></p>
</div> </div>

6
docs/manual.rst
View File

@ -1953,9 +1953,9 @@ empty, the http proxy will be tried to be used without authentication.
``proxy_password`` the password string for the http proxy. ``proxy_password`` the password string for the http proxy.
``user_agent`` this is the client identification to the tracker. It will ``user_agent`` this is the client identification to the tracker.
be followed by the string "(libtorrent)" to identify that this library The recommended format of this string is:
is being used. This should be set to your client's name and version number. "ClientName/ClientVersion libtorrent/libtorrentVersion".
This name will not only be used when making HTTP requests, but also when This name will not only be used when making HTTP requests, but also when
sending extended headers to peers that support that extension. sending extended headers to peers that support that extension.