stow/oh-my-zsh/.oh-my-zsh/plugins/wakeonlan/README.md

   1 # wakeonlan
   2
   3 This plugin provides a wrapper around the "wakeonlan" tool available from most
   4 distributions' package repositories, or from [the following website](https://github.com/jpoliv/wakeonlan).
   5
   6 To use it, add `wakeonlan` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... wakeonlan)
  10 ```
  11
  12 ## Usage
  13
  14 In order to use this wrapper, create the `~/.wakeonlan` directory, and place in
  15 that directory one file for each device you would like to be able to wake. Give
  16 the file a name that describes the device, such as its hostname. Each file
  17 should contain a line with the mac address of the target device and the network
  18 broadcast address.
  19
  20 For instance, there might be a file ~/.wakeonlan/leto with the following
  21 contents:
  22
  23 ```
  24 00:11:22:33:44:55:66 192.168.0.255
  25 ```
  26
  27 To wake that device, use the following command:
  28
  29 ```console
  30 $ wake leto
  31 ```
  32
  33 The available device names will be autocompleted, so:
  34
  35 ```console
  36 $ wake <tab>
  37 ```
  38
  39 ...will suggest "leto", along with any other configuration files that were
  40 placed in the ~/.wakeonlan directory.
  41
  42 For more information regarding the configuration file format, check the
  43 wakeonlan man page.