This is wol.info, produced by makeinfo version 4.0f from wol.texi.

INFO-DIR-SECTION Net utilities
START-INFO-DIR-ENTRY
* wol                           Wake On LAN client.
END-INFO-DIR-ENTRY

   This file documents wol 0.6.0, the Wake On LAN client.

   Copyright 2001-2002 Thomas Krennwallner <krennwallner@aon.at>

   Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled "GNU
Free Documentation License".


File: wol.info,  Node: Top,  Next: Description,  Prev: (dir),  Up: (dir)

wol - Wake On LAN client
************************

   This manual gives you an introduction into `wol', the Wake On LAN
client.  It remotely turns on computers that supports Magic Packet(TM)
(1) technology (also known as Wake On LAN).

   Some workstations support SecureON(TM) (2) password feature. These
machines only wake up if you provide the correct password. `wol' also
provides this feature.

   See <http://ahh.sourceforge.net/wol/> for updates and further
readings.

   This edition documents version 0.6.0.

* Menu:

* Description::                   Description
* Options::                       Options to wol
* Examples::                      Examples for program invocation

   ---------- Footnotes ----------

   (1) Magic Packet is a trademark of Advanced Micro Devices, Inc.

   (2) SecureON is a trademark of Digital Equipment Corporation.


File: wol.info,  Node: Description,  Next: Options,  Prev: Top,  Up: Top

Description
***********

   `wol' broadcasts so-called Magic Packet(TM) frames across a network
to wake up hardware that understands such packets. These are normally
NIC's with Wake On Lan function. To make use of this feature your
motherboard and your power supply have to support Wake On LAN. But
there are still some things needed to have a working Wake On LAN setup.
Most PCI NIC's come with a so-called WOL-connector and a 3 pin wire.
This wire has to be connected from the motherboards WOL connector to
the NIC's. After this basic hardware requirements you have to enable
Wake On LAN in your systems BIOS (or whatever called). If you have a
builtin network card with WOL support, you don't have to wire, enabling
WOL in the BIOS should be enough.

   If you are intending to switch on a computer, you need his `MAC
address'.  This is the 48 bit hardware address of the network card
which is written as x:x:x:x:x:x, where x is a hexadecimal number
between 0 and ff which represents one byte of the address, which is in
network byte order (big-endian).

   `wol' assembles a `hardware address' to a Magic Packet(TM) and sends
it over the network. The Wake On LAN enabled computer provides enough
power for the NIC to listen to the attached network and waits for
arriving Wake On LAN packets. The NIC recognizes the wake up call and
turns on.

   A Magic Packet(TM) consists of a header (6 bytes of 0xff) and 16
times the repetition of the MAC address. The optional SecureON(TM)
password is attached at the end of the packet. So if you want to wake
up the computer with the `hardware address 00:E0:98:13:45:E2', the
corresponding Magic Packet(TM) looks like:

ff   ff   ff   ff   ff   ff
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2
00   E0   98   13   45   E2

   To simplify things `wol' encapsulates such Magic Packets(TM) inside
an UDP packet. This gives various benefits over raw ethernet frames,
one is OS interoperability.

   An example of usage is `wol MAC-ADDRESS' which assembles a Magic
Packet(TM) which is intended to wake up the NIC with hardware address
`MAC-ADDRESS'. See *Note Examples:: for additional examples.


File: wol.info,  Node: Options,  Next: Examples,  Prev: Description,  Up: Top

Options
*******

`-h'
`--help'
     Print a summary of the command line options and exit.

`-V'
`--version'
     Print the version number of `wol' and exit.

`-i xxx.xxx.xxx.xxx'
`--ipaddr==xxx.xxx.xxx.xxx'
     Broadcast packet to this IP address. This is important if your wol
     client is a multihomed host and you want to send only to one
     subnet (default IP address is 255.255.255.255).

`-p NUM'
`--port=NUM'
     Send packet with this destination port. This option is important,
     if a packet filter would block the default destination port 40000.

`-f FILE'
`--file=FILE'
     Read hardware addresses, IP addresses, optional ports and
     SecureON(TM) password from file `FILE'. If `FILE' is "-", read
     from stdin.

`-'
     Read hardware addresses, IP addresses, optional ports and
     SecureON(TM) password from stdin.

`-v'
`--verbose'
     Turns on verbose output.

`-w NUM'
`--wait=NUM'
     Waits NUM milliseconds between Magic Packets(TM). Also known as
     fuse health pack.

`-P PASS'
`--passwd=PASS'
     Send a magic packet with SecureON(TM) password feature. PASS is
     written as x-x-x-x-x-x, where x is a hexadecimal number between 0
     and ff which represents one byte of the password. To set the
     password of your SecureON(TM) capable NIC, you can use ethtool
     <http://www.sourceforge.net/projects/gkernel/>.


File: wol.info,  Node: Examples,  Prev: Options,  Up: Top

Examples
********

`wol 00:4F:49:07:0B:5F 00:4F:50:06:12:4F'
     Sends packet addressed to 255.255.255.255:40000 and is intended to
     wake up hardware address 00:4F:49:07:0B:5F and 00:4F:50:06:12:4F.

`wol -i 192.168.3.255 -p 69 00:4F:49:07:0B:5F'
     Sends packet addressed to 192.168.3.255:69 and is intended to wake
     up hardware address 00:4F:49:07:0B:5F.

`wol --passwd=09-e6-f5-f3-dc-4e 00:4F:49:07:0B:5F'
     Sends packet addressed to 255.255.255.255:40000 with SecureON(TM)
     password 09-e6-f5-f3-dc-4e.

`wol -f /etc/ethers'
     Read hardware addresses and corresponding IP addresses from file
     `/etc/ethers'.

     File looks like:

          Hardware-Address  IP-Address:Port
          Hardware-Address  IP-Address
          # Comment
          Hardware-Address  IP-Address:Port	SecureON-Password

`wol-dhcpdconf < /etc/dhcpd.conf | wol -'
     `wol-dhcpdconf' filters MAC addresses and corresponding IP
     addresses from `/etc/dhcpd.conf' (config file of ISC dhcpd) and
     outputs it in macfile format (native wol format). `wol' sends the
     corresponding Magic Packets(TM).

     A valid dhcp entry:

          host hugo
          {
            hardware ethernet 11:ab:e3:5f:7f:8c;
            fixed-address 10.0.0.1;
          }



Tag Table:
Node: Top700
Ref: Top-Footnote-11501
Ref: Top-Footnote-21569
Node: Description1635
Node: Options4220
Node: Examples5663

End Tag Table
