README

   1 NOTE
   2 ----
   3 Some code was taken from the Deluge 0.6 branch. I was once working on a curses
   4 frontend for deluge then decided to ditch the idea. I backported my changes for
   5 tord and kept the good things from deluge.
   6
   7 Thanks deluge people for the ideas.
   8
   9 About
  10 -----
  11 Tore is a relatively simple to use bittorrent daemon/client currently shipped
  12 with a curses frontend.  Tore was initially created with the console user in
  13 mind (myself :S ).
  14
  15 Dependencies
  16 ------------
  17 pyxdg
  18 setuptools (python)
  19 boost
  20 pyinotify
  21
  22 Features
  23 --------
  24 Features prefixed with * do not work in this version.
  25
  26 DHT
  27 Global throttling
  28 Settings file (pickled)
  29 Client/Daemon
  30 Multiable clients able to connect to a single daemon.
  31   - May have multiable daemons where you select which daemon to connect to with the client
  32 Encryption
  33 Watched folder
  34 *On/off peak scheduling
  35 *File priority
  36 *Peers List
  37 *File List
  38 *Plugins (very limited)
  39 *File filtering
  40 *Logged alerts list (both session and torrented related)
  41 *Information list for each torrent
  42
  43 Setting up:
  44 -----------
  45 To install tord do
  46 'python setup.py install'
  47
  48 Launch the Pyro nameserver
  49 'pyro-nsd'
  50
  51 Launch the tord daemon
  52 'tord'
  53 on the computer you would like to download the torrents
  54
  55 Launch torc (the curses client)
  56 'tord' or 'tord hostname' if you have more then one daemon
  57 to start the UI on any computer on your network
  58
  59 Adjust session wide settings by pressing 'S' (press enter on setting you want
  60 to adjust) or by hand in ~/.config/tord/core.conf (mind you this file is hard
  61 to read). Some settings require a restart to take effect (changing paths).
  62
  63 Will download to and look for torrents in home (~) by default.
  64
  65 Keys
  66 ----
  67 Each view has both the following global keys and keys specific to that view only.
  68
  69 Global Keys:
  70 Up:           move cursor up
  71 Down:         move cursor down
  72 Left:         change to session view / refresh
  73 0-9:          sort keys
  74 *shift 0-9:   filter keys
  75 *c:           clear log
  76 u:            print UID for current line (eg torrent hash in torrent view)
  77 pgdn:         page down
  78 pgup:         page up
  79 B:            toggle border drawing
  80 T:            toggle drawing of titles
  81
  82 Torrent List View:
  83 *right:  view torrent information
  84 f:       view torrent file view
  85 S:       view core settings
  86 t:       toggle pause of torrent under cursor, also removes torrent from queue
  87 p:       pause torrent under cursor
  88 P:       pause all torrents
  89 r:       resume torrent under cursor
  90 R:       reume all torrents
  91 d:       move completed torrent torrents file to finsihed folder and remove from session
  92 D:      remove torrent from session and move torrent and files to deleted folder
  93 u:       display torrent id
  94 *l:      view torrent alert log
  95 *L:      with session alert log
  96 *c:      view torrent peers
  97 *q:      view torrent download queue
  98 *t:      view scheduled tasks
  99 *i:      view session information
 100 *d:      toggle DHT (implemented through Core Settings View)
 101 *a:      manual announce of torrent under cursor
 102 *A:      annouce all torrents
 103
 104 File List View:
 105 [:   increase priority
 106 ]:   decrease priority
 107 *F:  set all files off
 108 *N:  set all files on (priority 1)
 109 *p:   set all files to priority of file under cursor
 110
 111 Reading output
 112 --------------
 113 *All output may be adjusted by pressing 's' and changing the format for each view.
 114
 115 Status:
 116 At the bottom of each view shows the global status, no explanation as it is
 117 pretty striaght forward.
 118
 119 DownRate[ 6.06k | inf ] UpRate[ 5.23k | 5.00k ] Peers[31] DHT[39 18 0]
 120
 121 Session:
 122 Each torrent in the session is represented by.
 123 12 qp   5.00B     0.00B     0.00B      0   0.00% Torrent name
 124
 125 12: position in queue or ' ' for not in queue
 126 q:  torrent state (d: downloading, h: hashing.....)
 127 p:  paused or ' ' for active
 128 5.00B: download speed
 129 0.00B: upload speed
 130 0: peers
 131 Torrent Name: torrent name
 132 And more to come soon.