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