home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 July & August / PCWorld_2005-07-08_cd.bin / software / topware / dc++ / DCPlusPlus-0.674.exe / readme.txt < prev    next >
Text File  |  2005-01-06  |  15KB  |  298 lines
  1. DC++ Readme
  2.  
  3. --------------------------------------------------
  4. DC++
  5. Copyright (C) 2001-2005 Jacek Sieka, arnetheduck on gmail com
  6. License
  7.  
  8. This program is licensed under GPL-2 with the notable exception
  9. that you may compile it with WTL when redistributing binaries. 
  10. You can find the full text of the license in license.txt that
  11. should have been distributed with the rest of the application.
  12.  
  13. This program is free software; you can redistribute it and/or modify
  14. it under the terms of the GNU General Public License as published by
  15. the Free Software Foundation; either version 2 of the License, or
  16. (at your option) any later version.
  17.  
  18. This program is distributed in the hope that it will be useful,
  19. but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21. GNU General Public License for more details.
  22.  
  23. You should have received a copy of the GNU General Public License
  24. along with this program; if not, write to the Free Software
  25. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  26.  
  27. Magnet.exe is licensed under the Apache License.
  28. Full license text: http://www.apache.org/licenses/LICENSE-2.0
  29. Project Home Page: http://sourceforge.net/projects/magnethandler
  30.  
  31. GeoIP database Copyright (c) 2003 MaxMind LLC.  All Rights Reserved.
  32. This product includes GeoIP data created by MaxMind, available from
  33. http://maxmind.com/
  34.  
  35. --------------------------------------------------
  36.  
  37. This Readme will give you a quick startup guide and explain some features
  38. that are NOT obvious :)
  39. So this is especially for NMDC upgraders.
  40. Newbies should (also) check out the web site, http://dcplusplus.sourceforge.net
  41. There you can also find a FAQ (Frequenty Asked Questions) and a forum
  42. (http://dcplusplus.sf.net/forum).
  43.  
  44. Contents
  45. ----------
  46.  1 Installation
  47.  2 Upgrade
  48.  3 Uninstall
  49.  4 Available commands (type in main chat or pm)
  50.  5 What do those Icons mean ??
  51.  6 Not-so-obvious options
  52.  7 Other things you might want to know about
  53.  8 Shortcuts
  54.  9 Automatic search for alternative download locations
  55. 10 Further information
  56. 11 Have fun
  57.  
  58.  
  59.  1 Installation
  60. -----------------
  61.  
  62.   Just run the installer and fire it up, then enter the settings to set it up according to your
  63.   preferences (most important is nick, download location and shared folders).
  64.  
  65.   version without installer available at http://sourceforge.net/projects/dcplusplus
  66.  
  67.  2 Upgrade
  68. ------------
  69.   If u used NMDC: You can import your queue file now !
  70.   If u used older DC++ version:
  71.    Just install in the folder your old version was in.
  72.    Your old settings will still be there as is your queue.
  73.  
  74.   BEWARE: Old (ver <= 0.163) Notepad notes will get lost, format change in 0.17
  75.   BEWARE: If you upgrade to 0.22, all old queue items that are missing a directory in the
  76.   target file-name will be removed. Don't upgrade if your queue is precious to you, and you didn't have
  77.   anything in the default download directory box in the settings (finish it with version 0.181
  78.   or edit your queue.xml file and add a directory to all targets without...).
  79.  
  80.  3 Uninstall
  81. --------------
  82.   There is an uninstaller as well ...
  83.   If you didn't use the installer: Just delete the folder, there are no .dll's or registry settings :)
  84.  
  85.  4 Available commands (type in main chat or pm)
  86. -------------------------------------------------
  87.   /grant            grants a slot to the user of the pm window you type in
  88.   /close            close current window
  89.   /help             short help message
  90.   /refresh          Refreshes list of shared files :)
  91.   /away <message>   Specifies a message to auto-respond in PM's while you're AFK
  92.                      (there's a default message so you don't need to specify one)
  93.   /back             Turn away message off
  94.   /slots <#>        Changes number of slots to <#>
  95.   /clear            Clears the main chat windows
  96.   /ts               Switches timestamps in chat windows on and off
  97.   /showjoins        Toggles joins/parts messages for the current hub
  98.   /favshowjoins     Toggles joins/parts messages of favorite users for the current hub
  99.                      (requires showjoins to be enabled)
  100.   /search <string>  Searches for <string>
  101.   /join <hub>       Joins <hub>
  102.   /dc++             Gives a comment about DC++ and shows the URL where
  103.                      you can get it
  104.   /fav /favorite    Adds hub to favourites (also works in pm's from that user)
  105.  
  106.  5 What do those Icons mean ??
  107. --------------------------------
  108.  green       = normal Icon
  109.  blue        = DC++ user (identified on 1st direct connection to this user)
  110.  with bricks = User is in passive mode
  111.  with key    = User is an Operator
  112.  
  113.  6 Not-so-obvious options
  114. ---------------------------
  115.   Settings:
  116.    General:
  117.     Active:              The usual connection mode, you can specify your IP
  118.                           if detection fails and a port of your choice if you need to.
  119.                           This mode will use a random port between 1025 and 32000
  120.                           chosen anew on restart if nothing is set in settings.
  121.     Passive:             Compatibility connection mode for users behind
  122.                           Firewalls they can't change to let DC++
  123.                           connections trough.
  124.                          Only use this if Active is not working.
  125.                          Note: Passive <-> Passive connections aren't possible.
  126.    Downloads:
  127.     Unfinished files temporary directory:    You can specify a Directory for your
  128.                          partial files here, suggestion si to have it on another
  129.                          partition than the "Default download directory" to have
  130.                          the files defragmented through moving there :)
  131.     Download slots:      Maximum number of Downloads runing at once, suggestion
  132.                          is to set it to the same number as your upload slots
  133.    Sharing:
  134.     Upload slots:        The number of maximum simultaneous uploads, set to a reasonable
  135.                           value; you should have at least 4-5 KB/s uplaod speed per slot.
  136.    Appearance:
  137.     Use system icons:    Displays the icons set in Windows for filetypes
  138.     Language File:       A XML-file containing most of the text used in DC++.
  139.                           You can specify a file to have DC++ in your favourite language.
  140.                           There's an example.xml if you want to make your own.
  141.                           Language files available at http://DCPlusPlus.sourceforge.net
  142.    Logs and Sound:
  143.     Log Downloads:       You can use this feature to see what downloads
  144.                           completed while you were AFK :)
  145.     Parameters for the logging (the things in %[xxx]):
  146.      target         target filename (for downloads)
  147.      source         source filename (for uploads)
  148.      user           nick
  149.      hub            hub name
  150.      hubip          hub ip
  151.      size           size of the file
  152.      sizeshort      size in b/kB/MB/GB (short version)
  153.      chunksize      size downloaded this session (if resuming, otherwise the same as size)
  154.      chunksizeshort ...
  155.      speed          speed of download
  156.      time           time to download (hh:mm:ss format)
  157.      sfv            1 if the file was sfv/crc32 checked, 0 otherwise
  158.      tth            base32 representation of the tiger tree root hash
  159.    
  160.     You can also use all date and time parameters (%Y, %m, ...) of strftime (google for it).
  161.  
  162.  
  163.    Advanced:
  164.     Rollback:            Size of bytes to rollback when resuming a file to
  165.                           ensure it contains no errors.
  166.                          If there is an error DC++ deletes <rollback>
  167.                           bytes and checks again.
  168.     Write buffer size:   Anti-fragmentation feature, DC++ saves every
  169.                           <write buffer size> bytes to keep fragmentation low.
  170.     Client version:      Since most hubs specify a min client version that
  171.                           is much higher than DC++'s real version number you
  172.                           can set something here, i suggest adding 1 to version
  173.                           number e.g. 1.181
  174.                          to be able to enter the hub.
  175.     Automatically search for alternate download locations:  Allows DC++ to try
  176.                           to find other locations to download your files.
  177.                           Useful if you're AFK a lot.
  178.     Install URL handler on startup:     Set if you want URLS of type dchub://
  179.                          to open in DC++
  180.     Use small send buffer:    If uploads slow down your downloads A LOT you may
  181.                          try this option, but beware it increases HD usage and
  182.                          slows down upload, so it's not suggested.
  183.     Enable SFV checking: Many downloads on DC contain an sfv file to check the integrity of
  184.                          a download. DC++ can on-the-fly calculate CRC-32 values for
  185.                          a file and compare it agains the sfv file. If the check fails,
  186.                          the file is automatically downloaded once more from the same user
  187.                          and if that fails, the user is removed as a source. For this to work,
  188.                          the .sfv file must be in the same target directory as the download goes.
  189.  
  190.  7 Other things you might want to know about
  191. ----------------------------------------------
  192.   * you can doubleclick on a user name in chat to select him in the user list
  193.   * you can doubleclick on stuff starting with www. http:// of ftp:// to open :)
  194.   * DC++ supports uploading filelists and files <64 kB to other DC++ users
  195.     WITHOUT REQUIRING A SLOT. There's a max of 3 connections in addition to
  196.     normal slots.
  197.   * Files <64 kB and filelists are downloaded first.
  198.   * There is information added to the description field:
  199.     <++ V:x,M:x,H:x/y/z,S:x[,O:x]> where
  200.      V = client version,
  201.      M = mode (a=active, p=passive),
  202.      H: x = number of hubs connected to where you're not a registered user
  203.         y = number of hubs you're registered in
  204.         z = number of hubs you're registered as op
  205.      S = number of slots you have open.
  206.      O = if total upload is below this value DC++ will open another slot
  207.          this part of the tag is only shown when the option for it is enabled
  208.      This is updated every 1-2 minutes if there are changes.
  209.   * There is a limit so that only 15 users and 1 op can be kicked at a time
  210.     from the hub user list
  211.   * Passive user detection, those that are behind a set of bricks are passive.
  212.     (detected when the user searches or tries to connect to you)
  213.   * DC++ user detection, those appear blue.
  214.   * Dupe file removal, files with same name and size are automatically removed
  215.     from your share
  216.   * Search flood detection (If more than 5 searches are received from the same
  217.     user within 7 seconds, DC++ will send out a warning)
  218.   * if a user leaves the hub DC++ will close his slots, if the user is back within 10 minutes
  219.     DC++ will grant him a slot.
  220.     THIS CAN CAUSE YOUR UPLOAD GOING OVER MAXIMUM SET IN SETTINGS
  221.   * filelist will be recreated if missing on request
  222.   * optional SFV will remove and requeue file if check failed
  223.   * If DC++ receives "banned" during the login phase, it'll stop automatically reconnecting
  224.   * Files containing "$" aren't added to share 'cause they won't be downloadable alter on.
  225.     This is a protocol limitation ....
  226.  
  227.  
  228.  8 Shortcuts
  229. --------------
  230.   ALT-s   send chat message
  231.  
  232.  
  233.  9 Automatic search for alternative download locations
  234. --------------------------------------------------------
  235. An automatic search (the advanced option "Automatically search for 
  236. alternative download locations") will use the search string defined in the 
  237. download queue and it can be changed by the user. Previously (before 
  238. v0.301) the search used the target filename. A good search string is the 
  239. key to find many sources. If the search string is empty there will be no 
  240. search. The search string is also used when manually searching for alternates.
  241.  
  242. You can change the search string for many files at once, which is good for 
  243. rar sets. However, a client will return at most 10 results on a search, 5 
  244. if you are passive, and trying to alter the search string for more than 
  245. those numbers will give you a warning.
  246.  
  247. The option in advanced settings below auto-search "Automatically add search 
  248. string for alternative download locations" will automatically set the 
  249. target file name as search string when adding files to the download queue.
  250.  
  251. Since v0.301 the auto search will also search for items in the download 
  252. queue which have online users. Previously only items with offline users 
  253. were searched and lead people to believe auto search was not working at 
  254. all. This feature comes at a cost though. The delay between searches for 
  255. items with online users is 5 minutes whereas searches for items with no 
  256. online users is done every other minute. No search will be made for an item 
  257. which has a source from whom you are already downloading a different file 
  258. from. A file will be searched for no more than once per hour, so if you 
  259. only have one item in the download queue it will take one hour between 
  260. searches.
  261.  
  262. What does "Automatically search for alternative download locations" do when 
  263. no search strings are set? It will automatically match any search results 
  264. coming from manual searches against files in the download queue. So 
  265. basically it saves you the trouble of right-clicking every file you want to 
  266. add as an alternate source.
  267.  
  268. Example search string for rar sets:
  269. Files abc-cd1.r01 to abc-cd1.r09 can have the same search string set to 
  270. "abc-cd1.r0" (passive users will only get 5 files returned so one search 
  271. string per file, like "abc-cd1.r01"). But don't set it to "abc .r0" or 
  272. something similar, this will give you rar files for CD2 as well. If you 
  273. don't have sfv checking enabled (the advanced option "Enable automatic SFV 
  274. checking") you can end up with the right files in the wrong place. This 
  275. search for rar sets is so good that it's even better (at least less time 
  276. consuming) than doing it yourself with manual searches and getting 
  277. filelists and use match queue. It gives you 10 files at once, even if there 
  278. are online users.
  279.  
  280. That pretty much covers it.
  281.  
  282. Thanks Lundis for the first draft of this feature description and 
  283. suggesting and testing of the enhanced auto search in the first place.
  284.  
  285.  
  286. 10 Further information
  287. ------------------------
  288.   * Homepage                  @ http://dcplusplus.sourceforge.net
  289.   * Forum                     @ http://dcplusplus.sourceforge.net/forum
  290.   * Report bugs               @ http://dcplusplus.sourceforge.net/bugs
  291.   * Request features          @ http://dcplusplus.sourceforge.net/bugs
  292.   * Download language files   @ http://sourceforge.net/tracker/?atid=460289&group_id=40287&func=browse
  293.   * Get newest version        @ http://dcplusplus.sourceforge.net/index.php?t=2&s=1
  294.   * Typos and errors in readme go to Fireball@enLightning.de
  295.  
  296. 11 Have fun
  297. -------------
  298.   Go out, share some files, be a happy DC++ user and have fun.