jpopelka / rpms / net-tools

Forked from rpms/net-tools 4 years ago
Clone
1c4448
.\"                                      Hey, EMACS: -*- nroff -*-
1c4448
.\" First parameter, NAME, should be all caps
1c4448
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
1c4448
.\" other parameters are allowed: see man(7), man(1)
1c4448
.TH ETHER-WAKE 8 "March 31, 2003" "Scyld"
1c4448
.\" Please adjust this date whenever revising the manpage.
1c4448
.\"
1c4448
.\" Some roff macros, for reference:
1c4448
.\" .nh        disable hyphenation
1c4448
.\" .hy        enable hyphenation
1c4448
.\" .ad l      left justify
1c4448
.\" .ad b      justify to both left and right margins
1c4448
.\" .nf        disable filling
1c4448
.\" .fi        enable filling
1c4448
.\" .br        insert line break
1c4448
.\" .sp <n>    insert n+1 empty lines
1c4448
.\" for manpage-specific macros, see man(7)
1c4448
.SH NAME
1c4448
ether-wake \- A tool to send a Wake-On-LAN "Magic Packet"
1c4448
.SH SYNOPSIS
1c4448
.B ether-wake
1c4448
.RI [ options ] " Host-ID"
1c4448
.SH DESCRIPTION
1c4448
This manual page documents the usage of the
1c4448
.B ether-wake
1c4448
command.
1c4448
.PP
1c4448
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
1c4448
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, 
1c4448
.\" respectively.
1c4448
\fBether-wake\fP is a program that generates and transmits a Wake-On-LAN 
1c4448
(WOL) "Magic Packet", used for restarting machines that have been
1c4448
soft-powered-down (ACPI D3-warm state). It generates the standard
1c4448
AMD Magic Packet format, optionally with a password included.  The
1c4448
single required parameter is a station (MAC) address or a host ID that can
1c4448
be translated to a MAC address by an
1c4448
.BR ethers (5)
1c4448
database specified in
1c4448
.BR nsswitch.conf (5)
1c4448
.
1c4448
.SH OPTIONS
1c4448
\fBether-wake\fP needs a single dash (´-´) in front of options.
1c4448
A summary of options is included below.
1c4448
.TP
1c4448
.B \-b
1c4448
Send the wake-up packet to the broadcast address.
1c4448
.TP
1c4448
.B \-D
1c4448
Increase the Debug Level.
1c4448
.TP
1c4448
.B \-i ifname
1c4448
Use interface ifname instead of the default "eth0".
1c4448
.TP
1c4448
.B \-p passwd
1c4448
Append a four or six byte password to the packet. Only a few adapters
1c4448
need or support this. A six byte password may be specified in Ethernet hex
1c4448
format (00:22:44:66:88:aa) or four byte dotted decimal (192.168.1.1) format.
1c4448
A four byte password must use the dotted decimal format.
1c4448
1c4448
.TP
1c4448
.B \-V
1c4448
Show the program version information.
1c4448
1c4448
.SH EXIT STATUS
1c4448
This program returns 0 on success.
1c4448
A permission failures (e.g. run as a non-root user) results in an exit
1c4448
status of 2.  Unrecognized or invalid parameters result in an exit
1c4448
status of 3.  Failure to retrieve network interface information or send
1c4448
a packet will result in an exit status of 1.
1c4448
1c4448
.SH SEE ALSO
1c4448
.BR arp (8).
1c4448
.br
1c4448
.SH SECURITY
1c4448
On some non-Linux systems dropping root capability allows the process to be
1c4448
dumped, traced or debugged.
1c4448
If someone traces this program, they get control of a raw socket.
1c4448
Linux handles this safely, but beware when porting this program.
1c4448
.SH AUTHOR
1c4448
The ether-wake program was written by Donald Becker at Scyld Computing
1c4448
Corporation for use with the Scyld(\*(Tm) Beowulf System.