From 8ab5ba2cf5d09ec447202cdec819f109726553e8 Mon Sep 17 00:00:00 2001
From: Arvid Norberg <arvid@libtorrent.org>
Date: Fri, 22 Dec 2006 16:51:19 +0000
Subject: [PATCH] updated user agent documentation

---
 docs/manual.html | 10 +++++-----
 docs/manual.rst  |  6 +++---
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/manual.html b/docs/manual.html
index 2c48b5b50..962c91200 100755
--- a/docs/manual.html
+++ b/docs/manual.html
@@ -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
 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">user_agent</span></tt> this is the client identification to the tracker. It will
-be followed by the string &quot;(libtorrent)&quot; to identify that this library
-is being used. This should be set to your client's name and version number.
+<p><tt class="docutils literal"><span class="pre">user_agent</span></tt> this is the client identification to the tracker.
+The recommended format of this string is:
+&quot;ClientName/ClientVersion libtorrent/libtorrentVersion&quot;.
 This name will not only be used when making HTTP requests, but also when
 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
@@ -2551,7 +2551,7 @@ struct peer_error_alert: alert
 <div class="section">
 <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>
-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">debug</span></tt>.</p>
 <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
 scripts.</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><a class="reference" href="http://sourceforge.net"><img alt="sf_logo" src="http://sourceforge.net/sflogo.php?group_id=7994" /></a></p>
 </div>
diff --git a/docs/manual.rst b/docs/manual.rst
index bac1e4939..863610a10 100755
--- a/docs/manual.rst
+++ b/docs/manual.rst
@@ -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.
 
-``user_agent`` this is the client identification to the tracker. It will
-be followed by the string "(libtorrent)" to identify that this library
-is being used. This should be set to your client's name and version number.
+``user_agent`` this is the client identification to the tracker.
+The recommended format of this string is:
+"ClientName/ClientVersion libtorrent/libtorrentVersion".
 This name will not only be used when making HTTP requests, but also when
 sending extended headers to peers that support that extension.