home *** CD-ROM | disk | FTP | other *** search
/ The Unsorted BBS Collection / thegreatunsorted.tar / thegreatunsorted / hacking / internet / borg / dox / TORXDCC.DOC < prev    next >
Encoding:
Text File  |  1996-01-29  |  10.5 KB  |  254 lines
  1. Documentation for TorXDCC
  2.  
  3. Current version : 0.9 beta 4,  january 22 1996
  4.  
  5. TorXDCC is a program to implement the XDCC protocol for mIRC, the windows IRC 
  6. client by Khaled Mardam-Bey.
  7.  
  8.  
  9. INTRODUCTION
  10.  
  11. The XDCC protocol on IRC is an extension of DCC functions already available in 
  12. mIRC with which users can make files available to other users. In contrast to 
  13. DCC filetransfers are not intiated by the sender, but by the receiver of the 
  14. files. It consists essentially of two commands, 'xdcc list' and 'xdcc send'. 
  15. With 'xdcc list' a person can ask which files are available from another user, 
  16. and with 'xdcc send' the actual filetransfer is requested. This filetransfer 
  17. is done with the standard DCC functions.
  18.  
  19. XDCC can be implemented in mIRC by using the programmable parts of mIRC, but 
  20. this is not easily done and changing to the offered files costs quite some 
  21. time. For some time a utility, in the form of mIRC offer by st0rmcat, was 
  22. available to automate the creation of suitable command and event sections, but 
  23. the author has decided to discontinue supporting it. 
  24. Because of some changes in mIRC 3.8 it can no longer be used, and therefore 
  25. I decided to write my own XDCC utility.
  26.  
  27. TorXDCC uses the DDE capability introduced in version 3.9 and cannot be used 
  28. with earlier versions of mIRC. This means that TorXDCC is required to run 
  29. simultaneously with mIRC, and that essentially only 2 lines need to be added 
  30. to the events and command section of mIRC, On the other hand some more lines 
  31. are added for easier usage of TorXDCC. 
  32.  
  33.  
  34. CAUTION
  35.  
  36. Be aware that this is a beta version of the program. I would really like 
  37. comments and bug-reports on it.
  38.  
  39.  
  40. INSTALLATION
  41.  
  42. 1. mIRC doesn't start automatically in DDE-server mode, you must put this on
  43. yourself by performing '/DDESERVER ON mirc'
  44.  
  45. 2. From TorXDCC perform 'Tools|Install mirc'
  46. A check is performed to see whether mIRC is running, this is required to find
  47. the location of the mirc.ini file. A dialogbox appears where several options
  48. can be set.
  49.  
  50. mIRC doesn't have to be closed for the installation, but the perform
  51. actionlist cannot be changed while mIRC is running. If the mirc file location
  52. contains spaces (win95 long filenames),  mIRC must be closed during
  53. installation.
  54.  
  55. When you have installed mIRC before and you want to change the userlevel for
  56. XDCC transfers you can choose to 'change userlevels in Remote sections' in
  57. stead of a 'Full install', only the Commands section and the Events section
  58. will be changed then.
  59.  
  60. With 'Minimum userlevel for XDCC requests' you can limit access to the offered
  61. packs. With userlevel 1 all users on IRC have access to your packs.
  62.  
  63.  
  64. Manual Installation to mIRC
  65.  
  66. The following changes are made to the mirc .ini-files. You can use these steps
  67. if installation to mIRC fails. Exchange <userlevel> with your actual chosen
  68. userlevel
  69.  
  70. 1 'File|Options|Action Lists|Perform'
  71. Add '/ddeserver on mirc | /run <torxdcc path>TORXDCC.EXE'
  72. make sure 'Active' is checked
  73.  
  74. 2 'Tools|Aliases'
  75. Add these 2 lines
  76. /tordde /dde torxdcc command XDCC *1
  77. /toffer /dde torxdcc command XDCC # list
  78.  
  79. 3 'Tools|Popups'
  80. Add 4 lines to 'Main window'
  81. TorXDCC
  82. .Offer to current channel:/dde torxdcc command XDCC # list
  83. .Show summary to current channel:/dde torxdcc command XDCC # summary
  84. .Run TorXDCC:/run C:\DELPHI\PROJECT\TESTDDE\TORXDCC.EXE
  85. Add these lines to both 'Query/Chat window' and 'Channel names list'
  86. TorXDCC
  87. .Offer list:/dde torxdcc command XDCC $1 list
  88. .Send pack #?:/dde torxdcc command XDCC $1 send #$?
  89. If userlevel > 1 add lines to add remove people for access
  90. .Enable XDCC transfer:/auser -a <userlevel> $1
  91. .Disable XDCC transfer:/ruser <userlevel> $1
  92. Set all Popup windows to 'Active'
  93.  
  94. 4 'Tools|Remote
  95. Add 2 lines to 'Commands'
  96. 1:Version:/notice $nick $dde torxdcc info VERSION
  97. <userlevel>:XDCC:/dde torxdcc command XDCC $nick $parms
  98. And one line to 'Events'
  99. <userlevel>:ON TEXT:XDCC*:?:/Closemsg $nick | /dde torxdcc command XDCC $nick $parm2*
  100. And set both these panels to 'Listening'
  101.  
  102.  
  103. Using TorXDCC
  104.  
  105. First start up mIRC. The installation routine has put commands in the perform
  106. actionlist which will activate DDE-server mode and start up TorXDCC. TorXDCC
  107. will try to contact mIRC, and if it is succesfull, it will show some
  108. statistics from mIRC (version, connection, server,nickname and the number of
  109. channels). If it could not connect a messagebox is displayed which tells you
  110. to start up mIRC or put it in DDE-server mode.
  111.  
  112. A list of offered files can be made with 'Tools|Edit XDCC list' In this
  113. dialogbox packs are formed. The descriptions of the packs appear in the left
  114. listbox, and the currently selected description can be edited in the editline
  115. at the right. Each pack can contain a number of files, which can be chosen
  116. with a fileselector. Multiple files can be selected at the same time. If a
  117. pack description doesn't contain files it is considered a comment.
  118.  
  119. The packs you make can be saved and loaded in the file menu.
  120.  
  121. The mIRC statistics in the main screen are updated every 2 minutes, the XDCC
  122. statistics every few seconds. Using 'File|Get mIRC data' forces TorXDCC to
  123. display the updated mIRC statistics within some seconds.
  124.  
  125. The appearance of the offered lists to other users can be changed in
  126. 'Options|Offer Line Masks'. At the moment 4 lines can be edited. The place of
  127. the actual information in the lines can be set with placeholders with the
  128. following form; %xx%. You can insert these variables in the lines by pressing
  129. the buttons on the bottom of the dialogbox.
  130.  
  131. The following variables are supported:
  132. For packs and general description.
  133.   %np%  number of packs
  134.   %nn%  own nickname
  135.   %rn%  Requester nickname/channel
  136.   %sb%  total size (bytes)
  137.   %sk%  total size (kilobytes)
  138.   %sm%  total size (megabytes)
  139.  
  140. For the pack description and the line for sending a pack
  141.   %pn%  number of pack
  142.   %pd%  description of pack
  143.   %pf%  number of files in pack
  144.   %pg%  number of gets for the pack
  145.   %pb%  packsize (bytes)
  146.   %pk%  packsize (kilobytes)
  147.   %pm%  packsize (megabytes)
  148.  
  149. 'Options|Appearance in mIRC' controls the notification sent to mIRC on the
  150. different requests to TorXDCC. These can be done with notices, which are sent
  151. to the currently opened window in mIRC or with  messages which are sent to a
  152. separate query window with your own nickname. The form of these lines can be
  153. changed in the same way as the offerline masks.
  154.  
  155. With 'Tools|Log Window' some of the communication between mIRC and TorXDCC
  156. can be observed, but at the moment it is mainly there for debugging purposes.
  157. The contents of the window can be copied to the clipboard, or saved in a file.
  158. Yours truly may ask you to do this sometime.
  159.  
  160. To offer files in a channel type /toffer<enter> or right-click on the channel
  161. and choose 'TorXDCC|Offer to the current channel'. In some channels it is
  162. thought inappropriate to offer complete lists. Here you can make people aware
  163. of your offer with a summary.
  164. With 'Tools|Timed offer to channels' you can choose to offer your list to
  165. certain channels in regular intervals. The list included channels you're
  166. currently connected to, and channels already in the list. The interval must
  167. lie between 1 and 60 minutes. If the number entered here doesn't lie within
  168. that range the channel is excluded from the timed offer. You can choose if the
  169. offer is done in the form of a list or as a summary.
  170. You can also offer to individual people on a channel by selecting them in the
  171. names-list and right-clicking. Choose 'Offer list' to send a list, or
  172. 'Send pack ?', for sending a pack.
  173. If the installed userlevel in TorXDCC is higher than 1 also the possibility
  174. of enabling and disabling users for filetransfer is available here.
  175.  
  176. Another alias can be used with the form '/tordde [Nick|Channel] [list|send #n]
  177. <enter>'. This performs the chosen XDCC command.
  178.  
  179. ADVANCED FEATURES
  180.  
  181. Timing of commands sent to mIRC:
  182. The default interval between commands sent to mIRC is 1000 ms (1 second) this
  183. value can be changed in the torxdcc.ini in section [General]-CommandInterval.
  184. Values between 100 and 30000 are accepted. With this value at 1000 I have not
  185. been flooded of IRC by XDCC requests yet.
  186.  
  187.  
  188. VERSION HISTORY
  189. 05-01-96 0.9 b1 :
  190.         First public release
  191.  
  192. 07-01-96 0.9 b2 :
  193.         Automatic installation
  194.       Bugfixes
  195.         SendingLine missed a space
  196.         Timed updating gave GPFs in mIRC -> disabled
  197.  
  198. 12-01-96 0.9 b3 :
  199.         Several popups added to installation
  200.         Saving of Logwindow to File and Clipboard
  201.         Added timed updating of statistics again
  202.         Added %pg% variable in offer lines for number of gets
  203.         Added XDCC statistics to main window for number of lists and
  204.            pack requests in current session.
  205.         When a user /msg'es a XDCC list or send, the message window
  206.            gets automatically closed
  207.         Notices of Lists and sends to other users do not appear anymore
  208.            in the windows of mIRC
  209.       Bugfixes
  210.         'List index out of bounds' should not appear anymore
  211.         Changed wrong popups definitions
  212.       Known bugs
  213.         Very long lines in the .inis (remote/alias/popups) are
  214.            truncated at 256 chars
  215.  
  216. 22-01-96 0.9 b4
  217.         Added notification of filetransfers to mIRC
  218.         Improved installation
  219.         Saving and loading of packs
  220.         TorXDCC now can check if mIRC is running.
  221.         Dialogbox for editing packs improved on several points, packs
  222.            can now also be added to the last position of the list
  223.       BugFixes
  224.         Disabled running of TorXDCC twice
  225.         Fixed a small memory leak on deletion of files from packs
  226.         It was possible for a file to be twice in the same pack
  227.  
  228.  
  229. 28-01-96 0.9 b5
  230.         Offering of a 'summary' now possible
  231.         Timed offering to channels
  232.         Comments can include variables now
  233.         Improved dialogbox for line masks
  234.         Automatic activation of Popups and Perform list during installation
  235.       Bugfixes
  236.         Better removal of previous XDCC commands
  237.         Long lines in .ini's are not truncated anymore
  238.         Improved versionreply :)
  239.  
  240. FUTURE FEATURES
  241.  
  242. - Keeping the mIRC stats more uptodate with mIRC
  243. - Getting transfer speeds
  244. - Even more statistics about the filetransfers, maybe setting up a
  245.   list of the people that requested packs or lists
  246. - Getting mIRC to minimize DCC send windows (and making progress)
  247. - More configurability on message window closing
  248. - A helpfile
  249.  
  250.  
  251. Let me know what you think about the program. My e-mail address is
  252. j.oosting@farmaco.rulimburg.nl and I can sometimes be found on IRC, with
  253. nickname Torkie.
  254.