From 610b2529d2213a70e3d1153a9baf046c22f298b9 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Wed, 11 Mar 2020 19:57:46 +0100 Subject: Clean up plugin READMEs and a few plugins - fasd - history - mercurial - pylint - repo - yii2 --- plugins/wakeonlan/README | 29 ----------------------------- plugins/wakeonlan/README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 29 deletions(-) delete mode 100644 plugins/wakeonlan/README create mode 100644 plugins/wakeonlan/README.md (limited to 'plugins/wakeonlan') diff --git a/plugins/wakeonlan/README b/plugins/wakeonlan/README deleted file mode 100644 index 16fdd4587..000000000 --- a/plugins/wakeonlan/README +++ /dev/null @@ -1,29 +0,0 @@ -This plugin provides a wrapper around the "wakeonlan" tool available from most -distributions' package repositories, or from the following website: - -http://gsd.di.uminho.pt/jpo/software/wakeonlan/ - -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 -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 - -The available device names will be autocompleted, so: - -# wake - -...will suggest "leto", along with any other configuration files that were -placed in the ~/.wakeonlan directory. - -For more information regarding the configuration file format, check the -wakeonlan man page. diff --git a/plugins/wakeonlan/README.md b/plugins/wakeonlan/README.md new file mode 100644 index 000000000..3fcb6d7f1 --- /dev/null +++ b/plugins/wakeonlan/README.md @@ -0,0 +1,43 @@ +# wakeonlan + +This plugin provides a wrapper around the "wakeonlan" tool available from most +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) +``` + +## Usage + +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 +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: + +```console +$ wake leto +``` + +The available device names will be autocompleted, so: + +```console +$ wake +``` + +...will suggest "leto", along with any other configuration files that were +placed in the ~/.wakeonlan directory. + +For more information regarding the configuration file format, check the +wakeonlan man page. -- cgit v1.2.3-70-g09d2