From 2238b47114e46eb53d8ab303eb38824c51481f21 Mon Sep 17 00:00:00 2001 From: Charalampos Kardaris Date: Sun, 10 Feb 2019 20:04:47 +0200 Subject: [PATCH] README and man page --- README.md | 14 ++++++++++---- tormix.1 | 4 ++++ 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 66621ef..7faa21f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # tormix +img -Based on the original project from dylanaraps -I decided to add many more features +Based on the original project from dylanaraps
+I decided to change the name (to not conflict with other existing programs) and add many more features -A simple TUI client for `transmission-daemon`. +A simple TUI client for the `transmission-cli`. - Written in `bash`. - ## Dependencies - `bash` @@ -19,3 +19,9 @@ A simple TUI client for `transmission-daemon`. 2. Run `tormix`. ## Features +- Autocomplete of torrent ids to start, pause or remove them +- Autocomplete of local paths to add new torrent +- Customizable color themes +- Smoother interface (as few screen redraws as possible + +... More to come diff --git a/tormix.1 b/tormix.1 index 8035f9d..c4b2ba4 100644 --- a/tormix.1 +++ b/tormix.1 @@ -13,6 +13,10 @@ is a TUI (terminal user interface) written in pure bash, created to provide supp program. It makes easy the actions of adding, removing, starting and pausing torrents, while providing a clean interface with customizable colors. +.SH USAGE +1. start 'transmission-daemon' + +2. run 'tormix' .SH COLORS After the installation, all available color themes are placed in the directory .I $HOME/.config/tormix/themes/