]>
Commit | Line | Data |
---|---|---|
af5ec5a2 SS |
1 | .\" Hey, EMACS: -*- nroff -*- |
2 | .\" First parameter, NAME, should be all caps | |
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | |
4 | .\" other parameters are allowed: see man(7), man(1) | |
5 | .TH ETHER-WAKE 8 "March 31, 2003" "Scyld" | |
6 | .\" Please adjust this date whenever revising the manpage. | |
7 | .\" | |
8 | .\" Some roff macros, for reference: | |
9 | .\" .nh disable hyphenation | |
10 | .\" .hy enable hyphenation | |
11 | .\" .ad l left justify | |
12 | .\" .ad b justify to both left and right margins | |
13 | .\" .nf disable filling | |
14 | .\" .fi enable filling | |
15 | .\" .br insert line break | |
16 | .\" .sp <n> insert n+1 empty lines | |
17 | .\" for manpage-specific macros, see man(7) | |
18 | .SH NAME | |
19 | ether-wake \- A tool to send a Wake-On-LAN "Magic Packet" | |
20 | .SH SYNOPSIS | |
21 | .B ether-wake | |
22 | .RI [ options ] " Host-ID" | |
23 | .SH DESCRIPTION | |
24 | This manual page documents the usage of the | |
25 | .B ether-wake | |
26 | command. | |
27 | .PP | |
28 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and | |
29 | .\" \fI<whatever>\fP escape sequences to invoke bold face and italics, | |
30 | .\" respectively. | |
31 | \fBether-wake\fP is a program that generates and transmits a Wake-On-LAN | |
32 | (WOL) "Magic Packet", used for restarting machines that have been | |
33 | soft-powered-down (ACPI D3-warm state). It generates the standard | |
34 | AMD Magic Packet format, optionally with a password included. The | |
35 | single required parameter is a station (MAC) address or a host ID that can | |
36 | be translated to a MAC address by an | |
37 | .BR ethers (5) | |
38 | database specified in | |
39 | .BR nsswitch.conf (5) | |
40 | . | |
41 | .SH OPTIONS | |
42 | \fBether-wake\fP needs a single dash (´-´) in front of options. | |
43 | A summary of options is included below. | |
44 | .TP | |
45 | .B \-b | |
46 | Send the wake-up packet to the broadcast address. | |
47 | .TP | |
48 | .B \-D | |
49 | Increase the Debug Level. | |
50 | .TP | |
51 | .B \-i ifname | |
52 | Use interface ifname instead of the default "eth0". | |
53 | .TP | |
54 | .B \-p passwd | |
55 | Append a four or six byte password to the packet. Only a few adapters | |
56 | need or support this. A six byte password may be specified in Ethernet hex | |
57 | format (00:22:44:66:88:aa) or four byte dotted decimal (192.168.1.1) format. | |
58 | A four byte password must use the dotted decimal format. | |
59 | ||
60 | .TP | |
61 | .B \-V | |
62 | Show the program version information. | |
63 | ||
64 | .SH EXIT STATUS | |
65 | This program returns 0 on success. | |
66 | A permission failures (e.g. run as a non-root user) results in an exit | |
67 | status of 2. Unrecognized or invalid parameters result in an exit | |
68 | status of 3. Failure to retrieve network interface information or send | |
69 | a packet will result in an exit status of 1. | |
70 | ||
71 | .SH SEE ALSO | |
72 | .BR arp (8). | |
73 | .br | |
74 | .SH SECURITY | |
75 | On some non-Linux systems dropping root capability allows the process to be | |
76 | dumped, traced or debugged. | |
77 | If someone traces this program, they get control of a raw socket. | |
78 | Linux handles this safely, but beware when porting this program. | |
79 | .SH AUTHOR | |
80 | The ether-wake program was written by Donald Becker at Scyld Computing | |
81 | Corporation for use with the Scyld(\*(Tm) Beowulf System. |