summaryrefslogtreecommitdiff
path: root/plugins/wakeonlan
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2020-04-24 20:54:33 -0600
committerTuowen Zhao <ztuowen@gmail.com>2020-04-24 20:54:33 -0600
commitc197ad40f1dca62fd1e0e555e7bfc84e39f31223 (patch)
tree5c1e753e0ff2cb9d0e08a699f17352225b9ef9f1 /plugins/wakeonlan
parent0b67340fd2fe9330d8487491e1983ad1a111fb2b (diff)
parent2560f04982dfc2693221c7c0f47d1a71df09a794 (diff)
downloadzsh-c197ad40f1dca62fd1e0e555e7bfc84e39f31223.tar.gz
zsh-c197ad40f1dca62fd1e0e555e7bfc84e39f31223.tar.bz2
zsh-c197ad40f1dca62fd1e0e555e7bfc84e39f31223.zip
Merge branch 'master' of https://github.com/ohmyzsh/ohmyzsh
Diffstat (limited to 'plugins/wakeonlan')
-rw-r--r--plugins/wakeonlan/README.md (renamed from plugins/wakeonlan/README)24
1 files changed, 19 insertions, 5 deletions
diff --git a/plugins/wakeonlan/README b/plugins/wakeonlan/README.md
index 16fdd4587..3fcb6d7f1 100644
--- a/plugins/wakeonlan/README
+++ b/plugins/wakeonlan/README.md
@@ -1,9 +1,17 @@
+# wakeonlan
+
This plugin provides a wrapper around the "wakeonlan" tool available from most
-distributions' package repositories, or from the following website:
+distributions' package repositories, or from [the following website](https://github.com/jpoliv/wakeonlan).
+
+To use it, add `wakeonlan` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... wakeonlan)
+```
-http://gsd.di.uminho.pt/jpo/software/wakeonlan/
+## Usage
-In order to use this wrapper, create the ~/.wakeonlan directory, and place in
+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
@@ -12,15 +20,21 @@ 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
+```console
+$ wake leto
+```
The available device names will be autocompleted, so:
-# wake <tab>
+```console
+$ wake <tab>
+```
...will suggest "leto", along with any other configuration files that were
placed in the ~/.wakeonlan directory.