xref: /netbsd-src/usr.sbin/wakeonlan/wakeonlan.8 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\" $NetBSD: wakeonlan.8,v 1.5 2018/05/14 06:52:33 wiz Exp $
2.\"
3.\" Copyright (c) 2009 - 2017 Marc Balmer <marc@msys.ch>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd May 13, 2018
18.Dt WAKEONLAN 8
19.Os
20.Sh NAME
21.Nm wakeonlan
22.Nd send Wake on LAN frames to hosts on a local Ethernet network
23.Sh SYNOPSIS
24.Nm
25.Op Ar interface
26.Ar lladdr
27.Op Ar lladdr ...
28.Sh DESCRIPTION
29The
30.Nm
31program is used to send Wake on LAN (WoL) frames over a local
32Ethernet network to one or more hosts using their link layer (hardware)
33addresses.
34WoL functionality is generally enabled in a machine's BIOS
35and can be used to power on machines from a remote system without
36having physical access to them.
37.Pp
38.Ar interface
39is an Ethernet interface of the local machine and is used to send the
40Wake on LAN frames over it.
41If there is only one Ethernet device available that is up and running, then the
42.Ar interface
43argument can be omitted.
44.Ar lladdr
45is the link layer address of the remote machine.
46This can be specified as a hardware address
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 /etc/ethers
58Ethernet host name data base.
59.El
60.Sh SEE ALSO
61.Xr ethers 5 ,
62.Xr ifconfig 8
63.Sh HISTORY
64The
65.Nm
66utility first appeared in
67.Nx 6.0 .
68.Sh AUTHORS
69.Nm
70was written by
71.An Marc Balmer
72.Aq marc@msys.ch .
73