aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2019-12-23 20:21:07 +0100
committerRobert Alessi <alessi@robertalessi.net>2019-12-23 20:21:07 +0100
commit5768b4a60b6ee84f4741fe952bb4f8ff4181f4a9 (patch)
treea83b79e29f6fa28546dabf5cd2d1c154491b458f
parenta449cb5e5650da60d45102aeeeeebafa883291c1 (diff)
downloadx200-my-5768b4a60b6ee84f4741fe952bb4f8ff4181f4a9.tar.gz
updated README
-rw-r--r--README.md37
-rw-r--r--about.html13
2 files changed, 50 insertions, 0 deletions
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'
7 7
8Overview 8Overview
9======== 9========
10x200-my is a simple openrc script primarily designed to make the
11distinctive whining noise of Thinkpads X200 disappear. But it can
12also be used on other laptops.
10 13
14It is written to be used on [Hyperbola
15GNU/Linux-libre](https://www.hyperbola.info) but it should work on
16other Arch-based + openrc distributions.
17
18Privacy Settings
19----------------
20It also provides a “Privacy settings” section: if `enable_privacy` is
21set to `true`, then the wired internet interface that may or may not
22be connected to the internet can have its MAC address spoofed at
23startup. (The wireless interfaces must also be spoofed, but this can
24be handled by wpa_supplicant.) Additionally, x200-my will delete
25`/etc/dhcpcd.duid`, which will make `dhcpcd` generate a new DUID-LLT
26based file with an updated timestamp and the link-layer address of the
27network interface that is connected to the DHCP device at the time
28that the DUID is generated.
29
30Backup
31------
32Finally x200-my has the ability to backup essential files or
33directories—for instance a backup disk mounted inside the dock. Of
34course, the backup process is triggered on certain conditions
35only:
361. The option must be enabled in the `/etc/conf.d/x200-my` file
372. The disk must be mounted
383. An (empty) `dobackup` file must be present in the backup directory.
39
40Then, once these conditions are met, the backup process is triggered
41whenever the service is stopped. It additionally generates a list of
42installed packages in case the disk should die and everything should
43be reinstalled.
11 44
12License and Disclamer 45License and Disclamer
13===================== 46=====================
@@ -31,3 +64,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
31 64
32Installation 65Installation
33============ 66============
671. Clone this repository locally
682. Do `makepkg`
693. Install the generated x200-my as root with `pacman -U`
704. 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 @@
15<h2 class="author">Robert Alessi</h2> 15<h2 class="author">Robert Alessi</h2>
16</div> 16</div>
17<h1 id="overview">Overview</h1> 17<h1 id="overview">Overview</h1>
18<p>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.</p>
19<p>It is written to be used on <a href="https://www.hyperbola.info">Hyperbola GNU/Linux-libre</a> but it should work on other Arch-based + openrc distributions.</p>
20<h2 id="privacy-settings">Privacy Settings</h2>
21<p>It also provides a “Privacy settings” section: if <code>enable_privacy</code> is set to <code>true</code>, 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 <code>/etc/dhcpcd.duid</code>, which will make <code>dhcpcd</code> 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.</p>
22<h2 id="backup">Backup</h2>
23<p>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 <code>/etc/conf.d/x200-my</code> file 2. The disk must be mounted 3. An (empty) <code>dobackup</code> file must be present in the backup directory.</p>
24<p>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.</p>
18<h1 id="license-and-disclamer">License and Disclamer</h1> 25<h1 id="license-and-disclamer">License and Disclamer</h1>
19<p>x200-my - An openrc service dedicated to Thinkpads X200 Copyright (C) 2019 Robert Alessi <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p> 26<p>x200-my - An openrc service dedicated to Thinkpads X200 Copyright (C) 2019 Robert Alessi <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p>
20<p>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.</p> 27<p>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.</p>
21<p>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.</p> 28<p>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.</p>
22<p>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.</p> 29<p>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.</p>
23<h1 id="installation">Installation</h1> 30<h1 id="installation">Installation</h1>
31<ol style="list-style-type: decimal">
32<li>Clone this repository locally</li>
33<li>Do <code>makepkg</code></li>
34<li>Install the generated x200-my as root with <code>pacman -U</code></li>
35<li>Edit <code>/etc/conf.d/x200-my</code></li>
36</ol>
24</body> 37</body>
25</html> 38</html>