aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md67
1 files changed, 48 insertions, 19 deletions
diff --git a/README.md b/README.md
index 9e721e3..a923139 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,44 @@
-# A console client for the BitTorrent client [Transmission](http://www.transmissionbt.com/ "Transmission Homepage").
+## About
-**Download the latest version for [Transmission 1.90-2.52](http://github.com/fagga/transmission-remote-cli/raw/master/transmission-remote-cli.py).**
+A console client for the BitTorrent client [Transmission](http://www.transmissionbt.com/ "Transmission Homepage").
-**Also available in Debian Wheezy / Ubuntu Quantal: `apt-get install transmission-remote-cli`**
-## Modules
+## Distributions
+
+- [Arch Linux](https://aur.archlinux.org/packages.php?K=transmission-remote-cli)
+- [Debian](http://packages.debian.org/search?keywords=transmission-remote-cli)
+- [Fedora](https://admin.fedoraproject.org/pkgdb/acls/list/?searchwords=transmission-remote-cli)
+- [OpenSUSE](http://software.opensuse.org/package/transmission-remote-cli?search_term=transmission-remote-cli)
+- [Ubuntu](http://packages.ubuntu.com/search?keywords=transmission-remote-cli)
+
+
+## Requirements
For Python 2.5 or older, you need [simplejson](http://pypi.python.org/pypi/simplejson/) which should be
packaged in any Linux distribution. The Debian/Ubuntu package is called
`python-simplejson`.
### Optional Modules (you don't need them but they add features):
+
- GeoIP: Guess which country peers come from.
- adns: Resolve IPs to host names.
Debian/Ubuntu package names are `python-adns` and `python-geoip`.
-## Connection information
+## Usage
+
+### Connection information
+
Authentication and host/port can be set via command line with one
of these patterns:
-`$ transmission-remote-cli.py -c homeserver`
-`$ transmission-remote-cli.py -c homeserver:1234`
-`$ transmission-remote-cli.py -c johndoe:secretbirthday@homeserver`
-`$ transmission-remote-cli.py -c johndoe:secretbirthday@homeserver:1234`
+`$ transmission-remote-cli -c homeserver`
+`$ transmission-remote-cli -c homeserver:1234`
+`$ transmission-remote-cli -c johndoe:secretbirthday@homeserver`
+`$ transmission-remote-cli -c johndoe:secretbirthday@homeserver:1234`
You can write this (and other) stuff into a configuration file:
-`$ transmission-remote-cli.py -c johndoe:secretbirthday@homeserver:1234 --create-config`
+`$ transmission-remote-cli -c johndoe:secretbirthday@homeserver:1234 --create-config`
No configuration file is created automatically, you have to do this
somehow. However, if the file exists, it is re-written when trcli exits to
@@ -35,10 +47,11 @@ editing your configuration file.
If you don't like the default configuration file path
~/.config/transmission-remote-cli/settings.cfg, change it:
-`$ transmission-remote-cli.py -f ~/.trclirc --create-config`
+`$ transmission-remote-cli -f ~/.trclirc --create-config`
+
+### Calling transmission-remote
-## Calling transmission-remote
transmission-remote-cli forwards all arguments after '--' to
transmission-remote. This is useful if your daemon requires authentication
and/or doesn't listen on the default localhost:9091 for
@@ -47,21 +60,37 @@ the config file and forwards them on to transmission-remote, along with your
arguments.
Some examples:
-`$ transmission-remote-cli.py -- -l`
-`$ transmission-remote-cli.py -- -t 2 -i`
-`$ transmission-remote-cli.py -- -as`
+`$ transmission-remote-cli -- -l`
+`$ transmission-remote-cli -- -t 2 -i`
+`$ transmission-remote-cli -- -as`
-## Add torrents
+### Add torrents
+
If you provide only one command line argument and it doesn't start with '-',
it's treated like a torrent file/URL and submitted to the daemon via
transmission-remote. This is useful because you can instruct Firefox to open
-torrent files with transmission-remote-cli.py.
+torrent files with transmission-remote-cli.
+
+`$ transmission-remote-cli http://link/to/file.torrent`
+`$ transmission-remote-cli path/to/some/torrent-file`
-`$ transmission-remote-cli.py http://link/to/file.torrent`
-`$ transmission-remote-cli.py path/to/some/torrent-file`
+
+## Screenshots
+
+![Main window - full, v1.3](transmission-remote-cli/blob/master/screenshots/screenshot-mainfull-v1.3.png)
+
+![Main window - compact, v1.3](transmission-remote-cli/blob/master/screenshots/screenshot-maincompact-v1.3.png)
+
+![Info window, v1.3](transmission-remote-cli/blob/master/screenshots/screenshot-details-v1.3.png)
+
+
+## Copyright
+
+Released under the GPLv3 license, see [COPYING](transmission-remote-cli/blob/master/COPYING) for details.
## Contact
+
Feel free to request new features or provide bug reports.
You can find my email address [here](http://github.com/fagga).