Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 111 lines (71 sloc) 4.342 kb
a3905fa @fagga fan(hit(shit))
authored
1 **Please don't request or submit new features that would add more than a
2 handful (literally!) of lines of code.**
3
4 Given the messy implementation, adding functionality either causes new bugs
5 that nobody wants to fix or it adds cruft that I won't be able to understand
6 two weeks later because there's already so much cruft that mostly works but
7 without any regards to the bigger picture. (Also, there is not much of a
8 bigger picture, it's hacks all the way down (and maybe even up). Imagine a
9 house that is hold together by the corpses in the drywall.)
10
11 **This doesn't mean the project is dead.**
12 I'll always accept any bugfixes. (Unless they cause new bugs.)
13
3c9f5e3 Rewrite readme file
Anton Larionov authored
14 ## About
84b8fd5 added README.md
fagga authored
15
3c9f5e3 Rewrite readme file
Anton Larionov authored
16 A console client for the BitTorrent client [Transmission](http://www.transmissionbt.com/ "Transmission Homepage").
1ff4001 Add link for 2.40 branch
Benjamin authored
17
84b8fd5 added README.md
fagga authored
18
3c9f5e3 Rewrite readme file
Anton Larionov authored
19 ## Distributions
20
c3ade57 @t-8ch now in the official arch repos
t-8ch authored
21 - [Arch Linux](https://www.archlinux.org/packages/community/any/transmission-remote-cli/)
432b554 Fix readme file
Anton Larionov authored
22 - [Debian](http://packages.debian.org/search?keywords=transmission-remote-cli)
6cca205 @fagga Fix README link to Fedora package
authored
23 - [Fedora](https://admin.fedoraproject.org/pkgdb/package/transmission-remote-cli/)
432b554 Fix readme file
Anton Larionov authored
24 - [OpenSUSE](http://software.opensuse.org/package/transmission-remote-cli?search_term=transmission-remote-cli)
25 - [Ubuntu](http://packages.ubuntu.com/search?keywords=transmission-remote-cli)
3c9f5e3 Rewrite readme file
Anton Larionov authored
26
27
28 ## Requirements
80d412d explain which modules are needed/made use of
fagga authored
29
651eca1 @logaritmisk Updated readme
logaritmisk authored
30 For Python 2.5 or older, you need [simplejson](http://pypi.python.org/pypi/simplejson/) which should be
80d412d explain which modules are needed/made use of
fagga authored
31 packaged in any Linux distribution. The Debian/Ubuntu package is called
32 `python-simplejson`.
33
34 ### Optional Modules (you don't need them but they add features):
3c9f5e3 Rewrite readme file
Anton Larionov authored
35
80d412d explain which modules are needed/made use of
fagga authored
36 - GeoIP: Guess which country peers come from.
37 - adns: Resolve IPs to host names.
a99d46d @gabrielrcp Added messages better informing the user in case of failure to copy text
gabrielrcp authored
38 - [xerox](https://pypi.python.org/pypi/xerox): Copy magnet links to the system clipboard. You will also need either xclip on linux or pbcopy on OS X for this to work.
80d412d explain which modules are needed/made use of
fagga authored
39
af9f1a3 just testing githubs markdown parser
fagga authored
40 Debian/Ubuntu package names are `python-adns` and `python-geoip`.
80d412d explain which modules are needed/made use of
fagga authored
41
42
3c9f5e3 Rewrite readme file
Anton Larionov authored
43 ## Usage
44
45 ### Connection information
46
33664b4 broken markup
fagga authored
47 Authentication and host/port can be set via command line with one
84b8fd5 added README.md
fagga authored
48 of these patterns:
841ab43 Remove .py extension
Benjamin authored
49 `$ transmission-remote-cli -c homeserver`
50 `$ transmission-remote-cli -c homeserver:1234`
51 `$ transmission-remote-cli -c johndoe:secretbirthday@homeserver`
52 `$ transmission-remote-cli -c johndoe:secretbirthday@homeserver:1234`
84b8fd5 added README.md
fagga authored
53
54 You can write this (and other) stuff into a configuration file:
841ab43 Remove .py extension
Benjamin authored
55 `$ transmission-remote-cli -c johndoe:secretbirthday@homeserver:1234 --create-config`
84b8fd5 added README.md
fagga authored
56
ff9c75f force config file permissions to 0600
fagga authored
57 No configuration file is created automatically, you have to do this
5bab850 just more README changes
fagga authored
58 somehow. However, if the file exists, it is re-written when trcli exits to
59 remember some settings. This means you shouldn't have trcli running when
ff9c75f force config file permissions to 0600
fagga authored
60 editing your configuration file.
84b8fd5 added README.md
fagga authored
61
62 If you don't like the default configuration file path
390658c more things done
fagga authored
63 ~/.config/transmission-remote-cli/settings.cfg, change it:
841ab43 Remove .py extension
Benjamin authored
64 `$ transmission-remote-cli -f ~/.trclirc --create-config`
20d2387 support all options transmission-remote supports (see README.md)
fagga authored
65
66
3c9f5e3 Rewrite readme file
Anton Larionov authored
67 ### Calling transmission-remote
68
20d2387 support all options transmission-remote supports (see README.md)
fagga authored
69 transmission-remote-cli forwards all arguments after '--' to
70 transmission-remote. This is useful if your daemon requires authentication
71 and/or doesn't listen on the default localhost:9091 for
b266c2f show access to transmission-remote options in --help
fagga authored
72 instructions. transmission-remote-cli reads HOST:PORT and authentication from
73 the config file and forwards them on to transmission-remote, along with your
74 arguments.
20d2387 support all options transmission-remote supports (see README.md)
fagga authored
75
2317010 stupid markup
fagga authored
76 Some examples:
841ab43 Remove .py extension
Benjamin authored
77 `$ transmission-remote-cli -- -l`
78 `$ transmission-remote-cli -- -t 2 -i`
79 `$ transmission-remote-cli -- -as`
ea1402d done stuff
fagga authored
80
81
3c9f5e3 Rewrite readme file
Anton Larionov authored
82 ### Add torrents
83
58db426 single-argument calls submit torrent to daemon
fagga authored
84 If you provide only one command line argument and it doesn't start with '-',
85 it's treated like a torrent file/URL and submitted to the daemon via
86 transmission-remote. This is useful because you can instruct Firefox to open
841ab43 Remove .py extension
Benjamin authored
87 torrent files with transmission-remote-cli.
58db426 single-argument calls submit torrent to daemon
fagga authored
88
841ab43 Remove .py extension
Benjamin authored
89 `$ transmission-remote-cli http://link/to/file.torrent`
90 `$ transmission-remote-cli path/to/some/torrent-file`
58db426 single-argument calls submit torrent to daemon
fagga authored
91
92
3c9f5e3 Rewrite readme file
Anton Larionov authored
93 ## Screenshots
94
af4b40b @alanrburns fixed Screenshots
alanrburns authored
95 ![Main window - full, v1.3](https://github.com/fagga/transmission-remote-cli/raw/master/screenshots/screenshot-mainfull-v1.3.png)
07ec94e @diffycat Update README.md
diffycat authored
96
af4b40b @alanrburns fixed Screenshots
alanrburns authored
97 ![Main window - compact, v1.3](https://github.com/fagga/transmission-remote-cli/raw/master/screenshots/screenshot-maincompact-v1.3.png)
07ec94e @diffycat Update README.md
diffycat authored
98
af4b40b @alanrburns fixed Screenshots
alanrburns authored
99 ![Info window, v1.3](https://github.com/fagga/transmission-remote-cli/raw/master/screenshots/screenshot-details-v1.3.png)
3c9f5e3 Rewrite readme file
Anton Larionov authored
100
101
102 ## Copyright
103
93cbcd8 @fagga Fix COPYING link
authored
104 Released under the GPLv3 license, see [COPYING](COPYING) for details.
3c9f5e3 Rewrite readme file
Anton Larionov authored
105
106
390658c more things done
fagga authored
107 ## Contact
3c9f5e3 Rewrite readme file
Anton Larionov authored
108
84b8fd5 added README.md
fagga authored
109 Feel free to request new features or provide bug reports.
ea1402d done stuff
fagga authored
110 You can find my email address [here](http://github.com/fagga).
Something went wrong with that request. Please try again.