History

Indrajit Raychaudhuri d80e393f78 general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').	4 years ago
..
functions	Add comments into each of the function files to make them easier to find	8 years ago
README.md	general: Reformat documentation with better formatting and wording	4 years ago

Indrajit Raychaudhuri d80e393f78 general: Reformat documentation with better formatting and wording

General purpose reformating and rewording in (a few places). This should
also make markdown linting happier.

Prefer back-ticks wherever useful and use `console` for code blocks to
be executed on terminal.

Also, update references links wherever possible (including update from
'http://' to 'https://').

functions

Add comments into each of the function files to make them easier to find

README.md

general: Reformat documentation with better formatting and wording

README.md

Wake-on-LAN

This module provides a wrapper around the wakeonlan tool.

Usage

To use this wrapper, create the ~/.wakeonlan directory, and place in it 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

For more information on the configuration file format, read the wakeonlan man page.

Authors

The authors of this module should be contacted via issue tracker.