[quickstart] Import v1.00r1 released on 2008/03/06
[quickstart] / quickstart / README
1 **********************************************************
2 * quickstart.c - ACPI Direct App Launch Driver for Linux *
3 *            Vista(TM) calls this Hotstart(TM)           *
4 *            http://quickstart.sourceforge.net           *
5 **********************************************************
6
7 WHAT IS IT?
8   >>The Windows Vista(TM) operating system provides built-in support
9   for a fast system startup experience that boots or resumes directly
10   into media or other applications.
11   This support, called direct application launch, is possible on PCs
12   that are running Windows Vista by making simple changes to platform
13   firmware and underlying platform wake circuitry.<<
14
15 * With the introduction of Vista Microsoft launched a new ACPI
16   ?specification? to allow computers in sleep/off states to boot 
17   directly into multimedia applications by only pressing buttons.
18 * This driver provides support to these devices allowing userspace
19   scripts to launch multimedia applications based on which button
20   was pressed.
21
22 HOW IT WORKS:
23 * When the system boots, the driver receives an ACPI event telling
24   which button was used to power the system on. Then, the driver exports
25   this information to sysfs allowing userspace scripts to know the
26   button name. This also applies to memory suspend and other power
27   saving states.
28
29 EXAMPLE:
30 * File buttons shows a list of supported hot buttons.
31   $ cat /sys/devices/platform/quickstart/buttons
32   QBTN
33   DBTN
34   MUBN
35   PIBN
36   WEBN
37   LVBN
38   VOBN
39
40 * File pressed_button shows the hot button name used to power/resume the system.
41   You can also write "none" to it to reset.
42   $ cat /sys/devices/platform/quickstart/pressed_button
43   none
44
45 * NOTE: If you load the module with enable_runtime_btns=1 runtime keypresses
46   (hotkeys) will be reported through kernel messages. If this works for you
47   please report on the mailing list.
48
49 WHAT FOR?
50 * Mobile and Media Center Linux distributors could use this to enrich
51   their linux experience.
52 * It's easy to make an alternate init script that checks if some button
53   was pressed and launch the appropriate application without having to
54   load the entire system.
55 * Here are some ideas.. It's up to you!
56
57 DEPENDENCIES:
58 * You will need CONFIG_ACPI enabled on your kernel.
59
60 INSTALL
61 * Unpack
62   tar -xvjf quickstart-{version}.tar.bz2
63 * Compile and install
64   cd quickstart; make && make install
65 * Copy quickstart and quickstart.desktop into ~/.config/autostart to
66   get your applications launched when your session starts.
67
68 REFERENCES
69 * http://download.microsoft.com/download/9/c/5/9c5b2167-8017-4bae-9fde-d599bac8184a/DirAppLaunch_Vista.doc