diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
@@ -7,7 +7,40 @@ subtitle: 'An openrc service dedicated to Thinkpads X200' | |||
7 | 7 | ||
8 | Overview | 8 | Overview |
9 | ======== | 9 | ======== |
10 | x200-my is a simple openrc script primarily designed to make the | ||
11 | distinctive whining noise of Thinkpads X200 disappear. But it can | ||
12 | also be used on other laptops. | ||
10 | 13 | ||
14 | It is written to be used on [Hyperbola | ||
15 | GNU/Linux-libre](https://www.hyperbola.info) but it should work on | ||
16 | other Arch-based + openrc distributions. | ||
17 | |||
18 | Privacy Settings | ||
19 | ---------------- | ||
20 | It also provides a “Privacy settings” section: if `enable_privacy` is | ||
21 | set to `true`, then the wired internet interface that may or may not | ||
22 | be connected to the internet can have its MAC address spoofed at | ||
23 | startup. (The wireless interfaces must also be spoofed, but this can | ||
24 | be handled by wpa_supplicant.) Additionally, x200-my will delete | ||
25 | `/etc/dhcpcd.duid`, which will make `dhcpcd` generate a new DUID-LLT | ||
26 | based file with an updated timestamp and the link-layer address of the | ||
27 | network interface that is connected to the DHCP device at the time | ||
28 | that the DUID is generated. | ||
29 | |||
30 | Backup | ||
31 | ------ | ||
32 | Finally x200-my has the ability to backup essential files or | ||
33 | directories—for instance a backup disk mounted inside the dock. Of | ||
34 | course, the backup process is triggered on certain conditions | ||
35 | only: | ||
36 | 1. The option must be enabled in the `/etc/conf.d/x200-my` file | ||
37 | 2. The disk must be mounted | ||
38 | 3. An (empty) `dobackup` file must be present in the backup directory. | ||
39 | |||
40 | Then, once these conditions are met, the backup process is triggered | ||
41 | whenever the service is stopped. It additionally generates a list of | ||
42 | installed packages in case the disk should die and everything should | ||
43 | be reinstalled. | ||
11 | 44 | ||
12 | License and Disclamer | 45 | License and Disclamer |
13 | ===================== | 46 | ===================== |
@@ -31,3 +64,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |||
31 | 64 | ||
32 | Installation | 65 | Installation |
33 | ============ | 66 | ============ |
67 | 1. Clone this repository locally | ||
68 | 2. Do `makepkg` | ||
69 | 3. Install the generated x200-my as root with `pacman -U` | ||
70 | 4. Edit `/etc/conf.d/x200-my` | ||