NonGNU-devel ELPA - mentor

You can install mentor from NonGNU ELPA. Find and install Mentor using this command:

M-x package-list-packages

NonGNU ELPA is configured by default in Emacs 28.1 or later. For earlier versions of Emacs, please see the specific instructions for how to configure NonGNU ELPA.

Mentor should work on Emacs 25 or later. For the best performance I recommend using at least Emacs 27.1, built with libxml support. (See "Known issues" below.) I almost never test Mentor using old versions of Emacs, so please report any issues you run into.

You can also install mentor manually. First, make sure you have the minimum version of xml-rpc.el installed.

Clone this repository using:

git clone https://github.com/skangas/mentor.git

Add this to your init.el:

(add-to-list 'load-path "~/src/mentor/")
(require 'mentor)

Change "~/src/mentor" to the path where you keep the mentor source code.

To byte-compile mentor, go to the source directory and run:

make

To setup autoloading, you can add this to your Init file:

(autoload 'mentor "mentor" nil t)

You can find additional Mentor options in customize.

M-x customize-group RET mentor RET

Two useful variables to customize are mentor-rtorrent-download-directory and mentor-rtorrent-keep-session.

If you are already running rTorrent outside of Emacs, it is easy to configure Mentor to use it.

Add this to your ~/.rtorrent.rc and restart rTorrent:

scgi_local = ~/.rtorrent-rpc.socket
encoding.add = utf8

Customize mentor-rtorrent-external-rpc, or add this to your Init file and restart Emacs.

(setq mentor-rtorrent-external-rpc "~/.rtorrent-rpc.socket")

You can also specify an absolute path:

;; Alternative 2: Absolute path
(setq mentor-rtorrent-external-rpc "/path/to/rtorrent-rpc.socket")

It is also possible to connect to rtorrent over http. There are instructions on configuring this on the rtorrent wiki.

;; Alternative 3: Use a web server
(setq mentor-rtorrent-external-rpc "https://127.0.0.1:8080/RPC2")

Finally, you can connect directly to rtorrent over scgi. However, anyone that can send rtorrent xmlrpc requests can in all likelihood also execute arbitrary code as the user running rtorrent. Therefore, this is inadvisable on anything but the loopback device (e.g. 127.0.0.1) on single-user systems.

It is almost always easier and better to use a Unix domain socket (file) as suggested above.

;; Alternative 4: Connect directly to rtorrent over scgi
(setq mentor-rtorrent-external-rpc "scgi://127.0.0.1:5000")

For more information on configuring rTorrent, refer to the rTorrent wiki.

DEL	Add torrent file
l	Add Magnet link, URL or torrent file path
s	Start download
d	Stop download
D	Remove download
k	Close download
K	Remove download including data
r	Initiate hash check for download
g	Update screen
G	Re-initialize all download data
v	Show download in dired

m	Mark item
u	Unmark item
M	Mark all items
U	Unmark all items

t c	Sort downloads by state
t D	Sort downloads by directory
t d	Sort downloads by download speed
t n	Sort downloads by name
t p	Sort downloads by size
t t	Sort downloads by tied file name
t u	Sort downloads by upload speed

RET	Enter file details screen
R	Move download data
C	Copy download data
x	Call XML-RPC command
q	Bury mentor
Q	Shutdown mentor

rTorrent	Mentor	Description
->	RET	View download
0 - 9	0 - 9	Change view
^S	s	Start download
^D (1)	d	Stop an active download
^D (2)	D	Remove download
^K	k	Close a torrent and its files
n/a	K	Remove download including data
^E	e	Set 'create/resize queued' flags
^R	r	Initiate hash check of torrent
^O	o	Change the destination directory of the download
^X	x	Call commands or change settings
^B	n/a	Set download to perform initial seeding
+ / -	+ / -	Change the priority of the download
<DEL>	DEL	Add torrent file
	l	Add Magnet link, URL or torrent file path
l	n/a	View log. Exit by pressing the space-bar
U	n/a	Delete the file the torrent is tied to, and clear the association
I	n/a	Toggle whether torrent ignores ratio settings