4 watch-my-terminal is a little utility that enables people to watch your
5 terminal using just a web browser. This is achieved by having ``script`` send
6 its log to a tiny web server (thank you node.js) with realtime updates helped
7 along by the socket.io library.
9 The terminal emulation is far from complete, but sufficient to correctly render
10 vim (with color, etc), less, man, ls --color, etc. when run in
17 To run watch-my-terminal, you'll need coffeescript and a node library called
18 socket.io. socket.io depends on several other node libraries, so it's
19 recommended to install it with npm.
21 1. Install coffeescript and npm with your package manager. On debian-family
22 distros that would look something like this:
24 apt-get install coffee-script npm
26 2. Download socket.io (into a sub-directory of this folder.) First make sure
27 you cd into the watch-my-terminal directory (where you should see the
28 package.json file for watch-my-terminal) and then execute:
32 The other dependency is "script" which in installed by default on pretty much
33 all Linux installations. I've heard that there is an old BSD version which is
36 I have only tested this on debian unstable. Please contact jason@jasonwoof.com
37 if you are aware of what different or additional steps are required for other
44 For many programs to render correctly, you'll need to configure
45 watch-my-terminal to use the exact same dimensions as your terminal. Run this:
49 and then edit server.coffee. At the top you will see where you can set the
50 number of lines and columns, and (if you wish) change the port.
56 To start making your terminal viewable, cd to this directory, and run:
60 Then test that it's working by opening up http://localhost:2218/ in your
61 favorite web browser (assuming your favorite web-browser does javascript.)
63 watch-my-terminal listens on all your ip addresses by default, so your terminal
64 contents are now accessible to the whole network. Also, you can replace
65 "localhost" in that link with something that points at your computer, and share
66 the link with others on your network (or the internet if you're not
70 Feedback, Questions, Bugs, etc.
71 ===============================
73 Please direct your questions, statements, interjections, etc to the author:
75 Jason Woofenden <jason@jasonwoof.com>