1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-23 02:18:00 +00:00
prezto/modules/wakeonlan/README.md
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://').
2021-05-05 12:21:04 -05:00

38 lines
1021 B
Markdown

# Wake-on-LAN
This module provides a wrapper around the [wakeonlan][1] 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:
```conf
00:11:22:33:44:55:66 192.168.0.255
```
To wake that device, use the following command:
```console
wake leto
```
For more information on the configuration file format, read the
[wakeonlan man page][2].
## Authors
*The authors of this module should be contacted via [issue tracker][3].*
- [Paul Dann](https://github.com/giddie)
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: http://gsd.di.uminho.pt/jpo/software/wakeonlan/
[2]: https://man.cx/wakeonlan
[3]: https://github.com/sorin-ionescu/prezto/issues