Merge branch 'master' of ssh://woller-gui.git.sourceforge.net/gitroot/woller-gui...

[woller] / README.txt

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..b8153ff
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,91 @@
+Woller
+======
+
+Table of Contents
+
+1. About
+2. Theory
+3. Usage
+
+
+
+1. ABOUT
+
+
+Woller is a program I made out of curiosity to QT and me being lazy
+walking to my MythTV box to power it up. WOL (Wake On LAN [1]) is a feature
+that allows computers to be powered on by sending them a network package,
+instead of pushing a power button. So Woller is a "remote power button"
+for computers.
+
+During the years I've been using WOL (Wake On LAN) feature of computers to
+wake them up when I need them.  But this time I wanted a GUI button to
+press instead of command line application like the ones I've previously
+used. I chose QT due just the heck of checking out new framework, and
+since it can be easily adapted to any Linux like (Meego) internet tablets,
+Mac, Symbian or even Windows. Anything which runs QT.
+
+Since I was aiming for a desktop widget, I preferred simplicity. I wanted
+only minimalistic UI, thus Woller only has a list and button. At least for
+now.
+
+If anyone else finds use for it, feel free to modify it and please send me
+back any enhancements you may create. Also fixes are welcome.
+
+The code is available at sf.net [2] under GPL license [3].
+
+BR,
+
+ Ilkka Tengvall
+
+
+[1] http://en.wikipedia.org/wiki/Wake-on-LAN
+[2] http://sourceforge.net/projects/woller-gui
+[3] http://www.gnu.org/licenses/
+
+
+2. THEORY
+
+
+WOL is a network device feature, where network device listens to network
+for magic packets. When such packet arrives, it wakes up the device it's
+connected to (host). Usually the network device is PC's or laptops network
+card, and the device to be woken up is the PC or laptop.
+
+To create such a magic packet, one needs to know the MAC address of the
+network device. Woller then creates the magic packet using the given MAC
+address. The network device catches the packet, and wakes up the host.
+
+
+
+3. USAGE
+
+
+3.1. Find your hosts MAC address.
+
+This depends on your operating system. In unixes (linux, mac) it is found
+by issuing command "ifconfig" on command line. It might be also shown in
+hosts BIOS settings. Google for "find MAC address".
+
+
+3.2. Make sure WOL is enabled in target host
+
+Go to your hosts BIOS and look for setting "Wake on network", "Wake on
+LAN" or similar entry in bios and enable it.
+
+
+3.3 Configure Woller
+
+Start Woller, and go to configure dialog by selecting "Configure targets"
+from the drop down menu. That brings you to host list, where you press
+"Add" button. In the dialog that opens, give target host name, and the MAC
+address (e.g. format "00:11:22:aa:bb:cc", and optionally ip network
+address. The network address is optional. Save changes.
+
+3.4. Wake it up!
+
+Wake up the configured target by selecting it from the menu, and press the
+button next to it. Check that your host starts up.
+
+
+