sqrtminusone.github.io/public/configs/readme/index.html
2021-11-26 17:10:55 +03:00

384 lines
12 KiB
HTML

<!DOCTYPE html>
<html lang=""><head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>My dotfiles</title>
<meta name="description" content="Freedom is a state of mind">
<meta name="author" content='SqrtMinusOne'>
<link href="https://fonts.googleapis.com/css2?family=Inconsolata:wght@400;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css" integrity="sha512-iBBXm8fW90+nuLcSKlbmrPcLa0OT92xO1BIsZ+ywDWZCvqsWgccV3gFoRBv0z+8dLJgyAHIhR35VZc2oM/gI1w==" crossorigin="anonymous">
<link rel="stylesheet" href="/sass/researcher.min.css">
<link rel="icon" type="image/ico" href="https://sqrtminusone.xyz/favicon.ico">
</head>
<body><div class="container mt-5">
<nav class="navbar navbar-expand-sm flex-column flex-sm-row text-nowrap p-0">
<a class="navbar-brand mx-0 mr-sm-auto" href="https://sqrtminusone.xyz/" title="SqrtMinusOne">
SqrtMinusOne
</a>
<div class="navbar-nav flex-row flex-wrap justify-content-center">
<a class="nav-item nav-link" href="/" title="Index">
Index
</a>
<span class="nav-item navbar-text mx-1">/</span>
<a class="nav-item nav-link" href="/posts/" title="Posts">
Posts
</a>
<span class="nav-item navbar-text mx-1">/</span>
<a class="nav-item nav-link" href="/configs/readme" title="Configs">
Configs
</a>
</div>
</nav>
</div>
<hr>
<div id="content">
<div class="container">
<figure><img src="https://forthebadge.com/images/badges/works-on-my-machine.svg"/>
</figure>
<p>A set of my GNU/Linux configuration files. <a href="https://github.com/SqrtMinusOne/dotfiles">View at GitHub</a>.</p>
<p>The majority of the software is configured with <a href="https://leanpub.com/lit-config/read">literate configuration</a> strategy via Emacs' Org Mode. This way has its advantages and disadvantages, but overall it&rsquo;s pretty nice to keep the configs interweaved with comments in a handful of files.</p>
<p>The files themselves are managed and deployed via <a href="https://yadm.io/">yadm</a>, but I mostly use Org Mode rich noweb whenever I can instead of what yadm offers.</p>
<p>My current GNU/Linux distribution is <a href="https://guix.gnu.org/">GNU Guix</a>. In the context of this repo, Guix allows me to list all the used programs in manifests, which means I have the same set of programs across multiple machines. Look for tables with &ldquo;Guix dependency&rdquo; in the header.</p>
<p>Literate configuration files:</p>
<ul>
<li><a href="/configs/emacs/">Emacs.org</a></li>
<li><a href="/configs/desktop/">Desktop.org</a></li>
<li><a href="/configs/console/">Console.org</a></li>
<li><a href="/configs/guix/">Guix.org</a></li>
<li><a href="/configs/mail/">Mail.org</a></li>
</ul>
<h2 id="programs-used">Programs used</h2>
<p>Some of the notable programs are listed in the table below.</p>
<table>
<thead>
<tr>
<th>Group</th>
<th>Program</th>
<th>Purpose</th>
<th>Status</th>
<th>Documented?</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>console</td>
<td>bash</td>
<td>shell</td>
<td>launches fish :)</td>
<td><a href="/configs/console/">Console.org</a></td>
<td></td>
</tr>
<tr>
<td>console</td>
<td><a href="https://fishshell.com/">fish</a></td>
<td>shell</td>
<td><strong>active</strong></td>
<td><a href="/configs/console/">Console.org</a></td>
<td></td>
</tr>
<tr>
<td>console</td>
<td><a href="https://github.com/starship/starship">starship</a></td>
<td>prompt</td>
<td><strong>active</strong></td>
<td><a href="/configs/console/">Console.org</a></td>
<td></td>
</tr>
<tr>
<td>console</td>
<td><a href="https://github.com/tmux/tmux">tmux</a></td>
<td>terminal multiplexer</td>
<td><strong>active</strong></td>
<td><a href="/configs/console/">Console.org</a></td>
<td></td>
</tr>
<tr>
<td>console</td>
<td><a href="https://github.com/alacritty/alacritty">alacritty</a></td>
<td>terminal emulator</td>
<td><strong>active</strong></td>
<td><a href="/configs/console/">Console.org</a></td>
<td></td>
</tr>
<tr>
<td>mail</td>
<td><a href="https://notmuchmail.org/">notmuch</a></td>
<td>mail indexer</td>
<td><strong>active</strong></td>
<td><a href="/configs/mail/">Mail.org,</a> <a href="https://sqrtminusone.xyz/posts/2021-02-27-gmail/">post</a></td>
<td></td>
</tr>
<tr>
<td>mail</td>
<td><a href="https://github.com/gauteh/lieer">lieer</a></td>
<td>gmail API client</td>
<td><strong>active</strong></td>
<td><a href="/configs/mail/">Mail.org</a>, <a href="https://sqrtminusone.xyz/posts/2021-02-27-gmail/">post</a></td>
<td>credentials are encrypted</td>
</tr>
<tr>
<td>mail</td>
<td><a href="https://marlam.de/msmtp/">msmtp</a></td>
<td>SMTP client</td>
<td><strong>active</strong></td>
<td><a href="/configs/mail/">Mail.org</a></td>
<td></td>
</tr>
<tr>
<td>editor</td>
<td><a href="https://www.gnu.org/software/emacs/">emacs</a></td>
<td>everything</td>
<td><strong>active</strong></td>
<td><a href="/configs/emacs/">Emacs.org</a></td>
<td>GitHub renders .org files without labels and <code>tangle: no</code></td>
</tr>
<tr>
<td>editor</td>
<td><a href="https://www.vim.org/">vim</a></td>
<td>text edtior</td>
<td><strong>active</strong></td>
<td>-</td>
<td>A minimal config to have a lightweight terminal $EDITOR</td>
</tr>
<tr>
<td>editor</td>
<td><a href="https://neovim.io/">neovim</a></td>
<td>text edtior</td>
<td>archive</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>documents</td>
<td><a href="https://mg.readthedocs.io/latexmk.html">latexmk</a></td>
<td>LaTeX build tool</td>
<td><strong>active</strong></td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>documents</td>
<td><a href="https://pwmt.org/projects/zathura/">zathura</a></td>
<td>pdf viewer</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/dunst-project/dunst">dunst</a></td>
<td>notification manager</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://i3wm.org/">i3wm</a></td>
<td>tiling WM</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/jordansissel/keynav">keynav</a></td>
<td>control mouse with keyboard</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/polybar/polybar">polybar</a></td>
<td>status bar</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/davatorium/rofi">rofi</a></td>
<td>generic menu</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/flameshot-org/flameshot">flameshot</a></td>
<td>screenshot</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/yshui/picom">picom</a></td>
<td>X11 compositor</td>
<td><strong>active</strong></td>
<td><a href="/configs/desktop/">Desktop.org</a></td>
<td></td>
</tr>
<tr>
<td>desktop</td>
<td><a href="https://github.com/vivien/i3blocks">i3blocks</a></td>
<td>status bar</td>
<td>archive</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>internet</td>
<td><a href="https://github.com/tridactyl/tridactyl">tridactyl</a></td>
<td>vim bindings for Firefox</td>
<td><strong>active</strong></td>
<td>-</td>
<td>templated with yadm</td>
</tr>
<tr>
<td>internet</td>
<td><a href="https://newsboat.org/">newsboat</a></td>
<td>terminal RSS reader</td>
<td>archive</td>
<td>-</td>
<td>urls are encrypted</td>
</tr>
<tr>
<td>internet</td>
<td><a href="https://qutebrowser.org/">qutebrowser</a></td>
<td>browser with vim bindings</td>
<td>archive</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>internet</td>
<td><a href="https://github.com/jarun/buku">buku</a></td>
<td>bookmarks manager</td>
<td>archive</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>audio</td>
<td><a href="https://www.musicpd.org/">mpd</a></td>
<td>music player daemon</td>
<td><strong>active</strong></td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>audio</td>
<td><a href="https://github.com/ncmpcpp/ncmpcpp">ncmpcpp</a></td>
<td>MPD frontend</td>
<td><strong>active</strong></td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>misc</td>
<td><a href="https://yadm.io">yadm</a></td>
<td>dotfiles manager</td>
<td><strong>active</strong></td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>misc</td>
<td><a href="https://github.com/risacher/sunwait">sunwait</a></td>
<td>sunrise calculator</td>
<td><strong>active</strong></td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>misc</td>
<td><a href="https://github.com/vergoh/vnstat">vnstat</a></td>
<td>traffic stats</td>
<td><strong>active</strong></td>
<td>-</td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="posts-about-my-configuration">Posts about my configuration</h2>
<ul>
<li><a href="https://sqrtminusone.xyz/posts/2021-05-01-org-python/">Replacing Jupyter Notebook with Org Mode</a></li>
<li><a href="https://sqrtminusone.xyz/posts/2021-02-27-gmail/">Multiple Gmail accounts &amp; labels with Emacs</a></li>
</ul>
<h2 id="some-statistics">Some statistics</h2>
<p>If you are viewing the file in Emacs, eval the following to show the pictures with reasonable width:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-elisp" data-lang="elisp">(setq-local org-image-actual-width <span style="color:#f92672">&#39;</span>(<span style="color:#ae81ff">1024</span>))
</code></pre></div><h3 id="history">History</h3>
<figure><img src="./dot-stats/img/all.png"/>
</figure>
<figure><img src="./dot-stats/img/emacs-vim.png"/>
</figure>
<figure><img src="./dot-stats/img/literate-config.png"/>
</figure>
<h2 id="misc">Misc</h2>
<h3 id="notes">Notes</h3>
<ul>
<li><code>M-u C-c C-v t</code> to tangle a particular block</li>
<li><code>M-u M-u C-c C-v t</code> to tangle a particular file</li>
<li><code>C-c C-v d</code> to demarcate a block</li>
</ul>
<p>Uses yadm&rsquo;s <code>post_alt</code> hook to create symlinks</p>
<h3 id="encrypted-files">Encrypted files</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">.config/newsboat/urls
.config/filezilla/sitemanager.xml
.config/filezilla/filezilla.xml
Mail/thexcloud/.credentials.gmailieer.json
Mail/progin6304/.credentials.gmailieer.json
.emacs.d/dired-bookmarks.el
.emacs.d/private.org
.emacs.d/private.el
.emacs.d/.trello/sqrtminusone.el
</code></pre></div>
</div>
</div><div id="footer" class="mb-5">
<hr>
<div class="container text-center">
</div>
<div class="container text-center">
<a href="https://sqrtminusone.xyz/" title="Pavel Korytov, 2021"><small>Pavel Korytov, 2021</small></a>
</div>
</div>
</body>
</html>