Browse files

Adding README file for the wakeonlan plugin

  • Loading branch information...
1 parent e94039d commit 7ba54d197dac8d5ae380271259ba4d8843f01b4f @giddie giddie committed Sep 20, 2011
Showing with 29 additions and 0 deletions.
  1. +29 −0 plugins/wakeonlan/README
@@ -0,0 +1,29 @@
+This plugin provides a wrapper around the "wakeonlan" tool available from most
+distributions' package repositories, or from the following website:
+In order to use this wrapper, create the ~/.wakeonlan directory, and place in
+that directory one file for each device you would like to be able to wake. Give
+the file a name that describes the device, such as its hostname. Each file
+should contain a line with the mac address of the target device and the network
+broadcast address.
+For instance, there might be a file ~/.wakeonlan/leto with the following
+To wake that device, use the following command:
+# wake leto
+The available device names will be autocompleted, so:
+# wake <tab>
+...will suggest "leto", along with any other configuration files that were
+placed in the ~/.wakeonlan directory.
+For more information regarding the configuration file format, check the
+wakeonlan man page.

0 comments on commit 7ba54d1

Please sign in to comment.