Bug 136994 - Missing documentation on KTorrent
Summary: Missing documentation on KTorrent
Alias: None
Product: ktorrent
Classification: Applications
Component: general (show other bugs)
Version: unspecified
Platform: openSUSE Linux
: NOR wishlist
Target Milestone: ---
Assignee: Joris Guisson
Depends on:
Reported: 2006-11-07 09:50 UTC by Glenn Doig
Modified: 2015-06-19 08:30 UTC (History)
6 users (show)

See Also:
Latest Commit:
Version Fixed In:


Note You need to log in before you can comment on or make changes to this bug.
Description Glenn Doig 2006-11-07 09:50:26 UTC
Version:            (using KDE KDE 3.5.5)
Installed from:    SuSE RPMs
Compiler:          gcc 4.1.0 (it varies depending what version of OpenSuse is installed) Using 10.1 and 10.2 beta 4 OpenSuse Linux - installed via 64 bit(x86-64) rpm eg ktorrent-2.0.3-7.1
OS:                Linux

I am using KTorrent 2.0.2 using KDE 3.5.4 that comes with 10.2 Alpha 4(64 bit)
When I goto Help | Ktorrent Handbook I get an error message which says "There
is no documentation available for /ktorrent/index.html." in the helpsystem.
Can some documentation be put in place ?, especially howto open up a port when you
use a firewall and help-documentation on setting up KTorrent in Suse and howto run a simple test to
check it can get a file and others accessing a file you provide. Perhaps provide a short tutorial.

Also I get this message on an updated Suse 10.1 (64bit) system using KTorrent 2.0.3 using KDE 3.5.5.
Any help is appreciated. Thankyou.
Comment 1 Joris Guisson 2006-11-07 18:59:55 UTC
Documentation is being worked on for the 2.1 release.
Comment 2 Anguo 2007-10-11 11:15:13 UTC
I just downloaded the source code for ktorrent-2.2.2, but I still cannot find the (source of) the documentation.
Which file/folder is it supposed to be in? 

Has the documentation actually been started?
Comment 3 Joris Guisson 2007-10-11 19:34:47 UTC
It has been started, but I don't know the current status.
Comment 4 Jonathan Jesse 2007-11-01 20:19:23 UTC
Good afternoon,

Just curious if any work has been down on this manual or not?  I would be willing to help out on this.

Comment 5 Anguo 2007-11-02 06:05:41 UTC
I know someone has written something, but he is keeping what he has for himself on his usb stick or something like that (according to a comment I remember seeing in the ktorrent forum).

Check the ktorrent forums, find the guy and bit him up until he confesses and hand over the goods ;) 
Comment 6 Joris Guisson 2007-11-02 12:29:00 UTC
Yeah, he was going to send me what he had. I better check up on him, so we can include this with 2.2.3
Comment 7 Xenophon 2008-02-20 08:38:16 UTC
Perhaps a dummy file can be added stating that documentation is forthcoming along with the link to the site and the fora.
Comment 8 Harald Sitter 2008-11-05 18:03:01 UTC
In my opinion, if you don't have documentation to distribute, you should at least create a custom helpmenu (considering there is no way to get it not to show the Handbook item, as far as I know there is not ;-) and the documentation key should be removed from the desktop file.
Having no documentation is not as bad as having no documentation but still claiming there should be one. :)
Comment 9 Xenophon 2008-11-10 16:37:07 UTC
FYI: "The file or folder help:/ktorrent/index.html does not exist" is what I get when I press F1 in 3.1.2.

Perhaps an HTML file pointing out the existence of ktorrent.org and its fora could be a quick stop-gap solution. Just a thought.
Comment 10 Tristan Miller 2010-09-21 17:06:21 UTC
Problem still exists with KDE 4.5.1.
Comment 11 Valentin 2010-10-10 17:40:39 UTC
This is probably a very dumb question, but which repository should I check out if I want to add the manual page to the package?

This one?
Comment 12 Joris Guisson 2010-10-11 18:53:55 UTC
That is the one and only repository for ktorrent.

So you have a manual ?
Comment 13 Valentin 2010-10-15 21:17:40 UTC
No. I fixing some Ubuntu and KDE packages at work from time to time and I also spent hours of hours on working on the KDE Help Center.

I want to contribute some of the patches I already created for a company to the original packages. So I would like to do it myself: write the manual and then commit.
Comment 14 Joris Guisson 2010-10-16 12:45:46 UTC
I would very much welcome somebody putting in the effort to create a manual.

So go ahead, I will proofread it for you, just let me know when you have something to commit.
Comment 15 Burkhard Lück 2010-10-28 22:36:48 UTC
SVN commit 1190768 by lueck:

add help file with online ressources
@Valentin: if you'd like to join the kde documentation team subscribe to kde-doc-english@kde.org

 M  +1 -0      CMakeLists.txt  
 A             ktorrent (directory)  
 A             ktorrent/CMakeLists.txt  
 A             ktorrent/index.docbook  

WebSVN link: http://websvn.kde.org/?view=rev&revision=1190768
Comment 16 Tumul 2013-05-18 07:05:09 UTC
I dont understand if the documentation has been provided by  Burkhard Lueck and I can see the documentation in my ktorrent 4.1.3 then why has this bug not been closed.
Comment 17 Tristan Miller 2015-06-17 09:45:28 UTC
I too can no longer reproduce this problem (using KTorrent 4.3.1 on KDE 4.14.8).  Could someone please close this bug?
Comment 18 Myriam Schweingruber 2015-06-19 08:30:25 UTC
Closing as requested.