Archived

This topic is now archived and is closed to further replies.

rockett

Updating the µTorrent Help Documentation

Recommended Posts

Hello everyone,

The µTorrent help files and documentation are a bit out of date at this point. We’re working on updating and revising them, and we’d like to invite all of you to participate.

We’ve set up a github repo for the help files here:

https://github.com/bittorrent/utorrent_help/

You’ll need a github account to contribute. To make changes to the files, simply fork the master branch, push any edits to your fork, and then create a pull request for the master branch. We’ll review the changes for accuracy and and incorporate them into the master branch.

To keep everything consistent, when formatting your changes please adhere to the guidelines outlined in the _Formatting_Conventions_.html file.

Thanks much for your help, and if you have any questions please let me know.

Share this post


Link to post
Share on other sites
To keep everything consistent, when formatting your changes please adhere to the guidelines outlined in the _Formatting_Conventions_.html file.

You want people to adhere to a 404 link ... ? ;)

Share this post


Link to post
Share on other sites
Hello everyone,

The µTorrent help files and documentation are a bit out of date at this point. We’re working on updating and revising them, and we’d like to invite all of you to participate.

We’ve set up a github repo for the help files here:

https://github.com/bittorrent/utorrent_help/

You’ll need a github account to contribute. To make changes to the files, simply fork the master branch, push any edits to your fork, and then create a pull request for the master branch. We’ll review the changes for accuracy and and incorporate them into the master branch.

To keep everything consistent, when formatting your changes please adhere to the guidelines outlined in the _Formatting_Conventions_.html file.

Thanks much for your help, and if you have any questions please let me know.

Can anyone tell me where I can get the "compiled" help/utorrent.chm file? I like to keep up to date on the help file. I found the uncompiled version in the link above, but I have no knowledge on how to compile it. I would appreciate all and any assistance concerning this matter.

Thank You. :cool:

Share this post


Link to post
Share on other sites
Sure, take it from my sig/tip #1 or just do F1 in v3.3

Why would the help file (v3.3 from Rafi's link) no longer activate using F1 or in the Preferences menu when clicking "?" in the title block as it does in other versions? Unzipping uTorrent-help.zip in the settings directory and renaming to utorrent-331-29704.chm (or utorrent-330-29642.chm, the actual version) it still won't launch w/in uTorrent. Is this a beta/RC specific bug?

EDIT: Scratch that. I renamed to 311-29704 a second time and its now working.

Share this post


Link to post
Share on other sites
I renamed to 311-29704
Really? Should be ...331-...

A typo. Why it didn't work the first time. :D

Share this post


Link to post
Share on other sites
Sure, take it from my sig/tip #1 or just do F1 in v3.3 ... :)

Thanks, but I already have the help file dated March 22, 2013. The one on the website (utorrent-help-master, you have to compile it yourself to make any use out of it) and it's dated May 1, 2013.

µTorrent User Manual

v3.3 ( Last updated on: 1-May-2013, by: Rockett )

Welcome to the µTorrent User Manual. We hope the information provided here will assist you in using µTorrent.

My beta version of µTorrent 3.3.1-29704 doesn't download the help file, it just sits there and does nothing. When I do press F1 I get this in my log file:

[2013-05-22 20:41:48] Help file not found in settings directory, attempting to download

[2013-05-22 20:41:49] Could not download help file. Error: HTTP Error 404

[2013-05-22 20:42:00] HTTP: IP ::1: GET /gui/?token=pZaKx0JemqZC7IKaw_AmZ0jjFUMni9AlrKuOKpXfqmNbFLSi3F12kmRhnVEAAAAA&list=1

Either the µTorrent User Manual/Help file/zip file isn't on line, or there's something wrong with the HTTP, because, as you can see I get a 404 Error.

How hard is it to compile the help file and what exactly do you need to compile it, the bare minimum? At least someone is updating the help file every time a new release it put out. That's better than attempting to update it every MAJOR release.

@rafi Do you keep an updated version of the help file in your sig?

I would appreciate any and all help on this matter.

Thank You.

Share this post


Link to post
Share on other sites
Sure, take it from my sig/tip #1 or just do F1 in v3.3 ... :)

I now was able to download the user manual using F1. The only problem is that it's dated March 22, 2013. Any chance of someone compiling the new version and putting it online?

Thanks. :)

Share this post


Link to post
Share on other sites
Hello everyone,

The µTorrent help files and documentation are a bit out of date at this point. We’re working on updating and revising them, and we’d like to invite all of you to participate.

We’ve set up a github repo for the help files here:

https://github.com/bittorrent/utorrent_help/

You’ll need a github account to contribute. To make changes to the files, simply fork the master branch, push any edits to your fork, and then create a pull request for the master branch. We’ll review the changes for accuracy and and incorporate them into the master branch.

To keep everything consistent, when formatting your changes please adhere to the guidelines outlined in the _Formatting_Conventions_.html file.

Thanks much for your help, and if you have any questions please let me know.

Thank you for putting the µTorrent help files and documentation on github. I've downloaded the utorrent_help_master.zip file from github, downloaded and successfully installed CYGWIN, I followed the instructions to build the help files, copy [ 7z.exe 7z.dll hhc.exe ] to the same directory as buildscript.sh. Now, what sort of command do I give cygwin to compile the help file? Cygwin is like Greek to me. I did Help help, help -d, help -s, etc.. I would appreciate any and all assistance concerning this matter.

Thank You. :)

Share this post


Link to post
Share on other sites

To open help in the terminal use; man cygwin <enter> to read and hit [Q] to Quit the manual, Ctrl+D to logout.

man == manual in Unix/Linux

once you open a cygwin terminal window you are in a Unix 'bash' environment.

Have a read at http://mikesmithers.wordpress.com/2010/12/30/a-quick-guide-to-cygwin-commands-for-the-deprived-of-the-dos-world/

For a "Dummies guide" to Cygwin,

or go all out Linux and put Mint on a machine then if you miss Windows too much you could setup a VM with VirtualBox or Xen.

Share this post


Link to post
Share on other sites
To open help in the terminal use; man cygwin <enter> to read and hit [Q] to Quit the manual, Ctrl+D to logout.

man == manual in Unix/Linux

once you open a cygwin terminal window you are in a Unix 'bash' environment.

Have a read at http://mikesmithers.wordpress.com/2010/12/30/a-quick-guide-to-cygwin-commands-for-the-deprived-of-the-dos-world/

Thank you, and yes, I do know that once I'm in the cygwin terminal, I'm in the Unix 'bash' environment. In the 90's I was running UUCP (Unix to Unix Copy Protocol) on the Commodore Amiga to get my Newsfeeds from Rutgers NJ, so Unix isn't a complete stranger to me.

Thanks for explaining how to bring up the Cygwin manual. That does come in handy! :)

All I need to know is what command do I run to compile the help file? From there I can figure it out for myself.

I have the buildscript.sh file in the root directory along with 7z.exe, 7z.dll and hhc.exe, what command do I need to do to just compile the help file? It's almost like someone giving you the complete C++ code for a program, and you installed the C++ compiler, then you have no idea what command to use to compile it so you have the finished program.

For a "Dummies guide" to Cygwin,

or go all out Linux and put Mint on a machine then if you miss Windows too much you could setup a VM with VirtualBox or Xen.

Thanks for the link, I also subscribed to the Cygwin mailing list, but that won't really help unless I know what I want to do with Cygwin. Yes, I have several versions of Linux (I guess you recommend Mint? Why Mint over the others?), most of them I have from the DVD. I like it better than Windows (all versions), but there aren't allot of popular/compatible programs that run on them. I do know that there is Open Office, but I haven't tried their Outlook compatible program yet. Maybe once I have a steady and secure income, I'll look into getting more storage space to run some of the things I've been waiting to try.

All it says in the README.md file is:

utorrent_help

=============

Utorrent and bittorrent help files.

To build the help files, copy [ 7z.exe 7z.dll hhc.exe ] to the same directory as buildscript.sh

Note that this script requires cygwin.

I would really appreciate it very much if someone/anyone can tell me what command to I need to run to just compile the uTorrent help file.

Thank You. :/

Share this post


Link to post
Share on other sites

OKAY, I finally figure it all out on how to compile the latest µTorrent manual/help file.

1. Download the uncompiled files from https://github.com/bittorrent/utorrent_help/ (download the utorrent_help-master.zip)

2. Download and install CGWin from http://www.cygwin.com/install.html (download setup.exe) which is on the first line.

3. Install Cygwin (try choosing the second or third site to download it from after you run the setup.exe).

4. Download and install 7z from http://www.7-zip.org/download.html

5. Download and install "Microsoft Help Compiler" from http://www.helpandmanual.com/downloads_mscomp.html

6. To build the help files, copy [ 7z.exe 7z.dll hhc.exe ] to the same directory as buildscript.sh (Note that this script requires cygwin.)

7. Then from your Start menu (for Windows 7, it's different in Win 8 & Win XP(I could be wrong about this since I haven't use XP in a couple of years and I can't install Win8 because my CPU (Pentiium 4 @ 3.0Ghz) doesn't support the NX feature), HTML Help Workshop -> HTML Help Workshop, and once it comes up:

8. Choose File -> Open, then in the directory called Resources, open utorrent (which is a HHP file).

9. Then File -> Compile

10. You should find the newly compiled (utorrent.chm) should be in the same directory as the utorrent.hhp file.

11. Rename the file to the version of µTorrent you have, e.g. utorrent-3310-29721.chm

12. Now you can place the newly compiled file (utorrent-331-29721.chm) in your %AppData%/uTorrent/ directory.

Now you should have the latest µTorrent manual/help file.

I'm only doing this for the people who aren't as computer savvy as the Admins/Forum Moderators. I totally believe in sharing knowledge so others can learn/get ahead.

:cool:

Share this post


Link to post
Share on other sites

And ? Keeping the file to yourself?... You forgot to post a copy of it... :(

Share this post


Link to post
Share on other sites
And ? Keeping the file to yourself?... You forgot to post a copy of it... :(

Okay, I'll post it for everyone to have. I don't mind. I was under the impression that nobody wanted it because no one thought there wasn't enough changes to warrant it.

How would you like me to upload it? I don't have any accounts on any upload sites. Can you recommend a FREE upload site (the file, which is uncompressed is only 355 KB) that everyone can have access to for a specific length of time.

I definitely would love to help out where ever I can. :)

Share this post


Link to post
Share on other sites
Don't you have a Google account (G. drive)? Or here http://temp-share.com/home ?

I have a Gmail (Google Mail) account, is that the same? If not, how do I get a FREE Google account? Any ways, thanks for th quick free upload link. I did upload the latest version of uTorrent's help file (3.3), it's dated May 1, 2013 and it was updated by rockett. The name of the file is utorrent-331-29756.chm . You, and everyone else can get it from here : http://temp-share.com/show/f3Ygitjun

I just uploaded it less than five minutes ago. I have no idea how long they hold the files. I would really advise you to put the latest version of the .chm file in your signature. Maybe you might be able to have other users to automatically get it when they F1 in uTorrent.

Let me know how to obtain the free Google account, and I'll always keep the latest uTorrent help/manual in my signature as well. It's only 355.6 KB, so it's not going to hurt ANYONE to get it. :)

I hope that everyone will be able to find use for the new (and some what updated) uTorrent help/manual/utorrent-331-29756 file. Enjoy!

Share this post


Link to post
Share on other sites
I would really advise you to put the latest version of the .chm file in your signature.

Done @ my tips/guide para. #1 ...

Maybe you might be able to have other users to automatically get it when they F1 in uTorrent.

Not up to me... Only The admin of the update server can do it...

Share this post


Link to post
Share on other sites

This is the latest update to the user manual/help file. It is dated June 11, 2013.

http://mir.cr/12LEVVHR

Just some minor changes, such as updating the version change from 3.3.1 to 3.3.2

Please share and enjoy! :cool:

Share this post


Link to post
Share on other sites
This is the latest update to the user manual/help file. It is dated June 11, 2013.

http://mir.cr/12LEVVHR

Please share and enjoy!

All download slots for this link are currently filled.

Please try again momentarily.

You may also purchase an account and download now!

Share this post


Link to post
Share on other sites
You may also purchase an account and download now!

Or, you can see my solid tips/guide/link...

Share this post


Link to post
Share on other sites
This is the latest update to the user manual/help file. It is dated June 11, 2013.

http://mir.cr/12LEVVHR

Please share and enjoy!

All download slots for this link are currently filled.

Please try again momentarily.

You may also purchase an account and download now!

Okay, try this one: http://d01.megashares.com/dl/kqMhMwK/utorrent-332.chm

or try this one: http://temp-share.com/show/gFHKQ9l0Y

Let me know how you make out.

Thanks

Share this post


Link to post
Share on other sites