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