-
Notifications
You must be signed in to change notification settings - Fork 3
/
tormix.1
75 lines (63 loc) · 2.9 KB
/
tormix.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.\" Manpage for tormix.
.\" Contact [email protected] to correct errors or typos.
.TH TORMIX 1 "Feb 2019" "tormix" "User Commands"
.SH NAME
.B tormix
\- A TUI for the transmission-cli
.SH SYNOPSIS
.B tormix
.SH DESCRIPTION
.B tormix
is a TUI (terminal user interface) written in pure bash, created to provide support for the
.B transmission-cli
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/
These themes will be available for selection with the (t)heme option.
If you want to create your own theme, just
copy one of the provided themes, change the values of the relevant variables and move it in the same
directory with a new name (You should not modify existing themes, as they will be overwritten after the next update
(for compatibilty reasons with the new version).
.B tormix
reads the configuration of the file
.I $HOME/.config/tormix/.saved.theme
after being launched, which is
configured automatically each time you change a theme from the TUI, so you should not modify it.
If this file does not exist (e.g. first launch of the program), tormix will use the default theme.
If for some reason theming does not function correctly (e.g. after an update), it is advised to remove
.I $HOME/.config/tormix/.saved.theme
.SH SEE ALSO
transmission-cli(1), transmission-remote(1), transmission-daemon(1)
.SH BUGS
No known bugs.
Report issues at:
- https://github.com/ckardaris/tormix/issues
.SH AUTHORS
Charalampos Kardaris ([email protected])
Dylan Araps ([email protected]) (initial code)
.SH COPYRIGHT
The MIT License (MIT)
Copyright (c) 2016-2018 Dylan Araps
Copyright (c) 2019 Charalampos Kardaris
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.