Expand PMF_FN_* macros.
[netbsd-mini2440.git] / usr.sbin / wake / wake.8
blob51f41637254b0e52d69a0de1a0dea863c88292fd
1 .\" $NetBSD: wake.8,v 1.7 2010/01/03 19:04:26 wiz Exp $
2 .\"
3 .\" Copyright (c) 2009, 2010 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 January 4, 2010
18 .Dt WAKE 8
19 .Os
20 .Sh NAME
21 .Nm wake
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
29 The
30 .Nm
31 program is used to send Wake on LAN (WoL) frames over a local
32 Ethernet network to one or more hosts using their link layer (hardware)
33 addresses.
34 WoL functionality is generally enabled in a machine's BIOS
35 and can be used to power on machines from a remote system without
36 having physical access to them.
37 .Pp
38 .Ar interface
39 is an Ethernet interface of the local machine and is used to send the
40 Wake on LAN frames over it.
41 If there is only one Ethernet device available that is up and running, then the
42 .Ar interface
43 argument can be omitted.
44 .Ar lladdr
45 is the link layer address of the remote machine.
46 This can be specified as the actual hardware address
47 (six hexadecimal numbers separated by colons)
48 or as a hostname entry in
49 .Pa /etc/ethers .
50 .Nm
51 accepts multiple
52 .Ar lladdr
53 addresses.
54 Link layer addresses can be determined and set using
55 .Xr ifconfig 8 .
56 .Sh FILES
57 .Bl -tag -width "/etc/ethers" -compact
58 .It /etc/ethers
59 Ethernet host name data base.
60 .El
61 .Sh SEE ALSO
62 .Xr ethers 5 ,
63 .Xr ifconfig 8
64 .Sh AUTHORS
65 .Nm
66 was written by
67 .An Marc Balmer
68 .Aq marc@msys.ch .