summaryrefslogtreecommitdiff
path: root/plugins/wakeonlan
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
commit610b2529d2213a70e3d1153a9baf046c22f298b9 (patch)
tree75278ef17f12844d6810a40250b4f93abd5dd86c /plugins/wakeonlan
parentff6d111d793970fc522dd3743367a4c3c46f5fc2 (diff)
downloadzsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.gz
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.bz2
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.zip
Clean up plugin READMEs and a few plugins
- fasd - history - mercurial - pylint - repo - yii2
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.