From 3bf9cab570a422d069a361b82a1ca4a14985b524 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joaqu=C3=ADn=20Ignacio=20Aramend=C3=ADa?= Date: Sun, 1 Jan 2012 18:12:30 -0300 Subject: [PATCH] Updated readme --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9f37a2c..d9efbc3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ *Migrated from https://github.com/Lekensteyn/acpi-stuff* +About +----- + bbswitch is a kernel module which automatically detects the required ACPI calls for two kinds of Optimus laptops. It has been verified to work with "real" Optimus and "legacy" Optimus laptops (at least, that is how I call them). The @@ -19,7 +22,10 @@ detect the correct handle preceding _DSM and has some built-in safeguards: disabled again if that was the case before suspending. Hibernation should work, but it not tested. -To use it, build the module first (kernel headers are required): +Build +----- + +Build the module (kernel headers are required): make Then load it (requires root privileges, i.e. `sudo`): @@ -29,14 +35,23 @@ If your card is supported, there should be no error. Otherwise, you get a "No such device" (ENODEV) error. Check your kernel log (dmesg) for more information. -Usage (`#` means "run with root privileges, i.e. run it prefixed with `sudo `): +### DKMS support + +inside the "dkms" directory a file is provided for dkms support. Note that the +kernel version must be changed. + +Usage +----- -Get the status: +bbswitch has three commands to check the card status and switching +(`#` means "run with root privileges, i.e. run it prefixed with `sudo `): + +### Get the status: # cat /proc/acpi/bbswitch 0000:01:00.0 ON -Turn the card off, respectively on: +### Turn the card off, respectively on: # tee /proc/acpi/bbswitch <<