xref: /freebsd/usr.sbin/wake/wake.8 (revision 2f02600abfddfc4e9f20dd384a2e729b451e16bd)
1.\"
2.\" $FreeBSD$
3.\"
4.\" Copyright (c) 2009, 2010 Marc Balmer <marc@msys.ch>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd December 27, 2009
19.Dt WAKE 8
20.Os
21.Sh NAME
22.Nm wake
23.Nd send Wake on LAN frames to hosts on a local Ethernet network
24.Sh SYNOPSIS
25.Nm
26.Op Ar interface
27.Ar lladdr
28.Op Ar lladdr ...
29.Sh DESCRIPTION
30The
31.Nm
32program is used to send Wake on LAN (WoL) frames over a local
33Ethernet network to one or more hosts using their link layer (hardware)
34addresses.
35WoL functionality is generally enabled in a machine's BIOS
36and can be used to power on machines from a remote system without
37having physical access to them.
38.Pp
39.Ar interface
40is an Ethernet interface of the local machine and is used to send the
41Wake on LAN frames over it.
42If there is only one Ethernet device available that is up and running, then the
43.Ar interface
44argument can be omitted.
45.Ar lladdr
46is the link layer address of the remote machine.
47This can be specified as the actual hardware address
48(six hexadecimal numbers separated by colons)
49or as a hostname entry in
50.Pa /etc/ethers .
51.Nm
52accepts multiple
53.Ar lladdr
54addresses.
55Link layer addresses can be determined and set using
56.Xr ifconfig 8 .
57.Sh FILES
58.Bl -tag -width "/etc/ethers" -compact
59.It Pa /etc/ethers
60Ethernet host name data base.
61.El
62.Sh SEE ALSO
63.Xr ethers 5 ,
64.Xr ifconfig 8
65.Sh AUTHORS
66.Nm
67was written by
68.Ar Marc Balmer Aq marc@msys.ch .
69