From b3560ed26cdb699cd6cb646e3e355cbf148fb9ff Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Sun, 22 Dec 2013 12:50:36 +0100 Subject: [PATCH] lets markdown that readme --- README | 48 +----------------------------------------------- README => README.md | 31 ++++++++++++++++++------------- 2 files changed, 19 insertions(+), 60 deletions(-) rewrite README (100%) mode change 100644 => 120000 copy README => README.md (79%) diff --git a/README b/README deleted file mode 100644 index d2e2bf5..0000000 --- a/README +++ /dev/null @@ -1,47 +0,0 @@ -hdapsd - Hard Drive Active Protection System Daemon -=================================================== - -This is a disk protection user-space daemon. It monitors the acceleration -values through the various motion interfaces and automatically initiates -disk head parking if a fall or sliding of the laptop is detected. - -Currently, the following motion interfaces are supported: - * HDAPS on IBM/Lenovo ThinkPads - * AMS on Apple iBooks and PowerBooks (G4) - * HP3D on Hewlett-Packard laptops - * APPLESMC on Apple MacBooks and MacBooks Pro (Intel) (UNTESTED!) - -1. Compilation --------------- -./configure -make -make install - -2. Usage --------- -hdapsd (it will try to autodetect everything itself) -for more options, please read man hdapsd - -3. Compatibility ----------------- -Since kernel 2.6.28 you don't need to patch your kernel, as support for -IDLE_IMMEDIATE is present in mainline. - NOTE: The new interface only allows IDLE_IMMEDIATE for drives that - announce to be ATA-7 conform. But threre are also drives that - support ATA-6 only but do IDLE_IMMEDIATE fine. For those you - need to force the interface with: - echo -1 > /sys/block/$DISK/device/unload_heads - OR: Call hdapsd like this: hdapsd -f -d $DISK - -For kernels <2.6.28, please have a look at -http://www.thinkwiki.org/wiki/HDAPS#Kernel_patch -and patch your kernel with the appropriate patch before using hdapsd. - -4. mainline hdaps module vs tp_smapi (ThinkPad only) ----------------------------------------------------- -The mainline hdaps module present in Linux kernels does not support all -hdaps-enabled ThinkPads, thus it is recommended to use the one provided -by tp_smapi. -Additionally the tp_smapi version provides a input interface to the data, -which stops hdapsd from polling the data itself all the time, saving your -battery. diff --git a/README b/README new file mode 120000 index 0000000..42061c0 --- /dev/null +++ b/README @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/README b/README.md similarity index 79% copy from README copy to README.md index d2e2bf5..10427b2 100644 --- a/README +++ b/README.md @@ -11,19 +11,20 @@ Currently, the following motion interfaces are supported: * HP3D on Hewlett-Packard laptops * APPLESMC on Apple MacBooks and MacBooks Pro (Intel) (UNTESTED!) -1. Compilation --------------- -./configure -make -make install - -2. Usage --------- +Compilation +----------- + + ./configure + make + make install + +Usage +----- hdapsd (it will try to autodetect everything itself) -for more options, please read man hdapsd +for more options, please read `man hdapsd` -3. Compatibility ----------------- +Compatibility +------------- Since kernel 2.6.28 you don't need to patch your kernel, as support for IDLE_IMMEDIATE is present in mainline. NOTE: The new interface only allows IDLE_IMMEDIATE for drives that @@ -37,11 +38,15 @@ For kernels <2.6.28, please have a look at http://www.thinkwiki.org/wiki/HDAPS#Kernel_patch and patch your kernel with the appropriate patch before using hdapsd. -4. mainline hdaps module vs tp_smapi (ThinkPad only) ----------------------------------------------------- +mainline hdaps module vs tp_smapi (ThinkPad only) +------------------------------------------------- The mainline hdaps module present in Linux kernels does not support all hdaps-enabled ThinkPads, thus it is recommended to use the one provided by tp_smapi. Additionally the tp_smapi version provides a input interface to the data, which stops hdapsd from polling the data itself all the time, saving your battery. + +Travis CI build status +---------------------- +[![Build Status](https://travis-ci.org/evgeni/hdapsd.png?branch=master)](https://travis-ci.org/evgeni/hdapsd) -- 2.11.4.GIT