File: apmsleep.1

package info (click to toggle)
apmd 3.2.2-15
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 508 kB
  • sloc: ansic: 2,884; makefile: 594; sh: 192
file content (110 lines) | stat: -rw-r--r-- 4,025 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
.\" apmsleep.1
.\"
.TH APMSLEEP 1 "January 2004" "" ""
.SH NAME
apmsleep \- go into suspend or standby mode and wake-up later
.SH SYNOPSIS
.B apmsleep
[\-sSnwhVd] [\-\-suspend] [\-\-standby] [\-\-noapm]
[\-\-wait] [\-\-precise] [\-\-help]  [\-\-version] [\-\-debug]
[+]hh:mm
.SH DESCRIPTION
Some computers, especially laptops, can wake-up from a low-power suspend
to DRAM mode using the Real-time-clock (RTC) chip. 
.B Apmsleep
can be used to set the alarm time in the RTC and to go into suspend or
standby mode. An interrupt from the RTC causes the computer to wake-up.
The program detects this event, by waiting for a leap in the kernel time
and terminates successfully. If no time leap occurs within one minute, or 
something goes wrong, the exit value will be non-zero. 
.PP
The wake-up time can be specified in two formats:
.PP
.B +hh:mm
specifies a relative offset to the current time. The computer
will suspend for exactly hh hours and mm minutes plus a few seconds
to wake up.  On some laptops, the timing is not completely accurate so it
may be a few minutes (or more?) late.
.PP
.B hh:mm
specifies absolute 
.B local 
time in 24-hour format. The time stored in the RTC is not important.
You may change the time zone used, with
the TZ environment variable as usual. Daylight saving time is
not obeyed in this version, but might be in a future release.
.B WARNING:
Do not close cover of laptop after suspending the laptop with apmsleep.
Most laptops overheat when running with closed cover.
.PP
Energy conservation with APM is little for a desktop. Turning of the
screen will save 1/2, going into standby with drives turned off will 
save another 1/6th of the current.
.TP
.B \-V, \-\-version
Print the
.B apmsleep
program version and exit immediately.
.TP
.B \-s, \-\-suspend
Put the machine into suspend mode if possible (default). On my laptop,
suspend mode turns off everything except the memory. 
.TP
.B \-S, \-\-standby
Put the machine into standby mode if possible. On my laptop, standby mode
turns off screen, hard disk, and CPU.
.TP
.B \-w, \-\-wait
Wait indefinitely for the time leap.
.TP
.B \-p, \-\-precise
Wait for alarm time to match actual time. Do not wait for time leap.
This might be useful even without APM.
.TP
.B \-n, \-\-noapm
Do not call apm bios to suspend computer, just set the alarm clock
and wait for time leap indefinitely.
.TP
.B \-d, \-\-debug
Print some information about what is going on.
.SH REQUIRED SYSTEM CONFIGURATION
.TP
.B Kernel
The special character device /dev/rtc must exist and the kernel needs
to be compiled with APM and RTC support.
.TP
.B BIOS
The computer must have the 'suspend to RAM'
feature enabled in the BIOS; 'suspend to Disk' will not work, because the
computer is turned off completely. You do not need to enable the ALARM
timer, it will be activated by apmsleep. On some boards, you can configure
which interrupts can be used to awake from suspend mode. If you have such
a board, you might want to make sure that keyboard (IRQ 1) and RTC (IRQ 8) 
are among those interrupts. If your computer does not wake up, try to
enable 'modem ring' in the BIOS, even if you do not have a modem.
.TP
.B Privileges
The program must be run as root or have the SUID attribute set 
(see chmod(1)).
.PP
.SH BUGS
Apmsleep cannot detect which event terminated the suspension. Possible
events are: keyboard or mouse activity, modem ring, alarm from RTC, any
other interrupt. Sometimes, the time leap is not detected properly 
(causing a wrong exit value).

Should use APM BIOS calls to set alarm clock (not yet supported by
kernel).

This program was tested on a Winbook XL laptop (Pentium) only. 
It may not function on your hardware.
.SH AUTHOR
Written by Peter Englmaier (ppe@mpe.mpg.de) and may be freely
distributed under the terms of the GNU General Public License.  The
code is based on Paul Gortmacher's RTC test/example program.  There is
ABSOLUTELY NO WARRANTY for this program.  The current maintainer is
Peter Englmaier.
.SH "SEE ALSO"
.BR xapm (1),
.BR apmd (8).