forked from mirrors/prezto
1ff9421f7b
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.
Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.
While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
38 lines
1,021 B
Markdown
38 lines
1,021 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
|