Skip to content

Instantly share code, notes, and snippets.

@yasulab

yasulab/README.md

Created February 18, 2013 08:33
Show Gist options
  • Save yasulab/4975909 to your computer and use it in GitHub Desktop.
Save yasulab/4975909 to your computer and use it in GitHub Desktop.
Download ZIP
Broadcast your terminal to the world using ScreenX TV
Raw
README.md

Screenshot

ScreenX TV is a web service that lets you broadcast your terminal to the world. It is often used for a hackathon, lecture, and opensource activity. And this gist explains how to broacdcast your terminal using it.

1. Preparation

To install screenxtv command, you can broadcast your terminal anytime, and there are two ways, Ruby and GCC. In both ways, you need to use screen before installing screenxtv command.

To install screenx

  • Mac OS X: brew install screen
  • Linux (Ubuntu or Debian): sudo aptitude install screen
  • Windows: Download and install screen in Cygwin.

Ruby Client (recommended)

  1. You need Ruby 1.9 (or higher) and RubyGems.

  2. Then, install screenxtv using RubyGems.

    gem install screenxtv

  3. From now, you can broadcast your terminal by just typing screenxtv.

GCC Client

  1. Download the client from GitHub.

    git clone https://github.com/tompng/screenxtv-gcc-client.git

  2. Then, move to the downloaded directory, and compile it.

    cd screenxtv-gcc-client

    make

  3. From now, you can broadcast your terminal by running the client:

    ./screenxtv-gcc-client

2. Start Broadcasting

  1. Run the client:

    • Ruby: screenxtv
    • GCC: ./screenxtv-gcc-client

  2. Fill in the given items (e.g. URL, title).

    ss-start

  3. Finally, press Enter to start broadcasting.

3. Stop/Resume Broadcasting

  1. Exit from screen, then your broadcasting will stop.

    exit

    NOTE: ScreenX TV holds your session for 10 minutes after the exit.

    ss-stop

  2. If you'd like to resume, re-run the client program.

    ss-resume

Private Broadcasting (Ruby client only)

From Ruby client ver. 0.0.9, you can privately broadcast your terminal by adding -p or --private option. In private broadcasting, people who has the link can only access. Also, see --help message for other options:

Usage: 
  screenxtv [options]

Options:
    -u, [--url]    # Select a url (e.g. yasulab, tompng)
    -c, [--color]	# Select a color (options: black/white/green/novel)
    -t, [--title]	# Select a title (e.g. Joe's Codestream)
    -r, [--reset]	# Reset your default configuration (e.g. url, color, title)
    -f CONFIG_FILE	# Path to a preset configuration 
    -p, [--private]	# Broadcast your terminal privately (anyone who has the link can access)
    -h, [--help]	# Show this help message and quit
    -v, [--version]	# Show ScreenX TV Ruby Client version number and quit

Unique URL / Comment Log

You don't have to create an user account to broadcast, but if you create, you'll get an unique URL that cannot be used for anyone but you. Also, the comments you get in your broadcasting will remain after stop broadcasting.

user-account

If you have an idea / want us a feature to add

Create an issue, send a pull request, or directly send us an email.

Sample Issue

issue

Related Repositories and Articles

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment