From 5768b4a60b6ee84f4741fe952bb4f8ff4181f4a9 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Mon, 23 Dec 2019 20:21:07 +0100 Subject: updated README --- README.md | 37 +++++++++++++++++++++++++++++++++++++ about.html | 13 +++++++++++++ 2 files changed, 50 insertions(+) diff --git a/README.md b/README.md index 8631ccd..eb1de9b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,40 @@ subtitle: 'An openrc service dedicated to Thinkpads X200' Overview ======== +x200-my is a simple openrc script primarily designed to make the +distinctive whining noise of Thinkpads X200 disappear. But it can +also be used on other laptops. +It is written to be used on [Hyperbola +GNU/Linux-libre](https://www.hyperbola.info) but it should work on +other Arch-based + openrc distributions. + +Privacy Settings +---------------- +It also provides a “Privacy settings” section: if `enable_privacy` is +set to `true`, then the wired internet interface that may or may not +be connected to the internet can have its MAC address spoofed at +startup. (The wireless interfaces must also be spoofed, but this can +be handled by wpa_supplicant.) Additionally, x200-my will delete +`/etc/dhcpcd.duid`, which will make `dhcpcd` generate a new DUID-LLT +based file with an updated timestamp and the link-layer address of the +network interface that is connected to the DHCP device at the time +that the DUID is generated. + +Backup +------ +Finally x200-my has the ability to backup essential files or +directories—for instance a backup disk mounted inside the dock. Of +course, the backup process is triggered on certain conditions +only: +1. The option must be enabled in the `/etc/conf.d/x200-my` file +2. The disk must be mounted +3. An (empty) `dobackup` file must be present in the backup directory. + +Then, once these conditions are met, the backup process is triggered +whenever the service is stopped. It additionally generates a list of +installed packages in case the disk should die and everything should +be reinstalled. License and Disclamer ===================== @@ -31,3 +64,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA Installation ============ +1. Clone this repository locally +2. Do `makepkg` +3. Install the generated x200-my as root with `pacman -U` +4. Edit `/etc/conf.d/x200-my` diff --git a/about.html b/about.html index c1d9e2b..536b739 100644 --- a/about.html +++ b/about.html @@ -15,11 +15,24 @@

Robert Alessi

Overview

+

x200-my is a simple openrc script primarily designed to make the distinctive whining noise of Thinkpads X200 disappear. But it can also be used on other laptops.

+

It is written to be used on Hyperbola GNU/Linux-libre but it should work on other Arch-based + openrc distributions.

+

Privacy Settings

+

It also provides a “Privacy settings” section: if enable_privacy is set to true, then the wired internet interface that may or may not be connected to the internet can have its MAC address spoofed at startup. (The wireless interfaces must also be spoofed, but this can be handled by wpa_supplicant.) Additionally, x200-my will delete /etc/dhcpcd.duid, which will make dhcpcd generate a new DUID-LLT based file with an updated timestamp and the link-layer address of the network interface that is connected to the DHCP device at the time that the DUID is generated.

+

Backup

+

Finally x200-my has the ability to backup essential files or directories—for instance a backup disk mounted inside the dock. Of course, the backup process is triggered on certain conditions only: 1. The option must be enabled in the /etc/conf.d/x200-my file 2. The disk must be mounted 3. An (empty) dobackup file must be present in the backup directory.

+

Then, once these conditions are met, the backup process is triggered whenever the service is stopped. It additionally generates a list of installed packages in case the disk should die and everything should be reinstalled.

License and Disclamer

x200-my - An openrc service dedicated to Thinkpads X200 Copyright (C) 2019 Robert Alessi alessi@robertalessi.net

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Installation

+
    +
  1. Clone this repository locally
    2. +
  2. Do makepkg
    3. +
  3. Install the generated x200-my as root with pacman -U
    4. +
  4. Edit /etc/conf.d/x200-my
    5. +
-- cgit v1.2.3