diff options
| author | Jesse Luehrs <doy@tozt.net> | 2014-09-23 00:32:43 -0400 |
|---|---|---|
| committer | Jesse Luehrs <doy@tozt.net> | 2014-09-23 00:32:43 -0400 |
| commit | 6f67aa8950003962a197ee6c7b92be40e77977d2 (patch) | |
| tree | 10da74d5b60b35eafd4a2569f3919912378e26db /README | |
| parent | 4e4a118c4c441c41cbe50f6f0a2991690ed1bc5c (diff) | |
| download | python-termcast-client-6f67aa8950003962a197ee6c7b92be40e77977d2.tar.gz python-termcast-client-6f67aa8950003962a197ee6c7b92be40e77977d2.zip | |
packaging stuff
Diffstat (limited to 'README')
| -rw-r--r-- | README | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -0,0 +1,22 @@ +# termcast + +This module is a client for the L<http://termcast.org/> service, which allows +broadcasting of a terminal session for remote viewing. It can be installed +either via `pip install termcast_client` or by downloading the standalone +binary +[here](https://raw.githubusercontent.com/doy/python-termcast-client/master/termcast). + +To run it, just run `termcast`. A new shell will open, and it will start +streaming data to the termcast server. You can view the contents by following +the instructions at [termcast.org](http://termcast.org/). + +## Detailed Usage + + termcast [--host <host>] [--port <port>] [--username <username>] + [--password <password>] [command...] + +* `--host` defaults to `noway.ratry.ru` +* `--port` defaults to `31337` +* `--username` defaults to the contents of `$USER` +* `--password` defaults to asdf +* the command defaults to the contents of `$SHELL`, or `/bin/sh` if not set |