diff options
| -rw-r--r-- | README.md | 50 | ||||
| -rw-r--r-- | about.html | 28 |
2 files changed, 39 insertions, 39 deletions
| @@ -35,6 +35,31 @@ It is written to be used on [Devuan | |||
| 35 | GNU+Linux](https://www.devuan.org/) but it should work on other | 35 | GNU+Linux](https://www.devuan.org/) but it should work on other |
| 36 | Debian-based distributions. | 36 | Debian-based distributions. |
| 37 | 37 | ||
| 38 | Installation | ||
| 39 | ============ | ||
| 40 | |||
| 41 | 1. Clone this repository locally. | ||
| 42 | 2. Do `make debian`. | ||
| 43 | 3. Install the generated `my-x200` `.deb` package as root with `dpkg | ||
| 44 | -i`. | ||
| 45 | 4. Edit `/etc/default/my-x200`. | ||
| 46 | |||
| 47 | Alternatively, a `.deb` file ready to be installed and its associated | ||
| 48 | `.dsc` source package file are provided in this repository. Once | ||
| 49 | these two files and the corresponding two source files `.orig.tar.gz` | ||
| 50 | and `debian.tar.xz` are downloaded in the same directory, it is | ||
| 51 | advisable to verify the signature like so:— | ||
| 52 | |||
| 53 | 1. Download the `my-x200` master tarball: <http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz> | ||
| 54 | 2. Import the developer's [public PGP | ||
| 55 | key](https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7), | ||
| 56 | like so: `gpg --recv-keys 8085C8C7` | ||
| 57 | 3. Verify the signature: `dscverify --keyring ~/.gnupg/pubring.gpg | ||
| 58 | my-x200_<ver>.dsc` (Replace `<ver>` with the actual release | ||
| 59 | number.) | ||
| 60 | |||
| 61 | For a good GPG cheat sheet, see [here](https://guides.library.illinois.edu/data_encryption/gpgcheatsheet). | ||
| 62 | |||
| 38 | Configuration | 63 | Configuration |
| 39 | ------------- | 64 | ------------- |
| 40 | Once installed, `my-x200` is configured by editing | 65 | Once installed, `my-x200` is configured by editing |
| @@ -77,31 +102,6 @@ course, the backup process is triggered on certain conditions only: | |||
| 77 | Then, once these conditions are met, the backup process is triggered | 102 | Then, once these conditions are met, the backup process is triggered |
| 78 | whenever the service is stopped. | 103 | whenever the service is stopped. |
| 79 | 104 | ||
| 80 | Installation | ||
| 81 | ============ | ||
| 82 | |||
| 83 | 1. Clone this repository locally. | ||
| 84 | 2. Do `make debian`. | ||
| 85 | 3. Install the generated `my-x200` `.deb` package as root with `dpkg | ||
| 86 | -i`. | ||
| 87 | 4. Edit `/etc/default/my-x200`. | ||
| 88 | |||
| 89 | Alternatively, a `.deb` file ready to be installed and its associated | ||
| 90 | `.dsc` source package file are provided in this repository. Once | ||
| 91 | these two files and the corresponding two source files `.orig.tar.gz` | ||
| 92 | and `debian.tar.xz` are downloaded in the same directory, it is | ||
| 93 | advisable to verify the signature like so:— | ||
| 94 | |||
| 95 | 1. Download the `my-x200` master tarball: <http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz> | ||
| 96 | 2. Import the developer's [public PGP | ||
| 97 | key](https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7), | ||
| 98 | like so: `gpg --recv-keys 8085C8C7` | ||
| 99 | 3. Verify the signature: `dscverify --keyring ~/.gnupg/pubring.gpg | ||
| 100 | my-x200_<ver>.dsc` (Replace `<ver>` with the actual release | ||
| 101 | number.) | ||
| 102 | |||
| 103 | For a good GPG cheat sheet, see [here](https://guides.library.illinois.edu/data_encryption/gpgcheatsheet). | ||
| 104 | |||
| 105 | Use and recommended configuration | 105 | Use and recommended configuration |
| 106 | --------------------------------- | 106 | --------------------------------- |
| 107 | > The command `rc-update` that is used below refers to `openrc`. Other | 107 | > The command `rc-update` that is used below refers to `openrc`. Other |
| @@ -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_<ver>.dsc</code> (Replace <code><ver></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_<ver>.dsc</code> (Replace <code><ver></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> |