Skip to content

Commit

Permalink
Adding README file for the wakeonlan plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
giddie committed Sep 20, 2011
1 parent e94039d commit 7ba54d1
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions plugins/wakeonlan/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
This plugin provides a wrapper around the "wakeonlan" tool available from most
distributions' package repositories, or from the following website:

http://gsd.di.uminho.pt/jpo/software/wakeonlan/

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
contents:

00:11:22:33:44:55:66 192.168.0.255

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.