README

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