[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/mentor 04eb7ade9a 3/3: Various improvements to the README
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/mentor 04eb7ade9a 3/3: Various improvements to the README |
|
Date: |
Thu, 22 Sep 2022 08:59:16 -0400 (EDT) |
branch: elpa/mentor
commit 04eb7ade9aca29ebfdc8bd176a1e294f554c55d5
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>
Various improvements to the README
---
README.org | 129 ++++++++++++++++++++++++++++++-------------------------------
1 file changed, 64 insertions(+), 65 deletions(-)
diff --git a/README.org b/README.org
index 8571f649a6..d2c216fa4d 100644
--- a/README.org
+++ b/README.org
@@ -13,7 +13,7 @@ interface, that will feel familiar to Emacs users. Key
bindings are chosen to
be as close to the vanilla rTorrent curses interface as possible.
mentor still has some way to go before it can really be considered a complete
-interface, so please moderate your expectations. It works fine for many common
+interface, so please moderate your expectations. It works fine for many common
tasks though, and in some cases (dare we say?) much better than the standard
ncurses interface.
@@ -22,26 +22,26 @@ ncurses interface.
[[doc/screenshot.png]]
Screenshot of moving a download and its data to another directory using ido
-integration. Sort your downloads in a breeze!
+integration. Sort your downloads in a breeze!
** Features
Here is a summary of some of the features:
- Show torrents in a table, with configurable columns.
-- Search torrents using C-s (no more of the manual up/down).
+- Search torrents using ~C-s~ (no more of the manual up/down).
- Mark and perform operations on more than one torrent at once.
- Sort torrents according to one or more criteria.
- Move downloads together with their data in one command.
- Switch between views, create new etc. (like numbers)
-- Support for most standard operations. (Start/stop/rehash/move etc.)
-- Use all Emacs features you are used to: macros, Emacs Lisp etc.
+- Support for most standard operations. (Start/stop/rehash/move etc.)
+- Use all Emacs features you are used to: macros, Emacs Lisp, etc.
** Installing mentor
*** Installing through NonGNU ELPA (recommended)
-You can install mentor from [[https://elpa.nongnu.org/][NonGNU ELPA]] or
[[http://melpa.org/][MELPA]].
+You can install mentor from [[https://elpa.nongnu.org/][NonGNU ELPA]] or
[[https://melpa.org/][MELPA]].
NonGNU ELPA is configured by default in Emacs 28.1 or later. Find and install
Mentor using this command:
@@ -65,13 +65,13 @@ 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.
+Change ~"~/src/mentor"~ to the path where you keep the mentor source code.
-If you wish to byte-compile mentor, go into the source directory and run:
+To byte-compile mentor, go to the source directory and run:
: make
-Here is how you setup autoload. See the Emacs manual for more information.
+To setup autoloading, you can add this to your Init file:
: (autoload 'mentor "mentor" nil t)
@@ -92,24 +92,23 @@ configuration.
You can find additional Mentor options in customize.
- : M-x customize-group
- : mentor <RET>
+ : M-x customize-group RET mentor RET
-Two very useful variables to customize are
-`mentor-rtorrent-download-directory' and `mentor-rtorrent-keep-session'.
+Two useful variables to customize are ~mentor-rtorrent-download-directory~ and
+~mentor-rtorrent-keep-session~.
*** External rTorrent
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:
+Add this to your ~~/.rtorrent.rc~ and restart rTorrent:
: scgi_local = ~/.rtorrent-rpc.socket
: encoding.add = utf8
-Add this to your init.el and restart Emacs, or customize "Mentor Rtorrent
-External Rpc":
+Customize ~mentor-rtorrent-external-rpc~, or add this to your Init file and
+restart Emacs.
: (setq mentor-rtorrent-external-rpc "~/.rtorrent-rpc.socket")
@@ -127,7 +126,7 @@ configuring this on the
[[https://github.com/rakshasa/rtorrent/wiki/RPC-Setup-XM
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.
+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.
@@ -143,67 +142,67 @@ For more information on configuring rTorrent, refer to
the [[https://github.com/
*** Downloads
-| <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 |
+| ~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 |
*** Marking
-| m | Mark item |
-| u | Unmark item |
-| M | Mark all items |
-| U | Unmark all items |
+| ~m~ | Mark item |
+| ~u~ | Unmark item |
+| ~M~ | Mark all items |
+| ~U~ | Unmark all items |
*** Sorting
-| 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 |
+| ~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 |
*** Misc
-| <RET> | Enter file details screen |
-| R | Move download data |
-| C | Copy download data |
-| x | Call XML-RPC command |
-| q | Bury mentor |
-| Q | Shutdown mentor |
+| ~RET~ | Enter file details screen |
+| ~R~ | Move download data |
+| ~C~ | Copy download data |
+| ~x~ | Call XML-RPC command |
+| ~q~ | Bury mentor |
+| ~Q~ | Shutdown mentor |
** Mapping from rTorrent commands to Mentor
*** Main view keys
-| *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.
|
+| *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
|
** Known issues
- There is no view for trackers/peers/extra information.
@@ -212,7 +211,7 @@ For more information on configuring rTorrent, refer to the
[[https://github.com/
thousands of torrents. So I wrote a patch for xml-rpc.el to add support for
Emacs built-in libxml support, which was helpfully merged by the xml-rpc.el
maintainer Mark A. Hershberger. This improved performance by a factor
- of 100. Make sure you upgrade to Emacs 27.1, build it with libxml support,
and
+ of 100. Make sure you upgrade to Emacs 27.1, build it with libxml support,
and
use the latest xml-rpc.el version to benefit from this speed increase.
** Contact