aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2021-02-13 19:05:05 +0100
committerRobert Alessi <alessi@robertalessi.net>2021-02-13 19:05:05 +0100
commitfaf5cd914d7e8f1dcf766410f571ea4fbbe46453 (patch)
treec75b5c7fd341af9ba11d3cf000aaa98a37c8d8b1 /about.html
parentb8188a48e11409fc747bea065e1a1099547ed300 (diff)
downloadmy-x200-faf5cd914d7e8f1dcf766410f571ea4fbbe46453.tar.gz
moved up Intallation section in README.md
Diffstat (limited to 'about.html')
-rw-r--r--about.html28
1 files changed, 14 insertions, 14 deletions
diff --git a/about.html b/about.html
index e7244d5..fc09fec 100644
--- a/about.html
+++ b/about.html
@@ -27,6 +27,20 @@
27<h1 id="overview">Overview</h1> 27<h1 id="overview">Overview</h1>
28<p><code>my-x200</code> is a simple script primarily designed to make the distinctive whining noise of Thinkpads X200 disappear. But it can also be used on other laptops.</p> 28<p><code>my-x200</code> is a simple script primarily designed to make the distinctive whining noise of Thinkpads X200 disappear. But it can also be used on other laptops.</p>
29<p>It is written to be used on <a href="https://www.devuan.org/">Devuan GNU+Linux</a> but it should work on other Debian-based distributions.</p> 29<p>It is written to be used on <a href="https://www.devuan.org/">Devuan GNU+Linux</a> but it should work on other Debian-based distributions.</p>
30<h1 id="installation">Installation</h1>
31<ol type="1">
32<li>Clone this repository locally.</li>
33<li>Do <code>make debian</code>.</li>
34<li>Install the generated <code>my-x200</code> <code>.deb</code> package as root with <code>dpkg -i</code>.</li>
35<li>Edit <code>/etc/default/my-x200</code>.</li>
36</ol>
37<p>Alternatively, a <code>.deb</code> file ready to be installed and its associated <code>.dsc</code> source package file are provided in this repository. Once these two files and the corresponding two source files <code>.orig.tar.gz</code> and <code>debian.tar.xz</code> are downloaded in the same directory, it is advisable to verify the signature like so:—</p>
38<ol type="1">
39<li>Download the <code>my-x200</code> master tarball: <a href="http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz" class="uri">http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz</a></li>
40<li>Import the developer’s <a href="https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7">public PGP key</a>, like so: <code>gpg --recv-keys 8085C8C7</code></li>
41<li>Verify the signature: <code>dscverify --keyring ~/.gnupg/pubring.gpg my-x200_&lt;ver&gt;.dsc</code> (Replace <code>&lt;ver&gt;</code> with the actual release number.)</li>
42</ol>
43<p>For a good GPG cheat sheet, see <a href="https://guides.library.illinois.edu/data_encryption/gpgcheatsheet">here</a>.</p>
30<h2 id="configuration">Configuration</h2> 44<h2 id="configuration">Configuration</h2>
31<p>Once installed, <code>my-x200</code> is configured by editing <a href="http://git.robertalessi.net/my-x200/tree/my-x200.confd"><code>/etc/default/my-x200</code></a>.</p> 45<p>Once installed, <code>my-x200</code> is configured by editing <a href="http://git.robertalessi.net/my-x200/tree/my-x200.confd"><code>/etc/default/my-x200</code></a>.</p>
32<p>It is also possible to leave <code>/etc/default/my-200</code> untouched. In this case, <code>my-x200</code> can source its configuration from one or more <code>*.conf</code> files written in a specific directory <code>/etc/default/my-x200.d/</code> which is to be created. This is the recommended method for these files cannot be affected by subsequent updates.</p> 46<p>It is also possible to leave <code>/etc/default/my-200</code> untouched. In this case, <code>my-x200</code> can source its configuration from one or more <code>*.conf</code> files written in a specific directory <code>/etc/default/my-x200.d/</code> which is to be created. This is the recommended method for these files cannot be affected by subsequent updates.</p>
@@ -42,20 +56,6 @@
42<li>An (empty) <code>dobackup</code> file must be present in the backup directory.</li> 56<li>An (empty) <code>dobackup</code> file must be present in the backup directory.</li>
43</ol> 57</ol>
44<p>Then, once these conditions are met, the backup process is triggered whenever the service is stopped.</p> 58<p>Then, once these conditions are met, the backup process is triggered whenever the service is stopped.</p>
45<h1 id="installation">Installation</h1>
46<ol type="1">
47<li>Clone this repository locally.</li>
48<li>Do <code>make debian</code>.</li>
49<li>Install the generated <code>my-x200</code> <code>.deb</code> package as root with <code>dpkg -i</code>.</li>
50<li>Edit <code>/etc/default/my-x200</code>.</li>
51</ol>
52<p>Alternatively, a <code>.deb</code> file ready to be installed and its associated <code>.dsc</code> source package file are provided in this repository. Once these two files and the corresponding two source files <code>.orig.tar.gz</code> and <code>debian.tar.xz</code> are downloaded in the same directory, it is advisable to verify the signature like so:—</p>
53<ol type="1">
54<li>Download the <code>my-x200</code> master tarball: <a href="http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz" class="uri">http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz</a></li>
55<li>Import the developer’s <a href="https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7">public PGP key</a>, like so: <code>gpg --recv-keys 8085C8C7</code></li>
56<li>Verify the signature: <code>dscverify --keyring ~/.gnupg/pubring.gpg my-x200_&lt;ver&gt;.dsc</code> (Replace <code>&lt;ver&gt;</code> with the actual release number.)</li>
57</ol>
58<p>For a good GPG cheat sheet, see <a href="https://guides.library.illinois.edu/data_encryption/gpgcheatsheet">here</a>.</p>
59<h2 id="use-and-recommended-configuration">Use and recommended configuration</h2> 59<h2 id="use-and-recommended-configuration">Use and recommended configuration</h2>
60<blockquote> 60<blockquote>
61<p>The command <code>rc-update</code> that is used below refers to <code>openrc</code>. Other init systems use other commands. Please adapt.</p> 61<p>The command <code>rc-update</code> that is used below refers to <code>openrc</code>. Other init systems use other commands. Please adapt.</p>