Browse code

Adding README file for the wakeonlan plugin

Paul Gideon Dann authored on 20/09/2011 at 08:26:32
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,29 @@
0
+This plugin provides a wrapper around the "wakeonlan" tool available from most
1
+distributions' package repositories, or from the following website:
2
+
3
+http://gsd.di.uminho.pt/jpo/software/wakeonlan/
4
+
5
+In order to use this wrapper, create the ~/.wakeonlan directory, and place in
6
+that directory one file for each device you would like to be able to wake. Give
7
+the file a name that describes the device, such as its hostname. Each file
8
+should contain a line with the mac address of the target device and the network
9
+broadcast address.
10
+
11
+For instance, there might be a file ~/.wakeonlan/leto with the following
12
+contents:
13
+
14
+00:11:22:33:44:55:66 192.168.0.255
15
+
16
+To wake that device, use the following command:
17
+
18
+# wake leto
19
+
20
+The available device names will be autocompleted, so:
21
+
22
+# wake <tab>
23
+
24
+...will suggest "leto", along with any other configuration files that were
25
+placed in the ~/.wakeonlan directory.
26
+
27
+For more information regarding the configuration file format, check the
28
+wakeonlan man page.