prezto/modules/wakeonlan/README.md

# 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
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-04 01:59:31 +00:00			`# Wake-on-LAN`
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
			`This module provides a wrapper around the [wakeonlan][1] tool.`

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-04 01:59:31 +00:00			`## Usage`
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
general: Update documentation better qualifying runcom paths 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. 2021-05-05 17:59:01 +00:00			To use this wrapper, create the _`~/.wakeonlan`_ directory, and place in it one
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00			`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`
general: Update documentation better qualifying runcom paths 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. 2021-05-05 17:59:01 +00:00			_`~/.wakeonlan/leto`_ with the following contents:
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes 2017-07-21 01:07:29 +00:00			```conf
			`00:11:22:33:44:55:66 192.168.0.255`
			```
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
			`To wake that device, use the following command:`

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-04 01:59:31 +00:00			```console
			`wake leto`
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes 2017-07-21 01:07:29 +00:00			```
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
			`For more information on the configuration file format, read the`
			`[wakeonlan man page][2].`

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-04 01:59:31 +00:00			`## Authors`
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
general: Update documentation better qualifying runcom paths 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. 2021-05-05 17:59:01 +00:00			`_The authors of this module should be contacted via [issue tracker][3]._`
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
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-04 01:59:31 +00:00			`- [Paul Dann](https://github.com/giddie)`
			`- [Sorin Ionescu](https://github.com/sorin-ionescu)`
[Fix #150] Convert wakeonlan README to Markdown 2012-04-16 12:15:14 +00:00
			`[1]: http://gsd.di.uminho.pt/jpo/software/wakeonlan/`
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-04 01:59:31 +00:00			`[2]: https://man.cx/wakeonlan`
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv 2012-09-03 20:08:39 +00:00			`[3]: https://github.com/sorin-ionescu/prezto/issues`