--:: ultra-xdcc's Home ::--

-: menu :-
: home :
: features :
: download :
: readme :
: links :
SourceForge.net Logo
-: content :-
README - ultra-xdcc
-------------------
Author: Michael Nowak <tecskater@gmx.de>



I. Requirements
---------------
 1. Python
 2. XChat with Python support
 3. This script ;-)


II. Install
-----------
 1. Create a directory named 'ultra-xdcc' in: '/home/your_username/.xchat2/'
 2. Copy all 'ultra_*.py' files into this directory: '/home/your_username/.xchat2/ultra-xdcc/'
 3. If you want that the script starts with xchat, move 'ultra_xdcc.py' to the
    parent directory: '/home/your_username/.xchat2/'. Otherwise you have to
    load the script manually each time you start xchat by loading this file:
    'ultra_xdcc.py'
 4. Run the following command as root in the location of 'apps_xchat_xdcc_url_handler.schemas':
    'gconf-schemas --register apps_xchat_xdcc_url_handler.schemas'
    Now Gnome is able to handle the xdcc://-protocol and starts the downloads
    directly by clicking on a xdcc://-link.


III. Usage / Comamnds
---------------------
 1. uxdcc
  a. Syntax: /uxdcc <xdcc://..>
  b. Example: /uxdcc xdcc://network/irc.server.org/#channel/[xdcc]bot/#0001/file.bz2/msg [xdcc]bot xdcc send
  c. Result: Adds the download specified by the xdcc://-link to the
             download-list and starts it

 2. uxadd
  a. Syntax: /uxadd <xdcc://..>
  b. Example: /uxdcc xdcc://network/irc.server.org/#channel/[xdcc]bot/#0001/file.bz2/msg [xdcc]bot xdcc send
  c. Result: Adds the download specified by the xdcc://-link to the
             download-list and _without_ starting it

 3. uxprint
  a. Syntax: /uxprint
  b. Example: /uxprint
  c. Result: Prints the download-list to the current XChat-context. Here you
             can find the ID of a download, which you need for other commands

 4. uxstart
  a. Syntax: /uxstart <ID>
  b. Example: /uxstart 1
  c. Result: Starts the download with the specified ID from your download-list

 5. uxstop - NOT IMPLEMETED YET
  a. Syntax: /uxstop <ID>
  b. Example: /uxstop 1
  c. Result: Stops the download with the specified ID from your download-list

 6. uxremove
  a. Syntax: /uxremove <ID>
  b. Example: /uxremove 1
  c. Result: Removes the download with the specified ID from your download-list

 7. uxpriority - NOT IMPLEMETED YET
  a. Syntax: /uxpriority <ID> <Priority>
  b. Example: /uxpriority 1 5
  c. Result: Changes the priority of the download with the specified ID to the
             specified Priority

 8. uxsave
  a. Syntax: /uxsave [<File>]
  b. Example: /uxsave thisfile.cache 
  c. Result: Saves the download-list to the specified File in XML-format. If
             File is not specified, the download-list will be saved to the
             default cache-file, like specified in 'ultra_config.py'

 9. uxload
  a. Syntax: /uxload [<File>]
  b. Example: /uxload thisfile.cache 
  c. Result: Loads a download-list from the specified File. If File is not
             specified, the download-list will be loaded from the default
             cache-file, like specified in 'ultra_config.py'